Account management and tag operations
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.
New integrations should use ShipStation API V2 whenever possible. This V1 API is maintained for existing integrations.
Download OpenAPI description
Overview
Languages
Servers
Mock server
https://docs.shipstation.com/_mock/apis/shipstation-v1/openapi/
Production Server
https://ssapi.shipstation.com/
- Mock serverhttps://docs.shipstation.com/_mock/apis/shipstation-v1/openapi/webhooks
- Production Serverhttps://ssapi.shipstation.com/webhooks
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
https://docs.shipstation.com/_mock/apis/shipstation-v1/openapi/webhooksResponse
application/json
{ "webhooks": [ { … } ] }
Bodyapplication/jsonrequired
The URL to send the webhooks to
Example: "http://someexamplewebhookurl.com/neworder"
The type of webhook to subscribe to
Enum"ORDER_NOTIFY""ITEM_ORDER_NOTIFY""SHIP_NOTIFY""ITEM_SHIP_NOTIFY""FULFILLMENT_SHIPPED""FULFILLMENT_REJECTED"
Example: "ORDER_NOTIFY"
Store ID (optional - webhooks will only trigger for this store)
Example: 12345
Any of:
Store ID (optional - webhooks will only trigger for this store)
integer
- Mock serverhttps://docs.shipstation.com/_mock/apis/shipstation-v1/openapi/webhooks/subscribe
- Production Serverhttps://ssapi.shipstation.com/webhooks/subscribe
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
-u <username>:<password> \
https://docs.shipstation.com/_mock/apis/shipstation-v1/openapi/webhooks/subscribe \
-H 'Content-Type: application/json' \
-d '{
"target_url": "http://someexamplewebhookurl.com/neworder",
"event": "ORDER_NOTIFY",
"store_id": 12345,
"friendly_name": "My Webhook"
}'Response
application/json
{ "WebHookID": 123456, "HookType": "string", "Url": "string", "Name": "string" }
- Mock serverhttps://docs.shipstation.com/_mock/apis/shipstation-v1/openapi/webhooks/{webhookId}
- Production Serverhttps://ssapi.shipstation.com/webhooks/{webhookId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
-u <username>:<password> \
https://docs.shipstation.com/_mock/apis/shipstation-v1/openapi/webhooks/123456Response
application/json
{ "success": true, "message": "Webhook deleted successfully" }