Get Returns Order - Boxme API

Request

Query Params

return_tracking_number

string

optional

created_from

string

optional

created_to

string

optional

page_size

string

required

Example:

25,50

page

string

optional

Header Params

Authorization

string

required

Example:

Token {{API_TOKEN}}

Content-Type

string

optional

Example:

application/json

Body Params application/json

object {0}

Example

{}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET 'https://s.boxme.asia/api/v2/orders/rma/list/?return_tracking_number&created_from&created_to&page_size=25,50&page' \
--header 'Authorization: Token {{API_TOKEN}}' \
--header 'Content-Type: application/json' \
--data-raw '{}'

Responses

🟢200Success

application/json

Body

data

object

required

total_count

integer

required

orders

array [object {15}]

required

error

boolean

required

error_code

string

required

messages

string

required

request_id

integer

required

Example

{
    "data": {
        "total_count": 1,
        "orders": [
            {
                "country": "VN",
                "order_id": 6838349,
                "return_tracking_number": "BM881647999599RT",
                "origin_tracking_number": "BM881647999599",
                "order_number": "po_order_code",
                "items": [
                    {
                        "seller_sku": "HOP_BOXME_01",
                        "product_name": "Hộp Boxme 001",
                        "return_note": null,
                        "quantity": 1,
                        "accept_quantity": 0,
                        "damage_quantity": 0,
                        "lost_quantity": 0,
                        "destroy_quantity": 0
                    }
                ],
                "courier_name": "Boxme Express",
                "courier_tracking_code": "BM881647999599",
                "order_status": 2,
                "order_status_name": "Received",
                "item_status": 1,
                "item_status_name": "Waiting inspection",
                "return_note": "",
                "proof": [
                    "https://photo.com"
                ],
                "received_time": 1650451640,
                "complete_time": 0,
                "created_time": 1650451641
            }
        ]
    },
    "error": false,
    "error_code": "",
    "messages": "",
    "request_id": 1703650371
}