Return Order flow

Create RTO: API to create RTO (initiated from vendor) for an order.

Request Body:

{
  "order_id": "string",
  "order_items": [
    {
      "item_id": "string",
      "order_item_id": "string",
      "quantity": 0,
      "qc_code": "string",
      "reason": "string"
    }
  ]
}

Response Body:

{
  "error_message": "string",
  "return_order_id": "string",
  "status": "enum (SUCCESS, FAILED)"
}

Exception Handling:

Error	Response Code

Error	Response Code
Request is successful	200
Token is invalid or expired	401
Invalid request	400

2. Get Return Orders: API to fetch Return Orders (both RTO and Customer returns)

Response Body:

{
  "orders": [
    {
      "return_order_id": "string",
      "return_date": 1635828975,
      "order_id": "string",
      "return_status": "enum (RETURN_INITIATED, RETURN_CREATED, RETURN_DELIVERED, RETURN_PROCESSED, RETURN_CANCELLED)",
      "return_type": "string",
      "tracking_number": "string",
      "return_order_items": [
        {
          "item_details": {
            "brand_name": "string",
            "color": "string",
            "ean": "string",
            "item_code": "string",
            "name": "string",
            "size": "string"
          },
          "return_quantity": 1,
          "order_item_id": "string",
          "return_item_id": "string",
          "cancelled_return_quantity": 0
        }
      ]
    }
  ],
  "page": {
    "number": 0,
    "size": 0,
    "totalElements": 0,
    "totalPages": 0
  }
}

Apps and Automations

Return Order flow

Related content