Telco data feeds - broadband, TV, and landline

Details

• Data type: string

• Expected values: image URL

• Equivalent API field: router_image

Description

An image of the broadband router included in the package (if any).

Details

• Data type: string

• Expected values: image URL

• Equivalent API field: tv_box_image

Description

An image of the TV Box included in the package (if any).

Details

• Data type: string

• Expected values: URL

• Equivalent API field: awin_deep_link

Description

The recommended URL to use for conversions, with tracking pre-applied.

Details

• Data type: integer

• Expected values: number

• Equivalent API field: n/a

Description

Awin’s product ID for this product. Note this could change over time.

Details

• Data type: decimal

• Expected values: number

• Equivalent API field: price_upfront_hardware

Description

The amount being charged upfront for any devices included in the package. This will be included in the total upfront cost.

Details

• Data type: string

• Expected values: text

• Equivalent API field: deal_retailer

Description

The merchant’s brand name.

Details

• Data type: string

• Expected values: e.g. GBP

• Equivalent API field: deal_currency

Description

The currency in use.

Details

• Data type: string

• Expected values:

  • Address Check Required

  • Not Required

  • Required

• Equivalent API field: deal_requires_phone_line

Description

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.

Details

• Data type: string

• Expected values: text

• Equivalent API field: voucher_purpose

Description

To be used in conjunction with Telcos:special_offer - will contain a description of what the voucher code entitles the user to.

Details

• Data type: string

• Expected values: text

• Equivalent API field: n/a

Description

An asterisk-delimited list of gift cards or cashbacks included in the package.

Details

• Data type: decimal

• Expected values: number

• Equivalent API field: price_upfront_setup

Description

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.

Details

• Data type: decimal

• Expected values: number

• Equivalent API field: price_monthly_tv

Description

The monthly cost for the TV component of any package (if any). This will be included in the total monthly cost.

Details

• Data type: decimal

• Expected values: number

• Equivalent API field: price_monthly_broadband

Description

The monthly cost for the broadband component of any package (if any). This will be included in the total monthly cost.

Details

• Data type: decimal

• Expected values: number

• Equivalent API field: price_monthly_landline

Description

The monthly cost for the landline component of any package (if any). This will be included in the total monthly cost.

Details

• Data type: decimal

• Expected values: number

• Equivalent API field: price_upfront_delivery

Description

The cost of delivery (will be included in the total upfront cost).

Details

• Data type: string

• Expected values: text

• Equivalent API field: n/a

Description

This is the upfront price prefixed with the currency.

Details

• Data type: integer

• Expected values: 1

• Equivalent API field: n/a

Description

Will always contain 1 for package deals. If the deal is not available it won’t be included in the data.

Details

• Data type: integer

• Expected values: 1

• Equivalent API field: n/a

Description

Will always contain 1 (can be ignored).

Details

• Data type: string

• Expected values: exclusive

• Equivalent API field: keywords

Description

Will contain exclusive where this is a publisher or affiliate exclusive.

Details

• Data type: datetime

• Expected values: date and time

• Equivalent API field: deal_last_updated

Description

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.merchant_category

Details

• Data type: string

• Expected values: URL

• Equivalent API field: n/a

Description

The recommended URL to use for conversions, without tracking pre-applied (use aw_deep_link if you would like tracking applied).

Details

• Data type: integer

• Expected values: number

• Equivalent API field: n/a

Description

The ID of the merchant in Awin’s systems (MID or merchant ID).

Details

• Data type: string

• Expected values: image URL

• Equivalent API field: deal_retailer_logo

Description

The retailer's brand logo.

Details

• Data type: string

• Expected values: text

• Equivalent API field: n/a

Description

The name of the merchant in Awin’s systems.

Details

• Data type: string

• Expected values: text

• Equivalent API field: router_brand

Description

The brand name of the broadband router included in the package (if any).

Details

• Data type: string

• Expected values: text

• Equivalent API field: tv_contract_name

Description

The name of the TV contract included in the package (if any).

Details

• Data type: string

• Expected values: text

• Equivalent API field: landline_contract_name

Description

The name of the landline contract included in the package (if any).

Details

• Data type: string

• Expected values: text

• Equivalent API field: router_name

Description

The name of a broadband router included in the package (if any).

Details

• Data type: string

• Expected values: text

• Equivalent API field: deal_sku

Description

The merchant’s unique SKU for this package where known (in most cases this will be included).

Details

• Data type: decimal

• Expected values: number

• Equivalent API field: broadband_speed_upload

Description

Broadband upload speed.

Details

• Data type: string

• Expected values: text

• Equivalent API field: product_name

Description

The name of the product/bundle, summary of main components.

Details

• Data type: string

• Expected values: text

• Equivalent API field: product_merchant_name

Description

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).

Details

• Data type: string

• Expected values:

  • 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

• Equivalent API field: deal_type

Description

Indicates who the package is aimed at.

Details

• Data type: string

• Expected values: text

• Equivalent API field: deal_promo_info

Description

Will contain text describing any promotions attached to the deal. Note this is human-readable rather than machine parsable text.

Details

• Data type: decimal

• Expected values: number

• Equivalent API field: price_monthly_original

Description

The original total monthly cost before any discounts are applied.

Details

• Data type: decimal

• Expected values: number

• Equivalent API field: price_monthly_discount_pct

Description

The amount being saved every month taking into account any discounts expressed as a percentage.

Details

• Data type: decimal

• Expected values: number

• Equivalent API field: price_upfront_total

Description

The total upfront cost of the package (to be paid at checkout).

Details

• Data type: decimal

• Expected values: number

• Equivalent API field: broadband_speed_download

Description

Broadband download speed.

Details

• Data type: string

• Expected values:

  • Fibre / Hybrid Broadband

  • Cable Broadband

  • Full Fibre Broadband

• Equivalent API field: broadband_connectivity

Description

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.

Details

• Data type: integer

• Expected values:

  • 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

• Equivalent API field: awin_contract_type

Description

The ID of the contract type in bigupdata’s systems. This relates directly to the values in merchant_category.

Details

• Data type: string

• Expected values: text

• Equivalent API field: tv_box_name

Description

The name of the TV box included in the package (if any).

Details

• Data type: string

• Expected values: text

• Equivalent API field: physical_gift_list

Description

An asterisk-delimited list of physical gifts included in the package (such as a free iPad).

Details

• Data type: string

• Expected values: text

• Equivalent API field: broadband_inc_data

Description

Will contain a home broadband GB data allowance, though this is more often than not Unlimited.

Details

• Data type: decimal

• Expected values: number

• Equivalent API field: price_monthly_discounted

Description

The total monthly cost the customer will pay, including any discounts being applied.

Details

• Data type: string

• Expected values: text

• Equivalent API field: network_name

Description

The name of the network providing the package.

Details

• Data type: decimal

• Expected values: number

• Equivalent API field: price_monthly_postcontract

Description

The monthly price of the contract after the contract term expires (if published).

Details

• Data type: integer

• Expected values: number

• Equivalent API field: price_monthly_discount_term

Description

The number of months any discount runs for.

Details

• Data type: string

• Expected values: text

• Equivalent API field: broadband_contract_name

Description

The name of the broadband tariff included as part of the package.

Details

• Data type: integer

• Expected values: number

• Equivalent API field: deal_term

Description

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).

Details

• Data type: string

• Expected values: URL

• Equivalent API field: network_terms

Description

A public URL containing the network’s terms of service (in many cases this is the same as the merchant).

Details

• Data type: datetime

• Expected values: date & time

• Equivalent API field: deal_ends

Description

The date and time the deal becomes invalid (do not advertise after this time).

Details

• Data type: string

• Expected values: text

• Equivalent API field: n/a

Description

Contains an asterisk-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).

Details

• Data type: string

• Expected values:

  • Fibre / Hybrid Broadband

  • Cable Broadband

  • Full Fibre Broadband

• Equivalent create-a-feed field: Telcos:connectivity

Description

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.

Details

• Data type: string

• Expected values: URL

• Equivalent create-a-feed field: aw_deep_link

Description

The recommended URL to use for conversions, with tracking pre-applied.

Details

• Data type: string

• Expected values: text

• Equivalent create-a-feed field: Telcos:tariff

Description

The name of the broadband tariff included as part of the package.

Details

• Data type: string

• Expected values: text

• Equivalent create-a-feed field: Telcos:inc_data

Description

Will contain a home broadband GB data allowance, though this is more often than not Unlimited.

Details

• Data type: string

• Expected values:

  • Broadband and Landline Contract

  • Broadband, TV and Landline Contract

  • Broadband, TV, Landline and Phone Contract

  • Broadband and Phone Contract

  • Broadband and TV Contract

• Equivalent create-a-feed field: merchant_category

Description

A text description of the type of bundle.

Details

• Data type: string

• Expected values:

  • Automatic

  • By Redemption

• Equivalent create-a-feed field: n/a

Description

The type of cashback. Automatic comes off the bill, while Redemption will require that the customer applies for their cashback according to rules the merchant or any third party involved in the promotion will set.

Details

• Data type: decimal

• Expected values: number

• Equivalent create-a-feed field: n/a

Description

The value of any cashback associated with the deal.

Details

• Data type: string

• Expected values: e.g. GBP

• Equivalent create-a-feed field: currency

Description

The currency in use.

Details

• Data type: datetime

• Expected values: date & time

• Equivalent create-a-feed field: valid_to

Description

The date and time the deal becomes invalid (do not advertise after this time).

Details

• Data type: decimal

• Expected values: number

• Equivalent create-a-feed field: number_available

Description

Broadband upload speed.

Details

• Data type: decimal

• Expected values: number

• Equivalent create-a-feed field: n/a

Description

The value of any giftcard associated with the deal.

Details

• Data type: integer

• Expected values: number

• Equivalent create-a-feed field: merchant_product_id

Description

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.

Details

• Data type: datetime

• Expected values: date & time

• Equivalent create-a-feed field: last_updated

Description

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.

Details

• Data type: string

• Expected values: text

• Equivalent create-a-feed field: promotional_text

Description

Will contain text describing any promotions attached to the deal. Note this is human-readable rather than machine parsable text.

Details

• Data type: string

• Expected values:

  • Address Check Required

  • Not Required

  • Required

• Equivalent create-a-feed field: custom_1

Description

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.

Details

• Data type: string

• Expected values: image URL

• Equivalent create-a-feed field: merchant_image_url

Description

The retailer’s brand logo.

Details

• Data type: string

• Expected values: URL

• Equivalent create-a-feed field: description

Description

A public URL containing the merchant’s terms of service.

Details

• Data type: string

• Expected values: text

• Equivalent create-a-feed field: mpn

Description

The merchant’s unique SKU for this package where known (in most cases this will be included).

Details

• Data type: datetime

• Expected values: date & time

• Equivalent create-a-feed field: valid_from

Description

The date and time the deal becomes valid (do not advertise before this time).

Details

• Data type: integer

• Expected values: number

• Equivalent create-a-feed field: Telcos:term

Description

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).

Details

• Data type: string

• Expected values: text

• Equivalent create-a-feed field: n/a

Description

Contains an asterisk-delimited list of the freebies and promotional offers included in this package.

Details

• Data type: string

• Expected values:

  • exclusive

• Equivalent create-a-feed field: keywords

Description

Will contain exclusive where this is a publisher or affiliate exclusive.

Details

• Data type: string

• Expected values: text

• Equivalent create-a-feed field: merchant_product_third_category

Description

The name of the landline contract included in the package (if any).

Details

• Data type: string

• Expected values: text

• Equivalent create-a-feed field: n/a

Description

The brand name of any landline device included as part of the package.

Details

• Data type: string

• Expected values: n/a

• Equivalent create-a-feed field: n/a

Description

An image of any landline device included as part of the package.

Details

• Data type: string

• Expected values: image URL

• Equivalent create-a-feed field: alternate_image

Description

The network’s brand logo.

Details

• Data type: string

• Expected values: text

• Equivalent create-a-feed field: Telcos:network

Description

The name of the network providing the package.

Details

• Data type: string

• Expected values: URL

• Equivalent create-a-feed field: terms_of_contract

Description

A public URL containing the network’s terms of service (in many cases this is the same as the merchant).

Details

• Data type: string

• Expected values: text

• Equivalent create-a-feed field: Telcos:gift

Description

An asterisk-delimited list of physical gifts included in the package (such as a free iPad).

Details

• Data type: decimal

• Expected values: number

• Equivalent create-a-feed field: custom_8

Description

The monthly cost for the broadband component of any package (if any). This will be included in the total monthly cost.

Details

• Data type: decimal

• Expected values: number

• Equivalent create-a-feed field: saving

Description

The amount being saved every month taking into account any discounts.

Details

• Data type: integer

• Expected values: number

• Equivalent create-a-feed field: Telcos:subscription_renewal

Description

The number of months any discount runs for.

Details

• Data type: decimal

• Expected values: number

• Equivalent create-a-feed field: Telcos:month_cost

Description

The total monthly cost the customer will pay, including any discounts being applied.

Details

• Data type: decimal

• Expected values: number

• Equivalent create-a-feed field: custom_9

Description

The monthly cost for the landline component of any package (if any). This will be included in the total monthly cost.

Details

• Data type: decimal

• Expected values: number

• Equivalent create-a-feed field: rrp_price

Description

The original total monthly cost before any discounts are applied.

Details

• Data type: decimal

• Expected values: number

• Equivalent create-a-feed field: custom_7

Description

The monthly cost for the TV component of any package (if any). This will be included in the total monthly cost.

Details

• Data type: decimal

• Expected values: number

• Equivalent create-a-feed field: n/a

Description

The cost of activation (if any).

Details

• Data type: decimal

• Expected values: number

• Equivalent create-a-feed field: delivery_cost

Description

The cost of delivery (will be included in the total upfront cost).

Details

• Data type: decimal

• Expected values: number

• Equivalent create-a-feed field: base_price

Description

The amount being charged upfront for any devices included in the package. This will be included in the total upfront cost.

Details

• Data type: decimal

• Expected values: number

• Equivalent create-a-feed field: n/a

Description

The cost of installation (if any).

Details

• Data type: decimal

• Expected values: number

• Equivalent create-a-feed field: search_price

Description

The total upfront cost of the package (to be paid at checkout).

Details

• Data type: string

• Expected values: text

• Equivalent create-a-feed field: product_short_description

Description

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).

Details

• Data type: string

• Expected values: text

• Equivalent create-a-feed field: product_name

Description

The name of the product/bundle, summary of main components.

Details

• Data type: string

• Expected values: text

• Equivalent create-a-feed field: merchant_product_category_path

Description

The brand name of the broadband router included in the package (if any).

Details

• Data type: string

• Expected values: image URL

• Equivalent create-a-feed field: alternate_image_two

Description

An image of the broadband router included in the package (if any).

Details

• Data type: string

• Expected values: text

• Equivalent create-a-feed field: Telcos:device_description

Description

The brand of the TV box included in the package (if any).

Details

• Data type: string

• Expected values: image URL

• Equivalent create-a-feed field: alternate_image_three

Description

An image of the TV box included in the package (if any).

Details

• Data type: string

• Expected values: text

• Equivalent create-a-feed field: Telcos:device_full_name

Description

The name of the TV box included in the package (if any).

Details

• Data type: integer

• Expected values: number

• Equivalent create-a-feed field: custom_5

Description

The number of TV channels included in the package (if any).

Details

• Data type: string

• Expected values: text

• Equivalent create-a-feed field: merchant_product_second_category

Description

The name of the TV contract included in the package (if any).

Details

• Data type: string

• Expected values: text

• Equivalent create-a-feed field: Telcos:special_offer

Description

Will contain details of any voucher code if one can be applied.

Details

• Data type: string

• Expected values: text

• Equivalent create-a-feed field: custom_2

Description

To be used in conjunction with voucher_code - will contain a description of what the voucher code entitles the user to.