API reference
A valid request URL is required to generate request examples{
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"code": "<string>",
"customerRules": [
"<string>"
],
"description": "<string>",
"enabled": true,
"isReturnable": true,
"maxDays": 123,
"maxQty": 123,
"metaData": "<unknown>",
"name": "<string>",
"productRules": [
"<string>"
],
"rank": 123,
"validForAllSites": true,
"validSites": [
123
]
}Create Return Rule
Creates a new return rule.
A valid request URL is required to generate request examples{
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"code": "<string>",
"customerRules": [
"<string>"
],
"description": "<string>",
"enabled": true,
"isReturnable": true,
"maxDays": 123,
"maxQty": 123,
"metaData": "<unknown>",
"name": "<string>",
"productRules": [
"<string>"
],
"rank": 123,
"validForAllSites": true,
"validSites": [
123
]
}Authorizations
JWT Authorization header using the Bearer scheme.
Query Parameters
limits which fields are returned in the response body
Body
Return Rule contract
Show child attributes
Show child attributes
Unique identifier of the Return.
List of customer rule codes that apply to the Return
Return description
Indicates if the Return is enabled
Indicates if the Return is IsReturnable
Maximum Days of the Return
Maximum quantity of the Return
Metadata for the ReturnRule which is a json format, used to store additional information
Return name
List of product rule codes that apply to the Return
Rank of the Return
Indicates if the ReturnRule is valid for all sites
List of site IDs that the ReturnRule is valid for
Response
Success
Return Rule contract
Show child attributes
Show child attributes
Unique identifier of the Return.
List of customer rule codes that apply to the Return
Return description
Indicates if the Return is enabled
Indicates if the Return is IsReturnable
Maximum Days of the Return
Maximum quantity of the Return
Metadata for the ReturnRule which is a json format, used to store additional information
Return name
List of product rule codes that apply to the Return
Rank of the Return
Indicates if the ReturnRule is valid for all sites
List of site IDs that the ReturnRule is valid for