Create Return Request

Creates new Return Request. Pickup location is mandatory in the request in order to successfully create reverse shipment on Return Request approval.

SecurityOauth2.0
Request
header Parameters
tenant-id
string
Request Body schema: application/json
merchant
required
string
object (Pickup Request)

Pickup request must contain all the neccessary information about the sender: their name, phone number, email, address, city and country. These properties will be given from the corresponding partner location, if either of following fields are specified instead: partner_location_id, partner_location_name, partner_location_code.

channel
string
partner_order_reference
required
string
Array of objects (Return Request Additional Reference)

List of additional references associated with this return request.

required
Array of objects
Array of objects
resolution
required
string
Responses
200
400

Returns 400 when

  • duplicated SKU found in request
  • the requested quantity is missing for some SKU
post/returns/requests
Request samples
application/json
{
  • "merchant": "string",
  • "pickup": {
    },
  • "channel": "string",
  • "partner_order_reference": "string",
  • "additional_references": [
    ],
  • "items": [
    ],
  • "comments": [
    ],
  • "resolution": "string"
}
Response samples
application/json
{
  • "return_request_id": "RMA_843X7O267D7T",
  • "shipments": [
    ],
  • "partner_order_reference": "string",
  • "additional_references": [
    ],
  • "merchant": "string",
  • "status": "string",
  • "pickup": {
    },
  • "customer_comment": "string",
  • "channel": "string",
  • "notes": [
    ],
  • "items": [
    ],
  • "refund_method": "string",
  • "refund_info": {
    },
  • "creation_date": "string",
  • "update_date": "string",
  • "approval_date": "string",
  • "cancellation_date": "string",
  • "rejection_date": "string",
  • "completion_date": "string",
  • "return_items_updates": [
    ]
}