Detail Order

Overview

The Detail Order Endpoint is designed to retrieve detailed information about a specific order, allowing users to access real-time data on their order status, shipping details, and payment information. This endpoint enhances transparency by ensuring users have a clear view of their orders at any given time.

By using this endpoint, users can efficiently track their order progress, verify order details, and resolve any discrepancies before the shipping process is affected.

Key Feature

✅ Real-time Order Tracking → Users can instantly check their order status and monitor its progress.
✅ Enhanced Transparency → Provides full visibility into shipping, payment, and order details.
✅ Error Prevention → Users can verify order accuracy before shipping, reducing potential issues.
✅ Improved Customer Support → Customer service teams can quickly retrieve order details for assistance.
✅ Automated System Integration → Businesses can integrate this endpoint to streamline order management workflows.

How it Works

1. Initiate Request: The user sends a GET request to the endpoint, providing the unique Order ID as a parameter.
2. Data Retrieval: The system searches its database for the corresponding Order ID. If found, it compiles all relevant order information.
3. Response Delivery: The system returns a structured response containing detailed information, including:
   • Order Information: Order ID, status, creation and last update timestamps.
   • Shipping Details: Courier name, shipping method, cost, and estimated delivery time.
   • Origin and Destination: Addresses, region IDs, and city names for both sender and recipient.
   • Recipient Information: Name, phone number, and full address of the recipient.
   • Payment Details: Payment status, method, and total amount paid.

Use Cases for Detail Order EndPoint

1. Order Tracking : Users can check whether their order is still being processed, has been packed, or is already shipped.
2. Address Verification : If a user notices incorrect destination details, they can update the address (if the order is still eligible for modification).
3. Shipping Cost Confirmation : Businesses can confirm whether the correct shipping fee was applied to an
4. Payment Verification : Users can check if their payment has been received successfully or if further action is needed.
5. Customer Support Assistance : Support agents can use the Order ID to retrieve all relevant order details when assisting customers with inquiries.

:::warning Important Notes

• A valid Order ID is required to retrieve order details.
• Orders cannot be modified through this endpoint—only order details can be viewed.
• Real-time updates ensure that users always receive the most up-to-date order status.
• If an order is canceled, the response will indicate the cancellation status and refund details (if applicable).

By utilizing the Detail Order Endpoint, users and businesses can efficiently monitor and manage orders, ensuring a smooth and transparent order processing experience. :::

Request Body

curl --location 'https://api-sandbox.collaborator.komerce.id/order/api/v1/orders/detail?order_no=KOMXXXXXXXXXXXXXXXXX' \
--header 'x-api-key: inputapikey'

Query Parameter

Headers

Query Parameters

:::danger For each header and parameter that has a

Response

Response Structure

Success Respons for Getting Detail Order

{
    "meta": {
        "message": "Success get order detail",
        "code": 200,
        "status": "success"
    },
    "data": {
        "order_no": "KOMXXXXXXXXXXXXXXXXX",
        "awb": "{{ awb.number }}",
        "order_status": "{{ status }}",
        "order_date": "{{ order.date }}",
        "brand_name": "{{ brand_name }}",
        "shipper_name": "{{ shipper_name }}",
        "shipper_phone": "{{ shipper_phone_number }}",
        "shipper_destination_id": {{ shipper_destination_id }},
        "shipper_address": "{{ shipper_detail_address }}",
        "receiver_name": "{{ receiver_name }}",
        "receiver_phone": "{{ receiver_phone_number }}",
        "receiver_destination_id": {{ receiver_destination_id }},
        "receiver_address": "{{ receiver_detail_address }}",
        "shipping": "{{ courier }}",
        "shipping_type": "{{ courier.service }}",
        "payment_method": "{{ payment_method }}",
        "shipping_cost": {{ Shipping_cost }},
        "shipping_cashback": {{ shipping_cashback }},
        "service_fee": {{ service_fee, 2.8% }},
        "additional_cost": {{ additional_cost }},
        "grand_total": {{ grand_total }},
        "cod_value": {{ cod_value }},
        "notes": "{{ Order_notes }}",
        "insurance_value": {{ insurance_value }},
        "origin_pin_point": "{{ longitude }}, {{ latitude }}",
        "destination_pin_point": "{{ longitude }}, {{ latitude }}",
        "booking_id": "{{ booking_id }}",
        "driver_name": "{{ driver_name }}",
        "driver_phone": "{{ driver_phone }}",
        "cancelation_reason": "{{ reason }}",
        "live_tracking_url": "{{ track_url }}",
        "commodity_code": "{{ commodity }}",
        "order_details": [
            {
                "product_name": "{{ product_name }}",
                "product_variant_name": "{{ product_variant }}",
                "product_weight": {{ product_weight }},
                "product_height": {{ product_height }},
                "product_width": {{ product_width }},
                "product_length": {{ product_length }},
                "product_price": {{ product_price }},
                "qty": {{ qty }},
                "subtotal": {{ subtotal }}
            }
        ]
    }
}

Error Respons for Getting Detail Order

{
  "meta": {
    "message": "Get Order detail failed",
    "code": 400,
    "status": "error"
  },
  "data": {
    "errors": "Data not found"
  }
}

Error Code

Tips to Avoid Error

1. Always include the Authorization header with a valid apikey.
2. Do not leave the order_no parameter empty — it’s required.
3. Use the correct endpoint and query structure.