List fulfillments
<aside class="access" aria-label="Endpoint access"> <table class="access__table"> <thead> <tr> <th class="access__table-header">Products</th> <th class="access__table-header">Plans</th> </tr> </thead> <tbody> <tr> <td class="access__table-cell access__product"> <img class="access__logo" src="/static/logos/shipstation-api-logo.svg" alt="ShipStation API Logo" loading="lazy" decoding="async"/> <div class="access__sub">Formerly ShipEngine</div> </td> <td class="access__table-cell access__plans"> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-api-free.md" class="access__plan">Free</a> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-api-advanced-enterprise.md" class="access__plan">Advanced</a> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-api-advanced-enterprise.md" class="access__plan">Enterprise</a> </td> </tr> <tr> <td class="access__table-cell"> <img class="access__logo" src="/static/logos/shipstation-logo.svg" alt="ShipStation Logo" loading="lazy" decoding="async"/> </td> <td class="access__table-cell access__plans"> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-free-starter.md" class="access__plan access__plan--off">Free</a> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-free-starter.md" class="access__plan access__plan--off">Starter</a> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-standard-premium.md" class="access__plan">Standard</a> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-standard-premium.md" class="access__plan">Premium</a> </td> </tr> </tbody> </table> <footer class="access__footer"> <a class="access__help" href="/apis/@shipstation-v2/docs/getting-started/products-and-plans.md"> Learn about products and plans <img src="/static/icons/external-link.svg" alt="External Link Icon" style="width: 16px;" loading="lazy" decoding="async"/> </a> </footer> </aside>Retrieve 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.
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
Changed in 1 of the 6 revisions of this API.12
- ●
added the new
freight_connection_inactiveenum value to theerrors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/response property for the response status400response-property-enum-value-added
- ●
added the new
freight_connection_inactiveenum value to theerrors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/response property for the response status404response-property-enum-value-added
- ●
added the new
freight_provider_id_requiredenum value to theerrors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/response property for the response status400response-property-enum-value-added
- ●
added the new
freight_provider_id_requiredenum value to theerrors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/response property for the response status404response-property-enum-value-added
- ●
added the new
freight_shipment_not_batchableenum value to theerrors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/response property for the response status400response-property-enum-value-added
- ●
added the new
freight_shipment_not_batchableenum value to theerrors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/response property for the response status404response-property-enum-value-added
- ●
added the new
freight_shipment_not_foundenum value to theerrors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/response property for the response status400response-property-enum-value-added
- ●
added the new
freight_shipment_not_foundenum value to theerrors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/response property for the response status404response-property-enum-value-added
- ●
added the new
freight_tracking_not_availableenum value to theerrors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/response property for the response status400response-property-enum-value-added
- ●
added the new
freight_tracking_not_availableenum value to theerrors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/response property for the response status404response-property-enum-value-added
- ●
added the new
freight_tracking_not_foundenum value to theerrors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/response property for the response status400response-property-enum-value-added
- ●
added the new
freight_tracking_not_foundenum value to theerrors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/response property for the response status404response-property-enum-value-added
- ●