Listing Fulfillments

Retrieve a list of fulfillments based on various filter criteria. Fulfillments represent completed shipments that have been marked as shipped with tracking information.

Use Query Parameters Request & Response

When you list fulfillments, you can add query parameters to filter which fulfillments are returned in the response. All query parameters are optional when listing fulfillments.

Fulfillment Provider Response Fields

Not all fields in the response of the listing endpoint below can be assigned when creating fulfillments. The values for these fields will depend on your fulfillment provider settings in ShipStation.

GET /v2/fulfillments

curl -i -X GET \
  'https://api.shipstation.com/v2/fulfillments?batch_id=string&create_date_end=2019-08-24T14%3A15%3A22Z&create_date_start=2019-08-24T14%3A15%3A22Z&fulfillment_id=string&fulfillment_provider_code=string&order_source_id=string&page=1&page_size=25&ship_date_end=2019-08-24T14%3A15%3A22Z&ship_date_start=2019-08-24T14%3A15%3A22Z&ship_to_country_code=string&ship_to_name=string&shipment_id=string&shipment_number=string&sort_by=created_at&sort_dir=asc&tracking_number=string' \
  -H 'api-key: YOUR_API_KEY_HERE'

Response

application/json

{
  "fulfillments": [
    { … }
  ],
  "page": 0,
  "pages": 0,
  "total": 0,
  "links": {
    "first": { … },
    "last": { … },
    "prev": { … },
    "next": { … }
  }
}

Listing Fulfillments

Use Query Parameters Request & Response

Was this helpful?