boscod OpenAPI
  1. Orders
boscod OpenAPI
  • Introduction
  • Shipping label
  • Errors
  • Changelog
  • API
    • Coverage Area
      • Provinces
      • Cities
      • Districts
      • Search Area
    • Rates
      • List Courier
      • Shipping Fee
      • Shipping Fee (SSE)
    • Orders
      • Create Order
        POST
      • Cancel Order
        POST
      • Detail Order
        GET
      • Tracking
        GET
      • Estimation Rates
        GET
  • Webhook
  1. Orders

Detail Order

Developing
GET
/v1/order/{order_no}
Retrieves detailed information about a specific order including price change history.

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Path Params
order_no
string 
required
Order number when receiving a response from the Create Order API.

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://demo.boscod.com:4004/v1/order/'

Responses

🟢200Success
application/json
Body
success
boolean 
required
data
object 
required
calculated_weight
number 
required
Calculates the volumetric weight based on (Length × Width × Height).
claim_created
string 
required
The date when the package claim request was made.
claim_done
string 
required
The date when the package claim request was processed, either approved or rejected.
claim_note
string 
required
Claim Category (can be seen in the order description)
claim_status
integer 
required
Claim Package Status (0: unclaim, 1: claim, 2: approve claim, 3: reject claim, 4:Appeal)
courier_code
string 
required
courier code
created_on
string 
required
The date when the order was created.
dana_tertahan
integer 
required
Held balance for the shipping cost of an ongoing package.
dana_tertahan_return
null 
required
Withheld balance for return shipping fee of a package that is still in the return process.
delete_reason
null 
required
Reason for order cancel.
deleted
integer 
required
Canceled Package Status.
deleted_on
null 
required
The date when the package was canceled.
error_message
string 
required
Description of order creation failure.
etd_from
string 
required
Estimated minimum time of arrival of package.
etd_thru
string 
required
Estimated maximum time of arrival of package
feecod_shipper
integer 
required
Administrative fee for COD packages.
grand_total
integer 
required
insurance
integer 
required
Package status related to insurance. (0: NonInsurance, 1: Isurance)
insurance_fee
integer 
required
insurance fee. (default 0)
insurance_value
integer 
required
The value to be insured.
item_category
integer 
required
Item Category (can be seen in the order description)
item_height
integer 
required
Item height dimension in centimeter (cm).
item_length
integer 
required
Item length dimension in centimeter (cm).
item_name
string 
required
The name of the shipped item.
item_qty
integer 
required
The number of items in a colis (package unit).
item_value
integer 
required
item value
item_weight
integer 
required
Package weight in kilograms (kg).
item_width
integer 
required
Item width dimension in centimeter (cm).
nilai_cod
integer 
required
The value of the COD package.
nilai_ongkir
integer 
required
shpping_cost
no_resi
string 
required
air waybill (AWB)
note
string 
required
Instructions for the shipped package.
order_code
string 
required
Order code can be customized. Example (BCD982319823)
order_no
string 
required
order number
order_status
integer 
required
Shipment status. (0: delivery Proses, 1: delivery completed, 2: void deilvery)
order_type
integer 
required
Order category (0: pickup, 1: dropoff) (default 0)
ordered_on
string 
required
The date when the order was submitted.
pickup_time
string 
required
Start estimasi pickup (Format: YYYY-MM-DD H:i:s)
pickupend_on
string 
required
End estimasi pickup (Format: YYYY-MM-DD H:i:s)
pod_photo
string 
required
Link to proof of delivered package.
ppncod_shipper
integer 
required
Value-added tax (VAT) on COD packages.
problem_description
null 
required
package problem description.
receiver_address
string 
required
Receiver full address.
receiver_kecamatan
string 
required
Receiver district.
receiver_kota
string 
required
Receiver city.
receiver_name
string 
required
Receiver name.
receiver_phone
string 
required
Receiver phone.
receiver_postcode
string 
required
Receiver address postcode.
receiver_propinsi
string 
required
Receiver Province.
return_received
integer 
required
Return package received status. (0: Return handed over., 1:Return received)
sender_address
string 
required
Sender full address.
sender_city
string 
required
Sender city.
sender_district
string 
required
Sender district.
sender_latitude
string 
required
Sender latitude.
sender_longitude
string 
required
Sender longitude.
sender_name
string 
required
Sender name.
sender_phone
string 
required
Sender phone.
sender_postcode
string 
required
Sender address postcode.
sender_provice
string 
required
Sender province
service_code
string 
required
Courier service code
status_cod
integer 
required
COD package status. (0: NonCOD, 1: COD)
tracking_status
integer 
required
Package status. (0: Request pickup, 1: Delivery process, 2: Delivered, 3: Return process, 4: Return delivered, 5: Problem package)
price_changes
array [object {8}] 
required
updated_date
string 
optional
order_no
string 
optional
service_code
string 
optional
actual_weight
number 
optional
calculated_weight
number 
optional
shipping_fee
integer 
optional
shipping_fee_discount
integer 
optional
info
string 
optional
Example
{
    "data": {
        "calculated_weight": 1.5,
        "claim_created": "2024-02-21 10:00:00",
        "claim_done": "2024-02-21 11:00:00",
        "claim_note": "Item hilang",
        "claim_status": 1,
        "courier_code": "jne",
        "courier_id": 3,
        "created_on": "2024-02-21 09:00:00",
        "dana_tertahan": 0,
        "dana_tertahan_return": null,
        "delete_reason": null,
        "deleted": 0,
        "deleted_on": null,
        "error_message": "",
        "etd_from": "2024-02-22",
        "etd_thru": "2024-02-23",
        "feecod_shipper": 5000,
        "grand_total": 25000,
        "group_id": 123,
        "insurance": 1,
        "insurance_fee": 2500,
        "insurance_type": 1,
        "insurance_value": 100000,
        "item_category": 1,
        "item_height": 10,
        "item_length": 20,
        "item_name": "Shoes",
        "item_qty": 1,
        "item_value": 100000,
        "item_weight": 1,
        "item_width": 15,
        "job_status": 1,
        "nilai_cod": 125000,
        "nilai_ongkir": 20000,
        "no_resi": "JNE1234567890",
        "note": "Handle with care",
        "ongkir_disc": 0,
        "order_code": "ORD123",
        "order_no": "12345",
        "order_status": 1,
        "order_type": 0,
        "ordered_on": "2024-02-21 09:00:00",
        "pickup_date": "2024-02-21",
        "pickup_status": 1,
        "pickup_time": "2024-02-21 14:00:00",
        "pickupend_on": "2024-02-21 17:00:00",
        "pod_photo": "https://example.com/pod/123.jpg",
        "ppncod_shipper": 500,
        "problem_description": null,
        "problem_note": null,
        "receiver_addr_code": "RCV123",
        "receiver_addr_id": 456,
        "receiver_address": "Jl. Receiver No. 123",
        "receiver_kecamatan": "Menteng",
        "receiver_kota": "Jakarta Pusat",
        "receiver_name": "John Doe",
        "receiver_phone": "081234567890",
        "receiver_postcode": "10310",
        "receiver_propinsi": "DKI Jakarta",
        "return_received": 0,
        "return_received_on": null,
        "return_type": 0,
        "sender_addr_code": "SND123",
        "sender_address": "Jl. Sender No. 456",
        "sender_city": "Jakarta Selatan",
        "sender_district": "Kebayoran Baru",
        "sender_latitude": "-6.2088",
        "sender_longitude": "106.8456",
        "sender_name": "Jane Smith",
        "sender_phone": "087654321098",
        "sender_postcode": "12170",
        "sender_provice": "DKI Jakarta",
        "service_code": "REG",
        "sorting_code": "SRT123",
        "status": 1,
        "status_cod": 1,
        "status_problem": 0,
        "tracking_problem": null,
        "tracking_status": 1,
        "updated_on": "2024-02-21 09:30:00",
        "wa_verify": 1
    },
    "price_changes": [
        {
            "updated_date": "2024-02-21 09:30:00",
            "order_no": "12345",
            "service_code": "REG",
            "actual_weight": 1.5,
            "calculated_weight": 1.5,
            "shipping_fee": 20000,
            "shipping_fee_discount": 18000,
            "info": "Data pengiriman awal"
        }
    ]
}
🟠404Record Not Found
Previous
Cancel Order
Next
Tracking
Built with