Get order by ID | TTG Developer Portal

curl -G https://stg.ttix.io/api/v3/orders/12345 \
     -H "X-TT-Platform: android" \
     -H "X-TT-Retailer: YOUR_RETAILER_ID" \
     -H "X-TT-API-Key: <apiKey>" \
     -d cartId=6aac14d3-5826-4da8-98b6-9e68c28629d6

{
  "data": {
    "id": "12345",
    "confirmationNumber": "T123456789012",
    "customerId": "c.pm2fiairy2y6a6rpbf5",
    "contact": {
      "name": "John Smith",
      "email": "john.smith@example.com",
      "phone": "+12125550123"
    },
    "items": [
      {
        "id": "12345",
        "event": {
          "id": "123",
          "name": "Hamilton"
        },
        "occurrence": {
          "id": "456",
          "startsAt": "2026-03-15T19:30:00-04:00",
          "doorsOpen": {
            "at": "2026-03-15T19:00:00-04:00",
            "description": "Doors open 30 minutes before the performance."
          },
          "notices": [
            {
              "name": "Audio-described performance",
              "description": "Live audio description for visually impaired patrons."
            }
          ]
        },
        "venue": {
          "id": "UmljaGFyZCBSb2RnZXJzIFRoZWF0cmU",
          "name": "Richard Rodgers Theatre",
          "address": {
            "line1": "226 W 46th St",
            "line2": "Suite 200",
            "city": "New York",
            "state": "NY",
            "postalCode": "10036",
            "country": "US",
            "latitude": 40.759,
            "longitude": -73.9845
          },
          "timezone": "America/New_York"
        },
        "inventoryVariant": {
          "_type": "AssignedSeat",
          "attributes": [
            {
              "name": "Limited Legroom",
              "category": "NEGATIVE",
              "description": "Seats in this row have reduced legroom due to a safety barrier."
            }
          ],
          "id": "ORCHESTRA-A-101",
          "name": "Orchestra A 101",
          "row": "A",
          "seat": "101",
          "section": "Orchestra",
          "description": "Closest to the stage",
          "entrance": "Door 4",
          "extendedDescription": "Includes a complimentary drink. **Over 18s only.**",
          "images": [
            {
              "url": "https://example.com/seat-views/orchestra-a-101-center.jpg"
            }
          ]
        },
        "priceOption": {
          "category": {
            "name": "Adult",
            "id": "4471",
            "description": "Ages 3-12"
          },
          "sellPrice": {
            "amount": 18500,
            "currency": "USD"
          },
          "id": "eyJwcm92aWRlckNvZGUiOiJGVUxMUFJJQ0UiLCJob2xkQ29kZSI6IjE1NzM5In0",
          "constraints": {
            "requiresCategory": [
              "string"
            ]
          },
          "listPrice": {
            "amount": 18500,
            "currency": "USD"
          },
          "discountPercentage": 30,
          "discountAmount": {
            "amount": 18500,
            "currency": "USD"
          },
          "fees": [
            {
              "type": "SERVICE_FEE",
              "value": {
                "amount": 18500,
                "currency": "USD"
              }
            }
          ],
          "maxQuantityPerOrder": 4,
          "promotion": {
            "id": "promo-opening-week",
            "name": "Opening Week Special",
            "description": "40% off Orchestra seats for opening week performances."
          },
          "isDefault": true
        },
        "quantity": 1,
        "delivery": {
          "method": {
            "name": "E-ticket"
          },
          "instructions": "Your e-tickets will be emailed to you before the performance."
        },
        "tickets": [
          {
            "id": "tkt-001",
            "status": "CONFIRMED",
            "assignedCustomer": {
              "firstName": "Jordan",
              "lastName": "Lee"
            },
            "barcode": {
              "value": "TKT-2026-031519-A101",
              "format": "QR",
              "imageUrl": "https://cdn.ttix.io/barcodes/tkt-001.png",
              "link": "https://winterwonderland.tapaygo.com/wallet/add-tag/%24461180642"
            }
          }
        ],
        "giftCards": [
          {
            "code": "GC123456789",
            "value": {
              "amount": 18500,
              "currency": "USD"
            },
            "balance": {
              "amount": 18500,
              "currency": "USD"
            },
            "expiresOn": "2027-10-14"
          }
        ]
      }
    ],
    "receiptLines": [
      {
        "label": "Subtotal",
        "total": {
          "amount": 18500,
          "currency": "USD"
        },
        "sign": "positive",
        "_type": "SubtotalLine"
      }
    ],
    "total": {
      "amount": 18500,
      "currency": "USD"
    },
    "status": "COMPLETED",
    "createdAt": "2026-03-10T14:32:00Z",
    "delivery": {
      "instructions": "Your e-tickets will be emailed to you before the performance."
    },
    "protection": {
      "id": "prot_001",
      "pricePerItem": {
        "amount": 18500,
        "currency": "USD"
      },
      "total": {
        "amount": 18500,
        "currency": "USD"
      },
      "status": "ELIGIBLE"
    },
    "totalTaxes": {
      "amount": 18500,
      "currency": "USD"
    },
    "cancellationVoucher": {
      "code": "PWYHYCRSGZAXKPE",
      "value": {
        "amount": 18500,
        "currency": "USD"
      },
      "type": "CANCELLATION",
      "isExpired": false,
      "balance": {
        "amount": 18500,
        "currency": "USD"
      },
      "expiresOn": "2027-04-20"
    }
  }
}

Retrieve an order by its unique identifier. When cartId is provided as a query parameter, the order is returned without customer authentication. Use an API key for the retailer where the order was placed.

To find out whether an order whose payment is still settling or did not complete went through, use GET /orders?cartId=, which reports it as PROCESSING or FAILED.

Authentication

X-TT-API-Keystring

API Key authentication via header

Path parameters

orderIdstringRequiredformat: "^[1-9]\d*$">=1 character

Order ID, from the order response id.

Query parameters

cartIdstringOptionalformat: "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"

The cart ID the order was placed with. It lets your API key read the order without a signed-in customer.

Response headers

X-RateLimit-Limitinteger

How many requests this API key may make for this retailer in the current window. Sent only when the request was counted against that limit. A response served from cache was not counted and repeats the value it was cached with.

X-RateLimit-Remaininginteger

How many requests this API key has left for this retailer in the current window. Sent only when the request was counted against that limit. A response served from cache was not counted and repeats the value it was cached with.

Response

Order found successfully.

dataobject

An order, with its items and tickets.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

429

Too Many Requests Error

500

Internal Server Error