{ "openapi": "3.0.0", "info": { "title": "Driveo AI API stateless RESTful API documentation", "version": "1.0.0" }, "servers": [ { "url": "/api/v1/ai/", "description": "For AI API server" } ], "paths": { "/appointment": { "get": { "tags": [ "Appointments" ], "description": "Get available appointments times for this vehicle", "operationId": "aa41872c564f20ad7c226beb8562b01a", "parameters": [ { "name": "vehicle_id", "in": "query", "description": "Vehicle ID", "required": true, "example": "" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppointmentInfoResource" } } } }, "422": { "description": "Error: Unprocessable Content" }, "403": { "description": "Error: Forbidden" }, "404": { "description": "Error: Sorry. Record not found." } }, "security": [ { "sanctum": [] } ] }, "put": { "tags": [ "Appointments" ], "description": "Reschedule appointment by app id", "operationId": "2caf28f1c3272d6aebc5b06e281df00e", "parameters": [ { "name": "appointment_id", "in": "query", "description": "Appointment ID", "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAppointmentsRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAppointmentsRequest" } } } }, "422": { "description": "Error: Unprocessable Content" }, "403": { "description": "Error: Forbidden" }, "404": { "description": "Error: Sorry. Record not found." } }, "security": [ { "sanctum": [] } ] }, "post": { "tags": [ "Appointments" ], "description": "Create appointment for this vehicle", "operationId": "916ffe221843b2416968bfc739b33ee3", "parameters": [ { "name": "vehicle_id", "in": "query", "description": "Vehicle ID", "required": true, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAppointmentRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAppointmentResource" } } } }, "422": { "description": "Error: Unprocessable Content" }, "403": { "description": "Error: Forbidden" }, "404": { "description": "Error: Sorry. Record not found." } }, "security": [ { "sanctum": [] } ] }, "delete": { "tags": [ "Appointments" ], "description": "Delete appointment by ID", "operationId": "ab92314261c45b8ae2c379662a947b6a", "parameters": [ { "name": "appointment_id", "in": "query", "description": "Appointment ID", "required": false, "example": "" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteAppointmentByID" } } } }, "422": { "description": "Error: Unprocessable Content" }, "403": { "description": "Error: Forbidden" }, "404": { "description": "Error: Sorry. Record not found." } }, "security": [ { "sanctum": [] } ] } }, "/get-appointment-id": { "get": { "tags": [ "Appointments" ], "description": "Get appointment id for emails address, phone number or vehicle ID", "operationId": "2f8bcb147e37bb43895a9224e3f8f468", "parameters": [ { "name": "vehicle_id", "in": "query", "description": "Vehicle ID", "required": false, "example": "" }, { "name": "vin", "in": "query", "description": "VIN", "required": false, "example": "" }, { "name": "email", "in": "query", "description": "Email", "required": false, "example": "" }, { "name": "phone_number", "in": "query", "description": "Phone number", "required": false, "example": "" }, { "name": "appointment_details", "in": "query", "description": "Get all appointment details. Only Yes or No", "required": false, "example": "" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAppointmentByTermRequest" } } } }, "422": { "description": "Error: Unprocessable Content" }, "403": { "description": "Error: Forbidden" }, "404": { "description": "Error: Sorry. Record not found." } }, "security": [ { "sanctum": [] } ] } }, "/get-inventory": { "get": { "tags": [ "AutoData" ], "summary": "Get auto data by location id or dealer id", "description": "Get auto data by location id or dealer id", "operationId": "78854263146b7a4b1f416ae24b4fc1fc", "parameters": [ { "name": "status", "in": "query", "description": "Status: sold or current", "required": false, "example": "sold" }, { "name": "start_date", "in": "query", "description": "StartDate", "required": false, "example": "2023-12-01" }, { "name": "end_date", "in": "query", "description": "EndDate", "required": false, "example": "2024-01-01" }, { "name": "location_id", "in": "query", "description": "Location ID", "required": false, "example": "1" }, { "name": "show_group", "in": "query", "description": "Show inventory for the whole dealer group", "required": false, "example": false } ], "responses": { "200": { "description": "OK" }, "422": { "description": "Error: Unprocessable Content" }, "403": { "description": "Error: Forbidden" } }, "security": [ { "sanctum": [] } ] } }, "/call-history": { "get": { "tags": [ "Calls" ], "description": "Endpoint that returns a list of calls by location and date.", "operationId": "4679d4ebe2aafce789f8e99ce4939385", "parameters": [ { "name": "start_date", "in": "query", "description": "StartDate", "required": true, "example": "2023-07-01" }, { "name": "end_date", "in": "query", "description": "EndDate", "required": true, "example": "2023-07-26" }, { "name": "location_id", "in": "query", "description": "Location ID", "required": true, "example": "1" }, { "name": "page", "in": "query", "description": "Pagination page", "required": true, "example": "1" } ], "responses": { "422": { "description": "Error: Unprocessable Content" }, "403": { "description": "Error: Forbidden" } }, "security": [ { "sanctum": [] } ] } }, "/client/log-history": { "get": { "tags": [ "Clients" ], "description": "Returns client log history", "operationId": "84e1cb11d8749c5699fd9e4bc45f3fef", "parameters": [ { "name": "vehicle_id", "in": "query", "description": "Vehicle id", "required": false, "example": "" }, { "name": "email", "in": "query", "description": "Email", "required": false, "example": "" }, { "name": "phone", "in": "query", "description": "Phone", "required": false, "example": "" }, { "name": "period", "in": "query", "description": "Options = recent or empty. Recent returns log history for the last 30 days if empty returns all logs", "required": false, "example": "recent" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientLogHistoryResource" } } } }, "422": { "description": "Error: Unprocessable Content" }, "403": { "description": "Error: Forbidden" } }, "security": [ { "sanctum": [] } ] } }, "/client/get-general-info": { "get": { "tags": [ "Clients" ], "description": "Get general info about client from emails address, phone number or vehicle ID", "operationId": "908811ddf855ff7d2ccfcc48b942ff04", "parameters": [ { "name": "vehicle_id", "in": "query", "description": "Vehicle ID", "required": false, "example": "" }, { "name": "vin", "in": "query", "description": "VIN", "required": false, "example": "" }, { "name": "email", "in": "query", "description": "Email", "required": false, "example": "" }, { "name": "phone_number", "in": "query", "description": "Phone number", "required": false, "example": "" } ], "responses": { "200": { "description": "OK" }, "422": { "description": "Error: Unprocessable Content" }, "403": { "description": "Error: Forbidden" }, "404": { "description": "Error: Sorry. Record not found." } }, "security": [ { "sanctum": [] } ] } }, "/decode/vin": { "get": { "tags": [ "Decoder" ], "description": "Decode vin", "operationId": "0fed67f914e0bb467b20eb3f31c7daaa", "parameters": [ { "name": "vin", "in": "query", "description": "vin", "required": true, "example": "KNDJP3A57G7297796" } ], "responses": { "422": { "description": "Error: Unprocessable Content" }, "403": { "description": "Error: Forbidden" } }, "security": [ { "sanctum": [] } ] } }, "/decode/plate": { "get": { "tags": [ "Decoder" ], "description": "Decode plate", "operationId": "0b2038eeb0abdeb683fc2b246cf396cc", "parameters": [ { "name": "plate", "in": "query", "description": "plate", "required": true, "example": "TESLA28" }, { "name": "state", "in": "query", "description": "state", "required": true, "example": "AZ" } ], "responses": { "422": { "description": "Error: Unprocessable Content" }, "403": { "description": "Error: Forbidden" } }, "security": [ { "sanctum": [] } ] } }, "/decode/valuation": { "get": { "tags": [ "Decoder" ], "description": "Get valuation by plate or vin", "operationId": "5e1997eda9ce3d45c2ec0ebab3d16291", "parameters": [ { "name": "vin", "in": "query", "description": "vin", "required": false, "example": "KNDJP3A57G7297796" }, { "name": "plate", "in": "query", "description": "plate", "required": false, "example": "TESLA28" }, { "name": "state", "in": "query", "description": "state", "required": false, "example": "AZ" }, { "name": "zip_code", "in": "query", "description": "Zip code", "required": false, "example": "92020" }, { "name": "miles", "in": "query", "description": "Miles", "required": false, "example": "" }, { "name": "provider", "in": "query", "description": "Vehicle info provider. For example: TP - TradePending, BB - BlackBock, JDP - JDPower. Default: BB", "required": true, "example": "BB" } ], "responses": { "422": { "description": "Error: Unprocessable Content" }, "403": { "description": "Error: Forbidden" } }, "security": [ { "sanctum": [] } ] } }, "/decode": { "get": { "tags": [ "Decoder" ], "description": "Get decoded data by vehicle id", "operationId": "1fd8a684daa33a61f4e1558300f1a579", "parameters": [ { "name": "vehicle_id", "in": "query", "description": "Vehicle ID", "required": true } ], "responses": { "422": { "description": "Error: Unprocessable Content" }, "403": { "description": "Error: Forbidden" } }, "security": [ { "sanctum": [] } ] } }, "/decoder": { "get": { "tags": [ "Decoder" ], "description": "Get decoded vehicle by year, make, model", "operationId": "1fafa233516e84a26c0063e2cac36928", "parameters": [ { "name": "year", "in": "query", "description": "year", "required": true }, { "name": "make_id", "in": "query", "description": "make", "required": false }, { "name": "model_id", "in": "query", "description": "year", "required": false } ], "responses": { "422": { "description": "Error: Unprocessable Content" }, "403": { "description": "Error: Forbidden" } }, "security": [ { "sanctum": [] } ] } }, "/locations": { "get": { "tags": [ "Locations" ], "description": "Get list of locations", "operationId": "ef0abbe879b417ef1e61ea3ef4cd7754", "parameters": [ { "name": "status", "in": "query", "description": "Status mast be published or hidden", "required": false, "example": "published" }, { "name": "data", "in": "query", "description": "Data field included params which will be returned. Example: id,state,name,area_name,slug,shortcode and etc.", "required": false, "example": "id" }, { "name": "location_id", "in": "query", "description": "Location ID", "required": false } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocationCollection" } } } }, "422": { "description": "Error: Unprocessable Content" }, "403": { "description": "Error: Forbidden" } }, "security": [ { "sanctum": [] } ] } }, "/near-locations": { "get": { "tags": [ "Locations" ], "description": "Get list of nearest locations by zip code", "operationId": "b5f12f007b65682a3cede1d4de1a4ed5", "parameters": [ { "name": "zip", "in": "query", "description": "Location zip code", "required": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocationCollection" } } } }, "422": { "description": "Error: Unprocessable Content" }, "403": { "description": "Error: Forbidden" } }, "security": [ { "sanctum": [] } ] } }, "/vehicle/get-images-name": { "get": { "tags": [ "Media" ], "summary": "Endpoint to get all image files names for a lead", "description": "Endpoint to get all image files names for a lead", "operationId": "2e391540af439c96b8dc5e8dbbbff2f2", "parameters": [ { "name": "vehicle_id", "in": "query", "description": "Vehicle ID", "required": true, "example": "" } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Error: Not Found" }, "403": { "description": "Error: Forbidden" } }, "security": [ { "sanctum": [] } ] } }, "/vehicle/get-images-url": { "get": { "tags": [ "Media" ], "summary": "Endpoint to get all actual images for a lead", "description": "Endpoint to get all actual images for a lead", "operationId": "c9a80daf4482b6bf006e159b04d36ce3", "parameters": [ { "name": "vehicle_id", "in": "query", "description": "Vehicle ID", "required": true, "example": "" } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Error: Not Found" }, "403": { "description": "Error: Forbidden" } }, "security": [ { "sanctum": [] } ] } }, "/vehicle/delete-all-images": { "delete": { "tags": [ "Media" ], "summary": "Endpoint to delete all images at once but not offer images", "description": "Endpoint to delete all images at once but not offer images", "operationId": "a6ad7ced2cb317a2738f43792c79233f", "parameters": [ { "name": "vehicle_id", "in": "query", "description": "Vehicle ID", "required": true, "example": "" } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Error: Not Found" }, "403": { "description": "Error: Forbidden" } }, "security": [ { "sanctum": [] } ] } }, "/vehicle/delete-image-by-name": { "delete": { "tags": [ "Media" ], "summary": "Endpoint to delete images by file name ", "description": "Endpoint to delete images by file name ", "operationId": "1d0fe76bf00730f9a57a6df850f3481e", "parameters": [ { "name": "vehicle_id", "in": "query", "description": "Vehicle ID", "required": true, "example": "" }, { "name": "file_name", "in": "query", "description": "File name", "required": true, "example": "" } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Error: Not Found" }, "403": { "description": "Error: Forbidden" } }, "security": [ { "sanctum": [] } ] } }, "/client/delete-all-files": { "delete": { "tags": [ "Media" ], "summary": "Endpoint to delete images by file name ", "description": "Endpoint to delete images by file name ", "operationId": "5c7e0665fb052f368591466754b03ddf", "parameters": [ { "name": "vehicle_id", "in": "query", "description": "Vehicle ID", "required": true, "example": "" }, { "name": "client_id", "in": "query", "description": "ID of the client", "example": "" }, { "name": "email", "in": "query", "description": "Client email", "example": "" }, { "name": "phone_number", "in": "query", "description": "Client phone number", "example": "" } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Error: Not Found" }, "403": { "description": "Error: Forbidden" } }, "security": [ { "sanctum": [] } ] } }, "/lead/upload-file": { "post": { "tags": [ "Media" ], "description": "Upload files for client", "operationId": "f3881a3a6a1836b17458147c03807e0a", "parameters": [ { "name": "client_id", "in": "query", "description": "ID of the client", "example": "" }, { "name": "vehicle_id", "in": "query", "description": "ID of the vehicle", "example": "" }, { "name": "email", "in": "query", "description": "Client email", "example": "" }, { "name": "phone_number", "in": "query", "description": "Client phone number", "example": "" }, { "name": "file_urls", "in": "query", "description": "File urls", "example": "" } ], "requestBody": { "description": "Upload files for client", "content": { "multipart/form-data": { "schema": { "properties": { "file": { "description": "File to upload (PDF, DOC, DOCX, XLS, XLSX, CSV, JPEG, PNG, ZIP)", "type": "string", "format": "binary" } }, "type": "object" } } } }, "responses": { "200": { "description": "File uploaded successfully", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "File uploaded successfully." } }, "type": "object" } } } }, "422": { "description": "Validation error: Unprocessable Content", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "Validation failed." }, "errors": { "type": "object", "example": { "file": [ "The file field is required." ] } } }, "type": "object" } } } }, "403": { "description": "Error: Forbidden", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "You do not have permission to upload files." } }, "type": "object" } } } } }, "security": [ { "sanctum": [] } ] } }, "/contact-message": { "post": { "tags": [ "Contact Message" ], "summary": "Send contact message", "description": "Send contact message by location ID", "operationId": "98cfaf35692c2a93018adcc417af4a13", "parameters": [ { "name": "location_id", "in": "query", "description": "Location ID", "required": true, "example": "1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewContactMessageRequest" } } } }, "responses": { "200": { "description": "OK" }, "422": { "description": "Error: Unprocessable Content" }, "403": { "description": "Error: Forbidden" } }, "security": [ { "sanctum": [] } ] } }, "/contact-message/history": { "get": { "tags": [ "Contact Message" ], "description": "Get history list contact messages by location ID", "operationId": "ab4dfbe4177201d2cb72d2a3ebfb8beb", "parameters": [ { "name": "location_id", "in": "query", "description": "Location ID", "required": true, "example": "1" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactMessageResource" } } } }, "422": { "description": "Error: Unprocessable Content" }, "403": { "description": "Error: Forbidden" } }, "security": [ { "sanctum": [] } ] } }, "/sms/send": { "post": { "tags": [ "SMS" ], "summary": "Send sms message", "description": "Send sms message", "operationId": "e49a0c47e872aae2685912d82054d722", "parameters": [ { "name": "vehicle_id", "in": "query", "description": "Vehicle ID", "required": true, "example": "235777" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewMessageRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageResource" } } } }, "422": { "description": "Error: Unprocessable Content" }, "403": { "description": "Error: Forbidden" } }, "security": [ { "sanctum": [] } ] } }, "/sms/schedule": { "post": { "tags": [ "SMS" ], "summary": "Schedule message", "description": "Schedule message", "operationId": "0c865b2ecf772feda08da75408c036f8", "parameters": [ { "name": "vehicle_id", "in": "query", "description": "Vehicle ID", "required": true, "example": "235777" }, { "name": "date", "in": "query", "description": "Date and Time to will be send. If not set, now", "required": true, "schema": { "type": "string", "format": "date-time" }, "example": "2024-01-01 00:00:00" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewMessageRequest" } } } }, "responses": { "200": { "description": "OK" }, "422": { "description": "Error: Unprocessable Content" }, "403": { "description": "Error: Forbidden" } }, "security": [ { "sanctum": [] } ] } }, "/sms/retrieve/scheduled-sms": { "get": { "tags": [ "SMS" ], "summary": "Retrieve message", "description": "Get retrieve scheduled sms by vehicle. If vehicle is not set, return all scheduled sms.", "operationId": "3f554efaeda31463ec381eba8621728c", "parameters": [ { "name": "vehicle_id", "in": "query", "description": "Vehicle ID", "required": false, "example": "229462" } ], "responses": { "200": { "description": "OK" }, "422": { "description": "Error: Unprocessable Content" }, "403": { "description": "Error: Forbidden" } }, "security": [ { "sanctum": [] } ] } }, "/sms/retrieve/static-sms-templates": { "get": { "tags": [ "SMS" ], "summary": "Retrieve static sms templates", "description": "Get static sms templates by location ID.", "operationId": "79660784b777762dcf4d62d11295a39a", "parameters": [ { "name": "location_id", "in": "query", "description": "Location ID", "required": true, "example": "" } ], "responses": { "200": { "description": "OK" }, "422": { "description": "Error: Unprocessable Content" }, "403": { "description": "Error: Forbidden" }, "500": { "description": "Server Error." } }, "security": [ { "sanctum": [] } ] } }, "/sms/send/static-sms": { "post": { "tags": [ "SMS" ], "summary": "Send static sms message", "description": "Send static sms message", "operationId": "0e03e4d44b4020fddb5031ce6fc21a61", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendStaticSmsResource" } } } }, "responses": { "200": { "description": "OK" }, "422": { "description": "Error: Unprocessable Content" }, "403": { "description": "Error: Forbidden" }, "500": { "description": "Server Error." } }, "security": [ { "sanctum": [] } ] } }, "/sms/cancel/scheduled-sms": { "get": { "tags": [ "SMS" ], "summary": "Cancel scheduled sms", "description": "Cancel scheduled all messages by vehicle or one by message id.", "operationId": "a833e752aa4743eee54af7635b2d5562", "parameters": [ { "name": "vehicle_id", "in": "query", "description": "Vehicle ID", "required": false, "example": "229462" }, { "name": "message_id", "in": "query", "description": "Message ID", "required": false, "example": "1" } ], "responses": { "200": { "description": "OK" }, "422": { "description": "Error: Unprocessable Content" }, "403": { "description": "Error: Forbidden" } }, "security": [ { "sanctum": [] } ] } }, "/sms/history": { "get": { "tags": [ "SMS" ], "description": "Endpoint that returns a list of sms by location and date.", "operationId": "d1b9135602beb92e18b60fb19cb6bac1", "parameters": [ { "name": "start_date", "in": "query", "description": "StartDate", "required": false, "example": "2023-07-01" }, { "name": "end_date", "in": "query", "description": "EndDate", "required": false, "example": "2023-07-26" }, { "name": "is_read", "in": "query", "description": "Is read sms true or false. Options: true, false if empty - all", "required": false, "example": "true" }, { "name": "location_id", "in": "query", "description": "Location ID", "required": true, "example": "1" }, { "name": "page", "in": "path", "description": "page", "required": true, "example": "1" } ], "responses": { "422": { "description": "Error: Unprocessable Content" }, "403": { "description": "Error: Forbidden" } }, "security": [ { "sanctum": [] } ] } }, "/sms/client/history": { "get": { "tags": [ "SMS" ], "description": "The endpoint will retrieve sms history by email, phone and quote id", "operationId": "90f623d5985a480a345c672c79e6970c", "parameters": [ { "name": "start_date", "in": "query", "description": "StartDate", "required": false, "example": "2023-07-01" }, { "name": "end_date", "in": "query", "description": "EndDate", "required": false, "example": "2023-07-26" }, { "name": "email", "in": "query", "description": "Email", "required": false, "example": "" }, { "name": "phone", "in": "query", "description": "Phone", "required": false, "example": "" }, { "name": "quote_info", "in": "query", "description": "Get request with Quote price info.True or False", "required": false, "example": "true" }, { "name": "vehicle_id", "in": "query", "description": "Vehicle ID", "required": false, "example": "" } ], "responses": { "422": { "description": "Error: Unprocessable Content" }, "403": { "description": "Error: Forbidden" } }, "security": [ { "sanctum": [] } ] } }, "/sms/mark-read": { "get": { "tags": [ "SMS" ], "description": "Mark is Read", "operationId": "80acd109a50128beae2f1a021b8a42e4", "parameters": [ { "name": "sms_id", "in": "query", "description": "Sms ID", "required": true, "example": "1" }, { "name": "is_read", "in": "query", "description": "Mark is read: true or false", "required": true, "example": "true" } ], "responses": { "422": { "description": "Error: Unprocessable Content" }, "403": { "description": "Error: Forbidden" } }, "security": [ { "sanctum": [] } ] } }, "/note-message": { "post": { "tags": [ "Vehicle Note Message" ], "summary": "Send note message", "description": "Send note message by vehicle ID", "operationId": "14dbd3ad1d8a408e18c291c107948f68", "parameters": [ { "name": "vehicle_id", "in": "query", "description": "Vehicle ID", "required": true, "example": "1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewNoteMessageRequest" } } } }, "responses": { "200": { "description": "OK" }, "422": { "description": "Error: Unprocessable Content" }, "403": { "description": "Error: Forbidden" } }, "security": [ { "sanctum": [] } ] } }, "/note-types": { "get": { "tags": [ "Vehicle Note Message" ], "summary": "Get note types", "description": "Get note types", "operationId": "9d880469259a2da8d3e6de5b513ff429", "responses": { "200": { "description": "OK" }, "404": { "description": "Error: Not Found" }, "403": { "description": "Error: Forbidden" } }, "security": [ { "sanctum": [] } ] } }, "/notify-admins": { "post": { "tags": [ "Notification" ], "summary": "Send notifications to admins", "description": "Send notifications (email, SMS, in-app) to admins by their IDs", "operationId": "2b868a45d1a2d4e6551939bb37255be6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminNotificationRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminNotificationResponse" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" } }, "security": [ { "sanctum": [] } ] } }, "/offer": { "get": { "tags": [ "Offers" ], "summary": "Get offer by vehicle id", "description": "Get offer by vehicle id", "operationId": "843348c3dbaa16c0c0c785a10a5f6024", "parameters": [ { "name": "vehicle_id", "in": "query", "description": "Vehicle ID", "required": false, "example": "229462" }, { "name": "history", "in": "query", "description": "show history", "required": false, "example": "false" }, { "name": "vin", "in": "query", "description": "VIN", "required": false, "example": "JH4CU2F81CC025713" }, { "name": "email", "in": "query", "description": "Email", "required": false, "example": "" }, { "name": "phone_number", "in": "query", "description": "Phone", "required": false, "example": "" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PurchaseOfferResource" } } } }, "422": { "description": "Error: Unprocessable Content" }, "403": { "description": "Error: Forbidden" } }, "security": [ { "sanctum": [] } ] } }, "/qualitative-assessment/": { "post": { "tags": [ "QualitativeAssessment" ], "summary": "Save Qualitative Assessment", "operationId": "c982221ede56d9c401f5bb762abc04fe", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VehicleAssessmentRequest" } } } }, "responses": { "200": { "description": "OK" }, "422": { "description": "Error: Unprocessable Content" }, "403": { "description": "Error: Forbidden" } }, "security": [ { "sanctum": [] } ] } }, "/sentiments/": { "post": { "tags": [ "Sentiments" ], "summary": "Create sentiment", "operationId": "78d34e4afbe65ac3b76e8d0a81f70af1", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "properties": { "id": { "type": "integer" }, "sentiment": { "type": "string" }, "sentiment_reason": { "type": "string" }, "follow_up_quality": { "type": "string" }, "follow_up_reason": { "type": "string" }, "purchase_interest": { "type": "string" } }, "type": "object" }, "example": [ { "id": 1, "sentiment": "Positive", "sentiment_reason": "Customer had a prior appointment scheduled...", "follow_up_quality": "Negative", "follow_up_reason": "There are no notes, outgoing calls...", "purchase_interest": "No" } ] } }, "type": "object" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Error: Unprocessable Content" }, "403": { "description": "Error: Forbidden" } }, "security": [ { "sanctum": [] } ] } }, "/sentiments/history": { "get": { "tags": [ "Sentiments" ], "summary": "Get sentiments history by vehicle id, email or phone number", "description": "Get sentiments history", "operationId": "2c7745dc304efe7e5c9a0c734629d95c", "parameters": [ { "name": "vehicle_id", "in": "query", "description": "Vehicle ID", "required": false, "example": "" } ], "responses": { "200": { "description": "OK" }, "422": { "description": "Error: Unprocessable Content" }, "403": { "description": "Error: Forbidden" } }, "security": [ { "sanctum": [] } ] } }, "/subscription/": { "get": { "tags": [ "Subscription" ], "description": "Subscription lead by email or sms", "operationId": "ca83ba43edd23b340a43737c504127a5", "parameters": [ { "name": "email", "in": "query", "description": "Customer email", "required": false, "example": "" }, { "name": "vehicle_id", "in": "query", "description": "Vehicle ID", "required": false, "example": "" }, { "name": "phone_number", "in": "query", "description": "Phone number", "required": false, "example": "" }, { "name": "email_notify", "in": "query", "description": "notify by email", "required": true, "example": "0" }, { "name": "sms_notify", "in": "query", "description": "notify by sms", "required": true, "example": "1" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionLeadResource" } } } }, "422": { "description": "Error: Unprocessable Content" }, "403": { "description": "Error: Forbidden" } }, "security": [ { "sanctum": [] } ] } }, "/lead-notification-setting": { "get": { "tags": [ "Subscription" ], "description": "Lead notification setting", "operationId": "eb3dfde92c9bf741a7f4ba33112fe448", "parameters": [ { "name": "vehicle_id", "in": "query", "description": "Vehicle ID", "required": true, "example": "" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationLeadResource" } } } }, "422": { "description": "Error: Unprocessable Content" }, "403": { "description": "Error: Forbidden" } }, "security": [ { "sanctum": [] } ] }, "post": { "tags": [ "Subscription" ], "description": "Set lead notification setting", "operationId": "7f8131a8519444587480271f9317e149", "parameters": [ { "name": "vehicle_id", "in": "query", "description": "Vehicle ID", "required": true, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetNotificationLeadRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationLeadResource" } } } }, "422": { "description": "Error: Unprocessable Content" }, "403": { "description": "Error: Forbidden" } }, "security": [ { "sanctum": [] } ] } }, "/short-link/": { "get": { "tags": [ "Short Link" ], "description": "Get short link for vehicle", "operationId": "e0dfb091825f66627b6710f237609431", "parameters": [ { "name": "vehicle_id", "in": "query", "description": "Vehicle ID", "required": true, "example": "" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Error: Unprocessable Content" }, "403": { "description": "Error: Forbidden" } }, "security": [ { "sanctum": [] } ] } }, "/ask-question": { "put": { "tags": [ "Questions" ], "summary": "Ask question for vehicle", "description": "Options answer field only for one or multiple choice type pls drop it if not choice it", "operationId": "8e59acde8aa767f6068de4ba2ca7a88b", "parameters": [ { "name": "vehicle_id", "in": "query", "description": "Vehicle ID", "required": true, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AskQuestionRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Error: Unprocessable Content" }, "403": { "description": "Error: Forbidden" } }, "security": [ { "sanctum": [] } ] } }, "/send-email": { "get": { "tags": [ "Mail" ], "description": "Send email for client from vehicle ID, phone_number or email address ", "operationId": "b403964d4532607729061e1f2af74614", "parameters": [ { "name": "vehicle_id", "in": "query", "description": "Vehicle ID", "required": false, "example": "" }, { "name": "phone_number", "in": "query", "description": "Phone number", "required": false, "example": "" }, { "name": "to", "in": "query", "description": "To email address", "required": false, "example": "" }, { "name": "subject", "in": "query", "description": "Subject", "required": true, "example": "" }, { "name": "body", "in": "query", "description": "Body", "required": true, "example": "" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Error: Unprocessable Content" }, "403": { "description": "Error: Forbidden" } }, "security": [ { "sanctum": [] } ] } }, "/tasks": { "get": { "tags": [ "Tasks" ], "summary": "Get tasks list by vehicle id", "operationId": "2bb6e3366e7e57a0ebb4865179b6cfd7", "parameters": [ { "name": "vehicle_id", "in": "query", "description": "Vehicle ID", "required": false, "example": "" }, { "name": "vin", "in": "query", "description": "VIN", "required": false, "example": "" }, { "name": "email", "in": "query", "description": "Email", "required": false, "example": "" }, { "name": "phone", "in": "query", "description": "Phone", "required": false, "example": "" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskCollection" } } } }, "422": { "description": "Error: Unprocessable Content" }, "403": { "description": "Error: Forbidden" } }, "security": [ { "sanctum": [] } ] }, "put": { "tags": [ "Tasks" ], "summary": "Update task by task id", "operationId": "5de0cb6481c8cb196daa6e2a5580a400", "parameters": [ { "name": "task_id", "in": "query", "description": "Task ID", "required": true, "example": "81505" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateTaskRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskResource" } } } }, "422": { "description": "Error: Unprocessable Content" }, "403": { "description": "Error: Forbidden" } }, "security": [ { "sanctum": [] } ] }, "post": { "tags": [ "Tasks" ], "summary": "Create task", "operationId": "fffb94e2e8604035a75af7f8a8d5019e", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateTaskRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskResource" } } } }, "422": { "description": "Error: Unprocessable Content" }, "403": { "description": "Error: Forbidden" } }, "security": [ { "sanctum": [] } ] }, "delete": { "tags": [ "Tasks" ], "summary": "Delete task by id", "operationId": "10cc60c8bc0f020fe777df66dc4e2d85", "parameters": [ { "name": "task_id", "in": "query", "description": "Task ID", "required": true, "example": "593441" } ], "responses": { "200": { "description": "OK" }, "422": { "description": "Error: Unprocessable Content" }, "403": { "description": "Error: Forbidden" } }, "security": [ { "sanctum": [] } ] } }, "/task": { "get": { "tags": [ "Tasks" ], "summary": "Get task by task id", "operationId": "33037711c869094596dd8e0d1136ea89", "parameters": [ { "name": "task_id", "in": "query", "description": "Task ID", "required": true, "example": "593441" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskResource" } } } }, "422": { "description": "Error: Unprocessable Content" }, "403": { "description": "Error: Forbidden" } }, "security": [ { "sanctum": [] } ] } }, "/task-types": { "get": { "tags": [ "Tasks" ], "summary": "Get task types", "operationId": "6df2da29eafb1bf82ff98100ec185b65", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskTypesResource" } } } }, "422": { "description": "Error: Unprocessable Content" }, "403": { "description": "Error: Forbidden" } }, "security": [ { "sanctum": [] } ] } }, "/search-terms": { "get": { "tags": [ "Terms" ], "summary": "Get list of retrieve stats for keywords.", "description": "Returns list of leads", "operationId": "5e9bb3684c125c635a7201f9417e8666", "parameters": [ { "name": "location_id", "in": "query", "description": "Location ID", "required": false, "example": "" }, { "name": "term", "in": "query", "description": "Term", "required": false, "example": "driveo" }, { "name": "start_date", "in": "query", "description": "StartDate", "required": false, "example": "2023-07-01" }, { "name": "end_date", "in": "query", "description": "EndDate", "required": false, "example": "2023-07-26" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TermResource" } } } }, "422": { "description": "Error: Unprocessable Content" }, "403": { "description": "Error: Forbidden" } }, "security": [ { "sanctum": [] } ] } }, "/popular-terms": { "get": { "tags": [ "Terms" ], "summary": "Returns 20 most popular terms", "description": "Returns 20 most popular terms", "operationId": "62af69393e835165392c44cb597e3cbb", "parameters": [ { "name": "location_id", "in": "query", "description": "Location ID", "required": false, "example": "" }, { "name": "start_date", "in": "query", "description": "StartDate", "required": false, "example": "2024-05-01" }, { "name": "end_date", "in": "query", "description": "EndDate", "required": false, "example": "2024-06-30" } ], "responses": { "200": { "description": "OK" }, "422": { "description": "Error: Unprocessable Content" }, "403": { "description": "Error: Forbidden" } }, "security": [ { "sanctum": [] } ] } }, "/user/roles": { "get": { "tags": [ "User" ], "summary": "Get list roles", "description": "User roles list", "operationId": "ee2f8ec7d3bf1fe3cece079e6974515c", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserRolesResource" } } } }, "422": { "description": "Error: Unprocessable Content" }, "403": { "description": "Error: Forbidden" } }, "security": [ { "sanctum": [] } ] } }, "/users": { "get": { "tags": [ "User" ], "summary": "Get list users per location", "description": "User list", "operationId": "ebdb2b6ad27d9b2b05837d75cdf6e9ce", "parameters": [ { "name": "location_id", "in": "query", "description": "Location ID", "required": false, "example": "" }, { "name": "show_phone", "in": "query", "description": "Show user phone number", "required": false, "example": "" }, { "name": "show_last_name", "in": "query", "description": "Show user last name or no", "required": false, "example": "" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserResource" } } } }, "422": { "description": "Error: Unprocessable Content" }, "403": { "description": "Error: Forbidden" } }, "security": [ { "sanctum": [] } ] } }, "/ai-predictions": { "post": { "tags": [ "AiPrediction" ], "summary": "Save aiPrediction", "operationId": "75a6ff59fec2f6b10143db2040344074", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "properties": { "vehicle_info": { "properties": { "vehicle_id": { "type": "integer" }, "year": { "type": "integer" }, "make": { "type": "string" }, "model": { "type": "string" }, "trim": { "type": "string" }, "mileage": { "type": "integer" }, "condition": { "type": "string" } }, "type": "object" }, "prediction_context": { "properties": { "prediction_date": { "type": "string", "format": "date" }, "price_tier_used": { "type": "string" }, "factoring_percentage": { "type": "number", "format": "float" }, "factoring_location": { "type": "string" }, "factoring_source_note": { "type": "string" }, "history_adjustment": { "type": "string" }, "history_adjustment_amount": { "type": "number", "nullable": true } }, "type": "object" }, "median_values": { "properties": { "wholesale": { "type": "number" }, "wholesale_stdev": { "type": "number" }, "retail": { "type": "number" }, "retail_stdev": { "type": "number" } }, "type": "object" }, "model_metrics": { "properties": { "selected_model_name": { "type": "string" }, "model_full_name": { "type": "string" }, "support_latest_date": { "type": "string", "format": "date-time" }, "test_rows": { "type": "integer" }, "test_date": { "type": "string", "format": "date-time" }, "MAE": { "type": "number" }, "MAPE": { "type": "number" }, "Within $200": { "type": "number" }, "Within $500": { "type": "number" }, "Within $1000": { "type": "number" }, "Avg Underprediction": { "type": "number" }, "Median Underprediction": { "type": "number" }, "Avg Overprediction": { "type": "number" }, "Median Overprediction": { "type": "number" }, "% Predictions Lower than Actual": { "type": "number" }, "% Predictions Higher than Actual": { "type": "number" }, "support_row_count": { "type": "integer" } }, "type": "object" }, "predictions": { "properties": { "error_note": { "type": "string", "nullable": true }, "original": { "type": "number" }, "rounded": { "type": "number" }, "factored": { "type": "number" }, "factored_rounded": { "type": "number" } }, "type": "object" }, "quantiles": { "properties": { "0.1": { "type": "number" }, "0.1_rounded": { "type": "number" }, "0.25": { "type": "number" }, "0.25_rounded": { "type": "number" }, "0.4": { "type": "number" }, "0.4_rounded": { "type": "number" }, "0.5": { "type": "number" }, "0.5_rounded": { "type": "number" }, "0.6": { "type": "number" }, "0.6_rounded": { "type": "number" }, "0.75": { "type": "number" }, "0.75_rounded": { "type": "number" }, "0.9": { "type": "number" }, "0.9_rounded": { "type": "number" } }, "type": "object" } }, "type": "object" }, "example": { "vehicle_info": { "vehicle_id": 432217, "year": 2016, "make": "Honda", "model": "Civic", "trim": "2016 Honda Civic Sedan 4D EX 2.0L I4 Auto", "mileage": 54000, "condition": "Clean" }, "prediction_context": { "prediction_date": "2025-05-21", "price_tier_used": "10k_to_45k", "factoring_percentage": 102.14, "factoring_location": "San Diego", "factoring_source_note": "Used Local Data (Recent=29 from top 30 original, Total Local=8611)", "history_adjustment": "no", "history_adjustment_amount": 1231 }, "median_values": { "wholesale": 14044, "wholesale_stdev": 10.84, "retail": 17483, "retail_stdev": 11.11 }, "model_metrics": { "selected_model_name": "Core", "model_full_name": "clean_core-quantile_model_2025-05-12", "support_latest_date": "2025-05-13 07:31:56", "test_rows": 1000, "test_date": "2025-05-13 07:31:56", "MAE": 681.7, "MAPE": 3.7469, "Within $200": 28.3, "Within $500": 54.2, "Within $1000": 77.2, "Avg Underprediction": 718.28, "Median Underprediction": 505.4, "Avg Overprediction": 643.47, "Median Overprediction": 374.11, "% Predictions Lower than Actual": 51.1, "% Predictions Higher than Actual": 48.9, "support_row_count": 107398 }, "predictions": { "error_note": null, "original": 15083, "rounded": 15150, "factored": 15407, "factored_rounded": 15450 }, "quantiles": { "0.1": 14893.3994140625, "0.1_rounded": 14850, "0.25": 15032.5087890625, "0.25_rounded": 15150, "0.4": 15012.875, "0.4_rounded": 15150, "0.5": 15083.5166015625, "0.5_rounded": 15150, "0.6": 15165.822265625, "0.6_rounded": 15150, "0.75": 15635.931640625, "0.75_rounded": 15650, "0.9": 15813.90625, "0.9_rounded": 15850 } } } }, "type": "object" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Error: Unprocessable Content" }, "403": { "description": "Error: Forbidden" } }, "security": [ { "sanctum": [] } ] } }, "/lead/get-assessment": { "get": { "tags": [ "Leads", "Assessments" ], "description": "Returns all form entries by vehicle id", "operationId": "d0ac83bcbc416e4c4e38ca9f52c621f6", "parameters": [ { "name": "vehicle_id", "in": "query", "description": "Vehicle ID", "required": true, "example": "1" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Error: Unprocessable Content" }, "403": { "description": "Error: Forbidden" } }, "security": [ { "sanctum": [] } ] } }, "/lead/create": { "post": { "tags": [ "Leads" ], "summary": "Create lead form new lead", "description": "API for create new lead", "operationId": "b9100ca7261f14a6a0e195ffdf45379f", "parameters": [ { "name": "utm_medium", "in": "query", "description": "utm_medium", "required": false, "example": "" }, { "name": "utm_source", "in": "query", "description": "utm_source", "required": false, "example": "" }, { "name": "utm_campaign", "in": "query", "description": "utm_campaign", "required": false, "example": "" }, { "name": "utm_term", "in": "query", "description": "utm_term", "required": false, "example": "" }, { "name": "initial_offer_sms", "in": "query", "description": "Send initial offer sms. (true/false)", "required": false, "example": "" }, { "name": "increase_offer_sms", "in": "query", "description": "Send increase offer sms. (true/false)", "required": false, "example": "" }, { "name": "initial_sms", "in": "query", "description": "Send initial sms. (true/false)", "required": false, "example": "" }, { "name": "follow_up", "in": "query", "description": "The default is yes as it is now. If no is selected then there will be no automated follow up sms messages and emails.(true/false)", "required": false, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateVehicleRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateVehicleRequest" } } } }, "422": { "description": "Error: Unprocessable Content" }, "403": { "description": "Error: Forbidden" } }, "security": [ { "sanctum": [] } ] } }, "/leads-search/": { "get": { "tags": [ "Leads" ], "description": "Search leads", "operationId": "959f09512aee9eb6d1a762e1e2f495d6", "parameters": [ { "name": "filter[date_from]", "in": "query", "description": "StartDate", "required": false, "example": "2023-07-01" }, { "name": "filter[date_to]", "in": "query", "description": "EndDate", "required": false, "example": "2023-10-30" }, { "name": "filter[location_id]", "in": "query", "description": "Location ID", "required": false, "example": "1" }, { "name": "filter[status]", "in": "query", "description": "Status ", "required": false, "example": "quoted" }, { "name": "filter[search]", "in": "query", "description": "Search by seller name or email or phone or make or model or VIN or ID", "required": true, "example": "audi" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Error: Unprocessable Content" }, "403": { "description": "Error: Forbidden" } }, "security": [ { "sanctum": [] } ] } }, "/leads-stat": { "get": { "tags": [ "Leads" ], "description": "Returns statistic by location id", "operationId": "8603d1679ac2903f44ffde79274fdb50", "parameters": [ { "name": "start_date", "in": "query", "description": "StartDate", "required": true, "example": "2023-07-01" }, { "name": "end_date", "in": "query", "description": "EndDate", "required": true, "example": "2023-07-26" }, { "name": "location_id", "in": "query", "description": "Location ID", "required": true, "example": "1" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Error: Unprocessable Content" }, "403": { "description": "Error: Forbidden" } }, "security": [ { "sanctum": [] } ] } }, "/leads": { "get": { "tags": [ "Leads" ], "summary": "Get list of leads", "description": "Returns list of leads.\n\t\t\tMax period range=3 months, if no period is specified than the API will return only leads for the last 3 month starting from current day.\n\t\t\tSo if we want to retrieve data for 1 year, we will make 4 calls for 3 month each", "operationId": "c56f92ec72a9dc932882b7fe0fadf970", "parameters": [ { "name": "start_date", "in": "query", "description": "StartDate", "required": false, "example": "2023-07-01" }, { "name": "end_date", "in": "query", "description": "EndDate", "required": false, "example": "2023-07-26" }, { "name": "location_status", "in": "query", "description": "Location status mast be published or hidden. If not set, all statuses will be returned", "required": false, "example": "" }, { "name": "location_id", "in": "query", "description": "Location ID. Example: 1,2,3", "required": false, "example": "" }, { "name": "page", "in": "query", "description": "Number of page", "required": false, "example": "1" }, { "name": "per_page", "in": "query", "description": "Count results per page. Default: 100", "required": false, "example": "100" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Error: Unprocessable Content" }, "403": { "description": "Error: Forbidden" } }, "security": [ { "sanctum": [] } ] } }, "/lead-info": { "get": { "tags": [ "Leads" ], "summary": "Retrieve all lead info", "description": "Retrieve all lead info", "operationId": "bef74c36fe2968aaebcc61e2fec7b2d9", "parameters": [ { "name": "vehicle_id", "in": "query", "description": "Vehicle ID", "required": true, "example": "" }, { "name": "tasks", "in": "query", "description": "Tasks", "required": false, "schema": { "type": "boolean" } }, { "name": "customer_info", "in": "query", "description": "Customer info", "required": false, "schema": { "type": "boolean" } }, { "name": "quote_history", "in": "query", "description": "Quote History", "required": false, "schema": { "type": "boolean" } }, { "name": "log", "in": "query", "description": "Logs", "required": false, "schema": { "type": "boolean" } }, { "name": "valuation", "in": "query", "description": "Valuation", "required": false, "schema": { "type": "boolean" } }, { "name": "vehicle_info", "in": "query", "description": "Vehicle info", "required": false, "schema": { "type": "boolean" } }, { "name": "appointments", "in": "query", "description": "Appointments info", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LeadInfoResource" } } } }, "422": { "description": "Error: Unprocessable Content" }, "403": { "description": "Error: Forbidden" } }, "security": [ { "sanctum": [] } ] } }, "/lead/mark-is-lost": { "get": { "tags": [ "Leads" ], "description": "Mark is Read", "operationId": "5ce2ffe59e64de5f2e74df776f8bda24", "parameters": [ { "name": "vehicle_id", "in": "query", "description": "Vehicle ID", "required": true, "example": "" }, { "name": "stop", "in": "query", "description": "Stop communication", "required": false, "example": "true" }, { "name": "note", "in": "query", "description": "Note", "required": false, "example": "test note" } ], "responses": { "422": { "description": "Error: Unprocessable Content" }, "403": { "description": "Error: Forbidden" } }, "security": [ { "sanctum": [] } ] } }, "/lead/unsubscribe": { "get": { "tags": [ "Leads" ], "description": "Unsubscribe Lead", "operationId": "bd6878546c4cd4cfbd733f1b53fafd4a", "parameters": [ { "name": "vehicle_id", "in": "query", "description": "Vehicle ID", "required": true, "example": "235754" } ], "responses": { "422": { "description": "Error: Unprocessable Content" }, "403": { "description": "Error: Forbidden" } }, "security": [ { "sanctum": [] } ] } }, "/lead/change-location": { "get": { "tags": [ "Leads" ], "description": "Change location", "operationId": "7ef9d3e0e43e2da2d02448ef054ed6b5", "parameters": [ { "name": "vehicle_id", "in": "query", "description": "Vehicle ID", "required": true, "example": "235754" }, { "name": "location_id", "in": "query", "description": "Location ID", "required": true, "example": "1" } ], "responses": { "422": { "description": "Error: Unprocessable Content" }, "403": { "description": "Error: Forbidden" } }, "security": [ { "sanctum": [] } ] } }, "/lead/update-vin": { "get": { "tags": [ "Leads" ], "description": "Update or insert vehicle vin", "operationId": "817274a87e2013c97c1aff2d55127282", "parameters": [ { "name": "vehicle_id", "in": "query", "description": "Vehicle ID", "required": true, "example": "9474" }, { "name": "vin", "in": "query", "description": "Vin", "required": true, "example": "JH4CU2F81CC025713" } ], "responses": { "422": { "description": "Error: Unprocessable Content" }, "403": { "description": "Error: Forbidden" } }, "security": [ { "sanctum": [] } ] } }, "/lead/mark-as-purchased": { "get": { "tags": [ "Leads" ], "description": "Mark as purchased", "operationId": "4845aea749d23ed5074f7d7700361cbf", "parameters": [ { "name": "vehicle_id", "in": "query", "description": "Vehicle ID", "required": true, "example": "235754" }, { "name": "purchase_price", "in": "query", "description": "Purchase price", "required": false, "example": "15000" }, { "name": "date_of_sale", "in": "query", "description": "Date of sale", "required": false, "example": "2023-07-01" } ], "responses": { "422": { "description": "Error: Unprocessable Content" }, "403": { "description": "Error: Forbidden" } }, "security": [ { "sanctum": [] } ] } }, "/lead/refresh-valuations": { "get": { "tags": [ "Leads" ], "description": "Refresh valuations", "operationId": "2a2deca159945d01624c39b981f55edc", "parameters": [ { "name": "vehicle_id", "in": "query", "description": "Vehicle ID", "required": true, "example": "235754" } ], "responses": { "422": { "description": "Error: Unprocessable Content" }, "403": { "description": "Error: Forbidden" } }, "security": [ { "sanctum": [] } ] } }, "/lead/upload-image": { "post": { "tags": [ "Leads" ], "description": "Upload image", "operationId": "b1561df77ad9ad651e1d62b16ec947e0", "parameters": [ { "name": "vehicle_id", "in": "query", "description": "Vehicle ID", "required": true, "example": "235754" } ], "requestBody": { "description": "Upload image", "required": true, "content": { "multipart/form-data": { "schema": { "required": [ "file" ], "properties": { "file": { "description": "Upload image", "type": "string", "format": "base64" } }, "type": "object" } } } }, "responses": { "422": { "description": "Error: Unprocessable Content" }, "403": { "description": "Error: Forbidden" } }, "security": [ { "sanctum": [] } ] } }, "/lead/upload-offer": { "post": { "tags": [ "Leads" ], "description": "Upload offer. Upload offer from file or offer url", "operationId": "350f27a3570f1109e49e32e0f3827bc8", "parameters": [ { "name": "vehicle_id", "in": "query", "description": "Vehicle ID", "required": true, "example": "235754" }, { "name": "offer_url", "in": "query", "description": "Offer URL", "required": false, "example": "" } ], "requestBody": { "description": "Upload offer", "required": true, "content": { "multipart/form-data": { "schema": { "properties": { "offer": { "description": "Upload Offer", "type": "string", "format": "base64" } }, "type": "object" } } } }, "responses": { "422": { "description": "Error: Unprocessable Content" }, "403": { "description": "Error: Forbidden" } }, "security": [ { "sanctum": [] } ] } }, "/lead/unable-to-quote": { "get": { "tags": [ "Leads" ], "description": "Unable to quote.", "operationId": "3e260f4e62d0e76cdf64414ba9e55fe3", "parameters": [ { "name": "vehicle_id", "in": "query", "description": "Vehicle ID", "required": true, "example": "235755" }, { "name": "reasons_ids", "in": "query", "description": "Reasons IDs", "required": false, "example": "19,22,18,12,13" } ], "responses": { "422": { "description": "Error: Unprocessable Content" }, "403": { "description": "Error: Forbidden" } }, "security": [ { "sanctum": [] } ] } }, "/quote/create": { "post": { "tags": [ "Quote" ], "description": "Send a quote for vehicle", "operationId": "6f9a2e38428b237a85a3f16a106afd8f", "parameters": [ { "name": "vehicle_id", "in": "query", "description": "Vehicle ID", "required": true, "example": "" }, { "name": "price", "in": "query", "description": "Price", "required": true, "example": "" }, { "name": "quote_type", "in": "query", "description": "Quote Type. standard or dynamic", "required": true, "example": "" }, { "name": "expire_days", "in": "query", "description": "Expire Days", "required": false, "example": "" }, { "name": "dynamic_offer_days", "in": "query", "description": "Dynamic Offer Days", "required": false, "example": "" }, { "name": "dynamic_offer_value", "in": "query", "description": "Dynamic Offer Value", "required": false, "example": "" }, { "name": "follow_up", "in": "query", "description": "The default is yes as it is now. If no is selected then there will be no automated follow up sms messages and emails.(true/false)", "required": false, "example": "" }, { "name": "initial_offer_sms", "in": "query", "description": "Send initial offer sms. (true/false)", "required": false, "example": "" }, { "name": "increase_offer_sms", "in": "query", "description": "Send increase offer sms. (true/false)", "required": false, "example": "" } ], "responses": { "422": { "description": "Error: Unprocessable Content" }, "403": { "description": "Error: Forbidden" } }, "security": [ { "sanctum": [] } ] } }, "/quote/increase-offer": { "post": { "tags": [ "Quote" ], "description": "Increase/decrease quote", "operationId": "19736b23603d6378550726a62172b5fb", "parameters": [ { "name": "vehicle_id", "in": "query", "description": "Vehicle ID", "required": true, "example": "" }, { "name": "price", "in": "query", "description": "Price", "required": true, "example": "" }, { "name": "expire_days", "in": "query", "description": "Expire Days", "required": true, "example": "" }, { "name": "follow_up", "in": "query", "description": "Appraiser ID", "required": false, "example": "" }, { "name": "increase_offer_sms", "in": "query", "description": "Appraiser ID", "required": false, "example": "" } ], "responses": { "422": { "description": "Error: Unprocessable Content" }, "403": { "description": "Error: Forbidden" } }, "security": [ { "sanctum": [] } ] } }, "/dealer/lead/create": { "post": { "tags": [ "Dealer Leads" ], "summary": "Create lead form dealer server", "description": "API for create lead", "operationId": "ed2ecee8f1c476a1b712134a57fcd469", "parameters": [ { "name": "utm_medium", "in": "query", "description": "utm_medium", "required": false, "example": "" }, { "name": "utm_source", "in": "query", "description": "utm_source", "required": false, "example": "" }, { "name": "utm_campaign", "in": "query", "description": "utm_campaign", "required": false, "example": "" }, { "name": "utm_term", "in": "query", "description": "utm_term", "required": false, "example": "" }, { "name": "initial_offer_sms", "in": "query", "description": "Send initial offer sms. (true/false)", "required": false, "example": "" }, { "name": "increase_offer_sms", "in": "query", "description": "Send increase offer sms. (true/false)", "required": false, "example": "" }, { "name": "initial_sms", "in": "query", "description": "Send initial sms. (true/false)", "required": false, "example": "" }, { "name": "follow_up", "in": "query", "description": "The default is yes as it is now. If no is selected then there will be no automated follow up sms messages and emails.(true/false)", "required": false, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateVehicleRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateVehicleRequest" } } } }, "422": { "description": "Error: Unprocessable Content" }, "403": { "description": "Error: Forbidden" } }, "security": [ { "sanctum": [] } ], "servers": [ { "url": "/api/v1/", "description": "For AI API server" } ] } } }, "components": { "schemas": { "CreateAppointmentRequest": { "description": "CreateAppointmentRequest", "properties": { "office_id": { "description": "Office ID", "type": "integer", "example": "2" }, "date": { "description": "Date", "type": "string", "example": "2024-03-28" }, "begin_time": { "description": "Begin Time", "example": "09:00" } }, "type": "object" }, "DeleteAppointmentByID": { "description": "DeleteAppointmentByID", "properties": { "appointment_id": { "description": "Appointment ID", "type": "integer", "example": "" } }, "type": "object" }, "GetAppointmentByTermRequest": { "description": "GetAppointmentByTermRequest", "properties": { "appointment_id": { "description": "Appointment ID", "type": "integer", "example": "" } }, "type": "object" }, "GetAppointmentRequest": { "description": "GetAppointmentRequest", "properties": { "vehicle_id": { "description": "Vehicle ID", "type": "integer", "example": "" } }, "type": "object" }, "UpdateAppointmentsRequest": { "description": "UpdateAppointmentsRequest", "properties": { "office_id": { "description": "Office ID", "type": "integer", "example": "2" }, "date": { "description": "Date", "type": "string", "example": "2022-08-15" }, "begin_time": { "description": "Begin Time", "example": "480" } }, "type": "object" }, "AskQuestionRequest": { "description": "AskQuestionRequest", "properties": { "questions": { "description": "Questions template IDs", "type": "array", "items": { "type": "string" }, "example": "[1,2]" }, "new_questions": { "description": "Create new question", "type": "array", "items": { "properties": { "question": { "description": "Question", "type": "string" }, "answer": { "description": "Answer", "type": "string" }, "why_ask_that": { "description": "Why ask that", "type": "string" }, "answer_type": { "description": "answer_type", "type": "string" }, "options_answer": { "type": "array", "items": { "properties": { "answer_options": { "description": "Answer options", "type": "string" }, "id": { "description": "Answer options ID", "type": "integer" } }, "type": "object" }, "minItems": 2 } }, "type": "object" } } }, "type": "object" }, "CanselScheduledSMSRequest": { "description": "CanselScheduledSMSRequest", "properties": {} }, "NewContactMessageRequest": { "description": "NewContactMessageRequest", "properties": { "location_id": { "description": "Location ID", "type": "integer", "example": 1 }, "name": { "description": "Name", "type": "string", "example": "Test" }, "email": { "description": "Email", "type": "string", "example": "example@domain.org" }, "phone": { "description": "Phone", "type": "string", "example": "+1234567890" }, "message": { "description": "Body message", "type": "string", "example": "test message" }, "contact_preference": { "description": "Contact preference: email or phone", "type": "string", "example": "phone" }, "subject": { "description": "Subject (optional)", "type": "string", "example": null, "nullable": true }, "is_incoming": { "description": "Is incoming", "type": "boolean", "example": true }, "type": { "description": "Message type", "type": "string", "example": "api" } }, "type": "object" }, "NewMessageRequest": { "description": "NewMessageRequest", "properties": { "body": { "description": "Body message", "example": "test message" } }, "type": "object" }, "NewNoteMessageRequest": { "description": "NewNoteMessageRequest", "properties": { "content": { "description": "Content", "example": "Test note" }, "type": { "description": "Type", "example": "general" } }, "type": "object" }, "RetrieveScheduledSMSRequest": { "description": "RetrieveScheduledSMSRequest", "properties": {} }, "SendEmailRequest": { "description": "SendEmailRequest", "properties": { "from": { "description": "Note", "example": "" }, "to": { "description": "Note", "example": "" }, "subject": { "description": "Note", "example": "" }, "body": { "description": "Note", "example": "" } }, "type": "object" }, "BotNotificationRequest": { "description": "BotNotificationRequest", "properties": { "location_id": { "description": "Location ID", "type": "integer", "example": "" }, "message": { "description": "Notification text", "type": "string", "example": "" }, "urgency": { "description": "Urgency can urgent, medium, low", "example": "urgent" } }, "type": "object" }, "AdminNotificationRequest": { "description": "Request schema for sending notifications to admins", "required": [ "admin_ids", "message" ], "properties": { "admin_ids": { "type": "array", "items": { "type": "integer" }, "example": [] }, "location_id": { "type": "integer", "example": 1 }, "vehicle_id": { "type": "integer", "example": 1 }, "admin_level": { "type": "array", "items": { "type": "string" }, "example": [ "local-appraiser" ] }, "method": { "type": "boolean", "example": true }, "is_send_email": { "type": "boolean", "example": true }, "is_send_sms": { "type": "boolean", "example": true }, "is_send_app": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Custom notification message" } }, "type": "object" }, "VehicleAssessmentRequest": { "description": "Vehicle assessment request schema", "properties": { "vehicle_info": { "example": "2017 Toyota 86" }, "online_research_triggered": { "example": true }, "issues": { "type": "array", "items": { "properties": { "issue": { "example": "Supercharger" }, "matched_kb_entry": { "example": "Engine mod" }, "sentiment": { "example": "Negative" }, "seriousness": { "example": "Significant" }, "needs_addressing": { "example": "Yes" }, "adjustment": { "example": "-$2350" }, "reasoning": { "example": "Revert to stock" } }, "type": "object" } }, "total_adjustment": { "example": "-$3685" }, "pass_fail": { "example": "FAIL" }, "summary": { "example": "Several mods, -$3685 total" }, "history_analysis": { "properties": { "history": { "example": false }, "clean_history": { "example": false }, "history_auto_quote": { "example": true }, "history_summary": { "example": "Unavailable" }, "note": { "example": "No AutoCheck" } }, "type": "object" }, "final_assessment": { "properties": { "date": { "example": "2025-08-01" }, "final_auto_quote": { "example": false }, "decision_reason": { "example": "Condition issues" }, "final_adjustment": { "example": "-$3685" }, "vehicle_id": { "example": "12965" }, "recon_threshold": { "example": "$1500" }, "history_summary": { "example": "Unavailable" }, "condition_summary": { "example": "Supercharger, seats, wheels" } }, "type": "object" } }, "type": "object" }, "SetNotificationLeadRequest": { "description": "SetNotificationLeadRequest", "properties": { "follow_up": { "type": "boolean" }, "initial_sms": { "type": "boolean" }, "initial_offer_sms": { "type": "boolean" }, "increase_offer_sms": { "type": "boolean" } }, "type": "object" }, "CreateTaskRequest": { "description": "CreateTaskRequest", "properties": { "vehicle_id": { "description": "Vehicle ID", "example": "1" }, "date": { "description": "Date", "example": "2022-08-15" }, "types": { "description": "Task types", "type": "array", "items": {}, "example": "[1,2]" }, "roles": { "description": "User roles", "type": "array", "items": {}, "example": "[5, 6, 7]" }, "note": { "description": "Note", "example": "test note" }, "status": { "description": "Status", "example": "active" } }, "type": "object" }, "ShowTaskRequest": { "description": "ShowTaskRequest", "properties": { "task_id": { "description": "Task ID", "type": "integer", "example": "" } }, "type": "object" }, "UpdateTaskRequest": { "description": "CreateTaskRequest", "properties": { "date": { "description": "Date", "example": "2022-08-15" }, "types": { "description": "Task types", "type": "array", "items": {}, "example": "[1,2]" }, "roles": { "description": "User roles", "type": "array", "items": {}, "example": "[5, 6, 7]" }, "note": { "description": "Note", "example": "test note" }, "status": { "description": "Status", "example": "active" } }, "type": "object" }, "CreateLeadRequest": { "description": "CreateLeadRequest", "properties": { "form_step": { "example": "confirmation" }, "finished": { "description": "Finished", "example": "true" }, "email": { "example": "test@test.org" }, "form_type": { "description": "Sender form. Default: widget", "example": "widget" }, "location_id": { "description": "location_id", "example": "1" }, "office_id": { "description": "office_id", "example": "20" }, "name": { "description": "user name", "example": "test test" }, "phone": { "description": "user phone. (xxx) xxx-xx-xx", "example": "(xxx) xxx-xx-xx" }, "first_name": { "description": "first_name", "example": "test" }, "last_name": { "description": "last_name", "example": "test" }, "make": { "description": "make", "example": "Acura" }, "ext_make_id": { "description": "ext_make_id", "example": "Acura" }, "model": { "description": "model", "example": "TSX" }, "ext_model_id": { "description": "ext_model_id", "example": "TSX" }, "plate": { "description": "plate", "example": "" }, "vin": { "description": "vin", "example": "JH4CU2F81CC025713" }, "year": { "description": "year", "example": "2012" }, "style": { "description": "style", "example": "Sedan w/Special FWD" }, "body_type": { "description": "body_type", "example": "Sedan" }, "drivetrain": { "description": "drivetrain", "example": "Front Wheel Drive" }, "engine": { "description": "engine", "example": "2.4 liters, I4 cyl, Gasoline Fuel" }, "ext_style_id": { "description": "ext_style_id", "example": "w/Special" }, "trade_pending_id": { "description": "trade_pending_id", "example": "\"135258\"" }, "trim_title": { "description": "trim_title", "example": "\"w/Special" }, "mileage": { "description": "mileage", "example": "432322" }, "aftermarket": { "description": "aftermarket", "example": "false" }, "aftermarket_list": { "description": "aftermarket_list", "example": "" }, "condition_id": { "description": "condition_id", "example": "1" }, "states": { "description": "states", "type": "array", "items": { "type": "string" }, "example": "[1,2,3,4,5,7]" } }, "type": "object" }, "CreateVehicleRequest": { "description": "CreateVehicleRequest", "properties": { "email": { "description": "User Email. Required", "example": "test@test.org" }, "office_id": { "description": "Office id. Required", "example": "20" }, "location_id": { "description": "Location id. Required", "example": "1" }, "trade_pending_id": { "description": "TradePending id. Optional", "example": "1" }, "name": { "description": "User name. Required", "example": "test test" }, "phone": { "description": "User phone. (xxx) xxx-xxxx. Required ", "example": "(xxx) xxx-xxxx" }, "first_name": { "description": "first_name", "example": "test" }, "dealer_widget_id": { "description": "Dealer widget ID", "example": "" }, "last_name": { "description": "last_name", "example": "test" }, "make": { "description": "Make. Required", "example": "Acura" }, "model": { "description": "Model. Required", "example": "TSX" }, "plate": { "description": "plate", "example": "" }, "form_type": { "description": "Form type", "example": "" }, "sell_type": { "description": "Sell Type: (SELL, TRADE, NOT_SURE)", "example": "SELL" }, "vin": { "description": "vin", "example": "JH4CU2F81CC025713" }, "year": { "description": "Year. Required", "example": "2012" }, "style": { "description": "Style. Required", "example": "Sedan w/Special FWD" }, "body_type": { "description": "body_type", "example": "Sedan" }, "drivetrain": { "description": "drivetrain", "example": "Front Wheel Drive" }, "engine": { "description": "engine", "example": "2.4 liters, I4 cyl, Gasoline Fuel" }, "trim_title": { "description": "trim_title", "example": "\"w/Special" }, "mileage": { "description": "Mileage. Required", "example": "432322" }, "aftermarket": { "description": "aftermarket", "example": "false" }, "aftermarket_list": { "description": "aftermarket_list", "example": "" }, "condition_id": { "description": "condition_id", "example": "1" }, "states": { "description": "states", "type": "array", "items": { "type": "string" }, "example": "[8,9,10,\n\t\t\t\t{\"id\": 29,\"comment\": \"Transmission broken\"},\n \t\t\t\t{\"id\": 34,\"comment\": \"off\"},\n \t\t\t{\"id\": 30,\"comment\": \"test\"},\n \t\t\t{\"id\": 39,\"comment\": \"test note\"},\n \t\t\t{\"id\": 38,\"comment\": \"test note about missing parts\"},\n \t\t\t\t{\"id\": 41,\"comment\": \"Crashed\"}]" }, "image_urls": { "description": "image_urls", "type": "array", "items": { "type": "string" }, "example": "[\"valid image url\",\"valid image url\"]" } }, "type": "object" }, "AppointmentInfoResource": { "description": "AppointmentInfoResource", "properties": { "data": { "properties": { "today": { "properties": { "date": { "type": "string", "format": "date" }, "time": { "type": "string" } }, "type": "object" }, "appointment": { "type": "object" }, "offices": { "properties": { "office_id": { "type": "integer" }, "office_name": { "type": "string" }, "office_address": { "type": "string" }, "days": { "properties": { "day": { "type": "string", "format": "date" }, "slot_duration": { "type": "string" }, "slots": { "properties": {}, "type": "object" } }, "type": "object" } }, "type": "object" }, "pick_up_available": { "type": "boolean" }, "available_offices": { "type": "object" } }, "type": "object" } }, "type": "object" }, "CreateAppointmentResource": { "description": "CreateAppointmentResource", "properties": { "message": {}, "data": { "properties": { "id": { "type": "integer" }, "status": { "type": "string" }, "date": { "type": "string" }, "begin_time": { "type": "integer" }, "end_time": { "type": "integer" }, "created_at": { "type": "string" }, "office_id": { "type": "integer" } }, "type": "object" } }, "type": "object" }, "ClientGeneralInfoResource": { "description": "ClientGeneralInfoResource", "properties": { "data": { "properties": { "email": { "description": "ClientLogHistoryResource is a JSON resource for `Client` model.", "type": "string" }, "name": { "type": "string" }, "phone_number": { "type": "string" } }, "type": "object" } }, "type": "object" }, "ClientLogHistoryResource": { "description": "ClientLogHistoryResource", "properties": { "data": { "properties": { "email": { "description": "ClientLogHistoryResource is a JSON resource for `Client` model.", "type": "string" }, "name": { "type": "string" }, "phone_number": { "type": "string" } }, "type": "object" } }, "type": "object" }, "LeadInfoResource": { "description": "LeadInfoResource", "properties": { "data": { "properties": {}, "type": "object" } }, "type": "object" }, "LeadsResource": { "description": "LeadsResource", "properties": { "data": { "properties": {}, "type": "object" } }, "type": "object" }, "LeadsStatisticResource": { "description": "LeadsStatisticResource", "properties": { "data": { "properties": { "location_id": { "type": "string" }, "location_name": { "type": "string" }, "billable": { "type": "integer" }, "total_leads": { "type": "integer" }, "dealership": { "type": "integer" } }, "type": "object" } }, "type": "object" }, "GroupLocationCollection": { "description": "LocationCollection", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/LocationResource" } } }, "type": "object" }, "GroupLocationResource": { "description": "LocationResource", "properties": { "id": { "description": "LocationResource is a JSON resource for `Location` model.", "type": "integer" }, "dealership_name": { "type": "string" }, "address": { "type": "string" }, "city": { "type": "string" } }, "type": "object" }, "LocationCollection": { "description": "LocationCollection", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/LocationResource" } } }, "type": "object" }, "LocationResource": { "description": "LocationResource", "properties": { "id": { "description": "LocationResource is a JSON resource for `Location` model.", "type": "integer" }, "dealership_name": { "type": "string" }, "address": { "type": "string" }, "city": { "type": "string" } }, "type": "object" }, "LocationWithUsersResource": { "description": "LocationResource", "properties": { "id": { "description": "LocationResource is a JSON resource for `Location` model.", "type": "integer" }, "dealership_name": { "type": "string" }, "address": { "type": "string" }, "city": { "type": "string" } }, "type": "object" }, "NearLocationResource": { "description": "NearLocationResource", "properties": { "id": { "description": "LocationResource is a JSON resource for `Location` model.", "type": "integer" }, "dealership_name": { "type": "string" }, "address": { "type": "string" }, "city": { "type": "string" } }, "type": "object" }, "ShortLocationResource": { "description": "LocationResource", "properties": { "id": { "description": "LocationResource is a JSON resource for `Location` model.", "type": "integer" }, "dealership_name": { "type": "string" }, "address": { "type": "string" }, "city": { "type": "string" } }, "type": "object" }, "ContactMessageResource": { "description": "ContactMessageResource", "properties": { "data": { "properties": { "name": { "description": "VehicleNoteResource is a JSON resource for `ReceivedSms` model.", "type": "string" }, "phone": { "type": "string" }, "message": { "type": "string" }, "contact_preference": { "type": "string" }, "location_id": { "type": "integer" }, "status": { "type": "string" }, "type": { "type": "string" }, "created_at": { "type": "string" }, "viewed_at": { "type": "string" } }, "type": "object" } }, "type": "object" }, "MessageResource": { "description": "MessageResource", "properties": { "data": { "properties": { "id": { "description": "VehicleNoteResource is a JSON resource for `ReceivedSms` model.", "type": "integer" }, "to": { "type": "string" }, "from": { "type": "string" }, "direction": { "type": "string" }, "is_read": { "type": "boolean" }, "date_sent": { "type": "string" } }, "type": "object" } }, "type": "object" }, "ScheduledMessageResource": { "description": "ScheduledMessageResource", "properties": { "data": { "properties": { "id": { "description": "VehicleNoteResource is a JSON resource for `ScheduledMessages` model.", "type": "integer" }, "body": { "type": "string" }, "date": { "type": "string" } }, "type": "object" } }, "type": "object" }, "SendStaticSmsResource": { "description": "SendStaticSmsResource", "properties": { "template_id": { "description": "Template id ", "example": "" }, "vehicle_id": { "description": "Vehicle id ", "example": "" } }, "type": "object" }, "AdminNotificationResponse": { "description": "Response schema for admin notifications", "properties": { "Message": { "type": "string", "example": "Custom notification message" }, "Status": { "type": "string", "example": "Sent successfully" }, "Sent to": { "type": "array", "items": { "type": "string" }, "example": [ "Admin name = TestName, sent via: sms, app" ] } }, "type": "object" }, "NotificationLeadResource": { "description": "NotificationLeadResource", "properties": { "data": { "properties": { "vehicle_id": { "type": "integer" }, "follow_up": { "type": "boolean" }, "initial_sms": { "type": "boolean" }, "initial_offer_sms": { "type": "boolean" }, "increase_offer_sms": { "type": "boolean" } }, "type": "object" } }, "type": "object" }, "SubscriptionLeadResource": { "description": "UnsubscribeLeadResource", "properties": { "data": { "properties": { "sms": { "type": "boolean" }, "email": { "type": "boolean" }, "customer_email": { "type": "string" }, "customer_name": { "type": "string" }, "customer_phone": { "type": "string" } }, "type": "object" } }, "type": "object" }, "PurchaseOfferResource": { "description": "PurchaseOfferResource", "properties": { "data": { "properties": { "id": { "description": "PurchaseOfferResource is a JSON resource for `PurchaseOffer` model.", "type": "integer" }, "is_current": { "type": "boolean" }, "is_dynamic": { "type": "boolean" }, "is_term": { "type": "boolean" }, "price": { "type": "string" }, "status": { "type": "string" }, "feedback": { "type": "string" }, "feedback_price": { "type": "string" }, "viewed_at": { "type": "string" }, "viewed": { "type": "boolean" }, "upload_notify": { "type": "boolean" }, "expire_at": { "type": "string" }, "created_at": { "type": "string" } }, "type": "object" } }, "type": "object" }, "PurchaseOffersCollection": { "description": "PurchaseOffersCollection", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PurchaseOfferResource" } } }, "type": "object" }, "ShortPurchaseOfferResource": { "description": "PurchaseOfferResource", "properties": { "data": { "properties": { "id": { "description": "PurchaseOfferResource is a JSON resource for `PurchaseOffer` model.", "type": "integer" }, "price": { "type": "string" }, "status": { "type": "string" }, "viewed_at": { "type": "string" }, "viewed": { "type": "boolean" }, "expire_at": { "type": "string" } }, "type": "object" } }, "type": "object" }, "ShortLocationOfficeResource": { "description": "ShortLocationOfficeResource", "properties": { "id": { "description": "ShortLocationOfficeResource is a JSON resource for `Location` model.", "type": "integer" }, "dealership_name": { "type": "string" }, "address": { "type": "string" }, "city": { "type": "string" } }, "type": "object" }, "ShowTaskResource": { "description": "TaskResource", "properties": { "id": { "description": "TaskResource is a JSON resource for `Tasks` model.", "type": "integer" }, "start_date": { "type": "string" }, "due_date": { "type": "string" }, "status": { "type": "string" }, "types": { "type": "array", "items": {} }, "first_note": { "type": "string" }, "roles": { "type": "array", "items": {} } }, "type": "object" }, "TaskCollection": { "description": "TaskCollection", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/TaskResource" } } }, "type": "object" }, "TaskResource": { "description": "TaskResource", "properties": { "id": { "description": "TaskResource is a JSON resource for `Tasks` model.", "type": "integer" }, "start_date": { "type": "string" }, "due_date": { "type": "string" }, "status": { "type": "string" }, "types": { "type": "array", "items": {} }, "first_note": { "type": "string" }, "roles": { "type": "array", "items": {} } }, "type": "object" }, "TaskTypesResource": { "description": "TaskTypesResource", "properties": { "id": { "description": "TaskResource is a JSON resource for `Tasks` model.", "type": "integer" }, "name": { "type": "string" } }, "type": "object" }, "TermResource": { "description": "TermResource", "properties": { "data": { "properties": { "leads": { "type": "integer" }, "appointments": { "type": "integer" }, "purchases": { "type": "integer" }, "purchases_with_no_appts": { "type": "integer" } }, "type": "object" } }, "type": "object" }, "UserResource": { "description": "UserRolesResource", "properties": { "data": { "properties": { "id": { "type": "integer" }, "role": { "type": "string" }, "name": { "type": "string" }, "status": { "type": "string" }, "locations": { "type": "array", "items": {} } }, "type": "object" } }, "type": "object" }, "UserRolesResource": { "description": "UserRolesResource", "properties": { "data": { "properties": { "id": { "type": "integer" }, "role": { "type": "string" }, "description": { "type": "string" } }, "type": "object" } }, "type": "object" }, "UserTaskRolesResource": { "description": "UserRolesResource", "properties": { "data": { "properties": { "id": { "type": "integer" }, "role": { "type": "string" } }, "type": "object" } }, "type": "object" } }, "responses": { "200": { "description": "OK", "headers": { "Accept": { "description": "Accept header", "required": true, "schema": { "type": "string", "enum": [ "application/json" ] } } } }, "404": { "description": "Not Found", "headers": { "Accept": { "description": "Accept header", "required": true, "schema": { "type": "string", "enum": [ "application/json" ] } } } }, "500": { "description": "Internal Server Error", "headers": { "Accept": { "description": "Accept header", "required": true, "schema": { "type": "string", "enum": [ "application/json" ] } } } } }, "securitySchemes": { "sanctum": { "type": "apiKey", "description": "Enter token in format (apiKey )", "name": "x-api-key", "in": "header" } } }, "tags": [ { "name": "Appointments", "description": "Appointments" }, { "name": "AutoData", "description": "AutoData" }, { "name": "Calls", "description": "Calls" }, { "name": "Clients", "description": "Clients" }, { "name": "Decoder", "description": "Decoder" }, { "name": "Locations", "description": "Locations" }, { "name": "Media", "description": "Media" }, { "name": "Contact Message", "description": "Contact Message" }, { "name": "SMS", "description": "SMS" }, { "name": "Vehicle Note Message", "description": "Vehicle Note Message" }, { "name": "Notification", "description": "Notification" }, { "name": "Offers", "description": "Offers" }, { "name": "QualitativeAssessment", "description": "QualitativeAssessment" }, { "name": "Sentiments", "description": "Sentiments" }, { "name": "Subscription", "description": "Subscription" }, { "name": "Short Link", "description": "Short Link" }, { "name": "Questions", "description": "Questions" }, { "name": "Mail", "description": "Mail" }, { "name": "Tasks", "description": "Tasks" }, { "name": "Terms", "description": "Terms" }, { "name": "User", "description": "User" }, { "name": "AiPrediction", "description": "AiPrediction" }, { "name": "Leads", "description": "Leads" }, { "name": "Assessments", "description": "Assessments" }, { "name": "Quote", "description": "Quote" }, { "name": "Dealer Leads", "description": "Dealer Leads" } ] }