shippingPackageUpdate
mutation

Choose a version:

Requires Any of shipping access scopes or manage_delivery_settings user permission.

Updates a shipping package.

Anchor to section titled 'Arguments'

Arguments

Anchor to id id ID! required: The ID of the shipping package to update.
Anchor to shippingPackage shippingPackage CustomShippingPackageInput! required: Specifies the input fields for a shipping package.

Was this section helpful?

Anchor to section titled 'ShippingPackageUpdatePayload returns'

ShippingPackageUpdatePayload returns

Anchor to ShippingPackageUpdatePayload.userErrors userErrors [UserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Code examples for MUTATION: shippingPackageUpdate

Query Reference for MUTATION: shippingPackageUpdate

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

Input Reference for MUTATION: shippingPackageUpdate

"{\n  \"id\": \"gid://shopify/<objectName>/10079785100\",\n  \"shippingPackage\": {\n    \"default\": true,\n    \"dimensions\": {\n      \"height\": 1.1,\n      \"length\": 1.1,\n      \"unit\": \"CENTIMETERS\",\n      \"width\": 1.1\n    },\n    \"name\": \"<your-name>\",\n    \"type\": \"BOX\",\n    \"weight\": {\n      \"unit\": \"GRAMS\",\n      \"value\": 1.1\n    }\n  }\n}"

Schema Reference for MUTATION: shippingPackageUpdate

"input CustomShippingPackageInput {\n  default: Boolean\n  dimensions: ObjectDimensionsInput\n  name: String\n  type: ShippingPackageType\n  weight: WeightInput\n}\n\ninput ObjectDimensionsInput {\n  height: Float!\n  length: Float!\n  unit: LengthUnit!\n  width: Float!\n}\n\ninput WeightInput {\n  unit: WeightUnit!\n  value: Float!\n}\n"

Display Examples for MUTATION: shippingPackageUpdate

[]

shippingPackageUpdatemutation

Arguments

ShippingPackageUpdatePayload returns

shippingPackageUpdate
mutation