Apply return rules

POST {{baseUrl}}/brand/:brand_domain/return-portal/rule-modifications

This endpoint evaluates return rules against the data provided in the request. Returns the new values to set on the fields and instructions for next steps.

Request Body

{"from_country"=>"<string>", "parcel_weight"=>"<string>", "delivery_option"=>"in_store", "reason_id"=>"<integer>", "refund_type"=>"exchange", "items"=>[{"name"=>"<string>", "id"=>"<string>", "sku"=>"<string>", "reason_id"=>"<integer>"}, {"name"=>"<string>", "id"=>"<string>", "sku"=>"<string>", "reason_id"=>"<integer>"}]}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring
Acceptstring

RESPONSES

status: OK

{&quot;modifications&quot;:[{&quot;action&quot;:&quot;disable_return_requests&quot;,&quot;value&quot;:{&quot;description&quot;:&quot;Value to use, needed when applying certain actions. If a value is not needed for the action, it will be null.&quot;},&quot;item_id&quot;:&quot;\u003cstring\u003e&quot;},{&quot;action&quot;:&quot;item_not_returnable&quot;,&quot;value&quot;:{&quot;description&quot;:&quot;Value to use, needed when applying certain actions. If a value is not needed for the action, it will be null.&quot;},&quot;item_id&quot;:&quot;\u003cstring\u003e&quot;}]}