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. See also the Awin data descriptions help page.
Details
nvarchar
non-null
Awin generated field
Description
This is the 'tracked' version of the merchant_deep_link field. You should use this to ensure you receive commission for your clicks. Where a basket/deep link is unavailable, the product page link will automatically be substituted here.
Details
nvarchar
null
Description
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.
Details
int
non-null
Awin generated field
Description
Awin's unique product ID
Details
int
non-null
Description
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.
Details
nvarchar
non-null
Description
A large (400x400 pixels) image of the primary product being sold.
This image will have a white background. Should you want a large image with a transparent background, consider using the large_image field instead.
Details
nvarchar
non-null
Description
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.
Where the network does not contain No Network, this field should be consistently populated. Developers shouldn’t 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.
Details
nvarchar
non-null
Description
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.
Details
nvarchar
null
Description
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. See also the Awin data descriptions help page.
Details
nvarchar
non-null
Awin generated field
Description
The trading name of the merchant whose products are represented in this data feed.
Details
int
non-null
Awin generated field
Description
A unique ID for the advertiser whose products are represented in this data feed.
Details
nvarchar
non-null
Awin generated field
Description
Awin’s product category for the primary product represented on any given row of the feed.
Details
int
non-null
Awin generated field
Description
Awin’s product category ID for the primary product represented on any given row of the feed.
Details
nvarchar
non-null
Awin generated field
Description
A medium (200x200 pixels) image of the primary product being sold (served from Awin’s servers).
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.
Details
nvarchar
non-null
Description
The shop currency.
Example
GBP
Details
nvarchar
null
Description
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.
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.
Details
nvarchar
Awin generated field
Description
The advertiser’s untracked basket URL (or the 'deepest' URL available for this advertiser). You should only use this URL if you plan on adding your own tracking links.
Details
nvarchar
non-null
Description
Currently supported language.
Example
English
Details
nvarchar
null
Description
This is the date/time the deal described in this row was last imported by our systems.
Details
nvarchar
null
Description
This joins the currency and store_price fields together.
Details
int
non-null
Awin generated field
Description
Awin’s unique ID for the specific data feed that any given row belongs to.
Product specification
The following fields are listed in the Product specifications field section. See also the Awin data descriptions help page.
Details
nvarchar
non-null
Description
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.
Details
int
non-null
Awin generated field
Description
Awin’s unique ID for this brand.
Details
nvarchar
non-null
Description
This is the device’s color 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 color won’t always be available (for SIM cards, for instance). See Specifications and features availability for more information.
Details
nvarchar
null
Description
Finance plan description if deal is a finance deal.
Details
nvarchar
non-null
Description
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.
Not all product types support the below fields. See Specifications and features availability for more information.
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
colourfield 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).
The actual camera resolution in pixels is listed separately in the
device_specifications_json - primary_camera_resolutionfield.
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 (e.g. Super AMOLED).
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_jsonfield.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, or 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).
Details
nvarchar
null
Description
Specifies 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.
This field is currently not being used.
Details
nvarchar
null
Description
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
Details
nvarchar
non-null
Description
The primary product’s dimensions - always in the format H x W x D mm. Dimensions are not always available for all product types (e.g. SIM cards). See Specifications and features availability for more information.
Details
nvarchar
null
Description
This field will be populated with the word exclusive in the case of affiliate channel or publisher exclusives.
Details
nvarchar
null
Description
Any promotional text that relates to the deal (should any exist). It’s 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’s important that it’s displayed to consumers in order for them to be fully informed and improve both chances of click-through and ultimately conversion.
Details
nvarchar
non-null
Description
Describes the type of deal (e.g. Consumer, Upgrade, Business) to allow appropriate filtering.
Product category
The following fields are listed in the Product category field section. See also the Awin data descriptions help page.
This field is currently not being used.
This field is currently not being used.
Main category level 1.
This field is currently not being used.
Sub-category level 1.
This field is currently not being used.
Sub-category level 2.
This field is currently not being used.
Prices
The following fields are listed in the Prices field section. See also the Awin data descriptions help page.
This field is currently not being used.
Details
int
null
Description
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.
Details
int
null
Description
As per the saving field, but represented as a percentage reduction.
Details
decimal
null
Description
Monthly price with discount applied. Expressed as a decimal.
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.
Details
smallmoney
null
Description
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.
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.
Unit of price, e.g. price per piece.
This field is currently not being used.
Details
decimal
null
Description
Describes by how much the monthly cost will increase after the first in-contract price rise. This will be presented as a decimal value to two decimal places. This field will be empty if no price rises apply during the customer’s minimum contractual period.
Far more granular information about price rises is available in deal_cost_json.
Details
date
null
Description
Describes the date, in DD/MM/YYYY format that the price rise described in the warranty field will start to apply. This field will be empty if no price rises apply during the customer’s minimum contractual period.
Far more granular information about price rises is available in deal_cost_json.
Higher price, preceding the current price.
This field is currently not being used.
Delivery and terms
The following fields are listed in the Delivery and terms field section. See also the Awin data descriptions help page.
This field is currently not being used.
This field is currently not being used.
This field is currently not being used.
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).
Details
decimal
null
Description
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.
This field is currently not being used.
Availability
The following fields are listed in the Availability field section. See also the Awin data descriptions help page.
Details
bit
non-null
Description
Contains 1 if in stock, otherwise 0.
This field is currently not being used.
This field is currently not being used.
This field is currently not being used.
Details
int
non-null
Description
This field will always be set to 1 (you can assume that if it appears in the feed, it’s available for sale).
Details
nvarchar
null
Description
The information that was usually available here can now be found in deal_promo_offer field.
Details
bit
non-null
Description
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).
This field is currently not being used.
This field is currently not being used.
This field is currently not being used.
Images
The following fields are listed in the Images field section. See also the Awin data descriptions help page.
Details
nvarchar
non-null
Description
A small (150x150 pixels) thumbnail image of the primary product being sold.
This image will have a white background. If you want an image with a transparent background, consider using the alternate_image field instead.
Details
nvarchar
non-null
Description
The primary device’s large image, 400x400 pixels with transparent background.
Details
nvarchar
non-null
Description
The primary device’s thumbnail image, 200x200 pixels with transparent background.
Details
nvarchar
non-null
Awin generated field
Description
A very small (70x70 pixels) thumbnail image of the primary product being sold.
This image will have a white background. If you want a thumbnail image with a transparent background, consider using the alternate_image field instead.
Ratings
The following fields are listed in the Ratings field section. See also the Awin data descriptions help page.
This field is currently not being used.
This field is currently not being used.
This field is currently not being used.
Custom
The following fields are listed in the Custom field section. See also the Awin data descriptions help page.
Details
nvarchar
null
Description
Extra additional data field number 1.
Example
Contains the retailer logo URL, to be used for linking out to their site or in comparison lists.
Details
nvarchar
null
Description
Extra additional data field number 2.
Example
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.
Details
nvarchar
non-null
Description
Extra additional data field number 3.
Example
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.
Details
nvarchar
non-null
Description
Extra additional data field number 4.
Example
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.
Details
nvarchar
non-null
Description
Extra additional data field number 5.
Example
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.
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 - Another type of retailer discount, but generally expressed as a total £ value.
For example, £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_jsonanddeal_cashback_json.This field should be ignored if the
networkfield 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
Details
nvarchar
non-null
Description
Extra additional data field number 6.
Example
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.
This is often a legal/compliance issue so it’s 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.
Details
nvarchar
non-null
Description
Extra additional data field number 7
Example
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.
Details
nvarchar
null
Description
Extra additional data field number 8
Example
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.
Details
nvarchar
null
Description
Extra additional data field number 9.
Example
The primary product’s product type. See the list of valid product types.
ID
The following fields are listed in the ID field section. See also the Awin data descriptions help page.
Details
int
null
Description
This field will contain the advertiser-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 advertisers were to supply it).
For books (if gift book inside a bundle or similar).
This field is currently not being used.
Details
int
null
Description
Unique tariff ID which can be used to link the same tariff across multiple handsets or even retailers.
Example
An O2 Big Bundle sold by O2 will have the same ID as an O2 Big Bundle sold by mobiles.co.uk.
Details
nvarchar
null
Description
Manufacturer Part Number, if known. This might be useful for display on-site as part of SEO or to provide additional information to customers.
Details
nvarchar
non-null
Description
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.
In practice, the capacity and color 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.
Example
(Apple iPhone 11) 256GB Black or (Samsung Galaxy S10 Plus) 128GB Prism Green.
Details
int
null
Description
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. See also the Awin data descriptions help page.
Details
nvarchar
null
Description
This will contain only basket links.
Unlike the aw_deep_link field described earlier, product page links won’t be substituted in where basket links are unavailable.
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. See also the Awin data descriptions help page.
Details
tinyint
null
Description
The number of months this contract runs for.
Pay-as-you-go products don’t have a term, and so will show 0 in this field.
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.
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.
Details
nvarchar
null
Description
See search_price earlier in this document. Far more detailed pricing information is available in deal_cost_json.
Details
nvarchar
null
Description
This is the deal’s total monthly pre-discounted cost.
This field will be empty if the network field contains No Network. Otherwise you can rely on it being populated.
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.
Refer to the custom_5 field or the deal_cost_json field for details of discounts.
Details
nvarchar
non-null
Description
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.
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.
Details
nvarchar
non-null
Description
Contains the total number of anytime texts available with this contract. Same-network texts are described 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 texts allowance.
Details
nvarchar
non-null
Description
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.
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.
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.
Details
nvarchar
non-null
Description
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
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.
Details
nvarchar
non-null
Description
A short text description of the network contract being sold.
This field should be ignored if the network field contains No Network.
Details
nvarchar
non-null
Description
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.
Details
nvarchar
non-null
Description
The mobile network operator’s brand name. Will be set to No Network in the case of products not sold with a contract.
Details
nvarchar
non-null
Description
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.
Details
nvarchar
non-null
Description
Should always be the same as adding the following fields together:
device_product_json - product_branddevice_product_json - product_namedevice_product_version - product_version_namedevice_product_edition_json - product_edition_name
Example
Apple iPhone 11 (128GB Yellow)
Details
nvarchar
non-null
Description
The primary product’s description.
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.
Details
nvarchar
non-null
Description
See also Displaying tariff information.
This field may (it’s not always populated) contain text that should be passed through unaltered and displayed on your web page. The text usually contains legally required information relating to the package being sold.
Example
Pay cash for your device or spread the cost through a Device Plan on a consumer credit agreement. Subject to status, credit check, payment by Direct Debit. 18+. Subject to availability. Credit provided by Telefónica UK Limited trading as O2, 260 Bath Road, Slough, Berks SL1 4DX. Telefónica UK Limited is authorised and regulated by the Financial Conduct Authority (Reference Number 718822). Terms apply, visit o2.co.uk/terms.
Details
nvarchar
non-null
Description
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.
Details
nvarchar
null
Description
This field contains details of any bundled benefits, gifts or promotions that come with the deal.
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.
This field will be empty if the network field contains No Network and can be ignored.
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
Details
nvarchar
null
Description
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.
Details
decimal
null
Description
ECPM including VAT. This is the deal’s effective monthly cost, taking into account any required upfront payments. Expressed as a decimal.
Details
nvarchar
non-null
Description
Asterisk-delimited list of physical free gifts.
Example
Samsung Wireless Charger Duo Pad (Black) * £125 BT Reward Card
Details
nvarchar
null
Description
Get X with code GETFREETHINGS type offers will appear here when there’s a voucher code that can be used with the deal. Including this should significantly increase conversion where such an offer is available.