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

Boxme API

Create Delivery Order

POST

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

Last modified:2025-04-21 11:16:09

Use for create delivery order (non-fulfillment)

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

optional

customer_code

string

optional

Customer code/Store code refer to Customer list

default_address

boolean

optional

Use customer's default address

Default:

true

ship_to

object

required

country

string

required

customer_code

string

optional

To customer code/Store code refer to Customer list

default_address

boolean

optional

Use customer's default address

contact_name

string

required

phone

string

required

province

integer

required

district

integer

required

subdistrict

integer

required

zipcode

string

required

address

string

required

shipments

object

required

delivery_note

string

required

parcels

array [object {2}]

required

config

object

required

insurance

string

required

currency

string

required

unit_metric

string

required

sort_mode

string

required

auto_approve

string

required

include_distance_service

string

optional

delivery_service

string

optional

Delivery service code returnd from Get Shipping Option API

payment

object

required

cod_amount

integer

required

referral

object

required

order_number

string

required

platform

string

required

source

string

required

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": [
      {
        "dimension": {
          "width": 10,
          "height": 19,
          "length": 21
        },
        "items": [
          {
            "name": "Testing order",
            "quantity": 1,
            "price": 10000,
            "weight": 250
          }
        ]
      }
    ]
  },
  "config": {
    "insurance": false,
    "currency": "VND",
    "unit_metric": "metric",
    "sort_mode": "best_price",
    "auto_approve": true,
    "include_distance_service": false
  },
  "payment": {
    "cod_amount": 24000
  },
  "referral": {
    "order_number": "SO092921232",
    "platform": "shopee",
    "source": "Primer RMS"
  }
}

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/ship/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": [
      {
        "dimension": {
          "width": 10,
          "height": 19,
          "length": 21
        },
        "items": [
          {
            "name": "Testing order",
            "quantity": 1,
            "price": 10000,
            "weight": 250
          }
        ]
      }
    ]
  },
  "config": {
    "insurance": false,
    "currency": "VND",
    "unit_metric": "metric",
    "sort_mode": "best_price",
    "auto_approve": true,
    "include_distance_service": false
  },
  "payment": {
    "cod_amount": 24000
  },
  "referral": {
    "order_number": "SO092921232",
    "platform": "shopee",
    "source": "Primer RMS"
  }
}'

Responses

🟢200Success

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

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_SD",
        "service_name": "Standard",
        "cod_value": 24000
    },
    "error": false,
    "error_code": "",
    "messages": "Create order successfully.",
    "request_id": 1703485822
}

Modified at 2025-04-21 11:16:09

Create B2C Order

Create B2B Order