> ## Documentation Index > Fetch the complete documentation index at: https://docs.drivly.dev/llms.txt > Use this file to discover all available pages before exploring further. # Updates a Customer > Updates a Customer Make sure you install our SDK first. You can find out how, and more [here](/commerce/sdk). ```typescript theme={null} import { SDK } from '@drivly/commerce' import type { customers } from '@drivly/commerce' const sdk = new SDK(...) const customers = await sdk.customers.update(customersId: string, data: customers): Promise ``` ## OpenAPI ````yaml patch /customers/{id} openapi: 3.0.3 info: title: Drivly Commerce API version: 1.0.0 description: API for the Driv.ly experience contact: name: Drivly url: https://driv.ly email: support@driv.ly license: name: MIT url: https://opensource.org/licenses/MIT servers: - url: https://commerce.driv.ly/api security: [] paths: /customers/{id}: patch: tags: - customers summary: Updates a Customer description: Updates a Customer parameters: - name: id in: path description: id of the Customer required: true schema: type: string - name: depth in: query description: number of levels to automatically populate relationships and uploads schema: type: number - name: locale in: query description: retrieves document(s) in a specific locale schema: type: string - name: fallback-locale in: query description: specifies a fallback locale if no locale value exists schema: type: string requestBody: $ref: '#/components/requestBodies/customersRequest' responses: '200': $ref: '#/components/responses/customersUpsertConfirmationResponse' '404': $ref: '#/components/responses/NotFoundErrorResponse' security: - apiKeyAuth: [] components: requestBodies: customersRequest: content: application/json: schema: $ref: '#/components/schemas/customers' responses: customersUpsertConfirmationResponse: description: ok content: application/json: schema: $ref: '#/components/schemas/customersUpsertConfirmation' NotFoundErrorResponse: description: not found content: application/json: schema: $ref: '#/components/schemas/error' schemas: customers: additionalProperties: false title: Customer type: object properties: customerId: type: string nullable: true leads: items: oneOf: - type: number - additionalProperties: false title: Lead type: object properties: processStatuses: enum: - Qualified Lead - Actively Communicating - First Communication Attempt (phone and text) - Second Communication Attempt - On Hold - Lost type: string nullable: true reason: enum: - Do Not Contact - Duplicate - Looking For Business Financing - Looking For Listings - Looking For Personal Financing - Not Responding - Test - Bad Credit type: string nullable: true latestEvent: type: number nullable: true notes: type: string nullable: true statusTracker: type: string nullable: true searches: items: type: number type: array nullable: true attachments: type: string nullable: true firstName: type: string nullable: true lastName: type: string nullable: true phone: type: string nullable: true call: type: string nullable: true zipcode: type: string nullable: true email: type: string nullable: true loginEmail: type: string nullable: true purchaseOption: type: string nullable: true timeToPurchase: items: enum: - ASAP - This week - Within 1-2 weeks - Within 2-4 weeks - Asap - This Week - Within 1-2 Weeks - Within 2-4 Weeks - within 1-2 weeks - within 2-4 weeks - within 1-2 months - other - this week - asap - 2+ months - just browsing - 1-2 months - 1-2 weeks - 2-4 weeks type: string type: array nullable: true monthlyPayment: type: number nullable: true budgetLower: type: string nullable: true budgetUpper: type: string nullable: true mileageLower: type: number nullable: true mileageUpper: type: number nullable: true cashDown: type: number nullable: true newOrUsed: type: string nullable: true bodyStyle: items: enum: - truck - car - van - suv - wagon type: string type: array nullable: true carStyle: items: enum: - sedan - coupe - convertible - hatchback type: string type: array nullable: true truckStyle: items: enum: - crew - reg - extended type: string type: array nullable: true suvStyle: items: enum: - small/compact - mid-size - large/full-size type: string type: array nullable: true vanStyle: items: enum: - cargo - passenger - conversion type: string type: array nullable: true yearLower: type: number nullable: true yearUpper: type: number nullable: true year: type: number nullable: true make: type: string nullable: true model: type: string nullable: true exterior: items: enum: - Silver - White - Black - Brown - Blue - Orange - Red - Green - Any color - Beige - Gold - Gray - Light Blue type: string type: array nullable: true interior: items: enum: - Black - Gray - Tan - Beige - Blue - Brown - Red - White - Any color - Ivory - Cream type: string type: array nullable: true fuelType: items: enum: - Gasoline - Electric - Hybrid - gasoline - flex fuel - diesel - other - hybrid - electric type: string type: array nullable: true drivetrain: items: enum: - Four Wheel Drive - Rear Wheel Drive - Front Wheel Drive - all wheel drive - front wheel drive - rear wheel drive type: string type: array nullable: true transmission: items: enum: - Automatic - Manual - automatic - cvt - manual type: string type: array nullable: true comfort: items: enum: - Leather/premium Seats - Heated Steering Wheel - leather/premium seats - heated steering wheel - ventilated or cooled seats - heated seats - dual-zone/climate control - power-adjustable seats - noise-cancelling technology - massage seats type: string type: array nullable: true safety: items: enum: - Adaptive Cruise Control - Blind Spot Monitor - lane departure warning - back up camera - 360 camera - park assist - heads-up display - adaptive cruise control - blind spot monitor type: string type: array nullable: true entertainment: items: enum: - Premium Audio System - Entertainment Package/dvd - premium audio system - apple carplay/android auto - bluetooth - auxiliary input - usb ports - wireless device charging - wi-fi hotspot - navigation system - entertainment package/dvd - satellite radio type: string type: array nullable: true utility: items: enum: - Towing Package - Sunroof/moonroof/panoramic Roof - towing package - sunroof/moonroof/panoramic roof - adaptive suspension - 4 wheel drive - 3rd row seats - handicap accessible type: string type: array nullable: true subscribe: type: boolean nullable: true agree: type: boolean nullable: true customer: type: string nullable: true messageNotifications: type: boolean nullable: true emailNotifications: type: boolean nullable: true emailAlerts: type: boolean nullable: true emailOffers: type: boolean nullable: true leadEvents: items: type: number type: array nullable: true cfZipcode: type: string nullable: true cfState: type: string nullable: true cfCity: type: string nullable: true completedDate: type: string nullable: true localTime: type: string nullable: true trade: items: type: number type: array nullable: true messages: items: type: number type: array nullable: true creditScore: type: string nullable: true contactScore: type: string nullable: true contactBelongsTo: type: string nullable: true contactType: type: string nullable: true contactValid: type: boolean nullable: true testingCustomer: type: boolean nullable: true estimatedAgeRange: type: string nullable: true estimatedAddress: type: string nullable: true estimatedZipcode: type: string nullable: true meetings: items: type: number type: array nullable: true makeAndModel: type: string nullable: true conversation: type: string nullable: true city: type: string nullable: true state: type: string nullable: true preApprovalId: type: string nullable: true vdpEmails: items: type: number type: array nullable: true favorites: items: type: number type: array nullable: true calls: items: type: number type: array nullable: true salesRep: type: number nullable: true preApprovals: items: type: number type: array nullable: true anonymousId: type: string nullable: true manual: type: boolean nullable: true trim: type: string nullable: true oneOwner: type: boolean nullable: true customers: type: number nullable: true updatedAt: type: string createdAt: type: string required: - id - updatedAt - createdAt type: array nullable: true address: oneOf: - type: number nullable: true - additionalProperties: false title: Address type: object properties: name: type: string nullable: true street: type: string nullable: true suite: type: string nullable: true city: type: string nullable: true state: type: string nullable: true zip: type: string nullable: true country: type: string nullable: true deals: items: type: number type: array nullable: true tenants: type: number nullable: true customer: items: type: number type: array nullable: true contact: items: type: number type: array nullable: true updatedAt: type: string createdAt: type: string required: - id - updatedAt - createdAt shippingContact: oneOf: - type: number nullable: true - additionalProperties: false title: Contact type: object properties: name: type: string nullable: true status: enum: - Pending - Active - Inactive type: string nullable: true type: items: enum: - Auction - Mechanic - Operations - Back Office - Transporter - Detailer - Customer - Dealer type: string type: array nullable: true customer: type: number nullable: true addresses: type: number nullable: true transportServiceOrders: items: type: number type: array nullable: true transportServiceOrders2: items: type: number type: array nullable: true transportServiceOrders3: items: type: number type: array nullable: true transportServiceOrders4: items: type: number type: array nullable: true updatedAt: type: string createdAt: type: string required: - id - updatedAt - createdAt deals: items: oneOf: - type: number - additionalProperties: false title: Deal type: object properties: customer: type: number nullable: true vehicle: type: number nullable: true dealId: type: string nullable: true customerRelationship: type: string nullable: true coCustomer: type: number nullable: true companyConsumerCustomer: type: number nullable: true lienHolder: items: type: number type: array nullable: true dealer: type: number nullable: true facilitator: items: type: number type: array nullable: true type: items: enum: - Wholesale Dropship - Wholesale - Concierge Search - Consignment - Instant Cash Offer - Concierge Buy - Private Party type: string type: array nullable: true salesPrice: type: string nullable: true margin: type: string nullable: true downPayment: type: string nullable: true financedAmount: type: string nullable: true taxesAndFees: type: number nullable: true dependencies: items: type: number type: array nullable: true unsignedDocuments: type: string nullable: true signedDocuments: type: string nullable: true deliveryAddress: items: type: number type: array nullable: true paymentLink: type: string nullable: true getTradeOffer: type: string nullable: true notarizePowerOfAttorney: type: string nullable: true serviceQuotes: items: type: number type: array nullable: true tenant: type: number nullable: true trades: items: type: number type: array nullable: true creditApplications: items: type: number type: array nullable: true latestError: type: string nullable: true vscProvider: type: number nullable: true vsc: type: string nullable: true gapProvider: type: number nullable: true gap: type: string nullable: true status: type: string nullable: true transportServiceOrders: items: type: number type: array nullable: true mileage: type: number nullable: true createdBy: type: number nullable: true lastModifiedBy: type: number nullable: true development: type: boolean nullable: true updatedAt: type: string createdAt: type: string required: - id - updatedAt - createdAt type: array nullable: true createdBy: type: number lastModifiedBy: type: number email: type: string nullable: true phone: type: string nullable: true insurancePolicies: items: oneOf: - type: number - additionalProperties: false title: InsurancePolicy type: object properties: name: type: string nullable: true customer: items: type: number type: array nullable: true insuranceCompany: type: number nullable: true policyNumber: type: string nullable: true tenant: type: number nullable: true updatedAt: type: string createdAt: type: string required: - id - updatedAt - createdAt type: array nullable: true tenants: items: oneOf: - type: number - additionalProperties: false title: Tenant type: object properties: name: type: string nullable: true customer: items: type: number type: array nullable: true defaultDealer: items: type: number type: array nullable: true defaultFacilitator: type: number nullable: true email: type: string nullable: true apiKey: type: string nullable: true environment: type: string nullable: true creditApplicationLabel: type: string nullable: true deals: items: type: number type: array nullable: true locations: items: type: number type: array nullable: true insuranceQuotes: items: type: number type: array nullable: true serviceQuotes: items: type: number type: array nullable: true serviceOrders: type: string nullable: true insurancePolicies: items: type: number type: array nullable: true addresses: items: type: number type: array nullable: true listings: items: type: number type: array nullable: true vehicles: items: type: number type: array nullable: true webhooks: items: type: number type: array nullable: true taxesAndFees: items: type: number type: array nullable: true dmvFees: items: type: number type: array nullable: true transportServiceOrders: items: type: number type: array nullable: true updatedAt: type: string createdAt: type: string required: - id - updatedAt - createdAt type: array nullable: true consumerStatus: enum: - SOLD - Pending - Working - Cold - LOST - Duplicate - DNC type: string nullable: true consumerFirstName: type: string nullable: true consumerMiddleName: type: string nullable: true consumerLastName: type: string nullable: true consumerSuffix: type: string nullable: true consumerDateOfBirth: type: string nullable: true consumerEducationLevel: type: string nullable: true consumerVehicles: items: oneOf: - type: number - additionalProperties: false title: Vehicle type: object properties: name: type: string nullable: true vin: type: string nullable: true customer: type: number nullable: true status: items: enum: - Bought at Auction - Inspected - Transport to Inspection - Transport to Customer - Arbitration - Bid Placed - SOLD TO CUSTOMER - Identified as potential option for customer - Taken in on Trade - Trade sold at Auction - Trade sold Retail type: string type: array nullable: true deals: items: type: number type: array nullable: true year: type: string nullable: true make: type: string nullable: true model: type: string nullable: true trim: type: string nullable: true style: type: string nullable: true body: type: string nullable: true drivetrain: type: string nullable: true engine: type: string nullable: true transmission: type: string nullable: true interior: type: string nullable: true exterior: type: string nullable: true listings: items: type: number type: array nullable: true serviceQuotes: items: type: number type: array nullable: true tenant: type: number nullable: true trades: items: type: number type: array nullable: true createdBy: type: number nullable: true transportServiceOrders: type: string nullable: true transportServiceOrders2: items: type: number type: array nullable: true updatedAt: type: string createdAt: type: string required: - id - updatedAt - createdAt type: array nullable: true consumerPhoneType: type: string nullable: true consumerDriversLicense: type: string nullable: true consumerDriversLicenseState: type: string nullable: true consumerDriversLicenseNumber: type: string nullable: true consumerDriversLicenseExp: type: string nullable: true consumerDriversLicenseExpiration: type: string nullable: true consumerPreApprovals: items: oneOf: - type: number - additionalProperties: false title: PreApproval type: object properties: customer: type: number nullable: true title: type: string nullable: true status: enum: - Processing - Error - Processed - Needs Info type: string nullable: true firstName: type: string nullable: true middleInitial: type: string nullable: true lastName: type: string nullable: true suffix: enum: - JR - SR - II - III - IV type: string nullable: true address: type: string nullable: true city: type: string nullable: true state: enum: - AA - AE - AK - AL - AR - AS - AZ - CA - CO - CT - DC - DE - FL - FM - GA - GU - HI - IA - ID - IL - IN - KS - KY - LA - MA - MD - ME - MH - MI - MN - MO - MP - MS - MT - NC - ND - NE - NH - NJ - NM - NV - NY - OH - OK - OR - PA - PR - PW - RI - SC - SD - TN - TX - UT - VA - VI - VT - WA - WI - WV - WY - AP type: string nullable: true zip: type: string nullable: true phone: type: string nullable: true email: type: string nullable: true income: type: string nullable: true ipAddress: type: string nullable: true userAgent: type: string nullable: true isp: type: string nullable: true sessionId: type: string nullable: true resend: type: string nullable: true AppId: type: number nullable: true segmentationBand: enum: - Excellent (750-900) - Good (700-749) - Fair (650-699) - Fair (600-649) - OK (550-599) - Lower (300-549) - Unknown - NS type: string nullable: true Name: type: string nullable: true Score: type: string nullable: true Status: type: string nullable: true CreateDate: type: string nullable: true DealerName: type: string nullable: true Email: type: string nullable: true AppMobileNo: type: string nullable: true IsFullFileReportAvilable: type: boolean nullable: true estimatedInterestRate: type: string nullable: true estimatedLoanTerm: type: string nullable: true lead: type: number nullable: true UserName: type: string nullable: true ProductId: type: number nullable: true QuickProductId: type: number nullable: true StatusId: type: number nullable: true IsQqPass: type: number nullable: true IsQuickQualifyXpress: type: boolean nullable: true IsLeadFormReport: type: boolean nullable: true IsQr: type: boolean nullable: true RemoveOperator: type: boolean nullable: true IsQScan: type: boolean nullable: true QuickScanStatus: type: string nullable: true updatedAt: type: string createdAt: type: string required: - id - updatedAt - createdAt type: array nullable: true consumerGetPreApproved: type: string nullable: true consumerProvideProofOfInsurance: type: string nullable: true consumerLoginToBank: type: string nullable: true consumerConnectCar: type: string nullable: true consumerProvideProofOfIncome: type: string nullable: true consumerConsumerId: type: string nullable: true consumerCreditApplicationId: type: string nullable: true deals2: items: oneOf: - type: number - additionalProperties: false title: Deal type: object properties: customer: type: number nullable: true vehicle: type: number nullable: true dealId: type: string nullable: true customerRelationship: type: string nullable: true coCustomer: type: number nullable: true companyConsumerCustomer: type: number nullable: true lienHolder: items: type: number type: array nullable: true dealer: type: number nullable: true facilitator: items: type: number type: array nullable: true type: items: enum: - Wholesale Dropship - Wholesale - Concierge Search - Consignment - Instant Cash Offer - Concierge Buy - Private Party type: string type: array nullable: true salesPrice: type: string nullable: true margin: type: string nullable: true downPayment: type: string nullable: true financedAmount: type: string nullable: true taxesAndFees: type: number nullable: true dependencies: items: type: number type: array nullable: true unsignedDocuments: type: string nullable: true signedDocuments: type: string nullable: true deliveryAddress: items: type: number type: array nullable: true paymentLink: type: string nullable: true getTradeOffer: type: string nullable: true notarizePowerOfAttorney: type: string nullable: true serviceQuotes: items: type: number type: array nullable: true tenant: type: number nullable: true trades: items: type: number type: array nullable: true creditApplications: items: type: number type: array nullable: true latestError: type: string nullable: true vscProvider: type: number nullable: true vsc: type: string nullable: true gapProvider: type: number nullable: true gap: type: string nullable: true status: type: string nullable: true transportServiceOrders: items: type: number type: array nullable: true mileage: type: number nullable: true createdBy: type: number nullable: true lastModifiedBy: type: number nullable: true development: type: boolean nullable: true updatedAt: type: string createdAt: type: string required: - id - updatedAt - createdAt type: array nullable: true consumerSocialSecurity: type: string nullable: true consumerDriversLicenceState: type: string nullable: true consumerIncome: type: number nullable: true consumerIncomeInterval: type: string nullable: true consumerEmploymentStatusCode: type: string nullable: true consumerEmploymentDuration: type: number nullable: true consumerEmployerName: type: string nullable: true consumerEmployerPhone: type: string nullable: true consumerEmploymentTitle: type: string nullable: true consumerPreviousEmployerName: type: string nullable: true consumerPreviousEmployerPhone: type: string nullable: true consumerPreviousEmploymentTitle: type: string nullable: true consumerPreviousEmploymentDuration: type: number nullable: true consumerPreviousEmploymentincome: type: number nullable: true consumerTimeAtResidence: type: number nullable: true consumerPreviousAddressLine1: type: string nullable: true consumerPreviousAddressLine2: type: string nullable: true consumerPreviousAddressCity: type: string nullable: true consumerPreviousAddressState: type: string nullable: true consumerPreviousZip: type: string nullable: true consumerPreviousAddressDuration: type: number nullable: true consumerResidenceType: type: string nullable: true consumerRentMortgage: type: number nullable: true consumerOtherIncomeDescription: type: string nullable: true consumerOtherIncomeAmount: type: number nullable: true consumerLeadSource: items: enum: - Car Concierge (Andrew) - Driv.ly Website - Self Generated - Referral - Rocket type: string type: array nullable: true companyName: type: string nullable: true companyDealerDeals: items: oneOf: - type: number - additionalProperties: false title: Deal type: object properties: customer: type: number nullable: true vehicle: type: number nullable: true dealId: type: string nullable: true customerRelationship: type: string nullable: true coCustomer: type: number nullable: true companyConsumerCustomer: type: number nullable: true lienHolder: items: type: number type: array nullable: true dealer: type: number nullable: true facilitator: items: type: number type: array nullable: true type: items: enum: - Wholesale Dropship - Wholesale - Concierge Search - Consignment - Instant Cash Offer - Concierge Buy - Private Party type: string type: array nullable: true salesPrice: type: string nullable: true margin: type: string nullable: true downPayment: type: string nullable: true financedAmount: type: string nullable: true taxesAndFees: type: number nullable: true dependencies: items: type: number type: array nullable: true unsignedDocuments: type: string nullable: true signedDocuments: type: string nullable: true deliveryAddress: items: type: number type: array nullable: true paymentLink: type: string nullable: true getTradeOffer: type: string nullable: true notarizePowerOfAttorney: type: string nullable: true serviceQuotes: items: type: number type: array nullable: true tenant: type: number nullable: true trades: items: type: number type: array nullable: true creditApplications: items: type: number type: array nullable: true latestError: type: string nullable: true vscProvider: type: number nullable: true vsc: type: string nullable: true gapProvider: type: number nullable: true gap: type: string nullable: true status: type: string nullable: true transportServiceOrders: items: type: number type: array nullable: true mileage: type: number nullable: true createdBy: type: number nullable: true lastModifiedBy: type: number nullable: true development: type: boolean nullable: true updatedAt: type: string createdAt: type: string required: - id - updatedAt - createdAt type: array nullable: true companyDealsFacilitated: items: oneOf: - type: number - additionalProperties: false title: Deal type: object properties: customer: type: number nullable: true vehicle: type: number nullable: true dealId: type: string nullable: true customerRelationship: type: string nullable: true coCustomer: type: number nullable: true companyConsumerCustomer: type: number nullable: true lienHolder: items: type: number type: array nullable: true dealer: type: number nullable: true facilitator: items: type: number type: array nullable: true type: items: enum: - Wholesale Dropship - Wholesale - Concierge Search - Consignment - Instant Cash Offer - Concierge Buy - Private Party type: string type: array nullable: true salesPrice: type: string nullable: true margin: type: string nullable: true downPayment: type: string nullable: true financedAmount: type: string nullable: true taxesAndFees: type: number nullable: true dependencies: items: type: number type: array nullable: true unsignedDocuments: type: string nullable: true signedDocuments: type: string nullable: true deliveryAddress: items: type: number type: array nullable: true paymentLink: type: string nullable: true getTradeOffer: type: string nullable: true notarizePowerOfAttorney: type: string nullable: true serviceQuotes: items: type: number type: array nullable: true tenant: type: number nullable: true trades: items: type: number type: array nullable: true creditApplications: items: type: number type: array nullable: true latestError: type: string nullable: true vscProvider: type: number nullable: true vsc: type: string nullable: true gapProvider: type: number nullable: true gap: type: string nullable: true status: type: string nullable: true transportServiceOrders: items: type: number type: array nullable: true mileage: type: number nullable: true createdBy: type: number nullable: true lastModifiedBy: type: number nullable: true development: type: boolean nullable: true updatedAt: type: string createdAt: type: string required: - id - updatedAt - createdAt type: array nullable: true companyInsuranceQuotes: items: oneOf: - type: number - additionalProperties: false title: InsuranceQuote type: object properties: name: type: string nullable: true customer: items: type: number type: array nullable: true tenant: type: number nullable: true updatedAt: type: string createdAt: type: string required: - id - updatedAt - createdAt type: array nullable: true companyType: items: enum: - Dealer - Concierge - Broker - Partner - Auction - Affiliate - Insurer - Mobile Detailer - Last Mile Transporter - Service Provider - Lender type: string type: array nullable: true companyWebsite: type: string nullable: true companyStripeConnectLink: type: string nullable: true companyCustomerPortalLink: type: string nullable: true companyServiceQuotes: items: oneOf: - type: number - additionalProperties: false title: ServiceQuote type: object properties: name: type: string nullable: true type: items: enum: - Vehicle Service Contract - Pre-Paid Maintenance - Long Haul Transport - Last Mile Delivery - Pre-Purchase Inspection - Post Sale Inspection - Condition Inspection - Safety Inspection - Mechanical Inspection - Wash And Detail type: string type: array nullable: true status: enum: - Quoted - Pending - In Review - Active - Dispatched - En Route - Complete - Hold - Cancel - Error type: string nullable: true serviceProvider: items: type: number type: array nullable: true quoteId: type: string nullable: true partner: type: number nullable: true serviceOrders: type: string nullable: true checkoutLink: type: string nullable: true deal: type: number nullable: true vehicle: type: number nullable: true rush: type: boolean nullable: true etaMin: type: string nullable: true etaMax: type: string nullable: true distance: type: number nullable: true expires: type: string nullable: true cost: type: string nullable: true price: type: string nullable: true margin: type: string nullable: true partnerProfitShare: type: string nullable: true partnerMargin: type: string nullable: true tenant: type: number nullable: true transportServiceOrders: type: string nullable: true transportServiceOrders2: items: type: number type: array nullable: true updatedAt: type: string createdAt: type: string required: - id - updatedAt - createdAt type: array nullable: true companyServiceOrders: type: string nullable: true companyServiceQuotesPartners: items: oneOf: - type: number - additionalProperties: false title: ServiceQuote type: object properties: name: type: string nullable: true type: items: enum: - Vehicle Service Contract - Pre-Paid Maintenance - Long Haul Transport - Last Mile Delivery - Pre-Purchase Inspection - Post Sale Inspection - Condition Inspection - Safety Inspection - Mechanical Inspection - Wash And Detail type: string type: array nullable: true status: enum: - Quoted - Pending - In Review - Active - Dispatched - En Route - Complete - Hold - Cancel - Error type: string nullable: true serviceProvider: items: type: number type: array nullable: true quoteId: type: string nullable: true partner: type: number nullable: true serviceOrders: type: string nullable: true checkoutLink: type: string nullable: true deal: type: number nullable: true vehicle: type: number nullable: true rush: type: boolean nullable: true etaMin: type: string nullable: true etaMax: type: string nullable: true distance: type: number nullable: true expires: type: string nullable: true cost: type: string nullable: true price: type: string nullable: true margin: type: string nullable: true partnerProfitShare: type: string nullable: true partnerMargin: type: string nullable: true tenant: type: number nullable: true transportServiceOrders: type: string nullable: true transportServiceOrders2: items: type: number type: array nullable: true updatedAt: type: string createdAt: type: string required: - id - updatedAt - createdAt type: array nullable: true companyVisibility: type: string nullable: true companyTenants2: items: oneOf: - type: number - additionalProperties: false title: Tenant type: object properties: name: type: string nullable: true customer: items: type: number type: array nullable: true defaultDealer: items: type: number type: array nullable: true defaultFacilitator: type: number nullable: true email: type: string nullable: true apiKey: type: string nullable: true environment: type: string nullable: true creditApplicationLabel: type: string nullable: true deals: items: type: number type: array nullable: true locations: items: type: number type: array nullable: true insuranceQuotes: items: type: number type: array nullable: true serviceQuotes: items: type: number type: array nullable: true serviceOrders: type: string nullable: true insurancePolicies: items: type: number type: array nullable: true addresses: items: type: number type: array nullable: true listings: items: type: number type: array nullable: true vehicles: items: type: number type: array nullable: true webhooks: items: type: number type: array nullable: true taxesAndFees: items: type: number type: array nullable: true dmvFees: items: type: number type: array nullable: true transportServiceOrders: items: type: number type: array nullable: true updatedAt: type: string createdAt: type: string required: - id - updatedAt - createdAt type: array nullable: true companyCustomer: items: oneOf: - type: number - additionalProperties: false title: Customer type: object properties: customerId: type: string nullable: true leads: items: type: number type: array nullable: true address: type: number nullable: true shippingContact: type: number nullable: true deals: items: type: number type: array nullable: true createdBy: type: number nullable: true lastModifiedBy: type: number nullable: true email: type: string nullable: true phone: type: string nullable: true insurancePolicies: items: type: number type: array nullable: true tenants: items: type: number type: array nullable: true consumerStatus: enum: - SOLD - Pending - Working - Cold - LOST - Duplicate - DNC type: string nullable: true consumerFirstName: type: string nullable: true consumerMiddleName: type: string nullable: true consumerLastName: type: string nullable: true consumerSuffix: type: string nullable: true consumerDateOfBirth: type: string nullable: true consumerEducationLevel: type: string nullable: true consumerVehicles: items: type: number type: array nullable: true consumerPhoneType: type: string nullable: true consumerDriversLicense: type: string nullable: true consumerDriversLicenseState: type: string nullable: true consumerDriversLicenseNumber: type: string nullable: true consumerDriversLicenseExp: type: string nullable: true consumerDriversLicenseExpiration: type: string nullable: true consumerPreApprovals: items: type: number type: array nullable: true consumerGetPreApproved: type: string nullable: true consumerProvideProofOfInsurance: type: string nullable: true consumerLoginToBank: type: string nullable: true consumerConnectCar: type: string nullable: true consumerProvideProofOfIncome: type: string nullable: true consumerConsumerId: type: string nullable: true consumerCreditApplicationId: type: string nullable: true deals2: items: type: number type: array nullable: true consumerSocialSecurity: type: string nullable: true consumerDriversLicenceState: type: string nullable: true consumerIncome: type: number nullable: true consumerIncomeInterval: type: string nullable: true consumerEmploymentStatusCode: type: string nullable: true consumerEmploymentDuration: type: number nullable: true consumerEmployerName: type: string nullable: true consumerEmployerPhone: type: string nullable: true consumerEmploymentTitle: type: string nullable: true consumerPreviousEmployerName: type: string nullable: true consumerPreviousEmployerPhone: type: string nullable: true consumerPreviousEmploymentTitle: type: string nullable: true consumerPreviousEmploymentDuration: type: number nullable: true consumerPreviousEmploymentincome: type: number nullable: true consumerTimeAtResidence: type: number nullable: true consumerPreviousAddressLine1: type: string nullable: true consumerPreviousAddressLine2: type: string nullable: true consumerPreviousAddressCity: type: string nullable: true consumerPreviousAddressState: type: string nullable: true consumerPreviousZip: type: string nullable: true consumerPreviousAddressDuration: type: number nullable: true consumerResidenceType: type: string nullable: true consumerRentMortgage: type: number nullable: true consumerOtherIncomeDescription: type: string nullable: true consumerOtherIncomeAmount: type: number nullable: true consumerLeadSource: items: enum: - Car Concierge (Andrew) - Driv.ly Website - Self Generated - Referral - Rocket type: string type: array nullable: true companyName: type: string nullable: true companyDealerDeals: items: type: number type: array nullable: true companyDealsFacilitated: items: type: number type: array nullable: true companyInsuranceQuotes: items: type: number type: array nullable: true companyType: items: enum: - Dealer - Concierge - Broker - Partner - Auction - Affiliate - Insurer - Mobile Detailer - Last Mile Transporter - Service Provider - Lender type: string type: array nullable: true companyWebsite: type: string nullable: true companyStripeConnectLink: type: string nullable: true companyCustomerPortalLink: type: string nullable: true companyServiceQuotes: items: type: number type: array nullable: true companyServiceOrders: type: string nullable: true companyServiceQuotesPartners: items: type: number type: array nullable: true companyVisibility: type: string nullable: true companyTenants2: items: type: number type: array nullable: true companyCustomer: items: type: number type: array nullable: true companyTrades: items: type: number type: array nullable: true companyTenants3: items: type: number type: array nullable: true companyPartnerBrand: type: number nullable: true companyDeals3: items: type: number type: array nullable: true companyRouteOneDealer: type: string nullable: true companyTransportServiceOrders: items: type: number type: array nullable: true updatedAt: type: string createdAt: type: string required: - id - updatedAt - createdAt type: array nullable: true companyTrades: items: oneOf: - type: number - additionalProperties: false title: Trade type: object properties: status: enum: - 'Vehicle Picked Up ' - Dropped Off At Manheim type: string nullable: true deal: type: number nullable: true creditApplication: type: number nullable: true tradeInAllowance: type: string nullable: true odometer: type: number nullable: true lienholder: type: number nullable: true tradeInPayoffBalance: type: string nullable: true payoffGoodThrough: type: string nullable: true vehicle: type: number nullable: true lastModifiedBy: type: number nullable: true updatedAt: type: string createdAt: type: string required: - id - updatedAt - createdAt type: array nullable: true companyTenants3: items: oneOf: - type: number - additionalProperties: false title: Tenant type: object properties: name: type: string nullable: true customer: items: type: number type: array nullable: true defaultDealer: items: type: number type: array nullable: true defaultFacilitator: type: number nullable: true email: type: string nullable: true apiKey: type: string nullable: true environment: type: string nullable: true creditApplicationLabel: type: string nullable: true deals: items: type: number type: array nullable: true locations: items: type: number type: array nullable: true insuranceQuotes: items: type: number type: array nullable: true serviceQuotes: items: type: number type: array nullable: true serviceOrders: type: string nullable: true insurancePolicies: items: type: number type: array nullable: true addresses: items: type: number type: array nullable: true listings: items: type: number type: array nullable: true vehicles: items: type: number type: array nullable: true webhooks: items: type: number type: array nullable: true taxesAndFees: items: type: number type: array nullable: true dmvFees: items: type: number type: array nullable: true transportServiceOrders: items: type: number type: array nullable: true updatedAt: type: string createdAt: type: string required: - id - updatedAt - createdAt type: array nullable: true companyPartnerBrand: oneOf: - type: number nullable: true - additionalProperties: false title: Brand type: object properties: logoSvg: type: string nullable: true logoPng: type: string nullable: true primaryColor: type: string nullable: true hoverColor: type: string nullable: true secondaryColor: type: string nullable: true legalName: type: string nullable: true status: enum: - Active - Inactive type: string nullable: true customer: type: number nullable: true createdBy: type: number nullable: true updatedAt: type: string createdAt: type: string required: - id - updatedAt - createdAt companyDeals3: items: oneOf: - type: number - additionalProperties: false title: Deal type: object properties: customer: type: number nullable: true vehicle: type: number nullable: true dealId: type: string nullable: true customerRelationship: type: string nullable: true coCustomer: type: number nullable: true companyConsumerCustomer: type: number nullable: true lienHolder: items: type: number type: array nullable: true dealer: type: number nullable: true facilitator: items: type: number type: array nullable: true type: items: enum: - Wholesale Dropship - Wholesale - Concierge Search - Consignment - Instant Cash Offer - Concierge Buy - Private Party type: string type: array nullable: true salesPrice: type: string nullable: true margin: type: string nullable: true downPayment: type: string nullable: true financedAmount: type: string nullable: true taxesAndFees: type: number nullable: true dependencies: items: type: number type: array nullable: true unsignedDocuments: type: string nullable: true signedDocuments: type: string nullable: true deliveryAddress: items: type: number type: array nullable: true paymentLink: type: string nullable: true getTradeOffer: type: string nullable: true notarizePowerOfAttorney: type: string nullable: true serviceQuotes: items: type: number type: array nullable: true tenant: type: number nullable: true trades: items: type: number type: array nullable: true creditApplications: items: type: number type: array nullable: true latestError: type: string nullable: true vscProvider: type: number nullable: true vsc: type: string nullable: true gapProvider: type: number nullable: true gap: type: string nullable: true status: type: string nullable: true transportServiceOrders: items: type: number type: array nullable: true mileage: type: number nullable: true createdBy: type: number nullable: true lastModifiedBy: type: number nullable: true development: type: boolean nullable: true updatedAt: type: string createdAt: type: string required: - id - updatedAt - createdAt type: array nullable: true companyRouteOneDealer: type: string nullable: true companyTransportServiceOrders: items: oneOf: - type: number - additionalProperties: false title: ServiceOrder type: object properties: name: type: string nullable: true type: items: enum: - Condition Inspection - Last Mile Delivery - Long Haul Transport - Mechanical Inspection - Post Sale Inspection - Pre-Paid Maintenance - Pre-Purchase Inspection - Safety Inspection - Vehicle Service Contract - Wash And Detail type: string type: array nullable: true customer: items: type: number type: array nullable: true serviceQuotes: type: number nullable: true paymentLink: type: string nullable: true vin: type: number nullable: true status: enum: - Quoted - Pending - In Review - Active - Dispatched - En Route - Complete - Hold - Cancel - Error type: string nullable: true error: type: string nullable: true orderId: type: string nullable: true price: type: string nullable: true rush: type: boolean nullable: true attachments: items: type: number type: array nullable: true quoteExpiration: type: string nullable: true ordered: type: string nullable: true start: type: string nullable: true due: type: string nullable: true consignor: type: number nullable: true billTo: type: number nullable: true origin: type: number nullable: true destination: type: number nullable: true deals: items: type: number type: array nullable: true orderLink: type: string nullable: true tenant: items: type: number type: array nullable: true updatedAt: type: string createdAt: type: string required: - id - updatedAt - createdAt type: array nullable: true updatedAt: type: string createdAt: type: string required: - id - updatedAt - createdAt customersUpsertConfirmation: type: object title: Customer upsert confirmation properties: doc: additionalProperties: false title: Customer type: object properties: customerId: type: string nullable: true leads: items: type: number type: array nullable: true address: type: number nullable: true shippingContact: type: number nullable: true deals: items: type: number type: array nullable: true createdBy: type: number nullable: true lastModifiedBy: type: number nullable: true email: type: string nullable: true phone: type: string nullable: true insurancePolicies: items: type: number type: array nullable: true tenants: items: type: number type: array nullable: true consumerStatus: enum: - SOLD - Pending - Working - Cold - LOST - Duplicate - DNC type: string nullable: true consumerFirstName: type: string nullable: true consumerMiddleName: type: string nullable: true consumerLastName: type: string nullable: true consumerSuffix: type: string nullable: true consumerDateOfBirth: type: string nullable: true consumerEducationLevel: type: string nullable: true consumerVehicles: items: type: number type: array nullable: true consumerPhoneType: type: string nullable: true consumerDriversLicense: type: string nullable: true consumerDriversLicenseState: type: string nullable: true consumerDriversLicenseNumber: type: string nullable: true consumerDriversLicenseExp: type: string nullable: true consumerDriversLicenseExpiration: type: string nullable: true consumerPreApprovals: items: type: number type: array nullable: true consumerGetPreApproved: type: string nullable: true consumerProvideProofOfInsurance: type: string nullable: true consumerLoginToBank: type: string nullable: true consumerConnectCar: type: string nullable: true consumerProvideProofOfIncome: type: string nullable: true consumerConsumerId: type: string nullable: true consumerCreditApplicationId: type: string nullable: true deals2: items: type: number type: array nullable: true consumerSocialSecurity: type: string nullable: true consumerDriversLicenceState: type: string nullable: true consumerIncome: type: number nullable: true consumerIncomeInterval: type: string nullable: true consumerEmploymentStatusCode: type: string nullable: true consumerEmploymentDuration: type: number nullable: true consumerEmployerName: type: string nullable: true consumerEmployerPhone: type: string nullable: true consumerEmploymentTitle: type: string nullable: true consumerPreviousEmployerName: type: string nullable: true consumerPreviousEmployerPhone: type: string nullable: true consumerPreviousEmploymentTitle: type: string nullable: true consumerPreviousEmploymentDuration: type: number nullable: true consumerPreviousEmploymentincome: type: number nullable: true consumerTimeAtResidence: type: number nullable: true consumerPreviousAddressLine1: type: string nullable: true consumerPreviousAddressLine2: type: string nullable: true consumerPreviousAddressCity: type: string nullable: true consumerPreviousAddressState: type: string nullable: true consumerPreviousZip: type: string nullable: true consumerPreviousAddressDuration: type: number nullable: true consumerResidenceType: type: string nullable: true consumerRentMortgage: type: number nullable: true consumerOtherIncomeDescription: type: string nullable: true consumerOtherIncomeAmount: type: number nullable: true consumerLeadSource: items: enum: - Car Concierge (Andrew) - Driv.ly Website - Self Generated - Referral - Rocket type: string type: array nullable: true companyName: type: string nullable: true companyDealerDeals: items: type: number type: array nullable: true companyDealsFacilitated: items: type: number type: array nullable: true companyInsuranceQuotes: items: type: number type: array nullable: true companyType: items: enum: - Dealer - Concierge - Broker - Partner - Auction - Affiliate - Insurer - Mobile Detailer - Last Mile Transporter - Service Provider - Lender type: string type: array nullable: true companyWebsite: type: string nullable: true companyStripeConnectLink: type: string nullable: true companyCustomerPortalLink: type: string nullable: true companyServiceQuotes: items: type: number type: array nullable: true companyServiceOrders: type: string nullable: true companyServiceQuotesPartners: items: type: number type: array nullable: true companyVisibility: type: string nullable: true companyTenants2: items: type: number type: array nullable: true companyCustomer: items: type: number type: array nullable: true companyTrades: items: type: number type: array nullable: true companyTenants3: items: type: number type: array nullable: true companyPartnerBrand: type: number nullable: true companyDeals3: items: type: number type: array nullable: true companyRouteOneDealer: type: string nullable: true companyTransportServiceOrders: items: type: number type: array nullable: true updatedAt: type: string createdAt: type: string required: - id - updatedAt - createdAt message: type: string required: - doc - message error: title: Error response message type: object additionalProperties: false properties: errors: type: array items: type: object additionalProperties: false properties: message: type: string required: - message required: - errors securitySchemes: apiKeyAuth: in: header type: apiKey name: Authorization ````