List return requests

Lists the return requests on an order, newest first. Returns an empty list when the order has none. An order that does not exist or is not visible to the caller returns 404.

GET/{orderId}/returns

Authorization

AuthorizationBearer token · headerrequired

API token from the SIBI developer dashboard (developer.sibipro.com), sent as Authorization: Bearer <token>.

Scopes:read:returns

Path parameters

orderIdstringrequired

The order the return data belongs to.

min length 1

Responses

200

The return requests on the order.

itemsReturnRequestResponse[]required

The return requests on the order, newest first. Empty when none have been opened.

Show properties

Array of ReturnRequestResponse

idstringrequired

The unique identifier for the return request.

orderIdstringrequired

The order the returned lines belong to.

createdAtstringrequired

ISO 8601 timestamp of when the request was created.

updatedAtstringrequired

ISO 8601 timestamp of the most recent change.

itemsReturnRequestItem[]required

The requested lines, each carrying its current status.

Show properties

Array of ReturnRequestItem

orderLineItemIdstringrequired

Links back to the order line (Order line itemId).

quantityintegerrequired

How many units of the order line this covers.

conditionstringrequired

Physical condition reported at intake.

requestReasonstringrequired

Why the line was requested for return.

statusstringrequired

Per-item status, derived from the latest decision (PENDING when none exists).

Allowed:PENDINGAPPROVEDDENIED

latestDecisionReturnItemDecision | nullrequired

The most recent decision on this line; null while PENDING.

Show properties

outcomestringrequired

The decision recorded for the line.

Allowed:APPROVEDDENIED

denialReasonstring | nullrequired

Set only when the outcome is DENIED.

decidedAtstringrequired

ISO 8601 timestamp of when the decision was made.

400

Bad request - Invalid path parameters

codestringrequired

Error code indicating the type of error

messagestringrequired

Human-readable error message explaining what went wrong

detailsobject[]

Detailed validation errors when applicable

Show properties

Array of object

fieldstringrequired

errorstringrequired

401

Unauthorized - Missing or invalid authentication

codestringrequired

Error code indicating the type of error

messagestringrequired

Human-readable error message explaining what went wrong

detailsobject[]

Detailed validation errors when applicable

Show properties

Array of object

fieldstringrequired

errorstringrequired

403

Forbidden - the token was minted for the other environment, is not a Public REST API token, does not carry the scope this operation requires, or targeted the test environment (the Returns API is production-only)

codestringrequired

Error code indicating the type of error

messagestringrequired

Human-readable error message explaining what went wrong

detailsobject[]

Detailed validation errors when applicable

Show properties

Array of object

fieldstringrequired

errorstringrequired

404

Not found - no order with the given id is visible to the caller, or its return data could not be resolved

codestringrequired

Error code indicating the type of error

messagestringrequired

Human-readable error message explaining what went wrong

detailsobject[]

Detailed validation errors when applicable

Show properties

Array of object

fieldstringrequired

errorstringrequired

500

Internal server error

codestringrequired

Error code indicating the type of error

messagestringrequired

Human-readable error message explaining what went wrong

detailsobject[]

Detailed validation errors when applicable

Show properties

Array of object

fieldstringrequired

errorstringrequired

Request

curl -X GET "https://api.sibipro.com/orders/SIBI-12345678/returns" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://api.sibipro.com/orders/SIBI-12345678/returns", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

Response

{
  "items": [
    {
      "id": "RET-12345XYZ",
      "orderId": "SIBI-12345678",
      "createdAt": "string",
      "updatedAt": "string",
      "items": [
        {
          "orderLineItemId": "string",
          "quantity": 0,
          "condition": "UNOPENED",
          "requestReason": "string",
          "status": "PENDING",
          "latestDecision": {
            "outcome": "APPROVED",
            "denialReason": "string",
            "decidedAt": "string"
          }
        }
      ]
    }
  ]
}

{
  "code": "string",
  "message": "The request contains invalid parameters",
  "details": [
    {
      "field": "items.0.condition",
      "error": "Invalid enum value"
    },
    {
      "field": "items.0.quantity",
      "error": "Expected positive integer"
    }
  ]
}

{
  "code": "string",
  "message": "The request contains invalid parameters",
  "details": [
    {
      "field": "items.0.condition",
      "error": "Invalid enum value"
    },
    {
      "field": "items.0.quantity",
      "error": "Expected positive integer"
    }
  ]
}

{
  "code": "string",
  "message": "The request contains invalid parameters",
  "details": [
    {
      "field": "items.0.condition",
      "error": "Invalid enum value"
    },
    {
      "field": "items.0.quantity",
      "error": "Expected positive integer"
    }
  ]
}

{
  "code": "string",
  "message": "The request contains invalid parameters",
  "details": [
    {
      "field": "items.0.condition",
      "error": "Invalid enum value"
    },
    {
      "field": "items.0.quantity",
      "error": "Expected positive integer"
    }
  ]
}

{
  "code": "string",
  "message": "The request contains invalid parameters",
  "details": [
    {
      "field": "items.0.condition",
      "error": "Invalid enum value"
    },
    {
      "field": "items.0.quantity",
      "error": "Expected positive integer"
    }
  ]
}