Evaluate Return Eligibility

Evaluate the return eligibility for given products and customer

POST /commerce/rules/return/evaluate

Error

A valid request URL is required to generate request examples

200

{
  "items": [
    {
      "isReturnable": true,
      "maxDays": 123,
      "maxQty": 123,
      "productCode": "<string>",
      "ruleCode": "<string>",
      "variationProductCode": "<string>"
    }
  ],
  "totalCount": 123
}

Authorizations

Authorization · string · header · required

JWT Authorization header using the Bearer scheme.

Query Parameters

responseFields · string

limits which fields are returned in the response body

Body

application/json

The request containing the products and customer to evaluate

Request parameters for evaluating returns

customerId · integer<int32>

Customer ID

items · object[] | null

List of items to evaluate

Show child attributes

Response

200

application/json

Success

Collection of return evaluation response items

items · object[] | null

Show child attributes

totalCount · integer<int32>