GET
/
orders
/
returns
curl --request GET \
  --url https://staging.api.commercengine.io/api/v1/{store_id}/storefront/orders/returns \
  --header 'Authorization: Bearer <token>'
{
  "message": "<string>",
  "success": true,
  "content": {
    "returns": [
      {
        "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

Response

200 - application/json
OK
message
string
success
boolean
content
object