Ship a purchase return

Operation ID: shipPurchaseReturn

Group: Inventory › Purchase Returns

Open in the interactive reference

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

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

Ships an approved purchase return. Shipping fails when the warehouse does not have enough stock. For a purchase return line that draws on a purchase order line, shipping chooses the receipt lines that the quantity comes from and records them in applications. To undo a shipped purchase return, cancel it with POST inventory/purchase-returns/:id/cancel.

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 ship. Format: UUID. Example: "6a1f30c9-4d82-4b57-9e60-83c25f0a71b4".

Request body

Required, application/json: shipPurchaseReturnInput.

Field Type Required Description
shippedDate date no The date the goods left for the vendor. Format: YYYY-MM-DD. Defaults to today. Example: "2026-08-21". 
{
  "shippedDate": "2026-08-21"
}

Response

200 Success

Under data (shipPurchaseReturnOutput):

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 shipment. It is 'COMMITTED'. Example: "COMMITTED".
warnings array<string> yes Warnings about the shipment. Empty when there are no warnings. Example: []. 
{
  "data": {
    "id": "6a1f30c9-4d82-4b57-9e60-83c25f0a71b4",
    "documentStatus": "COMMITTED",
    "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