List every return request submitted against one order

GET

/api/v1/scent/orders/{id}/return-requests

const url = 'https://api-omni.linra.net/api/v1/scent/orders/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/return-requests?page=1&pageSize=20';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api-omni.linra.net/api/v1/scent/orders/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/return-requests?page=1&pageSize=20' \
  --header 'Authorization: Bearer <token>'

Authorizations

partnerBearer

Parameters

Path Parameters

required

string format: uuid

Query Parameters

page

integer

default: 1 >= 1

pageSize

integer

default: 20 >= 1 <= 100

Responses

200

A page of return requests, newest first, every status.

application/json

object

state

required

string

payload

required

details

object

payload

required

object

items

Array<object>

object

string format: uuid

scentOrderId

string format: uuid

orderGlobalId

string

fulfillmentGroupId

string format: uuid

partnerId

string format: uuid

status

string

Allowed values: Pending Approved Declined

requestedAt

string format: date-time

decidedAt

string format: date-time

nullable

decidedByUserId

string format: uuid

nullable

declineReason

string

nullable

lines

Array<object>

object

string format: uuid

scentOrderLineId

string format: uuid

quantity

integer

reasonCode

string

pagination

object

page

integer

pageSize

integer

totalCount

integer

totalPages

integer

Example

{
  "state": "SUCCESS",
  "payload": {
    "items": [
      {
        "status": "Pending"
      }
    ]
  }
}

429

Too many requests — see the Rate limits guide. Retry after the Retry-After header (seconds).

application/json

The envelope every /api/v1 ERROR response uses. state carries the machine-readable error code (see the Errors guide).

object

state

required

string

payload

required

Always null on an error response.

object

details

object

Example

{
  "state": "NOT_FOUND_ORDER",
  "payload": null
}

Headers

Retry-After

integer

Seconds to wait before retrying.