Process Return Rules

Applies the return rules to the shipment items and responds if items are eligible for return. Provides fulfillment information for order items such as quantity ordered, fulfilled, and returned. Indicates which items are eligible for return.

POST /commerce/orders/{orderId}/processreturnrules

Error

A valid request URL is required to generate request examples

200

[
  {
    "appliedReturnRuleInfo": {
      "isItemReturnable": true,
      "maxReturnQtyExceeded": true,
      "returnRuleInfo": {
        "isReturnable": true,
        "maxDays": 123,
        "maxQty": 123,
        "ruleCode": "<string>"
      },
      "returnWindowClosed": true
    },
    "shipmentItemId": 123,
    "shipmentNumber": 123
  }
]

Authorizations

Authorization · string · header · required

JWT Authorization header using the Bearer scheme.

Path Parameters

orderId · string · required

Unique identifier of the order item.

Query Parameters

responseFields · string

limits which fields are returned in the response body

Body

application/json

List of the shipments and their items to validate return rules

items · object[] | null

Show child attributes

totalCount · integer<int32>

Response

200

application/json

Success

appliedReturnRuleInfo · object

Show child attributes

shipmentItemId · integer<int32>

shipmentNumber · integer<int32>