Get Order Details by External Id

Get Order Details

All information regarding an order can be retrieved using this endpoint.

Authorizations : X-API-Key_Header

Get Order Details

GET /v3/order/external-id/{external_id}

Path Parameter

Parameter

Type

Description

external_id

string

Shipper External ID
example EXTID1234579

Sample Request & Response

curl --location --request GET '{{baseUrl}}/v3/order/215VKK6KQYEX2' \
--header 'X-API-Key: {{YOUR_API_KEY}}'
{
    "metadata": {
        "path": "/v3/order/external-id/EXTID1234579?%3Aexternal_id=EXTID1234579&",
        "http_status_code": 200,
        "http_status": "OK",
        "timestamp": 1622192522
    },
    "data": {
        "consignee": {
            "name": "Penerima",
            "phone_number": "62852280038095"
        },
        "consigner": {
            "name": "Pengirim",
            "phone_number": "62852280038095"
        },
        "origin": {
            "id": 4466605,
            "stop_id": 50,
            "address": "Jalan Kenangan",
            "direction": "",
            "postcode": "12940",
            "area_id": 4711,
            "area_name": "Karet Kuningan",
            "suburb_id": 482,
            "suburb_name": "Setia Budi",
            "city_id": 41,
            "city_name": "Jakarta Selatan",
            "province_id": 6,
            "province_name": "DKI Jakarta",
            "country_id": 228,
            "country_name": "INDONESIA",
            "lat": "-6.2197608",
            "lng": "106.8266873"
        },
        "destination": {
            "id": 0,
            "stop_id": 4327,
            "address": "Jalan Kenangan",
            "direction": "",
            "postcode": "12940",
            "area_id": 4711,
            "area_name": "Karet Kuningan",
            "suburb_id": 482,
            "suburb_name": "Setia Budi",
            "city_id": 41,
            "city_name": "Jakarta Selatan",
            "province_id": 6,
            "province_name": "DKI Jakarta",
            "country_id": 228,
            "country_name": "INDONESIA",
            "lat": "-6.2197608",
            "lng": "106.8266860"
        },
        "external_id": "KRN123111",
        "order_id": "215VKK6KQYEX2",
        "courier": {
            "rate_id": 4,
            "amount": 108000,
            "use_insurance": true,
            "insurance_amount": 7880,
            "cod": false,
            "min_day": 1,
            "max_day": 2
        },
        "package": {
            "weight": 1.1231,
            "length": 30,
            "width": 40,
            "height": 60,
            "volume_weight": 12,
            "package_type": 2,
            "items": [
                {
                    "id": 717898,
                    "name": "Baju Baju",
                    "price": 120000,
                    "qty": 12
                }
            ]
        },
        "proof_of_delivery":{
            "photo":"https://media.shipper.id/602202/poddelivery/215VKK6KQYEX2.jpg",
            "signature":"https://media.shipper.id/poddelivery/7742142f6d65ce36275b85cc16e5ffbd.jpg"
        },
          "time_slot_selected":{
            "start_time":"2022-07-20T15:00:00+07:00",
            "end_time":"2022-07-20T17:59:59+07:00"
          },
        "payment_type": "postpay",
        "driver": {
            "name": "",
            "phone": "",
            "vehicle_type": "",
            "vehicle_number": ""
        },
        "label_check_sum": "7742142f6d65ce36275b85cc16e5ffbd",
        "creation_date": "2021-05-28T08:16:21Z",
        "last_updated_date": "2021-05-28T08:16:33Z",
        "awb_number": "",
        "trackings": [
            {
                "shipper_status": {
                    "code": 1000,
                    "name": "Paket sedang dipersiapkan",
                    "description": "Paket sedang dipersiapkan"
                },
                "logistic_status": {
                    "code": 1,
                    "name": "Order Masuk ke sistem",
                    "description": "Data order sudah masuk ke sistem"
                },
                "created_date": "2021-05-28T08:16:21Z"
            },
            {
                "shipper_status": {
                    "code": 1000,
                    "name": "Paket sedang dipersiapkan",
                    "description": "Paket sedang dipersiapkan"
                },
                "logistic_status": {
                    "code": 1,
                    "name": "Order Masuk ke sistem",
                    "description": "Data order sudah masuk ke sistem"
                },
                "created_date": "2021-05-28T08:16:33Z"
            }
        ]
    }
}