Articles in this section

Available ShipStation APIs

Naga Sri Hari Gonaboyina
Updated

When you configure an export, import, or other type of flow step using the prebuilt ShipStation connector, you can select any of the API operations listed below, organized by API type.

Note

If your API endpoint isn’t listed here, switch the flow step to HTTP mode and configure the endpoint provided in the ShipStation API documentation. You can also create a composite endpoint for this application in HTTP mode.

API version: v1

Resource

API endpoint

Export

Import

Accounts

List tags

X

Carriers

List carriers

X

Get carrier

X

List packages

X

List services

X

Add funds

X

Customers

List customers

X

Get customer

X

Fulfillments

List fulfillments

X

Orders

List orders

X

List orders by tag

X

Get order

X

Add tag to order

X

Assign user to order

X

Create label for order

X

Create/update order

X

Hold order until

X

Mark an order as shipped

X

Remove tag to order

X

Restore order from on hold

X

Unassign user to order

X

Delete order

X

Products

List products

X

Get product

X

Update a product

X

Shipments

List shipments

X

Get rates

X

Create shipment label

X

Void label

X

Stores

Get store by ID

X

List stores

X

List marketplaces

X

Update store

X

Refresh store

X

Deactivate store

X

Reactivate store

X

Users

List users

X

Warehouses

List warehouses

X

Get warehouse by ID

X

Create warehouse

X

Update warehouse

X

Webhooks

List webhooks

X

Subscribe to webhook

X

Unsubscribe to webhook

X

API version: v2

Resource

API endpoint

Export

Import

Batches

List batches

X

Create a batch

X

Get batch by external ID

X

Delete batch by ID

X

Get batch by ID

X

Update batch status to 'archived' by ID

X

Add to a batch

X

Get batch errors

X

Process batch ID labels

X

Remove from batch

X

Carriers

List carriers

X

Get carrier by ID

X

Get carrier options

X

List carrier package types

X

List carrier services

X

Downloads

Download file

X

Inventory

List SKU inventory levels

X

Update SKU stock levels and related properties

X

List all inventory warehouses

X

Create a new inventory warehouse

X

Get a specific inventory warehouse and related properties using its warehouse ID

X

Update an inventory warehouse name

X

Delete an inventory warehouse

X

List all inventory locations

X

Create a new inventory location

X

Get inventory location by ID

X

Update an inventory location name

X

Delete an inventory location

X

Labels

List labels

X

Purchase label

X

Purchase label with rate ID

X

Purchase label with shipment ID

X

Get label by ID

X

Create a return label

X

Get label tracking information

X

Void a label by ID

X

Manifests

List manifests

X

Create manifest

X

Get manifest by ID

X

Package pickups

List scheduled pickups

X

Schedule a pickup

X

Get pickup by ID

X

Delete a scheduled pickup

X

Package types

List custom package types

X

Create custom package type

X

Get custom package type by ID

X

Update custom package type by ID

X

Delete a custom package by ID

X

Rates

Get shipping rates

X

Estimate rates

X

Get rate by ID

X

Shipments

List shipments

X

Create shipments

X

Get shipment by external ID

X

Get shipment by ID

X

Cancel a shipment

X

Get shipment rates

X

Add tag to shipment

X

Remove tag from shipment

X

Tags

Get tags

X

Create a new tag

X

Tracking

Stop tracking a package

X

Warehouses

List warehouses

X

Get warehouse by ID

X

Webhooks

List webhooks

X

Create a webhook

X

Get webhook by ID

X

Update a webhook

X

Delete webhook by ID

X