Simplified API Structure
We’ve simplified the API structure to allow you to fetch all the product & order information in a single call:- For products, this includes products, variants, inventory and inventory location across different channels.
- For orders, this returns the order information, shipments, fulfillment and refund info all in one call.
Exceptions
By default, we return all of the data that is available from the E-commerce platforms. When a platform doesn’t support some functionality, we simply leave it out of the response. For example, some channels don’t include inventory location information. Here is an overview of the exceptions by channel:| Channel | Exceptions |
|---|---|
| Shopify | None |
| WooCommerce | No inventory location user needs to install this add-on |
| BigCommerce | None |
| Lightspeed | None |
| Amazon | None |
| Bol | None |
| Mirakl | None |
| Magento | None |
Product Data
The unified product data model includes inventory details for all product variants. With one API call, you receive:Products
Core product details including title, description, and options
Product Variants
All variations of each product with their specific attributes
Inventory
Current stock levels for each product variant
Inventory Levels by Location
Stock levels broken down by physical location (if applicable)
- Products: API Documentation
- Product Variants: API Documentation
- Inventory: API Documentation
- Inventory Level: API Documentation
- Inventory Location: API Documentation
Order Data
The unified order data model includes comprehensive information about orders, their fulfillment status, and financial details. With one API call, you receive:Orders
Complete order details including customer information and line items
Shipments
Fulfillment status and shipping information for each order
Refunds
Any refunds associated with the orders
- Orders: API Documentation
- Shipments: API Documentation
- Refunds: API Documentation