Skip to main content
POST
/
v1
/
orders
/
{request_id}
/
return
Create Return
curl --request POST \
  --url https://api.zinc.io/v1/orders/{request_id}/return \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "products": [
    {
      "product_id": "<string>",
      "quantity": 123
    }
  ],
  "reason_code": "<string>",
  "method_code": "<string>",
  "explanation": "<string>",
  "webhooks": {
    "request_succeeded": "<string>",
    "request_failed": "<string>"
  },
  "cancel_pending": true,
  "return_address": {}
}'
{
  "request_id": "<string>"
}

Authorizations

​
Authorization
string
header
required

Use your client token as the username. Leave the password blank.

Path Parameters

​
request_id
string
required

The request id of the original order

Body

application/json
​
products
object[]
required

A list of product objects that should be returned

​
reason_code
string
required

The reason for the return. This is passed directly to Amazon. Reason codes will vary depending on Amazon country. Many users have had success using "inaccurate website description" for Amazon.com and "description on website was not accurate" for Amazon.co.uk. Note that the reason_code must be an exact match with the reason code dropdown available on Amazon.

​
method_code
string
required

The method of returning the specified products. This is passed directly to Amazon. The available options may vary based on Amazon country and customer address. Note that UPS Dropoff is the only method supported for automatic refunds on Zinc Managed Account orders. If you'd like to use a different method, you'll need to manually request a refund.

​
explanation
string
required

Any extra information that will be passed to Amazon or the Amazon seller. It is required for some return reasons.

​
webhooks
object

A webhooks object including URLs that will receive POST requests after particular events have finished.

​
cancel_pending
boolean

Whether or not this request should cancel any pending returns while creating a new return. Defaults to false.

​
return_address
object

An address object from which the return is sent. If not provided, the default return address from Amazon will be used.

Response

200 - application/json

Return created successfully

​
request_id
string

The unique identifier for the return request

⌘I