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
Listings
Create a new Listing
Create a new Listing
POST
/
listings
Copy
curl --request POST \
--url https://commerce.driv.ly/api/listings \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"vehicles": 123,
"mileage": 123,
"seller": "<string>",
"wholesaleValue": "<string>",
"wholesaleBuyNowPrice": "<string>",
"wholesaleMinimumBid": "<string>",
"wholesaleCurrentBid": "<string>",
"wholesaleDetailPage": "<string>",
"condition": 123,
"wholesaleConditionReport": "<string>",
"retailValue": "<string>",
"retailAskingPrice": "<string>",
"retailBuyNowPrice": "<string>",
"vehicleHistoryReport": "<string>",
"vehicleHistoryScore": "<string>",
"cleanTitle": true,
"owners": 123,
"accidents": 123,
"attachments": "<string>",
"pickupLocation": 123,
"tenant": 123,
"updatedAt": "<string>",
"createdAt": "<string>"
}'
Copy
{
"doc": {
"vehicles": 123,
"mileage": 123,
"seller": "<string>",
"wholesaleValue": "<string>",
"wholesaleBuyNowPrice": "<string>",
"wholesaleMinimumBid": "<string>",
"wholesaleCurrentBid": "<string>",
"wholesaleDetailPage": "<string>",
"condition": 123,
"wholesaleConditionReport": "<string>",
"retailValue": "<string>",
"retailAskingPrice": "<string>",
"retailBuyNowPrice": "<string>",
"vehicleHistoryReport": "<string>",
"vehicleHistoryScore": "<string>",
"cleanTitle": true,
"owners": 123,
"accidents": 123,
"attachments": "<string>",
"pickupLocation": 123,
"tenant": 123,
"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 { listings } from '@drivly/commerce'
const sdk = new SDK(...)
const listings = await sdk.listings.create(data: listings): Promise<listings>
Authorizations
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
Body
application/json
Response
200 - application/json
ok
The response is of type object
.
Copy
curl --request POST \
--url https://commerce.driv.ly/api/listings \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"vehicles": 123,
"mileage": 123,
"seller": "<string>",
"wholesaleValue": "<string>",
"wholesaleBuyNowPrice": "<string>",
"wholesaleMinimumBid": "<string>",
"wholesaleCurrentBid": "<string>",
"wholesaleDetailPage": "<string>",
"condition": 123,
"wholesaleConditionReport": "<string>",
"retailValue": "<string>",
"retailAskingPrice": "<string>",
"retailBuyNowPrice": "<string>",
"vehicleHistoryReport": "<string>",
"vehicleHistoryScore": "<string>",
"cleanTitle": true,
"owners": 123,
"accidents": 123,
"attachments": "<string>",
"pickupLocation": 123,
"tenant": 123,
"updatedAt": "<string>",
"createdAt": "<string>"
}'
Copy
{
"doc": {
"vehicles": 123,
"mileage": 123,
"seller": "<string>",
"wholesaleValue": "<string>",
"wholesaleBuyNowPrice": "<string>",
"wholesaleMinimumBid": "<string>",
"wholesaleCurrentBid": "<string>",
"wholesaleDetailPage": "<string>",
"condition": 123,
"wholesaleConditionReport": "<string>",
"retailValue": "<string>",
"retailAskingPrice": "<string>",
"retailBuyNowPrice": "<string>",
"vehicleHistoryReport": "<string>",
"vehicleHistoryScore": "<string>",
"cleanTitle": true,
"owners": 123,
"accidents": 123,
"attachments": "<string>",
"pickupLocation": 123,
"tenant": 123,
"updatedAt": "<string>",
"createdAt": "<string>"
},
"message": "<string>"
}
Assistant
Responses are generated using AI and may contain mistakes.