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.
ShipStation API v2 (2.0.0)
Download OpenAPI description
Overview
License
Languages
Servers
Mock server
https://docs.shipstation.com/_mock/openapi/
Production
https://api.shipstation.com/
- Mock serverhttps://docs.shipstation.com/_mock/openapi/v2/warehouses
- Productionhttps://api.shipstation.com/v2/warehouses
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
https://docs.shipstation.com/_mock/openapi/v2/warehouses \
-H 'api-key: YOUR_API_KEY_HERE'The request was a success.
The array of warehouses returned by the API call
A string that uniquely identifies the warehouse
Example: "se-28529731"
Designates which single warehouse is the default on the account
Default false
Example: true
Timestamp that indicates when the warehouse was created
Example: "2019-06-25T18:12:35.583Z"
Any residential or business mailing address, anywhere in the world.
Note: Either
nameorcompany_namemust be set. Both may be specified, if relevant.
Response
application/json
{ "warehouses": [ { … } ] }
- Mock serverhttps://docs.shipstation.com/_mock/openapi/v2/warehouses/{warehouse_id}
- Productionhttps://api.shipstation.com/v2/warehouses/{warehouse_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
https://docs.shipstation.com/_mock/openapi/v2/warehouses/se-28529731 \
-H 'api-key: YOUR_API_KEY_HERE'The request was a success.
A string that uniquely identifies the warehouse
Example: "se-28529731"
Designates which single warehouse is the default on the account
Default false
Example: true
Timestamp that indicates when the warehouse was created
Example: "2019-06-25T18:12:35.583Z"
Any residential or business mailing address, anywhere in the world.
Note: Either
nameorcompany_namemust be set. Both may be specified, if relevant.
The name of a contact person at this address. This field may be set instead of - or in addition to - the company_name field.
Example: "John Doe"
The phone number of a contact person at this address. The format of this phone number varies depending on the country.
Example: "+1 204-253-9411 ext. 123"
If this is a business address, then the company name should be specified here.
Example: "The Home Depot"
The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines.
Example: "1999 Bishop Grandin Blvd."
The second line of the street address. For some addresses, this line may not be needed.
Example: "Unit 408"
The third line of the street address. For some addresses, this line may not be needed.
Example: "Building #7"
The name of the city or locality
Example: "Winnipeg"
The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation.
Example: "Manitoba"
A two-letter ISO 3166-1 country code
Example: "CA"
Any residential or business mailing address, anywhere in the world.
Note: Either
nameorcompany_namemust be set. Both may be specified, if relevant.
The name of a contact person at this address. This field may be set instead of - or in addition to - the company_name field.
Example: "John Doe"
The phone number of a contact person at this address. The format of this phone number varies depending on the country.
Example: "+1 204-253-9411 ext. 123"
If this is a business address, then the company name should be specified here.
Example: "The Home Depot"
The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines.
Example: "1999 Bishop Grandin Blvd."
The second line of the street address. For some addresses, this line may not be needed.
Example: "Unit 408"
The third line of the street address. For some addresses, this line may not be needed.
Example: "Building #7"
The name of the city or locality
Example: "Winnipeg"
The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation.
Example: "Manitoba"
A two-letter ISO 3166-1 country code
Example: "CA"
Response
application/json
{ "warehouse_id": "se-28529731", "is_default": true, "name": "Zero Cool HQ", "created_at": "2019-06-25T18:12:35.583Z", "origin_address": { "name": "John Doe", "phone": "+1 204-253-9411 ext. 123", "email": "example@example.com", "company_name": "The Home Depot", "address_line1": "1999 Bishop Grandin Blvd.", "address_line2": "Unit 408", "address_line3": "Building #7", "city_locality": "Winnipeg", "state_province": "Manitoba", "postal_code": "78756-3717", "country_code": "CA", "address_residential_indicator": "yes" }, "return_address": { "name": "John Doe", "phone": "+1 204-253-9411 ext. 123", "email": "example@example.com", "company_name": "The Home Depot", "address_line1": "1999 Bishop Grandin Blvd.", "address_line2": "Unit 408", "address_line3": "Building #7", "city_locality": "Winnipeg", "state_province": "Manitoba", "postal_code": "78756-3717", "country_code": "CA", "address_residential_indicator": "yes" } }
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