Skip to content

ShipStation V1 API (Legacy) (1.0.0)

The ShipStation V1 API (Legacy) provides comprehensive functionality for managing orders, shipments, carriers, and more within the ShipStation platform.

Getting Started

New integrations should use ShipStation API V2 whenever possible. This V1 API is maintained for existing integrations.

Download OpenAPI description
Languages
Servers
Mock server
https://docs.shipstation.com/_mock/apis/shipstation-v1/openapi/
Production Server
https://ssapi.shipstation.com/

Accounts

Account management and tag operations

Operations

Carriers

Carrier information and package/service listings

Operations

Customers

Customer management

Operations

Fulfillments

Fulfillment operations

Operations

List fulfillments

Request

Obtains a list of fulfillments that match the specified criteria.

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

Security
basicAuth
Query
fulfillmentIdinteger

Returns the fulfillment with the specified fulfillment ID

orderIdinteger

Returns fulfillments whose orders have the specified order ID

orderNumberstring

Returns fulfillments whose orders have the specified order number

trackingNumberstring

Returns fulfillments with the specified tracking number

recipientNamestring

Returns fulfillments shipped to the specified recipient name

createDateStartstring(date-time)

Returns fulfillments created on or after the specified date

createDateEndstring(date-time)

Returns fulfillments created on or before the specified date

shipDateStartstring(date)

Returns fulfillments with shipDate on or after the specified date

shipDateEndstring(date)

Returns fulfillments with shipDate on or before the specified date

sortBystring

Sort the responses by a set value

Enum"ShipDate""CreateDate"
sortDirstring

Sort direction

Default "ASC"
Enum"ASC""DESC"
pageinteger>= 1

Page number

Default 1
pageSizeinteger[ 1 .. 500 ]

Number of results per page. Maximum 500.

Default 100
curl -i -X GET \
  -u <username>:<password> \
  'https://docs.shipstation.com/_mock/apis/shipstation-v1/openapi/fulfillments?fulfillmentId=0&orderId=0&orderNumber=string&trackingNumber=string&recipientName=string&createDateStart=2019-08-24T14%3A15%3A22Z&createDateEnd=2019-08-24T14%3A15%3A22Z&shipDateStart=2019-08-24&shipDateEnd=2019-08-24&sortBy=ShipDate&sortDir=ASC&page=1&pageSize=100'

Responses

List of fulfillments retrieved successfully

Bodyapplication/json
fulfillmentsArray of objects
totalinteger
pageinteger
pagesinteger
Response
application/json
{ "fulfillments": [ {} ], "total": 0, "page": 0, "pages": 0 }

Orders

Order management and operations

Operations

Products

Product catalog management

Operations

Shipments

Shipment operations and rate shopping

Operations

Stores

Store configuration and management

Operations

Users

User management

Operations

Warehouses

Warehouse and fulfillment location management

Operations

Webhooks

Webhook subscription management

Operations