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

# Get Wishlist

> Read the products on a public Amazon wishlist or gift list via the Zinc API.

Returns the products on a public Amazon wishlist or gift list. Each product carries its ASIN as `product_id`, the price shown on the list in cents as `buy_box_price`, whether it can be added to cart as `available`, and the list owner's `quantity_requested` and `quantity_purchased`. Pass a `product_id` to [Get Product Details](https://www.zinc.com/docs/v2/api-reference/products/get-product.md) or [Get Product Offers](https://www.zinc.com/docs/v2/api-reference/products/get-product-offers.md) with the response's `retailer` to get more.

## Pricing

| | |
| - | - |
| **Price** | \$0.01 per call, drawn from your [wallet](https://www.zinc.com/docs/v2/wallet.md) |
| **Charged** | On each successful call, before any order is placed |
| **Empty wallet** | `402` with `{"detail": "Insufficient wallet balance for data API call"}` |
| **Sandbox** | Free — `zn_test_` keys return synthetic sample data, marked `X-Zinc-Test-Data: synthetic` |

> [!WARNING]
>
> This is a metered data call, billed whether or not you go on to order. A retry loop bills every attempt: check [`GET /wallet/me`](https://www.zinc.com/docs/v2/api-reference/wallet/get-wallet) rather than retrying into a 402.

There is no MPP counterpart: wishlists are API-key only.

## Supported lists

| Wishlist host | Response `retailer` |
| - | - |
| `amazon.com` | `amazon` |
| `amazon.co.uk` | `amazon-uk` |
| `amazon.ca` | `amazon-ca` |

Any other host, including other Amazon marketplaces, is rejected with `400` before anything is billed. A private list, or a url on a supported host that is not a list, comes back from the upstream as an error.

A long list takes a while to read. `pages` caps how many pages of the list are fetched; omit it to read the whole list.

## Errors

| Status | When |
| - | - |
| `400` | `url` is not on a supported host: `{"detail": "unsupported wishlist url '...': pass an Amazon wishlist or gift list url on amazon.ca, amazon.co.uk, amazon.com"}` |
| `401` | Missing or invalid API key |
| `402` | Wallet balance too low for the data call |
| `422` | `url` missing or empty, or `pages` below 1 |


## OpenAPI

````yaml versions/latest.json GET /products/wishlists
openapi: 3.1.0
info:
  title: Zinc
  summary: >-
    Zinc lets you search, buy, and return items from top online retailers with a
    single API.
  description: >-
    Search, buy, and return items from top online retailers with a single API.
    Supports AI agent ordering via MPP (HTTP 402) — no account required.
    Supported retailers include 1-800-Flowers, Ace Hardware, AliExpress, Amazon,
    Amazon CA, Amazon DE, Amazon FR, Amazon MX, Amazon UK, Barnes & Noble, Best
    Buy, Chewy, and 21 more. Ships to the US and 6 other countries (CA, DE, FR,
    GB, IT, MX). The listed retailers are the ones Zinc verifies with daily test
    orders, not the limit of what Zinc can buy from: checkout is attempted at
    most online stores, including Shopify-hosted ones. To ask about a specific
    store before ordering, call GET /retailers/check?url=... — it answers
    whether Zinc will attempt that URL.
  version: '2026-10-26'
  x-logo:
    url: https://mintlify.s3.us-west-1.amazonaws.com/zinc/logo/light.png
  contact:
    name: Zinc API Support
    email: support@zinc.com
    url: https://zinc.com/docs
  x-guidance: >-
    Zinc lets AI agents buy products from online retailers via a single API. Use
    POST /agent/orders to place an order — no Zinc account needed, payment is
    handled via MPP (HTTP 402 flow). Provide a product URL from a supported
    retailer, a shipping address, and max_price in cents. The API charges
    max_price + $1 API fee upfront and refunds the difference on completion. To
    find products first, the /agent/* data endpoints (search, products/search,
    products/offers, products/details) are MPP-paid at $0.01 per call;
    /agent/search returns orderable URLs to feed straight into /agent/orders.
    GET /retailers lists supported retailers for free (no payment or account).
    Authenticated equivalents (orders, products, managed-accounts) require a
    Bearer token (API key prefixed zn_); those orders are paid from a prefunded
    wallet — GET /wallet/me returns the spendable balance and per-order fee, so
    check it before POST /orders to avoid a 402. Orders are strict by default:
    if the gift option can't be applied or any item can't be bought, the whole
    order fails. When the user wants whatever can be shipped, send fulfillment:
    {"gift": "best_effort", "items": "best_effort"} and read
    fulfillment.concessions on the order to see what was relaxed. max_price is
    never relaxed. Docs: https://zinc.com/docs Supported retailers include
    1-800-Flowers, Ace Hardware, AliExpress, Amazon, Amazon CA, Amazon DE,
    Amazon FR, Amazon MX, Amazon UK, Barnes & Noble, Best Buy, Chewy, and 21
    more, shipping to the US and 6 other countries (CA, DE, FR, GB, IT, MX). The
    listed retailers are the ones Zinc verifies with daily test orders, not the
    limit of what Zinc can buy from: checkout is attempted at most online
    stores, including Shopify-hosted ones. To ask about a specific store before
    ordering, call GET /retailers/check?url=... — it answers whether Zinc will
    attempt that URL.
  x-supported-retailers:
    - 1-800-Flowers
    - Ace Hardware
    - AliExpress
    - Amazon
    - Amazon CA
    - Amazon DE
    - Amazon FR
    - Amazon MX
    - Amazon UK
    - Barnes & Noble
    - Best Buy
    - Chewy
    - Gap
    - Grainger
    - IBS
    - Lowe's
    - Macys
    - McMaster-Carr
    - Partstown
    - Pokémon Center
    - Sephora
    - Shein
    - Target
    - Temu
    - The Home Depot
    - TikTok
    - Uniqlo
    - Walmart
    - Wayfair
    - Zinc
    - eBay
    - libraccio
    - zazzle
  x-supported-countries:
    - US
    - CA
    - DE
    - FR
    - GB
    - IT
    - MX
servers:
  - url: https://api.zinc.com
    description: Production
security:
  - BearerAuth: []
paths:
  /products/wishlists:
    get:
      tags:
        - products
      summary: Get Wishlist
      description: >-
        The products on a public Amazon wishlist or gift list.


        Each product carries its ASIN as `product_id` (pass it to the details or

        offers endpoints with the same `retailer`), the price shown on the list
        in

        cents as `buy_box_price`, whether it can be added to cart as
        `available`,

        and the list owner's `quantity_requested` / `quantity_purchased`. A long

        list takes a while to read: `pages` bounds it. A private list, or a url

        that is not a list, comes back from the upstream as an error.


        **Billing.** This is a metered data call: $0.01 is drawn from your
        wallet per successful request, before any order is placed. An empty
        wallet gets `402` instead. Sandbox (`zn_test_`) calls are free, return
        synthetic sample data (marked `X-Zinc-Test-Data: synthetic`) and never
        touch the live wallet, up to 10,000 per account per UTC day; past that
        they get `429` until midnight UTC.
      operationId: get_wishlist_products_wishlists_get
      parameters:
        - name: url
          in: query
          required: true
          schema:
            type: string
            minLength: 1
            maxLength: 2048
            description: >-
              A public Amazon wishlist or gift list url, on amazon.com,
              amazon.co.uk or amazon.ca
            title: Url
          description: >-
            A public Amazon wishlist or gift list url, on amazon.com,
            amazon.co.uk or amazon.ca
        - name: pages
          in: query
          required: false
          schema:
            anyOf:
              - type: integer
                minimum: 1
              - type: 'null'
            description: 'Read at most this many pages of the list (default: all)'
            title: Pages
          description: 'Read at most this many pages of the list (default: all)'
        - name: authorization
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Authorization
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WishlistResponse'
        '402':
          description: >-
            Insufficient wallet balance for the data-API fee. Fund the wallet
            (or check `GET /wallet/me`) and retry. Postpaid plan customers are
            never gated here.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                required:
                  - detail
              example:
                detail: Insufficient wallet balance for data API call
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    WishlistResponse:
      properties:
        retailer:
          type: string
          title: Retailer
        url:
          anyOf:
            - type: string
            - type: 'null'
          title: Url
        wishlist_title:
          anyOf:
            - type: string
            - type: 'null'
          title: Wishlist Title
        wishlist_description:
          anyOf:
            - type: string
            - type: 'null'
          title: Wishlist Description
        products:
          items:
            $ref: '#/components/schemas/WishlistProduct'
          type: array
          title: Products
          default: []
      additionalProperties: true
      type: object
      required:
        - retailer
      title: WishlistResponse
      description: An Amazon wishlist or gift list, as scraped from its public page.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    WishlistProduct:
      properties:
        product_id:
          type: string
          title: Product Id
        buy_box_price:
          anyOf:
            - type: integer
            - type: 'null'
          title: Buy Box Price
          description: Price in cents, as shown on the list.
        available:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Available
        quantity_purchased:
          anyOf:
            - type: integer
            - type: 'null'
          title: Quantity Purchased
        quantity_requested:
          anyOf:
            - type: integer
            - type: 'null'
          title: Quantity Requested
      additionalProperties: true
      type: object
      required:
        - product_id
      title: WishlistProduct
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    BearerAuth:
      type: apiKey
      in: header
      name: Authorization
      description: Zinc API key (Bearer zn_...)

````

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