|
|
|
|
Broadband, TV and Landline
Enhanced Feed Documentation |
Contact
broadband@bigupdata.co.uk if you would like access to the postcode lookup
API. |
| Create-a-feed field name |
API Field Name |
Data Type |
Description |
Expected Values |
| custom_3 |
|
string |
A
star-delimited list of gift cards or cashbacks included in the package |
text |
| aw_deep_link |
awin_deep_link |
string |
The
recommended URL to use for conversions, with tracking pre-applied |
URL |
| Telcos:connectivity |
broadband_connectivity |
string |
The
type of broadband technology in use. This is a broad descriptor designed to
give a feel for the technology in use since the technology landscape is
varied and ever changing (and often opaque). Cable Broadband relates to older
ADSL technologies (PSTN), Fibre/Hybrid relates to newer next-gen products
such as Fibre to the Cabinet and DOCSIS, while full fibre relates to Fibre To
The Premises. |
Fibre
/ Hybrid Broadband
Cable Broadband
Full Fibre Broadband |
| Telcos:tariff |
broadband_contract_name |
string |
The
name of the Broadband tariff included as part of the package |
text |
| Telcos:inc_data |
broadband_inc_data |
string |
Will
contain a Home Broadband GB data allowance, though this is more often than
not "Unlimited" |
text |
| stock_quantity |
broadband_speed_download |
decimal |
Broadband
download speed |
number |
| number_available |
broadband_speed_upload |
decimal |
Broadband
upload speed |
number |
| |
deal_cashback |
decimal |
The
value of any cashback associated with the deal (API Only) |
|
| |
deal_cashback_type |
string |
The
type of cashback (automatic comes off the bill, redemption will require that
the customer applies for their cashback according to rules the merchant or
any 3rd party involved in the promotion will set) |
Automatic
By Redemption |
| currency |
deal_currency |
string |
The
currency in use |
GBP |
| valid_to |
deal_ends |
datetime |
The
date and time the deal becomes invalid (do not advertise after this time) |
date & time |
| |
deal_giftcard_name |
string |
The
name of any giftcard associated with the deal (API Only) |
text |
| |
deal_giftcard_value |
decimal |
The
value of any giftcard associated with the deal (API Only) |
number |
| merchant_product_id |
deal_id |
integer |
Bigupdata's
product ID for this product. This ID should only change if the components of
any given deal/bundle change significantly (such as the addition of a gift,
or a change of contract length). Note that certain engineering changes can
also force deal IDs to be updated so they shouldn't be relied upon for
anything that has a commercial implication. |
number |
| last_updated |
deal_last_updated |
datetime |
The
last time we saw a change on this deal. Note this isn't an indication of how
often or when the deal was last checked - only when it last changed. |
date & time |
| promotional_text |
deal_promo_info |
string |
Will
contain text describing any promotions attached to the deal. Note this is
human-readable rather than machine parsable text. |
text |
| custom_1 |
deal_requires_phone_line |
string |
Whether
or not the deal requires a phone line. This is sometimes known ahead of time,
but often requires a postcode lookup to be performed against the customer's
address. Publishers using the feed only will see "Address Check
Required", or "Not Required" depending on whether this
information is known upfront. Users of the API will further see
"Required" appear as a value following a postcode lookup depending
on the results for any given postcode. |
Address
Check Required
Not Required
Required |
| brand_name |
deal_retailer |
string |
The
merchant's brand name |
text |
| description |
deal_retailer_terms |
string |
A
public URL containing the merchant's terms of service |
URL |
| mpn |
deal_sku |
string |
The
merchant's unique SKU for this package where known (in most cases this will
be included) |
text |
| valid_from |
deal_starts |
datetime |
The
date and time the deal becomes valid (do not advertise before this time) |
date & time |
| Telcos:term |
deal_term |
integer |
The
contract length of this package overall (note that components may have a
shorter contract length though this is unusual at the time of writing) |
number |
| product_type |
deal_type |
string |
Indicates
who the package is aimed at |
Consumer
Consumer Upgrade
Consumer Existing Customer
Business
Consumer - Affiliate Price
Consumer Existing Customer - Affiliate Price
Consumer - Publisher Exclusive
Consumer Existing Customer - Publisher Exclusive
Trade-in |
| |
extras_list |
string |
Contains
a star-delimited list of the freebies and promotional offers included in this
package. |
text |
| keywords |
keywords |
string |
Will
contain 'exclusive' where this is a publisher or affiliate exclusive. |
exclusive |
| merchant_product_third_category |
landline_contract_name |
string |
The
name of the Landline Contract included in the package (if any) |
text |
| |
landline_device_brand |
string |
The
brand name of any landline device included as part of the package (API Only) |
text |
| |
landline_device_image |
string |
An
image of any landline device included as part of the package (API Only) |
text |
| |
landline_device_name |
string |
The
name of any landline device included as part of the package (API Only) |
text |
| alternate_image |
network_logo |
string |
The
network's brand logo |
Image URL |
| Telcos:network |
network_name |
string |
The
name of the network providing the package |
text |
| terms_of_contract |
network_terms |
string |
A
public URL containing the network's terms of service (in many cases this is
the same as the merchant) |
URL |
| Telcos:gift |
physical_gift_list |
string |
A
star-delimited list of physical gifts included in the package (such as a free
iPad) |
text |
| custom_8 |
price_monthly_broadband |
decimal |
The
monthly cost for the Broadband component of any package (if any). This will
be included in the total monthly cost. |
number |
| savings_percent |
price_monthly_discount_pct |
decimal |
The
amount being saved every month taking into account any discounts expressed as
a percentage |
number |
| saving |
price_monthly_discount_pounds |
decimal |
The
amount being saved every month taking into account any discounts |
number |
| Telcos:subscription_renewal |
price_monthly_discount_term |
integer |
The
number of months any discount runs for |
number |
| Telcos:month_cost |
price_monthly_discounted |
decimal |
The
total monthly cost the customer will pay, including any discounts being
applied |
number |
| custom_9 |
price_monthly_landline |
decimal |
The
monthly cost for the Landline component of any package (if any). This will be
included in the total monthly cost. |
number |
| rrp_price |
price_monthly_original |
decimal |
The
original total monthly cost BEFORE any discounts are applied |
number |
| Telcos:subscription_price_effective |
price_monthly_postcontract |
decimal |
The
monthly price of the contract after the contract term expires (if published) |
number |
| custom_7 |
price_monthly_tv |
decimal |
The
monthly cost for the TV component of any package (if any). This will be
included in the total monthly cost. |
number |
| |
price_upfront_activation |
decimal |
The
cost of activation (if any) (API Only) |
number |
| delivery_cost |
price_upfront_delivery |
decimal |
The
cost of delivery (will be included in the total upfront cost) |
number |
| base_price |
price_upfront_hardware |
decimal |
The
amount being charged upfront for any devices included in the package. This
will be included in the total upfront cost. |
number |
| |
price_upfront_installation |
decimal |
The
cost of installation (if any) (API Only) |
number |
| custom_6 |
price_upfront_setup |
decimal |
The
total of any upfront activation and/or installation charges. This will be
included in the total upfront cost. Use either this, or the
price_upfront_activation and price_upfront_installation fields, but not all
three. |
number |
| search_price |
price_upfront_total |
decimal |
The
total upfront cost of the package (to be paid at checkout) |
number |
| product_short_description |
product_merchant_name |
string |
The
merchant's own package/bundle Title / Description if supplied. Note that this
won't always be available (e.g. where data is sourced from the merchant's own
API) |
text |
| product_name |
product_name |
string |
The
name of the product/bundle, summary of main components |
text |
| merchant_product_category_path |
router_brand |
string |
The
brand name of the Broadband Router included in the package (if any) |
text |
| alternate_image_two |
router_image |
string |
An
image of the broadband router included in the package (if any) |
Image URL |
| model_number |
router_name |
string |
The
name of a broadband router included in the package (if any) |
text |
| Telcos:device_description |
tv_box_brand |
string |
The
brand of the TV Box included in the package (if any) |
text |
| alternate_image_three |
tv_box_image |
string |
An
image of the TV Box included in the package (if any) |
Image URL |
| Telcos:device_full_name |
tv_box_name |
string |
The
name of the TV Box included in the package (if any) |
text |
| custom_5 |
tv_contract_channels |
integer |
The
number of TV channels included in the package (if any) |
number |
| merchant_product_second_category |
tv_contract_name |
string |
The
name of the TV Contract included in the package (if any) |
text |
| basket_link |
url_basket |
string |
Where
available, this will be a link as close to the basket as possible (often the
postcode lookup screen for broadband deals) with the relevant package
preselected where possible. This link is untracked. |
URL |
| Telcos:special_offer |
voucher_code |
string |
Will
contain details of any voucher code if one can be applied |
text |
| custom_2 |
voucher_purpose |
string |
To
be used in conjunection with Telcos:special_offer - will contain a
description of what the voucher code entitles the user to |
text |
| aw_product_id |
|
integer |
AWIN's
product ID for this product. Note this could change over time. |
number |
| display_price |
|
string |
This
is the upfront price prefixed with the currency |
text |
| in_stock |
|
integer |
Will
always contain 1 for package deals. If the deal is not available it won't be
included in the data. |
1 |
| is_for_sale |
|
integer |
Will
always contain 1 (can be ignored) |
1 |
| merchant_category |
awin_merchant_category |
string |
A
text description of the type of bundle |
Broadband
and Landline Contract
Broadband, TV and Landline Contract
Broadband, TV, Landline and Phone Contract
Broadband and Phone Contract
Broadband and TV Contract |
| merchant_deep_link |
|
string |
The
recommended URL to use for conversions, WITHOUT tracking pre-applied (use
aw_deep_link if you would like tracking applied) |
URL |
| merchant_id |
|
integer |
The
ID of the merchant in AWIN's systems (mid or merchant ID) |
number |
| merchant_image_url |
deal_retailer_logo |
string |
The retailer's brand logo |
Image URL |
| merchant_name |
|
string |
The name of the
merchant in AWIN's systems |
text |
| pre_order |
|
integer |
Will
always contain 0 (can be ignored) |
0 |
| Telcos:contract_type |
awin_contract_type |
integer |
The
ID of the contract type in bigupdata's systems. This relates directly to the
values in merchant_category. |
15 ��� Broadband and Landline Contract
16 ��� Broadband, TV and Landline
Contract
17 ��� Broadband, TV, Landline and
Phone Contract
18 ��� Broadband and Phone
Contract
19 ��� Broadband and TV Contract |
| web_offer |
|
string |
Contains
a star-delimited list of the freebies and promotional offers included in this
package. Will mention any landline devices that might be included in the
package (though these are unusual). |
text |
|
|
|
|
|
