Choose a version:

shippingLabelPurchase

mutation

Requires write_orders access scope. Also: The user must have buy_shipping_labels permission.

Purchases shipping label.

Anchor to Arguments

Arguments

Anchor to shippingLabelPurchaseshippingLabelPurchase

•ShippingLabelPurchaseInput!

required

The input for the shipping label purchase.

Was this section helpful?

Anchor to ShippingLabelPurchasePayload returnsShippingLabelPurchasePayload returns

Anchor to shippingLabelPurchaseResultshippingLabelPurchaseResult •ShippingLabelPurchaseResult: The result of the shipping label purchase request.
Anchor to userErrorsuserErrors •[ShippingLabelPurchaseUserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Examples

shippingLabelPurchase reference

Mutation Reference

mutation shippingLabelPurchase($shippingLabelPurchase: ShippingLabelPurchaseInput!) {

shippingLabelPurchase(shippingLabelPurchase: $shippingLabelPurchase) {

shippingLabelPurchaseResult {

# ShippingLabelPurchaseResult fields

}

userErrors {

field

message

}

Input

{

"shippingLabelPurchase": {

"fulfillmentOrderId": "gid://shopify/<objectName>/10079785100",

"notifyCustomer": true,

"packageInfo": {

"carrierPackage": {},

"customPackage": {}

"preferredRateSelection": {

"carrierCode": "<your-carrierCode>",

"serviceCode": "<your-serviceCode>"

"shippingDatetime": "2019-09-07T15:50:00Z",

"totalWeight": {

"unit": "GRAMS",

"value": 1.1

}

Variables

{
  "shippingLabelPurchase": {
    "fulfillmentOrderId": "gid://shopify/<objectName>/10079785100",
    "notifyCustomer": true,
    "packageInfo": {
      "carrierPackage": {},
      "customPackage": {}
    },
    "preferredRateSelection": {
      "carrierCode": "<your-carrierCode>",
      "serviceCode": "<your-serviceCode>"
    },
    "shippingDatetime": "2019-09-07T15:50:00Z",
    "totalWeight": {
      "unit": "GRAMS",
      "value": 1.1
    }
  }
}

Schema

input ShippingLabelPurchaseInput {
  fulfillmentOrderId: ID!
  notifyCustomer: Boolean
  packageInfo: PackageInfoInput
  preferredRateSelection: PreferredRateSelectionInput
  shippingDatetime: DateTime!
  totalWeight: WeightInput
}

input PackageInfoInput {
  carrierPackage: ShippingCarrierPackageInput
  customPackage: ShippingLabelPurchaseCustomPackageInput
}

input PreferredRateSelectionInput {
  carrierCode: String!
  serviceCode: String!
}

input WeightInput {
  unit: WeightUnit!
  value: Float!
}