Product API Overview

The API is designed to provide a way to search for and retrieve information about products available for sale from various affiliate merchants and networks. It supports filtering, sorting, pagination, and faceted search capabilities, allowing users to tailor their queries to specific needs. This API is ideal for developers looking to integrate product search functionality into their applications, providing users with the ability to find and view product information efficiently.

Endpoint

POST /v1/products

API Description

The API allows users to query a database of over 1 billion products based on various criteria. These products are refreshed daily. Users can specify which fields to include in the response, how many results to return per page, and how to sort the results. Additionally, users can filter out specific networks and merchants, and provide detailed search criteria to find exactly what they need. The API supports multiple networks and allows for specific configurations per network.

Features

Field Selection: Specify which product fields to include in the response.

Pagination: Control the number of results returned per page.

Sorting: Sort the results based on specific fields in ascending or descending order.

Exclusion Filters: Exclude certain networks and merchants from the results.

Network-Specific Configurations: Provide specific configurations for different networks to use your own affiliate IDs and subIDs.

Advanced Search: Use detailed search criteria to filter products based on field values and operators.

Faceted Search: Retrieve aggregated statistics and metadata about networks and merchants in your search results.

Benefits

Customization: Tailor the search and results to meet specific needs.

Efficiency: Quickly find relevant products using detailed filters and sorting options.

Flexibility: Support for multiple networks with specific configurations.

Analytics: Use facets to understand the composition of search results and available options.

Query Builder

Need help building queries? Visit https://my.affiliate.com/query-builder to create and customize queries and even test them right there!

Request Format

Endpoint: /v1/products

Method: POST

Headers:

Content-Type: application/json

Authorization: Bearer {your_api_key}

Request Body Parameters

Parameter Name	Type	Required	Description	Example
`fields`	Array of Strings or String	No	Limit the fields that are displayed in the result.	`["id", "name", "final_price"]`
`per_page`	Integer	No	The number of results to be returned per page. Minimum Value: 1, Maximum Value: Depends on subscription. Default is 100	`10`
`page`	Integer	No	The page number of results returned for pagination requests. Minimum Value: 1, Maximum Value: Depends on subscription.	`2`
`after`	String	No	For plans that allow results over 10000, this parameter will be used to paginate past 10000 products using a system generated ID.	`2`
`sort_by`	String	No	The field by which the results should be sorted. Must be one of: `relevance`, `id`, `barcode`, `name`, `description`, `commission_url`, `direct_url`, `image_url`, `currency`, `regular_price`, `final_price`, `on_sale`, `sale_discount`, `availability`, `stock_quantity`, `sku`, `brand`, `category`, `network`, `merchant`, `updated_at`, `started_at`	`final_price`
`sort_order`	String	No	The order by which the results should be sorted. Allowed Values: "asc", "desc"	`asc`
`networks`	Object	No (but recommended)	Object containing network-specific configurations for affiliate links. If omitted, the API will return commission_urls containing @@@ and ###. If provided, the API will validate the data to ensure it's in the correct format. For most networks, the system will check that each network config item includes an affiliate_id. For networks with additional configurations, the system will verify that each config item contains the necessary information: Adservice: `mid`, AffiliateGateway: `site_id`, Belboon: `adspace_id`, Effiliation: `api_key`, Partnerize: `application_key, user_api_key, publisher_id`	`{"329": {"affiliate_id": "yyyyyyyyyyyyyyyyyyy", "sub_id": "zzzzzzzzzzzzzzzzzzzz"}}`
`network_ids`	Array of Integers	No	Explicit list of network IDs to include in results. See Networks API Endpoint for IDs * Deprecated**: See network filter below.	`[1, 2, 3]`
`merchant_ids`	Array of Integers	No	Explicit list of merchant IDs to include in results. See Merchants API Endpoint for IDs * Deprecated**: See merchant filter below.	`[1000, 1100, 1200]`
`exclude_network_ids`	Array of Integers	No	List of network IDs to exclude from results. See Networks API Endpoint for IDs * Deprecated**: See network filter below.	`[1, 2, 3]`
`exclude_merchant_ids`	Array of Integers	No	List of merchant IDs to exclude from results. See Merchants API Endpoint for IDs * Deprecated**: See merchant filter below.	`[1000, 1100, 1200]`
`duplicate_fields_to_exclude`	Comma Separated String	No	Remove duplicate results based on field values. Supports optional limit syntax `field[limit]` to cap results per unique value. Fields: `name`, `image_url`, `direct_url`, `barcode`, `merchant.id`.	`"name,image_url"`
`balanced_mix`	Object	No	Advanced result balancing with round-robin interleaving and optional weighting. Allows fine-grained control over result diversity by field (e.g., limit products per merchant with customizable priorities).	See balanced_mix section
`search`	Array of Objects or String	Yes	Search criteria for products. Can be a simple string query where Affiliate API interpreter determines field you are querying (barcode, direct_url, or any), or a complex query object to refine specific products.	See search fields table below
`click_tracking`	Boolean	No	Default value is `false`. This feature will replace your subid with our `click_id` to provide 360 degree consolidated reporting.	`{"networks":{"10": {"affiliate_id": "aaaa", "click_tracking": true}}}`
`facets`	String	No	Comma-separated list of facets to include in the response. Supports dot notation for nested fields. Available facets: `network`, `merchant`, `network.name`, `network.logo_url`, `merchant.product_count`, `final_price`,etc. Default is `null` (no facets).	`"network,merchant"` or `"network.name,merchant.product_count"`
~~`use_short_url`~~ (deprecated)	Boolean	No	Depending on your api subscription, this will provide the ability to commisionable urls that you will programatically alter to input your affiliate information	**See urls object

Facets Parameter

The facets parameter allows you to retrieve aggregated information about the networks and merchants in your search results. This is useful for:

Building dynamic filter interfaces

Understanding the composition of search results

Displaying available options to users

Analytics and reporting

Supported Facet Types

network - Returns complete network information and statistics

merchant - Returns complete merchant information and statistics

Dot Notation Support

You can use dot notation to request specific fields from facet objects:

network.name - Only network names

network.logo_url - Only network logo URLs

merchant.product_count - Only product counts per merchant

Examples

Basic facets:

{
  "search": [{ "field": "name", "value": "laptop", "operator": "LIKE" }],
  "facets": ["network", "merchant"],
  "per_page": 10
}

Specific fields with dot notation:

{
  "search": [{ "field": "brand", "value": "nike", "operator": "=" }],
  "facets": ["network.name", "network.logo_url", "merchant.product_count"],
  "per_page": 10
}

Duplicate Fields to Exclude Parameter

The duplicate_fields_to_exclude parameter allows you to remove duplicate results and optionally limit the number of results per unique field value.

Supported fields:

name - Product name

image_url - Product image URL

direct_url - Direct merchant URL

barcode - Product barcode (UPC, EAN, etc.)

merchant.id - Merchant identifier

Basic usage (removes all duplicates, keeping only 1 per unique value):

{
  "duplicate_fields_to_exclude": "name,merchant.id"
}

With limits (cap the number of results per unique value):

{
  "duplicate_fields_to_exclude": "merchant.id[25]"
}

This keeps up to 25 products per merchant.

Combined example:

{
  "search": [{ "field": "name", "value": "laptop", "operator": "LIKE" }],
  "duplicate_fields_to_exclude": "name,merchant.id[10]",
  "per_page": 50
}

Balanced Mix Parameter

The balanced_mix parameter provides advanced control over result diversity with round-robin interleaving and optional weighting. This is ideal when you want a balanced mix of results across different values (e.g., merchants) rather than being dominated by high-volume sources.

Use cases:

Prevent a single large merchant from dominating results

Promote smaller merchants for better diversity

Deprioritize specific merchants while still including them

Create a more balanced shopping experience

Parameters

Field	Type	Required	Description
`field`	String	Yes	The field to balance by (e.g., `merchant.id`, `network.id`, `name`, `barcode`,`currency`, `image_url`, `brand`, `direct_url`)
`max_per_value`	Integer	Yes	Maximum number of results per unique field value
`interleave`	Boolean	No	If `true`, results are distributed in round-robin fashion. Default: `false`
`weights`	Object	No	Optional weight multipliers per value. Format: `{"value_id": multiplier}`. Values not specified default to 1.0

Basic Example

{
  "search": [{ "field": "name", "value": "laptop", "operator": "LIKE" }],
  "balanced_mix": {
    "field": "merchant.id",
    "max_per_value": 5,
    "interleave": true
  },
  "per_page": 50
}

This returns up to 5 products per merchant, distributed evenly across merchants.

Advanced Example with Weights

{
  "per_page": 20,
  "balanced_mix": {
    "field": "merchant.id",
    "max_per_value": 3,
    "interleave": true,
    "weights": {
      "102445": 2.0,
      "102478": 0.5
    }
  }
}

In this example:

Merchant 102445 gets 2x priority (appears more frequently in rotation)

Merchant 102478 gets 0.5x priority (appears less frequently)

All other merchants get default 1.0 weight

Real-World Example: Prioritizing Target over Best Buy

This example shows how to search for stainless steel bottles while prioritizing Target (2x weight) over Best Buy (1.1x weight):

{
  "page": 1,
  "per_page": 10,
  "sort_by": "relevance",
  "sort_order": "asc",
  "balanced_mix": {
    "field": "merchant.id",
    "max_per_value": "3",
    "interleave": true,
    "weights": {
      "54419": "2",
      "41357": "1.1"
    }
  },
  "networks": {
    "335": {
      "affiliate_id": "your_affiliate_id",
      "sub_id": "your_sub_id"
    }
  },
  "search": [
    {
      "field": "any",
      "value": "stainless steel bottle",
      "operator": "like"
    },
    {
      "field": "network.id",
      "operator": "=",
      "value": "335"
    },
    {
      "field": "merchant.id",
      "operator": "=",
      "value": "54419||41357"
    }
  ]
}

This query:

Searches for "stainless steel bottle" products

Filters to network 335 (Impact US) and merchants Target (54419) and Best Buy (41357)

Gives Target ~2x priority over Best Buy (2.0 vs 1.1)

Interleaves results so Target products appear first and more frequently

Caps at 3 products per merchant

Comparison: duplicate_fields_to_exclude vs balanced_mix

Important: The balanced_mix parameter cannot be used together with duplicate_fields_to_exclude. Please use one or the other.

Feature	`duplicate_fields_to_exclude`	`balanced_mix`
Limit per value	Yes (with `[limit]` syntax)	Yes (`max_per_value`)
Round-robin interleaving	No	Yes (`interleave: true`)
Weighted priorities	No	Yes (`weights`)
Multiple fields	Yes (comma-separated)	No (single field)
Use case	Simple deduplication	Advanced result balancing

Search Fields and Operators

Field	Operators	Notes
`id`	`=`, `!=`
`any`	`LIKE`	Searches across multiple fields including id, barcode, mpn, sku, asin, name, description, direct_url, ref_url, image, brand, category, size, color, condition, gender, material, model, manufacturer, author, artist, publisher, tags, network_name, merchant_name. Supports stemming.
`barcode`	`=`, `!=`	Case-sensitive
`sku`	`=`, `!=`, `LIKE`	Case-sensitive
`network.id`	`=`, `!=`
`merchant.id`	`=`, `!=`
`network.name`	`=`, `!=`, `LIKE`, `NOT LIKE`
`merchant.name`	`=`, `!=`, `LIKE`, `NOT LIKE`
`name`	`=`, `!=`, `LIKE`, `NOT LIKE`
`description`	`LIKE`, `NOT LIKE`
`direct_url`	`LIKE`, `=`, `NOT NULL`	Domain-only URLs (e.g. www.apple.com) and Product Page URLs supported
`image_url`	`=`, `!=`
`commission_url`	`=`, `!=`
`currency`	`=`, `!=`	USD, EUR, GBP, AUD, DKK, SEK, CHF, NOK, CAD, RUB, BRL, PLN, RON, NZD, UAH, HUF, CZK, SGD, BGN, MYR, TWD, HKD, IDR, AED, INR, CNY, JPY, TRY, KRW, MXN
`final_price`	`=`, `!=`, `>`, `<`, `>=`, `<=`
`regular_price`	`=`, `!=`, `>`, `<`, `>=`, `<=`
`on_sale`	`=`
`sale_discount`	`=`, `!=`, `>`, `<`, `>=`, `<=`
`availability`	`=`	`InStock`,`OutOfStock`
`stock_quantity`	`=`, `!=`, `>`, `<`, `>=`, `<=`
`brand`	`=`, `!=`, `LIKE`, `NOT LIKE`
`category`	`=`, `!=`, `LIKE`, `NOT LIKE`
`color`	`=`, `!=`, `LIKE`, `NOT LIKE`
`condition`	`=`, `!=`, `LIKE`, `NOT LIKE`
`country`	`=`, `!=`, `LIKE`, `NOT LIKE`
`gender`	`=`, `!=`, `LIKE`, `NOT LIKE`
`genre`	`=`, `!=`, `LIKE`, `NOT LIKE`
`manufacturer`	`=`, `!=`, `LIKE`, `NOT LIKE`
`model`	`=`, `!=`, `LIKE`, `NOT LIKE`
`size`	`=`, `!=`, `LIKE`, `NOT LIKE`
`material`	`=`, `!=`, `LIKE`, `NOT LIKE`
`asin`	`=`, `!=`	Amazon Seller Networks Only, Case-sensitive
`mpn`	`=`, `!=`	Case-sensitive
`tags`	`=`, `!=`, `LIKE`, `NOT LIKE`
`publisher`	`=`, `!=`, `LIKE`, `NOT LIKE`
`subtitle`	`=`, `!=`, `LIKE`, `NOT LIKE`
`commissionable_status`	`=`
`author`	`=`, `!=`, `LIKE`, `NOT LIKE`
`artist`	`=`, `!=`, `LIKE`, `NOT LIKE`
`seller_party`	`=`	`1st`, `3rd`, `unknown`
`started_at`	`=`, `>`, `<`, `>=`, `<=`, `<>`	YYYY-MM-DD format
`updated_at`	`=`, `>`, `<`, `>=`, `<=`, `<>`	YYYY-MM-DD format

Search Examples

Simple string search:

"search": "JBL Speaker"

Complex query object:

"search": [
  {
    "field": "on_sale",
    "value": true
  },
  {
    "field": "currency",
    "value": "GBP||EUR",
    "operator": "="
  },
  {
    "field": "name||description",
    "value": "Pet||Dog||Cat",
    "operator": "LIKE"
  },
  {
    "field": "brand",
    "value": "Chopard||Unknown",
    "operator": "NOT LIKE"
  },
  {
    "field": "regular_price",
    "value": "2000",
    "operator": ">"
  }
]

Search Notes:

To search for multiple values, use || (LOGICAL OR)

To AND values, create separate field objects

Omitted search operators will default to =

Most API search fields support case-insensitive searching except for: barcode, sku, mpn, asin

Response Format

{
  "meta": {
    "total": 150,
    "from": 1,
    "to": 10,
    "current_page": 1,
    "last_page": 15,
    "per_page": 10,
    "fields": [
      "id",
      "barcode",
      "name",
      "description",
      "commission_url",
      "direct_url",
      "image_url",
      "urls",
      "currency",
      "regular_price",
      "final_price",
      "on_sale",
      "sale_discount",
      "availability",
      "stock_quantity",
      "commissionable_status",
      "mpn",
      "sku",
      "brand",
      "category",
      "size",
      "color",
      "gender",
      "material",
      "country",
      "condition",
      "genre",
      "manufacturer",
      "model",
      "author",
      "artist",
      "tags",
      "network",
      "merchant",
      "updated_at",
      "started_at"
    ],
    "after": null,
    "sort_by": "finalprice",
    "sort_order": "desc",
    "trace_id": "01988abc-1234-5678-9def-123456789012"
  },
  "facets": {
    "networks": [
      {
        "id": 314,
        "name": "Awin US",
        "url": "https://www.awin.com",
        "logo_url": "https://img.affiliate.com/logos/groups/10013/128x128.png",
        "merchant_count": 310,
        "merchant_count_active": 225,
        "product_count": 63030351,
        "group": {
          "id": 10013,
          "name": "Awin"
        },
        "country": {
          "id": "US",
          "iso3": "USA",
          "name": "United States"
        }
      }
    ],
    "merchants": [
      {
        "id": 13581,
        "name": "KitchenAid",
        "description": "Premium kitchen appliances",
        "domains": ["www.kitchenaid.com"],
        "icon_url": "https://cdn.merchant-logos.com/kitchenaid/icon.png",
        "logo_url": "https://cdn.merchant-logos.com/kitchenaid/logo.png",
        "product_count": 269,
        "origin_id": "12345",
        "network": {
          "id": 314,
          "name": "Awin US",
          "url": "https://www.awin.com",
          "logo_url": "https://img.affiliate.com/logos/groups/10013/128x128.png"
        }
      }
    ]
  },
  "data": [
    {
      "id": "prod_12345678901234567890",
      "barcode": "1234567890123",
      "name": "Professional Outdoor Storage Shelter 60'x40'x15'",
      "description": "Heavy-duty waterproof storage shelter...",
      "commission_url": "https://outclick.co/a/eyJpdiI6IlkxOFQyZHo1ZHdtU2I1L0Fjd3JNcXc9PSIsInZhbHVlIjoiNnZoWFRqTk55cHZkTHpxYW96LzdqYlRJbU1KV2xsWkJTc21PYVl6cUZncTk5aC9MQTZyYUVkMkdKbjJwMHpLVTJYR2I1dEkyYW1PKzRldU9HemtXbk9SbWFqeXBmTG5ZT29EMDZVTnRBUnR2b3p6NFVReHVod2FXZmNwZUxSSXhSVFBXNCtIUWVCZ056RHlLdVNydXF2cENRU25pYzYwSVozS1FzKzlmVU1FRFpybmJhSVYzNmJOT09OZksvT0g4KytMWHV4WkJUWkl6YlM4bkkyU0hrS0NyUjRYOEtacEJmeG5NejZRaktzbWRRRExhT0g4QU82VFRieDIydmVpUFkzSGNKMVB6Q3F1TUVZM2FPd09JcjN3MFpNQ0pNN045a3Brdkd2Mzdwc1FoZ0xTRGNqZG52QXY4UlRvMDhIK0ZCa0hoRVVsd0xEaXdkUHExbThIaTU3L3NnclRWTXBvTEJzaXdHUmVpd0RqK01MYjNodW9mbUNTRUxQRFBKbDhGTXJ5REZ1cnNSOVVJdm1LbmRWYllQU0tlQklZbE8xTnVvRUxmQXdaaTRvTDArcnZMbGVJalVwSTZaQUZHTjh3bEtvYnVzUzJLY1BNeWMvNjE4a1RlUHFxN2twSG85VDYrU0I1WWR3c2h4cGdzaG5RcHhoNURvRDhzY2JVNmNwZkRHTEt4QkFTS1lDWDRjb1dHakJuS3N3OVJLdEYyQ2xOKzlJTlFqQzdvcFg4OUVhNVhhUWE4NVFoQzFtaGl2REVxb2dUb29wU2RPVC9wbU8rb05ScDEzR0VFVnphenFwd3VDYlByQVRsZTZ0dXZxc2k2ZWx6Y2RIejVjN3NkWThib2FiMXFXNGtsRjZVeFJsaHhxQ3ZqUHdrSHR0b29nZ3JlMzNyUnM2TERSc3IvM3pBNTNJak9VSWpnaTBqV2tmWFRRQlBwVThYc2lnMElCeTlDVzZoTkwvK3BrL3p3Y2wwb09uTTUzckdmMnRNSWpld2ZOU1VrRG9BTU9wN3Y2ZXJjSnh1N1FIdU4xMzFUcGliUlE4eDFPQVpZU1hGV0ZDWEZVZWtTaU1wdnFUQWVkcTd0TkNGekl4Y3YzNEZoMzY4dzJQZTk4Z3pkZjlIL3pCUVk3T3duMGxNMWN0WjlGRENIeklqOUxzZFZmQUIwQWtOV2piWHNyRGViVE1yY1M2ZjZPa0V4NVFlTUxQWEpvdTRQeVIyWmFHUE5FeVlpd3ZKZHl1Vmx1NHFTeHI4RENudk8yczg3Y1FmOWUzTGRaVS9CZ0xNcW9aeHlOekx2QWdwUTRVRGVNdW9ZdUdrREFOekZCU0VRUDVkenQvRT0iLCJtYWMiOiIyOTc4YmZmNTY4ZGE5NTdjMGZiMDlhM2E1MmVhNzE3NTg5NTcyZmJkOTk2MDMwNDEzZmZmMTFmMTY2MTU4NDJlIiwidGFnIjoiIn0=?affiliate_id=@@@&sub_id=###"",
      "direct_url": "https://shop.example-retailer.com/products/outdoor-shelter-60x40x15",
      "image_url": "https://cdn.example-retailer.com/images/shelter-main-view.jpg",
      "urls": {
        "outclick":  "https://outclick.co/a/eyJpdiI6IlkxOFQyZHo1ZHdtU2I1L0Fjd3JNcXc9PSIsInZhbHVlIjoiNnZoWFRqTk55cHZkTHpxYW96LzdqYlRJbU1KV2xsWkJTc21PYVl6cUZncTk5aC9MQTZyYUVkMkdKbjJwMHpLVTJYR2I1dEkyYW1PKzRldU9HemtXbk9SbWFqeXBmTG5ZT29EMDZVTnRBUnR2b3p6NFVReHVod2FXZmNwZUxSSXhSVFBXNCtIUWVCZ056RHlLdVNydXF2cENRU25pYzYwSVozS1FzKzlmVU1FRFpybmJhSVYzNmJOT09OZksvT0g4KytMWHV4WkJUWkl6YlM4bkkyU0hrS0NyUjRYOEtacEJmeG5NejZRaktzbWRRRExhT0g4QU82VFRieDIydmVpUFkzSGNKMVB6Q3F1TUVZM2FPd09JcjN3MFpNQ0pNN045a3Brdkd2Mzdwc1FoZ0xTRGNqZG52QXY4UlRvMDhIK0ZCa0hoRVVsd0xEaXdkUHExbThIaTU3L3NnclRWTXBvTEJzaXdHUmVpd0RqK01MYjNodW9mbUNTRUxQRFBKbDhGTXJ5REZ1cnNSOVVJdm1LbmRWYllQU0tlQklZbE8xTnVvRUxmQXdaaTRvTDArcnZMbGVJalVwSTZaQUZHTjh3bEtvYnVzUzJLY1BNeWMvNjE4a1RlUHFxN2twSG85VDYrU0I1WWR3c2h4cGdzaG5RcHhoNURvRDhzY2JVNmNwZkRHTEt4QkFTS1lDWDRjb1dHakJuS3N3OVJLdEYyQ2xOKzlJTlFqQzdvcFg4OUVhNVhhUWE4NVFoQzFtaGl2REVxb2dUb29wU2RPVC9wbU8rb05ScDEzR0VFVnphenFwd3VDYlByQVRsZTZ0dXZxc2k2ZWx6Y2RIejVjN3NkWThib2FiMXFXNGtsRjZVeFJsaHhxQ3ZqUHdrSHR0b29nZ3JlMzNyUnM2TERSc3IvM3pBNTNJak9VSWpnaTBqV2tmWFRRQlBwVThYc2lnMElCeTlDVzZoTkwvK3BrL3p3Y2wwb09uTTUzckdmMnRNSWpld2ZOU1VrRG9BTU9wN3Y2ZXJjSnh1N1FIdU4xMzFUcGliUlE4eDFPQVpZU1hGV0ZDWEZVZWtTaU1wdnFUQWVkcTd0TkNGekl4Y3YzNEZoMzY4dzJQZTk4Z3pkZjlIL3pCUVk3T3duMGxNMWN0WjlGRENIeklqOUxzZFZmQUIwQWtOV2piWHNyRGViVE1yY1M2ZjZPa0V4NVFlTUxQWEpvdTRQeVIyWmFHUE5FeVlpd3ZKZHl1Vmx1NHFTeHI4RENudk8yczg3Y1FmOWUzTGRaVS9CZ0xNcW9aeHlOekx2QWdwUTRVRGVNdW9ZdUdrREFOekZCU0VRUDVkenQvRT0iLCJtYWMiOiIyOTc4YmZmNTY4ZGE5NTdjMGZiMDlhM2E1MmVhNzE3NTg5NTcyZmJkOTk2MDMwNDEzZmZmMTFmMTY2MTU4NDJlIiwidGFnIjoiIn0=" ,
        "direct": "https://shop.example-retailer.com/products/outdoor-shelter-60x40x15",
        "affiliate": "https://partners.example-network.com/click?merchant=12345&product=67890&aff=@@@",
        "shopnomix": "https://r.v2i8b.com/api/v1/bid/redirect?url=http%3A%2F%2Fs.click.aliexpress.com%2Fdeep_link.htm%3Faff_short_key%3D7EM7auF%25af%3D%61%21%21id%21%21%21%26dp%3D%21%21%21awc%21%21%21%26cn%3D14044%26Afref%3D%21%21%21sitename%21%21%21%26dl_target_url%3Dhttps%253A%252F%252Fwww.aliexpress.com%254Fitem%252F1005009533217906.html%253Fpdp_npi%253D4%252540dis%252521USD%25252120000.08%25252110000.04%252521%252521%252521142959.86%25252171479.93%252521%252540214fb86917547433428292241e%25252112000049387574044%252521affd%252521%253521%252521"
      },
      "currency": "USD",
      "regular_price": 12599,
      "final_price": 11999,
      "on_sale": true,
      "sale_discount": 5,
      "availability": "InStock",
      "stock_quantity": 25,
      "commissionable_status": "confirmed_commissionable",
      "seller_party": "first",
      "mpn": "OS-60-40-15-HD",
      "sku": "SHELTER60401522",
      "brand": "ProShelter Industries",
      "category": "Home & Garden > Outdoor Storage > Shelters",
      "size": "60' x 40' x 15'",
      "color": "Green",
      "gender": null,
      "material": "Steel Frame, PVC Tarpaulin",
      "country": "USA",
      "condition": "new",
      "genre": null,
      "manufacturer": "ProShelter Industries",
      "model": "PS-604015-DT",
      "author": null,
      "artist": null,
      "tags": ["outdoor", "storage", "commercial", "waterproof"],
      "network": {
        "id": 123,
        "name": "ExampleAffiliate Network",
        "logo_url": "https://cdn.affiliate-logos.com/networks/example/128x128.png"
      },
      "merchant": {
        "id": 45678,
        "name": "Example Industrial Supply Co.",
        "logo_url": "https://cdn.merchant-logos.com/example-industrial/logo.png"
      },
      "updated_at": "2025-08-06 15:54:53",
      "started_at": "2025-08-06 15:54:53"
    }
  ]
}

Response Fields

Main Response

Field Name	Type	Description
`meta`	object	Metadata about the pagination and search results
`facets`	object	Aggregated statistics and metadata about networks and merchants (only present when `facets` parameter is used)
`data`	array	The array of products

Meta Object

Field Name	Type	Description
`total`	integer	The total number of items matching the search criteria
`from`	integer	The starting position of the current page results
`to`	integer	The ending position of the current page results
`current_page`	integer	The current page number
`last_page`	integer	The last available page number
`per_page`	integer	The number of items per page
`fields`	array	List of fields included in the response
`after`	string	Pagination cursor for results beyond 10,000 items
`sort_by`	string	The field used for sorting results
`sort_order`	string	The sort direction (asc/desc)
`trace_id`	string	Unique identifier for tracking the request

Facets Object

The facets object provides aggregated information about the networks and merchants represented in your search results. This object is only present when the facets parameter is included in the request.

Networks Facet

Field Name	Type	Description
`facets.networks`	array	Array of network objects with aggregated statistics
`networks[].id`	integer	Unique network identifier
`networks[].name`	string	Network display name
`networks[].url`	string	Network website URL
`networks[].logo_url`	string	Network logo image URL
`networks[].merchant_count`	integer	Total number of merchants in this network
`networks[].merchant_count_active`	integer	Number of active merchants in this network
`networks[].product_count`	integer	Total number of products available from this network
`networks[].group`	object	Network group information
`networks[].group.id`	integer	Network group identifier
`networks[].group.name`	string	Network group name
`networks[].country`	object	Network country information
`networks[].country.id`	string	Two-letter country code
`networks[].country.iso3`	string	Three-letter country code
`networks[].country.name`	string	Country display name

Merchants Facet

Field Name	Type	Description
`facets.merchants`	array	Array of merchant objects with aggregated statistics
`merchants[].id`	integer	Unique merchant identifier
`merchants[].name`	string	Merchant display name
`merchants[].description`	string	Merchant description
`merchants[].domains`	array	Array of merchant website domains
`merchants[].icon_url`	string	Merchant icon image URL
`merchants[].logo_url`	string	Merchant logo image URL
`merchants[].product_count`	integer	Number of products available from this merchant
`merchants[].origin_id`	string	Original merchant identifier from the network
`merchants[].network`	object	Network information for this merchant
`merchants[].network.id`	integer	Network identifier
`merchants[].network.name`	string	Network name
`merchants[].network.url`	string	Network website URL
`merchants[].network.logo_url`	string	Network logo URL

Product Object

Core Product Information

Field Name	Type	Description
`id`	string	Unique Product Identifier - A system-generated unique identifier for the product across all networks and merchants.
`barcode`	string	Product Barcode - The standardized product identifier (UPC, EAN, ISBN, GTIN). Used for exact product matching across different merchants
`name`	string	Product Title - The primary product name as provided by the merchant. This is the main display title for the product
`description`	string	Product Description - Detailed product description including features, specifications, and benefits as provided by the merchant
`commissionable_status`	string	Commission Eligibility - Indicates commission earning potential: • `confirmed_commissionable` - Verified commission earning • `assumed_commissionable` - Likely commission earning • `commissionable` - Commission earning available • `not_commissionable` - No commission available

URL and Tracking Information

Field Name	Type	Description
`commission_url`	string	Legacy Affiliate URL - Basic affiliate tracking URL with placeholders. Replace `@@@` with your affiliate ID and `###` with your subID. Note: Consider using the `urls` object for more advanced options
`direct_url`	string	Direct Merchant URL - The unaffiliated URL directly to the product page on the merchant's website. No affiliate commissions will be earned from this URL
`image_url`	string	Primary Product Image - URL to the main product image. Typically the first or featured image from the merchant's product listing
`urls`	object	Advanced URL Collection - Contains multiple URL types including enhanced tracking, direct links, and specialized routing options. See URLs Object section below

Pricing Information

Field Name	Type	Description
`currency`	string	Price Currency - Three-letter ISO currency code (e.g., USD, EUR, GBP) indicating the currency for all price fields
`regular_price`	integer	Original Price - The standard retail price in the smallest currency unit (cents for USD, pence for GBP, etc.). This is the price before any discounts
`final_price`	integer	Current Sale Price - The actual selling price after applying any discounts, in the smallest currency unit. This is what customers will pay
`on_sale`	boolean	Sale Status - Indicates whether the product is currently on sale or discounted (`true` = on sale, `false` = regular price)
`sale_discount`	integer	Discount Percentage - The percentage discount applied to the regular price.

Inventory and Availability

Field Name	Type	Description
`availability`	string	Stock Status - Current availability status. Values: `InStock` (available for purchase), `OutOfStock` (temporarily unavailable)
`stock_quantity`	integer	Available Quantity - Number of units currently available for purchase. May be `null` if merchant doesn't provide stock levels

Product Identifiers

Field Name	Type	Description
`mpn`	string	Manufacturer Part Number - Unique identifier assigned by the product manufacturer. Case-sensitive and useful for exact product matching
`sku`	string	Stock Keeping Unit - Merchant-specific product identifier used for inventory management. Case-sensitive

Product Attributes

Field Name	Type	Description
`brand`	string	Product Brand - The brand or manufacturer name associated with the product
`category`	string	Product Category - Hierarchical category path (e.g., "Home & Garden > Outdoor Storage > Shelters") showing product classification
`size`	string	Product Size - Physical dimensions or size designation as specified by the merchant (e.g., "Large", "60' x 40' x 15'")
`color`	string	Product Color - Color designation or description as provided by the merchant
`gender`	string	Target Gender - Intended gender demographic for the product (e.g., "Men", "Women", "Unisex"). May be `null` for non-gender-specific items
`material`	string	Primary Materials - Main materials used in product construction (e.g., "Steel Frame, PVC Tarpaulin", "100% Cotton")
`country`	string	Country of Origin - Country where the product was manufactured or originated
`condition`	string	Product Condition - Current state of the product. Common values: `new`, `used`, `refurbished`, `open-box`
`seller_party`	string	1P vs 3P - Identifier to indicate if this product is sold as first party vs thirs party. Common values: `first`

Specialized Attributes

Field Name	Type	Description
`genre`	string	Product Genre - Classification typically used for media products (books, music, movies). May be `null` for non-media items
`manufacturer`	string	Manufacturer Name - Company or entity that manufactured the product. May differ from brand for licensed products
`model`	string	Model Designation - Specific model name or number assigned by the manufacturer
`author`	string	Author Name - Author information, primarily for books, written content, or educational materials
`artist`	string	Artist Name - Artist information, typically for music, art, or creative content
`tags`	array	Descriptive Tags - Array of keywords and descriptive terms associated with the product, useful for search and categorization

Network and Merchant Information

Field Name	Type	Description
`network`	object	Affiliate Network Details - Information about the affiliate network providing this product listing
`network.id`	integer	Network ID - Unique identifier for the affiliate network
`network.name`	string	Network Name - Display name of the affiliate network
`network.logo_url`	string	Network Logo - URL to the affiliate network's logo image
`merchant`	object	Merchant Details - Information about the retailer or seller offering this product
`merchant.id`	integer	Merchant ID - Unique identifier for the merchant within the network
`merchant.name`	string	Merchant Name - Display name of the retailer or seller
`merchant.logo_url`	string	Merchant Logo - URL to the merchant's logo or brand image

System Information

Field Name	Type	Description
`updated_at`	string	Last Updated - ISO timestamp indicating when the product information was last refreshed from the merchant feed
`started_at`	string	When the product first appeared from - ISO timestamp indicating when the product was initially advertised by the merchant

URLs Object Detailed Breakdown

The urls object provides multiple access methods for the same product:

Field Name	Type	Description
`urls.outclick`	string	Enhanced Tracking URL - Advanced tracking URL with analytics capabilities and dynamic routing options. Supports query parameters for format control
`urls.direct`	string	No-Tracking URL - Direct link to merchant without any affiliate tracking. Use when affiliate commission is not desired
`urls.affiliate`	string	Standard Affiliate URL - Traditional affiliate tracking URL from the network. Replace `@@@` with affiliate ID and `###` with subID
`urls.shopnomix`	string	Shopnomix Integration - Specialized URL for Shopnomix platform integration (available for supported products)

Outclick URL Dynamic Parameters

The outclick URL supports runtime modification through query parameters:

Parameter	Effect	Use Case
`?format=direct`	Redirects to direct merchant URL	Price comparison, no commission needed
`?format=affiliate`	Redirects to affiliate URL (default)	Standard affiliate tracking
`?format=shopnomix`	Redirects to Shopnomix URL	Shopnomix platform integration
`?sub_id=VALUE`	Override subID for tracking	Campaign-specific attribution

Field Usage Notes

Price Handling

All price fields use the smallest currency unit (cents, pence, etc.)

To display prices: divide by 100 for most currencies

Always check the currency field for proper formatting

Case Sensitivity

Case-sensitive fields: barcode, sku, mpn, asin

Case-insensitive fields: Most other text fields

Null Values

Optional fields may contain null values

Always check for null before processing field data

Empty strings vs null may have different meanings

Network Object

Field Name	Type	Description
`network.id`	integer	The unique identifier of the network
`network.name`	string	The name of the network
`network.logo_url`	string	The URL of the network's logo

Merchant Object

Field Name	Type	Description
`merchant.id`	integer	The unique identifier of the merchant
`merchant.name`	string	The name of the merchant
`merchant.logo_url`	string	The URL of the merchant's logo

Links Object

Field Name	Type	Description
`links.self`	string	The current request URL
`links.first`	string	The URL of the first page
`links.last`	string	The URL of the last page
`links.prev`	string	The URL of the previous page (null if on first page)
`links.next`	string	The URL of the next page (null if on last page)

Use Cases and Examples

1. Simple Product Search with ANY Field

Searching for any product related to "iPhone 14" across all available fields (great for product searches):

{
  "search": [
    {
      "field": "any",
      "value": "iPhone 14",
      "operator": "LIKE"
    }
  ],
  "per_page": 20,
  "sort_by": "final_price",
  "sort_order": "asc"
}

This simple search will find products where "iPhone" appears in any searchable field including name, description, brand, category, tags, SKU, barcode, and more.

2. Barcode and SKU Lookup

Finding specific products using exact identifiers (great for price comparisons):

{
  "search": [
    {
      "field": "barcode",
      "value": "1234567890123",
      "operator": "="
    }
  ],
  "fields": ["id", "name", "brand", "final_price", "availability", "urls"]
}

Or searching by SKU:

{
  "search": [
    {
      "field": "sku",
      "value": "PROD-SKU-12345",
      "operator": "="
    }
  ]
}

3. Network and Merchant Specific Search

Searching within specific affiliate networks and includind and excluding merchants by their ID:

{
  "search": [
    {
      "field": "network.name",
      "value": "Commission Junction||ShareASale",
      "operator": "LIKE"
    },
    {
      "field": "merchant.id",
      "value": "23",
      "operator": "="
    },
    {
      "field": "merchant.id",
      "value": "20",
      "operator": "!="
    },
    {
      "field": "commissionable_status",
      "value": "confirmed_commissionable"
    }
  ],
  "networks": {
    "456": {
      "affiliate_id": "your_cj_affiliate_id",
      "sub_id": "multi_merchant_campaign"
    },
    "789": {
      "affiliate_id": "your_shareasale_id",
      "sub_id": "multi_merchant_campaign"
    }
  }
}

4. Advanced Pet Products Search

Finding specific pet products that meet multiple criteria:

{
  "page": 2,
  "per_page": 10,
  "sort_by": "final_price",
  "sort_order": "asc",
  "networks": {
    "329": {
      "affiliate_id": "your_affiliate_id_here",
      "sub_id": "pet_products_campaign"
    }
  },
  "search": [
    {
      "field": "name",
      "value": "dog toys || cat toys",
      "operator": "LIKE"
    },
    {
      "field": "on_sale",
      "value": true
    },
    {
      "field": "currency",
      "value": "GBP||EUR",
      "operator": "="
    },
    {
      "field": "brand",
      "value": "CatCo",
      "operator": "NOT LIKE"
    },
    {
      "field": "regular_price",
      "value": "2000",
      "operator": ">"
    },
    {
      "field": "merchant.name",
      "value": "Walmart",
      "operator": "LIKE"
    },
    {
      "field": "network.id",
      "value": "9",
      "operator": "="
    }
  ]
}

This example finds pet toys that are on sale, cost more than 20.00 in GBP or EUR, excludes the "CatCo" brand, and only includes results from Walmart on network ID 9.

5. Electronics Search with Brand Filtering

Searching for gaming laptops within a price range:

{
  "search": [
    {
      "field": "any",
      "value": "gaming laptop",
      "operator": "LIKE"
    },
    {
      "field": "final_price",
      "value": "100000",
      "operator": ">"
    },
    {
      "field": "final_price",
      "value": "300000",
      "operator": "<"
    },
    {
      "field": "availability",
      "value": "InStock"
    }
  ],
  "sort_by": "final_price",
  "sort_order": "desc",
  "per_page": 15,
  "networks": {
    "123": {
      "affiliate_id": "tech_affiliate_123",
      "sub_id": "gaming_laptops_q3"
    }
  }
}

6. Using Facets for Analytics and Filtering

Basic facets request for building filter interfaces:

{
  "search": [
    {
      "field": "name",
      "value": "laptop",
      "operator": "LIKE"
    }
  ],
  "facets": "network,merchant",
  "per_page": 10
}

Advanced facets with specific fields using dot notation:

{
  "search": [
    {
      "field": "category",
      "value": "Electronics",
      "operator": "LIKE"
    }
  ],
  "facets": "network.name,network.logo_url,merchant.name,merchant.product_count",
  "per_page": 20,
  "sort_by": "final_price",
  "sort_order": "asc"
}

7. Using Outclick Features After API Response

After receiving a product response, you can dynamically control the destination URL using the outclick URL parameters. Here are examples of how to modify the outclick URL for different purposes:
Example Product Response:

{
  "id": "prod_12345",
  "name": "Wireless Bluetooth Headphones",
  "urls": {
    "outclick": "https://outclick.co/a/encrypted_url_here",
    "direct": "https://merchant.com/product/123",
    "affiliate": "https://network.com/click?aff=@@@&product=123",
    "shopnomix": "https://r.v2i8b.com/api/v1/bid/redirect?url=http%3A%2F%2Fs.click.aliexpress.com%2Fdeep_link.htm%3Faff_short_key%3D7ER7auF%26af%3D%21%21%21id%21%21%21%26dp%3D%21%21%21awc%21%21%21%26cn%2D12044%26Afref%3D%21%21%21sitename%21%21%21%26dl_target_url%3Dhttps%2553A%252F%252Fwww.aliexpress.com%252Fitem%252F1005009533217906.html"
  }
}

Outclick URL Examples:

Standard affiliate link (default behavior):
https://outclick.co/a/encrypted_url_here

Direct merchant link (no affiliate tracking):
https://outclick.co/a/encrypted_url_here?format=direct

Affiliate link with custom sub_id for campaign tracking:
https://outclick.co/a/encrypted_url_here?format=affiliate&sub_id=summer_sale_2025

Shopnomix integration (when available):
https://outclick.co/a/encrypted_url_here?format=shopnomix

Common error scenarios:

400 Bad Request: Invalid parameters or malformed request

401 Unauthorized: Invalid or missing API key

403 Forbidden: API key lacks required permissions

429 Too Many Requests: Rate limit exceeded

500 Internal Server Error: Server-side error

Facets Use Cases

Building Product Discovery Interfaces

Facets enable you to build sophisticated product discovery experiences:

Dynamic Filtering: Use network and merchant facets to show users available filtering options

Analytics Dashboard: Display statistics about product availability across different networks

Merchant Comparison: Compare product offerings and counts across different retailers

Network Performance: Analyze which networks provide the most relevant results

Example Implementation Workflow

Initial Search: Perform a search with facets enabled

Display Options: Use facet data to populate filter dropdowns or checkboxes

Refined Search: Allow users to select specific networks/merchants and re-search

Analytics: Track which networks and merchants perform best for different search terms

Support

For additional help with the Product API:

Support: support@affiliate.com

Status Page: https://status.affiliate.com

Search Products

Product API Overview#

Endpoint#

API Description#

Features#

Benefits#

Query Builder#

Request Format#

Request Body Parameters#

Facets Parameter#

Supported Facet Types#

Dot Notation Support#

Examples#

Duplicate Fields to Exclude Parameter#

Balanced Mix Parameter#

Parameters#

Basic Example#

Advanced Example with Weights#

Real-World Example: Prioritizing Target over Best Buy#

Comparison: duplicate_fields_to_exclude vs balanced_mix#

Search Fields and Operators#

Search Examples#

Response Format#

Response Fields#

Main Response#

Meta Object#

Facets Object#

Networks Facet#

Merchants Facet#

Product Object#

Core Product Information#

URL and Tracking Information#

Pricing Information#

Inventory and Availability#

Product Identifiers#

Product Attributes#

Specialized Attributes#

Network and Merchant Information#

System Information#

URLs Object Detailed Breakdown#

Outclick URL Dynamic Parameters#

Field Usage Notes#

Price Handling#

Case Sensitivity#

Null Values#

Network Object#

Merchant Object#

Links Object#

Use Cases and Examples#

1. Simple Product Search with ANY Field#

2. Barcode and SKU Lookup#

3. Network and Merchant Specific Search#

4. Advanced Pet Products Search#

5. Electronics Search with Brand Filtering#

6. Using Facets for Analytics and Filtering#

7. Using Outclick Features After API Response#

Common error scenarios:#

Facets Use Cases#

Building Product Discovery Interfaces#

Example Implementation Workflow#

Support#