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

# Estimate a shipment

> **Rate limit:** 30 a minute, shared with Estimate a one-token shipment.

Carrier rates to ship 1-25 tokens held by one wallet in one box. Charges nothing and stores nothing. `amount` is the carrier rate; `total` is what the holder pays (the rate plus any cover premium): pass it as `max_cost` when you create the shipment. A refusal about particular tokens lists them in `token_ids`.



## OpenAPI

````yaml /partner-api/v2/openapi.yaml post /api/partner/v2/shipments/estimate
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/estimate:
    post:
      tags:
        - Shipments
      summary: Estimate a shipment
      description: >-
        **Rate limit:** 30 a minute, shared with Estimate a one-token shipment.


        Carrier rates to ship 1-25 tokens held by one wallet in one box. Charges
        nothing and stores nothing. `amount` is the carrier rate; `total` is
        what the holder pays (the rate plus any cover premium): pass it as
        `max_cost` when you create the shipment. A refusal about particular
        tokens lists them in `token_ids`.
      operationId: estimateShipment
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ShipmentEstimateRequest'
            example:
              token_ids:
                - '81264573985362058461377125337283195667'
                - '90311820476190023716442901288201455'
              holder: 0x8f3c...e21a
              address:
                name: Alice Tester
                address1: 1 Market St
                address2: null
                city: San Francisco
                state: CA
                zip: '94105'
                country: US
                phone: '4155550100'
              cover_amount: null
      responses:
        '200':
          description: The rates.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShippingRates'
              example:
                rates:
                  - carrier: USPS
                    service: Priority Mail
                    token: usps_priority
                    amount: 9.85
                    estimated_days: 3
                    total: 9.85
        '400':
          $ref: '#/components/responses/ShipmentEstimateBadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/NotHolderForbidden'
        '404':
          $ref: '#/components/responses/UnknownTokens'
        '409':
          $ref: '#/components/responses/TokensNotLive'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/ServerError'
        '503':
          $ref: '#/components/responses/ChainUnavailable'
components:
  schemas:
    ShipmentEstimateRequest:
      allOf:
        - type: object
          required:
            - token_ids
          properties:
            token_ids:
              $ref: '#/components/schemas/TokenIdList'
        - $ref: '#/components/schemas/TokenShipmentEstimateRequest'
    ShippingRates:
      type: object
      required:
        - rates
      properties:
        rates:
          type: array
          items:
            $ref: '#/components/schemas/ShippingRate'
    TokenIdList:
      type: array
      minItems: 1
      maxItems: 25
      uniqueItems: true
      description: >-
        1-25 distinct decimal token ids of your program, all held by `holder`.
        Send them as strings.
      items:
        type: string
        pattern: ^[0-9]{1,78}$
    TokenShipmentEstimateRequest:
      type: object
      required:
        - holder
        - address
      properties:
        holder:
          type: string
        address:
          $ref: '#/components/schemas/ShipmentAddress'
        cover_amount:
          $ref: '#/components/schemas/CoverAmount'
    ShippingRate:
      type: object
      required:
        - carrier
        - service
        - token
        - amount
        - estimated_days
        - total
      properties:
        carrier:
          type: string
        service:
          type: string
        token:
          type: string
          description: Pass it back as `rate.token`.
        amount:
          type: number
          description: The carrier rate.
        estimated_days:
          type:
            - integer
            - 'null'
        total:
          type: number
          description: >-
            What the holder pays (the rate plus any cover premium). Pass it as
            `max_cost`.
    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.
    ShipmentAddress:
      type: object
      required:
        - name
        - address1
        - city
        - country
      properties:
        name:
          type: string
          maxLength: 100
        address1:
          type: string
          maxLength: 100
        address2:
          type:
            - string
            - 'null'
          maxLength: 100
        city:
          type: string
          maxLength: 100
        state:
          type:
            - string
            - 'null'
          maxLength: 100
          description: Where the country uses it.
        zip:
          type:
            - string
            - 'null'
          maxLength: 20
          description: Where the country uses it.
        country:
          type: string
          minLength: 2
          maxLength: 2
          description: ISO 3166 alpha-2.
        phone:
          type:
            - string
            - 'null'
          maxLength: 20
          description: Required outside the US.
    CoverAmount:
      type:
        - number
        - 'null'
      exclusiveMinimum: 0
      description: >-
        Shipping insurance cover in dollars, with at most two decimals, within
        the range the items allow (a `400` `COVER_NOT_ALLOWED` gives the range).
        Leave it out or null for none.
    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).
  responses:
    ShipmentEstimateBadRequest:
      description: >-
        - `BAD_JSON`: the body isn't JSON.

        - `BAD_TOKEN_IDS`: `token_ids` isn't a list of 1-25 distinct decimal
        token id strings (Estimate a shipment only).

        - `BAD_HOLDER`: `holder` is not a wallet address on your mint chain.

        - `BAD_ADDRESS`: the shipping address is invalid; `fields` maps each bad
        field to a message.

        - `BAD_COVER`: `cover_amount` isn't a positive dollar amount with at
        most two decimals.

        - `COVER_NOT_ALLOWED`: `cover_amount` is outside what the items can be
        insured for; the body has `order_value`, `min_cover` and `max_cover`
        (`max_cover` is null when they can't be insured).

        - `NOT_SHIPPABLE`: an item can't ship.

        - `PARTNER_GOODS`: the item is held by its brand partner and can't ship
        through CatchBack; it can still be sold back.

        - `COUNTRY_NOT_SUPPORTED`: we don't ship to that country.

        - `OVER_CUSTOMS_CAP`: the items are worth more than we can ship
        internationally.


        A refusal about particular tokens lists them in `token_ids`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Some address fields are invalid.
            code: BAD_ADDRESS
            fields:
              phone: phone is required outside the US
    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
    NotHolderForbidden:
      description: >-
        - `NOT_HOLDER`: that wallet does not hold the token on chain right now.
        On the multi-token endpoints `token_ids` lists the tokens it doesn't
        hold.

        - Any of the key and program refusals every endpoint can return.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: >-
              That wallet does not hold every token: one shipment is for one
              holder.
            code: NOT_HOLDER
            token_ids:
              - '90311820476190023716442901288201455'
    UnknownTokens:
      description: >-
        `UNKNOWN_TOKEN`: no such token on your program's contract. On Create a
        shipment and Estimate a shipment, `token_ids` lists the unknown ones.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Unknown token
            code: UNKNOWN_TOKEN
            token_ids:
              - '90311820476190023716442901288201455'
    TokensNotLive:
      description: >-
        `TOKEN_NOT_LIVE`: the token isn't minted yet, or was already burned. On
        the multi-token endpoints `token_ids` lists them.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: These tokens are not live.
            code: TOKEN_NOT_LIVE
            token_ids:
              - '90311820476190023716442901288201455'
    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.
    ChainUnavailable:
      description: >-
        - `CHAIN_UNAVAILABLE`: we couldn't read a token's owner from the chain;
        retry shortly.

        - `AUTH_UNAVAILABLE`, or no code: we couldn't check your key or load
        your program; retry after `Retry-After`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Could not read the token owner; try again shortly.
            code: CHAIN_UNAVAILABLE
  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.