List fulfillments
Changed onRetrieve a list of fulfillments based on various filter criteria. You can filter by shipment details, tracking information, dates, and more to find the specific fulfillments you need.
Request
- Base URLhttps://api.shipstation.com
- URLhttps://api.shipstation.com/v2/fulfillments
- AuthAPI key in header api-key
Query parameters
Filter by recipient name
Filter by ship-to country code (2-letter ISO country code)
Filter by shipment number (order number)
Filter by specific shipment id
Filter by specific fulfillment id
Filter by batch ID
Filter by order source id (store id)
Filter by fulfillment provider code
Filter by tracking number
Filter by ship date start (inclusive)
Filter by ship date end (inclusive)
Filter by creation date start (inclusive)
Filter by creation date end (inclusive)
Page number for pagination
Number of results per page
Sort direction
Sort field
Response
The request was a success.
Example response
{
"fulfillments": [
{
"fulfillment_id": "se-12345678",
"shipment_id": "se-12345678",
"shipment_number": "ORDER-001",
"user_id": "00000000-0000-0000-0000-000000000000",
"tracking_number": "1Z12345E1234567890",
"created_at": "2024-01-15T10:30:00Z",
"ship_date": "2024-01-15T00:00:00Z",
"voided_at": "2024-01-15T00:00:00Z",
"delivered_at": "2024-01-18T14:22:00Z",
"fulfillment_carrier_friendly_name": "UPS",
"fulfillment_provider_id": "se-12345678",
"fulfillment_provider_friendly_name": "ShipStation Fulfillment",
"fulfillment_provider_code": "shipstation_fulfillment",
"fulfillment_service_code": "ups_ground",
"fulfillment_fee": {
"amount": 12
},
"order_source_notified": true,
"ship_to": {
"name": "Jane Doe",
"company_name": "Example Corp",
"email": "jane@example.com",
"phone": "555-555-5555",
"address_line1": "525 S Winchester Blvd",
"city_locality": "San Jose",
"state_province": "CA",
"postal_code": "95128",
"country_code": "US"
}
}
],
"page": 1,
"pages": 10,
"total": 100,
"links": {
"first": {
"href": "https://api.shipstation.com/v2/fulfillments?page=1&page_size=100"
},
"last": {
"href": "https://api.shipstation.com/v2/fulfillments?page=3&page_size=100"
},
"prev": {
"href": "https://api.shipstation.com/v2/fulfillments?page=1&page_size=100"
},
"next": {
"href": "https://api.shipstation.com/v2/fulfillments?page=3&page_size=100"
}
}
}Changes
- warning
added the new
bring_your_own_label_not_supportedenum value to the//response property for the response status - warning
added the new
bring_your_own_label_not_supportedenum value to the//response property for the response status - warning
added the new
multiple_sales_ordersenum value to the//response property for the response status - warning
added the new
multiple_sales_ordersenum value to the//response property for the response status - warning
added the new
sales_order_link_requiredenum value to the//response property for the response status - warning
added the new
sales_order_link_requiredenum value to the//response property for the response status
- warning
- breaking
the
/response's property type changed from no type toobjectfor status - breaking
the
/response's property type changed from no type toobjectfor status - info
added the optional property
//to the response with the status - info
added the optional property
//to the response with the status - info
added the optional property
//to the response with the status - info
added the optional property
//to the response with the status - info
removed from the
/response propertyallOflist for the response status - info
removed from the
/response propertyallOflist for the response status - info
added the required property
//to the response with the status - info
added the required property
//to the response with the status - info
added the required property
//to the response with the status - info
added the required property
//to the response with the status - info
added the required property
//to the response with the status - info
added the required property
//to the response with the status - info
added the required property
//to the response with the status - info
added the required property
//to the response with the status
- breaking