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>"
}
'

import requests

url = "https://api.zinc.com/returns"

payload = {
    "order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "items": [
        {
            "order_item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "quantity": 50
        }
    ],
    "notes": "<string>"
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    order_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    items: [{order_item_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a', quantity: 50}],
    notes: '<string>'
  })
};

fetch('https://api.zinc.com/returns', 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.zinc.com/returns",
  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([
    'order_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'items' => [
        [
                'order_item_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                'quantity' => 50
        ]
    ],
    'notes' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "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.zinc.com/returns"

	payload := strings.NewReader("{\n  \"order_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"items\": [\n    {\n      \"order_item_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"quantity\": 50\n    }\n  ],\n  \"notes\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	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.zinc.com/returns")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"order_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"items\": [\n    {\n      \"order_item_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"quantity\": 50\n    }\n  ],\n  \"notes\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.zinc.com/returns")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"order_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"items\": [\n    {\n      \"order_item_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"quantity\": 50\n    }\n  ],\n  \"notes\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "open",
  "reason": "damaged",
  "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>"
}

{
  "error": {
    "code": "unauthorized",
    "message": "<string>",
    "details": {}
  }
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

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>"
}
'

import requests

url = "https://api.zinc.com/returns"

payload = {
    "order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "items": [
        {
            "order_item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "quantity": 50
        }
    ],
    "notes": "<string>"
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    order_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    items: [{order_item_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a', quantity: 50}],
    notes: '<string>'
  })
};

fetch('https://api.zinc.com/returns', 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.zinc.com/returns",
  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([
    'order_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'items' => [
        [
                'order_item_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                'quantity' => 50
        ]
    ],
    'notes' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "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.zinc.com/returns"

	payload := strings.NewReader("{\n  \"order_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"items\": [\n    {\n      \"order_item_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"quantity\": 50\n    }\n  ],\n  \"notes\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	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.zinc.com/returns")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"order_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"items\": [\n    {\n      \"order_item_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"quantity\": 50\n    }\n  ],\n  \"notes\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.zinc.com/returns")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"order_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"items\": [\n    {\n      \"order_item_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"quantity\": 50\n    }\n  ],\n  \"notes\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "open",
  "reason": "damaged",
  "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>"
}

{
  "error": {
    "code": "unauthorized",
    "message": "<string>",
    "details": {}
  }
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

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

Reason	When to use
`damaged`	Arrived damaged in transit
`not_delivered`	Package never arrived
`empty_box`	Package arrived empty / item missing
`wrong_item`	A different item shipped than what was ordered
`defective`	Item works incorrectly / quality issue
`not_as_described`	Item doesn’t match the listing
`wrong_size`	Apparel or sizing mismatch
`no_longer_needed`	Customer changed their mind
`forced_cancellation`	Retailer / system forced cancellation after placement
`other`	Anything 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

Show child attributes

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

string<uuid>

required

order_id

string<uuid>

required

status

enum<string>

required

Available options:

open,

approved,

denied,

credited

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[]

Show child attributes

label_urls

string[]

merchant_return_id

string | null

Getting Started

Agent Sandbox

Search (Beta)

Orders

Bulk Orders

Managed Accounts

Returns

Product Data

Retailers

Agent

Usage

Create Return Request

Request

Return Reasons

Response

Authorizations

Headers

Body

Response

​Request

​Return Reasons

​Response

Authorizations

Headers

Body

Response

Request

Return Reasons

Response