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 B2B Customer
POST
https://s.boxme.asia/api/v2/orders/customers/create/
Last modified:2024-04-23 07:16:26
Request
Header Params
Authorization
string
optional
Example:
Token {{API_TOKEN}}
Content-Type
string
optional
Example:
application/json
Body Params application/json
type
string
required
Default:
personal
Examples:
personalcorporateconcessionconsignmentwholesaleonlineofflineemployeesaffiliate
name
string
required
customer_code
string
required
phone
string
required
email
string
required
config
object
required
packing_note
string
required
Example:
Pack 100 pcs into one carton box
shipping_note
string
required
Example:
Call before delivery
is_invoice_waiting
boolean
required
is_co_inspection
boolean
required
door_to_door
boolean
required
queue_service
boolean
required
expected_on_day
integer
required
Example:
2
expected_on_time
string
required
Examples:
10:0018:00
delivery_address
object
required
contact_name
string
required
contact_phone
string
required
country
string
required
province_id
integer
required
district_id
integer
required
sub_district_id
integer
required
zipcode
string
required
address
string
required
Example
{
"type": "distributor",
"name": "Vinh Vux2 ",
"customer_code": "C02332",
"phone": "02321312321323",
"email": "vinh@test.com",
"config": {
"packing_note": "Please pack with bubbles",
"shipping_note": "Call to phone before delivery",
"is_co_inspection": true,
"is_invoice_waiting": true,
"door_to_door": true,
"queue_service": false,
"expected_on_day": 2,
"expected_on_time": "10-12"
},
"delivery_address": {
"contact_name": "Store 1",
"contact_phone": "09084373743",
"country": "VN",
"province_id": 2 ,
"district_id": 33,
"sub_district_id": 112,
"zipcode": "00000",
"address": "18 Tam Trinh"
}
}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/orders/customers/create/' \
--header 'Authorization: Token {{API_TOKEN}}' \
--header 'Content-Type: application/json' \
--data-raw '{
"type": "distributor",
"name": "Vinh Vux2 ",
"customer_code": "C02332",
"phone": "02321312321323",
"email": "vinh@test.com",
"config": {
"packing_note": "Please pack with bubbles",
"shipping_note": "Call to phone before delivery",
"is_co_inspection": true,
"is_invoice_waiting": true,
"door_to_door": true,
"queue_service": false,
"expected_on_day": 2,
"expected_on_time": "10-12"
},
"delivery_address": {
"contact_name": "Store 1",
"contact_phone": "09084373743",
"country": "VN",
"province_id": 2 ,
"district_id": 33,
"sub_district_id": 112,
"zipcode": "00000",
"address": "18 Tam Trinh"
}
}'Responses
🟢200Success
application/json
Body
data
object
required
customer_id
integer
required
error
boolean
required
error_code
string
required
messages
string
required
request_id
integer
required
Example
{
"data": {
"customer_id": 234434
},
"error": false,
"error_code": "",
"messages": "Create customer successfully.",
"request_id": 1703485822
}Modified at 2024-04-23 07:16:26