Commits a sales return.

POST /inventory/sales-returns/{id}/commit

Group: Inventory › Sales Returns · Operation ID: commitSalesReturn

Commits a draft sales return, bringing the goods back into stock and posting the accounting, in one call. The platform commits the document, posts the inventory transactions that bring the stock back, writes the financial postings, and leaves the return RECEIVED. Where the return was raised as a credit, the credit memo is raised in the same transaction and its id is returned. This is the only workflow step this API publishes. After it, the return can no longer be edited or deleted.

Open in the interactive reference

Parameters

Name In Type Required Description
Api-Version header "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 for the sales return.

Request body

Required, application/json: commitSalesReturnInput.

Field Type Required Description
approvalNotes string no Free text recorded with the commit, added to the return's notes for audit.

Example:

{
  "approvalNotes": "RMA verified against the delivery"
}

Response

200 Success

Under data (commitSalesReturnOutput):

Field Type Required Description
id string yes The unique identifier for the sales return.
documentStatus string yes The status the return is now in, read back from the document. Possible values: 'DRAFT', 'OPEN', 'COMMITTED', 'RECEIVED', 'INSPECTED', 'PROCESSED', 'COMPLETED', 'CANCELLED'.
creditMemoId string no The unique identifier for the credit memo this commit raised, where it raised one. Absent for an inventory-only return, and its absence never means the commit failed. See id on GET accounting/credit-memos/:id.
warnings array of string yes Non-fatal advisories from this step. An empty array on a clean run. The step succeeded whatever is listed here.

Response headers

Errors

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

Statuses