Skip to main content

Ancilliary Products v2

A technical guide to retrieving and adding ancillary products to quotes in Accelerate using API v2.

Tom White avatar
Written by Tom White
Updated over 11 months ago

Path Parameters

HTTP Header

api-key REQUIRED

string - Your Accelerate API Key

URL Substitution

subdomain REQUIRED
string - Your Accelerate subdomain

relationship ID REQUIRED
integer - ID of your chosen relationship

opportunity ID REQUIRED
integer - ID of your chosen opportunity

quote ID REQUIRED
integer - ID of your chosen quote

ap ID OPTIONAL
integer - ID of your chosen ancillary product

Ancillary Product Requests

GET POST

GET POST - Retrieve Ancillary products on a quote or add a new ancillary product to a quote

https://{{subdomain}}.quotevineapp.com/qvine/quotevine/api/v2/relationships/{ID}/opportunities/{OPP_ID}/quotes/{QUO_ID}/ancillary-products/

Example Payload

POST

{
    "ancillary_product_type_id": 10044,
    "ancillary_product_type": "GAP Insurance",
    "supplier_id": 61013,
    "description": "GAP Insurance For Quote",
    "delivery_frequency": "Annual",
    "net_cost": 200,
    "net_price": 240,
    "payment_frequency": "Annual",
    "vat_rate_type": "Standard"
}


Response

400
​

Returned if the request sent is invalid.

404
​

Returned if the request is not found or the user does not have permission to view it.

200
Returned if the request is successful.

Expand to see example of a successful response.

{
    "client_id": 44382,
    "ancillary_product_id": 10071,
    "proposal_id": 20556753,
    "opportunity_id": 553444,
    "relationship_id": 2314194,
    "ancillary_product_temp_id": null,
    "ancillary_product_type_id": 10044,
    "ancillary_product_type": "GAP Insurance",
    "vehicle_order_id": null,
    "supplier_id": 2300187,
    "description": "GAP Insurance For Quote",
    "delivery_frequency_id": "ANN",
    "delivery_frequency": null,
    "net_cost": 200,
    "template_price": null,
    "net_price": 240,
    "payment_frequency_id": "ANN",
    "payment_frequency": null,
    "vat_rate_type_id": "STD",
    "ipt_rate_type_id": null,
    "creation_date": "2023-02-07 13:07",
    "created_by": 101125,
    "last_update_date": "2023-02-07 13:07",
    "last_updated_by": 101125,
    "ancillary_product_guid": "9BqlqknYXiLgUxkXCgrMZQ=="
}

GET - Retrieve a specific Ancillary Product from a quote

https://{{subdomain}}.quotevineapp.com/qvine/quotevine/api/v2/relationships/{ID}/opportunities/{OPP_ID}/quotes/{QUO_ID}/ancillary-products/{AP_ID}/

Response

200
​

Returned if the request is successful.

Expand to see example of a successful response.

{
    "client_id": 44382,
    "ancillary_product_id": 10071,
    "proposal_id": 20556753,
    "opportunity_id": 553444,
    "relationship_id": 2314194,
    "ancillary_product_temp_id": null,
    "ancillary_product_type_id": 10044,
    "ancillary_product_type": "GAP Insurance",
    "vehicle_order_id": null,
    "supplier_id": 2300187,
    "description": "GAP Insurance For Quote",
    "delivery_frequency_id": "ANN",
    "delivery_frequency": null,
    "net_cost": 200,
    "template_price": null,
    "net_price": 240,
    "payment_frequency_id": "ANN",
    "payment_frequency": null,
    "vat_rate_type_id": "STD",
    "ipt_rate_type_id": null,
    "creation_date": "2023-02-07 13:07",
    "created_by": 101125,
    "last_update_date": "2023-02-07 13:07",
    "last_updated_by": 101125,
    "ancillary_product_guid": "9BqlqknYXiLgUxkXCgrMZQ==",
}

404
​

Returned if the request is not found or the user does not have permission to view it.

Ancillary Product Attributes

When adding a new Ancillary Product via the API, there are a number of fields needed.

Mandatory Fields

Expand to see the list of mandatory fields

ancillary_product_type - string

delivery_frequency - string

net_price - number

payment_frequency - string

vat_rate_type - string


Non Mandatory Fields

Expand to see the list of non-mandatory fields.

ancillary_product_temp_id - number

vehicle_order_id - number

ancillary_product_type_id - number

supplier_id - number

description - string

delivery_frequency_id - string

net_cost - number

template_price - number

payment_frequency_id - string

ipt_rate_type - string

Related Articles
Quote Object v2
Driver Object v2
Quote Options Object v2
Cashflow Object v2
Asset Object v2
Did this answer your question?