Get Order Codes

Returns digital codes for the order in JSON format

Get Order Digital Codes (JSON)

GET /api/v1/orders/{order}/get-codes

Returns digital codes for the order in JSON format.

Path Parameters

Parameter	Type	Required	Description
order	string (ULID)	✅	The ulid in order

Example Response

{
  "error": false,
  "message": "Codes retrieved successfully",
  "data": [
    {
      "product_name": "Product Name",
      "status": "completed",
      "codes": [
        {
          "code": "XXXX-XXXX-XXXX-XXXX",
          "serial_number": "SN123456789",
          "pin_code": "1234",
          "expiration_date": "2026-01-30 00:00:00"
        }
      ]      
    }
  ]
}

Each product includes a status field indicating its fulfillment state: completed or pending.

Responses

Status	Description
200 OK	Successful operation
401 Unauthorized	Missing or invalid authentication token
403 Forbidden	Access denied, or the order hasn’t reached a status that has codes yet
404 Not Found	Order not found, or codes for it aren’t available yet (retry later)

A 404 here doesn’t necessarily mean something is wrong with the order; fulfillment can still be in progress. Check the order’s fulfillment_status via Get Order before treating it as an error.

404 — Codes Not Available Yet

{
  "error": true,
  "message": "Discount code is not available",
  "data": []
}

200 — Digital Codes

{
  "error": false,
  "message": "Codes retrieved successfully",
  "data": [
    {
      "product_name": "Product Name",
      "status": "completed",
      "codes": [
        {
          "code": "XXXX-XXXX-XXXX-XXXX",
          "serial_number": "SN123456789",
          "pin_code": "1234",
          "expiration_date": "2026-01-30 00:00:00"
        }
      ]
    }
  ]
}