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

Boxme API

Create Pickup Address

POST

https://s.boxme.asia/api/v2/sellers/pickup/create

Last modified:2025-04-11 16:08:20

Request

Body Params application/json

pickup_name

string

required

Pickup address name

contact_name

string

required

Contact name

contact_phone

string

required

Contact phone

province_id

integer

required

Province ID

district_id

integer

required

District ID

sub_district_id

integer

required

Subdistrict ID (used for VN and PH market)

zipcode

null

required

Zipcode (applied for TH market)

address

string

required

Details address (No 13 Road ..)

Example

{
  "pickup_name": "Test",
  "contact_name": "Mr Boxme Test",
  "contact_phone": "0987654321",
  "province_id": 2,
  "district_id": 24,
  "sub_district_id": 697,
  "zipcode": null,
  "address": "123 test"
}

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/pickup/create' \
--header 'Content-Type: application/json' \
--data-raw '{
    "pickup_name": "Test",
    "contact_name": "Mr Boxme Test",
    "contact_phone": "0987654321",
    "province_id": 2,
    "district_id": 24,
    "sub_district_id": 697,
    "zipcode": null,
    "address":"123 test"
}'

Responses

🟢200Success

application/json

Body

data

object

required

pickup_id

integer

required

country

string

required

warehouse_code

null

required

pickup_name

string

required

contact_name

string

required

contact_phone

string

required

address

string

required

province_id

integer

required

province_name

string

required

district_id

integer

required

district_name

string

required

sub_district_id

integer

required

sub_district_name

string

required

zipcode

null

required

lat

string

required

lng

string

required

active

boolean

required

created_time

integer

required

updated_time

integer

required

error

boolean

required

error_code

string

required

messages

string

required

request_id

string

required

Example

{
  "data": {
    "pickup_id": 436986,
    "country": "VN",
    "warehouse_code": null,
    "pickup_name": "Test",
    "contact_name": "Mr Boxme Test",
    "contact_phone": "0987654321",
    "address": "123 test",
    "province_id": 2,
    "province_name": "Hà Giang",
    "district_id": 24,
    "district_name": "Thành phố Hà Giang",
    "sub_district_id": 700,
    "sub_district_name": "Xã Ngọc Đường",
    "zipcode": null,
    "lat": "0.000000",
    "lng": "0.000000",
    "active": true,
    "created_time": 1744367191,
    "updated_time": 1744383511
  },
  "error": false,
  "error_code": "",
  "messages": "",
  "request_id": "67f92e1748e20ca1743e1deb"
}

🟠400Invalid input

Modified at 2025-04-11 16:08:20

Get Pickup List

Active / Deactive Pickup