> ## Documentation Index > Fetch the complete documentation index at: https://docs.archeraffiliates.com/llms.txt > Use this file to discover all available pages before exploring further. # Browse the product catalog > Browse the products available to you in the Archer catalog, on the Amazon marketplace of your choice. ### Picking a marketplace Use `marketplace` to choose the Amazon marketplace — for example `amazon.com`, `amazon.co.uk`, `amazon.de` or `amazon.fr`. North-American and European marketplaces are supported. Pass `marketplace=all` to retrieve products from **every** marketplace in a single response; each product still carries its own `marketplace` field so you can split client-side. **Default:** `marketplace` defaults to `amazon.com` when omitted, for backward compatibility with pre-v2 clients. If you're a new integration and want to see products from non-US marketplaces (e.g. UK), you **must** pass either a specific `marketplace` (such as `amazon.co.uk`) or `all`. Omitting the parameter will only return US products. ### Filtering and sorting - `search` — finds products whose title, ASIN, brand or category matches. - `brand_id` — restrict to a single brand. Brand ids come from `/brands`. - `asins` — restrict to specific products. Separate multiple ASINs with commas. - `product_available` — `yes` (default) returns only products that are in stock and good to promote. `no` returns only unavailable products. `either` returns both. - `sort_by` — `title`, `commission` (highest first) or `price` (cheapest first). ### Paging through results Use `skip` and `limit` to page through the catalog. `total_count` is the size of the full filtered set; `fetched_count` is how many you got back. ### What's in each product | Field | What it tells you | |-------|--------------------| | `ASIN` | Amazon product identifier. | | `product_name` | Product title. | | `marketplace` | Amazon marketplace the product belongs to. | | `pricing.price` and `pricing.currency` | Numeric price and its currency. | | `price` | Price as a plain string (mirror of `pricing.price`). | | `commission` | Affiliate commission rate you'd earn on a sale. | | `image_encoded_string` and `images` | Primary image and ordered gallery. Without a stored gallery, `images` is `[image_encoded_string]`; it is empty only when no primary image exists. | | `list_price` | Amazon list (was) price, when available. | | `avg_rating` and `total_reviews` | Average star rating and number of reviews. | | `best_seller`, `sales_rank`, `rank_category`, `monthly_sold` | Product demand and ranking signals, when available. | | `inStock` | Whether the product is currently buyable. | | `product_url` | A ready-to-share Amazon URL on the right marketplace. | | `company_name` and `company_logo` | The brand's name and logo. | | `product_category` and `sub_category` | Where the product sits in the catalog. | ## OpenAPI ````yaml /docs/api-reference/openapi.json get /getproducts openapi: 3.1.0 info: title: Archer Affiliates API description: API that allows use of features on the Archer Platform version: '2.0' servers: - url: https://api.archeraffiliates.com description: Production security: [] paths: /getproducts: get: tags: - Products summary: Browse the product catalog description: >- Browse the products available to you in the Archer catalog, on the Amazon marketplace of your choice. ### Picking a marketplace Use `marketplace` to choose the Amazon marketplace — for example `amazon.com`, `amazon.co.uk`, `amazon.de` or `amazon.fr`. North-American and European marketplaces are supported. Pass `marketplace=all` to retrieve products from **every** marketplace in a single response; each product still carries its own `marketplace` field so you can split client-side. **Default:** `marketplace` defaults to `amazon.com` when omitted, for backward compatibility with pre-v2 clients. If you're a new integration and want to see products from non-US marketplaces (e.g. UK), you **must** pass either a specific `marketplace` (such as `amazon.co.uk`) or `all`. Omitting the parameter will only return US products. ### Filtering and sorting - `search` — finds products whose title, ASIN, brand or category matches. - `brand_id` — restrict to a single brand. Brand ids come from `/brands`. - `asins` — restrict to specific products. Separate multiple ASINs with commas. - `product_available` — `yes` (default) returns only products that are in stock and good to promote. `no` returns only unavailable products. `either` returns both. - `sort_by` — `title`, `commission` (highest first) or `price` (cheapest first). ### Paging through results Use `skip` and `limit` to page through the catalog. `total_count` is the size of the full filtered set; `fetched_count` is how many you got back. ### What's in each product | Field | What it tells you | |-------|--------------------| | `ASIN` | Amazon product identifier. | | `product_name` | Product title. | | `marketplace` | Amazon marketplace the product belongs to. | | `pricing.price` and `pricing.currency` | Numeric price and its currency. | | `price` | Price as a plain string (mirror of `pricing.price`). | | `commission` | Affiliate commission rate you'd earn on a sale. | | `image_encoded_string` and `images` | Primary image and ordered gallery. Without a stored gallery, `images` is `[image_encoded_string]`; it is empty only when no primary image exists. | | `list_price` | Amazon list (was) price, when available. | | `avg_rating` and `total_reviews` | Average star rating and number of reviews. | | `best_seller`, `sales_rank`, `rank_category`, `monthly_sold` | Product demand and ranking signals, when available. | | `inStock` | Whether the product is currently buyable. | | `product_url` | A ready-to-share Amazon URL on the right marketplace. | | `company_name` and `company_logo` | The brand's name and logo. | | `product_category` and `sub_category` | Where the product sits in the catalog. | operationId: get_products_getproducts_get parameters: - name: skip in: query required: false schema: anyOf: - type: integer minimum: 0 - type: 'null' description: Number of rows to skip for offset pagination. default: 0 title: Skip description: Number of rows to skip for offset pagination. - name: limit in: query required: false schema: anyOf: - type: integer maximum: 500 minimum: 1 - type: 'null' description: Rows per page (1–500, default 100). default: 100 title: Limit description: Rows per page (1–500, default 100). - name: marketplace in: query required: false schema: anyOf: - type: string - type: 'null' description: >- Which Amazon marketplace to browse — e.g. `amazon.com`, `amazon.co.uk`, `amazon.de`. Defaults to `amazon.com` when omitted, for backward compatibility with pre-v2 clients. Pass `all` to retrieve products from every marketplace. examples: us: value: amazon.com uk: value: amazon.co.uk de: value: amazon.de all: value: all default: amazon.com title: Marketplace description: >- Which Amazon marketplace to browse — e.g. `amazon.com`, `amazon.co.uk`, `amazon.de`. Defaults to `amazon.com` when omitted, for backward compatibility with pre-v2 clients. Pass `all` to retrieve products from every marketplace. - name: search in: query required: false schema: anyOf: - type: string - type: 'null' description: Find products whose title, ASIN, brand name or category matches. title: Search description: Find products whose title, ASIN, brand name or category matches. - name: brand_id in: query required: false schema: anyOf: - type: string - type: 'null' description: Limit results to a single brand. Brand ids come from `/brands`. title: Brand Id description: Limit results to a single brand. Brand ids come from `/brands`. - name: product_available in: query required: false schema: type: string description: >- `yes` (default) only returns products that are in stock and good to promote. `no` returns only unavailable products. `either` returns both. enum: - 'yes' - 'no' - either default: 'yes' title: Product Available description: >- `yes` (default) only returns products that are in stock and good to promote. `no` returns only unavailable products. `either` returns both. - name: asins in: query required: false schema: anyOf: - type: string - type: 'null' description: >- Limit results to one or more products. Separate multiple ASINs with commas. examples: single: value: B0D45KS7QM multi: value: B0D45KS7QM,B07XJ8C8F5 title: Asins description: >- Limit results to one or more products. Separate multiple ASINs with commas. - name: sort_by in: query required: false schema: anyOf: - type: string - type: 'null' description: >- Sort order. `commission` shows highest-paying first; `title` and `price` sort ascending. enum: - title - commission - price title: Sort By description: >- Sort order. `commission` shows highest-paying first; `title` and `price` sort ascending. responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ProductCatalogResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - OAuth2PasswordBearer: [] components: schemas: ProductCatalogResponse: properties: total_count: type: integer title: Total Count description: Total products matching the filters across all pages. fetched_count: type: integer title: Fetched Count description: Number of products in this page. skip: type: integer title: Skip description: Offset that produced this page. limit: type: integer title: Limit description: Page size that produced this page. product_catalog: items: $ref: '#/components/schemas/ProductCatalogItem' type: array title: Product Catalog description: The rows for this page. type: object required: - total_count - fetched_count - skip - limit - product_catalog title: ProductCatalogResponse description: Paginated catalog response returned by `GET /getproducts`. HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError ProductCatalogItem: properties: ASIN: anyOf: - type: string - type: 'null' title: Asin description: Amazon product identifier. product_name: anyOf: - type: string - type: 'null' title: Product Name description: Product title. marketplace: anyOf: - type: string - type: 'null' title: Marketplace description: Amazon marketplace the product belongs to, e.g. `amazon.co.uk`. pricing: anyOf: - $ref: '#/components/schemas/Pricing' - type: 'null' description: Numeric price and its currency. price: anyOf: - type: string - type: 'null' title: Price description: Price as a plain string. Use `pricing.price` if you want a number. commission: anyOf: - type: number - type: 'null' title: Commission description: Affiliate commission rate you would earn on a sale, as a number. commission_payout_aff: anyOf: - type: string - type: 'null' title: Commission Payout Aff description: >- Affiliate commission rate as a plain string. Use `commission` if you want a number. image_encoded_string: anyOf: - type: string - type: 'null' title: Image Encoded String description: URL of the product image. images: items: type: string type: array title: Images description: >- Ordered product image gallery URLs. When no gallery is stored, this falls back to `[image_encoded_string]`; it is empty only when the product has no primary image. list_price: anyOf: - type: number - type: 'null' title: List Price description: Amazon list (was) price, when higher than the current price. avg_rating: anyOf: - type: string - type: 'null' title: Avg Rating description: Average star rating as a string. total_reviews: anyOf: - type: string - type: 'null' title: Total Reviews description: Number of customer reviews, as a string. best_seller: type: boolean title: Best Seller description: True when Amazon marks the product as a best seller. default: false sales_rank: anyOf: - type: integer - type: 'null' title: Sales Rank description: Amazon best-seller rank in `rank_category`. rank_category: anyOf: - type: string - type: 'null' title: Rank Category description: Category associated with `sales_rank`. monthly_sold: anyOf: - type: integer - type: 'null' title: Monthly Sold description: Recent monthly unit-sales estimate, when available. inStock: anyOf: - type: boolean - type: 'null' title: Instock description: True when the product is currently buyable. product_url: anyOf: - type: string - type: 'null' title: Product Url description: Ready-to-share Amazon URL on the correct marketplace. company_name: anyOf: - type: string - type: 'null' title: Company Name description: Brand name. brand_name: anyOf: - type: string - type: 'null' title: Brand Name description: Brand name (same value as `company_name`). company_logo: anyOf: - type: string - type: 'null' title: Company Logo description: URL of the brand logo. brand_id: anyOf: - type: string - type: 'null' title: Brand Id description: Brand identifier you can pass back to `/getproducts?brand_id=…`. product_category: anyOf: - type: string - type: 'null' title: Product Category description: Top-level product category. sub_category: anyOf: - items: additionalProperties: true type: object type: array - type: 'null' title: Sub Category description: Sub-categories the product appears under. is_variant_of: anyOf: - type: string - type: 'null' title: Is Variant Of description: Parent ASIN when this is a variant of another product. type: object title: ProductCatalogItem description: A product in the Archer catalog. ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type input: title: Input ctx: type: object title: Context type: object required: - loc - msg - type title: ValidationError Pricing: properties: price: anyOf: - type: number - type: 'null' title: Price description: Price as a number. currency: anyOf: - type: string - type: 'null' title: Currency description: Currency code for the marketplace (e.g. `USD`, `GBP`, `EUR`). type: object title: Pricing description: Numeric price and its currency. securitySchemes: OAuth2PasswordBearer: type: oauth2 flows: password: scopes: {} tokenUrl: token ````