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

# List orders

> Your orders, newest first, each in the Get an order shape. The units of a multi-pack order are listed one by one, each with the order's `order_id`, its `batch_id` and its `unit` number. `partner_user_ref` matches the wallets you first sent with that ref.



## OpenAPI

````yaml /partner-api/v2/openapi.yaml get /api/partner/v2/orders
openapi: 3.1.0
info:
  title: CatchBack Partner API v2 (wallets & NFTs)
  version: 2.0.0
  summary: >-
    Sell CatchBack packs to your users' own web3 wallets, and let the NFT holder
    sell back or ship.
  description: >-
    The official contract for Partner API v2. Generate clients from this file.


    Each customer pays for their own pack (USDC on Base or Solana, through a
    Unifold Payment

    Intent), and each pulled item is minted as an NFT to the customer's wallet.
    Whoever holds the

    NFT can trade it, sell it back for USDC, or have the physical item shipped.
    Selling back and

    shipping both burn the NFT. Guides: [Overview](/partner-api/v2/overview).


    - **Auth:** every `/api/partner/v2` request sends your key as a bearer
    token, and every key
      needs the scope `nft:orders`. The public token metadata needs no key.
    - **Your program:** your key is linked to your partner program, which fixes
    the chain your
      NFTs mint on (`mint_chain`) and your collection contract. An order, token, quote or shipment
      from another program answers `404`.
    - **Formats:** JSON, UTF-8. Money is USD as a number in dollars (`25`,
    `9.85`). New fields can be
      added to any response; ignore fields you don't know.
    - **Errors:** bodies are `{ "error": "<message>" }`, and errors your
    integration should act on
      also carry a stable `code` (see `ErrorCode`). Branch on the status and the `code`, never on the
      message text. [Errors](/partner-api/v2/errors).
    - **Idempotency:** `POST /orders`, `POST /shipments`, `POST
    /tokens/{tokenId}/shipment` and
      `POST /keys/rotate` require an `Idempotency-Key`. [Idempotency](/partner-api/v2/idempotency).
    - **Sandbox:** the sandbox runs the same API with simulated payments on a
    public testnet. Its base
      URL is issued on request, with a sandbox key. The operations tagged `Sandbox` exist only there
      and answer `404` in production.
  contact:
    name: CatchBack support
    email: support@catchbackcards.com
servers:
  - url: https://catchbackcards.com
    description: >-
      Production. Every payment is real money. The sandbox base URL is issued on
      request.
security:
  - bearerAuth:
      - nft:orders
tags:
  - name: Packs
    description: The packs you can sell, their odds and every item they can pull.
  - name: Orders
    description: >-
      Buy 1-10 packs for one wallet, follow the order to the mint, and prove the
      pull.
  - name: Tokens
    description: A wallet's tokens and one token's item, holder and sell-back schedule.
  - name: Sell-back
    description: >-
      Quote a sell-back, have the holder burn with it, and follow the USDC
      payout.
  - name: Shipments
    description: >-
      Pay shipping for 1-25 tokens, have the holder burn each one, and track the
      box.
  - name: Webhooks
    description: Register, read, test and remove your webhook URL.
  - name: Webhook events
    description: Signed POSTs we send to your webhook URL.
  - name: Keys
    description: Read, rotate and revoke your API key.
  - name: Revenue
    description: Your monthly revenue-share statement.
  - name: Sandbox
    description: Sandbox-only helpers. Every one answers `404` in production.
  - name: Metadata
    description: Public NFT metadata that wallets and marketplaces read with no key.
paths:
  /api/partner/v2/orders:
    get:
      tags:
        - Orders
      summary: List orders
      description: >-
        Your orders, newest first, each in the Get an order shape. The units of
        a multi-pack order are listed one by one, each with the order's
        `order_id`, its `batch_id` and its `unit` number. `partner_user_ref`
        matches the wallets you first sent with that ref.
      operationId: listOrders
      parameters:
        - $ref: '#/components/parameters/WalletFilter'
        - name: partner_user_ref
          in: query
          description: A `partner_user_ref` you sent with an order.
          schema:
            type: string
            pattern: ^[A-Za-z0-9_.:-]{1,128}$
        - name: status
          in: query
          description: Only orders in this status.
          schema:
            type: string
            enum:
              - awaiting_payment
              - paid
              - rolled
              - minted
              - mint_failed
              - expired
              - refund_due
              - refunded
        - $ref: '#/components/parameters/Limit'
        - $ref: '#/components/parameters/Cursor'
      responses:
        '200':
          description: One page of orders.
          content:
            application/json:
              schema:
                type: object
                required:
                  - orders
                  - next_cursor
                properties:
                  orders:
                    type: array
                    items:
                      $ref: '#/components/schemas/OrderOrUnit'
                  next_cursor:
                    $ref: '#/components/schemas/NextCursor'
              example:
                orders:
                  - order_id: okx-ord-7f3a9c21
                    id: 3d2b8f0e-6c1a-4f7e-9a51-2b0d8c4e7f13
                    status: minted
                    pack_type: bronze
                    category: pokemon
                    odds: standard
                    price: 25
                    recipient: 0x8f3c...e21a
                    mint_chain: evm:196
                    paid_at: '2026-11-16T18:04:40.002Z'
                    pull:
                      card_id: a1c4e2f8-7b3d-4c5e-9f1a-2b3c4d5e6f70
                      category: pokemon
                      name: Charizard ex 199/165 PSA 10
                      value: 412.5
                      pulled_at: '2026-11-16T18:04:41.317Z'
                    token:
                      chain: evm:196
                      contract: 0x7b1e...c0de
                      token_id: '81264573985362058461377125337283195667'
                      status: confirmed
                      tx: 0x9f2a...
                    failure_reason: null
                    created_at: '2026-11-16T18:02:11.420Z'
                next_cursor: >-
                  WyIyMDI2LTExLTE2VDE4OjAyOjExLjQyMDEyMyswMDowMCIsIjNkMmI4ZjBlLS4uLiJd
        '400':
          description: >-
            - `BAD_CURSOR`: `cursor` isn't a `next_cursor` from a previous page.

            - `BAD_LIMIT`: `limit` isn't 1-100.

            - `BAD_STATUS`: `status` isn't one the list filters on.

            - `BAD_ADDRESS`: `wallet` is not an address on your mint chain.

            - `BAD_PARTNER_USER_REF`: `partner_user_ref` isn't 1-128 characters
            of `A-Za-z0-9_.:-`.

            - `TOO_MANY_WALLETS`: that `partner_user_ref` covers more than 200
            wallets; filter by `wallet` instead.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: limit must be 1-100
                code: BAD_LIMIT
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/ServerError'
        '503':
          $ref: '#/components/responses/AuthUnavailable'
components:
  parameters:
    WalletFilter:
      name: wallet
      in: query
      description: A `recipient` address on your mint chain.
      schema:
        type: string
    Limit:
      name: limit
      in: query
      description: Page size, 1-100.
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 25
    Cursor:
      name: cursor
      in: query
      description: >-
        The `next_cursor` of the previous page, unchanged. Omit for the first
        page.
      schema:
        type: string
        maxLength: 400
  schemas:
    OrderOrUnit:
      anyOf:
        - $ref: '#/components/schemas/OrderUnit'
        - $ref: '#/components/schemas/Order'
    NextCursor:
      type:
        - string
        - 'null'
      description: >-
        Pass it back unchanged as `cursor` for the next page. Opaque. Null on
        the last page.
    Error:
      type: object
      required:
        - error
      description: >-
        Every error body. `code` is stable where you might branch on it; some
        errors add the fields below.
      properties:
        error:
          type: string
          description: >-
            For people. The text can change, so branch on the status and the
            `code`.
        code:
          description: >-
            Machine-readable, where you might branch on it. New codes can be
            added, so treat an unknown one like a missing one.
          anyOf:
            - $ref: '#/components/schemas/ErrorCode'
            - type: string
        retry_after_seconds:
          type: integer
          description: On `RATE_LIMITED`.
        odds:
          description: >-
            On `BAD_ODDS` when the pack sells other odds: the choices it sells.
            On `ODDS_UNAVAILABLE` from Create an order: the choice asked for.
          oneOf:
            - type: array
              items:
                $ref: '#/components/schemas/Odds'
            - $ref: '#/components/schemas/Odds'
        reason:
          type:
            - string
            - 'null'
          description: On `PACK_UNAVAILABLE`, why the pack can't open.
        status:
          type: string
          description: On `NOT_PULLED`, the order's status.
        token_ids:
          type: array
          items:
            type: string
          description: On a refusal about particular tokens, the token ids it is about.
        quote_id:
          type: string
          description: >-
            On `TOKEN_IN_SHIPMENT` from the one-token endpoint, the shipment
            waiting for the burn.
        fields:
          type: object
          additionalProperties:
            type: string
          description: >-
            On `BAD_ADDRESS` from a shipment or estimate, each bad address field
            and what is wrong with it.
        order_value:
          type: number
          description: On `COVER_NOT_ALLOWED`.
        min_cover:
          type: number
          description: On `COVER_NOT_ALLOWED`.
        max_cover:
          type:
            - number
            - 'null'
          description: On `COVER_NOT_ALLOWED`; null when the items can't be insured.
        amount:
          type: number
          description: On `PRICE_CHANGED`, the current shipping cost.
        successor:
          type: object
          description: On `ALREADY_ROTATED`, the key that replaced this one.
          properties:
            id:
              type: string
              format: uuid
            name:
              type: string
        expires_at:
          type:
            - string
            - 'null'
          format: date-time
          description: On `ALREADY_ROTATED`, when this key stops working.
    OrderUnit:
      description: >-
        One pack of a multi-pack order, in the single-order shape under the
        order's `order_id`.
      allOf:
        - $ref: '#/components/schemas/Order'
        - type: object
          required:
            - batch_id
            - unit
          properties:
            batch_id:
              type: string
              format: uuid
              description: The multi-pack order's `id`.
            unit:
              type:
                - integer
                - 'null'
              minimum: 1
              maximum: 10
              description: 1 to `quantity`.
    Order:
      type: object
      description: One single-pack order.
      required:
        - order_id
        - id
        - status
        - pack_type
        - category
        - odds
        - price
        - recipient
        - mint_chain
        - paid_at
        - pull
        - token
        - failure_reason
        - created_at
      properties:
        order_id:
          type: string
          description: Your `Idempotency-Key`.
        id:
          type: string
          format: uuid
          description: Our id.
        status:
          $ref: '#/components/schemas/OrderStatus'
        pack_type:
          type: string
        category:
          $ref: '#/components/schemas/PackCategory'
        odds:
          $ref: '#/components/schemas/Odds'
        price:
          type: number
        recipient:
          type: string
        mint_chain:
          $ref: '#/components/schemas/ChainKey'
        paid_at:
          type:
            - string
            - 'null'
          format: date-time
        pull:
          oneOf:
            - $ref: '#/components/schemas/Pull'
            - type: 'null'
        token:
          oneOf:
            - $ref: '#/components/schemas/OrderToken'
            - type: 'null'
        failure_reason:
          type:
            - string
            - 'null'
          description: 'On `mint_failed`, `expired`, `refund_due` and `refunded`: why.'
        created_at:
          type: string
          format: date-time
    ErrorCode:
      type: string
      description: Every `code` v2 returns. Branch on these, never on the message text.
      enum:
        - RATE_LIMITED
        - AUTH_UNAVAILABLE
        - NO_PROGRAM
        - PROGRAM_INACTIVE
        - NOT_AVAILABLE
        - BAD_JSON
        - BAD_IDEMPOTENCY_KEY
        - IDEMPOTENCY_KEY_REUSED
        - BAD_RECIPIENT
        - BAD_PACK
        - BAD_CATEGORY
        - BAD_ODDS
        - BAD_QUANTITY
        - ODDS_UNAVAILABLE
        - BAD_REFUND_ADDRESS
        - PACK_NOT_OFFERED
        - PACK_UNAVAILABLE
        - WALLET_REFUSED
        - WALLET_BLOCKED
        - SCREENING_UNAVAILABLE
        - UNKNOWN_ORDER
        - NOT_PULLED
        - VERIFY_UNAVAILABLE
        - BAD_CURSOR
        - BAD_LIMIT
        - BAD_STATUS
        - BAD_ADDRESS
        - BAD_PARTNER_USER_REF
        - TOO_MANY_WALLETS
        - UNKNOWN_TOKEN
        - BAD_HOLDER
        - NOT_HOLDER
        - CHAIN_UNAVAILABLE
        - TOKEN_NOT_MINTED
        - TOKEN_BURNED
        - TOKEN_NOT_LIVE
        - NO_OFFER
        - PAYOUT_CHAIN_NOT_SUPPORTED
        - PAYOUT_CHAIN_NOT_ENABLED
        - BAD_PAYOUT_ADDRESS
        - USE_SHIPMENT_ENDPOINT
        - BAD_TOKEN_IDS
        - TOKEN_IN_SHIPMENT
        - BAD_COVER
        - COVER_NOT_ALLOWED
        - COVER_UNAVAILABLE
        - BAD_MAX_COST
        - NOT_SHIPPABLE
        - PARTNER_GOODS
        - COUNTRY_NOT_SUPPORTED
        - OVER_CUSTOMS_CAP
        - RATE_UNAVAILABLE
        - PRICE_CHANGED
        - UNKNOWN_SHIPMENT
        - NOT_PAID
        - ALREADY_REDEEMED
        - HOLDER_CHANGED
        - UNKNOWN_QUOTE
        - INVALID_WEBHOOK_URL
        - WEBHOOK_ACCOUNT_CHANGED
        - WEBHOOKS_UNAVAILABLE
        - UNKNOWN_WEBHOOK
        - KEY_ROTATED
        - BAD_PERIOD
        - INVALID_KEY
        - NO_PREVIOUS_KEY
        - ALREADY_ROTATED
        - UNKNOWN_PAYMENT
        - NOT_BURNED
    Odds:
      type: string
      enum:
        - standard
        - hot
        - chill
        - classic
      description: >-
        The odds a pack is opened at, as in our app's picker. Standard, Hot and
        Chill share one value-band ladder and differ only in the chance of each
        band; Classic is the pack's own bands and chances. A pack that sells
        only its own odds sells just `classic`. [Odds](/partner-api/v2/odds).
    OrderStatus:
      type: string
      enum:
        - awaiting_payment
        - paid
        - rolled
        - minted
        - mint_failed
        - expired
        - refund_due
        - refunded
      description: >-
        - `awaiting_payment`: waiting for the payment, for up to 24 hours.

        - `expired`: not paid within 24 hours. A payment that still arrives is
        refunded in full.

        - `paid`: settled; the pack opens next.

        - `rolled`: the pack opened (`pull` is set); the NFT is being minted.

        - `minted` (final): the NFT is in `recipient`'s wallet.

        - `mint_failed`: the mint hasn't landed yet; it is retried and never
        re-opens the pack.

        - `refund_due`: being refunded in USDC on Base to `refund_address`;
        `failure_reason` says why (e.g. `paid_after_expiry`, `underpaid`).

        - `refunded` (final): the refund was sent.
    PackCategory:
      type: string
      enum:
        - pokemon
        - onepiece
        - sports
        - riftbound
        - watches
        - goods
      default: pokemon
      description: >-
        `goods` packs hold streetwear and jewelry. Raw singles have no category
        of their own: they come out of other categories' packs.
    ChainKey:
      type: string
      description: >-
        A chain as `<family>:<id>`: `evm:8453` is Base, `evm:<chainId>` any
        other EVM chain (e.g. `evm:196`, X Layer), `solana:mainnet` Solana. The
        sandbox uses a public testnet.
      pattern: ^(evm:[0-9]+|solana:(mainnet|devnet))$
      examples:
        - evm:196
    Pull:
      type: object
      required:
        - card_id
        - category
        - name
        - value
        - pulled_at
      properties:
        card_id:
          type: string
        category:
          $ref: '#/components/schemas/PackCategory'
        name:
          type:
            - string
            - 'null'
        value:
          type: number
          description: The item's value when it was pulled; it anchors the sell-back offer.
        pulled_at:
          type: string
          format: date-time
    OrderToken:
      type: object
      description: >-
        The NFT. On an EVM program it has `contract`; on a Solana program
        `collection` and `asset` instead.
      required:
        - chain
        - token_id
        - status
        - tx
      properties:
        chain:
          $ref: '#/components/schemas/ChainKey'
        contract:
          type:
            - string
            - 'null'
          description: EVM only.
        collection:
          type:
            - string
            - 'null'
          description: Solana only.
        asset:
          type:
            - string
            - 'null'
          description: Solana only.
        token_id:
          type:
            - string
            - 'null'
          description: Decimal. Keep it as a string or bigint.
        status:
          type: string
          enum:
            - pending
            - submitted
            - confirmed
            - failed
            - burned
          description: >-
            `pending` (reserved, not sent), `submitted`, `confirmed`, `failed`
            (being retried), or `burned` once sold back or shipped.
        tx:
          type:
            - string
            - 'null'
          description: The mint transaction.
  responses:
    Unauthorized:
      description: >-
        - `Missing or malformed API key`: no `Bearer cb_live_…` header.

        - `Invalid API key`: unknown or disabled, or a rotated key past its 24
        hours.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Missing or malformed API key
    Forbidden:
      description: >-
        - `API key lacks required scope: nft:orders`.

        - `NO_PROGRAM`: the key isn't linked to a partner program.

        - `PROGRAM_INACTIVE`: your program is not live.

        - `NOT_AVAILABLE`: wallet orders aren't switched on for your program
        yet.

        - `Access denied`: a request from a country on our sanctions list.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: This partner program is not live
            code: PROGRAM_INACTIVE
    RateLimited:
      description: >-
        `RATE_LIMITED`: too many requests from this key. Wait
        `retry_after_seconds`. Limits per key: `POST /orders` 30 a minute; the
        two shipment estimates 30 a minute together; every other endpoint 120 a
        minute together.
      headers:
        Retry-After:
          $ref: '#/components/headers/RetryAfter'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Too many requests. Slow down.
            code: RATE_LIMITED
            retry_after_seconds: 23
    ServerError:
      description: >-
        Our fault. Retry with backoff, with the same `Idempotency-Key` where the
        endpoint takes one.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Something went wrong; retry with the same Idempotency-Key.
    AuthUnavailable:
      description: >-
        `AUTH_UNAVAILABLE`, or no code: we couldn't check your key or load your
        program right now. This never means the key is bad; retry after
        `Retry-After`.
      headers:
        Retry-After:
          $ref: '#/components/headers/RetryAfter'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Could not load the partner program; try again.
  headers:
    RetryAfter:
      description: Seconds to wait before retrying.
      schema:
        type: integer
        minimum: 1
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: cb_live_<48 hex>
      description: >-
        Your API key (`cb_live_…`), sent as a bearer token, with the scope
        `nft:orders`. Keep it on your servers: never in a browser, app or
        wallet. Use a separate key per environment. A request from a country on
        our sanctions list gets a `403` with `Access denied`, whether or not it
        has a valid key. See [Authentication and
        keys](/partner-api/v2/authentication).

````

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