Doc – Response Fields Explained

API Development And
Integration Guid

Response Fields Explained

A. Place Order (pull-codes – POST /api/order/pull-codes)

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

json

{
  "data": {
    "orderName": "A00000000000123",
    "totalAmount": 35.00,
    "serials": [
      { "sku": "GOOGLE-USA-10USD", "serialCode": "ABCD-EFGH-IJKL", "serialNumber": "1234-5678" },
      { "sku": "GOOGLE-USA-10USD", "serialCode": "MNOP-QRST-UVWX", "serialNumber": "9876-5432" },
      { "sku": "APPLE-USA-15USD", "serialCode": "YYYY-ZZZZ-AAAA", "serialNumber": "0000-1111" }
    ]
  },
  "status": true
}

Field Breakdown:

B. Order History (order-list – POST /api/order/list)

json

{
  "pageInfo": {
    "totalPage": 1,
    "totalCount": 1,
    "pageSize": 20,
    "currentPage": 1
  },
  "data": [
    {
      "id": 19,
      "orderName": "A00000000000002",
      "orderDate": "2023-12-28T00:00:00",
      "orderAmount": 100.00
    }
  ],
  "status": true
}

Field Breakdown:

C. Order Details (order-detail – GET /api/order/detail?orderName=…)

json

{
  "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,
            "productSku": "testProduct001"
          }
        ]
      }
    ]
  },
  "status": true
}

Field Breakdown:

data.id – Internal order ID.
data.orderName – Public order identifier (matches pull-codes result).
data.orderDate – Timestamp for the order.
data.orderAmount – Total value of the order.
data.orderData[] – List of items within the order

Best Practices

Order Retrieval Flow: After pull-codes, use order-detail to fetch redemption codes and store them securely.
Batch Handling: Each item in an order corresponds to one entry in serials[]; handle accordingly in your application.
Audit & Support: Compare orderDate, orderAmount, and serials with your logs to verify integrity and resolve disputes.
Pagination: Use order-list to keep track of order history, then drill down into details with order-detail.