Valid Values Reference Guide

Deal Type

The Deal Type lookup table below lists all the IDs and their meanings. The IDs tend to be used in JSON fields, while the text values appear in the simpler CSV fields.

NOTE: Not all values are used across all feeds. Whether a value is used depends on the scope of products each merchant ranges and the demographics they target with those deals.

0 - "Consumer" - default. Note that Consumer deals don't necessarily exclude business customers, but they will be billed inclusive of VAT.
1 - "Consumer Upgrade" - as above, but limited to customers who already have a qualifying product from the Network this deal applies to. The most obvious example is a customer who already has an O2 mobile phone contract, and would like to buy another O2 contract, but upgrade their handset at the same time, keeping their number.
2 - "Consumer Existing Customer" - Unlike above, the customer might have a non-mobile contract (like broadband or TV). These "existing customer" deals provide favourable pricing for customers who already purchase some other service from the Network in question. Current examples include Virgin Mobile (who sell discounted mobile products to their existing Broadband/TV customers) and TalkTalk whose mobile products are ONLY available to their existing customers.
3 - "Business" - Available to business customers only. Prices should be represented as ex. VAT wherever possible (or clearly marked as including VAT).
4 - "Recycling - New" - Available to business customers only. Prices should be represented as ex. VAT wherever possible (or clearly marked as including VAT).
5 - "Recycling - Working" - Available to business customers only. Prices should be represented as ex. VAT wherever possible (or clearly marked as including VAT).
6 - "Recycling - Broken" - Available to business customers only. Prices should be represented as ex. VAT wherever possible (or clearly marked as including VAT).
7 - "Consumer - Affiliate Price" - Special affiliate price. You will also see 'exclusive' in the keywordsfield, and "Consumer" in the product_type field.
8 - "Consumer Existing Customer - Affiliate Price" - As above, but for existing customers. You will also see 'exclusive' in the keywords field, and "Consumer Existing Customer" in the product_type field.
9 - "Consumer - Publisher Exclusive" - This will only appear if you have agreed an exclusive with the advertiser. You will also see 'exclusive' in the keywords field, and "Consumer" in the product_type field.
10 - "Consumer Existing Customer - Publisher Exclusive" - As above but for existing customers. You will also see 'exclusive' in the keywords field, and "Consumer Existing Customer" in the product_type field.
11 - "Dummy Deal" - These types of deals should never be encountered. If you are recieving one, please contact us.
12 - "Trade-in" - This price is dependent on the customer trading in an eligible device.

Product Types

The product type relates to the deal device as well as any extras that may be included in the deal and referenced from deal_extras_json. Each product type has an ID which would usually be referenced in the json fields with the text value. Simpler CSV fields will use just the text value.

NOTE: Not all values are used across all feeds. Whether a value is used depends on the scope of products each merchant ranges and the demographics they target with those deals.

1 - Mobile Phone
2 - SIM Card
3 - Tablet
4 - USB Modem
5 - Laptop
6 - Mobile Wi-Fi
7 - Game Console
8 - Smartwatch
9 - Television
10 - Wearable
11 - Case
12 - Headphones
13 - Software
14 - Camera
15 - Media Streamers & Players
16 - Charging, Docks & Stands
17 - Personal Grooming
18 - Input Devices
19 - Toys & Gadgets
20 - Speakers
21 - VR Headsets
22 - Smart Home
23 - Multiplay Device
24 - Router
25 - TV Box
26 - Output Devices
27 - Portable Memory
28 - GPS Tracker
29 - Personal Transportation
30 - Landline Device
31 - Fitness Accessory

Tariff Type

This is the type of contract being sold to the customer.

NOTE: Tariff_types 12,13,14,15,16 and 17 are reserved for TV, Landline and Broadband feeds, and won’t ever be encountered in a Mobile Phone feed

NOTE: Not all values are used across all feeds. Whether a value is used depends on the scope of products each merchant ranges.

1 - "Mobile Broadband Contract" - A contract that usually only includes a data allowance.
2 - "Mobile Broadband Pre-pay" - A pay-as-you-go deal with no contractual commitment intended for use with MBB devices.
4 - "Phone Contract" - A contract that usually includes minutes, texts and data.
5 - "Phone Pre-pay" - A pay-as-you-go deal with no contractual commitment intended for use with phones.
11 - "SIM/Contract Free"
12 - "Broadband"
13 - "Landline"
14 - "TV"
15 - "Broadband and Landline"
16 - "TV, Broadband and Landline"
17 - "TV, Mobile, Broadband and Landline"

Extra Group Types

Used as part of [deal_extras_json], the Extra Group Type provides a detailed categorisation for any included extras. This should allow your software to break out any extras that you would like to provide special handling for (e.g. physical free gifts, topups).

Note: An ID of 1 means the Source Type is an Allowance (data/texts/minutes), and an ID of 2 means the Source Type is a Product (most usually applies to free gifts). An ID that begins 255 is 'something else' - this is used for most other 'soft' benefits like additional services or rewards.

1 - "Allowance" - A minutes, texts or data allowance (see interpreting the groupingId)
2 - "Product" - A physical product (see interpreting the groupingId)
255-1 - Gift Voucher
255-2 - Pay as you go Top-up
255-3 - Service Attributes
255-4 - Entertainment freebies and discounts
255-5 - Enhanced customer service
255-7 - Rewards Points
255-10 - Calls to special numbers
255-11 - Roaming services
255-16 - Trade-in Discounts
255-17 - Charity Donations
255-18 - Phone backup and protection services
255-19 - Commitments and Guarantees
255-23 - Free or discounted allowances
255-25 - Free or discounted software
255-26 - Free Gift
255-27 - VOIP Services
255-28 - Separate Call & Device Contract

Extra Source Types

Used as part of [deal_extras_json], the Extra Source Type provides a broad categorisation for any included extras. This might allow you to apply further logic to your categorisation code.

1 - Free Gifts - Contains details of any physical goods included as part of the deal, for instance free televisions, games consoles or boxed software that the customer owns without limitation. Time-limited software (like "Free Evernote Premium for a year") is considered a free service, and included in "Inclusive Services" (below) instead.
2 - Inclusive Services - Contains details of services or allowances that are included as part of the deal at no extra cost to the customer. Current examples include "Extra 750MB Wifi for the first 3 months", "BlackBerry services", "Tethering", and "6 months free Netflix".
3 - Discounts & Loyalty - Contains details of rewards or discounts linked (perhaps loosely) to customer loyalty. Examples include Tesco Clubcard points, charity donations on the customer's behalf or trade-in discounts for existing customers.
4 - Comes with (chargeable) - Contains details of additional products or services that are a mandatory part of the overall deal but for which the price charged isn't reflected in the upfront price. In all current examples this is limited to Top-ups for PAYG devices but there may well be different types in future. This is arguably a hangover from the days when a phone could be purchased (from a bricks-and-mortar shop) with a larger Top-up if required and so the price of the Top-up was excluded from the advertised price, but this doesn't actually happen on the web. You might consider just rolling the cost of the topup into the upfront price, though this risks making the deal look less attractive.
6 - Bundled products - Contains details of any bundled products or services that make up the Deal. The most obvious current examples are EE's Sharer deals that contain two products and two tariffs intended to be shared amongst the devices.

Allowance Types

Where the extra_group_type = 1, the allowance_type allows your code to understand whether you are dealing with an e.g. data allowance vs. a texts allowance that is being bundled into the deal.

1 - Talk Time
2 - Texts
3 - Data
4 - Channels

Discount Types

The Discount Types combined allow your code to understand the nature of the discount being offered and to calculate your own representation of the discount (you may have a preference for £ reduction or % for example). Alternatively discounts are also described in less detail in the simpler CSV fields.

1 - Fixed price (for instance, Pay only £20/month - the _value field will contain the monthly price in pence)
2 - Fixed reduction (for instance, £20 off per month - the _value field will contain the monthly discount in pence)
4 - Pay percentage (for instance, pay only 50% each month - the _value field will contain the percentage of the monthly price to be paid by the customer)
8 - Percentage reduction (for instance, 25% off each month - the _value field will contain the percentage discount)

Payment types (used in the above nd_payment_type_id and rd_payment_type_id fields):

32 - By redemption
64 - Automatic payment

Connectivity Type

Describes the fastest 'speed' at which the contract will allow the customer to access data services

"3G"
"4G"
"4G Double Speed"
"5G"

Colour Group

Used for filtering/grouping. 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".

Black
Blue
Brown
Gold
Green
Grey
Orange
Pink
Purple
Red
Rose Gold
Silver
White
Yellow

Table of Contents