Anchor to section titled 'undefined'

shippingPackageDelete
mutation

Requires Any of shipping access scopes or manage_delivery_settings user permission.

Deletes a shipping package.

Anchor to section titled 'Arguments'

Arguments

Anchor to id
id
ID!
required

The ID of the shipping package to remove.

Was this section helpful?
Anchor to section titled 'ShippingPackageDeletePayload returns'

ShippingPackageDeletePayload returns

Anchor to ShippingPackageDeletePayload.deletedId
deletedId
ID

The ID of the deleted shipping package.

Anchor to ShippingPackageDeletePayload.userErrors
userErrors
[UserError!]!
non-null

The list of errors that occurred from executing the mutation.

Was this section helpful?
Hide code
Mutation reference
Copy
mutation shippingPackageDelete($id: ID!) {
  shippingPackageDelete(id: $id) {
    deletedId
    userErrors {
      field
      message
    }
  }
}
Hide code
Input
Copy
{
  "id": "gid://shopify/<objectName>/10079785100"
}