List Fulfillments

Obtains a list of fulfillments that match the specified criteria. Please note the following:

  • Orders that have been marked as shipped either through the UI or the API will appear in the response as they are considered fulfillments.

All of the available filters are optional. They do not need to be included in the URL. If you do include them, here's what the URL may look like:

Url format with filters:

fulfillments?fulfillmentId={fulfillmentId}
&orderId={orderId}
&orderNumber={orderNumber}
&trackingNumber={trackingNumber}
&recipientName={recipientName}
&createDateStart={createDateStart}
&createDateEnd={createDateEnd}
&shipDateStart={shipDateStart}
&shipDateEnd={shipDateEnd}
&sortBy={sortBy}
&sortDir={sortDir}
&page={page}
&pageSize={pageSize}
Name Date Type Description
fulfillmentId number, optional Returns the fulfillment with the specified fulfillment ID.
orderId number, optional Returns fulfillments whose orders have the specified order ID.
orderNumber string, optional Returns fulfillments whose orders have the specified order number.
trackingNumber string, optional Returns fulfillments with the specified tracking number.
recipientName string, optional Returns fulfillments shipped to the specified recipient name.
createDateStart string, optional Returns fulfillments created on or after the specified createDate.
createDateEnd string, optional Returns fulfillments created on or before the specified createDate.
shipDateStart string, optional Returns fulfillments with the shipDate on or after the specified date.
shipDateEnd string, optional Returns fulfillments with the shipDate on or before the specified date.
sortBy string, optional
Values:
  • ShipDate
  • CreateDate
Sort the responses by a set value. The response will be sorted based off the ascending dates (oldest to most current). If left empty, the response will be sorted by ascending createDate.
sortDir string, optional
Values:
  • ASC
  • DESC
Sets the direction of the sort order.
page number, optional Page number.
pageSize number, optional Page size.

Example Request

GET /fulfillments?fulfillmentId={fulfillmentId}&orderId={orderId}&orderNumber={orderNumber}&trackingNumber={trackingNumber}&recipientName={recipientName}&createDateStart={createDateStart}&createDateEnd={createDateEnd}&shipDateStart={shipDateStart}&shipDateEnd={shipDateEnd}&sortBy={sortBy}&sortDir={sortDir}&page={page}&pageSize={pageSize} HTTP/1.1
Host: ssapi.shipstation.com
Authorization: __YOUR_AUTH_HERE__

Example Response

{
  "fulfillments": [
    {
      "fulfillmentId": 33974374,
      "orderId": 191759016,
      "orderNumber": "101",
      "userId": "c9f06d74-95de-4263-9b04-e87095cababf",
      "customerEmail": "[email protected]",
      "trackingNumber": "783408231234",
      "createDate": "2016-06-07T08:50:50.0670000",
      "shipDate": "2016-06-07T00:00:00.0000000",
      "voidDate": null,
      "deliveryDate": null,
      "carrierCode": "USPS",
      "fulfillmentProviderCode": null,
      "fulfillmentServiceCode": null,
      "fulfillmentFee": 0,
      "voidRequested": false,
      "voided": false,
      "marketplaceNotified": true,
      "notifyErrorMessage": null,
      "shipTo": {
        "name": "Yoda",
        "company": null,
        "street1": "3800 N Lamar Blvd # 220",
        "street2": null,
        "street3": null,
        "city": "AUSTIN",
        "state": "TX",
        "postalCode": "78756",
        "country": "US",
        "phone": "512-485-4282",
        "residential": null,
        "addressVerified": null
      }
    },
    {
      "fulfillmentId": 246310,
      "orderId": 193699927,
      "orderNumber": "101",
      "userId": "c9f06d74-95de-4263-9b04-e87095cababf",
      "customerEmail": "[email protected]",
      "trackingNumber": "664756278745",
      "createDate": "2016-06-08T12:54:53.3470000",
      "shipDate": "2016-06-08T00:00:00.0000000",
      "voidDate": null,
      "deliveryDate": null,
      "carrierCode": "FedEx",
      "fulfillmentProviderCode": null,
      "fulfillmentServiceCode": null,
      "fulfillmentFee": 0,
      "voidRequested": false,
      "voided": false,
      "marketplaceNotified": true,
      "notifyErrorMessage": null,
      "shipTo": {
        "name": "Yoda",
        "company": null,
        "street1": "3800 N Lamar Blvd # 220",
        "street2": null,
        "street3": null,
        "city": "AUSTIN",
        "state": "TX",
        "postalCode": "78756",
        "country": "US",
        "phone": "512-485-4282",
        "residential": null,
        "addressVerified": null
      }
    }
  ],
  "total": 2,
  "page": 1,
  "pages": 0
}