Cancel a purchase return

Operation ID: cancelPurchaseReturn

Group: Inventory › Purchase Returns

POST /inventory/purchase-returns/{id}/cancel

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

Cancels a purchase return with the documentStatus 'DRAFT', 'APPROVED', 'PREPARED', or 'COMMITTED'. If the purchase return has not been shipped, only its documentStatus changes. If the purchase return has been shipped ('COMMITTED'), canceling also:

puts the stock back in the warehouse
creates a reversing journal entry
lowers the returned quantities on the receipt lines again

Canceling a shipped purchase return fails when the quantity it puts back on a purchase order line is more than the received quantity on that line that has not yet been invoiced.

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 purchase return you want to cancel. Format: UUID. Example: `"6a1f30c9-4d82-4b57-9e60-83c25f0a71b4"`.

Response

200 Success

Under data (cancelPurchaseReturnOutput):

Field	Type	Required	Description
`id`	string	yes	The unique identifier for the purchase return. Format: UUID. Example: `"6a1f30c9-4d82-4b57-9e60-83c25f0a71b4"`.
`documentStatus`	string	yes	The status of the purchase return after the cancellation. It is 'CANCELLED'. Example: `"CANCELLED"`.
`warnings`	array<string>	yes	Warnings about the cancellation. Empty when there are no warnings. Example: `[]`.

{
  "data": {
    "id": "6a1f30c9-4d82-4b57-9e60-83c25f0a71b4",
    "documentStatus": "CANCELLED",
    "warnings": []
  },
  "diagnostics": [
    {
      "code": "<code>",
      "message": "<message>",
      "severity": "error",
      "path": [
        "<path>"
      ],
      "details": "<details>"
    }
  ]
}

Response headers

Idempotency-Replayed — Present and true only when this response replays a previously stored one for the same Idempotency-Key, rather than reflecting a live execution. Absent on a live response - never sent as false.

Errors

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

Statuses

400 — Invalid request or business failure. Codes: NOT_FOUND, WRONG_STATUS, POSTING_REJECTED
401 — The request carries no valid access token.
403 — Not authorized
404 — Not found
409 — The Idempotency-Key is still being processed by another request.
422 — The Idempotency-Key was already used with a different request payload.
429 — Too many requests from this client address. The response has no body and no Retry-After header.
500 — Internal server error