Orders

Get Orders Shipment States

GET /commerce/orders/shipments/states

Headers

Name	Type	Description
Client-Key*	String	Your client key

200: OK

{
    "data": [
        {
            "province_id": "1",
            "province": "Bali"
        },
        {
            "province_id": "2",
            "province": "Bangka Belitung"
        },
        {
            "province_id": "3",
            "province": "Banten"
        },
        {
            "province_id": "4",
            "province": "Bengkulu"
        },
        {
            "province_id": "5",
            "province": "DI Yogyakarta"
        },
        {
            "province_id": "6",
            "province": "DKI Jakarta"
        },
        {
            "province_id": "7",
            "province": "Gorontalo"
        },
        {
            "province_id": "8",
            "province": "Jambi"
        },
        {
            "province_id": "9",
            "province": "Jawa Barat"
        },
        {
            "province_id": "10",
            "province": "Jawa Tengah"
        },
        {
            "province_id": "11",
            "province": "Jawa Timur"
        },
        {
            "province_id": "12",
            "province": "Kalimantan Barat"
        },
        {
            "province_id": "13",
            "province": "Kalimantan Selatan"
        },
        {
            "province_id": "14",
            "province": "Kalimantan Tengah"
        },
        {
            "province_id": "15",
            "province": "Kalimantan Timur"
        },
        {
            "province_id": "16",
            "province": "Kalimantan Utara"
        },
        {
            "province_id": "17",
            "province": "Kepulauan Riau"
        },
        {
            "province_id": "18",
            "province": "Lampung"
        },
        {
            "province_id": "19",
            "province": "Maluku"
        },
        {
            "province_id": "20",
            "province": "Maluku Utara"
        },
        {
            "province_id": "21",
            "province": "Nanggroe Aceh Darussalam (NAD)"
        },
        {
            "province_id": "22",
            "province": "Nusa Tenggara Barat (NTB)"
        },
        {
            "province_id": "23",
            "province": "Nusa Tenggara Timur (NTT)"
        },
        {
            "province_id": "24",
            "province": "Papua"
        },
        {
            "province_id": "25",
            "province": "Papua Barat"
        },
        {
            "province_id": "26",
            "province": "Riau"
        },
        {
            "province_id": "27",
            "province": "Sulawesi Barat"
        },
        {
            "province_id": "28",
            "province": "Sulawesi Selatan"
        },
        {
            "province_id": "29",
            "province": "Sulawesi Tengah"
        },
        {
            "province_id": "30",
            "province": "Sulawesi Tenggara"
        },
        {
            "province_id": "31",
            "province": "Sulawesi Utara"
        },
        {
            "province_id": "32",
            "province": "Sumatera Barat"
        },
        {
            "province_id": "33",
            "province": "Sumatera Selatan"
        },
        {
            "province_id": "34",
            "province": "Sumatera Utara"
        }
    ]
}

Get Orders Shipment State Detail

GET /commerce/orders/shipments/states/{id}

Path Parameters

Name	Type	Description
id*	Integer	Id of the state

Headers

Name	Type	Description
Client-Key*	String	Your client key

200: OK

{
    "data": {
        "province_id": "2",
        "province": "Bangka Belitung"
    }
}

Get Orders Shipment Districts

GET /commerce/orders/shipments/districts

Query Parameters

Name	Type	Description
state*	Integer	Id of the state

Headers

Name	Type	Description
Client-Key*	String	Your client key

200: OK

{
    "data": [
        {
            "city_id": "31",
            "province_id": "11",
            "province": "Jawa Timur",
            "type": "Kabupaten",
            "city_name": "Bangkalan",
            "postal_code": "69118"
        }
    ]
}

Get Orders Shipment District Detail

GET /commerce/orders/shipments/districts/{id}

Path Parameters

Name	Type	Description
id*	Integer	Id of the disctrict

Headers

Name	Type	Description
Client-Key*	String	Your client key

200: OK

{
    "data": {
        "city_id": "10",
        "province_id": "21",
        "province": "Nanggroe Aceh Darussalam (NAD)",
        "type": "Kabupaten",
        "city_name": "Aceh Timur",
        "postal_code": "24454"
    }
}

Get Orders Shipment Subdistricts

GET /commerce/orders/shipments/subdistricts

Query Parameters

Name	Type	Description
district	Integer	The ID of the district

Headers

Name	Type	Description
Client-Key*	String	Your client key

200: OK

{
    "data": [
        {
            "subdistrict_id": "454",
            "province_id": "11",
            "province": "Jawa Timur",
            "city_id": "31",
            "city": "Bangkalan",
            "type": "Kabupaten",
            "subdistrict_name": "Arosbaya"
        }
    ]
}

Get Orders Shipment Subdistrict Detail

GET /commerce/orders/shipments/subdistricts/{id}

Path Parameters

Name	Type	Description
id*	Integer	Id of the subdisctrict

Headers

Name	Type	Description
Client-Key*	String	Your client key

200: OK

{
    "data": {
        "subdistrict_id": "454",
        "province_id": "11",
        "province": "Jawa Timur",
        "city_id": "31",
        "city": "Bangkalan",
        "type": "Kabupaten",
        "subdistrict_name": "Arosbaya"
    }
}

Check Orders Shipment Costs

POST /commerce/orders/shipments/costs

Headers

Name	Type	Description
Client-Key*	String	Your client key

Request Body

Name	Type	Description
products*	Objects
shipping_destination_id*	Integer	Id of subdistrict

200: OK

{
    "data": [
        {
            "code": "jne",
            "name": "Jalur Nugraha Ekakurir (JNE)",
            "costs": [
                {
                    "service": "OKE",
                    "description": "Ongkos Kirim Ekonomis",
                    "cost": [
                        {
                            "value": 11000,
                            "etd": "4-6",
                            "note": ""
                        }
                    ]
                },
                {
                    "service": "REG",
                    "description": "Layanan Reguler",
                    "cost": [
                        {
                            "value": 12000,
                            "etd": "3-4",
                            "note": ""
                        }
                    ]
                }
            ]
        },
        {
            "code": "pos",
            "name": "POS Indonesia (POS)",
            "costs": [
                {
                    "service": "Pos Reguler",
                    "description": "Pos Reguler",
                    "cost": [
                        {
                            "value": 8000,
                            "etd": "3 HARI",
                            "note": ""
                        }
                    ]
                },
                {
                    "service": "Pos Nextday",
                    "description": "Pos Nextday",
                    "cost": [
                        {
                            "value": 11500,
                            "etd": "1 HARI",
                            "note": ""
                        }
                    ]
                }
            ]
        },
        {
            "code": "tiki",
            "name": "Citra Van Titipan Kilat (TIKI)",
            "costs": [
                {
                    "service": "ECO",
                    "description": "Economy Service",
                    "cost": [
                        {
                            "value": 11000,
                            "etd": "5",
                            "note": ""
                        }
                    ]
                },
                {
                    "service": "REG",
                    "description": "Regular Service",
                    "cost": [
                        {
                            "value": 14000,
                            "etd": "3",
                            "note": ""
                        }
                    ]
                }
            ]
        },
        {
            "code": "sicepat",
            "name": "SiCepat Express",
            "costs": [
                {
                    "service": "REG",
                    "description": "Layanan Reguler",
                    "cost": [
                        {
                            "value": 10500,
                            "etd": "4-6",
                            "note": ""
                        }
                    ]
                },
                {
                    "service": "SIUNT",
                    "description": "SiUntung",
                    "cost": [
                        {
                            "value": 11000,
                            "etd": "4-6",
                            "note": ""
                        }
                    ]
                },
                {
                    "service": "GOKIL",
                    "description": "Cargo (Minimal 10kg)",
                    "cost": [
                        {
                            "value": 45000,
                            "etd": "4-7",
                            "note": ""
                        }
                    ]
                }
            ]
        },
        {
            "code": "J&T",
            "name": "J&T Express",
            "costs": [
                {
                    "service": "EZ",
                    "description": "Regular Service",
                    "cost": [
                        {
                            "value": 14000,
                            "etd": "",
                            "note": ""
                        }
                    ]
                }
            ]
        },
        {
            "code": "pahala",
            "name": "Pahala Kencana Express",
            "costs": []
        }
    ]
}

Example Request Body Orders Shipment Costs

{
    "products": [
        {
            "product_id": 4651,
            "quantity": 1
        },
        {
            "product_id": 4654,
            "quantity": 1
        } 
    ],
    "shipping_destination_id": 457
}

Orders

POST /commerce/orders

Headers

Name	Type	Description
Client-Key*	String	Your client key

Request Body

Name	Type	Description
name	String
email	String
phone	String
address	String
country	String
state	String
district	String
subdistrict	String
postcode	String
items	Array

200: OK

{
    "data": {
        "id": "2f596686-270d-4cd4-8fd4-e048e9736b7d",
        "name": "Andy Eka Saputra",
        "email": "[email protected]",
        "phone": "6281944835558",
        "address": "Khayangan Residence F1-28",
        "country": "ID",
        "state": "Jawa Timur",
        "district": "Bangkalan",
        "subdistrict": "Burneh",
        "postcode": "69118",
        "shipping_courier": "jne:OKE",
        "subtotal": "100000.00",
        "discount": 0,
        "shipping_cost": "11000.00",
        "tax": 0,
        "transaction_fee": 7500,
        "is_transaction_fee_covered": false,
        "total": 118500,
        "status": "pending",
        "link_payment": "https://checkout-staging.xendit.co/v2/656e818e00467dfd8a88431c",
        "expired_at": "2023-12-05T01:51:03.000000Z",
        "created_at": "2023-12-05T01:48:58.000000Z",
        "updated_at": "2023-12-05T01:49:03.000000Z"
    }
}

Example Request Body Order

{
    "name": "Andy Eka Saputra",
    "email": "[email protected]",
    "phone": "6281944835558",
    "address": "Khayangan Residence F1-28",
    "country": "ID",
    "state": "Jawa Timur",
    "district": "Bangkalan",
    "subdistrict": "Burneh",
    "postcode": "69118",
    "items": [
        {
            "product_id": 4651,
            "quantity": 1
        },
        {
            "product_id": 4654,
            "quantity": 1
        }
    ],
    "shipping_destination_id": 457,
    "shipping_courier": "jne:OKE",
    "payment_method_id": 1
}

Get Order Detail

GET /commerce/orders/{uuid}

Path Parameters

Name	Type	Description
uuid*	Integer	id of the order

Query Parameters

Name	Type	Description
include	String	options: shippings, items can be both

Headers

Name	Type	Description
Client-Key*	String	Your client key

200: OK

{
    "data": {
        "id": "2f596686-270d-4cd4-8fd4-e048e9736b7d",
        "name": "Andy Eka Saputra",
        "email": "[email protected]",
        "phone": "6281944835558",
        "address": "Khayangan Residence F1-28",
        "country": "ID",
        "state": "Jawa Timur",
        "district": "Bangkalan",
        "subdistrict": "Burneh",
        "postcode": "69118",
        "shipping_courier": "jne:OKE",
        "subtotal": "100000.00",
        "discount": "0.00",
        "shipping_cost": "11000.00",
        "tax": "0.00",
        "transaction_fee": "7500.00",
        "is_transaction_fee_covered": 0,
        "total": "118500.00",
        "status": "pending",
        "link_payment": "https://checkout-staging.xendit.co/v2/656e818e00467dfd8a88431c",
        "expired_at": "2023-12-05 08:51:03",
        "created_at": "2023-12-05T01:48:58.000000Z",
        "updated_at": "2023-12-05T01:49:03.000000Z",
        "shippings": {
            "data": [
                {
                    "id": "b6e135f5-f9b4-474b-86b2-b583933a0bad",
                    "origin": "Mulyorejo, Surabaya, Jawa Timur",
                    "destination": "Burneh, Bangkalan, Jawa Timur",
                    "weight": 1000,
                    "length": 0,
                    "width": 0,
                    "height": 0,
                    "price": "11000.00",
                    "discount": "0.00",
                    "total": "11000.00",
                    "created_at": "2023-12-05T01:48:58.000000Z",
                    "updated_at": "2023-12-05T01:48:59.000000Z"
                }
            ]
        },
        "items": {
            "data": [
                {
                    "id": "378e32dc-ab42-4352-9949-0432151c2801",
                    "product_name": "baju suci",
                    "weight": "500.00",
                    "length": "0.00",
                    "width": "0.00",
                    "height": "0.00",
                    "price": "10000.00",
                    "discount": "0.00",
                    "quantity": 1,
                    "total": "10000.00",
                    "created_at": "2023-12-05T01:48:58.000000Z",
                    "updated_at": "2023-12-05T01:48:58.000000Z"
                },
                {
                    "id": "5c0867b6-1e43-4e78-9e93-777eff69d05e",
                    "product_name": "baju hitam sangar",
                    "weight": "500.00",
                    "length": "0.00",
                    "width": "0.00",
                    "height": "0.00",
                    "price": "90000.00",
                    "discount": "0.00",
                    "quantity": 1,
                    "total": "90000.00",
                    "created_at": "2023-12-05T01:48:58.000000Z",
                    "updated_at": "2023-12-05T01:48:58.000000Z"
                }
            ]
        }
    }
}