We announce the release of a new API version aimed at providing convenience for our partners using the service.
- Overview
- Getting Started
- Authentication
- Q&A
- Common Errors
- API Call Flow
- Instant Order Flow
- Boxme's RTO and RPO
- Changelog
- API References
- Location
- Pickup
- Product
- Shipment (ASN)
- Customer
- Orders
- Order API Overview
- Error Codes
- Get Shipping Option (Fulfillment)
- Get Shipping Option (Dropship)
- Create B2C Order
- Create Delivery Order
- Create B2B Order
- Update Document
- Request Cancel Delivery Order
- Cancel Order
- Get Order Detail
- Get Order List
- Get Courier List
- Get Courier Service
- Get Packed Items
- Order Pack
- Get B2B Pickup TimeSlot
- Returns
- Finance
- Location
- Webhooks
- Guidelines
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
contact_name
string
required
contact_phone
string
required
province_id
integer
required
district_id
integer
required
sub_district_id
integer
required
zipcode
null
required
address
string
required
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
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
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