Create Order
POST/open/1.0/shipment/orderLast modified: 3 months ago
Member can use this endpoint to create a new shipment. In addition to API, we also provide web hooks to notify you in real time whenever we have status updates to store in your database in order to reduce unnecessary API calls.
| Property | Description |
|---|---|
| shipping_service | required in: HORE,SERBU,KISS,SATSET,SULTAN,GOCAP |
| is_cod | required,boolean |
| is_fragile | required,boolean |
| cod_amount | required_if:is_cod,true,numeric,min:25.000 |
| goods_value | required,numeric |
| applied_insurance | required,boolean |
| origin_id | required,numeric |
| destination_id | required,numeric |
| reference_no | nullable,string,max:30 |
| items | required,array,min:1 |
| items.*.name | required,string,min:1 |
| items.*.weight | required,numeric,min:1 |
| items.*.quantity | required,numeric,min:1 |
| items.*.price | required,numeric,min:1 |
| dimensions | required,array |
| dimensions.length | required,numeric,min:1 |
| dimensions.width | required,numeric,min:1 |
| dimensions.height | required,numeric,min:1 |
| pickup | required,array |
| pickup.name | required,string,max:50 |
| pickup.address | required,string,max:150 |
| pickup.phone | required,string |
| pickup.zip_code | required,numeric,digits:5 |
| pickup.timeslot | required,array |
| pickup.timeslot.start_time | required,date_format:H:i |
| pickup.timeslot.end_time | nullable,date_format:H:i |
| pickup.timeslot.timezone | required,timezone |
| pickup.date | required,date_format:Y-m-d |
| receiver | required,array |
| receiver.name | required,string,max:50 |
| receiver.address | required,string,max:150 |
| receiver.phone | required,string |
| receiver.zip_code | required,numeric,digits:5 |
| shipper | required,array |
| shipper.name | required,string,max:50 |
| shipper.address | required,string,max:150 |
| shipper.phone | required, string |
| realtime | true/false *set true if you want instanly get awb from 3pl partner |
| force_oexpress | true/false *set true if you want to force service from oexpress only |
| reference_code | unique AWB *unique AWB for reference |
Response Status Code
| Status Code | Description |
|---|---|
| 201 | Create Order Success |
| 422 | Validation Error |
| 401 | API Key is Required |
| 401 | API Key is Invalid |
Request
Header Params
X-API-KEY
string
optional
Example:
{{ApiKey}}
Body Params application/json
realtime
boolean
required
force_oexpress
boolean
required
shipping_service
string
required
is_cod
boolean
required
is_fragile
boolean
required
cod_amount
integer
required
goods_value
integer
required
applied_insurance
boolean
required
origin_id
integer
required
destination_id
integer
required
dimensions
object
required
length
integer
required
width
integer
required
height
integer
required
items
array [object {4}]
required
name
string
optional
weight
integer
optional
quantity
integer
optional
price
integer
optional
pickup
object
required
date
string
required
timeslot
object
required
name
string
required
address
string
required
phone
string
required
zip_code
integer
required
receiver
object
required
name
string
required
address
string
required
phone
string
required
zip_code
integer
required
shipper
object
required
name
string
required
address
string
required
phone
string
required
Example
{
"force_oexpress": false,
"shipping_service": "SERBU",
"is_cod": true,
"is_fragile": false,
"cod_amount": 50000,
"goods_value": 30000,
"applied_insurance": false,
"origin_id": 339,
"destination_id": 2111,
"dimensions": {
"length": 1,
"width": 1,
"height": 1
},
"items": [
{
"name": "Kaos Poloss",
"weight": 1000,
"quantity": 1,
"price": 30000
}
],
"pickup": {
"date": "2024-06-22",
"timeslot": {
"start_time": "12:00",
"end_time": "14:00",
"timezone": "Asia/Jakarta"
},
"name": "Septian Maulana",
"address": "Gegerkalong hilir no 73A",
"phone": "086788123139",
"zip_code": 40153
},
"receiver": {
"name": "Septian Maulana",
"address": "Gegerkalong hilir no 73A",
"phone": "086788123139",
"zip_code": 40153
},
"shipper": {
"name": "Septian Maulana",
"address": "Gegerkalong hilir no 73A",
"phone": "086788123139"
}
}Request samples
Responses
401 - Api Key is required(401)
401 - Api Key is invalid(401)
422 - Validation Error(422)
201 - Create Order(201)
201 - Create Order with Param Realtime(201)
404 - Create Order with Param force_oexpress(418)
401 - Api Key is required
HTTP Code: 401
Content Type : JSONapplication/json
Data Schema
data
string
required
message
string
required
error_code
integer
required
Example401 - Api Key is required
{
"data": "",
"message": "Api Key is required",
"error_code": 0
}Last modified: 3 months ago