Update Sales Return

PATCH /inventory/sales-returns/{id}

Group: Inventory › Sales Returns · Operation ID: updateSalesReturn

Updates the sales return with the given identifier. Only the fields in the request body change.

Updates one draft sales return. Only the fields in the request body change. Only a draft can be edited. Once committed, a return has moved stock and can no longer be edited. Lines change through three arrays, deleteLines, updateLines and createLines, applied in that order, so one call can retire a line and add its replacement. A line's tracking arrays replace what the line had: sending batches replaces that line's batches, and omitting it leaves them untouched. The inspection fields are not writable here. A line id belonging to another return is rejected, not skipped. The response is the updated return in full.

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 to update.

Request body

Required, application/json: updateSalesReturnInput.

Field Type Required Description
businessPartnerId string no A new customer for the return. Despite the name, this is a customer id. See id on GET accounting/customers/:id.
documentDate string (date) no A new document date. Use format YYYY-MM-DD.
deliveryDate string (date) no A new expected-back date. Use format YYYY-MM-DD.
currency string no A new currency for the return's amounts. Format ISO 4217, for example 'EUR'.
referenceNumber string no A new customer reference.
trackingNumber string no A new carrier tracking number.
returnType string no A new classification for the return.
returnFeeAmount string (decimal) no A new fee across the return, in the document's currency.
notes string no New free text. Pass an empty string to clear it.
deleteLines array of string no The identifiers of lines to remove. Applied before the other two arrays.
updateLines array of object no Lines to change, addressed by id. Applied after deleteLines and before createLines.
updateLines[].id string yes The unique identifier for the line to change. A line belonging to another return is rejected, not skipped.
updateLines[].itemId string no A new item for the line. See id on GET inventory/items/:id.
updateLines[].locationId string no A new warehouse for the line. See id on GET inventory/warehouses/:id.
updateLines[].unitId string no A new unit for the line's quantity. See id on GET inventory/unit-of-measures/:id.
updateLines[].quantity string (decimal) no A new quantity, in the line's unit. Greater than zero when given.
updateLines[].unitPrice string (decimal) no A new unit value, in the document's currency.
updateLines[].condition string, one of "NEW", "GOOD", "USED", "OPENED", "DAMAGED", "DEFECTIVE", "EXPIRED", "REFURBISHED" no A new expected condition.
updateLines[].disposition string, one of "RETURN_TO_STOCK", "RETURN_TO_VENDOR", "SCRAP", "DONATE", "REPAIR", "REWORK", "CREDIT_ONLY" no A new intended disposition.
updateLines[].reasonCode string no A new customer-facing reason.
updateLines[].reasonCodeId string no A new internal reason code. See id on GET inventory/reason-codes/:id.
updateLines[].returnFeeAmount string (decimal) no A new fee for this line, in the document's currency.
updateLines[].notes string no New free text. Pass an empty string to clear it.
updateLines[].batches array of object no The batches coming back on this line. Required for a batch-tracked item, and the quantities must add up to the line's quantity. On PATCH inventory/sales-returns/:id this replaces the line's batches.
updateLines[].batches[].batchNumberId string no The unique identifier for an existing batch. Omit it and give batchNumber for a lot the system has not seen.
updateLines[].batches[].batchNumber string no The batch number as printed. Required unless batchNumberId is given.
updateLines[].batches[].expirationDate string (date) no The expiration date of the lot. Format YYYY-MM-DD.
updateLines[].batches[].quantity string (decimal) yes The quantity of this batch coming back, in the line's unit. The batch quantities of a line must add up to the line's quantity.
updateLines[].serials array of object no The serialized units coming back, one entry per unit. Required for a serialized item, and the count must equal the line's quantity. On PATCH inventory/sales-returns/:id this replaces the line's serials.
updateLines[].serials[].serialNumberId string no The unique identifier for an existing serial record. Omit it and give serialNumber.
updateLines[].serials[].serialNumber string no The serial number stamped on the unit. Required unless serialNumberId is given.
updateLines[].binLocations array of object no The bins the goods go into, in a bin-tracked warehouse. One flat array. An entry may name a batchNumber or serialNumber of its own line. On PATCH inventory/sales-returns/:id this replaces the line's bin entries.
updateLines[].binLocations[].binLocationId string yes The unique identifier for the bin the goods go into. See id on GET inventory/bins/:id.
updateLines[].binLocations[].quantity string (decimal) yes The quantity going into this bin, in the line's unit.
updateLines[].binLocations[].batchNumber string no Names one of this line's batches, when the bin entry belongs to it.
updateLines[].binLocations[].serialNumber string no Names one of this line's serialized units, when the bin entry belongs to it.
createLines array of object no Lines to add.
createLines[].itemId string yes The unique identifier for the item coming back. See id on GET inventory/items/:id.
createLines[].locationId string yes The unique identifier for the warehouse the goods come back to. Each line of a return may use a different warehouse. See id on GET inventory/warehouses/:id.
createLines[].unitId string yes The unique identifier for the unit the quantity is counted in. See id on GET inventory/unit-of-measures/:id.
createLines[].quantity string (decimal) yes The quantity the customer is returning, in that unit. Greater than zero.
createLines[].unitPrice string (decimal) no The value of one unit, in the document's currency. Omit it to take the price from the sale.
createLines[].condition string, one of "NEW", "GOOD", "USED", "OPENED", "DAMAGED", "DEFECTIVE", "EXPIRED", "REFURBISHED" no The condition the goods are expected in. The inspection may find otherwise and restates it.
createLines[].disposition string, one of "RETURN_TO_STOCK", "RETURN_TO_VENDOR", "SCRAP", "DONATE", "REPAIR", "REWORK", "CREDIT_ONLY" no What you intend to do with the goods. The inspection may change it.
createLines[].reasonCode string no The customer-facing reason for the return, for example 'defectiveItem'. Reporting only.
createLines[].reasonCodeId string no The unique identifier for an internal reason code. See id on GET inventory/reason-codes/:id.
createLines[].returnFeeAmount string (decimal) no The fee withheld on this line, in the document's currency.
createLines[].sourceDocumentLineId string no The shipment line the goods went out on, where the return follows a delivery. It is a line's id on GET inventory/shipments/:id. Naming it lets the commit value the return from the original shipment cost.
createLines[].notes string no Free text on the line.
createLines[].batches array of object no The batches coming back on this line. Required for a batch-tracked item, and the quantities must add up to the line's quantity. On PATCH inventory/sales-returns/:id this replaces the line's batches.
createLines[].batches[].batchNumberId string no The unique identifier for an existing batch. Omit it and give batchNumber for a lot the system has not seen.
createLines[].batches[].batchNumber string no The batch number as printed. Required unless batchNumberId is given.
createLines[].batches[].expirationDate string (date) no The expiration date of the lot. Format YYYY-MM-DD.
createLines[].batches[].quantity string (decimal) yes The quantity of this batch coming back, in the line's unit. The batch quantities of a line must add up to the line's quantity.
createLines[].serials array of object no The serialized units coming back, one entry per unit. Required for a serialized item, and the count must equal the line's quantity. On PATCH inventory/sales-returns/:id this replaces the line's serials.
createLines[].serials[].serialNumberId string no The unique identifier for an existing serial record. Omit it and give serialNumber.
createLines[].serials[].serialNumber string no The serial number stamped on the unit. Required unless serialNumberId is given.
createLines[].binLocations array of object no The bins the goods go into, in a bin-tracked warehouse. One flat array. An entry may name a batchNumber or serialNumber of its own line. On PATCH inventory/sales-returns/:id this replaces the line's bin entries.
createLines[].binLocations[].binLocationId string yes The unique identifier for the bin the goods go into. See id on GET inventory/bins/:id.
createLines[].binLocations[].quantity string (decimal) yes The quantity going into this bin, in the line's unit.
createLines[].binLocations[].batchNumber string no Names one of this line's batches, when the bin entry belongs to it.
createLines[].binLocations[].serialNumber string no Names one of this line's serialized units, when the bin entry belongs to it.

Example:

{
  "businessPartnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "documentDate": "2026-01-15",
  "deliveryDate": "2026-01-15",
  "currency": "<currency>",
  "referenceNumber": "<referenceNumber>",
  "trackingNumber": "3SABCD7654321",
  "returnType": "<returnType>",
  "returnFeeAmount": "19.99",
  "notes": "<notes>",
  "deleteLines": [
    "<deleteLines>"
  ],
  "updateLines": [
    {
      "id": "8c14a6f2-3b70-4d59-9e02-6f5a1d38b47c",
      "quantity": "4.00"
    }
  ],
  "createLines": [
    {
      "itemId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "locationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "quantity": "19.99",
      "unitPrice": "19.99",
      "condition": "NEW",
      "disposition": "RETURN_TO_STOCK",
      "reasonCode": "<reasonCode>",
      "reasonCodeId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "returnFeeAmount": "19.99",
      "sourceDocumentLineId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "notes": "<notes>",
      "batches": [
        {
          "batchNumberId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "batchNumber": "<batchNumber>",
          "expirationDate": "2026-01-15",
          "quantity": "19.99"
        }
      ],
      "serials": [
        {
          "serialNumberId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "serialNumber": "<serialNumber>"
        }
      ],
      "binLocations": [
        {
          "binLocationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "quantity": "19.99",
          "batchNumber": "<batchNumber>",
          "serialNumber": "<serialNumber>"
        }
      ]
    }
  ]
}

Response

200 Success

Under data (updateSalesReturnOutput):

Field Type Required Description
id string yes The unique identifier for the sales return.
documentNumber string no The sales return number, for example 'SR-1042'. Assigned on create and never supplied by you.
documentStatus string yes The status of the return. Possible values: 'DRAFT', 'OPEN', 'COMMITTED', 'RECEIVED', 'INSPECTED', 'PROCESSED', 'COMPLETED', 'CANCELLED'.
documentDate string (date) yes The date the return is dated. Format YYYY-MM-DD.
deliveryDate string (date) no When the goods are expected back, or came back. Format YYYY-MM-DD.
entityId string yes The unique identifier for the legal entity the return belongs to. See id on GET base/entities.
entityName string no The name of that legal entity.
businessPartnerId string yes The unique identifier for the customer returning the goods. Despite the name, this is a customer id. See id on GET accounting/customers/:id.
businessPartnerName string no The name of that customer.
sourceDocumentId string no The document the goods went out on, where the platform recorded one, as its own numeric id in a string. It is not an identifier this API can look up. The usable link is sourceDocumentLineId on the line.
sourceDocumentType string no What kind of document that was, for example 'SalesDelivery'.
referenceNumber string no The customer's own reference for the return, for example an RMA number.
trackingNumber string no The carrier's tracking number for the goods coming back.
returnType string no How the business classifies the return.
currency string no The currency every amount on the document is in. Format ISO 4217, for example 'EUR'. A return is valued in the currency it was sold in, which need not be the legal entity's functional currency.
totalAmount string (decimal) no The total value of the return, in the document's currency.
returnFeeAmount string (decimal) no The fee withheld across the return, in the document's currency.
notes string no Free text on the document.
createdDate string (date-time) no The date and time the return was created, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.
lastModifiedDate string (date-time) no The date and time the return record last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.
lines array of object yes The lines of the return, oldest first. A sales return always has at least one.
lines[].id string yes The unique identifier for the line. Use it in updateLines and deleteLines on PATCH inventory/sales-returns/:id.
lines[].itemId string yes The unique identifier for the item coming back. See id on GET inventory/items/:id.
lines[].itemCode string no The short code of that item.
lines[].itemName string no The name of that item.
lines[].locationId string yes The unique identifier for the warehouse the goods come back to. Each line of a return may use a different warehouse. See id on GET inventory/warehouses/:id.
lines[].locationCode string no The short code of that warehouse.
lines[].locationName string no The name of that warehouse.
lines[].unitId string yes The unique identifier for the unit the quantity is counted in. See id on GET inventory/unit-of-measures/:id.
lines[].unitCode string no The short code of that unit.
lines[].quantity string (decimal) yes The quantity the customer is returning, in the line's unit.
lines[].inventoryQuantity string (decimal) no The same quantity in the item's stocking unit.
lines[].openQuantity string (decimal) no How much of the line has not yet been received.
lines[].inspectedQuantity string (decimal) no How much of the line the inspection covered.
lines[].approvedQuantity string (decimal) no How much of the line was approved back into stock.
lines[].rejectedQuantity string (decimal) no How much of the line was rejected. Approved plus rejected equals inspected.
lines[].inspectedDate string (date) no When the inspection took place. Format YYYY-MM-DD.
lines[].condition string no The condition the goods arrived in, restated by the inspection. Possible values: 'NEW', 'GOOD', 'USED', 'OPENED', 'DAMAGED', 'DEFECTIVE', 'EXPIRED', 'REFURBISHED'.
lines[].disposition string no What is to be done with the goods. Possible values: 'RETURN_TO_STOCK', 'RETURN_TO_VENDOR', 'SCRAP', 'DONATE', 'REPAIR', 'REWORK', 'CREDIT_ONLY'.
lines[].qualityGrade string no The grade assigned at inspection.
lines[].inspectionNotes string no Free text from the inspector.
lines[].rejectionReason string no Why the rejected portion was rejected.
lines[].unitPrice string (decimal) no The value of one unit, in the document's currency.
lines[].returnFeeAmount string (decimal) no The fee withheld on this line, in the document's currency.
lines[].reasonCode string no The customer-facing reason for the return, for example 'defectiveItem'. Reporting only, it does not affect how the return is processed.
lines[].reasonCodeId string no The unique identifier for an internal reason code, where one was set. See id on GET inventory/reason-codes/:id.
lines[].sourceDocumentLineId string no The shipment line the goods went out on, where the return cites one. It is a line's id on GET inventory/shipments/:id.
lines[].sourceDocumentLineType string, one of "IMInventorySalesOrderLine", "IMInventorySalesDeliveryLine", "IMSalesOrderLine", "IMInventoryPurchaseReturnLine", "IMInventorySalesReturnLine", "IMWarehouseTransferLine", "IMInventoryDecreaseLine", "IMInventoryIncreaseLine", "IMInventoryRevaluationLine", "IMInventoryTransferLine", "IMInventoryAdjustmentLine", "IMInventoryCountLine", "IMInventoryPutAwayTask", "IMInventoryPurchaseReturnReversal", "PurchaseOrderLine", "IMLandedCostAllocationLine", "SalesOrderProductItem", "IMWarehouseTransferOrderLine", "VendorBillItemBase", "InvPurchaseDeliveryLine" no What kind of document line that was.
lines[].notes string no Free text on the line.
lines[].batches array of object no The batches coming back on this line, for a batch-tracked item. Absent when the item is not batch-tracked.
lines[].batches[].batchNumberId string no The unique identifier for the batch record.
lines[].batches[].batchNumber string yes The batch number as printed.
lines[].batches[].expirationDate string (date) no The expiration date of the lot. Format YYYY-MM-DD.
lines[].batches[].quantity string (decimal) yes The quantity of this batch coming back, in the line's unit.
lines[].batches[].inventoryQuantity string (decimal) no The same quantity in the item's stocking unit.
lines[].batches[].openQuantity string (decimal) no How much of this batch has not yet been received.
lines[].batches[].unitCost string (decimal) no The cost of one unit of this batch, in the document's currency.
lines[].serials array of object no The serialized units coming back, one entry per unit. Absent when the item is not serialized.
lines[].serials[].serialNumberId string no The unique identifier for the serial record.
lines[].serials[].serialNumber string yes The serial number as stamped on the unit.
lines[].serials[].openQuantity string (decimal) no How much of this unit is still outstanding, one or zero.
lines[].serials[].unitCost string (decimal) no The cost of this unit, in the document's currency.
lines[].binLocations array of object no The bins the goods go into, in a bin-tracked warehouse. One flat array. An entry naming a batchNumber or serialNumber belongs to that batch or unit, and one naming neither belongs to the line.
lines[].binLocations[].binLocationId string yes The unique identifier for the bin the goods go into. See id on GET inventory/bins/:id.
lines[].binLocations[].binLocationCode string no The short code of that bin.
lines[].binLocations[].quantity string (decimal) yes The quantity going into this bin, in the line's unit.
lines[].binLocations[].inventoryQuantity string (decimal) no The same quantity in the item's stocking unit.
lines[].binLocations[].batchNumber string no Set when this bin entry belongs to one of the line's batches, naming it.
lines[].binLocations[].serialNumber string no Set when this bin entry belongs to one of the line's serialized units, naming it.
lines[].inspectionDetails array of object no What the inspection found, broken down by batch or unit. Absent before the inspection runs. The line has the totals and these give the detail.
lines[].inspectionDetails[].approvalStatus string yes What was decided about this portion, recorded as given.
lines[].inspectionDetails[].inspectedQuantity string (decimal) yes How much this finding covers.
lines[].inspectionDetails[].condition string no The condition of this portion. Possible values: 'NEW', 'GOOD', 'USED', 'OPENED', 'DAMAGED', 'DEFECTIVE', 'EXPIRED', 'REFURBISHED'.
lines[].inspectionDetails[].disposition string no What is to be done with this portion. Possible values: 'RETURN_TO_STOCK', 'RETURN_TO_VENDOR', 'SCRAP', 'DONATE', 'REPAIR', 'REWORK', 'CREDIT_ONLY'.
lines[].inspectionDetails[].qualityGrade string no The grade assigned at inspection, where the business uses one.
lines[].inspectionDetails[].inspectionNotes string no Free text from the inspector.
lines[].inspectionDetails[].rejectionReason string no Why this portion was rejected, where it was.
lines[].inspectionDetails[].batchNumber string no The batch this finding is about, where it is about one.
lines[].inspectionDetails[].serialNumber string no The serialized unit this finding is about, where it is about one.

Response headers

Errors

Code Status
NOT_FOUND 400
WRONG_STATUS 400
REFERENCE_NOT_FOUND 400
NO_LINES 400
INVALID_QUANTITY 400
DUPLICATE_TRACKING_NUMBER 400
UNKNOWN_TRACKING_REFERENCE 400
POSTING_REJECTED 400
IDEMPOTENCY_KEY_CONFLICT 409
IDEMPOTENCY_PAYLOAD_MISMATCH 422

Statuses