Fulfillments
Get Fulfillments Summary
Retrieves a paginated list of fulfillment summary items with optional filtering
get/fulfillments
Query parameters
outlet_idstring[]
Filter by outlet IDs (can be specified multiple times)
sale_idstring[]
Filter by sale IDs (can be specified multiple times)
fulfillment_typestring[]
Filter by fulfillment types (can be specified multiple times)
fulfillment_statestring[]
Filter by fulfillment states (can be specified multiple times)
page_numberinteger
Page number for pagination (1-based)
page_sizeinteger
Number of items per page
Response
Successful response with fulfillment summary data
Example response
{
"data": [
{
"created_at": "2024-01-15T10:30:00Z",
"id": "1947700198720344064",
"line_items": [
{
"fulfilled_quantity": "0.00",
"packed_quantity": "0.00",
"picked_quantity": "0.00",
"product_id": "e9d7d1b3-0561-45f5-9e40-c7bfa81db394",
"quantity": "5.00",
"sale_line_item_id": "460e1119-2f41-42a3-bd61-3f9639e2e265"
}
],
"note": "Customer requested specific pickup time\nHandle with care",
"outlet_id": "e058ea02-c565-405f-be27-cefaeeca1f92",
"sale_id": "81b37e5f-aa50-4fe3-95d3-a3cec73a7e2c",
"shipping_address_id": "12345678901234567",
"state": "OPEN",
"type": "PICKUP",
"updated_at": "2024-01-15T14:20:00Z",
"user_ids": [
"cca2eff2-9d4a-403b-a045-af953b6572b0"
],
"version": 1
}
]
}