Skip to main content
PATCH
Change a return line's reason

Authorizations

Authorization
string
header
required

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

Idempotency-Key
string

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: 255

Path Parameters

id
string<uuid>
required
item_id
string<uuid>
required

The return line: an id of the return's items.

Body

application/json
reason_code
enum<string>

The line's new reason. Any other value is refused 422 invalid_reason_code. Required unless reason_words is sent (400 missing_field). Sending the reason the line already has changes nothing.

Available options:
defective,
damaged_in_transit,
wrong_item_shipped,
not_as_described,
no_longer_needed,
found_better_price,
arrived_late,
other,
unspecified
reason_words
string

Why, in words, kept as an internal note of the return and never shown to the customer. Required when reason_code is other (422 reason_words_required); words that are only spaces are no words. At most 2,000 characters (422 note_too_long).

Maximum string length: 2000

Response

The line's reason after the edit, and what the edit changed.

data
object
required