The REST Admin API is a legacy API as of October 1, 2024. All apps and integrations should be built with the GraphQL Admin API. For details and migration steps, visit our migration guide.
Multiple access scopes needed — refer to each endpoint for access scope requirements.
You can use the Fulfillment
resource to view fulfillments for an order or a fulfillment order.
A fulfillment order represents a group of one or more items in an order that will be fulfilled from the same location. A fulfillment represents work that is completed as part of a fulfillment order and can include one or more items.
You can use the Fulfillment
resource to manage fulfillments for fulfillment orders.
This resource is typically used in apps that perform shipping-related actions, such as making tracking and delivery updates, or creating additional shipments as required for an order or fulfillment order.
Each fulfillment supports a single tracking number. If you need to use multiple tracking numbers, then you should create separate fulfillments.
.
. The first part represents the order name and the second part represents the fulfillment number. The fulfillment number automatically increments depending on how many fulfillments are in an order (e.g. #1001.1
, #1001.2
).The address of the fulfillment location. This property is intended for tax purposes,
as a full address is required for tax providers to accurately calculate taxes. To retrieve
a fulfillment location's address, use the assigned_location
` property on the
FulfillmentOrder resource instead.
A text field that provides information about the receipt:
The fulfillment service associated with the fulfillment.
The name of the tracking company.
For the tracking company names from the list below Shopify automatically builds tracking URLs for all of the provided tracking numbers, which makes the tracking numbers clickable in the interface.
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.
Supported tracking companies
The following tracking companies display for shops located in any country:
The fulfillment order line items that have to be fulfilled.
true
, then an email will be sent when the fulfillment is created or updated.
The default value is false
.The address of the fulfillment location. This property is intended for tax purposes,
as a full address is required for tax providers to accurately calculate taxes. To retrieve
a fulfillment location's address, use the assigned_location
` property on the
FulfillmentOrder resource instead.
The tracking information for the fulfillment.
The tracking information for the fulfillment.
Requires ANY of the following access scopes: orders
, .
Requires ANY of the following access scopes: orders
, .
Requires orders
access scope.