storage it solutions

Bolesa app: A shipping platform for online stores, available on web portals, Android, and iOS applications. 
This API documentation provides endpoints for integrating with the Bolesa app.

تطبيق بوليصة: أسرع وأسهل طريقة لشحن منتجاتكم إلى عملائكم.
تتميز بوليصة بتقديم تجربة شحن لا مثيل لها لعملاء المتاجر الإلكترونية. نوفر لكم جميع الأدوات اللازمة لتتجاوز توقعات عملائك.


Bolesa-SA

Carriers, Pricing, Supported Cities

Get And Query Cities

To get the status list, you should send a shipping type parameter (odd or Regular)

Get Statuses List

To get the data list, you should send a shipping type parameter (odd or Regular)

In case of &lt;u>&lt;b>ODD&lt;/b>&lt;/u> you will get a response contains:

- Supported serviceable areas along with the polygon points for each area in order to draw it in your application
    
- Estimated pricing range
    

In case of &lt;u>&lt;b>REGULAR&lt;/b>&lt;/u> you will get a response contains:

- Available Countries
    
- Cities
    
- Carriers
    
- Payment types
    

_**Note: the odd means the quick shipping**_

Get Data Lists

pairable cities for pickup city

Get Carriers Cities And Pricing

To get available carriers, pricing and logo you will send the pickup city , consignee city and the payment type (cc or cod)

Get Available Carriers and Pricing For 2 Cities

Get Carrier City Villages/Branches

Get Location Details

Shipping AWBs & On Demand Orders

Generate Combined Labels PDF

List Of Orders

You can create **REGULAR** or **ODD** airwaybill from this endpointalso, you can update the details of regular pending shipment

Create Awb Via Custom Integration

AWB/Order Tracking Log

In case of any user error occurred, you can retry the creation of odd order

Retry Odd Order

To cancel odd shipment, you will should send the uuid of the shipment to this endpoint

Cancel Odd Order

To delete regular shipment, you will should send the order id to this endpoint

Delete Pending Awb

Deactivate Shipping Air Waybill (AWB)

Locations & Addresses

To get the saved addresses list saved in bolesa, you should send a shipping type parameter (odd or Regular)

User Addresses List

This endpoint allows you to create a new address in bolesa, you should send the shipping type of the address

Create Or Update Address

Set Default Shipper Address

This endpoint returns polygon points of all serviceable areas available in bolesa for odd shipping

Serviceable Areas

This end point allows you to send coordinates and get the supported serviceable area polygon points according to that coordinates you sent

Check Serviceable Area

This endpoint allows you to get the **ODD** shipping pricing and distanceTo calculate the distance and price you should send

- Shipper coordinates and consignee coordinates
    
- Payment type

Compute Distance

Auth

Get Access Token

Logout

Store Webhooks

Get Store Key

List Store Webhook Events

Register Webhook

List Store Webhook Subscriptions

Unsubscribe Webhook

Refresh Webhook Authorization

Toggle Webhook Activation

ShipLink Integration

Create AWB through ShipLink

Get Matched Carrier for Shipments

Get All Orders

Track Order Shipments

External Integration

AWB External Integration

Production

Sandbox

<p class="slate-p " >Bolesa app: A shipping platform for online stores, available on web portals, Android, and iOS applications.
This API documentation provides endpoints for integrating with the Bolesa app.</p><p class="slate-p " >تطبيق بوليصة: أسرع وأسهل طريقة لشحن منتجاتكم إلى عملائكم.
تتميز بوليصة بتقديم تجربة شحن لا مثيل لها لعملاء المتاجر الإلكترونية. نوفر لكم جميع الأدوات اللازمة لتتجاوز توقعات عملائك.</p><p class="slate-p " ></p>

Bolesa app: A shipping platform for online stores, available on web portals, Android, and iOS applications.
This API documentation provides endpoints for integrating with the Bolesa app.

تطبيق بوليصة: أسرع وأسهل طريقة لشحن منتجاتكم إلى عملائكم.
تتميز بوليصة بتقديم تجربة شحن لا مثيل لها لعملاء المتاجر الإلكترونية. نوفر لكم جميع الأدوات اللازمة لتتجاوز توقعات عملائك.

Tab 1

<p class="slate-p " ></p><p class="slate-p " ><span style="background-color:rgb(255, 255, 255);color:rgb(64, 64, 64)">This endpoint generates Air Waybill (AWB) for multi-vendor shipments through the ShipLink integration, allowing a single order to process multiple shipments from different vendors. </span></p><p class="slate-p " ></p><p class="slate-p " ></p><h2 class="slate-h2 " >Request Body Options</h2><p class="slate-p " ><span style="background-color:rgb(255, 255, 255);color:rgb(64, 64, 64)">This endpoint supports </span><span style="background-color:rgb(255, 255, 255);color:rgb(64, 64, 64)"><strong class="slate-bold">two ways</strong></span><span style="background-color:rgb(255, 255, 255);color:rgb(64, 64, 64)"> to generate Air Waybills (AWBs):</span></p><p class="slate-p " ></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Using a </strong><code class="slate-code">processing_id</code><strong class="slate-bold"> (for pre-submitted orders).</strong></div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Using a full order object (for new orders)</strong></div></li></ul><p class="slate-p " ></p>

This endpoint generates Air Waybill (AWB) for multi-vendor shipments through the ShipLink integration, allowing a single order to process multiple shipments from different vendors. 

<p class="slate-p " ></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Submit the complete order and shipment details directly.</div></li></ul><h4 class="slate-h4 " ></h4><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 " ><span style="color:#3B78D8"><strong class="slate-bold">Carrier Strategy</strong></span></p><p class="slate-p " ><span style="background-color:rgb(255, 255, 255);color:rgb(64, 64, 64)">The </span><span style="background-color:#EFEFEF;color:rgb(64, 64, 64)"><code class="slate-code">carrier_strategy</code></span><span style="background-color:rgb(255, 255, 255);color:rgb(64, 64, 64)">  field determines how shipping carriers are selected for each shipment. </span></p><p class="slate-p " ><span style="background-color:rgb(255, 255, 255);color:rgb(64, 64, 64)">This is specified in the </span><span style="background-color:#EFEFEF;color:rgb(64, 64, 64)"><code class="slate-code">order</code></span><span style="background-color:rgb(255, 255, 255);color:rgb(64, 64, 64)"> object.</span></p><p class="slate-p " ></p><p class="slate-p " ><strong class="slate-bold">lowest_price:  </strong><span style="background-color:rgb(255, 255, 255);color:rgb(64, 64, 64)">System automatically selects the most economical carrier.</span></p><p class="slate-p " ><span style="background-color:rgb(255, 255, 255);color:rgb(64, 64, 64)"><strong class="slate-bold">shared: </strong></span><span style="background-color:rgb(255, 255, 255);color:rgb(64, 64, 64)">The system intelligently selects one carrier that can service all shipments in the order at the best combined value</span></p><p class="slate-p " ><span style="background-color:rgb(255, 255, 255);color:rgb(64, 64, 64)"><strong class="slate-bold">specifid: </strong></span><span style="background-color:rgb(255, 255, 255);color:rgb(64, 64, 64)">Uses the exact carrier provided in the </span><span style="background-color:#EFEFEF;color:rgb(64, 64, 64)"><code class="slate-code">shipments.carrier</code></span><span style="background-color:rgb(255, 255, 255);color:rgb(64, 64, 64)"> field</span></p></div></div><p class="slate-p " ></p><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 " ><span style="color:#3B78D8"><strong class="slate-bold">Short Address Usage</strong></span></p><p class="slate-p " >The short address fields provide a concise representation of the shipment or consignee address and are used as a primary source for address extraction when available.</p><p class="slate-p " ></p><p class="slate-p " ></p><h3 class="slate-h3 " ><strong class="slate-bold">Behavior and Priority</strong></h3><h3 class="slate-h3 " ></h3><p class="slate-p " ><span style="color:#A4C2F4"><strong class="slate-bold">1. Priority Extraction</strong></span></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">If a short address is provided: </div></li><li class="slate-li " ><div style="position:relative">For shippers: <code class="slate-code">shipments.*.address.short_address</code></div></li><li class="slate-li " ><div style="position:relative">For consignee: <code class="slate-code">consignee.address.short_address</code></div></li><li class="slate-li " ><div style="position:relative">The system will attempt to extract the full address line and city from the short address. </div></li><li class="slate-li " ><div style="position:relative">Any successfully extracted data takes priority over the explicitly provided address fields. </div></li></ul><p class="slate-p " ></p><p class="slate-p " ><span style="color:#A4C2F4"><strong class="slate-bold">2. Override Mechanism</strong></span></p><p class="slate-p " >When extraction from the short address is successful, the system will override the following fields:</p><p class="slate-p " ><strong class="slate-bold">For each shipment (shipper):</strong></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><code class="slate-code">shipments.*.address.address_line</code> </div></li><li class="slate-li " ><div style="position:relative"><code class="slate-code">shipments.*.address.city</code> </div></li></ul><p class="slate-p " ><strong class="slate-bold">For the consignee:</strong></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><code class="slate-code">consignee.address.address_line</code> </div></li><li class="slate-li " ><div style="position:relative"><code class="slate-code">consignee.address.city</code> </div></li></ul><p class="slate-p " ></p><p class="slate-p " ><span style="color:#A4C2F4"><strong class="slate-bold">3. Fallback Behavior</strong></span></p><p class="slate-p " >If the system fails to extract address details from the short address, it will fallback to the explicitly provided fields:</p><p class="slate-p " ><strong class="slate-bold">For each shipment (shipper):</strong></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><code class="slate-code">shipments.*.address.address_line</code> </div></li><li class="slate-li " ><div style="position:relative"><code class="slate-code">shipments.*.address.city</code> </div></li></ul><p class="slate-p " ><strong class="slate-bold">For the consignee:</strong></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><code class="slate-code">consignee.address.address_line</code> </div></li><li class="slate-li " ><div style="position:relative"><code class="slate-code">consignee.address.city</code> </div></li></ul></div></div><p class="slate-p " ></p><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 " ><span style="color:#3B78D8"><strong class="slate-bold">Vendor Order Validation</strong></span></p><p class="slate-p " ><span style="background-color:rgb(255, 255, 255);color:rgb(64, 64, 64)">The </span><span style="background-color:#EFEFEF;color:rgb(64, 64, 64)"><code class="slate-code">order.shipments.*.vendor_id</code></span><span style="background-color:rgb(255, 255, 255);color:rgb(64, 64, 64)"> field validates vendor assignments for each shipment.</span></p><p class="slate-p " ><span style="background-color:rgb(255, 255, 255);color:rgb(64, 64, 64)">This is specified in the </span><span style="background-color:#EFEFEF;color:rgb(64, 64, 64)"><code class="slate-code">shipments</code></span><span style="background-color:rgb(255, 255, 255);color:rgb(64, 64, 64)"> array.</span></p><p class="slate-p " ></p><p class="slate-p " ><span style="background-color:rgb(255, 255, 255);color:rgb(64, 64, 64)"><strong class="slate-bold">required:</strong></span><span style="background-color:rgb(255, 255, 255);color:rgb(64, 64, 64)"> Must provide a vendor ID for each shipment</span>
<span style="background-color:rgb(255, 255, 255);color:rgb(64, 64, 64)"><strong class="slate-bold">integer:</strong></span><span style="background-color:rgb(255, 255, 255);color:rgb(64, 64, 64)"> Must be a whole number value</span>
<span style="background-color:rgb(255, 255, 255);color:rgb(64, 64, 64)"><strong class="slate-bold">unique_combination:</strong></span><span style="background-color:rgb(255, 255, 255);color:rgb(64, 64, 64)"> Vendor must not already handle this order (checks: vendor_id + order_id + order_number + store_id)</span></p><p class="slate-p " ><strong class="slate-bold">Implementation Notes:</strong></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Automatically checks against existing records</div></li><li class="slate-li " ><div style="position:relative">Prevents duplicate vendor assignments</div></li><li class="slate-li " ><div style="position:relative">Respects store context from authentication</div></li></ul><p class="slate-p " ><strong class="slate-bold">Error Message:</strong></p><p class="slate-p " ><span style="background-color:#EFEFEF;"><code class="slate-code">&quot;The combination of vendor id, order id and order number must be unique.&quot;</code></span></p></div></div><p class="slate-p " ></p>

Using a full order object (for new orders)

order

x-api-key

store_uid

success

status

order_id

order_number

store_name

shipments

<p class="slate-p " ></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Provide only the <code class="slate-code">processing_id</code> if the order details were previously submitted and processed.</div></li><li class="slate-li " ><div style="position:relative">Example</div></li></ul><p class="slate-p " ></p>

Using a processing_id (for pre-submitted orders)

processing_id

<p class="slate-p " ></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><span style="background-color:rgb(255, 255, 255);color:rgb(64, 64, 64)">This endpoint analyzes shipments and returns the matched carriers along with pricing information. It generates a processing ID that can be used for subsequent AWB creation requests.</span></div></li></ul><h4 class="slate-h4 " ></h4><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 " ><span style="color:#6FA8DC"><strong class="slate-bold">Carrier Strategy</strong></span></p><p class="slate-p " ><span style="background-color:rgb(255, 255, 255);color:rgb(64, 64, 64)">The </span><span style="background-color:#EFEFEF;color:rgb(64, 64, 64)"><code class="slate-code">carrier_strategy</code></span><span style="background-color:rgb(255, 255, 255);color:rgb(64, 64, 64)">  field determines how shipping carriers are selected for each shipment. </span></p><p class="slate-p " ><span style="background-color:rgb(255, 255, 255);color:rgb(64, 64, 64)">This is specified in the </span><span style="background-color:#EFEFEF;color:rgb(64, 64, 64)"><code class="slate-code">order</code></span><span style="background-color:rgb(255, 255, 255);color:rgb(64, 64, 64)"> object.</span></p><p class="slate-p " ></p><p class="slate-p " ><strong class="slate-bold">lowest_price:  </strong><span style="background-color:rgb(255, 255, 255);color:rgb(64, 64, 64)">System automatically selects the most economical carrier.</span></p><p class="slate-p " ><span style="background-color:rgb(255, 255, 255);color:rgb(64, 64, 64)"><strong class="slate-bold">shared: </strong></span><span style="background-color:rgb(255, 255, 255);color:rgb(64, 64, 64)">The system intelligently selects one carrier that can service all shipments in the order at the best combined value</span></p><p class="slate-p " ><span style="background-color:rgb(255, 255, 255);color:rgb(64, 64, 64)"><strong class="slate-bold">specifid: </strong></span><span style="background-color:rgb(255, 255, 255);color:rgb(64, 64, 64)">Uses the exact carrier provided in the </span><span style="background-color:#EFEFEF;color:rgb(64, 64, 64)"><code class="slate-code">shipments.carrier</code></span><span style="background-color:rgb(255, 255, 255);color:rgb(64, 64, 64)"> field</span></p></div></div><p class="slate-p " ></p><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 " ><span style="color:#6C9EEB"><strong class="slate-bold">Vendor Order Validation</strong></span></p><p class="slate-p " ><span style="background-color:rgb(255, 255, 255);color:rgb(64, 64, 64)">The </span><span style="background-color:#EFEFEF;color:rgb(64, 64, 64)"><code class="slate-code">order.shipments.*.vendor_id</code></span><span style="background-color:rgb(255, 255, 255);color:rgb(64, 64, 64)"> field validates vendor assignments for each shipment.</span></p><p class="slate-p " ><span style="background-color:rgb(255, 255, 255);color:rgb(64, 64, 64)">This is specified in the </span><span style="background-color:#EFEFEF;color:rgb(64, 64, 64)"><code class="slate-code">shipments</code></span><span style="background-color:rgb(255, 255, 255);color:rgb(64, 64, 64)"> array.</span></p><p class="slate-p " ></p><p class="slate-p " ><span style="background-color:rgb(255, 255, 255);color:rgb(64, 64, 64)"><strong class="slate-bold">required:</strong></span><span style="background-color:rgb(255, 255, 255);color:rgb(64, 64, 64)"> Must provide a vendor ID for each shipment</span>
<span style="background-color:rgb(255, 255, 255);color:rgb(64, 64, 64)"><strong class="slate-bold">integer:</strong></span><span style="background-color:rgb(255, 255, 255);color:rgb(64, 64, 64)"> Must be a whole number value</span>
<span style="background-color:rgb(255, 255, 255);color:rgb(64, 64, 64)"><strong class="slate-bold">unique_combination:</strong></span><span style="background-color:rgb(255, 255, 255);color:rgb(64, 64, 64)"> Vendor must not already handle this order (checks: vendor_id + order_id + order_number + store_id)</span></p><p class="slate-p " ><strong class="slate-bold">Implementation Notes:</strong></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Automatically checks against existing records</div></li><li class="slate-li " ><div style="position:relative">Prevents duplicate vendor assignments</div></li><li class="slate-li " ><div style="position:relative">Respects store context from authentication</div></li></ul><p class="slate-p " ><strong class="slate-bold">Error Message:</strong></p><p class="slate-p " ><span style="background-color:#EFEFEF;"><code class="slate-code">&quot;The combination of vendor id, order id and order number must be unique.&quot;</code></span></p></div></div><p class="slate-p " ></p>

<p class="slate-p " ></p><p class="slate-p " ><span style="background-color:rgb(255, 255, 255);color:rgb(64, 64, 64)">Retrieves all shipping orders with their associated shipments for the authenticated store, with optional filtering capabilities.</span></p><p class="slate-p " ></p><h2 class="slate-h2 " >Authentication</h2><p class="slate-p " ></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Requires authenticated store access via API key</div></li><li class="slate-li " ><div style="position:relative">API Key should be passed in the <code class="slate-code">x-api-key</code> header.</div></li></ul><p class="slate-p " ></p><p class="slate-p " ></p>

Retrieves all shipping orders with their associated shipments for the authenticated store, with optional filtering capabilities.

vendor_id

tracking_number

result

<p class="slate-p " ></p><p class="slate-p " ><span style="background-color:rgb(255, 255, 255);color:rgb(64, 64, 64)">Tracks the shipment status of a specific order by its ID and tracking number, returning detailed carrier tracking information.</span></p><p class="slate-p " ></p><h2 class="slate-h2 " >Authentication</h2><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Requires authenticated store access via API key</div></li><li class="slate-li " ><div style="position:relative">API Key should be passed in the <code class="slate-code">x-api-key</code> header.</div></li></ul><p class="slate-p " ></p><p class="slate-p " ></p>

Tracks the shipment status of a specific order by its ID and tracking number, returning detailed carrier tracking information.

Sections