Shipping
The input fields for the fulfillment order, shipping date and time, package details, weight, notification setting, and optional rate preference used to purchase a shipping label.
Anchor to FieldsFields
- fulfillmentOrderId (ID!)
- notifyCustomer (Boolean)
- originAddress (MailingAddressInput)
- packageInfo (PackageInfoInput)
- preferredRateSelection (PreferredRateSelectionInput)
- shippingDatetime (DateTime!)
- totalWeight (WeightInput)
- Anchor to fulfillmentOrderIdfulfillment•ID!
Order Id non-null The ID of the fulfillment order to create the shipping label for. The fulfillment order must be fulfillable, require shipping, and have a destination shipping address.
- Anchor to notifyCustomernotify•Boolean
Customer Default:false Whether to notify the customer after the shipping label is purchased.
- Anchor to originAddressorigin•Mailing
Address Address Input A custom ship-from origin address that overrides the fulfillment order's assigned location for this label. If not provided, the assigned location is used.
- Anchor to packageInfopackage•Package
Info Info Input The package to use for the shipment. Provide either a custom package or a carrier-provided package.
- Anchor to preferredRateSelectionpreferred•Preferred
Rate Selection Rate Selection Input The preferred carrier and service to use for the shipping label. If omitted, the mutation uses Shopify Shipping's default rate selection.
- Anchor to shippingDatetimeshipping•Date
Datetime Time! non-null The date and time when the package is expected to be shipped. The value must not be in the past.
- Anchor to totalWeighttotal•Weight
Weight Input Total shipment weight, including the items being fulfilled and the package. If omitted, the total weight used is calculated using the weight of the empty package and the weight of the fulfillable line items.