Change a return's fees
curl --request POST \
--url https://api.arcuserp.com/v1/returns/{id}/fee-intents \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"intents": [
{
"op": "pick_rule",
"coupon_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"expected_updated_at": "2023-11-07T05:31:56Z"
}
'import requests
url = "https://api.arcuserp.com/v1/returns/{id}/fee-intents"
payload = {
"intents": [
{
"op": "pick_rule",
"coupon_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"expected_updated_at": "2023-11-07T05:31:56Z"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
intents: [{op: 'pick_rule', coupon_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'}],
expected_updated_at: '2023-11-07T05:31:56Z'
})
};
fetch('https://api.arcuserp.com/v1/returns/{id}/fee-intents', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.arcuserp.com/v1/returns/{id}/fee-intents",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'intents' => [
[
'op' => 'pick_rule',
'coupon_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
],
'expected_updated_at' => '2023-11-07T05:31:56Z'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.arcuserp.com/v1/returns/{id}/fee-intents"
payload := strings.NewReader("{\n \"intents\": [\n {\n \"op\": \"pick_rule\",\n \"coupon_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ],\n \"expected_updated_at\": \"2023-11-07T05:31:56Z\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.arcuserp.com/v1/returns/{id}/fee-intents")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"intents\": [\n {\n \"op\": \"pick_rule\",\n \"coupon_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ],\n \"expected_updated_at\": \"2023-11-07T05:31:56Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.arcuserp.com/v1/returns/{id}/fee-intents")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"intents\": [\n {\n \"op\": \"pick_rule\",\n \"coupon_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ],\n \"expected_updated_at\": \"2023-11-07T05:31:56Z\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"return_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"return_number": "<string>",
"preview": true,
"updated_at": "2023-11-07T05:31:56Z",
"lines": [
{
"key": "<string>",
"direction": "fee",
"source": {
"kind": "rule",
"coupon_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"applied": "auto",
"snapshot": {},
"reason_code": "<string>",
"note": "<string>",
"from": "typed_line",
"original": {},
"carried_from": "<string>",
"label_id": "<string>",
"folded_rule": {},
"taken_typed_line": {},
"absent_from_stored": true,
"legacy_claim_waiver": true
},
"fee_class": "restocking",
"label": "<string>",
"gl_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"calc": {
"mode": "flat",
"value": 123,
"deferred": true
},
"computed_amount": 123,
"override": {
"amount": 123,
"waive": true,
"reason": "<string>",
"by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"at": "2023-11-07T05:31:56Z"
},
"final_amount": 123,
"taxable": true,
"taxable_source": "rule",
"waived": true,
"waiver_source": "rule_merchant_fault",
"by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"at": "2023-11-07T05:31:56Z",
"disclosed_at": "2023-11-07T05:31:56Z",
"tax_override": {
"taxable": true,
"reason": "<string>",
"by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"at": "2023-11-07T05:31:56Z"
},
"cap_reduction": 123,
"exemption": {},
"superseded_by": "<string>",
"restocking_bound": {
"code": "restocking_fee_above_entity_max",
"entity_fee_min": 123,
"entity_fee_max": 123,
"outcome": "clamped",
"from": 123,
"to": 123,
"source": "stamp",
"words": "<string>"
},
"fee_type": "<string>",
"mode": "flat",
"value": 123,
"calculated_amount": 123,
"gl_account_key": "<string>",
"coupon_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"_auto_rule": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"rule_fee_min": 123,
"rule_fee_max": 123,
"deferred_pct": 123,
"_waived": true
}
],
"totals": {
"fees": 123,
"credits": 123,
"net_fee_income": 123,
"uncapped_fees": 123,
"taxable_fees": 123,
"fee_tax": 123,
"by_class": {}
},
"restocking_fee": 123,
"refusals": [
{
"code": "<string>",
"intent_index": 123,
"field": "<string>",
"errors": [
{
"code": "<string>",
"field": "<string>"
}
],
"key": "<string>",
"keys": [
"<string>"
],
"box_key": "<string>",
"coupon_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"goods": 123,
"uncapped_total": 123,
"why": "<string>"
}
],
"offers": [
{
"code": "<string>",
"key": "<string>",
"actions": [
"waive"
]
}
],
"notices": [
{
"code": "<string>"
}
],
"allow_ad_hoc_fees": true,
"books": {
"lines": [
{
"kind": "note",
"text": "<string>",
"amount": 123
}
],
"books_nothing": true
},
"logged": 123
}
}{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123"
}{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123"
}{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123",
"meta": {
"refusals": [
{
"code": "<string>",
"intent_index": 123,
"field": "<string>",
"errors": [
{
"code": "<string>",
"field": "<string>"
}
],
"key": "<string>",
"keys": [
"<string>"
],
"box_key": "<string>",
"coupon_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"goods": 123,
"uncapped_total": 123,
"why": "<string>"
}
],
"offers": [
{
"code": "<string>",
"key": "<string>",
"actions": [
"waive"
]
}
]
},
"fee_amount": 123,
"goods_value": 123,
"updated_at": "2023-11-07T05:31:56Z",
"status": "<string>",
"message": "<string>",
"permission_key": "<string>",
"role": "<string>"
}{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123"
}{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123",
"meta": {
"refusals": [
{
"code": "<string>",
"intent_index": 123,
"field": "<string>",
"errors": [
{
"code": "<string>",
"field": "<string>"
}
],
"key": "<string>",
"keys": [
"<string>"
],
"box_key": "<string>",
"coupon_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"goods": 123,
"uncapped_total": 123,
"why": "<string>"
}
],
"offers": [
{
"code": "<string>",
"key": "<string>",
"actions": [
"waive"
]
}
]
},
"fee_amount": 123,
"goods_value": 123,
"updated_at": "2023-11-07T05:31:56Z",
"status": "<string>",
"message": "<string>",
"permission_key": "<string>",
"role": "<string>"
}{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123",
"meta": {
"refusals": [
{
"code": "<string>",
"intent_index": 123,
"field": "<string>",
"errors": [
{
"code": "<string>",
"field": "<string>"
}
],
"key": "<string>",
"keys": [
"<string>"
],
"box_key": "<string>",
"coupon_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"goods": 123,
"uncapped_total": 123,
"why": "<string>"
}
],
"offers": [
{
"code": "<string>",
"key": "<string>",
"actions": [
"waive"
]
}
]
},
"fee_amount": 123,
"goods_value": 123,
"updated_at": "2023-11-07T05:31:56Z",
"status": "<string>",
"message": "<string>",
"permission_key": "<string>",
"role": "<string>"
}{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123",
"meta": {
"refusals": [
{
"code": "<string>",
"intent_index": 123,
"field": "<string>",
"errors": [
{
"code": "<string>",
"field": "<string>"
}
],
"key": "<string>",
"keys": [
"<string>"
],
"box_key": "<string>",
"coupon_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"goods": 123,
"uncapped_total": 123,
"why": "<string>"
}
],
"offers": [
{
"code": "<string>",
"key": "<string>",
"actions": [
"waive"
]
}
]
},
"fee_amount": 123,
"goods_value": 123,
"updated_at": "2023-11-07T05:31:56Z",
"status": "<string>",
"message": "<string>",
"permission_key": "<string>",
"role": "<string>"
}Returns
Change a return's fees
Changes a return’s fee lines one change at a time: pick a saved fee rule, add a one-off fee or credit with its reason, set a line’s amount or decide its tax, waive a line, or remove one. Every change runs the return’s one fee plan (its rules, caps, waivers and tax), and the plan’s lines are what is stored, with one activity row per change naming the key’s creator. Send expected_updated_at, the return’s updated_at as you read it: a save made from an older copy is refused 409 rma_changed and nothing is written. A refusal the save causes refuses the whole save (nothing is written) and lists every refusal with what can be done about it in meta.offers; a refusal that stood before is answered in refusals and refuses nothing. A closed, voided or cancelled return takes no fee change (409). Nothing posts and no money moves: the fees post when the return closes. Requires the returns:write scope and the returns.edit permission for the key’s creator (a tax decision also takes returns.override_condition). Preview the same save with POST /returns/{id}/fee-intents/preview.
POST
/
returns
/
{id}
/
fee-intents
Change a return's fees
curl --request POST \
--url https://api.arcuserp.com/v1/returns/{id}/fee-intents \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"intents": [
{
"op": "pick_rule",
"coupon_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"expected_updated_at": "2023-11-07T05:31:56Z"
}
'import requests
url = "https://api.arcuserp.com/v1/returns/{id}/fee-intents"
payload = {
"intents": [
{
"op": "pick_rule",
"coupon_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"expected_updated_at": "2023-11-07T05:31:56Z"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
intents: [{op: 'pick_rule', coupon_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'}],
expected_updated_at: '2023-11-07T05:31:56Z'
})
};
fetch('https://api.arcuserp.com/v1/returns/{id}/fee-intents', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.arcuserp.com/v1/returns/{id}/fee-intents",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'intents' => [
[
'op' => 'pick_rule',
'coupon_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
],
'expected_updated_at' => '2023-11-07T05:31:56Z'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.arcuserp.com/v1/returns/{id}/fee-intents"
payload := strings.NewReader("{\n \"intents\": [\n {\n \"op\": \"pick_rule\",\n \"coupon_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ],\n \"expected_updated_at\": \"2023-11-07T05:31:56Z\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.arcuserp.com/v1/returns/{id}/fee-intents")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"intents\": [\n {\n \"op\": \"pick_rule\",\n \"coupon_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ],\n \"expected_updated_at\": \"2023-11-07T05:31:56Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.arcuserp.com/v1/returns/{id}/fee-intents")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"intents\": [\n {\n \"op\": \"pick_rule\",\n \"coupon_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ],\n \"expected_updated_at\": \"2023-11-07T05:31:56Z\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"return_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"return_number": "<string>",
"preview": true,
"updated_at": "2023-11-07T05:31:56Z",
"lines": [
{
"key": "<string>",
"direction": "fee",
"source": {
"kind": "rule",
"coupon_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"applied": "auto",
"snapshot": {},
"reason_code": "<string>",
"note": "<string>",
"from": "typed_line",
"original": {},
"carried_from": "<string>",
"label_id": "<string>",
"folded_rule": {},
"taken_typed_line": {},
"absent_from_stored": true,
"legacy_claim_waiver": true
},
"fee_class": "restocking",
"label": "<string>",
"gl_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"calc": {
"mode": "flat",
"value": 123,
"deferred": true
},
"computed_amount": 123,
"override": {
"amount": 123,
"waive": true,
"reason": "<string>",
"by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"at": "2023-11-07T05:31:56Z"
},
"final_amount": 123,
"taxable": true,
"taxable_source": "rule",
"waived": true,
"waiver_source": "rule_merchant_fault",
"by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"at": "2023-11-07T05:31:56Z",
"disclosed_at": "2023-11-07T05:31:56Z",
"tax_override": {
"taxable": true,
"reason": "<string>",
"by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"at": "2023-11-07T05:31:56Z"
},
"cap_reduction": 123,
"exemption": {},
"superseded_by": "<string>",
"restocking_bound": {
"code": "restocking_fee_above_entity_max",
"entity_fee_min": 123,
"entity_fee_max": 123,
"outcome": "clamped",
"from": 123,
"to": 123,
"source": "stamp",
"words": "<string>"
},
"fee_type": "<string>",
"mode": "flat",
"value": 123,
"calculated_amount": 123,
"gl_account_key": "<string>",
"coupon_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"_auto_rule": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"rule_fee_min": 123,
"rule_fee_max": 123,
"deferred_pct": 123,
"_waived": true
}
],
"totals": {
"fees": 123,
"credits": 123,
"net_fee_income": 123,
"uncapped_fees": 123,
"taxable_fees": 123,
"fee_tax": 123,
"by_class": {}
},
"restocking_fee": 123,
"refusals": [
{
"code": "<string>",
"intent_index": 123,
"field": "<string>",
"errors": [
{
"code": "<string>",
"field": "<string>"
}
],
"key": "<string>",
"keys": [
"<string>"
],
"box_key": "<string>",
"coupon_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"goods": 123,
"uncapped_total": 123,
"why": "<string>"
}
],
"offers": [
{
"code": "<string>",
"key": "<string>",
"actions": [
"waive"
]
}
],
"notices": [
{
"code": "<string>"
}
],
"allow_ad_hoc_fees": true,
"books": {
"lines": [
{
"kind": "note",
"text": "<string>",
"amount": 123
}
],
"books_nothing": true
},
"logged": 123
}
}{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123"
}{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123"
}{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123",
"meta": {
"refusals": [
{
"code": "<string>",
"intent_index": 123,
"field": "<string>",
"errors": [
{
"code": "<string>",
"field": "<string>"
}
],
"key": "<string>",
"keys": [
"<string>"
],
"box_key": "<string>",
"coupon_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"goods": 123,
"uncapped_total": 123,
"why": "<string>"
}
],
"offers": [
{
"code": "<string>",
"key": "<string>",
"actions": [
"waive"
]
}
]
},
"fee_amount": 123,
"goods_value": 123,
"updated_at": "2023-11-07T05:31:56Z",
"status": "<string>",
"message": "<string>",
"permission_key": "<string>",
"role": "<string>"
}{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123"
}{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123",
"meta": {
"refusals": [
{
"code": "<string>",
"intent_index": 123,
"field": "<string>",
"errors": [
{
"code": "<string>",
"field": "<string>"
}
],
"key": "<string>",
"keys": [
"<string>"
],
"box_key": "<string>",
"coupon_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"goods": 123,
"uncapped_total": 123,
"why": "<string>"
}
],
"offers": [
{
"code": "<string>",
"key": "<string>",
"actions": [
"waive"
]
}
]
},
"fee_amount": 123,
"goods_value": 123,
"updated_at": "2023-11-07T05:31:56Z",
"status": "<string>",
"message": "<string>",
"permission_key": "<string>",
"role": "<string>"
}{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123",
"meta": {
"refusals": [
{
"code": "<string>",
"intent_index": 123,
"field": "<string>",
"errors": [
{
"code": "<string>",
"field": "<string>"
}
],
"key": "<string>",
"keys": [
"<string>"
],
"box_key": "<string>",
"coupon_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"goods": 123,
"uncapped_total": 123,
"why": "<string>"
}
],
"offers": [
{
"code": "<string>",
"key": "<string>",
"actions": [
"waive"
]
}
]
},
"fee_amount": 123,
"goods_value": 123,
"updated_at": "2023-11-07T05:31:56Z",
"status": "<string>",
"message": "<string>",
"permission_key": "<string>",
"role": "<string>"
}{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123",
"meta": {
"refusals": [
{
"code": "<string>",
"intent_index": 123,
"field": "<string>",
"errors": [
{
"code": "<string>",
"field": "<string>"
}
],
"key": "<string>",
"keys": [
"<string>"
],
"box_key": "<string>",
"coupon_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"goods": 123,
"uncapped_total": 123,
"why": "<string>"
}
],
"offers": [
{
"code": "<string>",
"key": "<string>",
"actions": [
"waive"
]
}
]
},
"fee_amount": 123,
"goods_value": 123,
"updated_at": "2023-11-07T05:31:56Z",
"status": "<string>",
"message": "<string>",
"permission_key": "<string>",
"role": "<string>"
}Authorizations
API key issued per entity via Settings > Developers > API Keys.
Each key carries scopes (e.g. orders:read, products:write).
Bearer token format: Authorization: Bearer ark_live_ent_Test keys use ark_test_ent_. Both are issued per entity
via Settings > Developers > API Keys.
Headers
Client-generated unique key for idempotent POST/PATCH/DELETE operations.
Alias for the Idempotency parameter. Max 255 chars. On retry with the
same key, the original response is returned without re-executing the
operation. Keys expire after 24 hours. A second request with the same
key sent while the first is still running waits for it and returns its
answer; if the first is still running after 20 seconds the second
answers 409 idempotency_key_in_use (retryable, nothing done). An
answer carrying retryable: true is not cached. Reusing a key with a
different request body answers 409 idempotency_key_collision (nothing
done; send the new request with a fresh key). The replay, the wait and
these two 409 codes come from the idempotency layer, so they apply to
the operations that run it, each of which can answer the two codes
whether or not its own 409 response lists them. The handlers of these
operations take the header but do not run the layer, so on them the key
neither replays nor answers either code: createPaymentPlan,
chargePaymentPlanInstallment, setProductLocations, updateOrder,
emailOrder, updateOrderItem, confirmPickup, markOrderNoShow,
applyExistingPaymentToInvoices, updatePackage, movePackageItem,
changePackageBox, changePackageCarrier, voidPackageLabel,
printPackageLabel, emailPackage, setProNumberV1, setPackageProNumber,
sendPurchaseOrderToVendorV1, notifyRevisionPurchaseOrderV1,
addMaintenanceLog, generateBOLV1,
createReportJobV1 and customerAcknowledgeRevision; recordVendorPrepaymentV1
and recordCustomerDepositV1 hand the key to their own write instead.
Maximum string length:
255Path Parameters
Body
application/json
One save: the changes to make, one intent each, and the copy of the return they were made from.
The changes, applied in order; told apart by op. A key no intent's op takes is refused 422 intent_invalid (or client_field_forbidden for a field only the server sets, such as source, final_amount or waived).
Required array length:
1 - 50 elementsAdds a saved return fee rule to the return (Settings > Adjustments & Coupons); the rule's own calculation, caps, tax and waiver apply.
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
Show child attributes
Show child attributes
The return's updated_at as you read it (on GET /returns/{id}, or the updated_at of the last fee change's answer). A save made from an older copy is refused 409 rma_changed; nothing is written.
Response
The changes were saved. The answer is the return's fee plan after them, read inside the save.
Show child attributes
Show child attributes
Was this page helpful?