Get Order Detail - Boxme API

Request

Path Params

tracking_number

string

required

Boxme tracking number

Example:

BM65221104356

Header Params

Authorization

string

required

Example:

Token {{API_TOKEN}}

Content-Type

string

optional

Example:

application/json

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/BM65221104356/' \
--header 'Authorization: Token {{API_TOKEN}}' \
--header 'Content-Type: application/json'

Responses

🟢200OK

application/json

Body

data

object

required

country

string

required

tracking_number

string

required

order_number

string

required

courier_tracking_code

string

required

pickup_id

integer

required

Refer to pickup list

order_type

string

required

receiver

object

required

config

object

required

items

array [object {10}]

required

courier_id

integer

required

service_code

string

required

order_value

integer

required

Order value

cod_amount

integer

required

CoD amount

currency

string

required

status

integer

required

status_name

string

required

created_time

integer

required

approved_time

integer

required

sla_to_pack

integer

required

SLA to pack for priority order

sla_to_ship

integer

required

Handover SLA to courier (Boxme's commitment)

sla_to_fulfill

integer

required

Marketplace's Handover SLA

sla_to_delivery

integer

required

SLA to delivery based on Shipped time.

sla_to_cancel

integer

required

SLA to cancel

sla_commitment

boolean

required

Commit SLA to ship (Boxme's SLA) or not (true when commit the SLA else false mean not)

Default:

true

sla_commitment_note

string

optional

Note when we do not commit the SLA to ship (Boxme's SLA)

rts_time

integer

required

shipped_time

integer

required

delivery_time

integer

required

error

boolean

required

error_code

string

required

messages

string

required

request_id

string

required

Example

{
  "data": {
    "country": "VN",
    "tracking_number": "BM65333307514",
    "order_number": "",
    "courier_tracking_code": "BM65333307514",
    "pickup_id": 409223,
    "order_type": "b2c",
    "receiver": {
      "country": "VN",
      "fullname": "Thịnh NV",
      "phone": "84032999292",
      "address": "18 Tam Trinh",
      "province_id": 1,
      "province_name": "Hà Nội",
      "district_id": 250,
      "district_name": "Huyện Mê Linh",
      "sub_district_id": 8980,
      "sub_district_name": "Xã Thạch Đà",
      "zipcode": ""
    },
    "config": {
      "preview": false,
      "insurance": false,
      "is_fulfill_now": false,
      "is_co_inspection": false,
      "is_priority_fulfill": false
    },
    "items": [
      {
        "bsin": "BSN33152979336228",
        "seller_sku": "TEST-EXP-KIEN01",
        "quantity": 1,
        "weight": 10,
        "dimension": "11x12x13",
        "product_name": "TEST-EXP-KIEN01",
        "price": 85000,
        "discounted_price": 83000,
        "insurance_price": 71440,
        "line_no": "",
        "updated_time": 0
      }
    ],
    "courier_id": 52,
    "service_code": "BM_DBS",
    "order_value": 20000,
    "cod_amount": 0,
    "currency": "VND",
    "status": 201,
    "status_name": "Label generated",
    "created_time": 1704965987,
    "approved_time": 1736820430,
    "sla_to_pack": 0,
    "sla_to_ship": 1736873999,
    "sla_to_fulfill": 1736993230,
    "sla_to_delivery": 0,
    "sla_to_cancel": 1737191230,
    "sla_commitment": false,
    "sla_commitment_note": "OTHER",
    "rts_time": 0,
    "shipped_time": 0,
    "delivery_time": 0
  },
  "error": false,
  "error_code": "",
  "messages": "",
  "request_id": "65a0e8af7262788ede58e571"
}