> ## Documentation Index
> Fetch the complete documentation index at: https://guides.affiliate.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Affiliate product data model: fields and structure

> A reference for the product data model — covering URLs, pricing, inventory, identifiers, attributes, and how to work with each field group.

A product in the Affiliate.com API represents a single item available for sale through an affiliate merchant. Products are sourced from merchant feeds across hundreds of networks and refreshed daily. Each product record normalizes data from the merchant into a consistent structure regardless of which network provided it.

You search for products by sending a `POST` request to:

```
POST /v1/products
```

## Core fields

| Field                   | Type   | Description                                                                                                             |
| ----------------------- | ------ | ----------------------------------------------------------------------------------------------------------------------- |
| `id`                    | string | System-generated unique identifier for the product across all networks                                                  |
| `barcode`               | string | Standardized product identifier — UPC, EAN, ISBN, or GTIN. Case-sensitive                                               |
| `name`                  | string | Product title as provided by the merchant                                                                               |
| `description`           | string | Full product description including features and specifications                                                          |
| `commissionable_status` | string | Commission eligibility: `confirmed_commissionable`, `assumed_commissionable`, `commissionable`, or `not_commissionable` |

## URLs

Each product includes several URL types. The `urls` object is the recommended way to access them.

| Field            | Type   | Description                                                                                                  |
| ---------------- | ------ | ------------------------------------------------------------------------------------------------------------ |
| `commission_url` | string | Legacy affiliate URL. Replace `@@@` with your affiliate ID and `###` with your sub ID. Prefer `urls` instead |
| `direct_url`     | string | Direct link to the product page on the merchant's site — no affiliate tracking                               |
| `image_url`      | string | URL to the primary product image                                                                             |
| `urls`           | object | Structured collection of URL types — see below                                                               |

### The `urls` object

```json theme={null}
{
  "urls": {
    "outclick": "https://outclick.co/a/ENCRYPTED_TOKEN",
    "direct": "https://shop.example.com/products/item-123",
    "affiliate": "https://partners.example-network.com/click?merchant=12345&aff=@@@",
    "shopnomix": "https://r.v2i8b.com/api/v1/bid/redirect?url=..."
  }
}
```

| Field            | Description                                                                                     |
| ---------------- | ----------------------------------------------------------------------------------------------- |
| `urls.outclick`  | Enhanced tracking URL with support for dynamic query parameters (see below)                     |
| `urls.direct`    | Direct merchant link with no affiliate tracking                                                 |
| `urls.affiliate` | Standard network affiliate URL. Replace `@@@` with your affiliate ID and `###` with your sub ID |
| `urls.shopnomix` | Specialized URL for Shopnomix platform integration                                              |

### Outclick URL parameters

You can append query parameters to the `outclick` URL at runtime to control its behavior:

| Parameter           | Effect                                                          |
| ------------------- | --------------------------------------------------------------- |
| `?format=direct`    | Redirects to the direct merchant URL — no commission            |
| `?format=affiliate` | Redirects through the affiliate tracking URL (default behavior) |
| `?format=shopnomix` | Redirects through the Shopnomix URL                             |
| `?sub_id=VALUE`     | Overrides the sub ID for campaign-level attribution             |

For example, to send a user through the affiliate link with a custom sub ID:

```
https://outclick.co/a/ENCRYPTED_TOKEN?format=affiliate&sub_id=summer_sale_2025
```

## Pricing

| Field           | Type    | Description                                                     |
| --------------- | ------- | --------------------------------------------------------------- |
| `currency`      | string  | ISO 4217 three-letter currency code (e.g., `USD`, `EUR`, `GBP`) |
| `regular_price` | float   | Standard retail price before any discounts (e.g., `119.99`)     |
| `final_price`   | float   | Current selling price after discounts (e.g., `99.99`)           |
| `on_sale`       | boolean | `true` if the product is currently discounted                   |
| `sale_discount` | float   | Discount amount in the product's currency                       |

## Inventory

| Field            | Type    | Description                                                                           |
| ---------------- | ------- | ------------------------------------------------------------------------------------- |
| `availability`   | string  | `InStock` or `OutOfStock`                                                             |
| `stock_quantity` | integer | Number of units available. May be `null` if the merchant doesn't provide stock levels |

## Identifiers

| Field     | Type   | Description                                                                                     |
| --------- | ------ | ----------------------------------------------------------------------------------------------- |
| `mpn`     | string | Manufacturer part number. Case-sensitive                                                        |
| `sku`     | string | Merchant-specific inventory identifier. Case-sensitive                                          |
| `barcode` | string | UPC, EAN, GTIN, or ISBN. Case-sensitive                                                         |
| `asin`    | string | Amazon Standard Identification Number. Available on Amazon seller networks only. Case-sensitive |

## Attributes

| Field          | Type   | Description                                                                        |
| -------------- | ------ | ---------------------------------------------------------------------------------- |
| `brand`        | string | Brand or manufacturer name                                                         |
| `category`     | string | Hierarchical category path (e.g., `"Home & Garden > Outdoor Storage > Shelters"`)  |
| `size`         | string | Size designation as provided by the merchant                                       |
| `color`        | string | Color as provided by the merchant                                                  |
| `gender`       | string | Target gender demographic (e.g., `"Men"`, `"Women"`, `"Unisex"`). May be `null`    |
| `material`     | string | Primary materials used in construction                                             |
| `country`      | string | Country of origin                                                                  |
| `condition`    | string | Product condition: `new`, `used`, `refurbished`, or `open-box`                     |
| `seller_party` | string | Whether the product is sold first-party (`1st`), third-party (`3rd`), or `unknown` |

## Network and merchant info

Each product includes embedded `network` and `merchant` objects identifying where the listing comes from:

| Field               | Type    | Description                                 |
| ------------------- | ------- | ------------------------------------------- |
| `network.id`        | integer | Unique identifier for the affiliate network |
| `network.name`      | string  | Display name of the network                 |
| `network.logo_url`  | string  | URL to the network's logo                   |
| `merchant.id`       | integer | Unique identifier for the merchant          |
| `merchant.name`     | string  | Display name of the merchant                |
| `merchant.logo_url` | string  | URL to the merchant's logo                  |

## Timestamps

| Field        | Type   | Description                                                                      |
| ------------ | ------ | -------------------------------------------------------------------------------- |
| `updated_at` | string | ISO timestamp of when the product data was last refreshed from the merchant feed |
| `started_at` | string | ISO timestamp of when this product first appeared in the merchant's feed         |