Doc – View Order Details

API Development And
Integration Guid

View Order Details (order-detail)

Overview

This endpoint retrieves complete order information, including product SKUs, serial codes, and timestamps. It’s essential for order tracking, delivery, and audit logs.

Endpoint & Environment

https

GET {baseUrl}/api/order/detail?orderName={orderName}

Required Headers

https

x-api-key: YOUR_API_KEY  
Accept-Language: en-US

Query Parameter

Parameter	Type	Required	Description
orderName	string	Yes	A unique order identifier (e.g., A00000000000021)

Sample Response

https

{
  "data": {
    "id": 19,
    "orderName": "A00000000000002",
    "orderDate": "2023-12-28T00:00:00",
    "orderAmount": 100.00,
    "orderData": [
      {
        "rowId": 23,
        "productCode": "testProduct001",
        "productName": "Test Product",
        "serials": [
          {
            "serialNumber": "",
            "serialCode": "",
            "productId": 23,
            "productName": "Test Product",
            "productSku": "testProduct001"
          },
          {
            "serialNumber": "",
            "serialCode": "",
            "productId": 23,
            "productName": "Test Product",
            "productSku": "testProduct001"
          }
        ]
      }
    ]
  },
  "status": true
}

Response Field Breakdown

data.id: Internal system order ID
data.orderName: Public order identifier
data.orderDate: Timestamp in ISO8601 format
data.orderAmount: Total cost of the order
data.orderData[]: Array of ordered items:

Usage Recommendations

Order Fulfillment: After placing an order, call this endpoint to retrieve redemption codes.
User Notifications: Send customers their serial codes immediately upon retrieval.
Audit & Reconciliation: Track inventories, usage, and verify delivery of digital goods.
Error Recovery: Useful for recovering from partial fulfillment or connection issues by re-fetching order state.

Best Practices

Immediate Retrieval:
Use this endpoint right after pull-codes to fetch and securely store digital codes.
Handle Multiple Serials:
 Orders may include multiple SKUs or quantities; always loop through the serials array.
Retry Logic:
If status returns false, log errors and decide based on error.code and error.message.
Edge Cases:
Always query by orderName, not by internal id, to ensure consistency.
Use Unique IDs:
If the order isn’t found, you’ll receive a 404 or status: false. Handle show-not-found gracefully.