BrainerceGet what can be returned from an order
Per line, how many units can still be returned and why a line cannot, the end of the return window and the store's reasons to choose from. An order that is not the signed-in customer's, or was placed through another channel, answers 404.
For /api/vc/{connectionId}/* routes the connectionId (vc_*) is in the URL path — not a header. Live-mode requests must also send a matching Origin header.
In: header
Path Parameters
Sales channel ID (vc_*), the canonical salesChannelId. connectionId is the deprecated name of the same value and is still the literal path segment.
Order id.
Header Parameters
Origin of the storefront page making the call, for example https://shop.example.com. Required: a request with no Origin header is refused with 403. On a LIVE channel its host must equal the channel's registered domain (or one of its subdomains) or match an allowed origin. A TEST channel with no domain accepts any origin; once a domain is set it is matched as on LIVE.
Customer token as Bearer <token>, returned by customers/login, customers/register or the OAuth callback. Expires after 7 days. It is a customer token, never an API key.
Version of the calling SDK (the Brainerce SDK sends it automatically). Informational: it is recorded on the channel and never changes the response.
curl -X GET "https://api.brainerce.com/api/vc/string/customers/me/orders/string/return-eligibility" \ -H "origin: string" \ -H "authorization: string" \ -H "X-SDK-Version: string"{
"eligible": true,
"reason": "RETURNS_DISABLED",
"windowStartedAt": "2019-08-24T14:15:22Z",
"windowEndsAt": "2019-08-24T14:15:22Z",
"currency": "string",
"lines": [
{
"lineId": "string",
"name": "string",
"sku": "string",
"productId": "string",
"variantId": "string",
"orderedQuantity": 0,
"refundedQuantity": 0,
"inReturnQuantity": 0,
"returnableQuantity": 0,
"reason": "GIFT_CARD"
}
],
"reasons": [
{
"code": "string",
"label": "string"
}
]
}{
"statusCode": 401,
"code": "UNAUTHORIZED",
"message": "Invalid or expired credential",
"timestamp": "2026-08-23T10:15:00.000Z",
"path": "/api/vc/{connectionId}/customers/me/orders/{orderId}/return-eligibility"
}{
"statusCode": 403,
"code": "INSUFFICIENT_SCOPE",
"message": "API key does not have the required scope: products:write",
"timestamp": "2026-08-23T10:15:00.000Z",
"path": "/api/vc/{connectionId}/customers/me/orders/{orderId}/return-eligibility"
}{
"statusCode": 404,
"code": "RESOURCE_NOT_FOUND",
"message": "Resource not found",
"timestamp": "2026-08-23T10:15:00.000Z",
"path": "/api/vc/{connectionId}/customers/me/orders/{orderId}/return-eligibility"
}{
"statusCode": 429,
"code": "RATE_LIMITED",
"message": "Too many requests",
"details": {
"retryAfterSeconds": 12
},
"timestamp": "2026-08-23T10:15:00.000Z",
"path": "/api/vc/{connectionId}/customers/me/orders/{orderId}/return-eligibility"
}