Products

Once a deal has been loaded via the deal API, the applicable products may requested from the provider products endpoint.

There is currently only one provider, 9577f5a5-31e8-4504-9ba5-70639472d521, which represents AutoProtect.

The provider products endpoint is:

/deals/{dealId}/applications/1/provider-products/{providerId}

The products response

The provider products endpoint returns a summary of all the available products applicable to the dealer. These correspond to the "tiles" in the Navigate product selection UI.

A product may consist of a number of agreement types. These are represented in the product's products element, shown empty in the condensed example below.

The description element contains an embeddable HTML product description, which may include links to video content or other media.

{
  "products": [
    {
      "id": "42",
      "code": "ABCDABCD",
      "isInsured": false,
      "description": "An html description of the product",
      "name": "Admin Scheme AP Holding Fund",
      "taxType": {
        "code": "5",
        "value": "VAT"
      },
      "percentageDepositRequired": 0.2,
      "hasPremiumFunding": true,
      "category": "Warranty",
      "categoryId": "6",
      "backSaleDuration": 30,
      "labourRates": [],
      "products": [],
      "hasProductsWithSpecialAcceptance": false,
      "isEligible": false,
      "policyReference": "20481346/18383245"
    }
  ]
}

Products that have "isEligible": false cannot be added to the deal.

Where a product is insurance-based, the isInsured flag will be true. For dealers who carry out their demands and needs process within Navigate (ie: they are an AR of AutoProtect), the underlying product IDs must be passed to the compliance process, and demands and needs must be completed before the product can be added to the deal.

Agreement types

Retail products each have one or more underlying agreement types. Agreement types themselves may have multiple variants based on attributes such as claims limits or durations.

To add a product to a deal, the following identifiers must be derived from the product data:

• productCode
• productTypeCode
• duration.code
• claimLimit.code (where applicable)
• labourRate.code (where applicable)

Below is an example of an underlying agreement type encompassing several durations and claim limits. In this case, claim limits are tied to the durations and are not independently selectable.

{
  "id": "10003701",
  "code": "SCMPO2",
  "name": "Shine!Protect",
  "description": "Shine!Protect",
  "productTypeName": "Shine!Protect",
  "insuranceProductType": {
    "id": "13",
    "code": "SMART"
  },
  "maxRetailPrice": {
    "amount": "500000",
    "currency": "GBP"
  },
  "durations": [
    {
      "name": "12 Months",
      "code": "10027046"
    },
    {
      "name": "24 Months",
      "code": "10027047"
    },
    {
      "name": "36 Months",
      "code": "10025722"
    }
  ],
  "claimLimits": [
    {
      "name": "7 Repairs",
      "code": "10016038"
    },
    {
      "name": "14 Repairs",
      "code": "10016039"
    },
    {
      "name": "21 Repairs",
      "code": "10014930"
    }
  ],
  "retailPrices": [],
  "fieldsByDuration": {
    "10025722": [
      {
        "claimLimitCode": "10014930",
        "additionalCoverCode": ""
      }
    ],
    "10027046": [
      {
        "claimLimitCode": "10016038",
        "additionalCoverCode": ""
      }
    ],
    "10027047": [
      {
        "claimLimitCode": "10016039",
        "additionalCoverCode": ""
      }
    ]
  },
  "additionalCovers": [],
  "productTypeId": "10000444",
  "isPack": false,
  "isEligible": true,
  "hasSpecialAcceptance": false,
  "rateCardId": "12159770",
  "complianceStatus": null
}

Because the fieldsByDuration section allows only a single, specific claim limit for each duration, the following combinations are valid:

Adding a product to a deal

To add a product to a deal, make a POST request to the VAPs endpoint at deals/{dealId}/applications/1/vaps. Multiple products may be added in a single operation.

[
    {
        "provider": {
            "id": "9577f5a5-31e8-4504-9ba5-70639472d521"
        },
        "name": "Shine!Protect",
        "category": "Chips & Dents",
        "categoryId": "11",
        "productCode": "10003701",
        "productTypeCode": "10000444",
        "productTypeName": "Shine!Protect",
        "hasPremiumFunding": false,
        "claimLimit": {
            "name": "21 Repairs",
            "code": "10014930"
        },
        "labourRate": {
            "name": "",
            "code": ""
        },
        "additionalCover": [

        ],
        "duration": {
            "name": "36 Months",
            "code": "10025722"
        },
        "priceGross": {
            "amount": "0",
            "currency": "GBP"
        },
        "taxRate": 20,
        "taxType": "VAT",
        "paymentType": "CASH",
        "coverStartDate": "2022-06-23T15:56:05.513Z"
    }
]

How to map products fields to the add product request

Further example - warranty product

In this example, a labour rate is also available and the two claims limits can be selected independently of the duration. This also includes recommended and minimum retail prices.

Products section from the product response

The product below describes allows the following products to be registered:

{
  "id": "10003546",
  "code": "UNCCP",
  "name": "CP Comprehensive",
  "description": "CP Comprehensive",
  "productTypeName": "Warranty",
  "insuranceProductType": {
    "id": "3",
    "code": "Warranty"
  },
  "maxRetailPrice": {
    "amount": "500000",
    "currency": "GBP"
  },
  "durations": [
    {
      "name": "12 Months",
      "code": "10023957"
    },
    {
      "name": "24 Months",
      "code": "10023958"
    }
  ],
  "claimLimits": [
    {
      "name": "£1000",
      "code": "10014011"
    },
    {
      "name": "£2000",
      "code": "10014012"
    }
  ],
  "retailPrices": [
    {
      "recommendedRetail": {
        "amount": "14000",
        "currency": "GBP"
      },
      "minimumRetail": {
        "amount": "0",
        "currency": "GBP"
      },
      "durationCode": "10023957",
      "claimLimitCode": "10014011",
      "labourRateCode": "1"
    },
    {
      "recommendedRetail": {
        "amount": "13000",
        "currency": "GBP"
      },
      "minimumRetail": {
        "amount": "0",
        "currency": "GBP"
      },
      "durationCode": "10023957",
      "claimLimitCode": "10014012",
      "labourRateCode": "1"
    },
    {
      "recommendedRetail": {
        "amount": "19000",
        "currency": "GBP"
      },
      "minimumRetail": {
        "amount": "0",
        "currency": "GBP"
      },
      "durationCode": "10023958",
      "claimLimitCode": "10014011",
      "labourRateCode": "1"
    },
    {
      "recommendedRetail": {
        "amount": "20000",
        "currency": "GBP"
      },
      "minimumRetail": {
        "amount": "0",
        "currency": "GBP"
      },
      "durationCode": "10023958",
      "claimLimitCode": "10014012",
      "labourRateCode": "1"
    }
  ],
  "fieldsByDuration": {
    "10023957": [
      {
        "claimLimitCode": "10014011",
        "additionalCoverCode": ""
      },
      {
        "claimLimitCode": "10014012",
        "additionalCoverCode": ""
      },
    ],
    "10023958": [
      {
        "claimLimitCode": "10014011",
        "additionalCoverCode": ""
      },
      {
        "claimLimitCode": "10014012",
        "additionalCoverCode": ""
      }
    ]
  },
  "additionalCovers": [],
  "productTypeId": "6",
  "isPack": false,
  "isEligible": true,
  "hasSpecialAcceptance": false,
  "rateCardId": "12159763",
  "complianceStatus": null
}

Adding the warranty to the deal

Having selected the duration (24 months) and claim limit (£1000), the warranty can be added as follows.

We will need a few parameters from the top level product:

• productCode is 10003546
• productTypeCode is 6
• labourRate is { "name": "60", "code": "1" }

The recommended price is £190, so we will add the product at that.

[
  {
    "provider": {
      "id": "9577f5a5-31e8-4504-9ba5-70639472d521"
    },
    "name": "CP Comprehensive",
    "category": "Warranty",
    "categoryId": "3",
    "productCode": "10003546",
    "productTypeCode": "6",
    "productTypeName": "Warranty",
    "hasPremiumFunding": false,
    "claimLimit": {
      "name": "£1000",
      "code": "10014011"
    },
    "labourRate": {
      "name": "60",
      "code": "1"
    },
    "additionalCover": [],
    "duration": {
      "name": "24 Months",
      "code": "10023958"
    },
    "priceGross": {
      "amount": "19000",
      "currency": "GBP"
    },
    "taxRate": 20,
    "taxType": "VAT",
    "paymentType": "CASH",
    "coverStartDate": "2022-06-23T15:56:05.513Z"
  }
]