Create Order

Developing

POST

/v1/order

To create an order, users can place a single order or multiple orders in one request. However, multi-order creation is limited to a single courier. If more than one courier is required, it is recommended to create separate orders for each courier. The AWB will be generated after the order is submitted and will be sent via the AWB generation webhook.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

order_code

string

required

Order code can be customized. Example (BCD982319823)

sender_name

string

required

Sender name max 50 character

sender_addr_id

string

required

Sender addr district id

sender_address

string

required

Sender addr min 10 character & max 500 character

sender_phone

string

required

Sender phone max 15 character. Validation charater 62 or 08

pickup_via

string

required

Pickup category (0: motor, 1: box, 2: truck) (default 0)

order_type

string

required

Order category (0: pickup, 1: dropoff) (default 0)

items

array [object {16}]

required

receiver_name

string

required

Receiver name max 50 character

receiver_phone

string

required

Receiver phone max 15 character

receiver_address

string

required

Sender addr min 10 character & max 200 character

receiver_addr_id

string

required

Receiver addr district id

service_code

string

required

Courier service code

item_width

string | null

optional

Default 10

item_height

string | null

optional

Default 10

item_length

string | null

optional

Default 10

item_value

string

required

Product price

item_weight

string

required

Item weight min 0,5kg & max 99kg

item_qty

string | null

optional

Default 1

item_name

string

required

Item name max 200 character

item_category

string

required

Item Category (can be seen in the order description)

insurance

string | null

optional

Insurance Type (0: Non Asuransi, 1: Asuransi)

cod

string | null

optional

COD Value maks Rp.2.500.000

note

string

optional

Instructions for the shipped package.

courier_code

string

required

Courier Code

pickup_time

string

required

Start estimasi pickup (Format: YYYY-MM-DD H:i:s)

pickupend_time

string

required

End estimasi pickup (Format: YYYY-MM-DD H:i:s)

sender_latitude

string

required

Geolocation Sender

sender_longitude

string

required

Geolocation Sender

Example

{
    "order_code": "BOS1234567891011",
    "sender_name": "TokuKu",
    "sender_addr_id": "15780",
    "sender_address": "Sidoarjo deket hotel",
    "sender_phone": "08888080880",
    "pickup_via": "0",
    "order_type": "0",
    "items": [
        {
            "receiver_name": "penerima",
            "receiver_phone": "08888080888",
            "receiver_address": "jl. alamat penerima",
            "receiver_addr_id": "15780",
            "service_code": "00",
            "item_width": "10",
            "item_height": "10",
            "item_length": "10",
            "item_value": "100000",
            "item_weight": "1",
            "item_qty": "1",
            "item_name": "produk 1",
            "item_category": "3",
            "insurance": "1",
            "cod": "109444",
            "note": "Dangerous package"
        }
    ],
    "courier_code": "idx",
    "pickup_time": "2025-02-11 09:00:00",
    "pickupend_time": "2025-02-11 13:00:00",
    "sender_latitude": "-6.206199753605871",
    "sender_longitude": "106.84524792895677"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://demo.boscod.com:4004/v1/order' \
--header 'Content-Type: application/json' \
--data-raw '{
    "order_code": "BOS1234567891011",
    "sender_name": "TokuKu",
    "sender_addr_id": "15780",
    "sender_address": "Sidoarjo deket hotel",
    "sender_phone": "08888080880",
    "pickup_via": "0",
    "order_type": "0",
    "items": [
        {
            "receiver_name": "penerima",
            "receiver_phone": "08888080888",
            "receiver_address": "jl. alamat penerima",
            "receiver_addr_id": "15780",
            "service_code": "00",
            "item_width": "10",
            "item_height": "10",
            "item_length": "10",
            "item_value": "100000",
            "item_weight": "1",
            "item_qty": "1",
            "item_name": "produk 1",
            "item_category": "3",
            "insurance": "1",
            "cod": "109444",
            "note": "Dangerous package"
        }
    ],
    "courier_code": "idx",
    "pickup_time": "2025-02-11 09:00:00",
    "pickupend_time": "2025-02-11 13:00:00",
    "sender_latitude": "-6.206199753605871",
    "sender_longitude": "106.84524792895677"
}'

Responses

🟢201Created

application/json

Body

object {0}

Example

{
    "success": true,
    "message": "Data berhasil disimpan, No Resi akan segera dibuat",
    "batch_id": "{batch_id}",
    "order_numbers": [
        "1317123029679001"
    ]
}

🟠400Bad Request

🟠403Forbidden

Orders

Cancel Order