The REST Admin API is a legacy API as of October 1, 2024. Starting April 1, 2025, all new public apps must be built exclusively with the GraphQL Admin API. For details and migration steps, visit our migration guide.
Fulfillment
The FulfillmentOrder resource represents either an item or a group of items in an order that are to be fulfilled from the same location. There can be more than one fulfillment order for an order at a given location.
Fulfillment orders represent the work which is intended to be done in relation to an order. When the fulfillment of some or all line items has started, a Fulfillment is created by a merchant or third party to represent the ongoing or completed work of fulfillment. See below for more details on creating fulfillments.
Shopify creates fulfillment orders automatically when an order is created. It is not possible to manually create fulfillment orders.
See below for more details on the lifecycle of a fulfillment order.
Retrieving fulfillment orders
All fulfillment orders related to a given order can be retrieved with the Get fulfillment orders by order ID endpoint. API access scopes govern which fulfillments orders are returned to clients. An API client will only receive a subset of the fulfillment orders which belong to an order if they don't have the necessary access scopes to view all of the fulfillment orders.
Fulfillment service apps can retrieve the fulfillment orders which have been assigned to their locations with the
AssignedFulfillmentOrder resource.
The assignment_status parameter in the
Retrieve a list of assigned fulfillment orders
query controls whether all assigned fulfillment orders
should be returned or only those where a merchant has sent a fulfilment request
and it has yet to be responded to.
The API client must be granted the read_assigned_fulfillment_orders access scope to access
the assigned fulfillment orders.
A specific fulfillment order can be retrieved with the Get fulfillment order endpoint.
The lifecycle of a fulfillment order
Fulfillment Order Creation
After an order is created, a background worker performs the order routing process which determines which locations will be responsible for fulfilling the purchased items. Once the order routing process is complete, one or more fulfillment orders will be created and assigned to these locations. It is not possible to manually create fulfillment orders.
Once a fulfillment order has been created, it will have one of two different lifecycles depending on the type of location which the fulfillment order is assigned to.
The lifecycle of a fulfillment order at a merchant managed location
Fulfillment orders are completed by creating fulfillments. Fulfillments represents the work done.
For digital products a merchant or an order management app would create a fulfilment once the digital asset has been provisioned. For example, in the case of a digital gift card, a merchant would to do this once the gift card has been activated - before the email being shipped.
On the other hand, for a traditional shipped order, a merchant or an order management app would create a fulfillment after picking and packing the items relating to a fulfillment order, but before the courier has collected the goods.
Learn about managing fulfillment orders as an order management app.
The lifecycle of a fulfillment order at a location which is managed by a fulfillment service
For fulfillment orders which are assigned to a location that is managed by a fulfillment service, a merchant or an Order Management App can send a fulfillment request to the fulfillment service which operates the location to request that they fulfill the associated items. A fulfillment service has the option to accept or reject this fulfillment request.
Once the fulfillment service has accepted the request, the request can no longer be cancelled by the merchant or order management app and instead a cancellation request must be submitted to the fulfillment service.
Once a fulfillment service accepts a fulfillment request, then after they are ready to pack items and send them for delivery, they create fulfillments with the Create a fulfillment for one or many fulfillment orders endpoint. They can provide tracking information right away or create fulfillments without it and then update tracking information for fulfillments.
Learn about managing fulfillment orders as a fulfillment service.
API access scopes
Fulfillment orders are governed by the following API access scopes:
-
The
read_merchant_managed_fulfillment_ordersandwrite_merchant_managed_fulfillment_ordersaccess scopes grant access to fulfillment orders assigned to merchant-managed locations. -
The
read_assigned_fulfillment_ordersandwrite_assigned_fulfillment_ordersaccess scopes are intended for fulfillment services. These scopes grant access to fulfillment orders assigned to locations that are being managed by fulfillment services. -
The
read_third_party_fulfillment_ordersandwrite_third_party_fulfillment_ordersaccess scopes grant access to fulfillment orders assigned to locations managed by other fulfillment services.
Fulfillment service app access scopes
Usually, fulfillment services have the write_assigned_fulfillment_orders access scope
and don't have the *_third_party_fulfillment_orders
or *_merchant_managed_fulfillment_orders access scopes.
The app will only have access to the fulfillment orders assigned to their location
(or multiple locations if the app registers multiple fulfillment services on the shop).
The app will not have access to fulfillment orders assigned to merchant-managed locations
or locations owned by other fulfillment service apps.
Order management app access scopes
Order management apps will usually request write_merchant_managed_fulfillment_orders and
write_third_party_fulfillment_orders access scopes. This will allow them to manage all fulfillment orders
on behalf of a merchant.
If an app combines the functions of an order management app and a fulfillment service, then the app should request all access scopes to manage all assigned and all unassigned fulfillment orders.
Notifications about fulfillment orders
Fulfillment services are required to register a self-hosted callback URL which has a number of uses. One of these uses is that this callback URL will be notified whenever a merchant submits a fulfillment or cancellation request.
Both merchants and apps can subscribe to fulfillment order webhooks to be notified whenever fulfillment order related domain events occur.
Endpoints
- post/admin/api/latest/fulfillment_
orders/{fulfillment_ order_ id}/cancel. json Cancel a fulfillment order - post/admin/api/latest/fulfillment_
orders/{fulfillment_ order_ id}/close. json Marks a fulfillment order as incomplete - post/admin/api/latest/fulfillment_
orders/{fulfillment_ order_ id}/hold. json Holds fulfillment of a fulfillment order - post/admin/api/latest/fulfillment_
orders/{fulfillment_ order_ id}/move. json Moves a fulfillment order to a new location - post/admin/api/latest/fulfillment_
orders/{fulfillment_ order_ id}/open. json Marks the fulfillment order as open - post/admin/api/latest/fulfillment_
orders/{fulfillment_ order_ id}/release_ hold. json Releases all holds on a fulfillment order - post/admin/api/latest/fulfillment_
orders/{fulfillment_ order_ id}/reschedule. json Reschedules the fulfill_at time of a scheduled fulfillment order - post/admin/api/latest/fulfillment_
orders/set_ fulfillment_ orders_ deadline. json Sets deadline for fulfillment orders - get/admin/api/latest/fulfillment_
orders/{fulfillment_ order_ id}. json Retrieves a specific fulfillment order - get/admin/api/latest/orders/{order_
id}/fulfillment_ orders. json Retrieves a list of fulfillment orders for a specific order
The FulfillmentOrder resource
Properties
The ID of the location that has been assigned to do the work.
The destination where the items should be sent.
Show destination properties
- id: The ID of the fulfillment order destination.
- address1: The street address of the assigned location.
- address2: An optional additional field for the street address of the assigned location.
- city: The city of the destination.
- company: The company of the destination.
- country: The country of the destination.
- email: The email of the customer at the destination.
- first_name: The first name of the customer at the destination.
- last_name: The last name of the customer at the destination.
- phone: The phone number of the customer at the destination.
- province: The province of the destination.
- zip: The ZIP code of the destination.
The type of method used to transfer a product or service to a customer.
Show delivery_method properties
- id: The ID of the delivery method.
- method_type: The type of delivery method. Valid values:
- local: A delivery to a customer's doorstep.
- none: No delivery method.
- pick_up: A delivery that a customer picks up at your retail store, curbside, or any location that you choose.
- retail: Items delivered immediately in a retail store.
- shipping: A delivery to a customer using a shipping carrier.
- min_delivery_date_time: The minimum date and time by which the delivery is expected to be completed.
- max_delivery_date_time: The maximum date and time by which the delivery is expected to be completed.
- additional_information: The Additional information to consider when performing the delivery. It has the following properties:
- instructions: The delivery instructions to follow when performing the delivery.
- phone: The phone number to contact when performing the delivery.
- branded_promise: The branded promise that was presented to the buyer during checkout. For example: Shop Promise.
It has the following properties:
- name: The handle of the branded promise. For example: `shop_promise`.
- handle: The name of the branded promise. For example: `Shop Promise`.
- service_code: A reference to the shipping method.
- source_reference: Source reference is promise provider specific data associated with delivery promise.
- presented_name: The name of the delivery option that was presented to the buyer during checkout.
The date and time at which the fulfillment order will be fulfillable.
When this date and time is reached, a scheduled fulfillment order is automatically transitioned to open.
For example, the fulfill_at date for a subscription order might be the 1st of each month, a pre-order fulfill_at date would be nil, and a standard order fulfill_at date would be the order creation date.
For more information about fulfillment statuses, refer to the status property.
The latest date and time by which all items in the fulfillment order need to be fulfilled.
Represents the fulfillment holds applied on the fulfillment order.
Show fulfillment_holds properties
- reason: The reason for the fulfillment hold.
- reason_notes: Additional information about the fulfillment hold reason.
An ID for the fulfillment order.
The international duties relevant to the fulfillment order.
Show international_duties properties
- incoterm: The method of duties payment. Valid values:
- DAP: Delivered at place.
- DDP: Delivered duty paid.
Represents line items belonging to a fulfillment order:
Show line_items properties
- id: The ID of the fulfillment order line item.
- shop_id: The ID of the shop associated with the fulfillment order line item.
- fulfillment_order_id: The ID of the fulfillment order associated with this line item.
- line_item_id: The ID of the line item associated with this fulfillment order line item.
- inventory_item_id: The ID of the inventory item associated with this fulfillment order line item.
- quantity: The total number of units to be fulfilled.
- fulfillable_quantity: The number of units remaining to be fulfilled.
- variant_id: The ID of the variant associated with this fulfillment order line item.
The ID of the order that's associated with the fulfillment order.
The request status of the fulfillment order. Valid values:
Show request_status properties
- unsubmitted: The initial request status for newly-created fulfillment orders. This is the only valid request status for fulfillment orders that aren't assigned to a fulfillment service.
- submitted: The merchant requested fulfillment for this fulfillment order.
- accepted: The fulfillment service accepted the merchant's fulfillment request.
- rejected: The fulfillment service rejected the merchant's fulfillment request.
- cancellation_requested: The merchant requested a cancellation of the fulfillment request for this fulfillment order.
- cancellation_accepted: The fulfillment service accepted the merchant's fulfillment cancellation request.
- cancellation_rejected: The fulfillment service rejected the merchant's fulfillment cancellation request.
- closed: The fulfillment service closed the fulfillment order without completing it.
The ID of the shop that's associated with the fulfillment order.
The FulfillmentOrder resource
Anchor to POST request, Cancel a fulfillment orderpostCancel a fulfillment order
Marks a fulfillment order as cancelled.
Cancel a fulfillment order
Cancel a fulfillment order
/admin/api/2025-07/fulfillment_
Response
Anchor to POST request, Marks a fulfillment order as incompletepostMarks a fulfillment order as incomplete
assigned_fulfillment_orders access scope.Marks an in-progress fulfillment order as incomplete,
indicating the fulfillment service is unable to ship any remaining items,
and closes the fulfillment request.
This mutation can only be called for fulfillment orders that meet the following criteria:
- Assigned to a fulfillment service location,
- The fulfillment request has been accepted,
- The fulfillment order status is
.
Closing a fulfillment order is explained in the fulfillment service guide.
An optional reason for marking the fulfillment order as incomplete.
Transition a fulfillment order from in progress to incomplete
Transition a fulfillment order from in progress to incomplete
/admin/api/2025-07/fulfillment_
Response
Anchor to POST request, Holds fulfillment of a fulfillment orderpostHolds fulfillment of a fulfillment order
Halts all fulfillment work on a fulfillment order.
Changes the fulfillment order status to ON_HOLD and creates a fulfillment hold.
An object containing
Show fulfillment_hold properties
reason: (String) required A reason for the fulfillment hold.awaiting_paymentThe fulfillment hold is applied because payment is pending.high_risk_of_fraudThe fulfillment hold is applied because of a high risk of fraud.incorrect_addressThe fulfillment hold is applied because of an incorrect address.inventory_out_of_stockThe fulfillment hold is applied because inventory is out of stock.otherThe fulfillment hold is applied for any other reason.
reason_notes: (String) optional Additional information about the fulfillment hold reason.notify_merchant: (Boolean) optional Whether the merchant should receive a notification about the fulfillment hold. " "If set to true, then the merchant will be notified on the Shopify mobile app " "(if they use it to manage their store). The default value is false.fulfillment_order_line_items: (Array) An optional array of fulfillment order line item ids and the quantity of each to move. Added as of version 2023-04
Apply a fulfillment hold on a fulfillment order because some inventory is out of stock
Apply a fulfillment hold on a fulfillment order because some inventory is out of stock
Show fulfillment_hold properties
An object containing
Show fulfillment_hold properties
reason: (String) required A reason for the fulfillment hold.awaiting_paymentThe fulfillment hold is applied because payment is pending.high_risk_of_fraudThe fulfillment hold is applied because of a high risk of fraud.incorrect_addressThe fulfillment hold is applied because of an incorrect address.inventory_out_of_stockThe fulfillment hold is applied because inventory is out of stock.otherThe fulfillment hold is applied for any other reason.
reason_notes: (String) optional Additional information about the fulfillment hold reason.notify_merchant: (Boolean) optional Whether the merchant should receive a notification about the fulfillment hold. " "If set to true, then the merchant will be notified on the Shopify mobile app " "(if they use it to manage their store). The default value is false.fulfillment_order_line_items: (Array) An optional array of fulfillment order line item ids and the quantity of each to move. Added as of version 2023-04
/admin/api/2025-07/fulfillment_
Response
Anchor to POST request, Moves a fulfillment order to a new locationpostMoves a fulfillment order to a new location
merchant_managed_fulfillment_orders, third_party_fulfillment_orders.Changes the location which is assigned to fulfill a number of unfulfilled fulfillment order line items.
Moving a fulfillment order will fail in the following circumstances:
- The fulfillment order is closed.
- The destination location has never stocked the requested inventory item.
- The API client doesn't have the correct permissions.
Line items which have already been fulfilled can't be re-assigned and will always remain assigned to the original location.
You can't change the assigned location while a fulfillment order has a
request_status of submitted, accepted,
cancellation_requested, or cancellation_rejected.
These request statuses mean that a fulfillment order is awaiting action by a fulfillment service
and can't be re-assigned without first having the fulfillment service accept a cancellation request.
This behavior is intended to prevent items from being fulfilled by multiple locations or fulfillment services.
How re-assigning line items affects fulfillment orders
If the original fulfillment order doesn't have any line items which are fully or partially fulfilled, the original fulfillment order will be moved to the new location. However if this isn't the case, the moved fulfillment order will differ from the original one.
Response
-
original_fulfillment_order- The final state of the original fulfillment order.
As a result of the move operation, the original fulfillment order might be moved to the new location or remain in the original location. The original fulfillment order might have the same status or be closed. -
moved_fulfillment_order- The fulfillment order which now contains the moved line items and is assigned to the destination location.
First scenario: All line items belonging to the original fulfillment order are re-assigned.
In this case, this will be the original fulfillment order.
Second scenario: A subset of the line items belonging to the original fulfillment order are re-assigned.
If the new location is already assigned to fulfill line items on the order, then this will be an existing active fulfillment order. Otherwise, this will be a new fulfillment order with the moved line items assigned. -
remaining_fulfillment_order- this field is deprecated.
An object containing
Show fulfillment_order properties
-
new_location_id: (integer) The ID of the location where the fulfillment order will be moved. -
fulfillment_order_line_items: (Array) An optional array of fulfillment order line item ids and the quantity of each to move. If left blank, all unfulfilled line items belonging to the fulfillment order are moved. Added as of version 2023-04.
Move a fulfillment order to a new location
Move a fulfillment order to a new location
Show fulfillment_order properties
An object containing
Show fulfillment_order properties
-
new_location_id: (integer) The ID of the location where the fulfillment order will be moved. -
fulfillment_order_line_items: (Array) An optional array of fulfillment order line item ids and the quantity of each to move. If left blank, all unfulfilled line items belonging to the fulfillment order are moved. Added as of version 2023-04.
/admin/api/2025-07/fulfillment_
Response
Anchor to POST request, Marks the fulfillment order as openpostMarks the fulfillment order as open
merchant_managed_fulfillment_orders, third_party_fulfillment_orders.Marks a scheduled fulfillment order as ready for fulfillment.
This endpoint allows merchants to work on a scheduled fulfillment order before its expected fulfill_at datetime.
Transition a fulfillment order from scheduled to open
Transition a fulfillment order from scheduled to open
/admin/api/2025-07/fulfillment_
Response
Anchor to POST request, Releases all holds on a fulfillment orderpostReleases all holds on a fulfillment order
Releases the fulfillment order from all fulfillment holds and changes its status from ON_HOLD.
NOTE: It is highly recommended that apps use the
fulfillmentOrderReleaseHold GraphQL mutation
to release specific holds by providing their IDs.
Releasing all holds on a fulfillment order will result in the fulfillment order being released prematurely
and items being incorrectly fulfilled.
Transition a fulfillment order from on_hold to open
Transition a fulfillment order from on_hold to open
/admin/api/2025-07/fulfillment_
Response
Anchor to POST request, Reschedules the fulfill_at time of a scheduled fulfillment orderpostReschedules the fulfill_
merchant_managed_fulfillment_orders, third_party_fulfillment_orders.Reschedules a scheduled fulfillment order.
Updates the value of thefulfill_at field on a scheduled fulfillment order.
The fulfillment order will be marked as ready for fulfillment at this date and time.
Response
-
fulfillment_order- a fulfillment order with the rescheduled line items.
Fulfillment orders may be merged if they have the samefulfill_atdatetime. If the fulfillment order is merged then the resulting fulfillment order will be returned. Otherwise the original fulfillment order will be returned with an updatedfulfill_atdatetime.
The new fulfillment deadline of the fulfillment order. Must be in future.
Update the fulfill_at time of a scheduled fulfillment order
Update the fulfill_at time of a scheduled fulfillment order
/admin/api/2025-07/fulfillment_
Response
Anchor to POST request, Sets deadline for fulfillment orderspostSets deadline for fulfillment orders
merchant_managed_fulfillment_orders, third_party_fulfillment_orders, marketplace_fulfillment_orders, orders.Sets the latest date and time by which the fulfillment orders need to be fulfilled.
The new fulfillment deadline of the fulfillment orders.
The IDs of the fulfillment orders for which the deadline is being set
Set a fulfillment deadline for a fulfillment order
Set a fulfillment deadline for a fulfillment order
Show fulfillment_order_ids properties
The IDs of the fulfillment orders for which the deadline is being set
The new fulfillment deadline of the fulfillment orders.
/admin/api/2025-07/fulfillment_
Response
Anchor to GET request, Retrieves a specific fulfillment ordergetRetrieves a specific fulfillment order
Retrieves a specific fulfillment order.
Include the financial summary data for each line item, if available.
Indicates whether the order reference fields should be returned in the result.
Get a single fulfillment order by its ID
Get a single fulfillment order by its ID
Get a single fulfillment order by its ID and include the financial summary data
Get a single fulfillment order by its ID and include the financial summary data
Include the financial summary data for each line item, if available.
Get a single fulfillment order by its ID and include the order reference data for each
Get a single fulfillment order by its ID and include the order reference data for each
Indicates whether the order reference fields should be returned in the result.
/admin/api/2025-07/fulfillment_
Response
Anchor to GET request, Retrieves a list of fulfillment orders for a specific ordergetRetrieves a list of fulfillment orders for a specific order
Retrieves a list of fulfillment orders for a specific order.
API access scopes govern which fulfillments orders are returned. An API client will only receive a subset of the fulfillment orders which belong to an order if they don't have the necessary access scopes to view all of the fulfillment orders. In the case that an API client does not have the access scopes necessary to view any of the fulfillment orders belongs to an order, an empty array will be returned.
Include the financial summary data for each line item, if available.
Indicates whether the order reference fields should be returned in the result.
The ID of the order that is associated with the fulfillment orders.
Retrieve a list of all fulfillment orders for an order
Retrieve a list of all fulfillment orders for an order
Retrieve a list of fulfillment orders for an order and include the financial summary data for each
Retrieve a list of fulfillment orders for an order and include the financial summary data for each
Include the financial summary data for each line item, if available.
Retrieve a list of fulfillment orders for an order and include the order reference data for each
Retrieve a list of fulfillment orders for an order and include the order reference data for each
Indicates whether the order reference fields should be returned in the result.