API Reference

Getting Started

ShipMonk API allows building a custom integrations between ShipMonk and 3rd party software. Currently it is possible to import orders and receivings (purchase orders), getting notified when the order is shipped, import products and get returns.

Date and Time

All input and output dates are in ISO 8601 format.

Example date: 2022-05-01T11:43:16-04:00

Warehouses

It might be useful to specify the warehouse for shipment / receiving. Here is the list of our warehouses with their identifier, that we simply call warehouse. For creating orders we recommend not sending us this value, as we have a sophisticated mechanism to use the warehouse with the cheapest shipment and/or highest available inventory.

WarehouseIdentifier
FloridaFL1
CaliforniaCA1
PennsylvaniaPA1
Pennsylvania 2PA2
MexicoMX1
NevadaNV1
Nevada 2NV2
Nevada 3NV3
KentuckyKY1
New JerseyNJ1
TexasTX1
Texas BondedTX8
United KingdomUK1
CzechiaCZ1
TorontoTO1
New YorkNY1
Kentucky (Deposco)KY7
Nevada (Deposco)NV7
Toronto (Deposco)TO7
New Jersey (Deposco)NJ7
Bay Shore (Deposco)NY7
California (Deposco)CA7

Rate Limiting

ShipMonk's API is built for real-time operations and designed to handle high-volume traffic, making rate limiting uncommon under normal usage. However, ShipMonk reserves the right to implement rate limits when necessary, and client applications should include appropriate rate limiting handling in their implementation.

Maintenance of Sandbox

We try to have the Sandbox environment as available as possible. From time to time, however, we have to perform maintenance that might require smaller downtime. Such maintenance activities will be done only between 00:00-06:00 EST and will take maximally 30 minutes. Any longer downtime maintenances will be announced in advance.