GET /v1/products/lists/{id} — get list with products

Use GET /v1/products/lists/{list_id} to retrieve a specific product list and the complete product data for every item it contains. This is the endpoint to call when you need current pricing, affiliate URLs, availability status, or any other product field for the items in a list.

Request

Endpoint: GET /v1/products/lists/{list_id}

Headers

string

required

Your API key as a Bearer token: Bearer {your_api_key}.

Path parameters

string

required

The unique identifier of the list to retrieve. You receive a list_id when you create a list or from the id field in GET /v1/products/lists responses.

Example request

cURL

curl --request GET \
  --url 'https://api.affiliate.com/v1/products/lists/{list_id}' \
  --header 'Authorization: Bearer {your_api_key}'

Response

A 200 OK response contains a data object with the list details and an array of full product objects.

{
  "data": {
    "id": "9ea4894b-8491-4a79-9419-902b69f70bed",
    "name": "listnamehere",
    "metadata": {
      "key1": "metavalueiwantreturned"
    },
    "products_count": 2,
    "products": [
      {
        "id": "8099982740095203709",
        "barcode": null,
        "name": "Acrylic Bubblegum Tupac by N Perez Print",
        "description": "This exclusive offering was created by N Perez, a local Miami-based artist best known for his college digital works and positive upbeat pop art.",
        "commission_url": "https://www.tkqlhce.com/click-@@@-13730087?url=https%3A%2F%2Fwww.wayfair.com%2F...&sid=###",
        "direct_url": "https://www.wayfair.com/DecorumBY--Acrylic-Bubblegum-Tupac-by-N-Perez-Print-Graphic-Art-Bubblegum-Tupac--L1318-K~DCBY1240.html",
        "image_url": "https://assets.wfcdn.com/im/96908466/resize-h400-w400%5Ecompr-r85/7745/77458008/.jpg",
        "currency": "USD",
        "regular_price": 679.99,
        "final_price": 679.99,
        "on_sale": false,
        "sale_discount": 0,
        "availability": "InStock",
        "sku": null,
        "brand": "DecorumBY",
        "category": "Home & Garden > Decor > Artwork; Home & Garden > Home Decor > Wall Art",
        "network": {
          "id": 3,
          "name": "CJ US",
          "logo_url": "https://img.affiliate.com/logos/groups/10013/128x128.png"
        },
        "merchant": {
          "id": 9998,
          "name": "Wayfair",
          "logo_url": "https://img.affiliate.com/logos/merchants/9998/logo.png"
        },
        "updated_at": "2025-04-17 04:46:36"
      },
      {
        "id": "8099987467386791069",
        "barcode": null,
        "name": "Bubblegum Tupac by N Perez - Round Photograph",
        "description": "Museum-quality art piece printed in ultra-high resolution on metallic photo paper.",
        "commission_url": "https://www.kqzyfj.com/click-@@@-13730087?url=https%3A%2F%2Fwww.wayfair.com%2F...&sid=###",
        "direct_url": "https://www.wayfair.com/DecorumBY--Bubblegum-Tupac-by-N-Perez-Round-Photograph-Graphic-Art-Bubblegum-Tupac-AD-L1318-K~DCBY1239.html",
        "image_url": "https://assets.wfcdn.com/im/08259379/resize-h400-w400%5Ecompr-r85/7745/77458009/.jpg",
        "currency": "USD",
        "regular_price": 769.99,
        "final_price": 769.99,
        "on_sale": false,
        "sale_discount": 0,
        "availability": "InStock",
        "sku": null,
        "brand": "DecorumBY",
        "category": "Home & Garden > Decor > Artwork; Home & Garden > Home Decor > Wall Art",
        "network": {
          "id": 3,
          "name": "CJ US",
          "logo_url": "https://img.affiliate.com/logos/groups/10013/128x128.png"
        },
        "merchant": {
          "id": 9998,
          "name": "Wayfair",
          "logo_url": "https://img.affiliate.com/logos/merchants/9998/logo.png"
        },
        "updated_at": "2025-04-17 04:46:36"
      }
    ]
  },
  "meta": {
    "trace_id": "019643f2-b64c-71a4-8bfd-092af3e318f7"
  }
}

Response fields

object

The list and its products.

Show data properties

string

Unique list identifier.

string

List display name.

object

Key:value metadata pairs associated with this list.

integer

Number of products in the list.

array

Full product objects. See the product fields table below.

object

Show meta properties

string

Unique request identifier. Include this when contacting support.

Product object fields

Each item in data.products contains the following fields.

Field	Type	Description
`id`	string	Unique product identifier
`barcode`	integer \| null	UPC, EAN, or GTIN barcode
`name`	string	Product title
`description`	string	Full product description
`commission_url`	string	Affiliate URL — replace `@@@` with your affiliate ID and `###` with your sub-ID
`direct_url`	string	Direct merchant URL (no commission)
`image_url`	string	Primary product image URL
`currency`	string	ISO 4217 currency code (e.g., `USD`)
`regular_price`	number	Original retail price
`final_price`	number	Current price after any discounts
`on_sale`	boolean	`true` when a sale discount is active
`sale_discount`	integer	Discount percentage
`availability`	string	Stock status (e.g., `InStock`, `OutOfStock`)
`sku`	integer \| null	Merchant stock-keeping unit
`brand`	string	Brand name
`category`	string	Hierarchical category path
`network.id`	integer	Affiliate network ID
`network.name`	string	Affiliate network name
`network.logo_url`	string	Network logo URL
`merchant.id`	integer	Merchant ID
`merchant.name`	string	Merchant display name
`merchant.logo_url`	string	Merchant logo URL
`updated_at`	string	Timestamp when the product was last refreshed from the merchant feed

Account

Networks

Merchants

Products

Tools

Watches

Product Lists

Pools

Reports

GET /v1/products/lists/{id} — get list with products

Request

Headers

Path parameters

Example request

Response

Response fields

Product object fields

​Request

​Headers

​Path parameters

​Example request

​Response

​Response fields

​Product object fields

Request

Headers

Path parameters

Example request

Response

Response fields

Product object fields