getSalesReturnOrder

READ

Get sales return order.

POST /api/v1/sales/getSalesReturnOrder

curl -X POST '<your-host>/api/v1/sales/getSalesReturnOrder' \
  -H 'Authorization: Bearer <api-key>' \
  -H 'Content-Type: application/json' \
  -d '{
    "salesReturnOrderId": "string"
  }'

Response

{
  "assignee": "string",
  "companyId": "string",
  "createdAt": "string",
  "createdBy": "string",
  "currencyCode": "string",
  "customerContactId": "string",
  "customerId": "string",
  "customerLocationId": "string",
  "customerReference": "string",
  "customFields": "…",
  "exchangeRate": 0,
  "expirationDate": "string",
  "externalNotes": "…",
  "id": "string",
  "internalNotes": "…",
  "linesCount": 0,
  "locationId": "string",
  "orderDate": "string",
  "quantityAuthorized": 0,
  "quantityCredited": 0,
  "quantityReceived": 0,
  "replacementSalesOrderId": "string",
  "salesOrderId": "string",
  "salesReturnOrderId": "string",
  "status": "Completed",
  "updatedAt": "string",
  "updatedBy": "string"
}

Parameters

ParameterType

Input schema

schema

{
  "type": "object",
  "properties": {
    "salesReturnOrderId": {
      "type": "string"
    }
  },
  "required": [
    "salesReturnOrderId"
  ]
}