Skip to content
Full API Reference/
/
Create a new supplier

ShipStation API v2 (2.0.0)

Download OpenAPI description
openapi.json
openapi.yaml
Overview
License
MIT
Languages
Servers
Mock server
https://docs.shipstation.com/_mock/openapi/
Production
https://api.shipstation.com/

Batches

Process labels in bulk and receive a large number of labels and customs forms in bulk responses. Batching is ideal for workflows that need to process hundreds or thousands of labels quickly.

Operations

Carriers

Retreive useful details about the carriers connected to your accounts, including carrier IDs, service IDs, advanced options, and available carrier package types.

Operations

Downloads

Download your label files in PDF, PNG, and ZPL.

Operations

Fulfillments

Manage fulfillments which represent completed shipments. Create fulfillments to mark orders as shipped with tracking information and notify customers and marketplaces.

Operations

Inventory

Manage inventory levels, warehouses, and locations.

Operations

Labels

Purchase and print shipping labels for any carrier active on your account. The labels endpoint also supports creating return labels, voiding labels, and getting label details like tracking.

Operations

Manifests

A manifest is a document that provides a list of the day's shipments. It typically contains a barcode that allows the pickup driver to scan a single document to register all shipments, rather than scanning each shipment individually.

Operations

Package Pickups

Scheduled pickups and manage pickup requests for supported carriers.

Operations

Package Types

Create custom package types to use for your shipments, rather than the carriers' default package types.

Operations

Products

Manage products in your ShipStation account. Products represent the items you sell and ship to customers.

Operations

Purchase Orders

Create and manage purchase orders from suppliers to replenish inventory. Track order status, receive products, and update inventory levels automatically.

Operations

Rates

Quickly compare rates using the Rates endpoint. You can see and compare rates for the carriers connected to your account (as long as they support sending rates).

Operations

Shipments

Shipments are at the core of most ShipStation capabilities. Shipment objects are required for cretaing labels and manifests, as well as getting rates.

Operations

Suppliers

Manage supplier information including contact details, email addresses, and physical addresses. Suppliers are used when creating purchase orders.

Operations

List suppliers

Request

Retrieve a paginated list of all suppliers with optional filtering by supplier name.

Security
api_keys
Query
supplier_namestring

Filter by supplier name (partial match)

page_sizeinteger[ 1 .. 500 ]

Number of results per page

Default 50
curl -i -X GET \
  'https://docs.shipstation.com/_mock/openapi/v2/suppliers?supplier_name=string&page_size=50' \
  -H 'api-key: YOUR_API_KEY_HERE'

Responses

The request was a success.

Bodyapplication/json
suppliersArray of objects
totalinteger

Total number of suppliers

Example: 25
pageinteger

Current page number

Example: 2
pagesinteger

Total number of pages

Example: 3
linksobject
Response
application/json
{
  "suppliers": [
    { … }
  ],
  "total": 25,
  "page": 2,
  "pages": 3,
  "links": {
    "first": { … },
    "next": { … }
  }
}

Create a new supplier

Request

Create a new supplier with contact and address information.

Security
api_keys
Bodyapplication/jsonrequired
supplier_namestringrequired

Name of the supplier

Example: "Acme Widgets Inc"
supplier_emailstring(email)

Email address of the supplier

Example: "orders@acmewidgets.com"
address_line_1string

First line of address

Example: "123 Main St"
address_line_2string

Second line of address

Example: "Suite 100"
citystring

City

Example: "Austin"
statestring

State or province

Example: "TX"
postal_codestring

Postal or ZIP code

Example: "78701"
country_codestring

ISO 3166-1 alpha-2 country code

Example: "US"
contact_namestring

Contact person name

Example: "John Doe"
contact_phonestring

Contact phone number

Example: "512-555-0100"
curl -i -X POST \
  https://docs.shipstation.com/_mock/openapi/v2/suppliers \
  -H 'Content-Type: application/json' \
  -H 'api-key: YOUR_API_KEY_HERE' \
  -d '{
    "supplier_name": "Acme Widgets Inc",
    "supplier_email": "orders@acmewidgets.com",
    "address_line_1": "123 Main St",
    "address_line_2": "Suite 100",
    "city": "Austin",
    "state": "TX",
    "postal_code": "78701",
    "country_code": "US",
    "contact_name": "John Doe",
    "contact_phone": "512-555-0100"
  }'

Responses

Supplier created successfully

Bodyapplication/json
supplier_idstring

Unique identifier for the created supplier

Example: "se-567"
Response
application/json
{
  "supplier_id": "se-567"
}

Get supplier details

Request

Retrieve detailed information about a specific supplier.

Security
api_keys
Path
supplier_idstringrequired

The supplier identifier

Example: se-567
curl -i -X GET \
  https://docs.shipstation.com/_mock/openapi/v2/suppliers/se-567 \
  -H 'api-key: YOUR_API_KEY_HERE'

Responses

Supplier details retrieved successfully

Bodyapplication/json
supplier_idstring
Example: "se-567"
supplier_namestring
Example: "Acme Widgets Inc"
supplier_emailstring(email)
Example: "orders@acmewidgets.com"
address_line_1string
Example: "123 Main St"
address_line_2string
Example: "Suite 100"
citystring
Example: "Austin"
statestring
Example: "TX"
postal_codestring
Example: "78701"
country_codestring
Example: "US"
contact_namestring
Example: "John Doe"
contact_phonestring
Example: "512-555-0100"
Response
application/json
{
  "supplier_id": "se-567",
  "supplier_name": "Acme Widgets Inc",
  "supplier_email": "orders@acmewidgets.com",
  "address_line_1": "123 Main St",
  "address_line_2": "Suite 100",
  "city": "Austin",
  "state": "TX",
  "postal_code": "78701",
  "country_code": "US",
  "contact_name": "John Doe",
  "contact_phone": "512-555-0100"
}

Update a supplier

Request

Update an existing supplier's information.

Security
api_keys
Path
supplier_idstringrequired

The supplier identifier

Example: se-567
Bodyapplication/jsonrequired
supplier_namestringrequired
Example: "Acme Widgets Inc"
supplier_emailstring(email)
Example: "orders@acmewidgets.com"
address_line_1string
Example: "123 Main St"
address_line_2string
Example: "Suite 100"
citystring
Example: "Austin"
statestring
Example: "TX"
postal_codestring
Example: "78701"
country_codestring
Example: "US"
contact_namestring
Example: "John Doe"
contact_phonestring
Example: "512-555-0100"
curl -i -X PUT \
  https://docs.shipstation.com/_mock/openapi/v2/suppliers/se-567 \
  -H 'Content-Type: application/json' \
  -H 'api-key: YOUR_API_KEY_HERE' \
  -d '{
    "supplier_name": "Acme Widgets Inc",
    "supplier_email": "orders@acmewidgets.com",
    "address_line_1": "123 Main St",
    "address_line_2": "Suite 100",
    "city": "Austin",
    "state": "TX",
    "postal_code": "78701",
    "country_code": "US",
    "contact_name": "John Doe",
    "contact_phone": "512-555-0100"
  }'

Responses

Supplier updated successfully

Bodyapplication/json
supplier_idstring

Unique identifier for the updated supplier

Example: "se-567"
Response
application/json
{
  "supplier_id": "se-567"
}

Tags

Tags are text-based identifiers you can add to shipments to help in your shipment management workflows.

Operations

Totes

Manage totes (bins or containers) used in warehouse picking and packing operations. Create, update, delete totes and track tote quantities by warehouse.

Operations

Tracking

Use the tracking endpoint to stop receiving tracking updates (more dedicated tracking endpoint methods coming soon).

Operations

Warehouses

Get warehouse details like warehouse ID and related addresses using the warehouses endpoint.

Operations

Users

Manage and retrieve user information for the ShipStation account. This endpoint allows you to list users with various filtering options.

Operations

Webhooks

Webhooks are a powerful feature that can save you from sending repeated polling requests to check on the state of something. With webhooks, ShipStation will automatically contact your servers when the stage changes. This can include parcel tracking events, notification when a batch operation completes, and more.

Operations