API ReferenceFulfillment
Fulfillment Orders List
Retrieve a list of fulfillment orders.
Authorization
oauth2 fulfillment_service:read, fulfillment_orders:readAuthorizationBearer <token>
Generate an Access Token through Settings > API Access for single store access or use the Authorization Code flow with your partner App Client ID. Use required permission scopes for API endpoint access. Example Authorization: Bearer 123
In: header
Scope: fulfillment_service:read, fulfillment_orders:read
Query Parameters
order_number?string
Order Number
location_id?string
Location ID
status?array<>
Status
not_required- Not Requriedopen- Openprocessing- Processingon_hold- On Holdincomplete- Incompleteclosed- Closedcanceled- Canceled
request_status?array<>
Request Status
pending- Pendingrequested- Requestedaccepted- Acceptedrejected- Rejectedcancel_requested- Cancel Requestedcancel_accepted- Cancel Acceptedcancel_rejected- Cancel Rejectedclosed- Closed
fulfillment_order_id?string
Fulfillment Order Id
shipping_method?array<string>
Shipping Method
date_created_from?string
YYYY-MM-DD
Format
datedate_created_to?string
YYYY-MM-DD
Format
dateproduct?array<array<integer>>
Filter by product ID (supports variant and parent product IDs)
sku?array<string|null>
Filter by SKU
cursor?string
The pagination cursor value.
Header Parameters
X-29next-API-Version*"2024-04-01"
Default
"2024-04-01"Value in
- "2024-04-01"
Response Body
application/json
curl -X GET "https://example.com/fulfillment-orders/" \ -H "X-29next-API-Version: 2024-04-01"{ "next": "http://example.com", "previous": "http://example.com", "results": [ { "assigned_location": { "accept_return": true, "address": { "country": "string", "line1": "string", "line2": "string", "line3": "string", "line4": "string", "phone_number": "string", "postcode": "string", "state": "string" }, "allowed_destination_countries": [ "string" ], "callback_url": "http://example.com", "id": 0, "name": "string" }, "created_at": "2019-08-24T14:15:22Z", "fulfillment_holds": [ { "created_at": "2019-08-24T14:15:22Z", "reason": "address_incorrect", "reason_message": "string" } ], "id": 0, "line_items": [ { "currency": "string", "fulfillable_quantity": "string", "fulfillment_order_id": 0, "id": 0, "order_line_id": 0, "price_excl_tax": "string", "price_incl_tax": "string", "product_id": "string", "product_image": "http://example.com", "product_title": "string", "properties": [ { "key": "string", "value": null } ], "quantity": 0, "sku": "string", "stockrecord_id": 0, "tax_lines": [ { "amount": "string", "currency": "string", "rate": 0.1, "report_values": { "amount": "string", "currency": "string" }, "source": "string", "tax_id": 0, "tax_title": "string" } ], "total_discount": "string" } ], "merchant_requests": [ { "message": "string", "notify": true, "type": "fulfill_request" } ], "order_number": "string", "request_status": "pending", "shipping_address": { "country": "string", "first_name": "string", "id": 0, "last_name": "string", "line1": "string", "line2": "string", "line3": "string", "line4": "string", "notes": "string", "phone_number": "string", "postcode": "string", "state": "string" }, "shipping_method": { "code": "string", "name": "string" }, "status": "not_required", "supported_actions": [ null ], "updated_at": "2019-08-24T14:15:22Z" } ]}