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

Boxme API

Create Inbound Shipment (ASN)

POST

https://s.boxme.asia/api/v2/sellers/shipments/

Last modified:2024-08-05 07:00:59

Use API to register ASN to a Boxme warehouse network (Philippines, Thailand, Vietnam...)

Request

Header Params

Authorization

string

required

Example:

Token {{API_TOKEN}}

Content-Type

string

optional

Example:

application/json

Body Params application/json

pickup_id

string

required

Boxme's warehouse ID (to receive goods)

po_number

string

required

Purchase Order Number

package_option

string

optional

single: Single SKU/Box, multi: Mix SKU/Box

Default:

single

Examples:

singlemulti

vas

object

required

inspection

boolean

required

Require Inspection service when shipment received

Default:

false

priority_inbound

boolean

required

Inbound within 2h

Default:

false

unloading

boolean

required

Require unloading service for high truck

Default:

false

reject_damaged_goods

boolean

required

Reject damage item when shipment receive & inspection with driver

Default:

false

products

array [object {6}]

required

seller_sku

string

required

Seller SKU

quantity_per_box

integer

optional

Quantity Per Carton Box. Require when package_option is single

quantity_of_box

integer

optional

Total box quantity. Require when package_option is single

quantity

integer

required

Total quantity

line_no

string

optional

Line number of ERP

auto_merge

boolean

optional

Auto convert pcs to box. Apply for special client.

Default:

false

inspection_note

string

optional

Inspection Note for inspector

note

string

required

Note for receiver

estimate_arrived_time

integer

required

Estimate arrival Time (Timestamp)

documents

array[string]

optional

Document support for ASN

pickup_service

boolean

optional

Boxme will arrange pickup service, When

Default:

false

pickup_from

object

optional

It's mandatory if you want Boxme to arrange for pickup

customer_code

string

optional

Customer Code, refer to customer list

default_address

boolean

optional

Default delivery address of customer

Example

{
  "pickup_id": 7347389,
  "po_number": "PO000001",
  "package_option": "single",
  "vas": {
    "inspection": true,
    "priority_inbound": false,
    "unloading": false,
    "reject_damaged_goods": true
  },
  "products": [
    {
      "seller_sku": "DLGLASS0001",
      "quantity_per_box": 12,
      "quantity": 1200,
      "line_no": "10000",
      "auto_merge": false
    },
    {
      "seller_sku": "TEST-0002",
      "quantity_per_box": 6,
      "quantity": 60,
      "line_no": "10000",
      "auto_merge": false
    }
  ],
  "inspection_note": "",
  "note": "Ghi chú",
  "estimate_arrived_time": "21/12/2023",
  "documents": [
    "https://storage.googleapis.com/boxme/warehouse/2023/12/hfEzUM_202312.jpg"
  ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://s.boxme.asia/api/v2/sellers/shipments/' \
--header 'Authorization: Token {{API_TOKEN}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "pickup_id":7347389,
    "po_number": "PO000001",
    "package_option": "single",
    "vas": {
        "inspection": true,
        "priority_inbound": false,
        "unloading": false,
        "reject_damaged_goods": true
    },
    "products": [
        {
            "seller_sku": "DLGLASS0001",
            "quantity_per_box": 12,
            "quantity": 1200,
            "line_no": "10000",
            "auto_merge":false
        },
        {
            "seller_sku": "TEST-0002",
            "quantity_per_box": 6,
            "quantity": 60,
            "line_no": "10000",
            "auto_merge":false
        }
    ],
    "inspection_note": "",
    "note": "Ghi chú",
    "estimate_arrived_time": "21/12/2023",
    "documents": [
        "https://storage.googleapis.com/boxme/warehouse/2023/12/hfEzUM_202312.jpg"
    ]
}'

Responses

🟢200Success

application/json

Body

data

object

required

shipment_code

string

required

po_number

string

required

created_time

integer

required

error

boolean

required

error_code

string

required

messages

string

required

request_id

string

required

Example

{
  "data": {
    "shipment_code": "SM-VN-331529-16537311",
    "po_number": "ASN02324221",
    "created_time": 1714637312
  },
  "error": false,
  "error_code": "",
  "messages": "",
  "request_id": "663349ff0bfeb065f4150d12"
}

🟠400Bad Request

Modified at 2024-08-05 07:00:59

Shipment (ASN)

Cancel ASN