Order
The input fields for a fulfillment to create for an order.
Anchor to FieldsFields
- locationId (ID!)
- notifyCustomer (Boolean)
- originAddress (FulfillmentOriginAddressInput)
- shipmentStatus (FulfillmentEventStatus)
- trackingCompany (String)
- trackingNumber (String)
- trackingNumbers ([String!])
- Anchor to locationIdlocation•ID!
Id non-null The ID of the location to fulfill the order from.
- Anchor to notifyCustomernotify•Boolean
Customer Default:false Whether the customer should be notified of changes with the fulfillment.
- Anchor to originAddressorigin•Fulfillment
Address Origin Address Input The address at which the fulfillment occurred.
- Anchor to shipmentStatusshipment•Fulfillment
Status Event Status The status of the shipment.
- Anchor to trackingCompanytracking•String
Company The name of the tracking company.
If you specify a tracking company name from the list, Shopify will automatically build tracking URLs for all provided tracking numbers, which will make the tracking numbers clickable in the interface. The same tracking company will be applied to all tracking numbers specified.
Additionally, for the tracking companies listed on the Shipping Carriers help page Shopify will automatically update the fulfillment's
field during the fulfillment process.NoteSend the tracking company name exactly as written in the list (capitalization matters).
Note:Send the tracking company name exactly as written in the list (capitalization matters).
Note: Send the tracking company name exactly as written in <a href="https://shopify.dev/api/admin-graphql/latest/objects/FulfillmentTrackingInfo#supported-tracking-companies">the list</a> (capitalization matters).
- Anchor to trackingNumbertracking•String
Number The tracking number of the fulfillment.
The tracking number will be clickable in the interface if one of the following applies (the highest in the list has the highest priority):
- Shopify-known tracking company name
specified in the
companyfield. Shopify will build the tracking URL automatically based on the tracking number specified. - The tracking number has a Shopify-known format. Shopify will guess the tracking provider and build the tracking url based on the tracking number format. Not all tracking carriers are supported, and multiple tracking carriers may use similarly formatted tracking numbers. This can result in an invalid tracking URL.
- Shopify-known tracking company name
specified in the
- Anchor to trackingNumberstracking•[String!]
Numbers The tracking numbers of the fulfillment, one or many.
With multiple tracking numbers, you can provide tracking information for all shipments associated with the fulfillment, if there are more than one. For example, if you're shipping the items in an order in several boxes, each with its own tracking number.
NoteIf you provide the
field, you shouldn't provide thefield.Note:If you provide the
field, you shouldn't provide thefield.Note: If you provide the <code><span class="PreventFireFoxApplyingGapToWBR">tracking<wbr/>Numbers</span></code> field, you shouldn't provide the <code><span class="PreventFireFoxApplyingGapToWBR">tracking<wbr/>Number</span></code> field.
Tracking numbers will be clickable in the interface if one of the following applies (the highest in the list has the highest priority):
- Shopify-known tracking company name
specified in the
field. Shopify will build tracking URLs automatically for all tracking numbers specified. The same tracking company will be applied to all tracking numbers. - Tracking numbers have a Shopify-known format. Shopify will guess tracking providers and build tracking URLs based on the tracking number formats. Not all tracking carriers are supported, and multiple tracking carriers may use similarly formatted tracking numbers. This can result in an invalid tracking URL. It is highly recommended that you send the tracking company.
- Shopify-known tracking company name
specified in the
Anchor to Input objects using this inputInput objects using this input
- •INPUT OBJECT
The input fields for creating an order.