DeepLogi

Quick intro

Authentication

Shipments

Add Shipment

Download sticker

Get Shipment

Track Shipment

Cancel Shipment

Quotations

Get Quotation

Create RFQ

Get RQ

Webhooks

Webhook

States

Get States

Deeplogi

DeepLogi Rest API

Production

Sandbox

<p class="slate-p " >Welcome to DeepLogi Rest API documentation.</p><p class="slate-p " ></p><p class="slate-p " >For simple and fast integration, you can use the “Add shipment” and “Track shipment” API endpoints only, Additionally, you can utilize the “Download sticker” endpoint for packages.</p><p class="slate-p " >For easier integration, we&apos;ve made many fields optional, with default values set in the DeepLogi control panel. but you can still set them using the API if needed.</p><p class="slate-p " >DeepLogi is a smart shipping gateway that automatically reroutes shipments for the best rate and delivery time with shipping companies. <strong class="slate-bold">For more information or technical assistance</strong>, please visit <a href="https://www.deeplogi.com/" target="_self">DeepLogi.com</a>.</p><p class="slate-p " >

</p><p class="slate-p " ></p><p class="slate-p " ></p>

Welcome to DeepLogi Rest API documentation.

For simple and fast integration, you can use the “Add shipment” and “Track shipment” API endpoints only, Additionally, you can utilize the “Download sticker” endpoint for packages.

For easier integration, we've made many fields optional, with default values set in the DeepLogi control panel. but you can still set them using the API if needed.

DeepLogi is a smart shipping gateway that automatically reroutes shipments for the best rate and delivery time with shipping companies. 

For more information or technical assistance

<p class="slate-p" placeholder="Type / for widgets">Authentication</p><p class="slate-p" placeholder="Type / for widgets">To integrate with our application, you need to authenticate your API requests using a Bearer token. Follow the steps below to obtain and use the Bearer token:</p><p class="slate-p" placeholder="Type / for widgets">
<strong class="slate-bold">Step 1</strong>: <strong class="slate-bold">Obtain the Bearer Token</strong></p><ul class="slate-ul"><li class="slate-li"><div style="position:relative">Dashboard Login:
Navigate to the Dashboard login <a href="https://app.deeplogi.com/register/login/" target="_blank">page </a>of our application.
Enter your admin credentials to log in.</div></li><li class="slate-li"><div style="position:relative">Generate Token:
After logging in, go to the <a href="https://app.deeplogi.com/integration/tokens/" target="_blank">Integration </a>section in the Admin dashboard.
Click on &quot;Create&quot; to create a new Bearer token.
Copy the generated token. Keep it secure as it will be used for authenticating API requests.</div></li></ul><p class="slate-p" placeholder="Type / for widgets"><strong class="slate-bold">Step 2</strong>: <strong class="slate-bold">Use the Bearer Token</strong></p><p class="slate-p" placeholder="Type / for widgets">To authenticate your API requests, include the Bearer token in the Authorization header of your HTTP requests. The format should be as follows:</p><p class="slate-p" placeholder="Type / for widgets">Authorization: Bearer YOUR_TOKEN_HERE</p><p class="slate-p" placeholder="Type / for widgets">Example Request</p><p class="slate-p" placeholder="Type / for widgets">Here’s an example of how to use the Bearer token in an API request using curl:</p><p class="slate-p" placeholder="Type / for widgets">curl -X GET <a href="https://api.deeplogi.com/api/v1/" target="_blank">https://api.deeplogi.com/api/v1/</a>endpoint 
       -H &quot;Authorization: Bearer YOUR_TOKEN_HERE&quot;</p><p class="slate-p" placeholder="Type / for widgets">By following these steps, you can securely integrate your application with our API using the Bearer token for authentication.</p>

To integrate with our application, you need to authenticate your API requests using a Bearer token. Follow the steps below to obtain and use the Bearer token:

To authenticate your API requests, include the Bearer token in the Authorization header of your HTTP requests. The format should be as follows:

Here’s an example of how to use the Bearer token in an API request using curl:

endpoint 
       -H "Authorization: Bearer YOUR_TOKEN_HERE"

By following these steps, you can securely integrate your application with our API using the Bearer token for authentication.

<p class="slate-p " >For simple and fast integration, you can use the “Add shipment” and “Track shipment” API endpoints only, Additionally, you can utilize the “Download sticker” endpoint for packages.</p><p class="slate-p " ></p><div style="text-align:left"><img src="https://i.ibb.co/XL3pQWv/Shipment-lifecycle.png" style="
              width:467px;
	            height:150px;
	            aspect-ratio:467 / 150"
         /></div><p class="slate-p " ></p><p class="slate-p " ></p>

<p class="slate-p " >This API endpoint allows you to retrieve a quotation request that was created earlier. by providing its quotation ID.</p><p class="slate-p " ><strong class="slate-bold">Request</strong> :
</p><div class="published-table"><div class="table-container" style="padding-left: 0px;"><table class="slate-table" style="min-width:100%;"><div class="published-table-header" style="width:100%;min-width:100%;min-height:initial;visibility: hidden;border:initial"><div style="width:200px;">Title</div><div style="width:119px;">Description</div><div style="width:173px;">Title</div><div style="width:229px;">Description</div><div style="width:400px;">Title</div></div><colgroup ><col style="width:200px"><col style="width:119px"><col style="width:173px"><col style="width:229px"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">Parameters</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">Type</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">Required</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">Description</strong></p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >quotationId</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >integer</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Mandatory</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >quotationId is provided in the “Get RQ” request.</p></td></div></tr></tbody></table></div></div><p class="slate-p " ></p><p class="slate-p " ><strong class="slate-bold">Response :</strong></p><div class="published-table"><div class="table-container" style="padding-left: 0px;"><table class="slate-table" style="min-width:100%;"><div class="published-table-header" style="width:100%;min-width:100%;min-height:initial;visibility: hidden;border:initial"><div style="width:0px;">Title</div><div style="width:290px;">Description</div><div style="width:0px;">Title</div></div><colgroup ><col style="width:initial"><col style="width:290px"><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">Parameters</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">Type</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">Description</strong></p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >id</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Integer</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >This ID u will send in the request add shipment</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >shipmentId</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Integer</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >This will fill after assigning the quotation to the shipment</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >price</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Number</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ></p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >serviceType</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >string</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >nullable</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >createdAt</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >string</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >date of creation</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >expiersAt</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >string</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >date formated `Y-m-d H:i:s` ex :(2024-12-08 05:00:00)</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >company</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Object</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ></p></td></div></tr></tbody></table></div></div><p class="slate-p " ><strong class="slate-bold">Company</strong>:</p><div class="published-table"><div class="table-container" style="padding-left: 0px;"><table class="slate-table" style="min-width:100%;"><div class="published-table-header" style="width:100%;min-width:100%;min-height:initial;visibility: hidden;border:initial"><div style="width:100px;">Title</div><div style="width:100px;">Description</div><div style="width:100px;">Title</div></div><colgroup ><col style="width:initial"><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">Parameters</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">Type</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">Description</strong></p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >id</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Integer</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ></p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >name</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >String</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ></p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >iconUrl</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >String</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ></p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >type</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >enum</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >possable value : [ondemand , domestic]
<span style="background-color:rgb(22, 23, 29);color:rgb(248, 248, 240)">`ondemand`  On-demand companies with same-day delivery (companies_durations.day = 0)
`domestic` : Regular shipping companies with standard delivery times</span></p></td></div></tr></tbody></table></div></div><p class="slate-p " ></p><p class="slate-p " ><span style="background-color:rgb(22, 23, 29);color:rgb(248, 248, 240)"><strong class="slate-bold">Error Responses:
</strong></span><span style="background-color:rgb(22, 23, 29);color:rgb(248, 248, 240)">- `401` - </span>This request need valid token</p><p class="slate-p " ><span style="background-color:rgb(22, 23, 29);color:rgb(248, 248, 240)">- `404` - No quotation found with this id or expired

</span><strong class="slate-bold">Notes</strong><span style="background-color:rgb(22, 23, 29);color:rgb(248, 248, 240)">- `expiresAt` field only appears for ondemand companies- All existing fields remain unchanged for backward compatibility- Both endpoints require user authentication</span></p><p class="slate-p " ></p>

This API endpoint allows you to retrieve a quotation request that was created earlier. by providing its quotation ID.

Title

Description

- `404` - No quotation found with this id or expired



- `expiresAt` field only appears for ondemand companies- All existing fields remain unchanged for backward compatibility- Both endpoints require user authentication

The Authorization header parameter is used to authenticate the request and authorize access to the /shipment endpoint. It typically contains a token or credentials that validate the user's identity and permissions. The Authorization parameter ensures that only authorized users can access and manipulate shipment data.

Authorization

quotationId

shipmentId

duration

price

createdAt

expiresAt

serviceType

company

The code parameter is returned as part of the response after adding a new shipment. It indicates the status of the shipment operation and can be used to identify any errors or issues encountered. Common codes include success codes for successful operations and error codes for failed operations.

code

The message parameter is used to provide a response message after adding a new shipment. It may contain information such as the status of the shipment or any additional instructions.

message

No quotation request in this id or expired

<p class="slate-p " >This API endpoint allows you to create a new quotation request.</p><p class="slate-p " ><strong class="slate-bold">Request</strong> :
</p><div class="table-container" style="width:100%;min-width:100%"><table class="slate-table" style="min-width:initial;"><div class="published-table-header" style="width:100%;min-width:100%;min-height:initial;visibility: hidden;border:initial"><div style="width:200px;">Title</div><div style="width:119px;">Description</div><div style="width:173px;">Title</div><div style="width:725px;">Description</div><div style="width:400px;">Title</div></div><colgroup ><col style="width:200px"><col style="width:119px"><col style="width:173px"><col style="width:725px"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">Parameters</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">Type</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">Required</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">Description</strong></p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >recipients</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >List of object</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Mandatory</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Information of recipients</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >senderAddress</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Object</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Optional</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >If senderAddress exist we will ignore your warehouse and we will make it as sender address for the shipment.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >weight</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >integer</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Optional</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Per KG ,The default value it is in your company settings in DeepLogi control panel.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >warehouseId</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >integer</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Optional</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Default warehouse will be used, or you can set warehouse id, you can get it from DeepLogi control panel.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >type</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >string</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Optional</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">Allowed Values:
- DOMESTIC (default behaviour if not provided)
- ONDEMAND Generate quotations only from on-demand logistics providers (e.g., Grab)
- ALL Generate quotations from all supported providers (both types)</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">scheduledAt</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >string</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Optional</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">Request a scheduled pickup time instead of an instant one.
Format: `YYYY-MM-DD HH:MM:SS` (24-hour format, Asia/Kuala_Lumpur timezone)
- Important Note:
The support and rules for `scheduledAt` depend on the logistics provider. Some providers (e.g., Grab) have the following strict requirements:
- The date must be within 4 days from the current time.
- The time must match one of the predefined delivery time slots:
``` 09:00 - 11:00, 10:00 - 12:00, 11:00 - 13:00, 12:00 - 14:00, 13:00 - 15:00, 14:00 - 16:00, 15:00 - 17:00        16:00 - 18:00, 17:00 - 19:00```
Other providers may allow more flexible scheduling without time slot restrictions or date limitations.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">duration</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >int</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Optional</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">duration days, 0 for instance and the default value set from the dashboard)</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><span style="background-color:rgb(22, 23, 29);color:rgb(248, 248, 240)">isCod</span></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >bool</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Optional</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >cash on delivery, default is false</p></td></div></tr></tbody></table></div><p class="slate-p " ></p><p class="slate-p " ><strong class="slate-bold">Recipient :</strong></p><div class="table-container" style="width:100%;min-width:100%"><table class="slate-table" style="min-width:initial;"><div class="published-table-header" style="width:100%;min-width:100%;min-height:initial;visibility: hidden;border:initial"><div style="width:208px;">Title</div><div style="width:208px;">Description</div><div style="width:225px;">Title</div><div style="width:353px;">Description</div><div style="width:400px;">Title</div></div><colgroup ><col style="width:208px"><col style="width:208px"><col style="width:225px"><col style="width:353px"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">Parameters</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">Type</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">Required</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">Description</strong></p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >address</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >String</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Conditional</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Full address including unit and floor number. (mandatory if no map location provided OR placeId)</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >latitude</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Number</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Conditional</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Map latitude number (mandatory if no postcode provided)</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >longitude</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Number</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Conditional</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Map longitude number (mandatory if no postcode provided)</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >city</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >String</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Optional</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Get the city name from request get states</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >postcode</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >String</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Conditional</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >(mandatory if no longitude and longitude provided).It should be 5 digits</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >placeId</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >String</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Conditional</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Mandatory if NO (postcode) OR (Latitude,longitude).
NOTE : When a placeId is submitted, we will disregard any other information regarding the address (city,postcode,latitude,longitude,address)

</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >unitNumber</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >String</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Optional</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >This with placeId only</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >isCod</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >boolean</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Optional</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Send it if a payment method is COD</p></td></div></tr></tbody></table></div><p class="slate-p " >
<strong class="slate-bold">SenderAddress :</strong></p><p class="slate-p " ></p><div class="table-container" style="width:100%;min-width:100%"><table class="slate-table" style="min-width:100%"><div class="published-table-header" style="width:100%;min-width:100%;min-height:initial;visibility: hidden;border:initial"><div style="width:100px;">Title</div><div style="width:100px;">Description</div><div style="width:100px;">Title</div><div style="width:100px;">Description</div></div><colgroup ><col style="width:initial"><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">Parameters</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">Type</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">Required</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">Description</strong></p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >address</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >String</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Mandatory</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Please ensure the address is complete, including unit and floor number, following this format:
 <strong class="slate-bold">“Unit 3A, Level 4, 123 Example Street, Downtown, Kuala Lumpur, 50450”</strong></p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >city</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >String</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Optional</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Get the city name from request get states</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >postcode</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >String</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Mandatory</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >It should be 5 digits</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >name</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >String</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Mandatory</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Name of address</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >mobile</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >String</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Mandatory</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Full mobile number with country calling code.</p></td></div></tr></tbody></table></div><p class="slate-p " ><strong class="slate-bold">Response :
</strong></p><div class="table-container" style="width:100%;min-width:100%"><table class="slate-table" style="min-width:100%"><div class="published-table-header" style="width:100%;min-width:100%;min-height:initial;visibility: hidden;border:initial"><div style="width:391px;">Title</div><div style="width:401px;">Description</div><div style="width:0px;">Title</div><div style="width:0px;">Description</div></div><colgroup ><col style="width:391px"><col style="width:401px"><col style="width:initial"><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">Parameters</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">Type</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">Required</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">Description</strong></p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >code</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Integer</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ></p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >quotationRequestId</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Integer</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ></p></td></div></tr></tbody></table></div><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p>

This API endpoint allows you to create a new quotation request.

recipients

warehouseId

weight

quotationRequestId is used to create a shipment based on a previously generated quotation. If provided, the system will validate and reuse the associated sender and recipient address data, saving time and ensuring consistency.
If not provided, the system will generate a new quotation automatically during shipment creation.

quotationRequestId

<p class="slate-p " >This API endpoint allows you to retrieve a quotation request that was created earlier by providing its quotation request ID.</p><p class="slate-p " ><strong class="slate-bold">Request</strong> :
</p><div class="published-table"><div class="table-container" style="padding-left: 0px;"><table class="slate-table" style="min-width:100%;"><div class="published-table-header" style="width:100%;min-width:100%;min-height:initial;visibility: hidden;border:initial"><div style="width:200px;">Title</div><div style="width:119px;">Description</div><div style="width:173px;">Title</div><div style="width:229px;">Description</div><div style="width:400px;">Title</div></div><colgroup ><col style="width:200px"><col style="width:119px"><col style="width:173px"><col style="width:229px"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">Parameters</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">Type</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">Required</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">Description</strong></p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >quotationId</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >integer</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Mandatory</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >quotationId is provided in the “RFQ” request.</p></td></div></tr></tbody></table></div></div><p class="slate-p " ></p><p class="slate-p " ><strong class="slate-bold">Response :</strong></p><div class="published-table"><div class="table-container" style="padding-left: 0px;"><table class="slate-table" style="min-width:100%;"><div class="published-table-header" style="width:100%;min-width:100%;min-height:initial;visibility: hidden;border:initial"><div style="width:208px;">Title</div><div style="width:208px;">Description</div><div style="width:225px;">Title</div><div style="width:353px;">Description</div><div style="width:400px;">Title</div></div><colgroup ><col style="width:208px"><col style="width:208px"><col style="width:225px"><col style="width:353px"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">Parameters</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">Type</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">Required</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">Description</strong></p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >id</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >integer</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ></p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >weight</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >integer</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ></p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >duration</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >integer</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ></p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >status</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >integer</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >if status 0 → the request quotation is still under get quotations
1 → is completed get all quotations</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >createdAt</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >String</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >is valid to 10 min from this date</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >quotations</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " > array of object quotation</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ></p></td></div></tr></tbody></table></div></div><p class="slate-p " ></p><p class="slate-p " ><strong class="slate-bold">Quotation :
</strong></p><div class="published-table"><div class="table-container" style="padding-left: 0px;"><table class="slate-table" style="min-width:100%;"><div class="published-table-header" style="width:100%;min-width:100%;min-height:initial;visibility: hidden;border:initial"><div style="width:0px;">Title</div><div style="width:291px;">Description</div><div style="width:0px;">Title</div></div><colgroup ><col style="width:initial"><col style="width:291px"><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">Parameters</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">Type</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">Description</strong></p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >id</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Integer</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >This id u will send in request add shipment</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >shipmentId</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Integer</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >This will fill after assign the quotation to shipment</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >price</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Number</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ></p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >createdAt</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >string</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ></p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >company</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Object</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ></p></td></div></tr></tbody></table></div></div><p class="slate-p " ><strong class="slate-bold">Company</strong>:</p><div class="published-table"><div class="table-container" style="padding-left: 0px;"><table class="slate-table" style="min-width:100%;"><div class="published-table-header" style="width:100%;min-width:100%;min-height:initial;visibility: hidden;border:initial"><div style="width:100px;">Title</div><div style="width:100px;">Description</div><div style="width:100px;">Title</div></div><colgroup ><col style="width:initial"><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">Parameters</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">Type</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">Description</strong></p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >id</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Integer</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ></p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >name</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >String</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ></p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >iconUrl</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >String</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ></p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >type</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >enum</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >possable value : [ondemand , domestic]</p></td></div></tr></tbody></table></div></div><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p>

This API endpoint allows you to retrieve a quotation request that was created earlier by providing its quotation request ID.

status

quotations

Sections