Welcome to the reference documentation for the ShipStream WMS Global API. The “Global” API is meant for organization-level access to all of your ShipStream data, typically focused on operational needs. For access which is limited to the data belonging to a single merchant, such as is common for shopping cart integrations, please use the Merchant API instead.

​
Danger, Will Robinson!

Do not provide Global API access tokens to your merchants, as it will allow them to access data from all of your other merchants!

​
Getting Started

Please familiarize yourself with the common features of the API to maximize the value of its capabilities. These features are designed to allow you to gain easy access to the data you need as efficiently as possible. The advanced field selection, filtering and sorting features provide a high degree of flexibility while being easy to consume. The ShipStream WMS Global API is a RESTful API that allows you to interact with your ShipStream data programmatically. It supports standard HTTP methods such as GET, POST, PUT, and DELETE. We currently do not provide official SDKs, but you can use any HTTP client to interact with the API. Additionally, the API adheres to the OpenAPI 3.0.4 specification, allowing you to generate client libraries in just about any common programming language and use a large number of Open API tools.
See Find Your URL for information on finding the correct URL to use for your ShipStream instance.

​
Reference Files

As the OpenAPI specs are very detailed and there are many endpoints, we have split the OpenAPI spec into several files to make them easier to consume and navigate. There are also different versions of the OpenAPI spec available, depending on your needs. The files are available at the following urls:
  • Release (recommended): https://openapi.shipstream.io/global/release-{version}/{reference}
  • Latest (always the latest release): https://openapi.shipstream.io/global/latest/{reference}
  • Nightly (latest development version): https://openapi.shipstream.io/global/nightly/{reference}
Where {version} is the release version with hyphens (e.g. 2025-5), and {reference} is one of the following:
  • combined.json: The complete OpenAPI specification for the Global API, combining all of the below references into one.
  • system.json: Provides information on system operations, including system status, users, and merchants.
  • inventory.json: Contains endpoints related to inventory management, such as products, locations, and stock levels.
  • receiving.json: Covers endpoints for managing receiving operations (ASNs and RMAs).
  • shipping.json: Covers endpoints for shipping operations (orders and shipments).
Example: https://openapi.shipstream.io/global/latest/combined.json