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/eligibilityAuthorization
AuthorizationBearer token · headerrequiredAPI token from the SIBI developer dashboard (developer.sibipro.com), sent as `Authorization: Bearer <token>`.
Scopes:
read:returnsPath parameters
orderIdstringrequiredThe order the return data belongs to.
min length 1
Responses
200Per-line returnability for the order.
itemsLineItemReturnability[]requiredPer-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 propertiesHide properties
Array of
LineItemReturnabilityindexintegerrequiredZero-based position in the order line items — the correlation key for this verdict.
orderLineItemIdstring | nullrequiredThe order line's itemId. Null on legacy lines that lack one.
productIdstringrequiredThe product on this line.
statusstringrequiredRETURNABLE (check conditions) · NOT_RETURNABLE (see reasons) · UNKNOWN (route to support).
Allowed:
RETURNABLENOT_RETURNABLEUNKNOWNisReturnableboolean | nullrequiredtrue = returnable (conditions may apply) · false = not returnable · null = unknown.
reasonsReturnabilityReason[]requiredWhy the item is not returnable (or why unknown). Empty when RETURNABLE.
Show propertiesHide properties
Array of
ReturnabilityReasoncodestringrequiredMachine-readable reason code.
messagestringrequiredCustomer-facing explanation.
conditionsReturnabilityCondition[]requiredCaveats on an otherwise-returnable item — state that can only be verified at intake.
Show propertiesHide properties
Array of
ReturnabilityConditioncodestringrequiredMachine-readable condition code.
messagestringrequiredCustomer-facing explanation.
policyAppliedReturnPolicy | nullrequiredThe published policy line that applied, when one matched.
Show propertiesHide properties
partnerstringrequiredShop slug the policy matched on.
windowDaysinteger | nullrequiredReturn window in days from delivery, when the policy defines one.
daysRemaininginteger | nullrequiredDays left in the window (0 = expires today). Null when there is no window or it is unverifiable.
windowEndsAtstring | nullrequiredExclusive end of the window (ISO 8601): now < windowEndsAt means it is open.
restockingFeestring | nullrequiredPublished restocking-fee text. Never a computed amount.
summarystringrequiredCustomer-facing summary of the published policy line.
400Bad request - Invalid path parameters
codestringrequiredError code indicating the type of error
messagestringrequiredHuman-readable error message explaining what went wrong
detailsobject[]Detailed validation errors when applicable
Show propertiesHide properties
Array of
objectfieldstringrequirederrorstringrequired401Unauthorized - Missing or invalid authentication
codestringrequiredError code indicating the type of error
messagestringrequiredHuman-readable error message explaining what went wrong
detailsobject[]Detailed validation errors when applicable
Show propertiesHide properties
Array of
objectfieldstringrequirederrorstringrequired403Forbidden - 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)
codestringrequiredError code indicating the type of error
messagestringrequiredHuman-readable error message explaining what went wrong
detailsobject[]Detailed validation errors when applicable
Show propertiesHide properties
Array of
objectfieldstringrequirederrorstringrequired404Not found - no order with the given id is visible to the caller, or its return data could not be resolved
codestringrequiredError code indicating the type of error
messagestringrequiredHuman-readable error message explaining what went wrong
detailsobject[]Detailed validation errors when applicable
Show propertiesHide properties
Array of
objectfieldstringrequirederrorstringrequired500Internal server error
codestringrequiredError code indicating the type of error
messagestringrequiredHuman-readable error message explaining what went wrong
detailsobject[]Detailed validation errors when applicable
Show propertiesHide properties
Array of
objectfieldstringrequirederrorstringrequiredRequest
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"
}
]
}