Skip to main content
07399 456 959 admin@uconvert.co.uk

Product Object
Last updated: March 09 2019 04:18 PM

Headers

Attribute Type Description
x-api-key
required
string The api token you will use to authorise requests to the API.

Query Parameters Available for Products

Parameter Type Description
filter
optional
string Filter the product results
expand
optional
string Get associated content for all products
fields
optional
string Reduce the number of properties returned for products
limit
optional
string The number of products to return per page
sort
optional
string Sort the products

Product Object

default attributes in the product object will always be returned.

Attribute Type Description
id
default
number A unique numeric Product ID that can be used to identify and reference other resources

E.g. 2203
name
default
string Product name

E.g. Apple iPhone 6s 16GB Silver
slug
default
string Friendly url

E.g. apple-iphone-6s-16gb-silver
colour
default
string Product colour

E.g. Silver
hexColour
default
string Product hexidecimal colour

E.g. #D6D6D6
condition
default
string Identifies if the product is new or refurbished

E.g. New or Refurbished
cheapestUpfrontCost
default
decimal Returns the lowest upfront cost of the product

E.g. 19.99
cheapestContractPrice
default
decimal Returns the lowest upfront cost of the product

E.g. 39.95
capacity
default
string Returns the capcity of the product

E.g. 64GB
content array[object] An array containing content for the product. See the product content object.
metaData array[object] An array containing meta tags about the HTML document (title, description and keywords). See the product meta data object
images array[object] An array containing multiple product images in various sizes, views and formats. See the product images object
specs array[object] An array containing product specifications. See the product specifications object
deals array[object] An array containing product deal contract allowances and associated information. See the product deals object
{
  "products" : [
    {
      "id": "2119",
      "name": "Apple iPhone 8 256GB Silver",
      "slug": "apple-iphone-8-256gb-silver",
      "cheapestUpfrontCost": "0.00",
      "cheapestContractPrice": "55.00",
      "condition": "New",
      "colour": "Silver",
      "hexColour": "#D6D6D6",
      "capacity": "64GB",
      "content": {
        "heading": "Apple iPhone 6 64GB Gold mobile phone deals",
        "introduction": "Get the very best and latest Apple iPhone . . .",
      },
      "metaData": {
        "title": "Apple iPhone 6 16GB Space Grey Contract . . .",
        "description": "Compare the best Apple iPhone 6 16GB . . .",
        "keywords": "Apple iPhone 6 16GB Space Grey contract . . .",
      },
      "specs": {
        "os": "IOS 8.1",
        "familyOs": "Apple iOS",
        "weight": "129g",
        "size": "138 x 67 x 7mm",
        "height": "138mm",
        "width": "67mm",
        "depth": "7mm",
        "screenSize": "5 inches",
        "screenPixelDensity": "326 ppi density",
        "screenResolution": "1334 x 750 pixels",
        "simType": "Nano SIM",
        "displayType": "LED-backlit IPS LCD",
        "handsetStyle": "Touchscreen",
        "cameraFront": "8MP",
        "cameraBack": "1.2MP",
        "cameraFlash": "Dual-LED (dual tone) flash",
        "batteryType": "Non-removable Li-Po",
        "batteryCapacity": "1810mAh",
        "chipset": "Apple A8",
        "gpu": "PowerVR GX6450",
        "cpu": "Dual-core 1.4 GHz Typhoon (ARM v8-based)",
        "nfc": "Yes (Apple Pay only)",
        "sensors": "Fingerprint, accelerometer, gyro, proximity, compass, barometer",
        "fmRadio": "No",
        "4g": "Yes"
      },
      "images": {
        "largeFrontImageWebp": "https://static.uconvert.co.uk/img/products/ . . .",
        "mediumFrontImageWebp": "https://static.uconvert.co.uk/img/products/ . . .",
        "smallFrontImageWebp": "https://static.uconvert.co.uk/img/products/ . . .",
        "largeBackImageWebp": "https://static.uconvert.co.uk/img/products/ . . .",
        "mediumBackImageWebp": "https://static.uconvert.co.uk/img/products/ . . .",
        "smallBackImageWebp": "https://static.uconvert.co.uk/img/products/ . . .",
        "largeLeftImageWebp": "https://static.uconvert.co.uk/img/products/ . . .",
        "mediumLeftImageWebp": "https://static.uconvert.co.uk/img/products/ . . .",
        "smallLeftImageWebp": "https://static.uconvert.co.uk/img/products/ . . .",
        "largeRightImageWebp": "https://static.uconvert.co.uk/img/products/ . . .",
        "mediumRightImageWebp": "https://static.uconvert.co.uk/img/products/ . . .",
        "smallRightImageWebp": "https://static.uconvert.co.uk/img/products/ . . .",
        "largeFrontImagePng": "https://static.uconvert.co.uk/img/products/ . . .",
        "mediumFrontImagePng": "https://static.uconvert.co.uk/img/products/ . . .",
        "smallFrontImagePng": "https://static.uconvert.co.uk/img/products/ . . .",
        "largeBackImagePng": "https://static.uconvert.co.uk/img/products/ . . .",
        "mediumBackImagePng": "https://static.uconvert.co.uk/img/products/ . . .",
        "smallBackImagePng": "https://static.uconvert.co.uk/img/products/ . . .",
        "largeLeftImagePng": "https://static.uconvert.co.uk/img/products/ . . .",
        "mediumLeftImagePng": "https://static.uconvert.co.uk/img/products/ . . .",
        "smallLeftImagePng": "https://static.uconvert.co.uk/img/products/ . . .",
        "largeRightImagePng": "https://static.uconvert.co.uk/img/products/ . . .",
        "mediumRightImagePng": "https://static.uconvert.co.uk/img/products/ . . .",
        "smallRightImagePng": "https://static.uconvert.co.uk/img/products/ . . .",
        "largeFrontImageJpg": "https://static.uconvert.co.uk/img/products/ . . .",
        "mediumFrontImageJpg": "https://static.uconvert.co.uk/img/products/ . . .",
        "smallFrontImageJpg": "https://static.uconvert.co.uk/img/products/ . . .",
        "largeBackImageJpg": "https://static.uconvert.co.uk/img/products/ . . .",
        "mediumBackImageJpg": "https://static.uconvert.co.uk/img/products/ . . .",
        "smallBackImageJpg": "https://static.uconvert.co.uk/img/products/ . . .",
        "largeLeftImageJpg": "https://static.uconvert.co.uk/img/products/ . . .",
        "mediumLeftImageJpg": "https://static.uconvert.co.uk/img/products/ . . .",
        "smallLeftImageJpg": "https://static.uconvert.co.uk/img/products/ . . .",
        "largeRightImageJpg": "https://static.uconvert.co.uk/img/products/ . . .",
        "mediumRightImageJpg": "https://static.uconvert.co.uk/img/products/ . . .",
        "smallRightImageJpg": "https://static.uconvert.co.uk/img/products/ . . ."
      },
      "manufacturerContent":{
        "id": "4",
        "name": "Apple",
        "slug": "apple",
        "img": "https://static.uconvert.co.uk/img/badges/manufacturer-4.png",
        "content": {
          "heading": "Apple iPhone contract mobile phone deals",
          "intro": "Compare the Apple iPhone X, iPhone 8 or 8 plus mobile  . . ."
        },
        "metaData": {
          "title": "Apple iPhone Mobile Deals On Contract",
          "description": "Apple iPhone mobile phone deals - Compare the  . . .",
          "keywords": "Apple iPhone mobiles, Apple iPhone mobile phones,  . . ."
        }
    	},
    }
  ],
  "deals": [
    {
      "contractName": "Virgin Mobile Pay Monthly Plan",
      "contractLength": "24",
      "contractSupplierId": "12",
      "contractSupplierName": "Virgin Mobile",
      "friendlyContractLength": "24 Month Contract",
      "dataAllowance": "1000",
      "friendlyDataAllowance": "1GB",
      "callAllowance": "1000",
      "friendlyCallAllowance": "1000 mins",
      "textAllowance": "999999",
      "friendlyTextAllowance": "Unlimited",
      "dealLink": "https://deals.uconvert.co.uk/deal_redirect/5/209496741/",
      "dealType": "Consumer",
      "totalDealCost": "1188.00",
      "supplierId": "12",
      "supplierName": "Virgin Mobile",
      "productUpfrontCost": "0.00",
      "supplierContractPrice": "55.00",
      "productImg": "https://static.uconvert.co.uk/img/ . . .",
      "productName": "Apple iPhone 8 256GB Silver"
    }
  ]
}