Quickshipper

QuickShipper Delivery API

Authorization

Endpoints

GET v1/order/fees

GET v1/order/custom-fields

POST v1/order

PUT v1/order

GET v1/order

POST v1/order/status

DELETE v1/order

Webhooks

POST v1/webhook

PUT v1/webhook

GET v1/webhook

Enums

OrderStatus

WebhookType

CustomFieldValueType

CustomFieldGroupType

CustomFieldType

Objects

CustomFieldModel

Delivery Button

Possible scenarios

Display section on a checkout page

 Delivery Api

Delivery API - English

Production

Sandbox

<p class="slate-p " ></p><p class="slate-p " >QuickShipper is a comprehensive platform designed to streamline order management for businesses operating across diverse sales channels. Whether you possess your own fleet of couriers or require efficient courier management and route planning, QuickShipper offers tailored solutions. Should you lack an existing courier network, QuickShipper seamlessly connects you with a range of reputable courier companies to fulfill your delivery needs.

</p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " >We&apos;re currently working on preparing the documentation, which will soon be enriched with comprehensive instructions to guide you through the process effectively.</p><p class="slate-p " >
</p><p class="slate-p " >

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

QuickShipper is a comprehensive platform designed to streamline order management for businesses operating across diverse sales channels. Whether you possess your own fleet of couriers or require efficient courier management and route planning, QuickShipper offers tailored solutions. Should you lack an existing courier network, QuickShipper seamlessly connects you with a range of reputable courier companies to fulfill your delivery needs.



We're currently working on preparing the documentation, which will soon be enriched with comprehensive instructions to guide you through the process effectively.

<p class="slate-p " >To utilize the Delivery API, start by registering within the QuickShipper system. Connect with our team to initiate the integration process tailored to your needs. </p><p class="slate-p " ></p><p class="slate-p " >To get an authorization token, you need to send a POST request to the address<span style="background-color:rgb(255, 255, 255);color:rgb(29, 28, 29)">: </span><a href="https://test-auth.quickshipper.ge/connect/token" target="_blank">{BASE_URL}/connect/token</a></p><p class="slate-p " >Base Url values are:</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:114px;">Title</div><div style="width:0px;">Description</div></div><colgroup ><col style="width:114px"><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 " >Test </p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><a href="https://test-auth.quickshipper.ge" target="_self">https://test-auth.quickshipper.ge</a></p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Production </p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><a href="https://auth.quickshipper.app" target="_self">https://auth.quickshipper.app</a></p></td></div></tr></tbody></table></div></div><p class="slate-p " >The data required for Basic authentication for the test environment is DeliveryApiClient:DeliveryApiSecret encoded in base64 scheme.
</p><div class="code-block-wrapper"  style="width:100%;min-width:100%" ><div class="code-block-header">Plain text</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-shell keep-markup drop-tokens"><div class="slate-code_line">curl --request POST \</div><div class="slate-code_line">  --url {BASE_URL}/connect/token \</div><div class="slate-code_line">  --header &apos;Authorization: Basic RGVsaXZlcnlBcGlDbGllbnQ6RGVsaXZlcnlBcGlTZWNyZXQ=&apos; \</div><div class="slate-code_line">  --header &apos;Content-Type: application/x-www-form-urlencoded&apos; \</div><div class="slate-code_line">  --data &apos;</div><div class="slate-code_line">{</div><div class="slate-code_line">  &quot;grant_type&quot;: &quot;password&quot;,</div><div class="slate-code_line">  &quot;scope&quot;: &quot;DeliveryApi&quot;,</div><div class="slate-code_line">  &quot;username&quot;: &quot;{YOUR_USERNAME}&quot;,</div><div class="slate-code_line">  &quot;password&quot;: &quot;{YOUR_PASSWORD}&quot;</div><div class="slate-code_line">}</div></code></pre></div><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

To utilize the Delivery API, start by registering within the QuickShipper system. Connect with our team to initiate the integration process tailored to your needs. 

To get an authorization token, you need to send a POST request to the address

Title

Description

The data required for Basic authentication for the test environment is DeliveryApiClient:DeliveryApiSecret encoded in base64 scheme.


httpStatusCode

userMessage

developerMessage

success

errors

Base Response

<div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p " >All ResponseModels have the following fields:</p><div class="slate-div"></div><div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=info ><div class="callout-icon"><svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M10.0628 14.1676C10.2434 14.1676 10.3927 14.1086 10.5107 13.9905C10.6288 13.8725 10.6878 13.7232 10.6878 13.5426V9.77177C10.6878 9.6051 10.6253 9.46274 10.5003 9.34469C10.3753 9.22663 10.2295 9.1676 10.0628 9.1676C9.88227 9.1676 9.73296 9.22663 9.61491 9.34469C9.49685 9.46274 9.43783 9.61205 9.43783 9.7926V13.5634C9.43783 13.7301 9.50033 13.8725 9.62533 13.9905C9.75033 14.1086 9.89616 14.1676 10.0628 14.1676ZM10.0003 7.62594C10.1948 7.62594 10.358 7.56344 10.4899 7.43844C10.6219 7.31344 10.6878 7.15371 10.6878 6.95927C10.6878 6.76482 10.6219 6.59816 10.4899 6.45927C10.358 6.32038 10.1948 6.25094 10.0003 6.25094C9.80588 6.25094 9.64269 6.32038 9.51074 6.45927C9.3788 6.59816 9.31283 6.76482 9.31283 6.95927C9.31283 7.15371 9.3788 7.31344 9.51074 7.43844C9.64269 7.56344 9.80588 7.62594 10.0003 7.62594ZM10.0003 18.3343C8.81977 18.3343 7.72255 18.1225 6.70866 17.6989C5.69477 17.2752 4.81283 16.6884 4.06283 15.9384C3.31283 15.1884 2.72602 14.3065 2.30241 13.2926C1.8788 12.2787 1.66699 11.1815 1.66699 10.0009C1.66699 8.83427 1.8788 7.74399 2.30241 6.7301C2.72602 5.71621 3.31283 4.83427 4.06283 4.08427C4.81283 3.33427 5.69477 2.74399 6.70866 2.31344C7.72255 1.88288 8.81977 1.6676 10.0003 1.6676C11.167 1.6676 12.2573 1.88288 13.2712 2.31344C14.285 2.74399 15.167 3.33427 15.917 4.08427C16.667 4.83427 17.2573 5.71621 17.6878 6.7301C18.1184 7.74399 18.3337 8.83427 18.3337 10.0009C18.3337 11.1815 18.1184 12.2787 17.6878 13.2926C17.2573 14.3065 16.667 15.1884 15.917 15.9384C15.167 16.6884 14.285 17.2752 13.2712 17.6989C12.2573 18.1225 11.167 18.3343 10.0003 18.3343ZM10.0003 17.0843C11.9448 17.0843 13.6114 16.3898 15.0003 15.0009C16.3892 13.612 17.0837 11.9454 17.0837 10.0009C17.0837 8.05649 16.3892 6.38982 15.0003 5.00094C13.6114 3.61205 11.9448 2.9176 10.0003 2.9176C8.05588 2.9176 6.38921 3.61205 5.00033 5.00094C3.61144 6.38982 2.91699 8.05649 2.91699 10.0009C2.91699 11.9454 3.61144 13.612 5.00033 15.0009C6.38921 16.3898 8.05588 17.0843 10.0003 17.0843Z" fill="#3960B4"></path></svg></div><div ><p class="slate-p " >When the operation succeeds, the response will have Success set to true. In the event of failure, Success will be set to false, accompanied by an appropriate error message.
</p></div></div><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

All ResponseModels have the following fields:

<p class="slate-p " >Webhooks provide timely updates on your orders. To enable this feature, register your addresses in the system. Webhooks are characterized by an active status, the maximum call attempt count, and a type that specifies the content of the received event.</p><p class="slate-p " ></p><p class="slate-p " ></p>

Webhooks provide timely updates on your orders. To enable this feature, register your addresses in the system. Webhooks are characterized by an active status, the maximum call attempt count, and a type that specifies the content of the received event.

<p class="slate-p " >Delivery Button is an easier way to integrate for stores that want to display their checkout page and let users choose their own delivery address and providers.</p><p class="slate-p " >To start testing, you first need to have an account on test.quickshipper.ge. You will be given a unique ApiKey that you will use for the integration API. The ApiKey can be found in the user profile in the Integration tab.</p><p class="slate-p " >For security reasons, it is recommended that you provide us with a list of IP addresses from which requests will be sent to the API. This could be, for example, the IP addresses of your servers or the developer&apos;s work/test computers.</p><p class="slate-p " ></p>

Delivery Button is an easier way to integrate for stores that want to display their checkout page and let users choose their own delivery address and providers.

To start testing, you first need to have an account on test.quickshipper.ge. You will be given a unique ApiKey that you will use for the integration API. The ApiKey can be found in the user profile in the Integration tab.

For security reasons, it is recommended that you provide us with a list of IP addresses from which requests will be sent to the API. This could be, for example, the IP addresses of your servers or the developer's work/test computers.

<p class="slate-p " >There are 2 possible scenarios:</p><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative">The store displays a QuickShipper button on the checkout page. When clicked, a modal/page with a map and address parameters appears. The user selects the desired provider and confirms. An order is created in QuickShipper with the status ReadyForPickup and the data is transferred to the delivery provider.  </div></li><li class="slate-li " ><div style="position:relative">The store displays a QuickShipper button on the checkout page. When clicked, a modal/page with a map and address parameters appears. The user selects the desired provider and confirms. An order is created in QuickShipper with the status Draft. The store charges the customer for the delivery amount and, if the payment is confirmed, calls the QuickShipper order/confirm service. The order status becomes ReadyForPickup and the data is transferred to the delivery provider.</div></li></ol><p class="slate-p " ></p>

<p class="slate-p " >To display the Delivery Button on your website, you need to perform the following steps (the example shows test data):</p><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative">On the checkout page where you want the user to enter the delivery address, you need to load the file <a href="https://express.quickshipper.ge/assets/quickshipper-express.min.js" target="_self">https://express.quickshipper.ge/assets/quickshipper-express.min.js</a>. To do this, add the following script to the Head tag:</div></li></ol><div class="code-block-wrapper"  style="width:60%" ><div class="code-block-header">JavaScript</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-javascript keep-markup drop-tokens"><div class="slate-code_line"><div class="slate-code_line">&lt;script src=&quot;https://express.quickshipper.ge/assets/quickshipper-express.min.js&quot;&gt;&lt;/script&gt;</div></div></code></pre></div><p class="slate-p " >2. Add the style file to the Head Tag:</p><div class="code-block-wrapper"  style="width:60%" ><div class="code-block-header">CSS</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-css keep-markup drop-tokens"><div class="slate-code_line"><div class="slate-code_line">&lt;link rel=&quot;stylesheet&quot; href=&quot;https://express.quickshipper.ge/assets/quickshipper-express.min.css&quot;&gt;</div></div></code></pre></div><p class="slate-p " >3. Add a button to the page. For example:</p><div class="code-block-wrapper"  style="width:60%" ><div class="code-block-header">HTTP</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-http keep-markup drop-tokens"><div class="slate-code_line"><div class="slate-code_line">&lt;div id=&quot;quickshipper-button-wrapper&quot;&gt;&lt;/div&gt;</div></div></code></pre></div><p class="slate-p " >4. Use the <strong class="slate-bold">Quickshipper.createButton</strong> function to initialize the button, passing it an id and information about the addresses. For example:</p><div class="code-block-wrapper"  style="width:60%" ><div class="code-block-header">JavaScript</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-javascript keep-markup drop-tokens"><div class="slate-code_line"><div class="slate-code_line">window.Quickshipper.createButton({
    buttonWrapperId: &quot;quickshipper-button-wrapper&quot;,
    data: {
        pickupInfo: {
            city: &quot;Tbilisi&quot;,
            address: &quot;38 Iakob Gogebashvili St, T&apos;bilisi, Georgia&quot;,
            latitude: &quot;41.703022188006344&quot;,
            longitude: &quot;44.78220031738281&quot;,
            name: &quot;Dashboard&quot;,
            phonePrefix: &quot;995&quot;,
            phone: &quot;089888888&quot;,
            addressComment: &quot;test express&quot;,
        },
        dropInfo: {
            city: &quot;Tbilisi&quot;,
            address: &quot;15 Irakli Abashidze Street, T&apos;bilisi, Georgia&quot;,
            latitude: &quot;41.7080523856428&quot;,
            longitude: &quot;44.77123544692993&quot;,
            name: &quot;EXpress&quot;,
            phonePrefix: &quot;995&quot;,
            phone: &quot;089888888&quot;,
            addressComment: &quot;test express&quot;,
        },
        apiKey: &quot;2dc471a6-fc86-4712-a5c4-84fad43c16ff&quot;
    }
});
window.Quickshipper.onOrderCreate = () =&gt; console.log(&quot;created&quot;);</div></div></code></pre></div><p class="slate-p " >The data in the dropoff object is not necessarily filled in and is used for prefill.</p><p class="slate-p " >After that, when you click on the button, a window with the Quickshipper interface should automatically appear. Please note that for full functionality, you need to specify your Google map key from your store settings.</p><p class="slate-p " ></p>

To display the Delivery Button on your website, you need to perform the following steps (the example shows test data):

3. Add a button to the page. For example:

 function to initialize the button, passing it an id and information about the addresses. For example:

The data in the dropoff object is not necessarily filled in and is used for prefill.

After that, when you click on the button, a window with the Quickshipper interface should automatically appear. Please note that for full functionality, you need to specify your Google map key from your store settings.

Sections