Get integrated with ShipStream!

• Home
• Documentation
• API Basics
• Units of Measure
• Search Filters
• Search Options
• Shipping Methods
• Import Formats
• API Reference
• Stock Movements
• Enumerations
• Third Party Billing
• Bill of Materials
• Rate
• Log
• Warehouse
• Import
• Webhook
• Topics
• Store
• Delivery
• Delivery Label
• Product
• Media
• Shipment
• Custom Fields
• Package
• Order
• Custom Fields
• Packing Instructions
• State Data
• Inventory

Integrate your clients with ShipStream

Welcome to the ShipStream Merchant API reference documentation.

What is an “API”?

An API, or Application Programming Interface, is a system that allows different software applications to communicate with each other. In the case of ShipStream, our Merchant API allows you to integrate your own systems with our WMS.

What can I do with the API?

First, you can use it to push data into our system from yours, such as orders, products and deliveries and you can pull back data like order statuses, package contents and details and delivery processing results. You can also request rate quotes which are based on your negotiated rates and update existing data (for example, put an order on hold).

You can also subscribe to “Webhooks” and have our system push information (like inventory updates and tracking numbers) directly to yours in real-time!

Lastly, we have a Middleware system that let’s you develop plugins that can either be integrated directly into our system or run on a standalone environment that makes your plugin operate like a first-class citizen in our environment complete with internal event notifications and the ability to handle third-party webhooks!

Looking for the Global API?

The Merchant API is designed for use by systems that access data for a specific merchant and is limited in scope compared to our Global API. The Global API is designed for use by systems that need to access data across multiple merchants and perform operational tasks like picking a shipment. The Merchant API is a subset of the Global API and is intended more for order management and syncing data between shopping carts and ERPs of a single merchant.

Getting Started

If you’re new to the API but ready to get your hands dirty your first stop should be the Merchant API Basics page.

If you’re trying to use our import feature, check out the Import Formats page for details about the various import formats supported (like CSV and JSON) and how to use them.

In general, the in-depth details of the API methods are listed in their respective sections under “API REFERENCE” to the left and the other reference material is provided in the “DOCUMENTATION” section also to the left. If you have any trouble, let us know how the documentation can be improved!