Get Order Details by Order 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/{orderID}

Path Parameter

Parameter

Type

Description

order_id

string

Shipper Order ID
example 215VKK6KQYEX2

Sample Request & Response

curl --location --request GET '{{baseUrl}}/v3/order/215VKK6KQYEX2' \
--header 'X-API-Key: {{YOUR_API_KEY}}'
{
    "metadata": {
        "path": "/v3/order/215VKK6KQYEX2?%3Aorder_id=215VKK6KQYEX2&",
        "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
        },
        "price_breakdown":{
            "surcharge_fee":675000,
            "base_price":675000,
            "discount":0,
            "insurance_fee":0,
            "final_price":1350000
        },
        "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"
            }
        ]
    }
}

Response List

Parameter

Description

metadata

Metadata information

metadata.path

Api endpoint path

metadata.http_status_code

Http status code

metadata.http_status

Http status

metadata.timestamp

Timestamp

data

All important information about order detail placed on this param

data.coverage

Order creation type: domestic/international

data.order_id

Shipper Order ID. To be use for pickup request

data.payment_type

Merchant payment type: cash/postpay

data.external_id

External ID generated by user

data.label_check_sum

Label check sum of order. To use for print label

data.creation_date

Creation date of order

data.last_updated_date

Last update date of order

data.awb_number

AWB number generated by 3PL

data.is_active

Order status

data.is_hubless

Flag of order type: hubless/non-hubless

data.pickup_code

Pickup code of order

data.pickup_time

Time of picked up package by driver

courier

All important information about courier (3PL) placed on this param

courier.rate_id

RateID of courier

courier.amount

Shipment fee

courier.user_insurance

Insurance flag of the order

courier.insurance_amount

Amount of insurance

courier.cod

Cash on delivery flag of the order

consignee

All important information about consignee placed on this param

consignee.name

Consignee name (Penerima)

consignee.phone_number

Consignee phone number

consigner

All important information about consignee placed on this param

consigner.phone_number

Consigner phone number

destination

All important information about destination of the package placed on this param

destination.address

Package destination address

destination.area_id

Area ID of package destination

destination.area_name

Area name of package destination

destination.city_id

City ID of package destination

destination.city_name

City name of package destination

destination.country_id

Country ID of package destination

destination.country_name

Country name of package destination

destination.lat

Latitude of package destination

destination.lng

Longitude of package destination

destination.postcode

Postcode of package destination

destination.province_id

Province ID of package destination

destination.province_name

Province name of package destinationa

destination.suburb_id

Suburb id of package destination

destination.suburb_name

Suburb name of package destination

destination.email_address

Email address of package destination

destination.company_name

Company name of package destination

origin

All important information about origin package placed on this param

origin.address

Address of package origin

origin.area_id

Area ID of package origin

origin.area_name

Area name of package origin

origin.city_id

City ID of package origin

origin.city_name

City name of package origin

origin.country_id

Country ID of package origins

origin.country_name

Country name of package origin

origin.lat

Latitude of package origin

origin.lng

Longitude of package origin

origin.postcode

Postcode of package origin

origin.province_id

Province ID of package origin

origin.province_name

Province name of package origin

origin.suburb_id

Suburb id of package origin

origin.suburb_name

Suburb name of package origin

origin.email_address

Email address of package origin

origin.company_name

Company name of package origin

package

All important information about package placed on this param

package.package_type

Type of package: 1) document 2) small package 3) medium package

package.weight

Weight of package (kg)

package.length

Length of package (cm)

package.width

Width of package (cm)

package.height

Height of package (cm)

package.price

Price of package (IDR)

package.price.items

Array of package items

package.price.items.id

Package item ID

package.price.items.name

Package item name

package.price.items.qty

Package item quantity

package.price.items.price

Package Item price

trackings

All important information about historical order trackings placed on this param

trackings.created_date

Tracking create date

trackings.shipper_status

The tracking status mapped by Shipper (external_status). Preferably used for displaying to user.

trackings.shipper_status.code

Shipper status code

trackings.shipper_status.name

Shipper status name/title

trackings.shipper_status.description

Shipper status description

trackings.logistic_status

The tracking status mapped by 3PL (external).
Preferably used for displaying to user
because it is what shown by the courier

trackings.logistic_status.code

Logistic status code

trackings.logistic_status.name

Logistic status name/title

trackings.logistic_status.description

Logistic status description

data.driver

All important information about driver info of order placed on this param

data.driver.name

Name of driver who pickup the order

data.driver.phone

Phone of the driver

data.driver.vehicle_type

Vehicle type that used by driver for pickup the order

data.driver.vehicle_number

Vehicle number that used by driver for pickup the order

data.shipment_status

All important information about shipment status of order placed on this param

data.shipment_status.name

Shipment status name

data.shipment_status.description

Shipment status description

data.shipment_status.code

Shipment status code

data.shipment_status.updated_by

Shipment status update by

data.shipment_status.updated_date

Shipment status date

data.shipment_status.track_url

Shipment status track url

data.shipment_status.reason

Shipment status reason

data.shipment_status.created_date

Shipment status created date

data.proof_of_delivery

Proof delivery information of the order placed on this param

data.proof_of_delivery.photo

Proof of delivery photo url

data.proof_of_delivery.signature

Proof of delivery signature

time_slot_selected

Timeslot selected from pickup request placed on this param

time_slot_selected.start_time

Start time of timeslot selected

time_slot_selected.end_time

End time of timeslot selected


What’s Next