The ShipMonk API enables developers to build custom integrations between ShipMonk and third-party software.
Overview
The ShipMonk API enables developers to build custom integrations between ShipMonk and third-party software.
For assistance with API related issues or inquiries, please reach out to [email protected]
Date and Time
All date and time values follow the ISO 8601 format. Example: 2022-05-01T11:43:16-04:00
Warehouses
Some API operations allow or require specifying a warehouse for shipments or receivings. Below is the list of ShipMonk warehouse identifiers.
Note: When creating orders, we recommend omitting the warehouse field. ShipMonk automatically routes orders to the optimal warehouse based on inventory availability and shipping cost.
| Warehouse | Identifier |
|---|---|
| Czechia | CZ1 |
| Kentucky | KY1 |
| Kentucky Bonded | KY8 |
| Kentucky 2 | KY2 |
| Mexico | MX1 |
| Nevada | NV1 |
| Nevada 3 | NV3 |
| Pennsylvania | PA1 |
| Pennsylvania 2 | PA2 |
| Pennsylvania 2 Bonded | PA8 |
| Texas | TX1 |
| Texas Bonded | TX8 |
| Toronto | TO1 |
| United Kingdom | UK1 |
Deprecated warehouses
New orders cannot be routed to these warehouses. Identifiers are retained for historical data and existing references.
| Warehouse | Identifier |
|---|---|
| Bay Shore (Deposco) | NY7 |
| California (Deposco) | CA7 |
| Kentucky (Deposco) | KY7 |
| Nevada 2 | NV2 |
| Nevada (Deposco) | NV7 |
| New Jersey | NJ1 |
| New Jersey (Deposco) | NJ7 |
| Toronto (Deposco) | TO7 |
| California | CA1 |
| Florida | FL1 |
Rate Limiting
The ShipMonk API enforces rate limits per account (merchant) to ensure platform stability. Limits are applied on a rolling basis as described below.
General Endpoints
All endpoints except the Orders List endpoint have a default limit of 100,000 requests per minute. Contact [email protected] to request a custom limit for your account.
Orders List Endpoint
The GET /v1/integrations/orders-list endpoint has a stricter limit of 1,000 requests per 30 minutes. Plan polling intervals accordingly.
Handling Rate Limit Responses
When a rate limit is exceeded, the API returns:
-
HTTP 429 Too Many Requests
-
A
Retry-Afterheader with the earliest retry time in RFC 1123 format: Retry-After: Mon, 01 Jan 2024 12:00:00 GMT -
A response body with an informational message indicating when to retry. This message is intended for human readability — use the
Retry-Afterheader for programmatic retry logic.
Your integration should read the Retry-After header and wait until that time before retrying. Implement exponential backoff for sustained 429 responses. Do not retry immediately — this will not restore tokens faster and may result in continued rate limiting.
Sandbox Environment Maintenance
ShipMonk aims to keep the Sandbox environment available at all times. However, periodic maintenance may cause brief downtime between 00:00 - 06:00 EST, typically lasting no longer than 30 minutes. Any extended maintenance windows will be announced in advance.
API Support
For assistance with API related issues or inquiries, please reach out to [email protected]