Check return eligibility

Returns per-line returnability for an order, index-aligned to the order’s line items. Use it before POST /orders/{orderId}/returns to see which lines can be returned, the window that applies, and any conditions. An order that does not exist or is not visible to the caller returns 404.

GET/{orderId}/returns/eligibility

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

Per-line returnability for the order.

itemsLineItemReturnability[]required

Per-line returnability, index-aligned to the order line items. Never empty — an order whose returnability cannot be produced surfaces as a 404, not an empty list.

Show properties

Array of LineItemReturnability

indexintegerrequired

Zero-based position in the order line items — the correlation key for this verdict.

orderLineItemIdstring | nullrequired

The order line's itemId. Null on legacy lines that lack one.

productIdstringrequired

The product on this line.

statusstringrequired

RETURNABLE (check conditions) · NOT_RETURNABLE (see reasons) · UNKNOWN (route to support).

Allowed:RETURNABLENOT_RETURNABLEUNKNOWN

isReturnableboolean | nullrequired

true = returnable (conditions may apply) · false = not returnable · null = unknown.

reasonsReturnabilityReason[]required

Why the item is not returnable (or why unknown). Empty when RETURNABLE.

Show properties

Array of ReturnabilityReason

codestringrequired

Machine-readable reason code.

messagestringrequired

Customer-facing explanation.

conditionsReturnabilityCondition[]required

Caveats on an otherwise-returnable item — state that can only be verified at intake.

Show properties

Array of ReturnabilityCondition

codestringrequired

Machine-readable condition code.

messagestringrequired

Customer-facing explanation.

policyAppliedReturnPolicy | nullrequired

The published policy line that applied, when one matched.

Show properties

partnerstringrequired

Shop slug the policy matched on.

windowDaysinteger | nullrequired

Return window in days from delivery, when the policy defines one.

daysRemaininginteger | nullrequired

Days left in the window (0 = expires today). Null when there is no window or it is unverifiable.

windowEndsAtstring | nullrequired

Exclusive end of the window (ISO 8601): now < windowEndsAt means it is open.

restockingFeestring | nullrequired

Published restocking-fee text. Never a computed amount.

summarystringrequired

Customer-facing summary of the published policy line.

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/eligibility" \
  -H "Authorization: Bearer YOUR_TOKEN"

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

Response

{
  "items": [
    {
      "index": 0,
      "orderLineItemId": "string",
      "productId": "string",
      "status": "RETURNABLE",
      "isReturnable": true,
      "reasons": [
        {
          "code": "RETURN_WINDOW_EXPIRED",
          "message": "string"
        }
      ],
      "conditions": [
        {
          "code": "MUST_BE_UNOPENED",
          "message": "string"
        }
      ],
      "policy": {
        "partner": "ge",
        "windowDays": 0,
        "daysRemaining": 0,
        "windowEndsAt": "string",
        "restockingFee": "5–10% restocking fee",
        "summary": "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"
    }
  ]
}