Returns the sales return with the given identifier.
GET /inventory/sales-returns/{id}
Group: Inventory › Sales Returns · Operation ID: getSalesReturn
Returns one sales return by its identifier, with all of its lines and their batch, serial, bin and inspection detail. The item schema is identical here and on POST inventory/sales-returns/search. The collection GET inventory/sales-returns returns the header only, so it cannot include the lines. documentStatus shows where the return is in its lifecycle: a draft can be updated, committed or deleted, and after commit the return is RECEIVED. The inspection detail appears once the goods have been inspected. Before that the lines show what was expected.
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. |
id |
path | string | yes | The unique identifier for the sales return to return. |
Response
200 Success
Under data (getSalesReturnOutput):
| 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. |
Errors
| Code | Status |
|---|---|
NOT_FOUND |
400 |
Statuses
400— Invalid request or business failure. Codes: NOT_FOUND401— Missing or invalid access token403— Not authorized404— Not found429— Too many requests500— Internal server error