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

Available DI objects

The following objects are available when using ShipStation as a source in Celigo Data Integration (DI).

Primary key: ShipStation DI endpoints use entity-specific primary keys — shipment_id for shipments, carrier_id for carriers, warehouse_id for warehouses, package_id for packages, sku for inventory levels, and name for tags. Each resource has its own unique identifier field.

Note: ShipStation hard deletes records. Deleted records are not retrievable via the API. Celigo syncs all data returned by the source as-is.

Object API endpoint Available extract modes Delta field
Carriers List carriers Full —
Inventory List SKU inventory levels Full —
Package types List custom package types Full —
Shipments List shipments Full, Incremental modified_at_start
Tags Get tags Full —
Warehouses List warehouses Full —

Response schemas

Click an object below to view its response fields and delta configuration.

Carriers — List carriers

Response schema:

Field Type
carrier_id string (Primary key)
carrier_code string
account_number string
connection_status string
requires_funded_amount boolean
balance number
nickname string
friendly_name string
funding_source_id string
primary boolean
has_multi_package_supporting_services boolean
supports_label_messages boolean
disabled_by_billing_plan boolean
services objectarray
services.carrier_id string
services.carrier_code string
services.service_code string
services.name string
services.domestic boolean
services.international boolean
services.is_multi_package_supported boolean
services.send_rates boolean
packages objectarray
packages.package_id string
packages.package_code string
packages.name string
packages.dimensions object
packages.dimensions.unit string
packages.dimensions.length number
packages.dimensions.width number
packages.dimensions.height number
packages.description string
options objectarray
options.name string
options.default_value string
options.description string
send_rates boolean
supports_user_managed_rates boolean
Inventory — List SKU inventory levels

Response schema:

Field Type
sku string (Primary key)
on_hand number
allocated number
available number
average_cost object
average_cost.amount number
average_cost.currency string
inventory_warehouse_id string
inventory_location_id string
Package types — List custom package types

Response schema:

Field Type
package_id string (Primary key)
package_code string
name string
description string
dimensions object
dimensions.unit string
dimensions.length number
dimensions.width number
dimensions.height number
Shipments — List shipments

Delta configuration: use it to request incremental data.

Setting Value
Delta filter modified_at_start = {{{lastExportDateTime}}}
Date format YYYY-MM-DDTHH:mm:ss.SSSZ

Response schema:

Field Type
shipment_id string (Primary key)
carrier_id string
service_code string
requested_shipment_service string
external_shipment_id string
external_order_id string
ship_date string
created_at string
modified_at string
shipment_status string
hold_until_date string
ship_by_date string
deliver_by_date string
confirmation string
insurance_provider string
store_id string
ship_to object
ship_from object
return_to object
retail_rate object
retail_rate.currency string
retail_rate.amount number
advanced_options object
tags objectarray
tags.name string
total_weight object
total_weight.value number
total_weight.units string
packages objectarray
items objectarray
Tags — Get tags

Response schema:

Field Type
name string (Primary key)
Warehouses — List warehouses

Response schema:

Field Type
warehouse_id string (Primary key)
is_default boolean
name string
created_at string
origin_address object
origin_address.name string
origin_address.phone string
origin_address.email string
origin_address.company_name string
origin_address.address_line1 string
origin_address.address_line2 string
origin_address.address_line3 string
origin_address.city_locality string
origin_address.state_province string
origin_address.postal_code string
origin_address.country_code string
origin_address.address_residential_indicator string
return_address object
return_address.name string
return_address.phone string
return_address.email string
return_address.company_name string
return_address.address_line1 string
return_address.address_line2 string
return_address.address_line3 string
return_address.city_locality string
return_address.state_province string
return_address.postal_code string
return_address.country_code string
return_address.address_residential_indicator string