Anchor to section titled 'undefined'

FulfillmentTrackingInput
input_object

The input fields that specify all possible fields for tracking information.

Note

If you provide the url field, you should not provide the urls field.

If you provide the number field, you should not provide the numbers field.

If you provide the url field, you should provide the number field.

If you provide the urls field, you should provide the numbers field.

Anchor to section titled 'Fields'

Fields

Anchor to FulfillmentTrackingInput.company
company
String

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 shipment_status field during the fulfillment process.

Note

Send the tracking company name exactly as written in the list (capitalization matters).
Anchor to FulfillmentTrackingInput.number
number
String

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):

  • Tracking url provided in the url field.
  • Shopify-known tracking company name specified in the company field. 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. It is highly recommended that you send the tracking company and the tracking URL.
Anchor to FulfillmentTrackingInput.numbers
numbers
[String!]

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 assembly parts of one furniture item in several boxes.

Tracking numbers will be clickable in the interface if one of the following applies (the highest in the list has the highest priority):

  • Tracking URLs provided in the urls field. The tracking URLs will be matched to the tracking numbers based on their positions in the arrays.
  • Shopify-known tracking company name specified in the company 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 and the tracking URLs.
Anchor to FulfillmentTrackingInput.url
url
URL

The URL to track the fulfillment.

The tracking URL is displayed in the merchant's admin on the order page. The tracking URL is displayed in the shipping confirmation email, which can optionally be sent to the customer. When accounts are enabled, it's also displayed in the customer's order history.

The URL must be an RFC 3986 and RFC 3987-compliant URI string. For example, "https://www.myshipping.com/track/?tracknumbers=TRACKING_NUMBER" is a valid URL. It includes a scheme (https) and a host (myshipping.com).

Anchor to FulfillmentTrackingInput.urls
urls
[URL!]

The URLs to track the fulfillment, one or many.

The tracking URLs are displayed in the merchant's admin on the order page. The tracking URLs are displayed in the shipping confirmation email, which can optionally be sent to the customer. When accounts are enabled, the tracking URLs are also displayed in the customer's order history.

If you're not specifying a Shopify-known tracking company name in the company field, then provide tracking URLs for all tracking numbers from the numbers field.

Tracking URLs from the urls array field are being matched with the tracking numbers from the numbers array field correspondingly their positions in the arrays.

Each URL must be an RFC 3986 and RFC 3987-compliant URI string. For example, "https://www.myshipping.com/track/?tracknumbers=TRACKING_NUMBER" is a valid URL. It includes a scheme (https) and a host (myshipping.com).

Was this section helpful?
Anchor to section titled 'Mutations using this input'

Mutations using this input

field-fulfillmenttrackinginfoupdate-trackinginfoinput
fulfillmentTrackingInfoUpdate
mutation
field-fulfillmenttrackinginfoupdatev2-trackinginfoinput
fulfillmentTrackingInfoUpdateV2
mutation
Was this section helpful?
Anchor to section titled 'Input objects using this input'

Input objects using this input

field-fulfillmentinput-trackinginfo
FulfillmentInput
input_object

The fulfillment's tracking information, including a tracking URL, a tracking number, and the company associated with the fulfillment.

field-fulfillmentv2input-trackinginfo
FulfillmentV2Input
input_object

The fulfillment's tracking information, including a tracking URL, a tracking number, and the company associated with the fulfillment.

Was this section helpful?
Map

Fields

FulfillmentTrackingInput

Input objects using this input

Mutations using this input