> ## Documentation Index
> Fetch the complete documentation index at: https://docs.churningtracker.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List gift card orders



## OpenAPI

````yaml /api-reference/openapi.json get /gift-card-orders
openapi: 3.1.0
info:
  title: Churning Tracker API
  version: 1.0.0
  description: Read and write your buying group orders, gift card orders, and shipments.
servers:
  - url: https://app.churningtracker.com/api/v1
security:
  - apiKey: []
    apiSecret: []
tags:
  - name: Buying group orders
  - name: Gift card orders
  - name: Shipments
  - name: Credit cards
paths:
  /gift-card-orders:
    get:
      tags:
        - Gift card orders
      summary: List gift card orders
      operationId: list-gift-card-orders
      parameters:
        - name: limit
          in: query
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 25
        - name: offset
          in: query
          schema:
            type: integer
            minimum: 0
            default: 0
        - name: status
          in: query
          schema:
            type: string
            enum:
              - purchased
              - submitted
              - partially_paid
              - issue
              - paid
              - cancelled
        - name: retailer
          in: query
          description: Exact retailer name, case-insensitive.
          schema:
            type: string
        - name: orderNumber
          in: query
          description: Exact order number.
          schema:
            type: string
        - name: orderDateFrom
          in: query
          description: Earliest order date, inclusive.
          schema:
            type: string
            format: date
        - name: orderDateTo
          in: query
          description: Latest order date, inclusive.
          schema:
            type: string
            format: date
      responses:
        '200':
          description: A page of orders.
          content:
            application/json:
              schema:
                type: object
                required:
                  - data
                  - pagination
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/GiftCardOrder'
                  pagination:
                    $ref: '#/components/schemas/Pagination'
              example:
                data:
                  - id: 0b6f3c1e-8f4a-4c2e-9d55-2f1a7e3b9c10
                    source: api
                    orderDate: '2026-10-01'
                    orderTime: null
                    retailer: Staples
                    orderNumber: STP-8812345
                    retailerAccount: null
                    subtotal: 101190
                    shipping: 0
                    tax: 0
                    discount: 0
                    total: 101190
                    creditCardId: null
                    subCreditCardId: null
                    cardEarnRate: 0
                    notes: null
                    cashback: null
                    createdAt: '2026-10-01T18:30:00.000Z'
                    status: purchased
                    expectedPayout: 100000
                    orderLineItems:
                      - id: c2d0a8f4-1b7e-4f0a-8a3e-5b6c7d8e9f01
                        description: Visa gift card
                        model: null
                        unitPrice: 50595
                        quantity: 2
                        expectedUnitPayout: 50000
                        unitValue: 50000
                    platform: card_cash
                pagination:
                  limit: 25
                  offset: 0
                  totalCount: 1
        '400':
          description: Invalid query parameter.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Missing or invalid credentials.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Your plan doesn't include API access.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Rate limited.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    GiftCardOrder:
      type: object
      properties:
        id:
          type: string
          format: uuid
        source:
          type: string
          enum:
            - dashboard
            - extension
            - csv_import
            - api
            - email_automation
          description: How the order was created.
        orderDate:
          type: string
          format: date
        orderTime:
          type:
            - string
            - 'null'
          example: '14:30:00'
        retailer:
          type: string
        orderNumber:
          type:
            - string
            - 'null'
        retailerAccount:
          type:
            - string
            - 'null'
        subtotal:
          type: integer
          minimum: 0
          description: Sum of line items in cents.
        shipping:
          type: integer
          minimum: 0
          description: Shipping in cents.
        tax:
          type: integer
          minimum: 0
          description: Tax in cents.
        discount:
          type: integer
          minimum: 0
          description: Discount in cents.
        total:
          type: integer
          minimum: 0
          description: Subtotal plus shipping and tax, minus discount in cents.
        creditCardId:
          type:
            - string
            - 'null'
        subCreditCardId:
          type:
            - string
            - 'null'
        cardEarnRate:
          type: number
          description: >-
            Points or cashback multiplier, e.g. `2` for 2x or `1.5` for 1.5x. Up
            to three decimal places.
        notes:
          type:
            - string
            - 'null'
        cashback:
          oneOf:
            - $ref: '#/components/schemas/Cashback'
            - type: 'null'
          description: Cashback stacked on the order, e.g. from a shopping portal.
        createdAt:
          type: string
          format: date-time
        expectedPayout:
          type: integer
          minimum: 0
          description: Sum of the line items' expected payouts in cents.
        platform:
          type: string
          maxLength: 100
          description: >-
            Resale platform: `aligned_incentives`, `card_center`, `card_cash`,
            `qgcg`, or one of your custom platforms.
          example: card_cash
        status:
          type: string
          enum:
            - purchased
            - submitted
            - partially_paid
            - issue
            - paid
            - cancelled
          example: purchased
        orderLineItems:
          type: array
          items:
            $ref: '#/components/schemas/GiftCardLineItem'
      required:
        - id
        - source
        - orderDate
        - orderTime
        - retailer
        - orderNumber
        - retailerAccount
        - subtotal
        - shipping
        - tax
        - discount
        - total
        - creditCardId
        - subCreditCardId
        - cardEarnRate
        - notes
        - cashback
        - createdAt
        - expectedPayout
        - platform
        - status
        - orderLineItems
    Pagination:
      type: object
      required:
        - limit
        - offset
        - totalCount
      properties:
        limit:
          type: integer
        offset:
          type: integer
        totalCount:
          type: integer
          description: Items matching the filters across all pages.
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              example: invalid_request
            message:
              type: string
            issues:
              type: array
              description: Per-field problems, when there are any.
              items:
                type: object
                properties:
                  path:
                    type: string
                    example: orderLineItems.0.unitPrice
                  message:
                    type: string
    Cashback:
      type: object
      properties:
        platform:
          type: string
        status:
          type: string
        rewardType:
          type: string
          enum:
            - cashback
            - points_miles
        rewardAmount:
          type:
            - number
            - 'null'
          description: >-
            Cents for `cashback`, or points or miles for `points_miles`. Null
            until entered.
    GiftCardLineItem:
      type: object
      properties:
        id:
          type: string
        description:
          type:
            - string
            - 'null'
        model:
          type:
            - string
            - 'null'
        unitPrice:
          type: integer
          minimum: 0
          description: Price per unit in cents.
        quantity:
          type: integer
        expectedUnitPayout:
          type: integer
          minimum: 0
          description: Expected payout per unit in cents.
        unitValue:
          type: integer
          minimum: 0
          description: Face value of each card in cents.
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: Your API key, starting with `ct_key_`.
    apiSecret:
      type: apiKey
      in: header
      name: x-api-secret
      description: Your API secret, starting with `ct_secret_`.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.