shippingPackageUpdate

Updates a shipping package.

Use it in a workflow

Add a step and choose the Shopify connector.
Pick the shippingPackageUpdate action (under Shipping).
Fill in the fields below, then reference the result from later steps as {{shippingpackageupdate.response.data}}.

Query

This is the mutation the action sends by default. Edit it in the step's Query field to change which fields come back.

graphql

mutation ShippingPackageUpdate($id: ID!, $shippingPackage: CustomShippingPackageInput!) {
  shippingPackageUpdate(id: $id, shippingPackage: $shippingPackage) {
    userErrors {
      field
      message
    }
  }
}

Variables

Pass these as a JSON object in the step's Variables field.

idstringrequired

The ID of the shipping package to update.

shippingPackageobjectrequired

Specifies the input fields for a shipping package.

weightobject2 fields

dimensionsobject4 fields

defaultboolean

namestring

typestring

One ofBOXFLAT_RATEENVELOPESOFT_PACK

json

{
  "id": "string",
  "shippingPackage": {
    "weight": {
      "value": 0,
      "unit": "KILOGRAMS"
    },
    "dimensions": {
      "length": 0,
      "width": 0,
      "height": 0,
      "unit": "MILLIMETERS"
    },
    "default": false,
    "name": "string",
    "type": "BOX"
  }
}

Response

Read the result with {{shippingpackageupdate.response.data.data.shippingPackageUpdate}}. If the API returns errors, the step fails and they are at {{shippingpackageupdate.response.data.errors}}.

userErrorsarray<object>

fieldobject

messageobject

Need more? See the Shopify guide for connection setup and behaviour shared by every action.

Was this page helpful?