API Reference
- Addresses
- Attachments
- Calls
- Contacts
- Credit Applications
- Customers
- Deals
- Definitions
- DMV Fees
- Documents
- Fees
- Holidays
- Insurance Policies
- Insurance Quotes
- Leads
- Lead Events
- Listings
- Locations
- Logs
- Meetings
- Messages
- Pre-Approvals
- Sales Reps
- Searches
- Service Quotes
- Service Orders
- Taxes And Fees
- Templates
- CRM Trades
- Trades
- VDP Emails
- CRM Vehicles
- Vehicles
- Web Events
- Webhooks
Deals
Restore a Deal version by its id
Restore a Deal version by its id
POST
/
deals
/
versions
/
{id}
Copy
curl --request POST \
--url https://commerce.driv.ly/api/deals/versions/{id} \
--header 'Authorization: <api-key>'
Copy
{
"doc": {
"customer": 123,
"vehicle": 123,
"dealId": "<string>",
"customerRelationship": "<string>",
"coCustomer": 123,
"companyConsumerCustomer": 123,
"lienHolder": [
123
],
"dealer": 123,
"facilitator": [
123
],
"type": [
"Wholesale Dropship"
],
"salesPrice": "<string>",
"margin": "<string>",
"downPayment": "<string>",
"financedAmount": "<string>",
"taxesAndFees": 123,
"dependencies": [
123
],
"unsignedDocuments": "<string>",
"signedDocuments": "<string>",
"deliveryAddress": [
123
],
"paymentLink": "<string>",
"getTradeOffer": "<string>",
"notarizePowerOfAttorney": "<string>",
"serviceQuotes": [
123
],
"tenant": 123,
"trades": [
123
],
"creditApplications": [
123
],
"latestError": "<string>",
"vscProvider": 123,
"vsc": "<string>",
"gapProvider": 123,
"gap": "<string>",
"status": "<string>",
"transportServiceOrders": [
123
],
"mileage": 123,
"createdBy": 123,
"lastModifiedBy": 123,
"development": true,
"updatedAt": "<string>",
"createdAt": "<string>"
},
"message": "<string>"
}
Usage with the Drivly SDK
Usage with the Drivly SDK
Make sure you install our SDK first. You can find out how, and more here.
Copy
import { SDK } from '@drivly/commerce'
import type { deals } from '@drivly/commerce'
const sdk = new SDK(...)
const deals = await sdk.deals.create(data: deals): Promise<deals>
Authorizations
Path Parameters
id of the Deal version
Query Parameters
number of levels to automatically populate relationships and uploads
retrieves document(s) in a specific locale
specifies a fallback locale if no locale value exists
Response
200
application/json
ok
The response is of type object
.
Copy
curl --request POST \
--url https://commerce.driv.ly/api/deals/versions/{id} \
--header 'Authorization: <api-key>'
Copy
{
"doc": {
"customer": 123,
"vehicle": 123,
"dealId": "<string>",
"customerRelationship": "<string>",
"coCustomer": 123,
"companyConsumerCustomer": 123,
"lienHolder": [
123
],
"dealer": 123,
"facilitator": [
123
],
"type": [
"Wholesale Dropship"
],
"salesPrice": "<string>",
"margin": "<string>",
"downPayment": "<string>",
"financedAmount": "<string>",
"taxesAndFees": 123,
"dependencies": [
123
],
"unsignedDocuments": "<string>",
"signedDocuments": "<string>",
"deliveryAddress": [
123
],
"paymentLink": "<string>",
"getTradeOffer": "<string>",
"notarizePowerOfAttorney": "<string>",
"serviceQuotes": [
123
],
"tenant": 123,
"trades": [
123
],
"creditApplications": [
123
],
"latestError": "<string>",
"vscProvider": 123,
"vsc": "<string>",
"gapProvider": 123,
"gap": "<string>",
"status": "<string>",
"transportServiceOrders": [
123
],
"mileage": 123,
"createdBy": 123,
"lastModifiedBy": 123,
"development": true,
"updatedAt": "<string>",
"createdAt": "<string>"
},
"message": "<string>"
}
Assistant
Responses are generated using AI and may contain mistakes.