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

Create B2B Order

POST/api/v2/courier/pricing/b2b/create_order

Last modified: 6 months ago

B2B orders allow you to create a bulk of items with some special requirements that fit with your business.
Example: Specific expiry date, date range, batch/lot, condition goods.
Rate limit: 1rps/IP

Request

Header Params

Content-Type

string

optional

Example:

application/json

Authorization

string

optional

Example:

Token {{API_TOKEN}}

ship_from

object

required

country

string

required

pickup_id

integer

required

ship_to

object

required

country

string

required

Examples:

VNTHIDPHMY

customer_code

string

required

B2B Customer Code, refer to customer list (required for B2B order, you can leave blank for inventory transfer)

default_address

boolean

optional

Default delivery address of customer, does not work with inventory transfer

Default:

true

pickup_id

string

optional

Require for transfer order (TO). You can skip customer information.

contact_name

string

optional

Require if default address is false

phone

string

optional

Require if default address is false

province

integer

optional

Require if default address is false

district

integer

optional

Require if default address is false

subdistrict

integer

optional

Require if default address is false

zipcode

string

optional

Require if default address is false

address

string

optional

Require if default address is false

shipments

object

required

delivery_note

string

optional

packing_note

string

optional

<= 255 characters

parcels

array [object {1}]

required

config

object

required

insurance

boolean

required

Default:

false

currency

string

required

Examples:

VNDPHPTHBIDRMYRSGD

unit_metric

string

required

metric

Default:

metric

sort_mode

string

optional

Example:

best_price

auto_approve

string

required

order_type

string

required

Fixed b2b value

Default:

b2b

Example:

b2b

is_inventory_transfer

boolean

optional

Require for Transfer Order to Boxme Warehouse

Default:

false

include_distance_service

string

required

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

fulfillment_vas

object

required

fulfill_now

boolean

optional

Default:

false

priority_fulfill

boolean

optional

Default:

false

{
  "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": "b2b",
    "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

Responses

OK(200)

HTTP Code: 200

Content Type : JSONapplication/json

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

{
  "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,
  "total": 0
}

Last modified: 6 months ago