Skip to main content
POST
/
returns
Create Manual Return
curl --request POST \
  --url http://api.withzimi.com/returns \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "[email protected]",
  "receive_by": "2024-09-01",
  "total_price": 100,
  "currency": "USD",
  "weight": 23,
  "weight_unit": "g",
  "reason_of_return": "This is reason",
  "length": 10,
  "width": 10,
  "height": 10,
  "dimension_unit": "cm",
  "return_line_items": [
    {
      "quantity": 1,
      "unreceived_quantity": 0,
      "name": "Product A",
      "price": 119,
      "currency": "USD",
      "merchant_sku": "GHSAK42157614 - M"
    },
    {
      "quantity": 2,
      "unreceived_quantity": 1,
      "name": "Product B",
      "price": 25,
      "currency": "USD",
      "merchant_sku": "SKU67890"
    }
  ]
}
'

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
email
string
required
​
receive_by
string
required
​
total_price
number
required
​
currency
string
required
​
weight
integer
required
​
weight_unit
string
required
​
reason_of_return
string
required
​
length
integer
required
​
width
integer
required
​
height
integer
required
​
dimension_unit
string
required
​
return_line_items
ReturnLineItem · object[]
required

Response

200 - undefined