API Doc Version 1.3.3
What's New
POST
/dms/customer/insurance-information/add-document
Add insurance document
POST
/dms/customer/insurance-information/remove-document
Delete insurance document
POST
/dms/email/
Get customer record
GET
/dms/customer/document/
Get customer document upload history
POST
/dms/customer/additional-document
Creates customer document
POST
/dms/configure/order-status/
Get orders record filtered on order status
POST
/dms/configure/order/status/
Update order status history record by order refrence number
POST
/dms/consents/
Delete consents
GET
/dms/customer/insurance-information
Get customer insurance information by customer reference id and order reference number
POST
/dms/configure/appointments/
Delete created appointment
What's Deleted
POST
/dms/customer/search
Search Customers
GET
/dms/vehicle/status/{vin}
Get vehicle status
GET
/dms/email/{email}
Get customer record
GET
/dms/configure/order-status/
Get orders record filtered on order status
GET
/dms/configure/order/status/
Update order status history record by order refrence number
DELETE
/dms/consents/
Delete consents
DELETE
/dms/configure/appointments/
Delete created appointment
DELETE
/dms/configure/quotation/{order_id}
Delete configured record
What's Changed
GET
/dms/consents/
GET
/dms/referral-detail
PATCH
/dms/check-customer-by-email
Return Type:
Changed response : 200 OK
Successful Response
-
Changed content type :
application/json
-
Added property
id
(integer) -
Added property
consent
(object) -
Deleted property
customer_addresses
(array) -
Deleted property
income_info
(object) -
Deleted property
payments_info
(array) -
Deleted property
license_info
(object)
-
GET
/dms/customer/license-info-history
Return Type:
Changed response : 200 OK
Successful Response
-
Changed content type :
application/json
Changed items (object):
- Added property
is_pdf_417
(boolean)
- Added property
POST
/dms/customer/insurance-information
Request:
Changed content type : application/json
-
Added property
insurance_documents
(array)Items (object):
-
Property
document
(string) -
Property
document_ext
(string) -
Property
document_name
(string) -
Property
created_at
(string)
-
-
Deleted property
images
(array)
Return Type:
Changed response : 201 Created
Successful Response
-
Changed content type :
application/json
-
Added property
insurance_documents
(array) -
Deleted property
images
(array)
-
PATCH
/dms/customer/insurance-information
Request:
Changed content type : application/json
- Deleted property
images
(array)
Return Type:
Changed response : 200 OK
Successful Response
-
Changed content type :
application/json
-
Added property
insurance_documents
(array) -
Deleted property
images
(array)
-
GET
/dms/customer/insurance-information-history
Parameters:
Added: page_number
in query
Added: page_size
in query
Return Type:
Changed response : 200 OK
Successful Response
- Changed content type :
application/json
GET
/dms/customer/insurance-information-by-customer
Return Type:
Changed response : 200 OK
Successful Response
-
Changed content type :
application/json
-
Added property
insurance_documents
(array) -
Deleted property
images
(array)
-
GET
/dms/customer/insurance-information-by-order
Return Type:
Changed response : 200 OK
Successful Response
-
Changed content type :
application/json
-
Added property
insurance_documents
(array) -
Deleted property
images
(array)
-
GET
/dms/customer/status-flag-hitsory
Parameters:
Added: page_number
in query
Added: page_size
in query
Return Type:
Changed response : 200 OK
Successful Response
- Changed content type :
application/json
GET
/dms/order/expiry/{order_stage}
/{dealer_id}
POST
/dms/configure/order-fees
DELETE
/dms/configure/order-fees/{order_fee_id}
PATCH
/dms/configure/order-fees/{order_fee_id}
GET
/dms/configure/order-fees/{order_id}
POST
/dms/configure/order-options
DELETE
/dms/configure/order-options/{order_option_id}
PATCH
/dms/configure/order-options/{order_option_id}
Parameters:
Changed: order_option_id
in path
GET
/dms/configure/order-options/{order_id}
POST
/dms/configure/order-fni
DELETE
/dms/configure/order-fni/{order_fni_id}
PATCH
/dms/configure/order-fni/{order_fni_id}
GET
/dms/configure/order-fni/{order_id}
POST
/dms/configure/order/tradein
GET
/dms/configure/order/tradein/{order_id}
PATCH
/dms/configure/order/tradein/{order_id}
DELETE
/dms/configure/order/tradein/{tradein_id}
GET
/dms/configure/orders
GET
/dms/configure/order/filter
POST
/dms/configure/workqueue
Request:
Changed content type : application/json
New required properties:
dealer_id
expired_at
order_id
request_type
GET
/dms/configure/workqueue/search
PATCH
/dms/configure/workqueue/create_application/{workqueue_id}
POST
/dms/quote/calculation
POST
/dms/quote/calculation/quantity
POST
/dms/consents
GET
/dms/consents/{consents_id}
PATCH
/dms/consents/{consents_id}
POST
/dms/referral
GET
/dms/customer/document/review
Get customer document reviews
GET
/dms/configure/document-package/document
Get document from document package by identifier
Return Type:
New response : 404 Not Found
Record not found
Changed response : 200 OK
Successful
-
Changed content type :
application/json
-
Added property
generated_document_uri
(string) -
Deleted property
generated_document_url
(string)
-
POST
/dms/configure/{document_package_id}
/{document_id}
/{signature_id}
Sign document
Return Type:
New response : 404 Not Found
Record not found
Changed response : 422 Unprocessable Entity
Signature type must be initials or signature
- Deleted content type :
application/json
Changed response : 200 OK
Successful
-
Changed content type :
application/json
-
Added property
generated_document_uri
(string) -
Deleted property
generated_document_url
(string)
-
POST
/dms/customer/
Return Type:
Changed response : 201 Created
Successful Response
-
Changed content type :
application/json
-
Changed property
license_info
(object)- Added property
is_pdf_417
(boolean)
- Added property
-
GET
/dms/customer
Return Type:
Changed response : 200 OK
Successful Response
-
Changed content type :
application/json
-
Changed property
license_info
(object)- Added property
is_pdf_417
(boolean)
- Added property
-
PATCH
/dms/customer
Return Type:
Changed response : 200 OK
Successful Response
-
Changed content type :
application/json
-
Changed property
license_info
(object)- Added property
is_pdf_417
(boolean)
- Added property
-
GET
/dms/customer-by-email
Return Type:
Changed response : 200 OK
Successful Response
-
Changed content type :
application/json
-
Changed property
license_info
(object)- Added property
is_pdf_417
(boolean)
- Added property
-
PATCH
/dms/customer/license-info
Request:
Changed content type : application/json
- Added property
is_pdf_417
(boolean)
Return Type:
Changed response : 200 OK
Successful Response
-
Changed content type :
application/json
- Added property
is_pdf_417
(boolean)
- Added property
POST
/dms/customer/license-info
Request:
Changed content type : application/json
- Added property
is_pdf_417
(boolean)
Return Type:
Changed response : 201 Created
Successful Response
-
Changed content type :
application/json
- Added property
is_pdf_417
(boolean)
- Added property
GET
/dms/customer/third-party-response-history
Return Type:
Changed response : 200 OK
Successful Response
-
Changed content type :
application/json
Changed items (object):
-
Changed property
license_detail
(object)- Added property
is_pdf_417
(boolean)
- Added property
-
GET
/dms/configure/quotation
GET
/dms/configure/all-quotation
GET
/dms/configure/all-quotations
PATCH
/dms/configure/quotation/{order_id}
POST
/dms/configure/save-quotation
PATCH
/dms/configure/order/update-status/{order_id}
DELETE
/dms/configure/document-package
Cancel document package and document by identifier
Return Type:
Changed response : 200 OK
Successful
GET
/dms/configure/document-package
Get document package by identifier
Return Type:
New response : 404 Not Found
Record not found
Changed response : 200 OK
Successful
-
Changed content type :
application/json
-
Changed property
documents
(array)Changed items (object):
-
Added property
generated_document_uri
(string) -
Deleted property
generated_document_url
(string)
-
-
POST
/dms/configure/document-package
Create document package
Return Type:
New response : 201 Created
Successful
New response : 404 Not Found
Record not found
Changed response : 422 Unprocessable Entity
Signature type must be initials or signature
- Deleted content type :
application/json
Changed response : 200 OK
Successful
-
Changed content type :
application/json
-
Changed property
documents
(array)Changed items (object):
-
Added property
generated_document_uri
(string) -
Deleted property
generated_document_url
(string)
-
-
GET
/dms/configure/document-package-by-reference-id
Get document package by reference_id
Return Type:
New response : 404 Not Found
Record not found
Changed response : 200 OK
Successful
-
Changed content type :
application/json
-
Changed property
documents
(array)Changed items (object):
-
Added property
generated_document_uri
(string) -
Deleted property
generated_document_url
(string)
-
-
GET
/dms/customer/all-customers
Return Type:
Changed response : 200 OK
Successful Response
-
Changed content type :
application/json
-
Changed property
result
(array)Changed items (object):
-
Changed property
license_info
(object)- Added property
is_pdf_417
(boolean)
- Added property
-
-