POST
/
deals
curl --request POST \
  --url https://commerce.driv.ly/api/deals \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "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>"
}'
{
  "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>"
}

Authorizations

​
Authorization
string
header
required

Query Parameters

​
depth
number

number of levels to automatically populate relationships and uploads

​
locale
string

retrieves document(s) in a specific locale

​
fallback-locale
string

specifies a fallback locale if no locale value exists

Body

application/json

Response

200 - application/json

ok

The response is of type object.