Skip to main content
POST
Add To Inventory Count

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

Idempotency-Key
string

Optional, client-generated key for deduplicating repeated write requests. A repeated request with the same key returns the originally recorded result instead of executing the effect again.

Required string length: 1 - 255
x-tenant-id
string<uuid>
required

The tenant ID for the target ERP instance.

Path Parameters

warehouseId
string<uuid>
required

Unique identifier of the standard warehouse in which the inventory takes place.

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

Body

application/json

Request model for AddToInventoryCount command endpoint. Route parameters bind from the route, query parameters from the query string, everything else from the body.

itemId
string<uuid>
required

Unique identifier of the counted item.

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

quantity
number<decimal>
required

The counted quantity of the item. Must not be negative; a whole number unless the item is divisible.

shelfLifeEndDate
string<date-time>

The best-before date of the counted stock. Required for items managed by best-before date, not allowed otherwise.

batchNumber
string

The batch number of the counted stock. Required for items managed by batch number, not allowed otherwise.

serialNumber
string

The serial number of the counted unit. Required for items managed by serial number, not allowed otherwise; the quantity must then be 1.

Response

The inventory count was successfully added.

Adds the counted quantity of an item to the inventory of a standard warehouse. The item must keep stock of its own: bills of materials, variation parents and items whose stock is kept per variation cannot be counted. For an item managed by batch number, best-before date or serial number, add one count per batch number and best-before date, or per serial number. The stock is changed only when the inventory of the warehouse is finished. Send an Idempotency-Key header to make retries safe. - Response

inventoryCountId
string<uuid>
required

The ID of the newly added inventory count.

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"