Welcome to the ShipStream Developer Center! This site is primarily for developers looking to integrate with the ShipStream WMS APIs. If you are looking for user documentation, please visit our Knowledge Base. ShipStream offers two main APIs: the Global API and the Merchant API. Understanding their differences is crucial for choosing the right integration path.

​
Global API vs. Merchant API

​
Global API

The Global API is designed for 3PLs (Third-Party Logistics providers) or for managing warehouse operations. It provides comprehensive access to operational data and allows for broad management across multiple merchants. Use Cases for Global API:
  • Syncing data for all merchants into an external centralized sytstem.
  • Obtaining operational data for reporting across all merchants.
  • Performing daily operations outside of the Admin UI or Scanner UI.
  • Integrating with ERPs (Enterprise Resource Planning) and WESs (Warehouse Execution Systems).

​
Merchant API

The Merchant API is tailored for individual merchants to synchronize their e-commerce platforms, shopping carts, and other systems with their ShipStream WMS (Warehouse Management System) instance. This is ideal for merchants who work with a 3PL using ShipStream or those who self-fulfill. Use Cases for Merchant API:
  • Syncing shopping cart data (orders, tracking, inventory) for a single merchant.
  • Creating ASNs (Advance Shipment Notifications) when resupply purchase orders are en-route.
  • Integrating with e-commerce platforms and marketplaces.
  • Custom workflows to modify order data or respond to shipment or tracking events.

​
Obtaining API Credentials

To access either API, you will need to obtain API credentials. Please refer to the following documentation pages for detailed instructions: