We announce the release of a new API version aimed at providing convenience for our partners using the service.

Boxme API

Create B2C Order

POST

https://s.boxme.asia/api/v2/courier/pricing/b2c/create_order

Last modified:2025-03-14 06:32:36

Create order information.
Rate limit: 2rps/IP

Request

Header Params

Authorization

string

optional

Example:

Token {{API_TOKEN}}

Content-Type

string

optional

Example:

application/json

Body Params application/json

ship_from

object

required

country

string

required

pickup_id

integer

required

ship_to

object

required

address

string

required

subdistrict

integer

required

contact_name

string

required

country

string

required

district

integer

required

phone

string

required

province

integer

required

zipcode

string

required

shipments

object

required

delivery_note

string

required

parcels

array [object {1}]

required

config

object

required

insurance

boolean

required

currency

string

required

unit_metric

string

required

sort_mode

string

required

auto_approve

boolean

required

Set default to N in case delivery by your self or marketplace

order_type

string

required

include_distance_service

boolean

required

delivery_service

string

optional

Delivery service code, set default to BM_DBS in case delivery by your self or marketplace

check_stock

boolean

required

Default:

true

payment

object

required

cod_amount

number

required

For TH market courier only support integer. If you send as decimal we will automatically round up them.

referral

object

required

order_number

string

required

Order number from your system

store_id

string

optional

Marketplace Store Code/ID

store_order_id

string

optional

Order number from sales channel

platform

string

required

Your platform/system name

source

enum<string>

required

Sale channel

Allowed values:

shopeelazadatiktoktikiwebother

fulfillment_vas

object

optional

fulfill_now

boolean

optional

priority_fulfill

boolean

optional

Example

{
  "ship_from": {
    "country": "VN",
    "pickup_id": 409223
  },
  "ship_to": {
    "address": "18 Tam Trinh",
    "subdistrict": 8980,
    "contact_name": "Thịnh NV",
    "country": "VN",
    "district": 250,
    "phone": "84032999292",
    "province": 1,
    "zipcode": ""
  },
  "shipments": {
    "delivery_note": "",
    "parcels": [
      {
        "items": [
          {
            "quantity": 1,
            "seller_sku": "TEST-0004"
          },
          {
            "quantity": 1,
            "seller_sku": "TEST-0005"
          }
        ]
      }
    ]
  },
  "config": {
    "insurance": false,
    "currency": "VND",
    "unit_metric": "metric",
    "sort_mode": "best_price",
    "auto_approve": true,
    "order_type": "b2c",
    "include_distance_service": false
  },
  "payment": {
    "cod_amount": 24000
  },
  "referral": {
    "order_number": "SO092921232",
    "platform": "shopee",
    "source": "Primer RMS"
  },
  "fulfillment_vas": {
    "fulfill_now": false,
    "priority_fulfill": false
  }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://s.boxme.asia/api/v2/courier/pricing/b2c/create_order' \
--header 'Authorization: Token {{API_TOKEN}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "ship_from": {
        "country": "VN",
        "pickup_id": 409223
    },
    "ship_to": {
        "address": "18 Tam Trinh",
        "subdistrict": 8980,
        "contact_name": "Thịnh NV",
        "country": "VN",
        "district": 250,
        "phone": "84032999292",
        "province": 1,
        "zipcode": ""
    },
    "shipments": {
        "delivery_note": "",
        "parcels": [
            {
                "items": [
                    {
                        "quantity": 1,
                        "seller_sku": "TEST-0004"
                    },
                    {
                       
                        "quantity": 1,
                        "seller_sku": "TEST-0005"
                    }
                ]
            }
        ]
    },
    "config": {
        "insurance": false,
        "currency": "VND",
        "unit_metric": "metric",
        "sort_mode": "best_price",
        "auto_approve": true,
        "order_type": "b2c",
        "include_distance_service": false
    },
    "payment": {
        "cod_amount": 24000
    },
    "referral": {
        "order_number": "SO092921232",
        "platform": "shopee",
        "source" : "Primer RMS"
    },
    "fulfillment_vas": {
        "fulfill_now": false,
        "priority_fulfill": false
    }
}'

Responses

🟢200OK

application/json

Body

data

object

required

label_url

string

required

tracking_number

string

required

courier_name

string

required

service_code

string

required

service_name

string

required

cod_value

integer

required

sorting_hub

string

required

total_fee

integer

required

fee

object

required

origin_courier

object

required

origin_service

object

required

discount

integer

required

invoice_url

string

required

error

boolean

required

error_code

string

required

messages

string

required

request_id

string

required

Example

{
  "data": {
    "label_url": "https://s.boxme.asia/api/v1/orders/awb-label/MzEwZWNmYTktYWY1Zi00OTM2LTk4M2EtYmE2MGM5YmYxN2Ez",
    "tracking_number": "BM65221104356",
    "courier_name": "Boxme Express",
    "service_code": "BM_DBS",
    "service_name": "Self-Delivery",
    "cod_value": 24000
  },
  "error": false,
  "error_code": "",
  "messages": "Create order successfully.",
  "request_id": 1703485822
}

Modified at 2025-03-14 06:32:36

Get Shipping Option (Dropship)

Create Delivery Order