Table of Contents

Standard Fields

These fields are available across all verticals and should be used by anyone wishing to include Telco products alongside other types of product.

Note: in order to provide data that can co-exist with far 'simpler' product types, the information in the standard fields is heavily simplified. Anyone planning to make extensive use of Telco products is encouraged to use the JSON Telco fields

Default Fields

The following fields are listed in the "Default Fields" section.

product_name (nvarchar) - null

Describes the primary features of the deal being sold. If the price is a special affiliate-only or publisher exclusive price, this will also be described here.

Example

Samsung Galaxy S10 Plus 128GB Prism White Used (Grade A) at £30 on O2 Refresh Flex (36 Month contract) with Unlimited mins & texts; 15GB of 5G data. £38.25 a month.

aw_product_id (int) - non-nullAWIN Generated Field

Affiliate Window's unique product ID

merchant_product_id (int) - non-null

A unique ID linked to this deal. The unique ID persists from one feed to the next, including in most cases, when monthly or upfront prices change.

merchant_image_url (nvarchar) - non-null

A large (400x400 pixels) image of the primary product being sold.

Note: This image will have a white background. Should you want a large image with a transparent background, consider using the [large_image] field instead.

A note about images.

description (nvarchar) - non-null

The primary product's product description. Usually a paragraph or two long, and designed to act as an introduction to the product's main features and benefits for anyone browsing your product page.

Note: Where the [network] does not contain "No Network", this field should be consistently populated. Developers should not make assumptions about the availability or completeness of product descriptions under other circumstances.

Example

The Xperia 1 was made for the professionals with advanced technology from Sony displays. It features the world´s first 21:9 CinemaWide 4K HDR OLED display and a pro-quality triple lens camera system. Enjoy Dolby Atmos audio through your phone – it creates an amazing audio experience with multi-dimensional sound that flows above and around you and the Xperia 1’s seamless body, sleek metal frame and durable Corning Gorilla Glass 6 front and back means it is perfectly designed to fit comfortably in your hand and looks as good as it feels.

merchant_category (nvarchar) - non-null

The primary product's product type appended with the contract type: e.g. "Mobile Phone - PAYM" or "Mobile Phone - PAYG". See the list of valid product types here.

search_price (nvarchar) - null

The deal's upfront price. This is a one-off price. See [store_price]. This field will always exclude any top-up amount that is associated with the deal. Please remember to check base_price_amount.

Recommended Fields

The following fields are listed in the "Recommended Fields" section.

merchant_name (nvarchar) - non-nullAWIN Generated Field

The trading name of the merchant whose products are represented in this datafeed.

merchant_id (int) - non-nullAWIN Generated Field

A unique ID for the merchant mentioned above.

category_name (nvarchar) - non-nullAWIN Generated Field

Affiliate Window's product category for the primary product represented on any given row of the feed.

category_id (int) - non-nullAWIN Generated Field

Affiliate Window's product category id for the primary product represented on any given row of the feed.

aw_image_url (nvarchar) - non-nullAWIN Generated Field

A medium (200x200 pixels) image of the primary product being sold (served from Affiliate Window's servers).

Note: This image will have a white background. Should you want a large image (though larger, at 400x400 pixels) with a transparent background, consider using the [large_image] field instead.

A note about images.

currency (nvarchar) - non-null

The only currency currently supported is "GBP"

store_price (nvarchar) - null

This is the deal's upfront cost. The upfront cost usually relates to the purchase of a device with a contract (contracts on their own, for instance SIM-only will rarely if ever attract an upfront cost). This field will always exclude any top-up amount that is associated with the deal. Please remember to check base_price_amount.

Note: in some cases, the device and the linked contract can have separate monthly costs. Where this is the case, details can be found in the [deal_cost_json] field.

language (nvarchar) - non-null

Currently the only supported language is 'English'.

last_updated (nvarchar) - null

This is the date/time the deal described in this row was last imported by our systems. 

display_price (nvarchar) - null

This joins the [currency] and [store_price] fields together.

data_feed_id (int) - non-nullAWIN Generated Field

Affiliate Window's unique ID for the specific datafeed that any given row belongs to.

Product Specification

The following fields are listed in the "Product Specifications" field section.

brand_name (nvarchar) - non-null

The primary product's branding. Note that this could be different from the manufacturer, so for instance a "Google Nexus 6" is branded "Google" but is manufactured by Motorola. Wherever possible we will specify the branding rather than the manufacturer. Similarly the "EE Kestrel" is manufactured by Huawei, but will be branded "EE" in our data.

brand_id (int) - non-nullAWIN Generated Field

Affiliate Window's unique ID for this brand

colour (nvarchar) - non-null

This is the device's "Colour Group". We use this for grouping or filtering, and as such the list of acceptable values here has been reduced to a sensible minimum. You won't find any "ruby red" or "sunset orange" style values here, just "red" and orange".

This data is repeated in the [device_features_json] field, along with a list of valid values.

The colour won't always be available (for SIM Cards, for instance). See Specifications and Features availability for more information.

product_short_description (nvarchar) - null

Finance plan description if deal is a finance deal.

specifications (nvarchar) - non-null

The primary product's specifications, represented as a name:value pair, with each specification separated by an asterisk. You can feel free to interpret this field programmatically as it will always remain structured in this way.

Note: Not all product types support the below fields. See Specifications and Features availability for more information.

Note: The below represents the total number of available fields. These will only be displayed where the relevant entry exists for the device being described, so if there's no GPS specification (for instance), you won't see a GPS entry.

Example

* Colour: Gold * SIM Type: Micro SIM * Camera Megapixels: 16 * Camera Flash: LED * Selfie Camera: 2.1 Megapixel, 1080p@30fps * Screen resoution: 1080 x 1920 * Screen size: 5.1" * Screen type: Super AMOLED capacitive touchscreen, 16M colors * Internal memory: 16GB * Memory card slot: microSD, up to 128GB * Processor: 2.5 GHz Quad-core Krait 400 * Chipset: Qualcomm Snapdragon 801 * Cellular support: 2G 3G 4G * Maximum Talk-time: Up to 21 hours * Bluetooth: 4.0 with A2DP, LE, EDR * GPS: A-GPS and GLONASS * Wifi: 802.11 a/b/g/n/ac, dual-band, DLNA, Wi-Fi Direct, Wi-Fi hotspot * Weatherproofing / IP Rating: IP55 & IP58 - Protected against dust, water jets and immersion in water * Weight (grams): 144 * Dimensions: 142 x 72.5 x 8.1 mm * Operating System: Android

Usage

  • Colour - this is the device's 'marketing' colour, could be any value like "ruby red", "scarlett", "blood red" etc., and is used to construct the product name for marketing/advertising purposes. This field should not be used for grouping or filtering is it isn't distinct enough (use the separate [colour] field for this instead.
  • SIM Type - valid values for this are currently limited to: "Combi SIM" (used for SIM cards only), "Standard SIM", "Nano SIM", "Micro SIM". Note that "Micro SIM" and "Standard SIM" devices can be used with "Combi SIM" SIM Cards.
  • Camera Megapixels - The number of megapixels available to the device's primary camera. This field is intended to be used for filtering or grouping products, and so for simplicity rounds up the actual number of megapixels to the nearest 1MP (so a device with 5.2MP would be listed as having 5MP with the exception of devices with less than 1MP where decimal values are allowed).

    Note:The actual camera resolution in pixels is listed separately in the [device_specifications_json] - primary_camera_resolution field.

  • Camera Flash - The type of Flash available with this device (i.e. None, Xenon, LED, etc.)
  • Selfie Camera - Details of the device's secondary or rear-facing camera if available.
  • Screen Resolution - The device's primary display resolution in pixels in "W x H" format.
  • Display Size - The device's primary display size in inches in X" format where valid values could be decimal, and will always end with a double quote.
  • Display Type - A text description of the type of display (like "Super AMOLED", etc.)
  • Internal Memory - The amount of internal storage the device ships with. This value can be quite specific, and will end with either "MB" or "GB". Note this differs from the "Capacity" field, which is rounded to the nearest GB and used for grouping/filtering products.
  • Memory card slot - The type of memory card slot, and the maximum card capacity (if known). 
  • Processor - Details of the device's processor (where known).
  • Chipset - Details of the device's chipset (where known).
  • Cellular Support - Will contain "2G", "3G", "4G" or a combination of those, separated by a space to show whether the device is compatible with those data standards. More detailed information about which frequency bands the device operates on may be available in the [device_specifications_json] field.
  • Maximum Talk-time - Will contain text in the format "Up to x hours". Talk time is always rounded up to the nearest hour for simplicity and to allow for easier filtering/grouping.
  • Bluetooth - The bluetooth version number will always be at the beginning of the string and will be a decimal like "2.0", "2.1", "4.2". This will be followed by any text describing the additional/supported Bluetooth features of the device as advertised by the manufacturer.
  • GPS - The supported GPS standards of the device.
  • Wifi - The supported WiFi standards of the device.
  • Weatherproofing / IP Rating - Describes the device's weatherproofing capabilities along with its IP rating where known.
  • Weight (grams) - An integer rounded up to the nearest gram describing the device's weight.
  • Dimensions - Always in the format "H x W x D mm"
  • Operating System - The device's operating system where known (for instance it is unlikely this field would be populated for a USB Modem or Wifi Dongle).

condition (nvarchar) - null

Whether the primary device (i.e. not including free gifts) is "new" or "refurbished" (these are the only two valid values and will always appear lowercase). Note that some merchants or brands may prefer to have their products described differently (for instance EE prefer to use "Good as new" to describe refurbished products whereas Apple prefer "Refreshed". Where this is the case, you can find the appropriate brand-friendly representation in the [device_features_json] - condition_friendly field.

product_model

This field is currently not being used.

model_number (nvarchar) - null

This is the primary product's full name, excluding the manufacturer/branding. You can prefix the [brand_name] field to this field to construct a full product name.

Example

Galaxy S10 Plus 128GB Prism White

dimensions (nvarchar) - non-null

The primary product's dimensions - always in the format "H x W x D mm". Dimensions are not always available for all product types (SIM Cards being one example). See Specifications and Features Availability for more information.

keywords (nvarchar) - null

This field will be populated with the word 'exclusive' in the case of affiliate channel or publisher exclusives.

promotional_text (nvarchar) - null

Any promotional text that relates to the deal (should any exist). It is expected that this text would be passed through as is and displayed on site. Often this text describes some important aspect of the deal and so it is important that it is displayed to consumers in order for them to be fully informed and improve both chances of click-through and ultimately conversion.

product_type (nvarchar) - non-null

Describes the type of deal (Consumer, Upgrade, Business, etc) to allow appropriate filtering.

Product Category

The following fields are listed in the "Product Category" field section.

commission_group

This field is currently not being used.

merchant_product_category_path

This field is currently not being used.

merchant_product_second_category

This field is currently not being used.

merchant_product_third_category

This field is currently not being used.

Prices

The following fields are listed in the Prices field section.

rrp_price

This field is currently not being used.

saving (int) - null

Monthly saving in £ compared to the ‘regular’ price. When the regular price kicks in will depend on the detailed information found in [deal_discount_json].

savings_percent (int) - null

As per the saving field, but represented as a percentage reduction.

base_price (decimal) - null

Monthly price with discount applied.

NOTE: The discount may not persist for the duration of the contract. Please check the discount fields for further information on the nature of the discount. Expressed as a decimal.

base_price_amount (smallmoney) - null

If the deal is a pay-as-you-go deal, it will often require a mandatory top-up, which will be defined here as a decimal value.

NOTE: that increasingly, merchants like VOXI and giffgaff are selling what appear to be monthly contracts, but are in fact pay as you go tariffs with a recurring monthly payment set up by default. Care should therefore be taken to ensure that the contract_type is considered when deciding how to present pricing information for any given deal.

base_price_text

This field is currently not being used.

product_price_old

This field is currently not being used.

Delivery and Terms

The following fields are listed in the "Delivery and Terms" field section.

delivery_restrictions

This field is currently not being used.

delivery_weight

This field is currently not being used.

warranty

This field is currently not being used.

Note: All new products sold in the UK will have a minimum 1 year warranty and are covered by both EU directive 1999/44/EC (which states that all EU countries have to ensure a retailer could be held liable for all "non-conformities" which manifest within two years from delivery) as well as the UK's SOGA (Sale Of Goods Act).

terms_of_contract (decimal) - null

If this device is sold on finance, and the APR is a fixed rate, it will be presented in this field as a decimal value.

delivery_time

This field is currently not being used.

Availability

The following fields are listed in the "Availability" field section.

in_stock (bit) - non-null

Contains 1 if in stock, otherwise 0.

stock_quantity

This field is currently not being used.

valid_from

This field is currently not being used.

valid_to

This field is currently not being used.

is_for_sale (int) - non-null

This field will always be set to 1 (you can assume that if it appears in the feed, it's available for sale).

web_offer (nvarchar) - null

Note: The info that was usually available here has now moved to the [deal_promo_offer] field.

pre_order (bit) - non-null

Contains 1 if the the device is available for pre-order only, or 0 if the device has some other stock status (could be in stock or out of stock).

stock_status

This field is currently not being used.

size_stock_status

This field is currently not being used.

size_stock_amount

This field is currently not being used.

Images

The following fields are listed in the "Images" field section.

A note about images.

merchant_thumb_url (nvarchar) - non-null

A small (150x150 pixels) thumbnail image of the primary product being sold.

Note: This image will have a white background. Should you want an image with a transparent background, consider using the [alternate_image] field instead.

large_image (nvarchar) - non-null

The primary device's large image, 400x400 pixels with transparent background.

alternate_image (nvarchar) - non-null

The primary device's thumbnail image, 200x200 pixels with transparent background.

aw_thumb_url (nvarchar) - non-nullAWIN Generated Field

A very small (70x70 pixels) thumbnail image of the primary product being sold.

Note: This image will have a white background. Should you want a (slightly larger 150x150 pixels) thumbnail image with a transparent background, consider using the [alternate_image] field instead.

Ratings

The following fields are listed in the "Ratings" field section.

reviews

This field is currently not being used.

average_rating

This field is currently not being used.

rating

This field is currently not being used.

Custom

The following fields are listed in the "Custom" field section.

custom_1 (nvarchar) - null

Contains the retailer logo URL, to be used for linking out to their site or in comparison lists.

custom_2 (nvarchar) - null

Contains the URL for the Retailer's general terms and conditions page.

Note: that this differs from the Network's terms and conditions page found in [network_details_json].

custom_3 (nvarchar) - non-null

This contains the type of contract being sold to the customer. These values can be used to reliably filter/group tariffs. See Tariff Type for a list of valid values.

custom_4 (nvarchar) - non-null

Contains the URL for the primary device's product page on the merchant's website, where available. In most cases, the deeplink URL is better for conversion.

custom_5 (nvarchar) - non-null

Contains an asterisk-delimited list of cash discounts. These are broken down below:

  • "Discount: " - Refers to a discount offered by the retailer (as opposed to a mobile network).

    Examples include Half Price Line Rental or Free Line Rental for a certain number of months.

  • "Network Discount: " - Refers to a discount offered by the Mobile Network themselves. These discounts are usually automatically taken off the customer's monthly bill.

    Note: that a retailer discount and network discount could co-exist in the same deal (this hasn't happened recently, but was the case for a while with Orange deals sold via retailers like mobiles.co.uk).

  • "Cashback: " - Really just another type of retailer discount, but generally expressed as a total £ value.

    "£100 cashback by redemption" or "£325 automatic cashback".

Notes

  • Greater detail on these discounts is available in a structured format in the fields [deal_discounts_json] and [deal_cashback_json].
  • This field should be ignored if the [network] field contains "No Network"
  • The asterisk-delimited structure will exist even when there are no discounts or cashbacks available in the deal. In this case, output would look like this:

    Discount: None * Cashback: None * Network Discount: None

custom_6 (nvarchar) - non-null

Contains the Brand-friendly description for the Data Allowance. In all cases, this field will repeat what you see in [inc_data] while overriding any content that isn't On-Brand. You can therefore rely on this field for display purposes without having to check both fields, but always use the [inc_data] field for comparison/sorting/filtering.

Note: This is often a legal/compliance issue and it is thus important that this value is used in your presentation layer when engaging with customers. The underlying data allowance is still contained in the [inc_data] field and should still be used for comparison/sorting/filtering purposes.

custom_7 (nvarchar) - non-null

This field will contain the total monthly cost the customer can be expected to pay in month 1. In the case of Pay As You Go, this means the cost of the device finance payments (if any) plus the cost of the top-up. For Pay Monthly, this will be the total of any device finance and airtime payments, less any monthly cost discounts.

custom_8 (nvarchar) - null

This field will contain the merchant's internal SKU where this has been supplied by them. This can be useful in certain scenarios such as responding to on-page Javascript events that use the same SKU codes.

custom_9 (nvarchar) - null

The primary product's product type. See the list of valid product types here.

ID

The following fields are listed in the "ID" field section.

ean (int) - null

This field will contain the merchant-supplied GTIN/EAN where the merchant is able to supply one. Note that this field is entirely optional as not all merchants have access to this information. Products should instead be grouped using the parent_product_id field and other fields, as EAN/GTIN is rarely reliable for this purpose (even if all merchants were to supply it).

isbn

This field is currently not being used.

upc (int) - null

Unique Tariff ID which can be used to link the same tariff across multiple handsets or even retailers.

NOTE: An O2 Big Bundle sold by O2 will have the same ID as an O2 Big Bundle sold by mobiles.co.uk.

mpn (nvarchar) - null

Manufacturer Part Number, if known. This might be useful for display on-site as part of SEO or to provide additional information to customers.

parent_product_id (nvarchar) - non-null

This is a unique Product Edition ID. The "product edition" is the lowest level of the product hierarchy and describes a specific product being sold.

NOTE: in practice, the capacity and colour will act as the defining features of this edition (separating it from other editions under the same [product_version]), but in future other defining features could emerge.

(Apple iPhone 11) "256GB Black" or (Samsung Galaxy S10 Plus) "128GB Prism Green"

product_GTIN (int) - null

This field is identical to the EAN field and is provided for compatibility reasons.

Other

The following fields are listed in the "Other" field section.

Simple Telco Fields

The following fields are only available if the user elects to enable the additional "Telco" fields, which we highly recommend. The intention is that the fields below will enhance the information available to users of the standard schema without much additional work.

contract_type (nvarchar) - non-null

See Contract Type Values for a list of valid values.

term (tinyint) - null

The number of months this contract runs for.

Pay-as-you-go products do not have a term, and so will show 0 in this field.

Note: This field will contain the length of the handset finance agreement term where the deal is a giffgaff deal. Since giffgaff are a pay-as-you-go network, there's no term associated with the tariff portion of the deal.

Note: Some Networks for legal reasons don't advertise "1 month" contracts and instead refer to "30 day" contracts. Any brand-friendly contract length descriptions can be found in the [tariff_details_json] - tariff_term_friendly.

initial_cost (nvarchar) - null

See [search_price] earlier in this document. Far more detailed pricing information is available in [deal_cost_json].

month_cost (nvarchar) - null

This is the deal's total monthly pre-discounted cost.

Note: This field will be empty if the [network] field contains "No Network". Otherwise you can rely on it being populated.

Note: that in some cases, the phone and contract are sold separately, with a finance agreement covering the device's monthly cost, and a separate contract governing the services provided by the Network. Details of these 'split' monthly pricing deals (of which O2's Refresh tariffs are one example) can be found in the more detailed [deal_cost_json] field. In all cases, even where the monthly cost is split, this field will represent the sum of the device and contract monthly costs.

Note: Refer to the [custom_5] field or the [deal_cost_json] field for details of discounts.

inc_minutes (nvarchar) - non-null

Contains the total number of cross-network, anytime minutes available with this contract. Some or all of these minutes may be eligible for use abroad. Where this is the case it will only be described in the more detailed [tariff_allowances_json] field.

Note: This field will be empty if the network field contains "No Network" or if the tariff type being sold doesn't include a minutes allowance.

inc_texts (nvarchar) - non-null

Contains the total number of anytime texts available with this contract. Same-network texts are described in [tariff_allowances_json]

Note: This field will be empty if the [network] field contains "No Network" or if the tariff type being sold doesn't include a texts allowance.

inc_data (nvarchar) - non-null

Contains the total amount of data included in this contract, expressed as a number of megabytes. This excludes any WiFi allowances that might be described in the more detailed [tariff_allowances_json] field.

Note: This field will be empty if the [network] field contains "No Network" or if the tariff type being sold doesn't include a data allowance.

IMPORTANT NOTE: This field can be used reliably for sorting/filtering/grouping, but please refer to the [custom6] field for the Brand-friendly description of any data allowances included in this deal. This can be important for legal/compliance reasons and so should not be skipped.

connectivity (nvarchar) - non-null

Describes the effective 'speed' at which the combination of device and tariff will allow the customer to access data services. See Connectivity Types for available values

Note:
  • Device capabilities are described in detail in [device_specifications_json] and contract details can be found in [tariff_allowances_json].
  • This field will be empty if the network field contains "No Network" or if the tariff type being sold doesn't include a data allowance.

tariff (nvarchar) - non-null

A short text description of the Network contract being sold.

Note: This field should be ignored if the network field contains "No Network"

storage_size (nvarchar) - non-null

Describes the primary device's storage capacity rounded to the nearest GB. This field is intended to be used for filtering/grouping similar products and may not be available in all cases. See Specifications and Features availability for more information.

network (nvarchar) - non-null

The Mobile Network Operator's brand name. Will be set to "No Network" in the case of products not sold with a contract.

operating_system (nvarchar) - non-null

The primary device's operating system, where known (USB Modems for instance are unlikely to have an Operating System listed). See Specifications and Features availability for more information.

device_full_name (nvarchar) - non-null

Should always be the same as adding the following fields together:

Example

Apple iPhone 11 (128GB Yellow)

device_description (nvarchar) - non-null

The primary product's product description.

Note: In all cases where the [network_details_json] - company_id field is not "76", this description should be fully populated. Developers should not assume the existence of a complete description under other circumstances.

deal_promo_info (nvarchar) - non-null

See also Displaying tariff information.

Should the deal have any promotional information tied to it, this will be displayed here. The text should be passed through unaltered where possible as it could contain important information about the customer's deal.

deal_promo_offer (nvarchar) - null

This field contains details of any bundled benefits, gifts or promotions that come with the deal.

Note: this is a very simple, asterisk-delimited representation. A significantly more detailed and structured representation of this data is available in the [deal_extras_json]

Note: This field will be empty if the [network] field contains "No Network" and can be ignored.

Note: This is the new [web_offer] field. All information that was previously there is now here.

Example

* Charge to mobile * Share your data across multiple devices * O2 Priority * Unlocked Phones * Recommend a Friend and Earn Rewards * O2 Travel * Virgin Wi-Fi Hotspots * O2 Wi-Fi Hotspots * O2 Refresh Flex * O2 Yearly Upgrade * Disney+ Subscription

subscription_name (nvarchar) - null

Products sold on Finance will often have a 'branded' name, such as Sky's 'SWAP' payment plans, and Tesco's 'Upgrade Anytime Flex' payment plans. Where there is clear branding associated with a payment plan, we will include that information here.

subscription_price_effective (decimal) - null

ECPM including VAT. This is the deal’s effective monthly cost, taking into account any required upfront payments. Expressed as a decimal.

gift (nvarchar) - non-null

Star delimitted list of physical free gifts.

“Samsung Wireless Charger Duo Pad (Black) * £125 BT Reward Card”

special_offer (nvarchar) - null

Get X with code GETFREETHINGS' type offers will appear here where there's a voucher code that can be used with the deal'. Including this should significantly increase conversion where such an offer is available.