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.
Assigned
assigned_fulfillment_orders access scope.A list of all the fulfillment orders that are assigned to an app at the shop level. The list of fulfillment orders can be filtered by location and assignment status.
Assigned fulfillment orders are fulfillment orders that are set to be fulfilled from locations managed by fulfillment services that are registered by the app. One app (api_client) may host multiple fulfillment services on a shop. Each fulfillment service manages a dedicated location on a shop. Assigned fulfillment orders can have associated fulfillment requests or might currently not be requested to be fulfilled.
Endpoints
- get/admin/api/latest/assigned_
fulfillment_ orders. json?assignment_ status=cancellation_ requested&location_ ids[]=24826418 Retrieves a list of fulfillment orders assigned to the shop locations that are owned by the app
The AssignedFulfillmentOrder resource
Properties
The ID of the fulfillment order's assigned location. This is the location from which the order is expected to be fulfilled.
The destination where the items should be sent upon fulfillment.
Show destination properties
- id: The ID of the fulfillment order destination.
- address1: The first line of the address of the destination.
- address2: The second line of the address of the destination.
- 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 ID of the fulfillment order.
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.
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 the 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 status of the fulfillment order. Valid values:
Show status properties
- open: Default state for newly created fulfillment orders.
- in_progress: The fulfillment order is being processed.
- cancelled: The fulfillment order has been cancelled by the merchant.
- incomplete: The fulfillment order cannot be completed as requested.
- closed: The fulfillment order has been completed and closed.
The AssignedFulfillmentOrder resource
Anchor to GET request, Retrieves a list of fulfillment orders assigned to the shop locations that are owned by the appgetRetrieves a list of fulfillment orders assigned to the shop locations that are owned by the app
Retrieves a list of fulfillment orders assigned to the shop locations that are owned by the app.
The app must have the read_assigned_fulfillment_orders
access scope
to be able to retrieve fulfillment orders assigned to its locations.
All assigned fulfillment orders (except those with the CLOSED status)
will be returned by default.
Perform filtering with the assignment_status query parameter
to receive only fulfillment orders that have been requested to be fulfilled.
The assignment status of the fulfillment orders that should be returned.
If assignment_status parameter isn't provided, then
the query will return all assigned fulfillment orders,
except those with the CLOSED status.
Show assignment_status properties
fulfillment_unsubmitted: Fulfillment orders for which the merchant hasn't yet requested fulfillment. Filtering by this value is supported as of the
2023-04API version.fulfillment_requested: Fulfillment orders for which the merchant has requested fulfillment.
fulfillment_accepted: Fulfillment orders for which the merchant's fulfillment request has been accepted. Any number of fulfillments can be created on these fulfillment orders to completely fulfill the requested items.
cancellation_requested: Fulfillment orders for which the merchant has requested cancellation of the previously accepted fulfillment request.
The IDs of the assigned locations of the fulfillment orders that should be returned.
If the location_ids parameter isn't provided, then all fulfillment orders assigned
to the shop locations that are managed by the app will be returned.
Retrieve a list of fulfillment orders in cancellation_requested state at a location for an app
Retrieve a list of fulfillment orders in cancellation_requested state at a location for an app
The assignment status of the fulfillment orders that should be returned.
If assignment_status parameter isn't provided, then
the query will return all assigned fulfillment orders,
except those with the CLOSED status.
Show assignment_status properties
fulfillment_unsubmitted: Fulfillment orders for which the merchant hasn't yet requested fulfillment. Filtering by this value is supported as of the
2023-04API version.fulfillment_requested: Fulfillment orders for which the merchant has requested fulfillment.
fulfillment_accepted: Fulfillment orders for which the merchant's fulfillment request has been accepted. Any number of fulfillments can be created on these fulfillment orders to completely fulfill the requested items.
cancellation_requested: Fulfillment orders for which the merchant has requested cancellation of the previously accepted fulfillment request.