Skip to main content

​
Get Order Digital Codes (JSON)

GET /api/v1/orders/{order}/get-codes Returns digital codes for the order in JSON format.

​
Path Parameters

ParameterTypeRequiredDescription
orderstring (ULID)✅The ulid in order

​
Example Response

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

​
Responses

StatusDescription
200 OKSuccessful operation
401 UnauthorizedMissing or invalid authentication token
403 ForbiddenAccess denied
404 Not FoundOrder not found or no codes available

​
200 — Digital Codes

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