Omni API Documentation

Description

The Omni API Product Search endpoint allows users to retrieve product data from multiple sources, including Amazon and our comprehensive database of over 1 billion products. This single endpoint simplifies product search workflows by aggregating data from both Amazon and our internal database.

Advantages

Streamlined Process: Rather than querying separate APIs (e.g., Amazon's API) and combining the results manually, this endpoint offers a consolidated response, saving time and reducing complexity.

Broad Search Criteria: Supports multiple search parameters such as:

Amazon ASIN: Unique Amazon product identifier

Barcode: UPC, EAN, GTIN, ISBN codes

URL: Direct product link from merchants such as Amazon, Target, Walmart, Home Depot, Best Buy, etc.

Advanced Filtering: Filter results using specific field criteria with multiple operators

Flexible Grouping: Control result grouping and sorting

Request Format

Endpoint: /products/omni

Method: POST

Headers:

Content-Type: application/json

Authorization: Bearer {your_api_key}

Request Parameters

Parameter Name	Type	Required	Description	Example
`fields`	Array of Strings or String	No	Specifies the fields to be included in the response	`["id", "name", "final_price"]`
`per_page`	Integer	No	The number of results to be returned per page. Min: 1, Max: Depends on subscription. Default: 100	`10`
`page`	Integer	No	The page number of results returned for pagination requests. Min: 1, Max: Depends on subscription	`2`
`after`	String	No	For plans that allow results over 10,000, this parameter is used to paginate past 10,000 products using a system generated ID	`"abc123"`
`sort_by`	String	No	The field by which results should be sorted. Options: `relevance`, `id`, `barcode`, `name`, `final_price`, `on_sale`, `regular_price`, `availability`, `stock_quantity`, `brand`, `category`, `updated_at`	`"final_price"`
`sort_order`	String	No	The order by which results should be sorted. Options: `asc`, `desc`	`"asc"`
`group_by`	String	No	Group results by criteria index. Use `criteria.{index}` to group by a specific criteria item, or `none` for ungrouped results. Default: `none`	`"criteria.0"`
`network_ids`	Array of Integers	No	Explicit list of network IDs to include in results. See Networks API Endpoint for IDs	`[1, 2, 3]`
`merchant_ids`	Array of Integers	No	Explicit list of merchant IDs to include in results. See Merchants API Endpoint for IDs	`[1000, 1100, 1200]`
`exclude_network_ids`	Array of Integers	No	List of network IDs to exclude from results. See Networks API Endpoint for IDs	`[1, 2, 3]`
`exclude_merchant_ids`	Array of Integers	No	List of merchant IDs to exclude from results. See Merchants API Endpoint for IDs	`[1000, 1100, 1200]`
`duplicate_fields_to_exclude`	Comma Separated String	No	Remove duplicate results based on field values. Fields: `name`, `image_url`, `direct_url`, `barcode`, `merchant.id`.	`"name,image_url"`
`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`	Array of Strings	No	Retrieve aggregated statistics about the search results. Supported values: `final_price`, `network`, `merchant`. Useful for building dynamic filters and analytics.	`["final_price", "network", "merchant"]`

Networks Configuration

Parameter Name	Type	Required	Description	Example
`networks`	Object	Sometimes	Object containing network-specific configurations for affiliate links. For Amazon results, you will need to include your Creator API (v2 or v3) credentials.	See example below

Networks Parameter Details:

If omitted, the API will return commission_urls containing @@@ and ### placeholders

If provided, the API validates the data to ensure correct format:

Most networks require an affiliate_id

Networks with additional configurations require:

Amazon: credential_id, credential_secret, partner_tag, locale (similar to marketplaces: US, GB, DE, etc.)

Adservice: mid

AffiliateGateway: site_id

Belboon: adspace_id

Effiliation: api_key

Partnerize: application_key, user_api_key, publisher_id

Networks Configuration Example:

{
  "networks": {
    "amazon": {
      "credential_id": "{{my_amz_credential_id}}",
      "credential_secret": "{{my_amz_credential_secret}}",
      "partner_tag": "{{my_amz_partner_tag}}",
      "locale": "{{my_amz_partner_locale}}"
    },
    "329": {
      "affiliate_id": "yyyyyyyyyyyyyyyyyyy",
      "sub_id": "zzzzzzzzzzzzzzzzzzzz"
    }
  }
}

Facets Parameter

The facets parameter allows you to retrieve aggregated statistics about your search results. This is particularly useful for:

Building dynamic filter interfaces

Understanding result composition

Displaying available filtering options to users

Analytics and reporting

Supported Facet Types:

Facet Type	Description	Response Key
`final_price`	Returns minimum and maximum price values in the result set	`final_prices`
`network`	Returns complete network information and statistics including product counts and merchant counts	`networks`
`merchant`	Returns complete merchant information and statistics including product counts and network associations	`merchants`

Facets Example Request:

{
  "criteria": [
    {
      "field": "any",
      "value": "iphone"
    }
  ],
  "facets": ["final_price", "network", "merchant"],
  "fields": ["id", "name", "final_price"],
  "per_page": 100
}

Facets Example Response:

{
  "meta": {
    "total": 3610,
    "from": 1,
    "to": 100,
    "current_page": 1,
    "last_page": 37,
    "per_page": 100,
    "fields": ["id", "barcode", "name", "direct_url"],
    "after": null,
    "facets": ["final_price", "network", "merchant"],
    "sort_by": "relevance",
    "sort_order": "asc",
    "trace_id": "019b299f-b113-7240-94f1-a8365ece7443"
  },
  "facets": {
    "final_prices": {
      "min": 201.4,
      "max": 1500
    },
    "networks": [
      {
        "id": 335,
        "name": "Impact US",
        "product_count": 1523
      },
      {
        "id": 9000,
        "name": "Amazon",
        "product_count": 2087
      }
    ],
    "merchants": [
      {
        "id": 102478,
        "name": "Walmart",
        "product_count": 856,
        "network": {
          "id": 335,
          "name": "Impact US"
        }
      },
      {
        "id": 900000,
        "name": "Amazon",
        "product_count": 2087,
        "network": {
          "id": 9000,
          "name": "Amazon"
        }
      }
    ]
  },
  "data": [
    {
      "id": "1254685214754622667",
      "barcode": "616960528395",
      "name": "Apple iPhone 15 Pro Max 1TB Prepaid - Total Wireless Natural Titanium",
      "direct_url": "https://www.totalwireless.com/smartphones/iphone-15-pro-max-1tb.natural-titanium"
    }
  ],
  "links": {
    "self": "https://api.affiliate.com/v1/products/omni",
    "first": "https://api.affiliate.com/v1/products/omni?page=1",
    "prev": null,
    "next": "https://api.affiliate.com/v1/products/omni?page=2"
  }
}

Use Cases:

Price Range Filters: Use final_price facet to display min/max price sliders in your UI

Network/Merchant Filters: Display available networks and merchants with product counts for user filtering

Analytics: Understand which networks and merchants have the most products for a given search

Dynamic UI: Build responsive filter interfaces that show only available options based on search results

Search Criteria

Parameter Name	Type	Required	Description	Example
`criteria`	Array of Objects	Yes	Contains search criteria for finding products. Only one criteria permitted per query.	See example below

Supported Search Fields:

asin - Amazon Standard Identification Number

url - Product page URLs (Amazon, Walmart, Target, Best Buy, Home Depot)

barcode - UPC, EAN, GTIN, ISBN codes

keyword - Keyword-based search across product fields

any - 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)

Search Notes:

Maximum of 10 ASINs permitted per call

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

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

Criteria Example:

{
  "criteria": [
    {
      "field": "url",
      "value": "https://www.amazon.com/Beats-Studio-Pro-Kardashian-Compatibility/dp/B0D95134GD/"
    },
    {
      "field": "asin",
      "value": "B07QK2SPP7||B08N5WRWNW||B09JBQZPX8"
    },
    {
      "field": "barcode",
      "value": "1234567890123"
    }
  ]
}

Filter Array (Advanced Filtering)

Parameter Name	Type	Required	Description	Example
`filter`	Array of Objects	No	Advanced filtering criteria to refine search results further	See example below

The filter array allows you to apply advanced filtering conditions to your search results. Each filter object contains:

Field Name	Type	Required	Description	Example
`field`	String	Yes	The field name to filter on	`"brand"`
`operator`	String	Yes	The comparison operator to use	`"="`
`value`	Mixed	Yes	The value to compare against (string/number)	`"Nike"`

Filter Example:

{
  "filter": [
    {
      "field": "merchant.name",
      "operator": "LIKE",
      "value": "walmart"
    },
    {
      "field": "currency",
      "operator": "=",
      "value": "USD"
    },
    {
      "field": "final_price",
      "operator": "<=",
      "value": 10000
    },
    {
      "field": "availability",
      "operator": "=",
      "value": "InStock"
    }
  ]
}

Filter Fields and Operators

Field	Operators	Notes
`id`	`=`, `!=`
`any`	`LIKE`, `ENHANCED`	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`
`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`	`=`, `!=`, `>`, `<`, `>=`, `<=`, `<>`	For between (`<>`), you would indicate a range by indicating lower and higher values separated by a single pipe `\|` (e.g., `"2000\|15000"`)
`regular_price`	`=`, `!=`, `>`, `<`, `>=`, `<=`, `<>`	For between (`<>`), you would indicate a range by indicating lower and higher values separated by a single pipe `\|` (e.g., `"2000\|15000"`)
`on_sale`	`=`
`sale_discount`	`=`, `!=`, `>`, `<`, `>=`, `<=`
`availability`	`=`, `!=`	Values: `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`
`seller_party`	`=`	Filter values: `1st` (first party - sold directly by merchant), `3rd` (third party - sold by reseller), `unknown` (not specified in feed). Supports multiple values with `\|\|` separator (e.g., `"1st\|\|unknown"`)
`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`
`added_at`	`=`, `!=`, `>`, `<`, `>=`, `<=`, `<>`	YYYY-MM-DD format
`updated_at`	`=`, `!=`, `>`, `<`, `>=`, `<=`, `<>`	YYYY-MM-DD format

Operator Usage Notes:

=: Exact match

!=: Not equal to

LIKE: Contains (partial match, case-insensitive unless noted)

ENHANCED: AI-powered search using LLM to intelligently rephrase and expand queries for better results. Only available for any field. Ideal for natural language queries and complex product descriptions.

NOT LIKE: Does not contain

>: Greater than

<: Less than

>=: Greater than or equal to

<=: Less than or equal to

NOT NULL: Field has a value (is not null)

Response Format

The response includes the specified fields for each product that matches the search criteria, sorted according to your parameters.

Example Response

{
  "meta": {
    "total": 39,
    "from": 1,
    "to": 39,
    "current_page": 1,
    "last_page": 1,
    "per_page": 100,
    "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",
      "seller_party",
      "mpn",
      "sku",
      "brand",
      "category",
      "size",
      "color",
      "gender",
      "material",
      "country",
      "condition",
      "genre",
      "manufacturer",
      "model",
      "author",
      "artist",
      "tags",
      "network",
      "merchant",
      "added_at",
      "updated_at"
    ],
    "after": null,
    "sort_by": "relevance",
    "sort_order": "asc",
    "group_by": "none",
    "trace_id": "0198821a-47bf-711a-9ac6-f1bc7178073c"
  },
  "data": [
    {
      "id": "AZN-B07QK2SPP7",
      "barcode": "6925281954566",
      "name": "JBL FLIP 5, Waterproof Portable Bluetooth Speaker, Black, Small",
      "description": "Take the party with you no matter what the weather. The JBL Flip 5 speaker delivers crystal clear, room-filling JBL Original Pro Sound with surprisingly deep bass.",
      "commission_url": "https://www.amazon.com/dp/B07QK2SPP7?tag=aff-tag-here&linkCode=ogi&th=1&psc=1&language=en_US",
      "direct_url": "https://www.amazon.com/dp/B07QK2SPP7",
      "image_url": "https://m.media-amazon.com/images/I/31NDJ9+-ckL._SL500_.jpg",
      "urls": {
        "outclick": "https://outclick.co/a/eyJpdiI6ImhaQ0RaMU0wVEZJNXEvRmpXMWJXZkE9PSIsInZhbHVlIjoidmcwL3llQklVNTcwNWhvWXFzRnlEWXFPM1RqQ0Vrc2JBVHk0RE5HT3RnN3ZXbEZkQjlWMkJoajFFdXdkaWtpcmVpZnJ2ejBRZDkrTlBaeWUzWFhqbnU5QTF6SXdRWHJEdnFYeGxmYW9oY1FxUTZ3dEZSZDhaNWZWSm1QRmJLNDhJYjNRUnllZExIWlBqZGhndW9MczQxelpXQTFERnhBWGVXckNaRGtqa3Z6UkY5Z2Jsem5BTks1SVVZK0c4b0hLYW9mdXM1cXIvUldxSFdnd1NmaHJhV3pvdVE1RE5pK000UFlsMFcwenJsUmNjVmJBSHdRUzVsd1ZZazI0L3NlUXpTWWc2dzFMbjZtRFRoNjN1NkNnd0h4REdyQm5SMUF0TXJSQXJSeVlJS0EvS2c2am5UYnFDcXVqVi9rUkY3Y3oyYzlTd2NodGJvd1dVREl0dkl6UXFsODRFRU9tYXFDNHIzZGQwL1pYZlprc01TenlTQTRHMjBsM1B1WUU0QTBpWWErM292cGxDaVlIVkNsMUtZQ1hXcWl4Mm52anQ2a0JsWk8vODBzcnRhV1poaWtGckpUSm1xSS9uNGlqa3dmRmtZL1krakZPU0NqVkRvMmZaNEpHRTVuV1VNdUt3RDRSVjc4dXFXSzh4aVhMeC8xMzBEUFBSS2tDQ3Y1ek5CMHprNjlESHhsQmNlNWVhSThjMUJsTVJjVEFTbWpMTWJMZjZtQlB0aVh4ZlR6aGRKdmQ5Y1VKdHQxL2xkelZ5TXkzWVh2alNZVVdCcU9iRVppSU4yWCtkQnFsV3Zuc0VXNGNCd0ZZaHdkQzdCWmlMdDROM1lRZTZaN1NlTHJqTkN2bU1UN1pjbUpIVlFPYmFJcXVFYTNaSVJTdWdGdjZ0WVFlSHlETllBa1JGbTN6dTkvaVpiUlJoSzkzdTdXd0ZsOWtxQUx2RXhaU1d1Q25xSVVVZGNTeVpHbVQ3WWhNZXZ0dzZKWjhtWGVPOCtuQlh1cXlTYmVkWjRlL1ErYldxTFFseTg5dzJkNStmMldwdUkrVUJ2dTFOZU56bjVjM2EreDc2RWFRQnpVUkZBZ0pETnZaeEF0RUt5clJsTjYzRDRBTnd0U3dMb0pMNEovM1BEdVNVTnFDTy82NUUzY2FhTFFyK2l6UTd2cGduQ1lUMS9BNUhXeUt4WTZKMU9SZmNmeS91dzEvaE5CblhES0k1MHI4L2N3QWZTeGVLOHhKa2FvQmVxUUlsckxoUDM4PSIsIm1hYyI6ImE2MTE2OGZiMDc0NTEyYWY0OTVkNmFiYjM2YzZkYWNkODcwM2NmODI0YTdiN2M3ZDEzZTA0YWUyN2JjODVmNmMiLCJ0YWciOiIifQ==?affiliate_id=@@@&sub_id=###",
        "direct": "https://www.amazon.com/dp/B07QK2SPP7",
        "affiliate": "https://www.amazon.com/dp/B07QK2SPP7?tag=aff-tag-here&linkCode=ogi&th=1&psc=1&language=en_US",
        "shopnomix": "https://r.v2i8b.com/api/v1/bid/redirect?url=https%3A%2F%2Fwww.amazon.com%2Fdp%2FB07QK2SPP7"
      },
      "currency": "USD",
      "regular_price": 89.95,
      "final_price": 89.95,
      "on_sale": false,
      "sale_discount": 0,
      "availability": "in_stock",
      "stock_quantity": 15,
      "commissionable_status": "confirmed_commissionable",
      "mpn": "JBLFLIP5BLK",
      "sku": "JBL-FLIP5-BLACK",
      "brand": "JBL",
      "category": "Electronics > Audio > Speakers",
      "size": "Small",
      "color": "Black",
      "gender": null,
      "material": "Plastic, Fabric",
      "country": "China",
      "condition": "new",
      "genre": null,
      "manufacturer": "JBL",
      "model": "FLIP 5",
      "author": null,
      "artist": null,
      "tags": ["bluetooth", "waterproof", "portable", "speaker"],
      "network": {
        "id": 9000,
        "name": "Amazon",
        "logo_url": "https://img.affiliate.com/logos/groups/91/128x128.png"
      },
      "merchant": {
        "id": 900000,
        "name": "Amazon",
        "logo_url": "https://img.affiliate.com/logos/merchants/900000/logo.png"
      },
      "added_at": "2025-08-01 10:23:45",
      "updated_at": "2025-08-07 01:16:57"
    },
    {
      "id": "8609572540091819226",
      "barcode": "1234567890123",
      "name": "Professional Wireless Bluetooth Speaker - Premium Sound Quality",
      "description": "High-quality wireless speaker with advanced Bluetooth 5.0 technology, offering crystal clear audio and deep bass response for all your music needs.",
      "commission_url": "https://outclick.co/a/eyJpdiI6ImNaa0lLdGpZYURYdThsdFNUTitXK0E9PSIsInZhbHVlIjoiUGFPYnRtMzZYK0RFemoyZWlkbUFKVzMxcDhCRTJ0dkdMcmsyNDFIOCtVVy9RTzJZbEJGQzR6akwyV1lHSXFhZjJHOTB5V0FBbEQ2Qm9QeEZYUVdsOUgwNUEyY3cxNmtLMXNUL2lZWVBQUjIxRFB2UnNLaEY2UGdaN2d4V0dMSk1PeDRtcUZYSkN0U0VJNFpYcHpzL2lZSUdXK1UybFI5RHdhaG5GMUN0SmpVT09kV1EvVFFhTUg0cFZpVEhEUms1Q0c3MHg3azU5RTVHaVl1aWdTa0c4VE5NWGRwUURuZ3MwV2c4U0VVTzRyUEJrRXhkcHhCalJHamdBajFhWVlPYkxzK2NrVG1SRWljYjNON2k4WllRbWxnNis1UnRERTN2Z3o0dUJPV0xaM3pWeHJJUGM2bFdhb0IzOFZ0UEV4UmdVc1k3T1RqQnV2S1BWamY3OEY1bVg0U1FtZ2lncElEREJBN2NnQTNIVnNxeFozdldIL0h4V2RDR2xyWXpxUjVrNWhlbnRHZHF6SjhWM1V5NkpFcWw1M013MjlHVTQvNlN5d2NGbnoxRTByYVRoZytTNEJtOTFHWjVUOEJGQlZZcmQvSmRwTTVFYWxXUmZwUExVbXRaaGlIU042L1pmNFo5S3J5SWdPMkN2REpMWHhkRnpVQUVuTVF4Y0Q2RmdhbEFOK2tmSDBmeUcxMmVYcGd4UWliSEttblFoQ3lwNmtLQUxnQVNkZmJucWtPRCtLRjJHVjkwQTVZb3pvcEhyS2JqSEREOWRTOHJmcnlvV0ZQU05QZ2daZWZPd1dxTit0bDVzbTlHbkYvcXh1U281eVVvQ0R3QVNmdEs4d3A1NDVicmJ4YmtFZ0Z1cU90N1J1YTNZNElPWHFHWFZoOCIsIm1hYyI6IjMwNzk4MTU3MTA0NTRjNDkzYmIxODU0NzIyZTAwNGZlYzNkYWNkZjQ4NGM2YjIwZjNjMTZhNjUwNjFmNzI0YzkiLCJ0YWciOiIifQ==?affiliate_id=@@@&sub_id=###",
      "direct_url": "https://shop.example-merchant.com/products/wireless-speaker-premium",
      "image_url": "https://cdn.example-merchant.com/images/speaker-premium-view.jpg",
      "urls": {
        "outclick": "https://outclick.co/a/eyJpdiI6ImNaa0lLdGpZYURYdThsdFNUTitXK0E9PSIsInZhbHVlIjoiUGFPYnRtMzZYK0RFemoyZWlkbUFKVzMxcDhCRTJ0dkdMcmsyNDFIOCtVVy9RTzJZbEJGQzR6akwyV1lHSXFhZjJHOTB5V0FBbEQ2Qm9QeEZYUVdsOUgwNUEyY3cxNmtLMXNUL2lZWVBQUjIxRFB2UnNLaEY2UGdaN2d4V0dMSk1PeDRtcUZYSkN0U0VJNFpYcHpzL2lZSUdXK1UybFI5RHdhaG5GMUN0SmpVT09kV1EvVFFhTUg0cFZpVEhEUms1Q0c3MHg3azU5RTVHaVl1aWdTa0c4VE5NWGRwUURuZ3MwV2c4U0VVTzRyUEJrRXhkcHhCalJHamdBajFhWVlPYkxzK2NrVG1SRWljYjNON2k4WllRbWxnNis1UnRERTN2Z3o0dUJPV0xaM3pWeHJJUGM2bFdhb0IzOFZ0UEV4UmdVc1k3T1RqQnV2S1BWamY3OEY1bVg0U1FtZ2lncElEREJBN2NnQTNIVnNxeFozdldIL0h4V2RDR2xyWXpxUjVrNWhlbnRHZHF6SjhWM1V5NkpFcWw1M013MjlHVTQvNlN5d2NGbnoxRTByYVRoZytTNEJtOTFHWjVUOEJGQlZZcmQvSmRwTTVFYWxXUmZwUExVbXRaaGlIU042L1pmNFo5S3J5SWdPMkN2REpMWHhkRnpVQUVuTVF4Y0Q2RmdhbEFOK2tmSDBmeUcxMmVYcGd4UWliSEttblFoQ3lwNmtLQUxnQVNkZmJucWtPRCtLRjJHVjkwQTVZb3pvcEhyS2JqSEREOWRTOHJmcnlvV0ZQU05QZ2daZWZPd1dxTit0bDVzbTlHbkYvcXh1U281eVVvQ0R3QVNmdEs4d3A1NDVicmJ4YmtFZ0Z1cU90N1J1YTNZNElPWHFHWFZoOCIsIm1hYyI6IjMwNzk4MTU3MTA0NTRjNDkzYmIxODU0NzIyZTAwNGZlYzNkYWNkZjQ4NGM2YjIwZjNjMTZhNjUwNjFmNzI0YzkiLCJ0YWciOiIifQ==?affiliate_id=@@@&sub_id=###",
        "direct": "https://shop.example-merchant.com/products/wireless-speaker-premium",
        "affiliate": "https://partners.example-network.com/click?merchant=12345&product=67890&aff=@@@",
        "shopnomix": null
      },
      "currency": "USD",
      "regular_price": 12999,
      "final_price": 9999,
      "on_sale": true,
      "sale_discount": 23,
      "availability": "low_stock",
      "stock_quantity": 3,
      "commissionable_status": "assumed_commissionable",
      "seller_party": "first",
      "mpn": "WS-PREM-5000",
      "sku": "SPEAKER-WIRELESS-PREM",
      "brand": "AudioTech Pro",
      "category": "Electronics > Audio > Speakers",
      "size": "Medium",
      "color": "Matte Black",
      "gender": null,
      "material": "Aluminum, Fabric",
      "country": "Germany",
      "condition": "new",
      "genre": null,
      "manufacturer": "AudioTech Industries",
      "model": "ProSound 5000",
      "author": null,
      "artist": null,
      "tags": ["wireless", "bluetooth", "premium", "portable"],
      "network": {
        "id": 123,
        "name": "ExampleAffiliate Network",
        "logo_url": "https://cdn.affiliate-logos.com/networks/example/128x128.png"
      },
      "merchant": {
        "id": 45678,
        "name": "Example Electronics Store",
        "logo_url": "https://cdn.merchant-logos.com/example-electronics/logo.png"
      },
      "added_at": "2025-08-06 15:54:53",
      "updated_at": "2025-08-07 01:16:57"
    }
  ]
}

Response Fields

Main Response

Field Name	Type	Description
`meta`	object	Metadata about the pagination and search results
`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
`facets`	array	List of facets requested (only present if facets were requested)
`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)
`group_by`	string	The grouping method applied to results
`trace_id`	string	Unique identifier for tracking the request

Facets Object

The facets object is only included in the response when the facets parameter is specified in the request. It provides aggregated statistics about the search results.

Field Name	Type	Description
`facets.final_prices`	object	Price range statistics. Contains `min` and `max` values representing the lowest and highest prices in the result set
`facets.final_prices.min`	number	Minimum final_price value in the result set
`facets.final_prices.max`	number	Maximum final_price value in the result set
`facets.networks`	array	List of networks in the result set with their product counts and basic information
`facets.merchants`	array	List of merchants in the result set with their product counts, network associations, and basic information

Network Facet Object:

Field Name	Type	Description
`id`	integer	Network ID
`name`	string	Network name
`product_count`	integer	Number of products from this network in the results

Merchant Facet Object:

Field Name	Type	Description
`id`	integer	Merchant ID
`name`	string	Merchant name
`product_count`	integer	Number of products from this merchant in the results
`network`	object	Associated network information (id and name)

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	Seller Type - Indicates whether the product is sold directly by the merchant (first party) or through a third-party reseller. Response values: `first` (sold directly by merchant like Walmart), `third` (sold by reseller on platforms like Amazon Marketplace), `unknown` (not specified in merchant feed)

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
`added_at`	string	Date Added - ISO timestamp indicating when the product was first added to the system
`updated_at`	string	Last Updated - ISO timestamp indicating when the product information was last refreshed from the merchant feed

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

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

Use Cases and Examples

1. Amazon ASIN Lookup

Finding specific Amazon products using their ASIN identifiers:

{
  "fields": ["id", "name", "brand", "final_price", "commission_url", "urls", "availability"],
  "per_page": 10,
  "networks": {
    "amazon": {
      "credential_id": "{{my_amz_credential_id}}",
      "credential_secret": "{{my_amz_credential_secret}}",
      "partner_tag": "mytag-20",
      "locale": "US"
    }
  },
  "criteria": [
    {
      "field": "asin",
      "value": "B07QK2SPP7||B08N5WRWNW||B09JBQZPX8"
    }
  ],
  "sort_by": "final_price",
  "sort_order": "asc"
}

2. URL-Based Product Lookup with Filters

Finding products from a URL with additional filtering:

{
  "criteria": [
    {
      "field": "url",
      "value": "https://www.amazon.com/dp/B07QK2SPP7"
    }
  ],
  "filter": [
    {
      "field": "currency",
      "operator": "=",
      "value": "USD"
    },
    {
      "field": "availability",
      "operator": "=",
      "value": "InStock"
    }
  ],
  "networks": {
    "amazon": {
      "credential_id": "{{my_amz_credential_id}}",
      "credential_secret": "{{my_amz_credential_secret}}",
      "partner_tag": "{{my_amz_partner_tag}}",
      "locale": "US"
    }
  },
  "sort_by": "final_price",
  "sort_order": "asc"
}

3. Advanced Filtering and Grouping

Complex search with multiple filters and grouping:

{
  "criteria": [
    {
      "field": "any",
      "value": "bluetooth speaker"
    }
  ],
  "filter": [
    {
      "field": "final_price",
      "operator": "<>",
      "value": "2000|15000"
    },
    {
      "field": "brand",
      "operator": "LIKE",
      "value": "JBL"
    },
    {
      "field": "availability",
      "operator": "=",
      "value": "InStock"
    },
    {
      "field": "on_sale",
      "operator": "=",
      "value": true
    }
  ],
  "fields": ["id", "name", "brand", "final_price", "regular_price", "sale_discount", "urls", "merchant.name"],
  "group_by": "none",
  "sort_by": "final_price",
  "sort_order": "asc",
  "per_page": 20
}

4. Merchant and Network Specific Search

Filtering by specific merchants and networks:

{
  "criteria": [
    {
      "field": "any",
      "value": "wireless headphones"
    }
  ],
  "filter": [
    {
      "field": "merchant.name",
      "operator": "LIKE",
      "value": "walmart"
    },
    {
      "field": "final_price",
      "operator": "<",
      "value": 10000
    }
  ],
  "network_ids": [9000, 123],
  "exclude_merchant_ids": [12345],
  "duplicate_fields_to_exclude": "name,image_url",
  "sort_by": "final_price",
  "sort_order": "asc"
}

5. Barcode-Based Search with Stock Filtering

Finding products by barcode with stock requirements:

{
  "criteria": [
    {
      "field": "barcode",
      "value": "1234567890123"
    }
  ],
  "filter": [
    {
      "field": "stock_quantity",
      "operator": ">",
      "value": 0
    },
    {
      "field": "condition",
      "operator": "=",
      "value": "new"
    }
  ],
  "fields": ["id", "name", "brand", "barcode", "final_price", "stock_quantity", "urls", "merchant.name"],
  "sort_by": "final_price",
  "sort_order": "asc"
}

6. Grouping Results by Criteria

Searching for multiple ASINs and grouping results by each ASIN:

{
  "fields": "id,name,final_price,direct_url,image_url",
  "group_by": "criteria.0",
  "networks": {
    "amazon": {
      "credential_id": "{{my_amz_credential_id}}",
      "credential_secret": "{{my_amz_credential_secret}}",
      "partner_tag": "{{my_amz_partner_tag}}",
      "locale": "US"
    }
  },
  "criteria": [
    {
      "field": "asin",
      "value": "B096N66GHN||B0BGH753WB||B0B4X42BN6"
    }
  ]
}

Response Structure for Grouped Results:

{
  "meta": {
    "total": 14,
    "from": 1,
    "to": 14,
    "current_page": 1,
    "last_page": 1,
    "per_page": 100,
    "fields": ["id", "name", "final_price", "direct_url", "image_url"],
    "after": null,
    "sort_by": "relevance",
    "sort_order": "asc",
    "group_by": "criteria.0",
    "trace_id": "0198e8e2-d07d-70d4-993a-1dacca9c467f"
  },
  "data": [
    {
      "criterion": {
        "field": "asin",
        "value": "B096N66GHN"
      },
      "results": [
        {
          "id": "AZN-B096N66GHN",
          "name": "PAVILIA White and Navy Blue Buffalo Plaid Sherpa Throw Blanket for Couch Twin, Soft Fuzzy Flannel Blanket for Bed, Plush Checkered Fleece Blanket and Throws, Warm Thick Winter Blanket Gift, 60x80",
          "final_price": 24.99,
          "direct_url": "https://amazon.com/dp/B096N66GHN",
          "image_url": "https://images-na.ssl-images-amazon.com/images/I/816OoqNXhXL.jpg"
        },
        {
          "id": "1024504015279236427",
          "name": "PAVILIA Buffalo Plaid Sherpa Blanket Throw Twin | Fuzzy White Navy Blue Checkered Flannel Fleece Blanket for Couch Bed | Fluffy Warm Soft Plush Microfiber Blanket | 60x80",
          "final_price": 25.99,
          "direct_url": "https://www.walmart.com/ip/PAVILIA-Buffalo-Plaid-Sherpa-Blanket-Throw-Twin-Fuzzy-White-Navy-Blue-Checkered-Flannel-Fleece-Couch-Bed-Fluffy-Warm-Soft-Plush-Microfiber-60x80/384320360",
          "image_url": "https://i5.walmartimages.com/asr/69bcbce1-3cbb-40ef-9a93-ae1c4069679f.79e618361f0d55ed80d86008022c96bd.jpeg?odnHeight=450&odnWidth=450&odnBg=ffffff"
        }
      ]
    },
    {
      "criterion": {
        "field": "asin",
        "value": "B0BGH753WB"
      },
      "results": [
        {
          "id": "AZN-B0BGH753WB",
          "name": "PAVILIA Glow in The Dark Pink Unicorn Blanket - Gift for Girls Ages 1-10, Soft Plush Fleece for Birthday, Christmas, Room Decor - 50x60",
          "final_price": 12.79,
          "direct_url": "https://amazon.com/dp/B0BGH753WB",
          "image_url": "https://images-na.ssl-images-amazon.com/images/I/91akBnnJykL.jpg"
        },
        {
          "id": "8099985569292540178",
          "name": "P-B3027 Throw Blanket",
          "final_price": 20.99,
          "direct_url": "https://www.wayfair.com/Pavilia--PB3027-Throw-Blanket-PB3027GWPT02-L2239-K~PVII1070.html",
          "image_url": "https://assets.wfcdn.com/im/48159836/resize-h400-w400%5Ecompr-r85/2686/268601691/.jpg"
        }
      ]
    },
    {
      "criterion": {
        "field": "asin",
        "value": "B0B4X42BN6"
      },
      "results": [
        {
          "id": "AZN-B0B4X42BN6",
          "name": "PAVILIA Blanket Hoodie for Women Teal, Sherpa Wearable Blanket Men, Cozy Oversized Sweatshirt Blanket, Warm Fleece Hooded Blanket Sweater with Sleeves and Two Big Pocket, Adult Long, Teal Blue",
          "final_price": 29.99,
          "direct_url": "https://amazon.com/dp/B0B4X42BN6",
          "image_url": "https://images-na.ssl-images-amazon.com/images/I/81Q3IACRXWL.jpg"
        },
        {
          "id": "1024744062857650362",
          "name": "PAVILIA Blanket Hoodie for Women Teal Sherpa Wearable Blanket Men Cozy Oversized Sweatshirt Blanket Warm Fleece Hooded Blanket Sweater with Sleeves and Two Big Pocket Adult Long Teal Blue",
          "final_price": 32.99,
          "direct_url": "https://www.walmart.com/ip/PAVILIA-Blanket-Hoodie-Women-Teal-Sherpa-Wearable-Men-Cozy-Oversized-Sweatshirt-Blanket-Warm-Fleece-Hooded-Sweater-Sleeves-Two-Big-Pocket-Adult-Long/1223906334",
          "image_url": "https://i5.walmartimages.com/asr/e643d7b5-d848-4b7b-9510-e9f1c7d61d38.3d555ba19d2c7d1939baf3edae3a880a.jpeg?odnHeight=450&odnWidth=450&odnBg=ffffff"
        }
      ]
    }
  ],
  "links": {
    "self": "https://api.affiliate.local/v1/products/omni",
    "first": "https://api.affiliate.local/v1/products/omni?page=1",
    "prev": null,
    "next": null
  }
}

7. AI-Enhanced Search with ENHANCED Operator

Using the ENHANCED operator for intelligent, natural language product search:

{
  "criteria": [
    {
      "field": "any",
      "value": "dog toys",
      "operator": "ENHANCED"
    }
  ],
  "filter": [
    {
      "field": "final_price",
      "operator": "<=",
      "value": 5000
    }
  ],
  "fields": ["id", "name", "brand", "final_price", "description", "urls"],
  "sort_by": "relevance",
  "sort_order": "desc",
  "per_page": 50
}

How ENHANCED Works:

The ENHANCED operator uses an LLM to intelligently rephrase and expand your search query. For example:

Query: "dog toys" → Might expand to include: "pet toys", "canine playthings", "chew toys", "fetch toys", "interactive dog games"

Query: "waterproof bluetooth speaker" → Expands to related terms and variations for better product matching

When to Use ENHANCED:

Natural language queries (e.g., "gifts for coffee lovers")

Complex product descriptions (e.g., "eco-friendly reusable water bottles for hiking")

Broad category searches where you want comprehensive results

When standard LIKE searches return too few or irrelevant results

Performance Note: The ENHANCED operator may take slightly longer than standard LIKE searches due to AI processing.

8. Filtering by Seller Party (First Party vs Third Party)

Finding products from Walmart (first party only) and Best Buy (first party or unknown status):

{
  "criteria": [
    {
      "field": "any",
      "value": "laptop"
    }
  ],
  "filter": [
    {
      "field": "seller_party",
      "operator": "=",
      "value": "1st||unknown"
    },
    {
      "field": "merchant.name",
      "operator": "LIKE",
      "value": "best buy||walmart"
    }
  ],
  "fields": ["id", "name", "merchant", "seller_party", "final_price", "urls"],
  "sort_by": "final_price",
  "sort_order": "asc",
  "per_page": 100
}

Example Response:

{
  "meta": {
    "total": 200000,
    "from": 1,
    "to": 100,
    "current_page": 1,
    "last_page": 2000,
    "per_page": 100,
    "fields": ["id", "name", "merchant", "seller_party"],
    "after": null,
    "sort_by": "relevance",
    "sort_order": "asc",
    "trace_id": "019a9a44-2234-7152-904c-edb7e7a28402"
  },
  "data": [
    {
      "id": "1024456267708918817",
      "name": "Acdelco 18J4916 18j4916",
      "merchant": {
        "id": 102445,
        "name": "Walmart",
        "logo_url": "https://img.affiliate.com/logos/merchants/102445/logo.png"
      },
      "seller_party": "first",
      "final_price": 2499,
      "urls": {
        "outclick": "https://outclick.co/a/encrypted_url_here",
        "direct": "https://www.walmart.com/ip/product-id",
        "affiliate": "https://www.walmart.com/ip/product-id?affid=yourid"
      }
    }
  ]
}

Use Cases:

Filter for products sold directly by major retailers (avoiding marketplace sellers)

Ensure consistent return policies and customer service

Target campaigns for first-party inventory with potentially better commission rates

Combine multiple seller party values using || to include both first-party and unknown status products

9. Using Facets for Dynamic Filtering

Building dynamic filter interfaces with facets:

{
  "criteria": [
    {
      "field": "any",
      "value": "laptop"
    }
  ],
  "facets": ["final_price", "network", "merchant"],
  "filter": [
    {
      "field": "availability",
      "operator": "=",
      "value": "InStock"
    }
  ],
  "fields": ["id", "name", "brand", "final_price", "merchant", "network"],
  "sort_by": "final_price",
  "sort_order": "asc",
  "per_page": 50
}

Example Response with Facets:

{
  "meta": {
    "total": 2456,
    "from": 1,
    "to": 50,
    "current_page": 1,
    "last_page": 50,
    "per_page": 50,
    "fields": ["id", "name", "brand", "final_price", "merchant", "network"],
    "facets": ["final_price", "network", "merchant"],
    "sort_by": "final_price",
    "sort_order": "asc",
    "trace_id": "019b299f-b113-7240-94f1-a8365ece7443"
  },
  "facets": {
    "final_prices": {
      "min": 299.99,
      "max": 3499.99
    },
    "networks": [
      {
        "id": 335,
        "name": "Impact US",
        "product_count": 1234
      },
      {
        "id": 9000,
        "name": "Amazon",
        "product_count": 1222
      }
    ],
    "merchants": [
      {
        "id": 102478,
        "name": "Walmart",
        "product_count": 567,
        "network": {
          "id": 335,
          "name": "Impact US"
        }
      },
      {
        "id": 102445,
        "name": "Best Buy",
        "product_count": 667,
        "network": {
          "id": 335,
          "name": "Impact US"
        }
      },
      {
        "id": 900000,
        "name": "Amazon",
        "product_count": 1222,
        "network": {
          "id": 9000,
          "name": "Amazon"
        }
      }
    ]
  },
  "data": [
    {
      "id": "AZN-B08N5WRWNW",
      "name": "Dell Inspiron 15 3000 Laptop",
      "brand": "Dell",
      "final_price": 299.99,
      "merchant": {
        "id": 900000,
        "name": "Amazon"
      },
      "network": {
        "id": 9000,
        "name": "Amazon"
      }
    }
  ]
}

Implementation Use Cases:

Price Range Slider: Use facets.final_prices.min and facets.final_prices.max to set the bounds of a price range slider

Merchant Filter Checkboxes: Display checkboxes for each merchant in facets.merchants with product counts

Network Selection: Show available networks with their product counts to help users focus on specific affiliate programs

Smart Defaults: Pre-select merchants or networks with the highest product counts for better user experience

10. Complete Example with All Parameters

Comprehensive request using multiple features:

{
  "criteria": [
    {
      "field": "asin",
      "value": "B0B1D5BL5C"
    }
  ],
  "fields": ["name", "direct_url", "final_price", "brand", "image_url", "availability"],
  "filter": [
    {
      "field": "merchant.name",
      "operator": "LIKE",
      "value": "walmart"
    },
    {
      "field": "currency",
      "operator": "=",
      "value": "USD"
    }
  ],
  "group_by": "none",
  "sort_by": "final_price",
  "sort_order": "asc",
  "per_page": 10,
  "page": 1,
  "networks": {
    "amazon": {
      "credential_id": "{{my_amz_credential_id}}",
      "credential_secret": "{{my_amz_credential_secret}}",
      "partner_tag": "{{my_amz_partner_tag}}",
      "locale": "US"
    }
  },
  "duplicate_fields_to_exclude": "name,image_url"
}

After getting product results, using outclick URLs for different tracking purposes:

Initial API Response:

{
  "id": "AZN-B07QK2SPP7",
  "name": "JBL FLIP 5 Speaker",
  "urls": {
    "outclick": "https://outclick.co/a/encrypted_url_here",
    "direct": "https://www.amazon.com/dp/B07QK2SPP7",
    "affiliate": "https://www.amazon.com/dp/B07QK2SPP7?tag=yourtag-20",
    "shopnomix": "https://r.v2i8b.com/api/v1/bid/redirect?url=https%3A%2F%2Fwww.amazon.com%2Fdp%2FB07QK2SPP7"
  }
}

Outclick URL Variations:

Standard affiliate tracking:

https://outclick.co/a/encrypted_url_here

Direct merchant link (non-affiliated):

https://outclick.co/a/encrypted_url_here?format=direct

Campaign-specific tracking:

https://outclick.co/a/encrypted_url_here?format=affiliate&sub_id=omni_price_comparison

Shopnomix integration:

https://outclick.co/a/encrypted_url_here?format=shopnomix&sub_id=cashback_campaign

Common Error Scenarios

400 Bad Request: Invalid parameters or malformed request, invalid filter operators

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

Best Practices

Combine criteria and filters effectively: Use criteria for broad searches and filter for precise refinement

Implement caching: Cache results for frequently requested products

Handle errors gracefully: Always wrap API calls in try-catch blocks

Use pagination: For large result sets, implement proper pagination

Monitor rate limits: Track your API usage to avoid hitting limits

Validate URLs: Ensure outclick URLs are properly formatted before use

Optimize filters: Use the most selective filters first to improve performance

Test filter combinations: Some filter combinations may return no results - test thoroughly

Support

For additional help with the Omni API:

Support: support@affiliate.com

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

Omni

Omni API Documentation#

Description#

Advantages#

Request Format#

Request Parameters#

Networks Configuration#

Facets Parameter#

Search Criteria#

Filter Array (Advanced Filtering)#

Filter Fields and Operators#

Response Format#

Example Response#

Response Fields#

Main Response#

Meta Object#

Facets Object#

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#

Network Object#

Merchant Object#

Use Cases and Examples#

1. Amazon ASIN Lookup#

2. URL-Based Product Lookup with Filters#

3. Advanced Filtering and Grouping#

4. Merchant and Network Specific Search#

5. Barcode-Based Search with Stock Filtering#

6. Grouping Results by Criteria#

7. AI-Enhanced Search with ENHANCED Operator#

8. Filtering by Seller Party (First Party vs Third Party)#

9. Using Facets for Dynamic Filtering#

10. Complete Example with All Parameters#

Common Error Scenarios#

Best Practices#

Support#