POST
/
orders
/
{order_number}
/
return
curl --request POST \
  --url https://staging.api.commercengine.io/api/v1/{store_id}/storefront/orders/{order_number}/return \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "return_items": [
    {
      "product_id": "<string>",
      "sku": "<string>",
      "quantity": 123,
      "resolution": "refund",
      "return_reason": "<string>"
    }
  ],
  "shipping_address": {
    "id": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "country_code": "<string>",
    "phone": "<string>",
    "email": "<string>",
    "address_line1": "<string>",
    "address_line2": "<string>",
    "landmark": "<string>",
    "pincode": "<string>",
    "city": "<string>",
    "state": "<string>",
    "country": "<string>",
    "tax_identification_number": "123456789",
    "business_name": "<string>"
  }
}'
{
  "message": "order details",
  "success": true,
  "content": {
    "order_return": {
      "request_number": "<string>",
      "status": "<string>",
      "return_items": [
        {
          "product_id": "<string>",
          "product_name": "<string>",
          "product_image_url": "<string>",
          "sku": "<string>",
          "selling_price": 123,
          "tax_type": "<string>",
          "tax_rate": 123,
          "quantity": 123,
          "resolution": "refund",
          "return_reason": "<string>"
        }
      ],
      "subtotal": 123,
      "shipping_amount": 123,
      "total_tax": 123,
      "grand_total": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "approved_at": "2023-11-07T05:31:56Z",
      "shipped_at": "2023-11-07T05:31:56Z",
      "received_at": "2023-11-07T05:31:56Z",
      "original_order_number": "<string>",
      "original_order_delivered_at": "2023-11-07T05:31:56Z",
      "replacement_order_number": "<string>",
      "replacement_order_date": "2023-11-07T05:31:56Z",
      "replacement_order_amount": 123,
      "refund": [
        {
          "request_number": "<string>",
          "refund_amount": 123,
          "refund_date": "2023-11-07T05:31:56Z",
          "status": "pending",
          "payment_mode": "PaymentGateway",
          "payment_method": "<string>",
          "payment_reference_number": "<string>",
          "bank_account_number": "<string>",
          "bank_name": "<string>",
          "refund_remarks": "<string>"
        }
      ]
    }
  }
}

Authorizations

Authorization
string
header
required

Access token

Path Parameters

order_number
string
required

order number

Body

application/json
return_items
object[]
shipping_address
object | null

Response

200
application/json
OK
message
string
default:order details
success
boolean
content
object