Commit a unit to a sale
Puts a unit on an oripa or sale while it stays on the shop shelf. This does not create a shipment. Creation returns 201; replaying the same requestId and content returns 200. Reusing requestId for different content fails with idempotency_conflict. In addition to inventory:read, this needs its operation scope and the approving member’s inventory.write permission.
/inventory/commitmentsAuthorizationOAuth2 access token · headerrequiredAuthorization code flow (PKCE S256 required). Send resource=https://api.toreca-cloud.com/partner/v1 with the authorization, token and refresh requests. Access tokens last 15 minutes; refresh tokens last 90 days and rotate on every refresh.
inventory:readinventory:writeapplication/jsonrequestIdstring<uuid>requiredinventoryItemIdstring<uuid>requiredpurposestringrequiredoripasalelabelstringrequiredexternalRefstringSuccess
idstring<uuid>requiredcreatedAtstring<date-time>requiredupdatedAtstring<date-time>requiredinventoryItemIdstring<uuid>requiredassetNumberstringrequiredpurposestringrequiredoripasalelabelstringrequiredexternalRefstring | nullrequiredShow propertiesHide properties
stringnullstatusstringrequiredon_saleallocatedshippingblockedshippedreleasedendedallocatedAtstring<date-time> | nullrequiredShow propertiesHide properties
string<date-time>nullallocationRefstring | nullrequiredShow propertiesHide properties
stringnullshipmentIdstring<uuid> | nullrequiredShow propertiesHide properties
string<uuid>nullclosedAtstring<date-time> | nullrequiredShow propertiesHide properties
string<date-time>nullCreated
idstring<uuid>requiredcreatedAtstring<date-time>requiredupdatedAtstring<date-time>requiredinventoryItemIdstring<uuid>requiredassetNumberstringrequiredpurposestringrequiredoripasalelabelstringrequiredexternalRefstring | nullrequiredShow propertiesHide properties
stringnullstatusstringrequiredon_saleallocatedshippingblockedshippedreleasedendedallocatedAtstring<date-time> | nullrequiredShow propertiesHide properties
string<date-time>nullallocationRefstring | nullrequiredShow propertiesHide properties
stringnullshipmentIdstring<uuid> | nullrequiredShow propertiesHide properties
string<uuid>nullclosedAtstring<date-time> | nullrequiredShow propertiesHide properties
string<date-time>nullinvalid_request: a parameter is invalid.
errorstringrequiredThe error code
scopestringWith insufficient_scope, the missing scope
requestIdstring<uuid>inventoryItemIdsstring<uuid>[]holdIdsstring<uuid>[]commitmentIdsstring<uuid>[]invalid_token: the token is missing, expired, or for another resource.
errorstringrequiredThe error code
scopestringWith insufficient_scope, the missing scope
requestIdstring<uuid>inventoryItemIdsstring<uuid>[]holdIdsstring<uuid>[]commitmentIdsstring<uuid>[]One of insufficient_scope, connection_revoked, client_disabled or forbidden.
errorstringrequiredThe error code
scopestringWith insufficient_scope, the missing scope
requestIdstring<uuid>inventoryItemIdsstring<uuid>[]holdIdsstring<uuid>[]commitmentIdsstring<uuid>[]Conflict, reused requestId or receipt not confirmed
errorstringrequiredThe error code
scopestringWith insufficient_scope, the missing scope
requestIdstring<uuid>inventoryItemIdsstring<uuid>[]holdIdsstring<uuid>[]commitmentIdsstring<uuid>[]The state, target or value refuses the operation. Inspect error and affected IDs.
errorstringrequiredThe error code
scopestringWith insufficient_scope, the missing scope
requestIdstring<uuid>inventoryItemIdsstring<uuid>[]holdIdsstring<uuid>[]commitmentIdsstring<uuid>[]
