Browse the product catalog

curl --request GET \
  --url https://api.example.com/getproducts \
  --header 'Authorization: Bearer <token>'

{
  "total_count": 123,
  "fetched_count": 123,
  "skip": 123,
  "limit": 123,
  "product_catalog": [
    {
      "asin": "<string>",
      "ASIN": "<string>",
      "title": "<string>",
      "product_name": "<string>",
      "marketplace": "<string>",
      "pricing": {
        "price": 123,
        "currency": "<string>"
      },
      "price": "<string>",
      "commission": 123,
      "commission_payout_aff": "<string>",
      "image": "<string>",
      "image_encoded_string": "<string>",
      "rating": 123,
      "avg_rating": "<string>",
      "ratingsTotal": 123,
      "total_reviews": "<string>",
      "inStock": true,
      "product_url": "<string>",
      "company_name": "<string>",
      "company_logo": "<string>",
      "brand_id": "<string>",
      "product_category": "<string>",
      "sub_category": [
        {}
      ],
      "is_variant_of": "<string>",
      "product_status": "<string>",
      "status_reason": "<string>",
      "collection_name": "<string>"
    }
  ]
}

Products

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.
`title`	Product title.
`marketplace`	Amazon marketplace the product belongs to.
`pricing.price` and `pricing.currency`	Numeric price and its currency.
`commission`	Affiliate commission rate you’d earn on a sale.
`image`	URL of the product image.
`rating` and `ratingsTotal`	Average star rating and number of reviews.
`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.

GET

getproducts

Browse the product catalog

curl --request GET \
  --url https://api.example.com/getproducts \
  --header 'Authorization: Bearer <token>'

{
  "total_count": 123,
  "fetched_count": 123,
  "skip": 123,
  "limit": 123,
  "product_catalog": [
    {
      "asin": "<string>",
      "ASIN": "<string>",
      "title": "<string>",
      "product_name": "<string>",
      "marketplace": "<string>",
      "pricing": {
        "price": 123,
        "currency": "<string>"
      },
      "price": "<string>",
      "commission": 123,
      "commission_payout_aff": "<string>",
      "image": "<string>",
      "image_encoded_string": "<string>",
      "rating": 123,
      "avg_rating": "<string>",
      "ratingsTotal": 123,
      "total_reviews": "<string>",
      "inStock": true,
      "product_url": "<string>",
      "company_name": "<string>",
      "company_logo": "<string>",
      "brand_id": "<string>",
      "product_category": "<string>",
      "sub_category": [
        {}
      ],
      "is_variant_of": "<string>",
      "product_status": "<string>",
      "status_reason": "<string>",
      "collection_name": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

skip

integer | null

default:0

Number of rows to skip for offset pagination.

Required range: x >= 0

limit

integer | null

default:100

Rows per page (1–500, default 100).

Required range: 1 <= x <= 500

marketplace

string | null

default:amazon.com

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.

string | null

Find products whose title, ASIN, brand name or category matches.

brand_id

string | null

Limit results to a single brand. Brand ids come from /brands.

product_available

enum<string>

default:yes

yes (default) only returns products that are in stock and good to promote. no returns only unavailable products. either returns both.

Available options:

yes,

no,

either

asins

string | null

Limit results to one or more products. Separate multiple ASINs with commas.

sort_by

enum<string>

Sort order. commission shows highest-paying first; title and price sort ascending.

Available options:

title,

commission,

price

Response

Successful Response

Paginated catalog response returned by GET /getproducts.

total_count

integer

required

Total products matching the filters across all pages.

fetched_count

integer

required

Number of products in this page.

skip

integer

required

Offset that produced this page.

limit

integer

required

Page size that produced this page.

product_catalog

ProductCatalogItem · object[]

required

The rows for this page.

Show child attributes

⌘I

Documentation Index

Authorizations

Query Parameters

Response