Skip to main content
GET
/
openapi
/
v1
/
Returns
/
{returnNo}
Get Return by returnNo.
curl --request GET \
  --url https://api.oplog.one/openapi/v1/Returns/{returnNo} \
  --header 'Authorization: <api-key>'
{
  "lineItems": [
    {
      "lineItemReferenceNumber": "<string>",
      "sku": "<string>",
      "processedAt": "2023-11-07T05:31:56Z",
      "state": "WaitingToBeProcessed",
      "damagedState": "WaitingInWarehouse",
      "serialNumber": "<string>"
    }
  ],
  "source": "Oplog",
  "returnReferenceNumber": "<string>",
  "salesOrderChannel": "<string>",
  "salesOrderReferenceNumber": "<string>",
  "notes": "<string>",
  "state": "ReturnCreated",
  "trackingId": "<string>",
  "cargoCarrier": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "arrivedToWarehouseAt": "2023-11-07T05:31:56Z",
  "completedAt": "2023-11-07T05:31:56Z",
  "courierRequest": "No"
}

Authorizations

​
Authorization
string
header
required

Headers

​
X-Tenant-Id
string

If you want to emulate, please enter TenantId.

Path Parameters

​
returnNo
string
required

Response

Success

​
lineItems
object[]
​
source
enum<string>
Available options:
Oplog,
WMS
​
returnReferenceNumber
string
​
salesOrderChannel
string
​
salesOrderReferenceNumber
string
​
notes
string
​
state
enum<string>
Available options:
ReturnCreated,
ArrivedToWarehouse,
Completed
​
trackingId
string
​
cargoCarrier
string
​
createdAt
string<date-time>
​
updatedAt
string<date-time>
​
arrivedToWarehouseAt
string<date-time>
​
completedAt
string<date-time>
​
courierRequest
enum<string>
Available options:
No,
Requested,
Success,
Fail