/
Orders Object v2

Orders Object v2

Owned by Matt Sullivan (Unlicensed)
Last updated: Jan 30, 2023 by Daniel Layne
3 min read

Path Parameters

HTTP Header

api-key status:REQUIRED
string - Your Accelerate API Key

URL Substitution

subdomain status:Required
string - Your Accelerate subdomain

relationship ID status:REQUIRED
integer - ID of your chosen relationship

order ID status:Optional
integer - ID of your chosen order

Order Requests status:GEt status:Post status:put

status:Get status:Post - Retrieve all orders from a relationship or add a new order to a relationship.

https://{{subdomain}}.quotevineapp.com/qvine/quotevine/api/v2/relationships/{id}/orders/

Example Payload status:POSt

{ "target_delivery_date": "End of August", "order-status": "Sent to Customer", "delivery_property": "Unit A Platform BEDFORD", "delivery_postcode": "MK40 2FL", "dealer_id": null, "proposal_id": 20295213 }

Response

status:200
Returned if the request is successful.

{ "items": [ { "vehicle_order_id": 154709, "driver_id": null, "order_date": "2022-08-05", "target_delivery_date": "End of August", "confirmed_delivery_date": null, "created_by": "example", "creation_date": "2022-08-05 11:06:13", "last_updated_by": "example", "last_update_date": "2022-08-05 11:06:13", "delivery_property": "Unit A Platform BEDFORD", "delivery_postcode": "MK40 2FL", "k4k_flag": "N", "k4k_registration_number": null, "external_reference": 104, "order_number": null, "dealer_id": null, "proposal_id": 20295213, "funder_fleet_number": null, "delivery_method": null, "vehicle_registree": null, "discount_bonus_code_1": null, "discount_bonus_code_2": null, "quantity": 1, "paint_option_code": null, "registration_number": null, "vin": null, "new_used": "NEW", "int_target_delivery_date": null, "order_status": "Sent to Customer", ... } ] }

status:400
Returned if the request sent is invalid.

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

status:Get status:Put - Retrieve a single order or update a single order on a relationship

https://{{subdomain}}.quotevineapp.com/qvine/quotevine/api/v2/relationships/{id}/orders/{id}/

Example Payload status:PUT

{ "target_delivery_date": "End of September", "dealer_id": null, "proposal_id": 20295213, "order_status": "Completed" }

Response

status:200
Returned if the request is successful.

{ "vehicle_order_id": 154706, "driver_id": null, "order_date": "2022-08-05", "target_delivery_date": "End of August", "confirmed_delivery_date": null, "created_by": "example@qv.systems", "creation_date": "2022-08-05 10:57:20", "last_updated_by": "example@qv.systems", "last_update_date": "2022-08-05 10:57:20", "delivery_property": "Unit A Platform BEDFORD", "delivery_postcode": "MK40 2FL", "k4k_flag": "N", "k4k_registration_number": null, "external_reference": 101, "order_number": null, "dealer_id": null, "proposal_id": 20295213, "funder_fleet_number": null, "delivery_method": null, "vehicle_registree": "Funder", "discount_bonus_code_1": null, "discount_bonus_code_2": null, "quantity": 1, "paint_option_code": null, "registration_number": null, "vin": null, "new_used": "NEW", "int_target_delivery_date": null, "order_status": "Sent to Customer", ... }

status:400
Returned if the request sent is invalid.

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

Order Attributes

When updating/adding a new order via the API, there are a number of fields needed.

Mandatory Fields

proposal_id - number

order_status - string
Must be one of your configured order statuses.

target_delivery_date - string

Non Mandatory Fields

proposal_status - string
Must be one of your configured proposal statuses.

order_date - date
Will default to current date if not supplied.

dealer_id - number

dealer_contact_id - number

int_target_delivery_date - date

confirmed_delivery_date - date

delivery_property - string
Can also be passed as delivery_address

delivery_postcode - string

delivery_method - string
Must be Transporter, Delivery Driver or Customer Collection.

new_used - string
Must be New, Used or Pre-reg.

paint_option_code - number
The cap option code for the paint finish chosen.

trim_option_code - number
The cap option code for the interior chosen.

build_tracking_number - string

registration_number - string

vin - string

k4k_registration_number - string

funder_fleet_number - string

discount_bonus_code_1 - string
Can also be passed as discount_bonus_1.

discount_bonus_code_2 - string
Can also be passed as discount_bonus_2.

cooling_off_date - date

cancellation_date - date

cancellation_reason - string

contact_notes - string

contact_name - string

contact_telephone - string

contact_mobile - string

funder_order_number - string

delivery_slot - string
Must be AM or PM.

first_registration_date - date

vehicle_registree - string
Must be Customer, Funder or Your Organisation.

registree_name - string

registree_house_number_name - string

registree_street - string

registree_locality - string

registree_town_city - string

registree_postcode - string

profit_date - date

update_frequency_days - number
Must be 0 (no updates), 1, 3, 7, 14, 21 or 30.

last_customer_update - datetime

working_user_email - string
The email address of the member of your staff who is managing the order.

Related content