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.

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

<h4 class="slate-h4 " ><strong class="slate-bold">Available Filters:</strong></h4><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Shipping Category</strong> <em class="slate-italic">(Select only one to avoid conflicts)</em></div></li><li class="slate-li " ><div style="position:relative"><span style="background-color:rgb(236, 236, 236);"><code class="slate-code">regular</code></span> (boolean) – Will return cities supported by Standard Dry Regular Shipping Services</div></li><li class="slate-li " ><div style="position:relative"><span style="background-color:rgb(236, 236, 236);"><code class="slate-code">cold</code></span> (boolean) – Will return cities supported by Cold Shipping Services</div></li><li class="slate-li " ><div style="position:relative"><span style="background-color:rgb(236, 236, 236);"><code class="slate-code">heavy</code></span> (boolean) – Will return cities supported by Heavy/Pallet Shipping Services for Big Volume or heavy items</div></li></ul><p class="slate-p " ><strong class="slate-bold">Shipping Carrier</strong></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><span style="background-color:rgb(236, 236, 236);"><code class="slate-code">carrier</code></span> (string) – Specify a carrier to get only supported coverage (e.g., <span style="background-color:rgb(236, 236, 236);"><code class="slate-code">&quot;smsa&quot;</code></span>)</div></li></ul><p class="slate-p " ><strong class="slate-bold">Direction Filter</strong></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><span style="background-color:rgb(236, 236, 236);"><code class="slate-code">for_shipper</code></span> (boolean) – Only cities supported to ship from</div></li><li class="slate-li " ><div style="position:relative"><span style="background-color:rgb(236, 236, 236);"><code class="slate-code">for_consignee</code></span> (boolean) – Only cities supported to ship to</div></li></ul><p class="slate-p " ><strong class="slate-bold">Search By City Name Or Part of Name</strong></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><span style="background-color:rgb(236, 236, 236);"><code class="slate-code">search</code></span> (string) – Filter by city name</div></li></ul><p class="slate-p " ><strong class="slate-bold">Pagination Controls</strong> <em class="slate-italic">(All results returned by default, Results will be return all by default to paginate use one or combination of these keys)</em></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><span style="background-color:rgb(236, 236, 236);"><code class="slate-code">page</code></span> (integer) – Page number</div></li><li class="slate-li " ><div style="position:relative"><span style="background-color:rgb(236, 236, 236);"><code class="slate-code">per_page</code></span> (integer) – Items per page <em class="slate-italic">(Default: 200)</em></div></li><li class="slate-li " ><div style="position:relative"><span style="background-color:rgb(236, 236, 236);"><code class="slate-code">paginate</code></span> (boolean) – Enable pagination</div></li></ul><p class="slate-p " ></p><div class="code-block-wrapper"  style="width:100%" ><div class="code-block-header">JSON</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-json keep-markup drop-tokens"><div class="slate-code_line"><div class="slate-code_line">{
    &quot;regular&quot;:true,
    &quot;carrier&quot;:&quot;smsa&quot;,
    &quot;paginate&quot;:true,
    &quot;per_page&quot;:10
}</div></div></code></pre></div><p class="slate-p " ></p>

(All results returned by default, Results will be return all by default to paginate use one or combination of these keys)

Specifies if the city is a regular city in the body parameter.

regular

Specifies the carrier of the city name in the body parameter.

carrier

Specifies whether to paginate the results of the cities list. Set to true to enable pagination.

paginate

Specifies the number of cities to display per page in the body parameter.

per_page

The API key required to access the endpoint.

x-api-key

Indicates whether the request was successful in the response.

success

cities

<p class="slate-p " >To get the status list, you should send a shipping type parameter (odd or Regular)</p><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p>

oddOrRegular

<p class="slate-p" placeholder="Type / for widgets">To get the data list, you should send a shipping type parameter (odd or Regular)</p><p class="slate-p" placeholder="Type / for widgets">In case of <strong class="slate-bold">ODD</strong>  you will get a response contains:</p><ul class="slate-ul"><li class="slate-li"><p class="slate-p" placeholder="Type / for widgets">Supported serviceable areas along with the polygon points for each area in order to draw it in your application</p></li><li class="slate-li"><p class="slate-p" placeholder="Type / for widgets">Estimated pricing range</p></li></ul><p class="slate-p" placeholder="Type / for widgets">In case of <strong class="slate-bold">REGULAR</strong> you will get a response contains:</p><ul class="slate-ul"><li class="slate-li"><p class="slate-p" placeholder="Type / for widgets">Available Countries</p></li><li class="slate-li"><p class="slate-p" placeholder="Type / for widgets">Cities</p></li><li class="slate-li"><p class="slate-p" placeholder="Type / for widgets">Carriers</p></li><li class="slate-li"><p class="slate-p" placeholder="Type / for widgets">Payment types</p></li></ul><p class="slate-p" placeholder="Type / for widgets"><em class="slate-italic"><strong class="slate-bold">Note: the odd means the quick shipping</strong></em></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

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

<p class="slate-p" placeholder="Type / for widgets"><span style="background-color:rgb(248, 250, 253);color:rgb(95, 99, 104);font-size:14px" class="slate-color"><span style="background-color:rgb(248, 250, 253);color:rgb(95, 99, 104);font-size:14px" class="slate-backgroundColor">Retrieves a list of </span></span>pair able<span style="background-color:rgb(248, 250, 253);color:rgb(95, 99, 104);font-size:14px" class="slate-color"><span style="background-color:rgb(248, 250, 253);color:rgb(95, 99, 104);font-size:14px" class="slate-backgroundColor"> cities for the specified pickup city.</span></span></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

cityID

<p class="slate-p " >To get available carriers, pricing and logo you will send the pickup city , consignee city and  the payment type (cc or cod)</p><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p>

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

cityOne

cityTwo

paymentType

weight

<p class="slate-p " ></p><h2 class="slate-h2 " >Description</h2><p class="slate-p " >Retrieves villages or branches for a specific carrier based on either city IDs or address IDs. This endpoint first attempts to fetch villages from the carrier&apos;s external API, and falls back to local carrier branches if no results are found.</p><p class="slate-p " ></p><p class="slate-p " ></p>

Retrieves villages or branches for a specific carrier based on either city IDs or address IDs. This endpoint first attempts to fetch villages from the carrier's external API, and falls back to local carrier branches if no results are found.

Array of address IDs to fetch villages for


address_id

city_ids

Unique identifier for the carrier (e.g., 'aramex', 'smsa')


response

<p class="slate-p " ></p><p class="slate-p " >This endpoint retrieves location information (city details, display names) based on geographic coordinates (latitude and longitude)</p><p class="slate-p " ></p><p class="slate-p " ></p>

This endpoint retrieves location information (city details, display names) based on geographic coordinates (latitude and longitude)

Sections