> ## 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 shipments

> Your shipments, newest first, one-token and multi-token together, each in its Get a shipment shape.



## OpenAPI

````yaml /partner-api/v2/openapi.yaml get /api/partner/v2/shipments
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/shipments:
    get:
      tags:
        - Shipments
      summary: List shipments
      description: >-
        Your shipments, newest first, one-token and multi-token together, each
        in its Get a shipment shape.
      operationId: listShipments
      parameters:
        - name: wallet
          in: query
          description: The `holder`, on your mint chain.
          schema:
            type: string
        - name: status
          in: query
          description: Only shipments in this status.
          schema:
            type: string
            enum:
              - awaiting_payment
              - ready
              - redeemed
              - expired
              - partially_redeemed
        - $ref: '#/components/parameters/Limit'
        - $ref: '#/components/parameters/Cursor'
      responses:
        '200':
          description: One page of shipments.
          content:
            application/json:
              schema:
                type: object
                required:
                  - shipments
                  - next_cursor
                properties:
                  shipments:
                    type: array
                    items:
                      $ref: '#/components/schemas/AnyShipment'
                  next_cursor:
                    $ref: '#/components/schemas/NextCursor'
              example:
                shipments:
                  - quote_id: 0xc41d...77e2
                    status: ready
                    shipping_cost: 9.85
                    holder: 0x8f3c...e21a
                    expires_at: '2026-11-17T18:41:02.000Z'
                    paid_at: '2026-11-16T18:41:02.000Z'
                    burn:
                      quote:
                        tokenId: '81264573985362058461377125337283195667'
                        kind: 2
                        quoteId: 0xc41d...77e2
                        holder: 0x8f3c...e21a
                        payoutHash: 0x9e04...
                        amount: '0'
                        expiresAt: '1795458062'
                      signature: 0x77ab...1c
                    fulfilment: null
                next_cursor: null
        '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.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: >-
                  status must be one of awaiting_payment, ready, redeemed,
                  expired, partially_redeemed
                code: BAD_STATUS
        '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:
    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:
    AnyShipment:
      description: >-
        A multi-token shipment (`shipment_id`, `tokens`) or a one-token shipment
        (`quote_id`, `burn`).
      anyOf:
        - $ref: '#/components/schemas/ShipmentGroup'
        - $ref: '#/components/schemas/TokenShipment'
    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.
    ShipmentGroup:
      type: object
      description: >-
        A shipment of 1-25 tokens in one box, named by `shipment_id`. Tokens are
        listed by token id.
      required:
        - shipment_id
        - status
        - shipping_cost
        - holder
        - expires_at
        - paid_at
        - tokens
        - fulfilment
      properties:
        shipment_id:
          type: string
          format: uuid
        status:
          type: string
          enum:
            - awaiting_payment
            - ready
            - expired
            - redeemed
            - partially_redeemed
          description: >-
            `partially_redeemed`: the window and its 24-hour grace passed; the
            burned tokens ship, the rest are `dropped`.
        shipping_cost:
          type: number
        holder:
          type: string
        expires_at:
          type: string
          format: date-time
        paid_at:
          type:
            - string
            - 'null'
          format: date-time
        tokens:
          type: array
          items:
            $ref: '#/components/schemas/ShipmentToken'
        fulfilment:
          oneOf:
            - $ref: '#/components/schemas/Fulfilment'
            - type: 'null'
    TokenShipment:
      type: object
      description: >-
        A one-token shipment, named by the token's `quote_id`. `fulfilment` is
        present on reads and webhook events, not on the create response.
      required:
        - quote_id
        - status
        - shipping_cost
        - holder
        - expires_at
        - paid_at
        - burn
      properties:
        quote_id:
          type: string
        status:
          type: string
          enum:
            - awaiting_payment
            - ready
            - expired
            - redeemed
          description: >-
            `awaiting_payment`, `ready` (paid; burn it), `expired` (the paid
            burn window lapsed: renew it), `redeemed` (the burn was seen).
        shipping_cost:
          type:
            - number
            - 'null'
        holder:
          type: string
        expires_at:
          type: string
          format: date-time
          description: >-
            The end of the burn window once paid. An unpaid shipment never
            expires.
        paid_at:
          type:
            - string
            - 'null'
          format: date-time
        burn:
          $ref: '#/components/schemas/ShipmentBurn'
        fulfilment:
          oneOf:
            - $ref: '#/components/schemas/Fulfilment'
            - type: 'null'
    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).
    ShipmentToken:
      type: object
      required:
        - token_id
        - quote_id
        - status
        - burned_at
        - burn_tx
        - burn
      properties:
        token_id:
          type:
            - string
            - 'null'
        quote_id:
          type: string
          description: What this token burns with.
        status:
          type: string
          enum:
            - awaiting_payment
            - ready
            - expired
            - redeemed
            - dropped
          description: >-
            `dropped`: not burned before the shipment closed; still live in the
            holder's wallet.
        burned_at:
          type:
            - string
            - 'null'
          format: date-time
        burn_tx:
          type:
            - string
            - 'null'
        burn:
          $ref: '#/components/schemas/ShipmentBurn'
    Fulfilment:
      type: object
      description: >-
        Where the box is, once every burn is seen. Never the address or the
        label.
      required:
        - status
        - carrier
        - service
        - tracking_number
        - tracking_url
        - shipped_at
        - expected_delivery
        - delivered_at
        - created_at
      properties:
        status:
          type: string
          enum:
            - pending
            - processing
            - shipped
            - delivered
            - cancelled
            - needs_review
          description: >-
            `pending`: burns seen, the shipping order is being created.
            `processing`: being packed. `shipped`: on its way, with tracking.
            `delivered`. `cancelled`: by our team (rare); contact us.
            `needs_review`: we couldn't create the shipment; our team resolves
            it.
        carrier:
          type:
            - string
            - 'null'
        service:
          type:
            - string
            - 'null'
        tracking_number:
          type:
            - string
            - 'null'
        tracking_url:
          type:
            - string
            - 'null'
          description: The carrier's own tracking page.
        shipped_at:
          type:
            - string
            - 'null'
          format: date-time
        expected_delivery:
          type:
            - string
            - 'null'
          format: date
          description: A date, not a moment.
        delivered_at:
          type:
            - string
            - 'null'
          format: date-time
        created_at:
          type: string
          format: date-time
    ShipmentBurn:
      description: >-
        What the holder burns the token with, once the shipping is paid and
        while the window is open; else null.
      oneOf:
        - $ref: '#/components/schemas/EvmShipmentBurn'
        - $ref: '#/components/schemas/SolanaShipmentBurn'
        - type: 'null'
    EvmShipmentBurn:
      type: object
      required:
        - quote
        - signature
      properties:
        quote:
          $ref: '#/components/schemas/EvmBurnQuote'
        signature:
          type: string
    SolanaShipmentBurn:
      type: object
      required:
        - transaction
        - vault
        - last_valid_block_height
      properties:
        transaction:
          type: string
          description: Base64 unsigned transaction, built fresh on every GET.
        vault:
          type: string
        last_valid_block_height:
          type: integer
    EvmBurnQuote:
      type: object
      description: >-
        The EIP-712 `Quote` struct to pass to `burnWithQuote` exactly as
        returned. Domain: name `CatchBackCards`, version `1`, your mint chain
        id, your contract. `kind` 1 is a sell-back, 2 a shipment. `tokenId`,
        `amount` (USDC, 6 decimals; "0" for a shipment) and `expiresAt` (unix
        seconds) are decimal strings: convert them to bigints.
      required:
        - tokenId
        - kind
        - quoteId
        - holder
        - payoutHash
        - amount
        - expiresAt
      properties:
        tokenId:
          type: string
        kind:
          type: integer
          enum:
            - 1
            - 2
        quoteId:
          type: string
          description: bytes32.
        holder:
          type: string
        payoutHash:
          type: string
          description: >-
            bytes32. Sell-back: keccak256(abi.encode(string payout.chain, string
            payout.address)). Shipment: keccak256(abi.encode(string "shipment",
            string quote_id)).
        amount:
          type: string
        expiresAt:
          type: string
  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.