Commit an inventory decrease

Operation ID: commitInventoryDecrease

Group: Inventory › Inventory Decreases

Open in the interactive reference

POST /inventory/inventory-decreases/{id}/commit

Retry-safe: A write that accepts Idempotency-Key: repeating a request with the same key replays the stored answer instead of executing twice.

Commits an inventory decrease. The lines' quantities leave stock and documentStatus becomes 'COMMITTED'. The response includes journalEntryId and any warnings.

Only a draft can be committed. Stock is checked when you commit, not when you created the draft. Each line needs enough stock at its item and location, or the request fails with POSTING_REJECTED.

A committed inventory decrease can't be changed or deleted, and no endpoint cancels it.

Commits of the same item at the same location may run at the same time. A database write conflict between them is not a rejection: the platform retries the request, so it never returns POSTING_REJECTED.

Parameters

Name In Type Required Description
Api-Version header string · v1 yes The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version v1.
Idempotency-Key header string no An opaque caller-chosen string (1-255 characters) that makes this request safe to retry. Repeating the same key with an identical request body replays the original response instead of re-executing - but only once that original request succeeded; a failed attempt re-executes on retry. Repeating the key with a different body is answered with 422. A key still in flight is answered with 409 - as is a key whose original request was interrupted before it finished, for a few minutes afterwards, until that attempt is presumed dead. A completed response stays replayable for 24 hours. The key is scoped to the caller, not to the action: reusing it for a different action is answered with 409 or 422 rather than treated independently. On read actions this header is ignored. On write actions that cannot offer the guarantee it is answered with 400 IDEMPOTENCY_NOT_SUPPORTED rather than silently ignored.
id path string yes The unique identifier of the draft inventory decrease you want to commit.

Response

200 Success

Under data (commitInventoryDecreaseOutput):

Field Type Required Description
id string yes The unique identifier for the committed inventory decrease. Example: "d4a17f28-6b93-4c50-8e71-2a5d0c9b3e64".
documentStatus string yes The status of the inventory decrease, read back from the document. It is 'COMMITTED' on success. Possible values: 'DRAFT', 'COMMITTED', 'CANCELLED'. Example: "COMMITTED".
journalEntryId string no The unique identifier for the journal entry the commit posted. Absent when posting produced none. See id on GET accounting/journal-entries/:id. Example: "7c1b9a34-2e05-4d68-b930-5f8c6a1d2e07".
warnings array<string> yes Non-fatal advisories from the posting, in practice soft bin-capacity breaches. An empty array on a clean commit. The commit succeeded regardless of what is listed here. Example: []. 
{
  "data": {
    "id": "d4a17f28-6b93-4c50-8e71-2a5d0c9b3e64",
    "documentStatus": "COMMITTED",
    "journalEntryId": "7c1b9a34-2e05-4d68-b930-5f8c6a1d2e07",
    "warnings": []
  },
  "diagnostics": [
    {
      "code": "<code>",
      "message": "<message>",
      "severity": "error",
      "path": [
        "<path>"
      ],
      "details": "<details>"
    }
  ]
}

Response headers

Errors

Code Status
NOT_FOUND 400
WRONG_STATUS 400
POSTING_REJECTED 400
IDEMPOTENCY_KEY_CONFLICT 409
IDEMPOTENCY_PAYLOAD_MISMATCH 422

Statuses