Inventory

Inventory allows you to track stock quantities.

Inventory allows you to track stock quantity per SKU and optionally per supply channel.

Representations

InventoryEntry

InventoryEntryDraft

There can only be one inventory entry for the combination of sku and supplyChannel.

Get InventoryEntry by ID

Endpoint: /{projectKey}/inventory/{id}
Method: GET
OAuth2 Scopes: view_products:{projectKey}
Response Representation: InventoryEntry

Query Inventory

Endpoint: /{projectKey}/inventory
Method: GET
OAuth2 Scopes: view_products:{projectKey}
Response Representation: PagedQueryResult with the results array of InventoryEntry
Query Parameters:

Create an InventoryEntry

Endpoint: /{projectKey}/inventory
Method: POST
OAuth2 Scopes: manage_products:{projectKey}
Request Representation: InventoryEntryDraft
Response Representation: InventoryEntry

Update an InventoryEntry

Endpoint: /{projectKey}/inventory/{id}
Method: POST
OAuth2 Scopes: manage_products:{projectKey}
Response Representation: InventoryEntry
Fields:

Update Actions
Please find below the individual update actions provided on this endpoint.


Add Quantity

Increments quantityOnStock and updates availableQuantity according to the new quantity and amount of active reservations.

Remove Quantity

Decrements quantityOnStock and updates availableQuantity according to the new quantity and amount of active reservations.

Change Quantity

Sets quantityOnStock and updates availableQuantity according to the new quantity and amount of active reservations.

Set RestockableInDays

Set ExpectedDelivery

Set SupplyChannel

This action will fail if an entry with the combination of sku and supplyChannel already exists.

Set Custom Type

This action sets or removes the custom type for an existing inventory entry.

This action overwrites any existing custom type and fields.

Set CustomField

Delete an InventoryEntry

Endpoint: /{projectKey}/inventory/{id}
Method: DELETE
OAuth2 Scopes: manage_products:{projectKey}

Deleting an InventoryEntry produces the InventoryEntryDeleted message.