Skip to main content

Set Quote Inventory Allocation

POST 

/api/quotes/:quote/allocation

Toggle whether the quote holds inventory, applying the side effect immediately so this is the single control for allocation:

  • allocate=false always RELEASES any stock the quote is currently holding.
  • allocate=true re-allocates now if the quote is already issued (sent/viewed); for a draft it only records intent, since allocation otherwise happens on send.
Required scope: orders:write

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Returns 422 (InvalidQuoteTransition) when the quote is in a terminal state (ordered/declined/expired).

Body: allocate (boolean, required).

Authentication: Requires Bearer token. Permission: quotes.update.

Request

Responses

OK

Response Headers
    Content-Type