Skip to main content
PATCH
Set the inventory count for a SKU in a bin

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key
string

Optional, case-sensitive key for one intended action. Scope: team, HTTP method and canonical path. Retained for at least 24 hours and while processing. Same key and payload reuses the stored outcome without repeating side effects; the resource representation is current. Changed payload: 422 with an Idempotency-Key entry in errors. Concurrent duplicate: 409 with Retry-After and Location when known. Without a key there is no deduplication. Use GET at Location after 202.

Required string length: 16 - 128
Pattern: ^[A-Za-z0-9._-]{16,128}$
Request-ID
string

Optional client-supplied request identifier. When provided and matching the validation pattern, the value is echoed back in the Request-ID response header. Otherwise the server generates one. Use this to correlate requests between client and server when reporting issues.

Required string length: 1 - 64
Pattern: ^[A-Za-z0-9._-]{1,64}$

Path Parameters

teamUuid
string<uuid>
required

Team uuid. All resources are scoped to this team.

sku
string
required

Stock keeping unit identifier.

Minimum string length: 1
Example:

"TSHIRT-RED-M"

Body

application/json
bin
string
required
Minimum string length: 1
Example:

"A1-04"

count
integer
required

Absolute count to set for the SKU in the given bin.

Required range: x >= 0
Example:

42

Response

Inventory count updated.