Skip to main content
GET
/
commerce
/
rules
/
return
/
{code}
Error
A valid request URL is required to generate request examples
{
  "code": "<string>",
  "name": "<string>",
  "description": "<string>",
  "maxQty": 123,
  "maxDays": 123,
  "productRules": [
    "<string>"
  ],
  "customerRules": [
    "<string>"
  ],
  "rank": 123,
  "enabled": true,
  "isReturnable": true,
  "validForAllSites": true,
  "validSites": [
    123
  ],
  "metaData": "<unknown>",
  "auditInfo": {
    "updateDate": "2023-11-07T05:31:56Z",
    "createDate": "2023-11-07T05:31:56Z",
    "updateBy": "<string>",
    "createBy": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Path Parameters

​
code
string
required

The code of the Return rule.

Query Parameters

​
responseFields
string

limits which fields are returned in the response body

Response

Success

Return Rule contract

​
code
string | null

Unique identifier of the Return.

​
name
string | null

Return name

​
description
string | null

Return description

​
maxQty
integer<int32> | null

Maximum quantity of the Return

​
maxDays
integer<int32> | null

Maximum Days of the Return

​
productRules
string[] | null

List of product rule codes that apply to the Return

​
customerRules
string[] | null

List of customer rule codes that apply to the Return

​
rank
integer<int32>

Rank of the Return

​
enabled
boolean | null

Indicates if the Return is enabled

​
isReturnable
boolean | null

Indicates if the Return is IsReturnable

​
validForAllSites
boolean | null

Indicates if the ReturnRule is valid for all sites

​
validSites
integer<int32>[] | null

List of site IDs that the ReturnRule is valid for

​
metaData
any | null

Metadata for the ReturnRule which is a json format, used to store additional information

​
auditInfo
object