fulfillments

List fulfillments

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.

get/v2/fulfillments

Request

  • Base URL: https://api.shipstation.com
  • URL: https://api.shipstation.com/v2/fulfillments
  • Auth: API key in header api-key

Query parameters

ship_to_namestring

Filter by recipient name

ship_to_country_codestring

Filter by ship-to country code (2-letter ISO country code)

shipment_numberstring

Filter by shipment number (order number)

shipment_idstring

Filter by specific shipment id

fulfillment_idstring

Filter by specific fulfillment id

batch_idstring

Filter by batch id

order_source_idstring

Filter by order source id (store id)

fulfillment_provider_codestring

Filter by fulfillment provider code

tracking_numberstring

Filter by tracking number

ship_date_startstring date-time

Filter by ship date start (inclusive)

ship_date_endstring date-time

Filter by ship date end (inclusive)

create_date_startstring date-time

Filter by creation date start (inclusive)

create_date_endstring date-time

Filter by creation date end (inclusive)

pageinteger

Page number for pagination

page_sizeinteger

Number of results per page

sort_dir'asc' | 'desc'

Sort direction

sort_by'created_at' | 'modified_at' | 'shipped_at'

Sort field

Response

The request was a success.

pageinteger

Current page number

pagesinteger

Total number of pages

totalinteger

Total number of fulfillments

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.5,
        "currency": "usd"
      },
      "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

No recorded changes to this operation across all 1 revision of this API.