Skip to main content
POST
/
returns
Create Return Request
curl --request POST \
  --url https://api.zinc.com/returns \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "items": [
    {
      "order_item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "quantity": 50
    }
  ],
  "notes": "<string>"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "notes": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "resolution_notes": "<string>",
  "items": [],
  "label_urls": [],
  "merchant_return_id": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://www.zinc.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Submit a return request for a previously placed order. Returns are reviewed and resolved asynchronously — subsequent reads will show the current status and any return labels.

​
Request

Required fields:
  • order_id — UUID of the order being returned. The order must belong to the caller and be in order_placed status.
  • items — One or more line items being returned. Each entry has order_item_id (UUID of a line on the order) and quantity (1–100).
  • reason — One of the values in the Reasons table below.
Optional fields:
  • notes — Free-form context (max 2000 characters). Recommended when reason is other.
{
  "order_id": "8c2d…",
  "items": [
    { "order_item_id": "a1b2…", "quantity": 1 }
  ],
  "reason": "damaged",
  "notes": "Arrived with crushed corner."
}

​
Return Reasons

ReasonWhen to use
damagedArrived damaged in transit
not_deliveredPackage never arrived
empty_boxPackage arrived empty / item missing
wrong_itemA different item shipped than what was ordered
defectiveItem works incorrectly / quality issue
not_as_describedItem doesn’t match the listing
wrong_sizeApparel or sizing mismatch
no_longer_neededCustomer changed their mind
forced_cancellationRetailer / system forced cancellation after placement
otherAnything else — include details in notes
Use other only when none of the specific reasons fit. Categorized reasons route faster.

​
Response

A successful request returns the new return request with status: "open" and an empty label_urls array. See Get Return Request for the full response shape.

Authorizations

​
Authorization
string
header
required

Zinc API key (Bearer zn_...)

Headers

​
authorization
string | null

Body

application/json
​
order_id
string<uuid>
required
​
items
ReturnRequestItem · object[]
required

Per-product lines being returned

Minimum array length: 1
​
reason
enum<string>
required

Universal return reason codes (Shopify + Amazon prepaid alignment).

Available options:
damaged,
not_delivered,
empty_box,
wrong_item,
defective,
not_as_described,
wrong_size,
no_longer_needed,
forced_cancellation,
other
​
notes
string | null
Maximum string length: 2000

Response

Successful Response

​
id
string<uuid>
required
​
order_id
string<uuid>
required
​
status
enum<string>
required
Available options:
open,
approved,
denied
​
reason
enum<string>
required

Universal return reason codes (Shopify + Amazon prepaid alignment).

Available options:
damaged,
not_delivered,
empty_box,
wrong_item,
defective,
not_as_described,
wrong_size,
no_longer_needed,
forced_cancellation,
other
​
notes
string | null
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
resolution_notes
string | null
​
items
ReturnRequestItem · object[]
​
label_urls
string[]
​
merchant_return_id
string | null