Managing Inventory
When you have enabled the Inventory API add-on for ShipStation, you’ll have access to the inventory endpoints that allow you to view and manage SKU stock levels, create and manage your inventory warehouses, and create and manage inventory locations.
What you can do with the inventory endpoints:
/v2/inventory: List and update inventory-related properties, including stock counts, for all SKUs that use ShipStation Inventory./v2/inventory_warehouses: Create and delete inventory warehouses, list inventory warehouses, and update inventory warehouse names./v2/inventory_locations: Create and delete inventory locations in inventory warehouses, list inventory inventory locations, and update inventory location names.
Requirements
- To use the inventory endpoints, you must have activated the Inventory API add-on for your ShipStation account.
- Specific endpoints and methods will also have their own properties requirements, which are documented in their specific guides.
Key Inventory Properties
It’s important to understand the primary properties used by the inventory endpoints, what they mean, and how they map to fields in the ShipStation application.
| Property | Type | Description |
|---|---|---|
sku | string | The SKU value of a product. You’ll need the SKU value to update or query stock levels for specific SKUs. SKUs are also associated with specific inventory warehouses and inventory locations. |
inventory_warehouse_id | string | This is the unique ID of an inventory warehouse. You’ll need this property to update the name of an inventory warehouse, delete an inventory warehouse, and add an inventory location. The name property for an inventory_warehouse_id maps to the Warehouse Name in your ShipStation Settings and Product Inventory screens. |
inventory_location_id | string | This is the unique ID of an inventory location, which will always be associated with a specific inventory_warehouse_id. You’ll need this property to update SKU stock levels, update the name of an inventory location, and delete an inventory location. The name property reflects the area - unit - shelf - bin warehouse layout set for your warehouse locations in ShipStation. The inventory location name maps to the Location field in your ShipStation Settings and Product Inventory screens. |
Any additional properties needed for specific endpoints and operations are described in the guides specific to the inventory actions you will take: