# Welcome

### Discover Roolz, a modern digital platform for organizing freight transportation!

You'll find a lot of useful information and lifehacks in the sections below ⬇️

<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-cover data-type="files"></th><th data-hidden></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Getting Started</strong></td><td></td><td><a href="/files/qQ6xIcqndYbR21WXDtPM">/files/qQ6xIcqndYbR21WXDtPM</a></td><td></td><td><a href="/pages/CyH2xJQs9yWJ1S8BYNav">/pages/CyH2xJQs9yWJ1S8BYNav</a></td></tr><tr><td><strong>Registration and login</strong></td><td></td><td><a href="/files/tYhbH9DqCCLv8rCX1yTV">/files/tYhbH9DqCCLv8rCX1yTV</a></td><td></td><td><a href="/pages/7aUFmnCMx9m4smGncsXL">/pages/7aUFmnCMx9m4smGncsXL</a></td></tr><tr><td><strong>User profile</strong></td><td></td><td><a href="/files/y1bZVYz1AaE4TRb0sOwc">/files/y1bZVYz1AaE4TRb0sOwc</a></td><td></td><td><a href="/pages/JjjojIyKxaiBPzzLwvtg">/pages/JjjojIyKxaiBPzzLwvtg</a></td></tr><tr><td><strong>Contacts and people search</strong></td><td></td><td><a href="/files/np3w9FhxPfluiOWDkNjY">/files/np3w9FhxPfluiOWDkNjY</a></td><td></td><td></td></tr><tr><td><strong>Companies</strong></td><td></td><td><a href="/files/6xMKEe5vgQEli6wu7q6d">/files/6xMKEe5vgQEli6wu7q6d</a></td><td></td><td></td></tr><tr><td><strong>Company directory</strong></td><td></td><td><a href="/files/MVkPHSh1wi3t509QWs7l">/files/MVkPHSh1wi3t509QWs7l</a></td><td></td><td></td></tr><tr><td><strong>Exchange and offers: freight and transport market</strong></td><td></td><td><a href="/files/GIhtHPfIvfG7Gug9vIGA">/files/GIhtHPfIvfG7Gug9vIGA</a></td><td></td><td></td></tr><tr><td><strong>Bids</strong></td><td></td><td><a href="/files/rpRelaL7AMk3V3rD65cX">/files/rpRelaL7AMk3V3rD65cX</a></td><td></td><td></td></tr><tr><td><strong>Messenger</strong></td><td></td><td><a href="/files/uBGj97j6gqYR4lYuIAKW">/files/uBGj97j6gqYR4lYuIAKW</a></td><td></td><td></td></tr><tr><td><strong>Prepared integrations with others</strong></td><td></td><td><a href="/files/FItWcvQqnBeGFxdg6t34">/files/FItWcvQqnBeGFxdg6t34</a></td><td></td><td></td></tr></tbody></table>


# What is Roolz?

**Roolz** is a multifunctional IT platform for finding partners in the freight transportation industry. It is aimed at cargo owners, carriers, forwarders, dispatchers and other participants in the logistics chain. The system provides convenient interaction between all parties.

**Transportation geography:** Roolz helps to efficiently organize cargo transportation not only around Belarus, Russia but also to international destinations, including CIS—China, Russia—Asia, Belarus—Asia and other routes.

**Multilingual**: the platform is translated into 10 languages including Russian, English, German, French, Chinese and others for the convenience of users.

**Roolz platform** has:

{% stepper %}
{% step %}
**Public and private exchanges:** a public exchange is for the open and spot market, while a private exchange is for confidential cooperation with existing partners in a confidential format.

The advantage of a private exchange is efficient work with its own database of verified counterparties which saves time, maintains control and ensures the safety of cooperation. The public exchange provides a variety of cargo and transportation offers with regard to routes, vehicle types and cooperation conditions.

<div align="left"><figure><img src="/files/fg7ZbIefeSNXbD30nHHZ" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
**4 bidding modes**: «Bargain», «Auction», «Fix» and «Ad». Users can bid on both exchanges offering competitive rates and conditions for transportation. This helps to find profitable orders and optimize expenses.

<div align="left"><figure><img src="/files/S90QUqGsWnAYZpbtdb6k" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
**Business messenger**. A convenient tool for fast communication between partners, colleagues, drivers and all stakeholders. Real-time information exchange without data loss in a single space.

<div align="left"><figure><img src="/files/lkhhqylR4gBnWfpS1xHz" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
**«Partner selection» mode**. Cargo owners cannot only compare rates but also select new partners on the public exchange to add them to their private exchange.

<div align="left"><figure><img src="/files/9yqBrk6LVbi3dPYqZcc4" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
**Data upload to Excel, CSV and JSON**. Ability to collect and analyze data on tenders and contracts. This speeds up reporting and analytics for companies that use these formats in their business processes.

<div align="left"><figure><img src="/files/6yOu1Lr7GknWh2lgqwii" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
**Auto-selection of cargoes and transportation**. The system automatically selects cargoes and transportation based on specified parameters saving specialists' time and simplifying logistics.
{% endstep %}

{% step %}
**Integration with CRM, TMS and ERP systems.** The platform integrates with transportation and resource management systems which simplifies interaction with current business processes.
{% endstep %}

{% step %}
**Email notifications.** Users receive prompt notifications about new offers, offer statuses and other important events. This allows you to quickly respond to profitable orders and not miss opportunities.

<div align="left"><figure><img src="/files/8uMkjgTPMT41b24bRpE5" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
**Roolz company directory.** Users can create and promote their company profile to showcase their services and competitive advantages, as well as find new partners. Such a company card on the platform can be a mini version of your company website.

<div align="left"><figure><img src="/files/ksgnVC5IRjV7WdVBdg3X" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
**Prepared integrations with other systems.** For example, Roolz integration with the SpotGo platform allows cargo owners to access carriers and forwarders from Europe, CIS and China. Roolz acts as a reliable logistics bridge bringing together market players from all over the world and simplifying the process of searching for partners.

<div align="left"><figure><img src="/files/q79jqyYAzBday5GDuzi2" alt=""><figcaption></figcaption></figure></div>
{% endstep %}
{% endstepper %}


# Plans and subscriptions

### Roolz has 5 plans, each one covers a different purpose:

1. **Free** *— for those who rarely carry out shipping and have few partners. Includes:*

* Unlimited publishing of freight and transport offers
* Unlimited freight and transport search
* View contacts and participate in bidding: 3 offers (per company)
* Free private offers: 3 (per company)
*

2. **Beginner** *— for entrepreneurs and companies with a small volume of transportation. Includes:*

* Viewing contacts and participating in bidding: 10 offers (per user)
* Viewing company and user contacts: 5 (per user)
* Free private offers: 5 (per user)
* Free partner groups: 2

General:

* Support speed: up to 3 days<br>

3. **Pro** *— for developing companies that need to streamline and speed up the organization of cargo transportation. Includes:*

* Viewing contacts and participating in bidding: unlimited
* Viewing company and user contacts: unlimited
* Viewing offers in company profiles
* Free private offers: 60 (per user)
* Free partner groups: 5

General:

* Delayed bidding start (temporary bidding windows)
* The first bid from a participant can be any
* Planned auction price
* Support speed: within 24 hours<br>

4. **Expert** *— for those who are actively working in contract logistics and spot market. Includes:*

* Full access to the private exchange
* Free private offers: 150 (per user)
* Free partner groups: 100,000

General

* Delayed bidding start (temporary bidding windows)
* The first bid from a participant can be any
* Planned auction price
* Support speed: within 4 hours<br>

5. **Enterprise** *— for companies that need to streamline, simplify and speed up the organization of transporting large volumes within departments. Includes:*

* Full access to the private exchange
* Free private offers: individual
* Free partner groups: individual
* Private offer price without a limit: individual

General

* Delayed bidding start (temporary bidding windows)
* The first bid from a participant can be any
* Planned auction price

<details>

<summary><strong>How to request an invoice for payment and closing documents?</strong></summary>

Contact our support at **<support@roolz.net>**.

</details>

<details>

<summary><strong>Do the carriers pay to see contacts in our private offers?</strong></summary>

They don't. Viewing contacts and bidding on your private offers is free for your partners.

</details>

<details>

<summary><strong>Does the number of offer contact views roll over to the next month?</strong></summary>

No, it doesn't. We recommend you to use all features of your plan in a timely manner so that unused limits are not burned off.

</details>

<details>

<summary><strong>Can employees of the same company use different subscription plans?</strong></summary>

No, they can't. The plan is purchased for the company, within which the employees work.

</details>

<details>

<summary><strong>How are offer views on a public exchange counted?</strong></summary>

Offer views are free for everyone on a public exchange. You only pay for contact views. The number of available contact views is regulated by your plan: the higher the plan, the more the number of the possible contact views.

</details>

<details>

<summary><strong>What is the chargeback policy?</strong></summary>

There are no refunds. If you have purchased a plan and have not used its limits you will not be refunded if you cancel your subscription.

</details>

<details>

<summary><strong>How soon after payment does the plan take effect?</strong></summary>

Immediately after the payment, you will be able to view offers and contacts of users, the number per month depends on your plan.

</details>


# Can Roolz be used for free?

Yes, you can. To do this you need to register on the platform. If you represent a company, create company profile so that the number of responses to your offers is much higher.

The free plan includes:

* Publication of cargo and transport **without limits**;
* Search for cargo and transport **without limits**;
* Viewing offers and bidding: **3 offers (per company)**.
* Communication with potential partners or colleagues in Roolz messenger **directly on the exchange**.


# How to buy a subscription?

{% hint style="info" %}
Only available for companies.
{% endhint %}

{% hint style="danger" %}
**Note!** If you have already bought a subscription and then add users to the company you will have to pay extra for each of them according to your plan.
{% endhint %}

<figure><img src="/files/N2Vu7UpUZLHFiay2UaQK" alt=""><figcaption></figcaption></figure>

{% stepper %}
{% step %}
Log in to your profile at [roolz.net](https://roolz.net) and then to the space of the company you are working on behalf of.
{% endstep %}

{% step %}
Click on the "Expand Logistics" button in the upper right corner of the page, or open the "Pricing" tab in the menu on the left. You will be directed to the page with the current tariff plans.
{% endstep %}

{% step %}
Choose a monthly or yearly subscription. Select the plan that suits you and click "Confirm" button.

***You will receive a 20% discount on your annual payment.***
{% endstep %}

{% step %}
Then the final cost of the payment will be indicated, taking into account the number of users in the company and the VAT percentage. Make sure everything is correct and click "Confirm".
{% endstep %}

{% step %}
You will be directed to the payment window of the payment system. Enter the card details and confirm the payment.
{% endstep %}

{% step %}
Congrats! You have successfully purchased a Roolz subscription.

{% hint style="info" %}
Only the Owner and Administrators of the company can buy a subscription.
{% endhint %}

{% hint style="danger" %}
**Notes!** We have an invoice payment option for quarterly and annual subscriptions. If you want to use it, please contact our support at **<support@roolz.net>**.
{% endhint %}
{% endstep %}
{% endstepper %}


# How to unsubscribe?

{% hint style="info" %}
Only the Owner and Administrators of the company can cancel the subscription.
{% endhint %}

To cancel the subscription:

{% stepper %}
{% step %}
Log in to your profile at [roolz.net](https://roolz.net) and then to the space of the company you are working on behalf of.
{% endstep %}

{% step %}
Click on the "Settings" button located in the upper right corner.
{% endstep %}

{% step %}
Select "Plan and billing" tab on the left.
{% endstep %}

{% step %}
Click on the ellipsis on the right where your current plan is indicated, then on "Cancel subscription". Confirm this action with the "Yes, cancel" selection, and the subscription will be canceled.
{% endstep %}

{% step %}
Your plan will change to the free version at the end of the plan's scheduled term. For example, if you bought any monthly plan on February 1 and canceled on February 15, the free version will start running from March 1. The same is valid for annual subscriptions.

{% hint style="danger" %}
**Note!** You won't be able to purchase a new plan until your old subscription expires even if it's canceled. However, until the subscription automatically expires, all plan features remain.
{% endhint %}
{% endstep %}
{% endstepper %}


# How to change a subscription plan?

{% stepper %}
{% step %}
Log in to your profile at [roolz.net](https://roolz.net) and then to the space of the company you are working on behalf of.
{% endstep %}

{% step %}
Click on the "Settings" button located in the upper right corner.
{% endstep %}

{% step %}
Select the "Plan and billing" tab on the left.
{% endstep %}

{% step %}
There are 3 options on how to change your subscription plan:

1. Click on the ellipsis on the right where your current plan is listed, then "Switch to another plan";&#x20;
2. Click on "Expand possibilities, business, logistics" and select a new plan;
3. In your plan block at the bottom click on "Switch to beginner/pro/expert" button and select a new plan.
   {% endstep %}

{% step %}
Congrats! You have successfully changed your plan.
{% endstep %}
{% endstepper %}


# How are subscription fees calculated?

**Formula**: cost per user \* number of spaces (i.e. number of users in the company on Roolz platform) + 20% VAT = total cost.

VAT is calculated automatically. If you have purchased a subscription and the price has increased, you do not need to pay anything extra while the subscription is still valid.


# What does it mean to say «the total company limit is formed from the sum of the limits per user»?

This point relates to the posting of private offers.

If the limit of private offers in your plan is 10, these 10 limits apply to one user of this company. Each user added to the company gives +10 free private offers for the whole company. Thus, if 10 users are added to your company, each of them has 10 limits. The total limit for one company will be 100 private offers (the formula is: number of limits \* by the number of users in the company).

{% hint style="danger" %}
**Note!** Each user spends company limits, not personal.
{% endhint %}


# What are credits and how to buy them?

**Credits** are Roolz currency. It is necessary for those who work on the private exchange. Now you can buy additional private offers placement with credits, i.e. above your plan limit.

To buy credits:

{% stepper %}
{% step %}
Log in to your profile at [roolz.net](https://roolz.net) and then to the space of the company you are working on behalf of.
{% endstep %}

{% step %}
Click on the "Settings" button located in the upper right corner.
{% endstep %}

{% step %}
Select "Plan and billing" tab on the left.
{% endstep %}

{% step %}
Find "Credits balance" and click "Top up credits".
{% endstep %}

{% step %}
Enter the number of credits you would like to purchase and click the button "Top up credits".
{% endstep %}

{% step %}
Enter your card details and click "Pay".
{% endstep %}

{% step %}
Purchased credits will immediately appear on the "Credits balance".
{% endstep %}
{% endstepper %}


# How we are different?

**Roolz** is a new generation system and is built on different principles. Roolz is an IT company, not an intermediary, freight forwarder or broker. The platform **does not take a commission from the cost of transportation.** That eliminates conflicts of interest and makes the platform as transparent and profitable as possible for all participants in the freight transportation market.

Unlike Atrucks, Loginet and 1C, Roolz not only provides **a private exchange** but also has **a public exchange for spot transportation, bidding modes and a business messenger** in one place. You can work with Roolz from anywhere. The platform's website is also adapted for cell phones. For the convenience of drivers, Roolz also developed Roolz Driver app.

Roolz features:

* Placing freight and transport offers, bidding, participating and promoting your company profile **for free.** We make our money by providing advanced functionality to large companies for contract logistics. This combination of functionality within one solution is unique even without Roolz Driver mobile app;
* The exchange has its own **companies directory** where users can conveniently view all registered companies at once. This distinguishes us from most freight exchanges.
* Roolz is a flexible system which generally **does not require separate enhancements**, only customizations within the system;
* Roolz optimizes the speed of many processes and automates routine tasks. This allows the logistician **to save 10-40 hours per month.** Thus, the logistician can handle more shipments per month.


# Our values

### Top 5 benefits of working on Roolz platform:

1. **Internationality**. A distinctive advantage of Roolz exchange. Cargo owners, carriers and forwarders can easily find each other on any directions (CIS, EU, Asia, China), expanding opportunities for effective cooperation.
2. **Optimization and reduction of transportation costs.** Private bidding among regular partners and a public exchange provide an opportunity to select the best offers, helping to reduce transportation costs by 10-25%. Competitive bidding attracts new carriers and freight owners, improving flexibility, and increasing the competitiveness of the existing partners.
3. **Processes automation.** The auto-matching system allows users to quickly find the transportation offer they need, saving time and reducing the number of "empty" runs. It also reduces labor costs, increases productivity and allows logisticians to handle more tasks faster.
4. **Flexibility in transportation choices.** The platform supports various types of cargo and vehicles: from standard tents and refrigerated trucks to tanks and platforms.
5. **Transparency and risk reduction.** Roolz centralizes important data, which not only ensures transparency but also the security for the company. Users can monitor market prices and receive up-to-date information that can help them make informed and timely decisions.


# PC registration

### How to register on Roolz from PC

{% stepper %}
{% step %}
Go to the website using the link [https://roolz.net](https://roolz.net/ru) or paste it into a search query.
{% endstep %}

{% step %}
To proceed to registration, tap the "‎Sign Up"‎ button, which is located in the upper right corner of the main page.

<div align="left"><figure><img src="/files/7tN57CmD5Vc1C4JsLc4E" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
In the newly appeared window, you will be offered several registration options: via email, phone number or Google account. We recommend registering via email.

{% tabs %}
{% tab title="VIA EMAIL" %}

1. Enter your valid email address in the field.
2. Set a password or choose the "‎Sign up via link"‎ option (above "Create password"‎ field).\
   The password must be at least 8 characters long and contain both letters and numbers (at least one of each).
3. Click "Continue"‎, and you will be registered.
4. A confirmation email will be sent to your inbox with a link that you need to click to confirm your email address. This is very important for the security of your account.
5. After the registration you will be directed to the profile completion page.
6. Fill out your public profile, providing your first and last name. It is also very helpful to include your contact details and upload a photo.
7. After that, you will see the screen offering you the option to create company profile or to act as an individual.

<div align="left"><figure><img src="/files/GRkItGbYBzCVN1nUBXfU" alt=""><figcaption></figcaption></figure></div>
{% endtab %}

{% tab title="VIA PHONE NUMBER" %}

1. Select your country from the list or type its name in the "Country"‎ field and enter your phone number in international format.\
   You will receive an SMS with a verification code.
2. Enter the code in the field, and you will be registered.
3. After the registration you will be directed to the profile completion page.
4. Fill out your public profile, providing your first and last name. It is also very helpful to include your contact details and upload a photo.
5. After that, you will see the screen offering you the option to create company profile or to act as an individual.

<div align="left"><figure><img src="/files/K4KgmsG3AuRXYrZdK8Vz" alt=""><figcaption></figcaption></figure></div>
{% endtab %}

{% tab title="VIA GOOGLE ACCOUNT" %}

1. Click the "Log in with Google"‎ button at the bottom of the registration window.
2. Once you select Google account that you want to use for the registration, you will be directed to the profile completion page.
3. Fill out your public profile, providing your first and last name.
4. It is also very helpful to include your contact details and upload a photo.
5. After that, you will see the screen offering you the option to create company profile or to act as an individual.

<div align="left"><figure><img src="/files/of1Cs4P2JUsIlrYNQbFo" alt=""><figcaption></figcaption></figure></div>
{% endtab %}
{% endtabs %}
{% endstep %}

{% step %}
Your personal profile has been created, congratulations! However, for a profile to be considered 100% registered, it must be completely filled out (scroll through the interactive window to learn how to do it):

{% embed url="<https://app.storylane.io/share/pdfx2wdt5a5q>" %}
{% endstep %}

{% step %}
If your company or business is not on Roolz yet, we recommend that you [create company profile](/en/companies/company-profile).
{% endstep %}
{% endstepper %}


# Mobile registration

### How to register on Roolz from a mobile device?

{% stepper %}
{% step %}
Go to the website using the link [https://roolz.net](https://roolz.net/ru) or paste it into a search query.
{% endstep %}

{% step %}
On the website, open the menu in the upper left corner and click the "Sign Up"‎ button.

<div align="left"><figure><img src="/files/9qO16iSzTlrdO2EYszua" alt="" width="375"><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
In the newly appeared window, you will be offered several registration options: via email, phone number or Google account. We recommend registering via email.

{% tabs %}
{% tab title="VIA EMAIL" %}

1. Enter your valid email address in the field.
2. Set a password or choose the "Sign up via link"‎ option (above "Create password" field).\
   The password must be at least 8 characters long and contain both letters and numbers (at least one of each).
3. Click "Continue"‎, and you will be registered.
4. A confirmation email will be sent to your inbox with a link you need to click to confirm your email address. This is very important for the security of your account.
5. After the registration you will be directed to the profile completion page.
6. Fill out your public profile, providing your first and last name. It is also very helpful to include your contact details and upload a photo.
7. After that, you will see the screen offering you the option to create company profile or to act as an individual.

<div align="left"><figure><img src="/files/GRkItGbYBzCVN1nUBXfU" alt=""><figcaption></figcaption></figure></div>
{% endtab %}

{% tab title="VIA PHONE NUMBER" %}

1. Select your country from the list or type its name in the "Country" field and enter your phone number in international format.\
   You will receive an SMS with a verification code.
2. Enter the code in the field, and you will be registered.
3. After the registration you will be directed to the profile completion page.
4. Fill out your public profile, providing your first and last name. It is also very helpful to include your contact details and upload a photo.
5. After that, you will see the screen offering you the option to create company profile or to act as an individual.

<div align="left"><figure><img src="/files/K4KgmsG3AuRXYrZdK8Vz" alt=""><figcaption></figcaption></figure></div>
{% endtab %}

{% tab title="VIA GOOGLE ACCOUNT" %}

1. Click "Log in with Google"‎ button at the bottom of the registration window.
2. Once you select Google account that you want to use for the registration, you will be directed to the profile completion page.
3. Fill out your public profile, providing your first and last name.
4. It is also very helpful to include your contact details and upload a photo.
5. After that, you will see the screen offering you the option to create company profile or to act as an individual.

<div align="left"><figure><img src="/files/of1Cs4P2JUsIlrYNQbFo" alt=""><figcaption></figcaption></figure></div>
{% endtab %}
{% endtabs %}
{% endstep %}

{% step %}
Your personal profile has been created, congratulations! However, for a profile to be considered 100% registered, it must be completely filled out (scroll through the interactive window to learn how to do it):

{% embed url="<https://app.storylane.io/share/pdfx2wdt5a5q>" %}
{% endstep %}

{% step %}
If your company or business is not on Roolz yet, we recommend that you [create company profile](/en/companies/company-profile).
{% endstep %}
{% endstepper %}


# Registration via the invitation link

### How to register on Roolz via email with the invitation link to the company?

{% stepper %}
{% step %}
First, you need to open your personal or work email, where you should have received a letter with an invitation link. The invitation link is valid for 14 days. If the period has expired, contact your company administrator to receive a new invitation.
{% endstep %}

{% step %}
Open the email and click "Accept"‎ in the invitation link.
{% endstep %}

{% step %}
Next, roolz.net will open, and you will see a window stating that you have joined the company. Depending on the device you used to open the email (phone or computer), you will need to either click "Enter"‎ or "Ok"‎ button.

<div align="left"><figure><img src="/files/LAjGyZ9asshEgOHPbUAU" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
If you are already registered on Roolz platform, you will be prompted to create [freight](/en/freight-offers) or [transport offer](/en/vehicle-offers).

{% hint style="danger" %}
**Note!** This registration process occurs without creating a password. To ensure your security and to expand your login options, we recommend adding an additional authentication method.
{% endhint %}
{% endstep %}

{% step %}
However, if you don't have one, you will be directed to the page to create your [public profile](/en/user-profile/what-is-a-user-profile), providing your first and last name, contact details, and uploading a photo. You will only be considered fully registered after completing your profile.

Below is an interactive guide to the completion of your profile:

{% embed url="<https://app.storylane.io/share/pdfx2wdt5a5q>" %}
{% endstep %}

{% step %}
Congratulations! You have successfully registered and become a member of the company on Roolz.
{% endstep %}
{% endstepper %}


# Login

### How to log in?

{% stepper %}
{% step %}
Go to the website using the link <https://roolz.net> or paste it into a search query. On the main page in the upper right corner, click on the "‎Log in" button. If you are using a mobile phone, this button is located in the menu in the upper left corner.

<div align="left"><figure><img src="/files/AthPrmsnQH2plgf4RgJ4" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
In the window that opens, enter the information you used to register:

{% tabs %}
{% tab title="VIA EMAIL" %}

1. Enter your email address and password.
2. If you have forgotten your password, use the "‎Login via link" option or reset your password.
3. In both cases, you will receive an email with a link to proceed.

<div align="left"><figure><img src="/files/45PivviPpB9Jm5lpBZEJ" alt=""><figcaption></figcaption></figure></div>
{% endtab %}

{% tab title="VIA PHONE" %}

1. An SMS code will be sent to the specified number, which must be entered to log in.

<div align="left"><figure><img src="/files/PnkPtgQoPWd68rj0F1wF" alt=""><figcaption></figcaption></figure></div>

{% hint style="danger" %}
**Note!** Adding a phone number to your user profile if you registered via email, or adding your email if you registered via phone number, does not make these details an additional authentication method. Attempting to log in using them will result in creating a duplicate profile. You can find out how to set up an additional authentication method [here](/en/registration-and-login/how-to-change-login-method).
{% endhint %}
{% endtab %}

{% tab title="VIA GOOGLE ACCOUNT" %}

1. Log in via your Google account.
2. Select the preferred account and click on it.

<div align="left"><figure><img src="/files/flEv3a3xJCoktswwwNyg" alt=""><figcaption></figcaption></figure></div>
{% endtab %}
{% endtabs %}
{% endstep %}

{% step %}
Congratulations! You have logged into your personal Roolz account.
{% endstep %}
{% endstepper %}

### How to log in if I forgot my password? (Only for those who registered by email)

{% stepper %}
{% step %}
To recover your password, enter the email you registered with.

<div align="left"><figure><img src="/files/3aiphNfpvttZzNOpSR40" alt="" width="375"><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Click the "Continue" button.

<div align="left"><figure><img src="/files/pTaZ530a8FNUL1tYp3sN" alt="" width="375"><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Click “Recover” under the password line.

<div align="left"><figure><img src="/files/psxF4cozP0xu1gQxuYNw" alt="" width="375"><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
In the appeared window, click the "Send" button. A password reset link will be sent to the specified email address.

<div align="left"><figure><img src="/files/sBhQ7Uge66faRHH7GiV7" alt="" width="375"><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Click on "Change Password" in the email and you will be automatically logged into your account on the platform.

<div align="left"><figure><img src="/files/OFXXSkbq0DXJ4SffW1mW" alt="" width="375"><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Done! Set a new password and save it so you won't forget it.

<div align="left"><figure><img src="/files/mHKJd272fYotxnuFmdLw" alt="" width="375"><figcaption></figcaption></figure></div>
{% endstep %}
{% endstepper %}


# How to change login method

### How to change, add or remove a login method?

{% hint style="danger" %}
**Note!** These features only available to the authorized users. Therefore, you must first [log in to your ](/en/registration-and-login/login)[profile](/en/registration-and-login/login).
{% endhint %}

{% stepper %}
{% step %}
[On the exchange](https://roolz.net), click on your avatar (or circle with two letters) in the upper right corner;

<div align="left"><figure><img src="/files/19bimuOdLGeND8Vy0LNm" alt="" width="375"><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Click "Settings";

<div align="left"><figure><img src="/files/bGog1pjYnwfdlbHWEu66" alt="" width="375"><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Click "Login and security";

<div align="left"><figure><img src="/files/aCW8b44PGKCxwMF1UymH" alt="" width="375"><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
The authorization methods page will open.

<div align="left"><figure><img src="/files/bWr4bz01cJcHj4pHuD4g" alt="" width="375"><figcaption></figcaption></figure></div>
{% endstep %}
{% endstepper %}

### On the authorization methods page you can:

* **Add, change or delete a phone number.** Confirmation of the new number occurs by entering

  the code that will be sent in an SMS message to the new phone number.

<div align="left"><figure><img src="/files/zs9KwkQJl1QRNlfiHnhP" alt="" width="375"><figcaption></figcaption></figure></div>

* **Add, change, or delete an email address.** You will receive an email with a link that you must click to confirm your email address. This is important for the security of your account.

<div align="left"><figure><img src="/files/lud1tDuaRiE9wJOiASJc" alt="" width="375"><figcaption></figcaption></figure></div>

{% hint style="info" %}
If you logged in using Google account, your new email address should be the same as the one that you used to sign in.
{% endhint %}

* **Set, change, or delete the password.** It must be longer than 8 characters and contain at least one number and one letter. If the password already exists, changing or deleting it requires entering your current password. If you have forgotten your password, click on the "Recover" button, and a password reset link will be sent to your email.

<div align="left"><figure><img src="/files/XsFezqtAONFUrd2Jzt2L" alt="" width="375"><figcaption></figcaption></figure></div>

* **Enable or disable authorization via Google.** The email address specified in the service must match the email address in your Roolz account.

<div align="left"><figure><img src="/files/1ncTFWwZfAHhnShIgcBl" alt="" width="375"><figcaption></figcaption></figure></div>

{% hint style="danger" %}
**Note!** If you have already set a password, any changes to the authentication methods requires entering your current password. For security reasons, an email notification will be sent to you after each change to the authentication methods.
{% endhint %}


# What is a user profile?

**Roolz user profile** is your profile that is visible to all registered users.

The profile is like your social media page, but in the world of trucking. Fill it out as thoroughly as possible. Include all contact information, add a photo, tell us who you are and what services you provide. A well-filled profile with a photo is more trustworthy and increases recognition among other users.

{% hint style="info" %}
To create user profile, you must provide first and last name.
{% endhint %}

<div align="left"><figure><img src="/files/kSMUGnXj9LnCcdGlG542" alt="" width="375"><figcaption></figcaption></figure></div>


# Which optional info can you add in your profile?

1. **Photo** — people trust users more if they have a real photograph;
2. **Middle name**;
3. **Country** — displayed as the flag of the country where you live;
4. **About** — a brief description of yourself, your experience, achievements and services;
5. **Contact information** — personal and work phone numbers, personal and work email, Skype;
6. **A** **link** to your company's website.

<div align="left"><figure><img src="/files/HVQRm6IiHSKsNiGqDoP2" alt="" width="375"><figcaption></figcaption></figure></div>


# How to change user profile information?

{% stepper %}
{% step %}
In the upper right corner, click on your avatar (or circle with two letters);

<div align="left"><figure><img src="/files/PMraJocgAGYwKCSq2PND" alt="" width="375"><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Click "My profile" from the drop-down menu. Your profile view page will be opened;

<div align="left"><figure><img src="/files/RnxXpAH4gz4ILsiPqyDd" alt="" width="375"><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Click "Edit".

<div align="left"><figure><img src="/files/nYt02kY5uisNTRf8MVkT" alt="" width="375"><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
In the edit mode, you can change information, such as:

1. **Photo** — people trust users more if they have a real photograph;
2. **First Name\*** — maximum 25 characters;
3. **Surname\*** — maximum 25 characters;
4. **Middle name —** maximum 25 characters;
5. **Nickname\*** — A-Z, 0-9 and \_ are allowed. Length from 4 to 20 characters. Nickname must be unique, i.e. different from the nicknames of other users registered on the platform;
6. **Country** — displayed as the flag of the country where you live;
7. **About** — a brief description of yourself, your experience, accomplishments and services;
8. **Contact information** — personal and business phone number, personal and business email, Skype;
9. **A** **link** to your company's website.

\*Required fields

<div align="left"><figure><img src="/files/8xqbmpWCamqywVIjygao" alt="" width="375"><figcaption></figcaption></figure></div>
{% endstep %}
{% endstepper %}


# How to delete user profile?

{% stepper %}
{% step %}
In the upper right corner, click on your avatar (or circle with two symbols);

<div align="left"><figure><img src="/files/T4C2rdNN3W74BjykPzvo" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Select "My Profile." This will open your profile page;

<div align="left"><figure><img src="/files/ZqzhIyy0Fiur6RZT0iNA" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Click on the trash can icon;

<div align="left"><figure><img src="/files/IZ3HY0GfhuPLnVmKvZRD" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Please describe the reasons why you want to remove the company so that we can improve the product;

<div align="left"><figure><img src="/files/xm58vNFdaJinM78pFDuT" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Click "Confirm". Done!
{% endstep %}
{% endstepper %}


# My contacts

Imagine Roolz both as a social network and a messenger for the trucking industry. The platform allows its users to maintain both corporate as well as personal database of counterparties and customers.

### What you can and can't do with contacts

* You can add users to your personal contacts, just like in the phonebook.
* If you are a member of a company, you can see both your personal contacts as well as those of your colleagues in the contact list, i.e. company contacts. You can quickly find and contact the right person in the company.
* You can also remove users from your contacts. To do this, open the user's profile. Next to the "Message" button, you will see the "Delete from contacts" icon.
* If a user has blocked you (blacklisted you), you won't be able to add them to your contacts.
* You can't change another user's first name, last name or other data.
* You cannot add company contacts to the blacklist.
* When you block a user, both you and the user cannot add each other to contacts or send messages in a chat.

{% hint style="info" %}
You can add users to your contacts without sending an approval request.
{% endhint %}


# People search

### **How to find a user that is not in your list of contacts?**

* **Nickname** is the easiest way to find a user. Nickname is unique. Search starts with 4 characters. Search query may partially match search results, which simplifies finding the right user.
* **Phone number or email** that is specified in the user profile or is used by the the searched user for authorization. The search query must exactly match the phone number or email.

### **How to find users from your contacts?**

There are 3 ways:

* **First and last name,** searches start at the 1st character match. For better results, enter the user's first and last names in full.

<div align="left"><figure><img src="/files/KihdGVGc0MPCBOHZuJxG" alt="" width="375"><figcaption></figcaption></figure></div>

* **Nickname,** search starts with 1 matching character.

<div align="left"><figure><img src="/files/bE6EgCNUm10oQ4RxiUL5" alt="" width="375"><figcaption></figcaption></figure></div>

* **Email or phone number search,** starts with matching 2 or more characters in a row.

<div align="left"><figure><img src="/files/ewehwWHwrymO09vNGZO1" alt="" width="375"><figcaption></figcaption></figure></div>

<div align="left"><figure><img src="/files/O7SCnXIMyAUgSR0rlKP3" alt="" width="375"><figcaption></figcaption></figure></div>

### **Where to** search **for users?**

* There is a search field in the menu on the left above the list of chats. This is the most universal search that allows you to quickly find people and chats.

<div align="left"><figure><img src="/files/1L8xWD8WEhXiHM6cP9y1" alt="" width="375"><figcaption></figcaption></figure></div>

* Click on your profile picture (or the colored circle with the two letters) in the upper right corner. In the menu that appears, select "My Contacts". A list of your contacts will open, with a search option available for users, including those not in your contacts.

<div align="left"><figure><img src="/files/HvXY07HE6kjI0bpdJk8z" alt="" width="375"><figcaption></figcaption></figure></div>

<div align="left"><figure><img src="/files/dlGXLkqo4JoSSQ0EEGky" alt="" width="375"><figcaption></figcaption></figure></div>

### **How to add users to your contacts?**

* In the [user profile](/en/user-profile/what-is-a-user-profile), click "Add to contacts".

<div align="left"><figure><img src="/files/6UkqxZifMyq9i00p6pXn" alt="" width="375"><figcaption></figcaption></figure></div>

* In the [chat](/en/messenger/full-guide) with the user, click "Add to contacts".

<div align="left"><figure><img src="/files/5dqZX9FjrwyYLiRkn1Bi" alt="" width="375"><figcaption></figcaption></figure></div>


# Viewing contacts in a company profile

{% hint style="danger" %}
**Important!** On the platform, access to company and user contacts is hidden in profiles and is regulated by the pricing plan and the system of limits.
{% endhint %}

### What counts as viewing contacts in the company profile?

Viewing contacts means opening a full company card with contact information and details of its representatives.

* General company information is available to view for free;
* Additional information (email, phone number, representative contacts, etc.) are viewed by clicking "Open contacts" button;
* Opening any new company card is counted as a separate view.

<div align="left"><figure><img src="/files/33WLbQVp3TsdXhKXJrfj" alt=""><figcaption></figcaption></figure></div>

### Tariff limits

* Free plan — 0 views per month;
* Beginner plan — 30 views per month;
* Pro / Expert / Enterprise — unlimited;

{% hint style="danger" %}
**Important!** The logic of limits depends on the tariff plan.

* On the free plan, the limit applies to the entire company and is shared among all employees.
* On paid plans, limits are applied per user but are cumulatively calculated to form a shared company pool.
  {% endhint %}

This means that all company employees share the same available number of views.

For example, if a company has two users and each has 30 available views, the total limit will be 60 views and can be used by any employee.

### Restrictions on viewing contacts

Contacts are opened automatically if:

* You have a tariff plan with unlimited access to contacts;
* You have already opened this profile this month;
* The company is your current partner;
* You are viewing user profiles for your company.

### How do limits work?

* With a paid subscription, usage and limits are calculated with the payment for the next billing period;
* With a free plan, limits are calculated per calendar month;
* Reopening an already viewed profile does not consume the limit for the current billing period and until it is reset;
* After the limit is reset, all views are recalculated;

### What happens when the limit is reached?

If your view limit has been reached:

* A notification will appear indicating the limit has been reached and you will not be able to open any new contacts until the next billing period (or until your plan is upgraded);
* You will need to upgrade to a higher plan to continue;
* Previously opened contacts will remain available for the current subscription period;
* If you are not a company owner or administrator, the system will prompt you to contact your company administrator.

{% hint style="danger" %}
**Important!** Opening contacts does not automatically make them visible in other sections (for example, in offers).
{% endhint %}

### Where can I see the remaining limits?

The current tariff plan section displays "Viewing contacts of companies and users" counter.

If you are a company owner or administrator, you can see the available number of views by clicking "Settings" → "Plan and billing" in the dashboard.

* For a company owner or administrator:\
  click "Settings" → "Plan and billing" section.
* For a company representative:\
  click "My plan" in the dashboard.

<div align="left"><figure><img src="/files/wQOTiRlGYtxVIxBVC7EJ" alt=""><figcaption></figcaption></figure></div>

{% hint style="danger" %}
**Important!** Viewing contacts in a company profile does not reveal contacts in offers, and vice versa— accessing contacts in offers does not reveal contacts in the company profile. Contacts are also unavailable to unauthorized users.
{% endhint %}


# How to view user's contact information in an offer?

To do this:

{% stepper %}
{% step %}
Go to the offer you are interested in;

<div align="left"><figure><img src="/files/YozezDZ5uP6LFQULFcOY" alt=""><figcaption></figcaption></figure></div>

{% hint style="danger" %}
**Important!** If company profile does not contain any contact information, the contact section will be displayed without restrictions.
{% endhint %}
{% endstep %}

{% step %}
Viewing company and its contacts is only possible after the user has explicitly taken action in the open offer — by clicking "View contact info" button.

<div align="left"><figure><img src="/files/8Y7IgjifuW568yDJUt5v" alt=""><figcaption></figcaption></figure></div>

Once opened:

* company information is displayed,
* the person responsible for the offer becomes visible,
* communicating is available via the platform's built-in messenger, also call and email buttons are displayed (without revealing the user's contact information);

<div align="left"><figure><img src="/files/vZKXD0HRxxgv84iRhRmG" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
When you open the responsible person's profile ("Profile details" section), contact information remains hidden; disclosure of contacts is possible only after activating the corresponding tariff plan.

<div align="left"><figure><img src="/files/N7iBS2Qz2nH1drwPZSMw" alt=""><figcaption></figcaption></figure></div>
{% endstep %}
{% endstepper %}

### Limits on viewing contacts in the offers

If you are company's owner or administrator, you can view the available number of company views in the offers by clicking "Settings" → "Plan and billing" in the dashboard.

* For company's owner or administrator:\
  click "Settings" → "Plan and billing" section → "Viewing offers and participating in bidding" block.
* For a company representative:\
  click "My plan" in the dashboard → "Viewing offers and participating in bidding" block.

<div align="left"><figure><img src="/files/1dfS7ytRZekARjPNVh5f" alt=""><figcaption></figcaption></figure></div>

### Access by tariffs:

Contact views and bidding participation:

* Free: Offer views and bidding participation - 30 offers (company-wide).
* Beginner: Offer views and bidding participation - 500 offers (company-wide).
* Pro / Expert / Enterprise: unlimited.

Each opened contact counts towards the monthly limit of the selected plan.

{% hint style="danger" %}
**Important!** The limit applies to the entire company and is used by all employees. View counters are separate:

* offer views and bid participation are counted separately,
* company and user contact views are counted separately.
  {% endhint %}

### What happens when the limit is reached?

If the view limit is reached:

* a notification will appear indicating the limit has been reached;
* to continue, you will need to upgrade to a higher plan or wait for a new month;
* if you are not company's owner or administrator, the system will prompt you to contact your company administrator.

{% hint style="danger" %}
**Important!** Opening contacts does not automatically make them visible in other sections (for example, company profile).
{% endhint %}


# Company creation

### Who can create a company?

Individual entrepreneurs and representatives of legal entities, organizations, companies, firms or enterprises can create a business account, i.e. Company, for free.

Roolz is a flexible system that can be used successfully by both individual entrepreneurs or large companies. Any employee of a company can create company profile on the platform and quickly invite their colleagues and management to join.

The creator immediately becomes the Owner of the company. Therefore, we recommend granting the right to create Roolz business account to the user with the appropriate responsibility.

Often, a logistician or purchaser starts using Roolz individually for their own transportation and invites colleagues later. Ultimately, the company will start to actively use Roolz platform. There are also many progressive managers who come and start a company themselves.

{% hint style="info" %}
You can create up to 9 companies with one user profile. Sometimes the company structure is such that one department serves different companies with completely different business processes.
{% endhint %}

### How to create a Company?

An interactive window to help you figure out how to do this (you can scroll through it):

{% @storylane/embed subdomain="app" linkValue="6iw5a1yduvae" url="<https://app.storylane.io/share/6iw5a1yduvae>" %}

### Text guide:

{% stepper %}
{% step %}
Click "Create company" in the upper right corner [on the exchange](https://roolz.net).

<div align="left"><figure><img src="/files/XZW2rQ2v0Le5DU7SOvGn" alt=""><figcaption></figcaption></figure></div>

{% hint style="info" %}
Additionally, you can add company logo for easy recognition in our companies directory.
{% endhint %}
{% endstep %}

{% step %}
You will be redirected to the company profile page, where you will be asked to fill in a minimum of required fields:

**Type of company\*** — company (legal entity, e.g. LLC) or entrepreneur (as individual entrepreneur);

**Company role in logistics**\* — carrier, freight forwarder, shipper;

**Brand name\*** — not a legal entity, but the name of your brand. For example, you are Euromarket LLC and your supermarket chain is called EuroFoods. Specify EuroFoods. The legal name is specified separately after the company is created;

**Registration country\*** — checklist;

**Company size\*** — only for companies as legal entities. Entrepreneurs do not need to fill this in;

**Shipments per month\* —** select the range of transportation from the list;

**Fleet size\*** — for carrier and freight forwarder roles only;

**Email\*** — your personal email by default, but it is better to replace it with the company email.

\*Required fields

<div align="left"><figure><img src="/files/cS313hQ3VbAHh4vhJkQs" alt="" width="375"><figcaption></figcaption></figure></div>
{% endstep %}
{% endstepper %}

This information is enough to create a company in the system, but for successful cooperation with other companies all other data should ideally be filled in, such as legal name, registration date, registration number, tax number (if any) and others.\
Administrators and the Owner of the company can add or modify this information by going to the "Settings" mode under the company name in the upper right corner of the freight and transportation search page in the "Company account" tab.

{% hint style="info" %}
How well your profile is filled out directly affects the number of responses to your freight or transport offers. The company card acts as a mini-version of your website that is indexed by search engines. Most platform participants decide whether to contact you based on your company profile.
{% endhint %}

<details>

<summary><strong>How many users can work within a single company?</strong></summary>

As many as you need. There's no limit.

</details>


# How to add details in your company profile?

{% hint style="info" %}
Only Administrators and the Owner of the company can modify and add company profile information.
{% endhint %}

To add or change data:

{% stepper %}
{% step %}
In the upper right corner of the page, click "Settings". This is your company-wide administration panel.

<div align="left"><figure><img src="/files/zUiFIMzrs7vhpGFxh8c2" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
On the "Company account" tab, click "Edit info".

<div align="left"><figure><img src="/files/u1uQG1525nW1PXBHrlIE" alt=""><figcaption></figcaption></figure></div>

Here you can add, change or delete information about your company such as:

* Company logo;
* Brand name\*;
* Type of company\*;
* Registration country\*;
* VAT/Tax number;
* Registration date;
* Registered address;
* Mailing address;
* Associations;
* Licenses.

\*Required fields

If you are a member of associations or have licenses, be sure to mention them to make your company's business profile more attractive and professional.

<div align="left"><figure><img src="/files/jRZp4etBtP3pYC2i6Jwy" alt="" width="375"><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Other information can be edited in the "Company profile" tab. Click the edit icon next to the company name.

<div align="left"><figure><img src="/files/anH7jc7JxusoouF1TELv" alt=""><figcaption></figcaption></figure></div>

Here you can specify:

* Company motto;
* Role in logistics\*;
* Shipments per month\*;
* Fleet size\* if you are a carrier.

\*Required fields

<div align="left"><figure><img src="/files/3CjnC4pCPqLAXxDOUmSX" alt="" width="375"><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
If you want to change company description, add information about new directions or logistics services, you can do it in the forms below.

{% hint style="danger" %}
**Note!** Providing directions will help your future customers and partners find you through the filters of the business directory.
{% endhint %}

{% hint style="danger" %}
**Note!** Want more feedback and new contractors? Fill out your company profile as detailed as possible. This will make your profile more attractive to both potential and current partners. According to our research, a well-filled company profile generates 40% more responses to freight offers and 160% more responses to transport offers.
{% endhint %}
{% endstep %}

{% step %}
On the right side, you can also change or add your company's contact information.

<div align="left"><figure><img src="/files/alJQr8A7o6y5jUHLO0Iw" alt=""><figcaption></figcaption></figure></div>

<div align="left"><figure><img src="/files/7SmRtoXUusXiRxBvyELb" alt=""><figcaption></figcaption></figure></div>
{% endstep %}
{% endstepper %}


# How to edit info in your company profile?

{% stepper %}
{% step %}
In the upper right corner, click “Settings” button;

<div align="left"><figure><img src="/files/Yye0YRbW2GHmzOZNPFK1" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
In the “Company account” block, click “Edit info” button;

<div align="left"><figure><img src="/files/0597hu3KN6MnAsi1ZXnh" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
In edit mode, you can change information such as:

1. **Company logo** — people trust companies with logos more;
2. **Brand name\*** — not the legal entity's name, but the name of your brand. For example, you are Eurotrade LLC, and your supermarket chain is called Euromarket. Please indicate "Euromarket." The legal name is specified separately after the company is established;
3. **Company type\*** — private company, entrepreneur (sole proprietor), partnership, publicly traded company, government organization, non-profit organization;
4. **Registration country\*** — displayed as the flag of the country where your company is located;
5. **VAT/Tax number;**
6. **Company registration date**;
7. **Registered address**;
8. **Mailing address**;
9. **Associations** — select from the list;
10. **Transport license** — check the box if applicable;
11. **Freight forwarding license** — check the box if applicable.

<div align="left"><figure><img src="/files/J9pDhrIoUVSh0oT70JZZ" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
You can also edit some of the data in the "Company profile" section. For example:

* Set or change cover photo. This appears on your company profile and is useful for increasing trust among other users and visibility through the company directory;&#x20;

  <div align="left"><figure><img src="/files/OLM7nxcYb4GYg0zlkHLt" alt=""><figcaption></figcaption></figure></div>

* Edit your motto, role in logistics, number of shipments per month and number of employees in the company using the button next to the company name;

  <figure><img src="/files/cfsVvTan8qKs47iszs7V" alt=""><figcaption></figcaption></figure>

* Check "Make public" checkbox to allow other companies to see your company in the company directory (by default, all companies are private and visible only when publishing offers or through your personal user profile);

  <div align="left"><figure><img src="/files/uwVaVnJJUufgD7AZYXtw" alt=""><figcaption></figcaption></figure></div>

* Add a brief description of the company: what it does, what services it provides, how many years it has been operating in the market, etc.

  <div align="left"><figure><img src="/files/OkGkejM3Ufd2I6aTHPzC" alt=""><figcaption></figcaption></figure></div>

* List the areas in which you work: international transportation and/or transportation within the country (countries);

  <div align="left"><figure><img src="/files/mCEEUZelw8n9290ru9VX" alt=""><figcaption></figcaption></figure></div>

* Specify logistics services your company provides: types of transportation, types of cargo, etc.

  <div align="left"><figure><img src="/files/FmH0aKLyc7KecHe3HMnS" alt=""><figcaption></figcaption></figure></div>

* Add or change contact information: company website, email and phone number;

  <div align="left"><figure><img src="/files/toYRIvmiVL96FrY9YaZX" alt=""><figcaption></figcaption></figure></div>

* You can also add a company representative. They will appear on your company profile and can be contacted by other users.

  <div align="left"><figure><img src="/files/88e5UoUOJgrbhVslTMYc" alt=""><figcaption></figcaption></figure></div>

{% endstep %}
{% endstepper %}

{% hint style="danger" %}
**Important!** The more detailed and accurate your company profile is, the greater your chances of finding more partners and being at the top of the platform's company directory.
{% endhint %}


# How to delete company?

How to delete a company on Roolz transportation management system. Available only to Administrators and Company Owners.

{% hint style="info" %}
Only Administrators and Company Owners can delete a company.
{% endhint %}

### To delete a company:

{% stepper %}
{% step %}
In the upper right corner of the page, go to the company's "Settings". This is your administration panel for the entire company.

<div align="left"><figure><img src="/files/k0dUdeO3I2pfsv7pXVM3" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
On the "Company account" tab, click "Edit info" button.

<div align="left"><figure><img src="/files/JdX0k49mvenHQukHHpdX" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Scroll to the very bottom and click "Delete".

<div align="left"><figure><img src="/files/EaPGrZ1d3i5F2CEciX1g" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Please be sure to specify the reason for deletion so we can improve our product in the future. Done!

<div align="left"><figure><img src="/files/QE0zMBPzVVwaBsyIeETe" alt=""><figcaption></figcaption></figure></div>
{% endstep %}
{% endstepper %}


# Company profile

### What is a company profile and why is it needed?

A company profile is a "business card" of your company on Roolz.

Most participants evaluate your company before responding to your freight or transport offer.

In addition, a well-filled profile allows you to advertise your organization for free in the companies directory. It will be more visible and will also be placed higher in the list where customers often look for new partners.

<div align="left"><figure><img src="/files/f5dUSlbaY7zTPuyzkzkY" alt=""><figcaption></figcaption></figure></div>


# Completed company profile

### When user profile is 100% complete, it displays such information as:

1. **Brand name\*,** not a legal entity, but the name of your brand. For example, you are Euromarket LLC and your supermarket chain is called EuroFoods. Specify EuroFoods. The legal name is specified separately after the company is created;
2. **Company logo,** if not set, a system logo is generated in the form of a random color with the first letter of the business name on it;
3. **Cover,** helps to stand out. If you don't have any ready-made covers, Roolz designers are always ready to help you create one for your company for free. Contact our support team at **<support@roolz.net>**.
4. **Short description,** like a slogan, which can be 255 characters maximum;
5. **Role in logistics\*,** carrier, forwarder-carrier, forwarder, shipper, shipper-carrier, dispatcher, customs broker, warehouse provider;
6. **Employees\*,** only for the companies;
7. **Fleet size\*,** for carrier roles only;
8. **Shipments per month\*,** for all roles except customs broker and warehouse provider;
9. **Associations,** checklist

<figure><img src="/files/E2sGaEZp9fxwuLL4TCE1" alt=""><figcaption></figcaption></figure>

10. **Long company description,** you must enter the information from "About" field;
11. **Type of company\*,** companies (like LTD), enterpreneurs (like SP);
12. **Transport license,** availability;
13. **Freight forwarding license,** availability;
14. **Contact information,** phone number, email\* and website;&#x20;

<div align="left"><figure><img src="/files/ECPkrkOczlRQ1bh48RNB" alt=""><figcaption></figcaption></figure></div>

15. **International transportation (to/from),** checklist;
16. **Domestic transportation,** checklist;
17. **Types of transportation,** road/maritime/air/railway/multimodal cargo transportation;
18. **Types of cargo and transportation,** checklist;
19. **Logistics services,** checklist;

<div align="left"><figure><img src="/files/chKYsgtBvpF3FTvSVhXn" alt=""><figcaption></figcaption></figure></div>

20. **Customs services,** checklist, with customs role in logistics only;

<div align="left"><figure><img src="/files/7VIqzvjzIyZ2j6Eb1qI1" alt=""><figcaption></figcaption></figure></div>

21. **Company (or sole proprietorship) legal data and credentials,** date of registration, registration number, full registered name, tax number, legal address, mailing address;
22. **Registration country\*,** checklist;

\*Required fields


# How do I change my company profile information?

{% stepper %}
{% step %}
In the upper right corner, click “Settings”

<div align="left"><figure><img src="/files/ukmUv41gzQOyH1dUbhd5" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
In the “Company account” block, click “Edit info”

<div align="left"><figure><img src="/files/GWIfigT4rCeno2kI2PlR" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
In edit mode, you can change information, such as:

1. **Company logo** - people trust companies with logos more;
2. **Brand name\***—not the legal entity name, but the name of your brand. For example, imagine you are Eurotrade LLC, and your supermarket chain is called EuroMarket. Please indicate "EuroMarket" in this field. The legal name is specified separately after the company is created;
3. **Type of company\*** — such as private company, entrepreneur (sole proprietor), partnership, publicly traded company, government organization, non-profit organization, etc.;
4. **Registration country\*** - displayed as the flag of the country where your company is located;
5. **VAT/TAX number**;
6. **Registration date;**
7. **Registered address;**
8. **Mailing address;**
9. **Associations** - selection from a list;
10. **Transport license** - check the box if applicable;
11. **Freight forwarding license** - check the box if applicable.

<div align="left"><figure><img src="/files/oFe6rjXdsjlYBneAuJTV" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
You can also edit some of the data in the "Company profile" section. For example:

* Set or change a cover photo. It appears in your company profile and is used to increase trust among other users and recognition through the company directory.

  <div align="left"><figure><img src="/files/io9ERFWBcDxVvpg66k1Q" alt=""><figcaption></figcaption></figure></div>

* Edit your motto, logistics role, number of shipments per month and number of employees using the button next to your company name.

  <div align="left"><figure><img src="/files/ktmtCNGZyaF7fwUYdAoW" alt=""><figcaption></figcaption></figure></div>

* Check "Make public" checkbox so other companies can see your company in the company directory (by default, all companies are private and visible only when publishing offers or through your personal user profile).

  <div align="left"><figure><img src="/files/ZW4rW81y0pmVLrWczgFS" alt=""><figcaption></figcaption></figure></div>

* Add a brief company description: what it does, what services it provides, how long it has been in business, etc.

  <div align="left"><figure><img src="/files/HnHqFGkRYM0cO7ruwzOv" alt=""><figcaption></figcaption></figure></div>

* List the directions that you work with: international and/or domestic shipping.

  <div align="left"><figure><img src="/files/nq5homGaE6Obv1Erwdey" alt=""><figcaption></figcaption></figure></div>

* List the logistics services that your company provides: types of shipping, freight, etc.

  <div align="left"><figure><img src="/files/ssHiOIVgCRDHG4FENNM3" alt=""><figcaption></figcaption></figure></div>

* Add or change contact information: company website, email and phone number.

  <div align="left"><figure><img src="/files/M5OseviGTzHDoXoKQ0LT" alt=""><figcaption></figcaption></figure></div>

* You can also add a company representative. They will be displayed in your company profile and can be contacted by other users.

  <div align="left"><figure><img src="/files/XOJKQhmDr1rddK7tz5oL" alt=""><figcaption></figcaption></figure></div>

{% hint style="danger" %}
**Important!** The more detailed and accurate your company profile, the greater your chances are of finding more partners and being at the top of the platform's company directory.
{% endhint %}
{% endstep %}
{% endstepper %}


# Can we make a private company public?

### Yes, you can! The "Make public" checkbox is selected by default.

<div align="left"><figure><img src="/files/ZAOgI4muHZJjUoXmOmT9" alt=""><figcaption></figcaption></figure></div>

However, if you removed it during registration and want to make the company public in the future, you can do this if you are the Administrator or the Owner of the company.

Follow these steps:

{% stepper %}
{% step %}
In the upper right corner of the page, go to "Settings". This is your company-wide administration panel.

<div align="left"><figure><img src="/files/LH2WfztA9ASoJUEbWs3C" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Click on "Company profile" in the left menu.
{% endstep %}

{% step %}
On the "Company profile" page, select the "Make Public" checkbox.

<div align="left"><figure><img src="/files/MkoBwFz1s8fRcSjQ49Qv" alt=""><figcaption></figcaption></figure></div>
{% endstep %}
{% endstepper %}


# Private and public profiles: what's the difference?

1. If the profile is public, other users can find it in the companies directory.\
   When profile is public, it gets additional advertising and customer exposure through the display in Roolz directory and browser search engines.
2. If profile is private, it will not appear in the companies directory, but it can be invited as a partner.

There are several ways to find a private company profile:

* By link;

<div align="left"><figure><img src="/files/u0Q3uSIY9bHz8FoXRKgj" alt="" width="375"><figcaption></figcaption></figure></div>

* Through your employee profiles, if you know them;

<div align="left"><figure><img src="/files/pl78l2EUdpT1mpD7Froz" alt="" width="375"><figcaption></figcaption></figure></div>

* Through published offers on the exchange.

<div align="left"><figure><img src="/files/aWMaXMwXKsK3z4ped08v" alt="" width="375"><figcaption></figcaption></figure></div>


# Hiding offers in your company profile

### What affects the displaying of offers?

Whether the offers (freight and transport) are displayed in the company profile depends on your pricing plan.

Full access to offers in other company profiles is available on the "Pro" plan and above.

After upgrading to the "Pro" plan, all previously hidden offers will become available.

<div align="left"><figure><img src="/files/tqISllFK8wM3dHWT95HW" alt=""><figcaption></figcaption></figure></div>

### How does offer displaying work?

* A list of offers is displayed in the company profile;
* For users with a plan lower than "Pro," offers from other companies are hidden;
* Only the number of offers is displayed, but no details.

<div align="left"><figure><img src="/files/s1dRRtS5No5YQwfDVsjJ" alt=""><figcaption></figcaption></figure></div>

{% hint style="danger" %}
**Important!** You can see all offers from your company and your profiles without restrictions.
{% endhint %}


# Inviting colleagues and the roles

### How to add users to a company?

{% hint style="info" %}
Only Administrators and the company Owner can add users to the company.
{% endhint %}

{% stepper %}
{% step %}
In the top right corner of the page, go to "Settings". This is your company-wide administration panel.

<div align="left"><figure><img src="/files/t4nyClUwaXKY2g9wtA8o" alt="" width="375"><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Click "Users" tab in the menu on the left.

<div align="left"><figure><img src="/files/cBLFCRUiE9yO3jAJrrY3" alt="" width="375"><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Click on the "Invite coworkers" button and select an invitation method.

<div align="left"><figure><img src="/files/Zt9HI36mEPhX6WUnRZDR" alt="" width="375"><figcaption></figcaption></figure></div>

{% tabs %}
{% tab title="FROM MY CONTACTS" %}
The search will help you find your coworkers among the existing Roolz users. We recommend that you use your coworker's unique Roolz nickname when searching. You can also search by email, phone number or first and last name.

<div align="left"><figure><img src="/files/zRkDp9cqSyeY4WChcbVq" alt="" width="375"><figcaption></figcaption></figure></div>
{% endtab %}

{% tab title="BY EMAIL" %}
You can enter multiple email addresses to invite as many coworkers as you want.

<div align="left"><figure><img src="/files/GlKNnfjkvQf5m2I0fmtX" alt="" width="375"><figcaption></figcaption></figure></div>
{% endtab %}
{% endtabs %}
{% endstep %}

{% step %}
Select the coworkers that you want to invite to the company and click on the "Invite" or "Invite coworkers" button. A window will pop up where you can specify the role of the invitee in the company:

* **Administrator** can create and post offers, edit company info and invite/remove users.
* **Member** can only create and post offers.

<div align="left"><figure><img src="/files/56PHAzTIA3FDSWiCHZV4" alt="" width="375"><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
When an invitation is sent, your employee can accept or decline it.

<div align="left"><figure><img src="/files/FqXvXZ23WB5b2qoIiYvH" alt="" width="375"><figcaption></figcaption></figure></div>

If the invitation is declined, you can see this in the list of sent invitations.

<div align="left"><figure><img src="/files/lgfcJKFOC0KFiBiMBEpk" alt=""><figcaption></figcaption></figure></div>

If the invited employee is not registered on Roolz, they have to register on the platform after accepting an invitation (by clicking on the button in the email). They will only be considered a member of the company after the registration.

<div align="left"><figure><img src="/files/3hblGIOwbirCKrXEyUcX" alt="" width="375"><figcaption></figcaption></figure></div>
{% endstep %}
{% endstepper %}


# Switching company spaces

### If you have multiple companies and don't know how to switch between them:

{% tabs %}
{% tab title="PC version" %}

* In the upper right corner, next to your profile picture, you will see your active space (a colored circle with 2 letters if you don't have photo).
* If you see "Create company", you are in your personal space and are not a member of any company. You can create a company and invite your colleagues to join you for more productive work.
* If you are a member of the company, click on the down arrow icon. When the list of your spaces expands, click on the company, which space you want to enter.
* In addition to company spaces, there is also a personal space where the user acts as an individual. To act as an individual, select "Personal space".

<div align="left"><figure><img src="/files/enm8FMOauHmNWlgqv98m" alt="" width="375"><figcaption></figcaption></figure></div>
{% endtab %}

{% tab title="Mobile version" %}

* Click on the menu button in the top left corner. At the top of the page, your active workspace will be displayed. If you see "Create company" button, you are in your personal space and are not in the company. You can create a company and invite people to join you to be more productive.

<div align="left"><figure><img src="/files/sifQ6lafLFvuLNcs7PVW" alt="" width="375"><figcaption></figcaption></figure></div>

* If you are a company member, click on the down arrow icon.

<div align="left"><figure><img src="/files/8k0sn3OV4MbS3e4RQzKE" alt="" width="375"><figcaption></figcaption></figure></div>

* When the list of your spaces expands, click on the company, which space you want to enter.

<div align="left"><figure><img src="/files/6n1Ukao4n7YqV0k43EMA" alt="" width="375"><figcaption></figcaption></figure></div>
{% endtab %}
{% endtabs %}


# Company verification

### Do you check companies? How can I be sure the counterparty is reliable?

Most frequently, the verification status is required to work on a public exchange when organizing transportation between unfamiliar or unknown companies. Most shipments on Roolz take place within the private exchange among trusted and familiar partners.

In addition, participants can work on the platform without verification due to for the following reasons:

1. Participant has not submitted a verification request;
2. Participant does not pass the verification criteria;
3. We cannot sufficiently verify a company or entrepreneur due to the lack of necessary information about the company and the lack of reliable sources of verification. This usually happens due to the specific country of registration of the company or entrepreneur.

Roolz is an open and free platform where different companies from many countries can join. You choose who you want to work with and how.


# Working in the company space

<details>

<summary><strong>What are the company's users roles?</strong></summary>

* **Owner**. There can be only one user who has all rights of Administrator and Member and also has the exclusive right to delete the entire company. There is always the Owner in the company, and there can be only one.
* **Administrator**. Has access to the company administration panel, where you can edit company's data, invite and delete company members except for the Owner.
* **User**. Does not have access to the administrator panel. Therefore, they cannot edit company's data or manage the list of company members. User has access to the company's space and can act on behalf of the company on the exchange. This role is usually held by most employees.

</details>

<details>

<summary><strong>How do I assign and remove an Administrator role?</strong></summary>

When you send an invitation, specify the invitee's system role in your company: Administrator or Member.&#x20;

To remove Administrator rights, you must remove the participant from the company and send a new invitation with the system role "Member".

<img src="/files/lMqKsrXECaj1BTKAewoF" alt="" data-size="original">

</details>

<details>

<summary><strong>What rights do the Administrator and the Owner have?</strong></summary>

The Owner and Administrator have access to the company's administration panel, where they can edit account and company profile data, as well as invite and remove users.

<img src="/files/beCloVGNog6b9795IwVZ" alt="" data-size="original">

❕**Note.** The Owner has exclusive rights to delete the company from the system. Every company on Roolz always has the owner, and there can be only one.

</details>

<details>

<summary><strong>How many Administrators can a company have?</strong></summary>

The number is unlimited. Note that the Owner has all rights of the Administrator. There is always the Owner in the company and there is only one.

</details>

<details>

<summary><strong>Do I see offers from my colleagues in the company profile?</strong></summary>

Yes, but only public offers. Private offers are not displayed in the company profile for greater security and privacy.

You can view your colleagues' offers on "My offers" page. Make sure you are in your company's space.

</details>

<details>

<summary><strong>Will I be able to place offers on behalf of my coworkers?</strong></summary>

Yes, this feature will be available soon. When you create an offer, you will be able to assign the responsibility for it to your colleague. You will also be able to change the assigned responsible user on existing offers that have not been archived.

<img src="/files/PSgtr74o3eKr3UQBBYkw" alt="" data-size="original">

</details>


# All you need to know

### What is companies directory? What companies are there and how to find them?

**Companies directory** is a database of all companies on Roolz, which profiles are public.

The companies directory includes both large organizations and entrepreneurs of all roles: shippers, carriers, forwarders, dispatchers, customs brokers, warehouse operators.

Roolz unites companies that organize, implement and maintain transport logistics. In the companies directory, many users find regular transportation partners and work with them on [a private exchange.](/en/private-exchange-partnerships)

Searching for new shippers and carriers is particularly convenient, as there are advanced search filters by company's roles, size, services provided, types of transported goods and route directions.

<div align="left"><figure><img src="/files/nRQJ6W12xaES25N2lhDR" alt=""><figcaption></figcaption></figure></div>

### How to find company in the directory?

{% stepper %}
{% step %}
In the companies directory, click on the "Filter" button located to the right of the search bar.

<div align="left"><figure><img src="/files/pOzNaSLk4IE6KsaALYTL" alt="" width="375"><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Use categories to search by roles, modes, services and types of transportation. For example, if you are looking for freight forwarders, go to the "Freight forwarders" category. You can then select the country you are interested in, such as "Carriers in Italy", for example.

<div align="left"><figure><img src="/files/zI6D5aEwsTRQ1o7wHAcN" alt="" width="375"><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Find companies that best meet your needs in terms of references, company size and other requirements with flexible filters across many fields.

<div align="left"><figure><img src="/files/0Pa3euIhEmEWY1MTnZkR" alt="" width="375"><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Searching by name helps you quickly find companies you already know. Companies prefer to use their brand in the company name.

<div align="left"><figure><img src="/files/lWhb2w7Mlxi085vi1RWK" alt="" width="375"><figcaption></figcaption></figure></div>
{% endstep %}
{% endstepper %}

### How to view and contact people listed in my company profile?

{% stepper %}
{% step %}
Open the profile of the selected company.

<div align="left"><figure><img src="/files/wEUon6PffrTfdXWUKmWj" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
In the "Main" section you will find "Contact Information" field, which contains the list of company representatives.

<div align="left"><figure><img src="/files/xeBokKRbMOUIO3xJMu6j" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Write to a company representative via messenger. You can also open user's profile and see other ways to contact them.

{% hint style="danger" %}
**Note!** Some companies do not display their representatives on the exchange.
{% endhint %}
{% endstep %}
{% endstepper %}


# The information displayed in the profile

**Company profile** is a "business card" of your company on Roolz. A well-filled profile allows you to advertise your business for free in the companies directory (it will be placed higher in the list and will be more visible), where shippers often look for new carriers and forwarders.&#x20;

In the directory, company information is briefly presented with a profile card where you can fill in the following fields:

* Company name;
* Logo;
* Motto;
* Company role;
* Public offers amount;
* Fleet size (for carriers);
* Company size.

Once you click on the card, [the company profile](/en/companies/company-profile) will open.

<div align="left"><figure><img src="/files/oorodGnFomOCbfIoncve" alt="" width="375"><figcaption></figcaption></figure></div>


# Criteria for searching companies in the directory

In the "**Companies"** section, you can search for carriers, shippers, and partners using various filters. The very first filter is search by company's name. Simply enter the name you're looking for.

<div align="left"><figure><img src="/files/iiS5SO8S7W8Lexhny5m1" alt=""><figcaption></figcaption></figure></div>

In the upper right corner, there's a **"Filter"** button for advanced searches of companies based on various criteria. You can search by Role, Service, or Category.

<div align="left"><figure><img src="/files/VDAlfqhAc7nPtqBmsebZ" alt=""><figcaption></figcaption></figure></div>

By switching to the **"Filter"** button, you can search by the following criteria:

1. **Company role in logistics,** carrier, forwarder-carrier, forwarder, shipper, shipper-carrier, dispatcher, customs broker, warehouse provider;
2. **Fleet size,** for carrier roles only;
3. **Company size,** only for companies. Entrepreneurs do not need to fill this out;
4. **Modes of transportation,** road/maritime/air/railway/multimodal cargo transportation;
5. **Country of registration,** checklist;
6. **Shipments per month,** for all roles except customs broker and warehouse provider;
7. **Types of cargo and transportation,** checklist;
8. **Logistics services,** checklist;
9. **Customs services,** checklist, with customs role in logistics only;
10. **International transportation,** checklist;
11. **Domestic transportation,** checklist;
12. **Business type,** companies (like LTD), enterpreneurs (like SP).

<div align="left"><figure><img src="/files/G82Vjm7hZEmN7McXxJdM" alt="" width="375"><figcaption></figcaption></figure></div>

{% hint style="warning" %}
**Important!** If you want to find, for example, a **Carrier** that serves specific destinations (countries), click **Categories → Carriers → Filter**. On the right, you'll see a list of destinations (countries), from which you can select the desired option.

<img src="/files/FTSEJQmlDvuIalX8GpjR" alt="" data-size="original">

If you want to filter by the carrier's **Country of registration** (for example, Hungary), click:\
**Categories → Carriers → Filter → Carriers in Hungary → Filter → Local Only**

<img src="/files/n7hH6FzSoq8quzWTQamh" alt="" data-size="original">
{% endhint %}


# How to promote your company in the directory

Companies with a large number of published and up-to-date offers are always displayed on the top.

To promote your company in the directory, we recommend:

1. To list all your freight and available vehicles on the public exchange.
2. To fill in your company profile and add a cover photo. This will help you stand out.

<div align="left"><figure><img src="/files/LyvGBGpjxGvqixGUe5LQ" alt=""><figcaption></figcaption></figure></div>

{% hint style="info" %}
If you don't have any ready-made covers, Roolz designers are always ready to help you create one for your company free of charge. Contact our support team at **<support@roolz.net>.**
{% endhint %}


# Public vs private exchange: the difference

**Public exchange** is an open platform that helps shippers and carriers find each other quickly and conveniently for cooperation in freight transportation. As a rule, public exchange organizes spot transport, i.e. short-term and one-time offers without concluding a long-term contract.

**Private exchange** is a closed platform where you can search, offer and organize transport among your trusted partners in a private, comfortable and transparent way. Private exchange also allows you to systematically and centrally develop and control your base of contractors and customers in freight transportation. Private exchange is dedicated to cooperation with regular and trustworthy partners. It is usually used for contract logistics.

<div align="left"><figure><img src="/files/MDFlickdT6kvUWSqDUQk" alt=""><figcaption></figcaption></figure></div>


# Vehicle search

### How to search for vehicle?

There are 2 ways:

1. **Automatic**. Publish your freight offer and the system will automatically start searching and selecting suitable vehicle offers. Once they're found, you will receive a notification to your email with a list of suitable offers. You can click on any offer to view it in full. Similarly, carriers will also see that your freight is suitable for them.
2. **Manual**. Open "Search freight and transport" page, switch to the "Vehicle" tab above the search bar.

<div align="left"><figure><img src="/files/D184oTwm0O0x7wGmIwwM" alt=""><figcaption></figcaption></figure></div>

The search with filters is also available on the private exchange on the sent and received offers page.

In addition to searching with filters, you can find vehicles in:

* **User profile**. If a user posted public offers, these will be displayed in their profile. You do not need to write and disturb the person unnecessarily while others do not need to distract you.

{% hint style="info" %}
Roolz allows its users to maintain both a corporate database of business partners and customers as well as a personal one. You can add users to your contacts, just like to your work phonebook.
{% endhint %}

* **Company profile**. If a company posted public offers, they are displayed in the company's profile.

There is also a feature called "Partners selection".

If you are a shipper and only work with trusted partners but want to find new ones, you can publish duplicates of your private offers on the public exchange.

And if you are a carrier, partner selection offers are a great way to get into the customer's private exchange.


# Freight search

### How to find freight?

There are 2 ways:

1. **Automatic**. Publish your vehicle offer and the system will automatically start searching and selecting suitable freight. When loads are found, you will receive an email notification and you will be able to view the offers provided by the system. Shippers will also see that your vehicle is suitable for them.
2. **Manual**. Open "Search freight and transport" page, switch the button above the search form to "Freight" mode.

<div align="left"><figure><img src="/files/qJeOkkhJcQZGEv5Uxfn7" alt=""><figcaption></figcaption></figure></div>

Indicate where you can to pick up the shipment and where you can deliver it. You can enter names of towns, areas, regions and countries. Such filters are also available on the private exchange on the pages of sent and received offers.

Besides filter searches, you can also do it through:

* **User profile**. If a user posted public offers, these will be displayed in their profile. You do not have to write and disturb the person unnecessarily and others do not have to distract you.

{% hint style="info" %}
Roolz allows its users to maintain a corporate database of business partners and customers as well as a personal one. You can add users to your contacts, just like in your work phonebook.
{% endhint %}

* **Company profile.** If a company posted public offers, they are displayed in the company profile.

There is also a feature called "Partners selection".

If you are a shipper and only work with trusted partners but want to find new ones, you can publish duplicates of your private offers on the public exchange.

And if you are a carrier, partner selection offers are a great way to get into the customer's private exchange.


# Automatic matching of freight and transport offers

### What is an automatic matching?

**Automatic matching of offers** is a system feature that allows you to save your time through automatic search and selection of suitable freight or vehicle for your offer.

Only offers with "Published" status participate in automatic selection.

The auto-selection results are updated every 2-5 minutes, i.e. after publishing your offer, the first auto-selection result may appear in 5 minutes.

Comparison of freight and vehicle offers is carried out using neural networks (AI) according to the following criteria, which may sometimes differ (automatic selection for the best result):

1. **Exact match:**

* **Loading**. The loading location of the freight offer must include the loading location of the vehicle offer or vice versa.

  For example, loading is indicated in Istanbul, and this city is included in the area that is indicated in the vehicle offer as the loading region.
* **Unloading**. The final loading point in the freight offer must coincide with or be included in the location of one of the transport delivery directions (there can be up to 15 of them) or vice versa.

  For example, in freight offer the last unloading is Istanbul, and in transport one of the directions is Turkey.
* **Loading time**. The first loading time must overlap with the time when the transport is ready for loading.

  For example, the loading period is from the 13th to the 15th, and the transport is ready for loading from the 14th.
* **Type of transportation**. If the types of transportation in the cargo and transport are specified, they must match.

  For example, an FTL load that requires an entire truck to be transported will not match a vehicle that is only looking for less than full truck loads (LTL).
* **Vehicle category**. If a requirement is specified in the freight offer, it must match the vehicle category.

  For example, the load for a truck will not match transport that has the category of light van (LCV up to 3.5t).
* **Truck body type**. One of the body types in the freight offer must match the corresponding value in the vehicle offer.

  For example, a load that requires a timber truck will not match a fuel truck.
* **Weight**. The tonnage of the vehicle must be sufficient to carry the weight of the cargo.

  For example, a load that weighs 18 tons will not match a transport that indicates a free tonnage of 12 tons.
* **Volume**. The free cubic volume of cargo space must be able to accommodate the volume of cargo.

  For example, a load with a volume of 90m³ will not match a vehicle with a body volume of 20m³.
* **Temperature conditions**. The temperature requirements of the cargo must fully fall within the range of the temperature conditions of the transport.

  For example, cargo with a minimum temperature of -15°C will not match transport with a minimum temperature of -5°C.
* **Cargo hazard**. If cargo is dangerous, then hazard class must correspond to one of the ADR classes in transport.

  For example, cargo with hazard class 4 will not match transport where ADR class 9 is indicated.
* **Loading type**. If cargo and transport indicate loading types, one of the loading types must match one of the types in the transport.

  For example, cargo that requires top loading/unloading will not match a vehicle that has a rear loading type.

2. **Partial matches** are freight and vehicle offers that do not fully meet the exact match criteria,

   but may potentially be suitable for transportation. Partial search criteria have been expanded to include the following fields and data:

* **Loading**. If transport specifies location and radius, the radius is increased 2x times.

  For example, if transport indicates a radius of 15 km, then the radius is increased to 30 km.
* **Type of transportation**. The specified values of freight and transport offers are ignored.

  For example, there is currently no LTL option for cargo on the market, but there are FTL carriers, with whom you can negotiate.
* **Vehicle category**. The specified values in freight and vehicle offers are ignored.

  For example, the cargo indicates double-trailer, but there are no such offers on the market, however, there are 2 trucks that are fully suitable according to other criteria.
* **Truck body type**. If not a whole group of body types is chosen in the freight offer, then the entire group gets selected.

  For example, freight offer indicates curtainsider, but it can also most likely be transported in a refrigerator with the temperature control turned off or in an all-metal body.
* **Loading type**. The specified values in cargo and transport are ignored.

  For example, right now there is no suitable transport on the market with loading from both sides, but in general, loading cargo from one side is possible.


# Freight offers

### What is an Offer?

**An offer** is an offering or request for a freight transportation service. Shippers publish their freight and carriers publish their transport. When your offer is published, the system automatically searches for offers that match your offer. Users can view published offers as well as publish their own.

There are 2 types of offers:

1. **Freight**. You are a shipper and are looking for carriers.
2. **Vehicle**. You have free transport and you are looking for a freight transportation offer.

<div align="left"><figure><img src="/files/DoBZ5rkzpJDbV43IrBo0" alt="" width="375"><figcaption></figcaption></figure></div>

All offers can be public and private. This is regulated using checkboxes when creating an offer.

<div align="left"><figure><img src="/files/V0ScXdlIRxrcRWVivvVE" alt="" width="375"><figcaption></figcaption></figure></div>

Also, if you placed an offer privately, then your offer will only be visible to you and your partners from the [private exchange](/en/private-exchange-partnerships); such offers will be indicated as "Private".

<div align="left"><figure><img src="/files/sAgMoNV7suOhkuMUQ66O" alt=""><figcaption></figcaption></figure></div>

Here is an interactive window to help you understand how this works (you can scroll through it):

{% @storylane/embed subdomain="app" linkValue="mirm919gmtxu" url="<https://app.storylane.io/share/mirm919gmtxu>" %}

### Text guide:

{% stepper %}
{% step %}
Click "Create an offer" in the upper left corner of the screen.
{% endstep %}

{% step %}
Select "Freight" to create a freight offer.
{% endstep %}

{% step %}
Select which contact methods will be displayed when opening an offer: phone number and/or email address. You can select both or just one. Both cannot be removed at the same time.
{% endstep %}

{% step %}
Please provide the name of your freight (e.g. "lumber", "glass containers", etc.). This field is optional.
{% endstep %}

{% step %}
In the "Cargo type and package" field, you can indicate to the carrier how your cargo will be packaged.

Once the desired type has been selected, "Cargo quantity" field will appear. Here you can specify the number of pallets, boxes, barrels, etc., that you want to transport.

{% hint style="info" %}
If you do not know the type of packaging, skip this field. If the type you need is not in the proposed list, specify your special type of cargo or packaging in the comment to the offer.
{% endhint %}
{% endstep %}

{% step %}
Please indicate the weight of cargo in tons and its exact or approximate volume (these fields are mandatory).
{% endstep %}

{% step %}
Please indicate the hazard class of the cargo, or skip this field if your cargo is not hazardous; "not dangerous" is set by default.
{% endstep %}

{% step %}
Also, if desired, indicate the length, width and height of the transported cargo in the package or the parameters of the free volume of the vehicle that you require. These fields are not mandatory.
{% endstep %}

{% step %}
If you need to maintain a certain temperature of the cargo during its transportation, check the "Temperature control" box. Then you can specify the minimum and maximum values of the temperature range.
{% endstep %}

{% step %}
In the "Transportation Requirements" section, select the type of transportation (dedicated transport, partial load, oversized cargo or any), body type (required field) and any additional options required.

In the "Shipping mode" field, select the type that you need. There can only be one: FTL, LTL or project transportation.

{% hint style="danger" %}
**Important!** When selecting **FTL** or **Project Transportation**, an additional field will appear where you can specify the number of vehicles required for the shipment.
{% endhint %}

Specify "Vehicle category".

Specify «Truck body type». This field is obligatory, the list of options offered in this field depends on your selection in "Vehicle category". You can specify either a group or groups of types, such as "Closed", for example, or a specific type.

If necessary, please provide additional information in the "Note" section.
{% endstep %}

{% step %}
In the "Rate and payment" section, select offer publication mode: "Bargain", "Auction", "Fix" or "Ad".\
\*Bidding mode is how you accept bids from carriers.

Select "Bargain" if you want to receive offers on terms and rates of transportation. Please indicate whether you are willing to accept bids from participants operating under a taxation system different from the one you are offering.

Select "Auction" if you want to select winning bids at the best cost.

Select "Fix" if you want to set your own shipping price. If you don't want to choose between offers and speed is important to you, check "Book now" box. Then the first person to submit a bid on your offer will automatically be the winner.

Select "Ad" if you offer a flat rate or prefer to negotiate shipping terms and costs individually.
{% endstep %}

{% step %}
Next, select or specify the time you give the winner to confirm their bid (during this time, the winner must confirm their intention to pick up and transport your cargo; the maximum possible period is 168 hours).
{% endstep %}

{% step %}
Proceed to the payment section where you can specify your desired terms and conditions.
{% endstep %}

{% step %}
Specify payment terms ("By original documents", "By copies of documents", "On delivery", "Other conditions").
{% endstep %}

{% step %}
Select payment method ("Bank transfer", "Cash", "Card", "Mixed", "Other method").

{% hint style="info" %}
If the payment method that you need is not listed, please indicate it in the comments.
{% endhint %}

If you offer a pre-payment, indicate the amount as percentage of the total cost of transportation.
{% endstep %}

{% step %}
Click "Open additional options" arrow, where you can select "Delayed bidding start" checkbox if you want bidding to start at a specific time. Click this checkbox to set starting time and duration.

If you select "Auction" bidding mode, you will also have access to another feature: "First bid can be any amount" This allows the bidder to place the first bid at any price, with no increment or current best bid restrictions. This lowers the barrier to entry, helps gather bidders faster and maintains fair conditions: bidding data can be viewed only after the first bid.

{% hint style="danger" %}
**Important!** This feature is available to companies on the **Pro, Expert** and **Enterprise** plans and works on both public and private exchange. It is not available to **Beginner** and **Free** plans or to **individuals**.
{% endhint %}
{% endstep %}

{% step %}
Next, in the "Access and privacy" section, select where you want to place your offer:

* **Only on public exchange.** Placing a freight offer on a public exchange allows all Roolz participants to view and respond to it.
* **Only on private exchange.** Placing a freight offer on a private exchange only allows your partners to view the offer and respond to it.
* **On both public and private exchange.** Select both placement options if you want to make the offer available to the current partners as well as to attract the attention of other participants. In this case, when publishing an offer in "Bargain" mode, your partners and public exchange participants will see each other's bids in the offer itself.
* **Duplicate on the public exchange.** Select private exchange placement and 'Duplicate on public exchange" option if you want to post an offer on both private and a public exchange. In such way participants in different spaces do not see each other's bids. This option allows you to post the main offer on the private exchange and the connected one on the public exchange.

{% hint style="danger" %}
**Important!** If "Partner Selection" and "Duplicate on a Public Exchange" checkboxes are selected, the "Delayed Bidding Start" feature will not work.
{% endhint %}
{% endstep %}

{% step %}
Specify the route, i.e. date, time, loading and unloading points and methods.

Loading and unloading points may be populated areas, districts, regions and countries.

{% hint style="info" %}
If your address is not on the list, try expanding the geography to the area, and indicate the exact location that you need in the comment to the offer.
{% endhint %}

If your route involves additional loading, unloading, customs clearance or travel through a specific location, you can specify this as well as the date, time and the location of the additional stop, by clicking "Add a waypoint" between the "Pickup" and "Delivery" sections.
{% endstep %}
{% endstepper %}


# Bidding modes for freight offers

Unlike transport offers that are always ads, freight offers have 4 bidding modes:

<div align="left"><figure><img src="/files/W12X231JdoNiwtZKjVdI" alt="" width="375"><figcaption></figcaption></figure></div>

### Ad:&#x20;

* The "old-fashioned"‎ offer mode;
* Cannot accept bids;
* Potential counterparties can contact you via messenger, phone number, email and other contacts methods specified in your profile.

<div align="left"><figure><img src="/files/y2sWKnyi8kSm6XnisRoB" alt=""><figcaption></figcaption></figure></div>

### Bargain:&#x20;

* Bargain is the most fair and flexible bidding mode when both cost and transportation conditions matter;
* The bidder has 4 statuses for their active bid: "Best", "Among the best", "Mid" and "Losing";
* Each user can make an unlimited number of bids, but only the last bid will always be active;
* Even if the user is a member of several companies, they can also submit an unlimited number of bids;
* The price specified in the offer is a guideline for the participants in the bidding;
* You decide the winner yourself.

<div align="left"><figure><img src="/files/9IONe5vlkAaeKRul994R" alt=""><figcaption></figcaption></figure></div>

### Auction:&#x20;

* A mode, where each participant can offer their own bid;
* Suitable when you only care about the cost of transportation;
* The lowest bid wins automatically when the auction duration time ends;
* You can select the winner manually and the offer will be marked as "Winner selected manually";
* If the offer does not specify the price, then the first bid is set according to the initial bid;
* If the price is specified in the offer, the first bid must either match this price or be lower;
* There are 2 statuses of active bids in the auction: "Best" and "Outbid";
* All subsequent bids must differ from the current best by the minimum step specified by the shipper when creating an offer.

<div align="left"><figure><img src="/files/XmX0ObUBosc2Vl9QBUwt" alt=""><figcaption></figcaption></figure></div>

### Fix:&#x20;

* Offer mode, where each participant competes for transportation by offering transportation conditions;
* The cost of transportation is fixed and is set by the owner of the offer;
* When you have a fixed price for transportation, no one can negotiate on the price;
* If "Book now" setting is not disabled, then fix allows you to conduct competition between participants, but only on the terms of transportation;
* This mode is ideal for holding a competition among your carriers with a single contract price.

<div align="left"><figure><img src="/files/BjXmvtTXoMecfGMAU6Ju" alt=""><figcaption></figcaption></figure></div>

#### *Fix with the indicator "Book now".*

This function is used in two cases:

1. The first one to agree wins the transportation deal;
2. If you only sent an offer to one partner, then it is a direct assignment of the offer to the partner,

   as in the case of a contract plan.

<div align="left"><figure><img src="/files/mKCyrLBJJrpBcbwsy0rB" alt="" width="375"><figcaption></figcaption></figure></div>


# Vehicle offers

### What is an offer?

**An offer** is an offering or request for a freight transportation service. Shippers publish their freight and carriers publish their vehicles. When your offer is published, the system automatically searches for offers that match your offer. Users can view published offers as well as post their own.

There are 2 types of offers:

1. **Freight**. You are a shipper and are looking for carriers.
2. **Transport**. You have free transport and you are looking for a freight transportation offer.

<div align="left"><figure><img src="/files/DoBZ5rkzpJDbV43IrBo0" alt="" width="375"><figcaption></figcaption></figure></div>

All offers can be public and private. This is regulated using checkboxes when creating an offer.

<div align="left"><figure><img src="/files/jJCNphkPlAKzhhzBcFY2" alt="" width="375"><figcaption></figcaption></figure></div>

Also, if you placed an offer privately, then your offer will only be visible to you and your partners from the [private exchange](/en/private-exchange-partnerships); such offers will be indicated as "Private".

Here is an interactive window to help you understand how this works (you can scroll through it):

{% @storylane/embed subdomain="app" linkValue="4cv5judebigg" url="<https://app.storylane.io/share/4cv5judebigg>" %}

### Text guide:

{% stepper %}
{% step %}
Click on the "Create an offer" button in the upper left corner.
{% endstep %}

{% step %}
Select "‎Vehicle".
{% endstep %}

{% step %}
Fill in the description of your transport:

**Vehicle category\*,** select one value from the list: light van (LCV; up to 3.5t), truck (from 3.5t to 12t), semi-trailer truck, double-trailer (truck or semi-trailer with 2 cargo bodies/trailers), special machinery.

**Truck body type\*,** select one value from the list, and if the vehicle category is double-trailer, then 1 or 2.

**Transportation type,** select one or more values from the list: FTL (dedicated transport), LTL (less than full load), oversized/project transportation.

**Tonnage\*,** enter a value from 0.01 to 999,999.99. When you are looking for additional loading (i.e. additional cargo) then specify free available tonnage (in tons).

**Volume\*,** enter a value from 0.01 to 999,999.99. When you are looking for additional loading (i.e. additional cargo) then specify free available body volume.

**Body options and features,** select one or more values from the list, for example, hydraulic manipulator.

**Loading methods,** select one or more values from the list: rear, one side, both sides, racks removed, top, full tilt dismantling. Especially relevant for the curtainsider body type.

**ADR: transportation of dangerous goods,** select classes of dangerous goods that you can transport.

**Length, Width, Height of cargo,** specify the dimensions of the cargo. Especially useful if you have a non-standard body size.

**Trailer interchange,** check this box if you are ready to do trailer interchange taking into account the provision of a trailer.

{% hint style="info" %}
If you are ready to provide the service of trailer interchange without a trailer, that is, to provide a vehicle (the «‎head»‎ itself), then in the body type indicate "‎Truck with driver".
{% endhint %}

**Temperature control,** if your vehicle is adapted for transporting temperature-sensitive cargo, specify the minimum and the maximum temperature. Multi-temperature mode can be specified in the options and body features.

Optionally, provide a text note, e.g. about insurance, country of vehicle registration, additional conditions of transportation, possible services, etc.

Optionally, specify the cost per kilometer. If you do not specify the cost, it will be displayed as negotiable.

\*Required fields.
{% endstep %}

{% step %}
Specify directions:

Specify the region where you are ready to pick up\*, i.e. a city, a region, or a specific location with a radius. Be sure to specify the range of dates and times when your transport is available to accept an offer. You can specify an open date, for example, "‎From today" until the moment the offer is accepted.

Specify delivery directions\*, i.e. cities, regions and countries where you are ready to deliver the cargo. You can specify up to 15 delivery directions.

\*Required fields.

{% hint style="danger" %}
**Note!** At least one direction must be specified.
{% endhint %}
{% endstep %}

{% step %}
Specify where the offer will be published (i.e. to whom it will be available) at the bottom of the page:

**Public exchange,** your offer will be publicly available and will be visible to all exchange users.

**Private exchange,** your offer will only be seen by your company's specified partners. By default, all partners are selected, but you can select specific ones. No one except for you, your company's employees and the partners selected as recipients of the offer will be able to find and view private offers.

**Both exchanges,** you need to tick both private and public exchange checkboxes. Your offer will be placed on both public and private exchange at the same time. The offer is subject to the rules of the public exchange, meaning that any user and visitor of Roolz platform will have access to your offer. In this case, the specified recipient partners will see your offer on their private exchange page in the received offers in addition to the general search for cargo and transport.
{% endstep %}

{% step %}
Publish the offer. When the offer has "‎Published"‎ status, other exchange participants will be able to find it.
{% endstep %}
{% endstepper %}


# Offers: editing, activity and statuses

### How long will the offer be active?

{% tabs %}
{% tab title="Freight offer" %}

* Freight offer is active and has "‎Published" status on the exchange until the end of the first loading time specified in the offer. For example, if the first loading is from the 13th to the 14th day of the month at 16:00, then the offer will be automatically removed from publication on the 14th at 16:00.
* When creating an offer, you can also specify your own duration of the offer publication, but upon reaching the last time of the first loading, the offer will still be removed from publication.
  {% endtab %}

{% tab title="Vehicle offer" %}
Transport offer can have:

* Specific dates or date range. For example, you specify that transport will be able to accept an offer from the city that you need only on the 17th. In this case, the offer will be automatically removed from publication on the 17th at 23:59.
* Open dates, i.e. when the period of possibility to accept the order is not limited. The time is specified as "From today" and until the moment of receiving the offer. This option is convenient when carrier has a fleet of vehicles in the specified directions to search for offers constantly.
  {% endtab %}
  {% endtabs %}

{% hint style="danger" %}
**Note!** Your transport and freight offers can be removed manually by you when your offer becomes irrelevant. Also, an offer can be automatically removed from publication when it receives many complaints or remains published for a long time although you did not log in to the system. Such mechanisms are needed to prevent offers from being on the exchange (in the "‎Published"‎ status) when they have actually lost their relevance (for example, they were forgotten)
{% endhint %}


# Files in the offers

Attaching files to the offers saves time and reduces the risk of misunderstandings between the bidders. Here we explain the benefits of this feature and how it works.

### What is it?

**Files in the offers** feature allow you to attach documents, photographs, diagrams and other materials directly to the offer. It is useful to ensure all transportation details are recorded precisely and to avoid unnecessary additional clarifications, delays and risks of misunderstanding between the bidders.

### What files can be attached?

You can attach up to 15 active files to your offer, each up to 35 MB in size.

The following formats are supported:

* Spreadsheets: CSV, TSV, XLSX, XLS, ODS
* Documents: PDF, DOC/DOCX, ODT, RTF, TXT
* Images: PNG, JPG/JPEG, TIFF, HEIC, SVG
* Presentations: PPT, PPTX
* Videos: MP4, MOV
* Archives: ZIP, RAR

{% hint style="info" %}
If there are more than two files, “Download archive (.zip)” button will appear.
{% endhint %}

### What are the benefits of this feature?

* Allows you to store all transportation files directly in the offer, without losing information in the chats and external sources;
* Makes file management transparent by displaying the added date and time as well as history changes;
* Reduces the risk of misunderstanding between bidders through unified and up-to-date data;
* Helps control the order and volume of attachments with clear limits and deletion rules;
* Ensures correct access to the files at different stages of the offer's life cycle, i.e. from publication to archiving;
* Saves time with built-in checks during uploads and the ability to manage files efficiently.

{% hint style="danger" %}
**Important!** If you create a duplicate offer, the files from the original offer are not transferred, i.e. they will not appear in the new offer. The same applies if you duplicate private offer to publish it on the public exchange: the files will not be copied to such duplicate. Similarly, when creating an offer template, files will not be transferred to the template.
{% endhint %}

{% hint style="danger" %}
**Important!** If an offer is linked to other offers (for example, if "Partner selection" feature is enabled) and you add or remove files from it, the link will be broken. The system will display a warning beforehand so you can understand the consequences and make a decision.
{% endhint %}

### Convenient and transparent work with files

* Files can be added, downloaded and deleted both when creating/editing an offer and directly when viewing it.
* Each file displays the date and time when it was attached (in your local time zone).
* If a file is deleted more than 10 minutes after upload, the offer will display "File was deleted" note with the date and time.
* Files deleted within the first 10 minutes disappear completely and will not be counted against the limits.

### File visibility and access

* In active offers, files are visible to all users that have access to the offer.
* In archived offers, files are only accessible to the offer owner (including the responsible party's colleagues) and the winning bidder.
* In archived offers, files can be added and deleted using full viewing mode.

{% hint style="info" %}
The offer owner, as well as the responsible person's colleagues, can download, add and delete files both in the offer creation and editing form, as well as when viewing it.
{% endhint %}

### How does files function work?

{% stepper %}
{% step %}
On the exchange, in the upper left corner click "Create an offer" button.

<div align="left"><figure><img src="/files/5NdMxn1JXtWzxsIjFBDp" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Select "Freight" or "Vehicle".

<div align="left"><figure><img src="/files/qulOdrfALTguZFdJ4dvW" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
When the offer filling window opens, enter all required data regarding freight or transport.

<div align="left"><figure><img src="/files/tuGPXoY1WEObrsNpM82N" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
To attach file(s), click "Add file or photo" button and select the one(s) you need.

<div align="left"><figure><img src="/files/nOFKNL5b1YKlF2BOrxGR" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Publish your offer. Done!

<div align="left"><figure><img src="/files/aQVqt6liad65zOoI6pnW" alt=""><figcaption></figcaption></figure></div>

{% endstep %}
{% endstepper %}


# How to create offer templates?

{% stepper %}
{% step %}
Fill out all required fields when creating an offer;

<div align="left"><figure><img src="/files/VeoVJNBcHEQnOtRcoqaa" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Click "Save as template" button at the upper right or bottom left corner of the page;

<div align="left"><figure><img src="/files/MVbENipAd79wyXjval2H" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Name the template and click "Create";

<div align="left"><figure><img src="/files/h2VIli71lkPVySTYLJLY" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Done! To see all your saved templates click on "Create an offer", "Freight" / "Vehicle". Click "Use a template" at the top of the page.

<div align="left"><figure><img src="/files/Vgn2Ov7wOcpuNn5PMmDE" alt=""><figcaption></figcaption></figure></div>
{% endstep %}
{% endstepper %}


# How to delete or edit an offer?

{% stepper %}
{% step %}
Open your offer in the list of offers on the freight and transport search page or in "‎My offers" section.

<div align="left"><figure><img src="/files/CYqTZ9ToUZNmzqVh3EzZ" alt="" width="375"><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
In the upper right corner you will see an ellipsis icon. Clicking on it will open a menu where you can edit or delete the offer.

<div align="left"><figure><img src="/files/7rianoepIGCpe5GpgUi4" alt="" width="375"><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Another way to quickly edit an offer is to click the pencil icon in the upper right corner of the offer.

<div align="left"><figure><img src="/files/zm4DRj86coyV5h16rbyQ" alt="" width="375"><figcaption></figcaption></figure></div>
{% endstep %}
{% endstepper %}

{% hint style="danger" %}
**Note!** Archived offers cannot be edited.
{% endhint %}

## Restrictions on editing offer parameters after creation and publication

After creating and publishing an offer, some parameters become unavailable for editing. This is necessary to maintain the integrity of the bidding conditions and to ensure correct bid processing.

1. **"Auto-renewal on a late bid" checkbox**&#x20;

The **"Auto-renewal on a late bid"** setting cannot be changed immediately after creating and/or publishing an offer.

After saving the offer status, the value of this checkbox is fixed.

2. **Editing the bidding mode, currency, prices and tax**

After the offer is published, the following parameters can be changed:

* Bidding mode;
* Currency;
* Price;
* Taxation type.

Editing is only available until the first bid is received.

After the first bid is received, these parameters can no longer be changed.

3. **Features of offers with deferred acceptance of bids**

If an offer is published with **deferred bidding** enabled, you cannot change the **bidding mode** immediately after publication, even if no bids have been received yet.

However, you can still change the following until the first bid is received:

* currency;
* price;
* taxation type.

4. **Deferred bidding settings**

In a published offer, you cannot change the parameters related to the delayed bid acceptance:

* **"Delayed Start"** checkbox;
* **"Start in"** field;
* **"Specify exact date and time"** field;
* **"Bid Duration"** field.

> Deferred bidding is a paid feature and is only available in the **Pro** package and above.

5. Checkbox **"First bid from participant can be any"** (auction)

Once an offer is published, you cannot change the following setting:

* **"First bid from participant can be any."**

> This function is a paid feature of the platform and is only available in the **Pro** package and above.

6. **"Cargo type and packaging"** field

If a value is already selected for the **"Cargo type and packaging"** field:

* You cannot delete it and leave the field blank;
* You can only replace the selected value with a different one.

7. **Other offer parameters**

All parameters not listed in the restrictions above **remain available for editing after the offer is published.**

{% hint style="success" %}
Can you change the bidding mode after an offer has been published?

Yes, the bidding mode can be changed after an offer has been published, but **only before the first bid has been received.**

Exception:

* If an offer is published with **deferred bidding enabled**, the bidding mode cannot be changed immediately after the publication, regardless of whether there are any bids.

After the first bid has been received, changing the bidding mode is no longer possible.
{% endhint %}


# How to publish an offer as an individual if I have a company?

{% stepper %}
{% step %}
In the upper right corner next to your profile photo there is a display of the current active space.
{% endstep %}

{% step %}
Click the down arrow button to open the space selection, where "‎Personal space" option will appear.
{% endstep %}

{% step %}
When you move to "‎Personal space"‎, you can act on the exchange as an individual.

<div align="left"><figure><img src="/files/8DkEMXu95iR5CFEDLnCC" alt="" width="375"><figcaption></figcaption></figure></div>
{% endstep %}
{% endstepper %}


# How to respond to an offer?

{% stepper %}
{% step %}
**Place your bid.**

This option is available only if the offer is placed in the "‎Bargain"‎, "Auction"‎ or "‎Fix"‎ modes, and only for freight offers.
{% endstep %}

{% step %}
**Write in messenger to the person specified in the offer.**

Available for both freight and transport offers. This is the primary response method for an offer in the "‎Ad"‎ mode. Messenger is also useful when you need to clarify transportation details that were not specified in the offer.
{% endstep %}

{% step %}
**Contact by phone, email, Skype or other specified method.**

These contact details are used as a last resort. Please note that not all users provide their third-party contact methods. Available for both freight and transport offers.
{% endstep %}
{% endstepper %}


# How to receive notifications about responses to my offer?

The best option is to periodically log into Roolz platform so that you can track all activity in full.

There are also 2 types of notifications:

1. An email sent to the address specified in your account's authorization methods. This notification comes when you offer:

* Receives the first matchings from an automatic search for suitable offers (an email with an update on the number of offers suitable for you may come every morning);&#x20;
* Receives new bids;
* Sent to the winner of the auction to confirm their intention to cooperate in a timely manner.

2. Push notifications in the browser for new messages in chats.

{% hint style="danger" %}
**Note!** Push notifications are available if you allowed the site to send you notifications via your browser, and your operating system settings does not prohibit browser notifications. If browser notifications are allowed, such notifications will come when the browser is not minimized or closed.
{% endhint %}


# What are the offer statuses?

* **Not published |** `not_published`

  Available for all offers. The offer is not published on the exchange, meaning no one outside your company can find it and respond. Typically, this status is for offers that have been removed from publication or created as a draft for subsequent publication.\
  ![](/files/Kok0ThU8SUOWWG3yMyvu)

  \
  An offer may be automatically removed from publication if:

  * the publication period has ended and the winner of the auction has not been selected;
  * the winning bid was rejected or cancelled and the offer cannot be automatically re-published (the deadline and first loading date have passed).

  \
  Also, an offer may be automatically removed from publication by the system in the following cases:

  * the deadline for the first loading specified in the cargo offer has passed;
  * the user indicated as responsible in the offer has been deleted;
  * the offer has received complaints from other users.

* **Published |** `published`&#x20;

  Available for all types of offers. The offer is posted on the exchange, it is valid, and can be found by others on the public and/or private exchange. \
  ![](/files/fI7nsFc49u6UVxc3xYY9)\
  \
  An offer can only be published if all required fields are filled in. The date and time of the first upload must be in the future.

* **Pending |** `await_confirm`&#x20;

  Only freight offers in the "Bargain", "Auction" and "Fix" modes with the selected bid winner. The offer is not published on the exchange. The bid winner has been selected and you are waiting for confirmation of their bid and readiness to take the cargo.\
  ![](/files/crgKSeSPX0IG6q7FzrqV)\
  \
  When creating an offer in the "Bargain", "Auction" or "Fix" modes, you can set waiting period for bid confirmation. If the winner does not confirm their bid within the specified period, it will be automatically rejected and the offer will be republished. In the "Auction" mode in this case the system will automatically select a new winner, i.e. the next one with the highest bid.\
  &#x20;\
  If the deadline and first loading date have passed by this point, the offer will not be republished and will receive "Not published" status.<br>

* **Confirmation |** `confirmation`&#x20;

  Only freight offers in the "Bargain", "Auction" and "Fix" modes with the selected bidder. The offer is not published on the exchange. The winner has confirmed their bid and readiness for transportation. Both you and the carrier are satisfied with all the conditions and next you need to finally conclude the deal.\
  ![](/files/q20OVzyh2wvOtS4nRaxO)<br>

* **Archive |** `closed`&#x20;

  Available for all offers. The offer is not posted on the exchange and is closed. Archived offers cannot be edited or deleted. There is a special status for archived freight offers, for which transactions were concluded through "‎Bargain"‎, "‎Auction"‎ or "Fix" modes‎: **The deal has been concluded** (`deal_made`).\
  ![](/files/N9yVzrAROaJBrf4IxCP9)<br>

{% hint style="warning" %}
Deleted offers are not available for viewing, downloading (in Excel, CSV, JSON formats) or receiving via API.
{% endhint %}


# Offers: managing and exporting to EXCEL, CSV, JSON

### Where to find filters to sort offers:

{% stepper %}
{% step %}
[On the exchange](https://roolz.net), go to the "My offers" section in the menu on the left.
{% endstep %}

{% step %}
Click "Filter"‎ button in the upper right corner.
{% endstep %}

{% step %}
Select filters to find the offers that you need and click "Apply".

<div align="left"><figure><img src="/files/FNmUlzyUm1cWKZEyjJXh" alt=""><figcaption></figcaption></figure></div>
{% endstep %}
{% endstepper %}

### How to export offers:

{% stepper %}
{% step %}
[On the exchange](https://roolz.net), go to "My offers"‎ section
{% endstep %}

{% step %}
Click "Download" button in the upper right corner.

<div align="left"><figure><img src="/files/ddh0zD5xXfUajf89qWcX" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Select the format for download:

{% tabs %}
{% tab title="EXCEL" %}

* In the window that appears the "‎Excel file"‎ tab is active by default.
* Select the lines that you want to download.

<div align="left"><figure><img src="/files/UjNxsaoEJ1EnMnE1XixV" alt=""><figcaption></figcaption></figure></div>
{% endtab %}

{% tab title="CSV" %}

* In the window that appears choose "CSV file" tab.
* Select the lines that you want to download.

<div align="left"><figure><img src="/files/00GJW4qXKZxw2qKhfc7q" alt=""><figcaption></figcaption></figure></div>
{% endtab %}

{% tab title="JSON" %}

* In the window that appears choose "‎JSON file" tab.
* Select the lines that you want to download.

<div align="left"><figure><img src="/files/Z1sEmBYXw1E6cDl3yBRX" alt=""><figcaption></figcaption></figure></div>
{% endtab %}
{% endtabs %}
{% endstep %}

{% step %}
Click "‎Download"‎ button at the bottom of the window and the file will be downloaded to your computer.

<div align="left"><figure><img src="/files/QjRYQ5y9Z2U65CAP7X3o" alt="" width="375"><figcaption></figcaption></figure></div>

{% hint style="danger" %}
**Note!** You can download 1000 offers at a time. If your target sample is larger, use a filter.
{% endhint %}
{% endstep %}
{% endstepper %}


# Private exchange: partnerships

<details>

<summary><strong>Who can be invited to the private exchange?</strong></summary>

You can only invite companies that created their profile on Roolz (legal entities and entrepreneurs) to your partners. The invited companies can be both private ones (invitation via an invitation link) and public ones (invitation via search in the company directory and via offers by clicking on the contact person).

</details>

<details>

<summary><strong>How many partners can I have on the private exchange?</strong></summary>

As many as you need, the number is not limited

</details>

<details>

<summary><strong>What types of partnerships are there?</strong></summary>

When you send an invitation to the company to become their partner, you propose a type of interaction for exchanging offers, i.e. who can send offers to whom.

There are following partnership types:

1. **Sending offers**. You send offers to the partner, but the partner cannot send their offers to you;
2. **Receiving offers**. The partner sends offers to you, but you cannot send your offers to the partner;
3. **Exchanging offers**. You and your partner can send offers to each other if both interaction options are selected.

<img src="/files/y6cbuCnTVxGZjjsB8AsJ" alt="" data-size="original">

</details>

<details>

<summary><strong>How to invite company to the private exchange?</strong></summary>

To invite a company to partner, you must access the profile of a potential partner through:

* **Search in the company directory** by name or using filters and categories.

❕ **Note**: Private companies are not displayed in the company directory.<br>

1. On the Roolz exchange, select the “Companies” tab in the menu on the left.

<div align="left"><figure><img src="/files/FztpfnlYm6MaZzh8fFW1" alt="" width="375"><figcaption></figcaption></figure></div>

2. From the opened company directory, choose the company you want to invite as a partner.

<div align="left"><figure><img src="/files/mTXPyeNhS4FZ9tqBAI6p" alt="" width="375"><figcaption></figcaption></figure></div>

3. Click the “Invite to partners” button.

<div align="left"><figure><img src="/files/tc0EfuQwyALp3pHXBysH" alt="" width="375"><figcaption></figcaption></figure></div>

4. Select the type of offer interaction — who and how you can send offers.

<div align="left"><figure><img src="/files/J8MWcuna54fdLYxpa49n" alt="" width="375"><figcaption></figcaption></figure></div>

5. Done! Stand by for acceptance of the invitation.

<div align="left"><figure><img src="/files/dl1G2YzsViFYAMidAe7m" alt="" width="375"><figcaption></figcaption></figure></div>

* **A published offer on a public exchange**. You can access the company profile via the offer.

1. On the Roolz Exchange, click on the "Search Freights and Transport" tab. Then, open an offer from the list of offers.

<div align="left"><figure><img src="/files/obM7z4sm0ixW5iGAZUi5" alt="" width="375"><figcaption></figcaption></figure></div>

2. Click the "View contact info" button, then click the company that posted the offer.

<div align="left"><figure><img src="/files/JkkjYLc8UIyFdvdvZide" alt="" width="375"><figcaption></figcaption></figure></div>

3. Click the “Invite to partners” button.

<div align="left"><figure><img src="/files/YlzrzZg0mngXHinuKhc6" alt="" width="375"><figcaption></figcaption></figure></div>

4. Select the type of offer interaction — who and how you can send offers.

<div align="left"><figure><img src="/files/I347i4tl1Wi6B9syjjAX" alt="" width="375"><figcaption></figcaption></figure></div>

5. Done! Stand by for acceptance of the invitation.

<div align="left"><figure><img src="/files/uAuMGZcqd2IbHuiCc2sX" alt="" width="375"><figcaption></figcaption></figure></div>

* **A link to the company profile**. Companies often place links to their Roolz profiles on their website and other resources. Companies with private profiles that are not displayed on the public exchange share a link to their Roolz profile with their counterparties.

1. Follow the link that the prospective partner sent you.
2. Click the “Invite to partners” button.

<div align="left"><figure><img src="/files/YlzrzZg0mngXHinuKhc6" alt="" width="375"><figcaption></figcaption></figure></div>

3. Select the type of offei nteraction — who and how you can send offers.

<div align="left"><figure><img src="/files/I347i4tl1Wi6B9syjjAX" alt="" width="375"><figcaption></figcaption></figure></div>

4. Done! Stand by for acceptance of the invitation.

<div align="left"><figure><img src="/files/uAuMGZcqd2IbHuiCc2sX" alt="" width="375"><figcaption></figcaption></figure></div>

</details>

<details>

<summary><strong>How to change the type of partnership?</strong></summary>

On Roolz exchange, go to the "Private exchange"‎ tab, which is located on the top left. There you can change the type of interaction for offers (who can send offers to whom) in two ways:

1. Hover over the company profile card, where an ellipsis icon will appear. Clicking on it will display "Change interaction type»" button.

<img src="/files/KyxmaFK6pyna0oiS1kkJ" alt="" data-size="original">

2. Open your partner's company profile. In "Partner"‎ block, there is an ellipsis icon on the right. Clicking on it will display "Change interaction type" button.

<img src="/files/Obv4vROjMBKSA8tQ3MQW" alt="" data-size="original">

3. After that, select new interaction type and send request to update the relationship to your partner. They can accept or decline it.

<img src="/files/7O2HbUkJGDb0JV7D8159" alt="" data-size="original">

</details>

<details>

<summary>How to remove company from the list of partners and what happens after the partnership is terminated?</summary>

Go to the "Private exchange"‎ tab, which is located on the top left.

<img src="/files/xnCHGBWr7I1UpUJPKf9Y" alt="" data-size="original">

Here you can end partnership in two ways::

1. Place the cursor on the company card where an ellipsis icon is located. Clicking on it will display "Terminate partnership" button.

<img src="/files/MrAidoPX3M6vKir8fqpl" alt="" data-size="original">

2. Open your partner's company profile. In "Partner" block, there is an ellipsis icon on the right. Clicking on it will display "Terminate partnership"‎ button.

<img src="/files/hcXPiWTvS0WjWh9cNuXu" alt="" data-size="original">

You and your partner can terminate partnership unilaterally, i.e. mutual consent to terminate partnership is not required.

When you delete partner they lose access to all your current private offers and will not be able to receive new private offers from you.

Archived offers, for which transportation was concluded within Roolz system, will be available for viewing. However, you will only be able to view offer card with brief information about it and not the the full offer page.

<img src="/files/9L5arODd0AzPS5VAr0TF" alt="" data-size="original">

</details>


# Private exchange: sending offers

### How to distinguish private exchange offers from public offers on freight and transport search page?

**Freight search page** is a single window where all available offers are displayed for you, including the private ones from your partners. Such offers have special indication of a black plate with the text "‎Private"‎. There is also a similar indication in the offer view in the upper left corner under the offer name.

<div align="left"><figure><img src="/files/sQWEtP4mlyyQrzLMC7Yh" alt=""><figcaption></figcaption></figure></div>

If you are a shipper and only work with trusted partners, but are also looking for new ones, you can publish duplicates of your private offers on the public exchange. This is how "Partners selection"‎ feature works.

<div align="left"><figure><img src="/files/9yqBrk6LVbi3dPYqZcc4" alt=""><figcaption></figcaption></figure></div>

If you're a carrier, offers with "Partners selection" feature are a great way to get into customer's private exchange.

### What happens if I add new partners to my private exchange?

If you add new partners to your private exchange, they will not automatically gain access to previously posted offers. To ensure new partners can see these and all future offers, you must enable "Including future partners" option when creating them.

<div align="left"><figure><img src="/files/nNULUZZO3vSApTHVhTGE" alt=""><figcaption></figcaption></figure></div>

If the "Including future partners" feature is disabled, new offers will only be available to partners who had previously been the members of your private exchange.


# Partner groups

Organize your work on the freight exchange with "Partner groups" tool. Learn more about how to create groups and work with them.

### What is it?

**Partner groups** is a flexible tool for organizing and simplifying work with contractors and customers of your company on a private exchange. You can combine partners by different criteria to organize the database, speed up work processes and increase the transparency of interaction.

Let's say your company cooperates with more than 250 carriers and forwarders. The company makes around 500 to 800 shipments per month in different directions. Behind this volume is a team: 15 logisticians, 5 procurement specialists, 5 accountants as well as the employees of the legal department and security service.

It is nearly impossible to remember who transports what, in what directions, with what risks and conditions. This is why platform like Roolz with the function of creating **partner groups** is especially relevant for large logistics companies. This allows you to combine counterparties by directions, types of cargo, levels of trust or other criteria, and to work with them in one space. Faster. More transparency. No losses.

**Groups** can be created according to the specific tasks and interests of different departments.

Here are the possible examples of partner groups, which can be arranged as follows:

* By reliability and financial conditions:&#x20;

&#x20;      – Reliable / questionable / on stop list&#x20;

&#x20;      – Fast payments / long payments&#x20;

&#x20;      – Prepayment/deferred payment

* By vehicle fleet:&#x20;

&#x20;      – Refrigerators, curtainsiders, low-tonnage trucks, etc.

* By vehicle type:

&#x20;      – Own fleet / outsourced transport

* By type of transportation:

&#x20;      – FTL / LTL

&#x20;      – ADR / non-ADR

&#x20;      – Customs carriers, etc.

* By geography:

&#x20;      – CIS, Asia, Europe, domestic routes, etc.

{% hint style="danger" %}
**Important!** The number of available partner groups also depends on the tariff plan. For example, free tariff has only 2 partner groups, while "Expert" tariff has 25.
{% endhint %}

### How to create groups?

{% stepper %}
{% step %}
Open [roolz.net](https://roolz.net/) exchange, go to the "Private Exchange" section in the menu on the left.

{% hint style="danger" %}
**Important!** To work on the private exchange, you must have invited partners, otherwise this section will be inactive.
{% endhint %}
{% endstep %}

{% step %}
In the "Groups" section, click "Create a new group" button.
{% endstep %}

{% step %}
Come up with a name for the group, choose color, add description and select the desired partners for this group.
{% endstep %}

{% step %}
Click "Create group" button in the lower right corner.
{% endstep %}

{% step %}
Done! In the "Groups" section you will find all groups that you created.
{% endstep %}
{% endstepper %}

### How to edit groups?

{% stepper %}
{% step %}
Open [roolz.net](https://roolz.net/) exchange, go to the "Private Exchange" section in the menu on the left.

{% hint style="danger" %}
**Important!** To work on the private exchange, you must have invited partners, otherwise this section will be inactive.
{% endhint %}
{% endstep %}

{% step %}
In the "Groups" section, click on the ellipsis button in the upper right corner of the desired group and then click "Edit".
{% endstep %}

{% step %}
Edit all the necessary data and click "Save changes" button. Done!
{% endstep %}
{% endstepper %}

### How to delete groups?

{% stepper %}
{% step %}
Open [roolz.net](https://roolz.net/) exchange, go to the "Private Exchange" section in the menu on the left.

{% hint style="danger" %}
**Important!** To work on the private exchange, you must have invited partners, otherwise this section will be inactive.
{% endhint %}
{% endstep %}

{% step %}
In the "Groups" section, click the ellipsis button in the upper right corner of the group that you want to delete.
{% endstep %}

{% step %}
Click "Delete group" button and confirm action. Done!
{% endstep %}
{% endstepper %}

### How to add partners to groups?

{% stepper %}
{% step %}
Open [roolz.net](https://roolz.net/) exchange, go to the "Private Exchange" section in the menu on the left.

{% hint style="danger" %}
**Important!** To work on the private exchange, you must have invited partners, otherwise this section will be inactive.
{% endhint %}
{% endstep %}

{% step %}
In the "Partners" section, select partners that you want to add to the group and click "Add to group" button.
{% endstep %}

{% step %}
Enter the name of the desired group or select from the list provided.
{% endstep %}

{% step %}
Click on the desired group and partner will be added to it. Done!
{% endstep %}
{% endstepper %}

### How to send offers to partner groups?

{% stepper %}
{% step %}
Open [roolz.net](https://roolz.net/) exchange and create freight or transport offer.
{% endstep %}

{% step %}
Once the offer is ready for publication (all data is filled in), select "Private Exchange" checkbox and then "Recipients".
{% endstep %}

{% step %}
In the "Groups" section, select partner group, which you want to send this offer to, and click "Select". It is important to note that if there are 5 partners in a group, but only one of them has the right to receive offers according to the type of partnership, only this partner will receive the offer.
{% endstep %}

{% step %}
Click "Publish Now" button at the bottom or top right.
{% endstep %}

{% step %}
Done! The group of partners you selected will receive the offer in a few seconds.
{% endstep %}
{% endstepper %}


# Multimodal transportation: how to create an offer

Roolz now lets you create multimodal shipments within a single offer, combine different modes of transport and use new search tools.

### How to create a multimodal offer?

Multimodal transportation allows you to combine multiple modes of transport within a single offer and conduct electronic bidding across the entire logistics chain.&#x20;

Let's take a step-by-step look at how to create a multimodal offer on Roolz platform.

{% stepper %}
{% step %}
In the upper left corner of the platform, click **“Create an offer” → “Freight”**.

<div align="left"><figure><img src="/files/yoXfL8gyJIiG2lfndek2" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
In the **"About freight"** section, fill in all required fields. Specify **Incoterms** and, if necessary, select additional options: "Cargo insurance needed", "Temperature control," and "Specify cargo value."

<div align="left"><figure><img src="/files/tbM4y6MQIevohLjYouh6" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Go to the container management section and select the appropriate option:

<div align="left"><figure><img src="/files/MHeKUSwALie1wviYtyKm" alt=""><figcaption></figcaption></figure></div>

* **Containers available** — if containers are already available and will be used for the shipment.
* **Containers needed** — if containers need to be provided or rented from a carrier, shipping line, freight forwarder or other equipment supplier.

In the preview of published offers, the status of containers is displayed as follows:

<div align="left"><figure><img src="/files/6D2fX2H0Ako93i57PcTG" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
After selecting container options, the fields for specifying their type, size and quantity will become available.

* If **"Containers available"** is selected, an additional field "Container return location" will appear - this indicates the place where the container will be returned after the transportation is completed.

  <div align="left"><figure><img src="/files/Cn4d9Y0KjCIGUHD6SNLm" alt=""><figcaption></figcaption></figure></div>

* If **"Containers needed"** is selected, the fields for specifying the parameters of the required containers (type, size, quantity) will be displayed.

  <div align="left"><figure><img src="/files/mBvsLY7Ts6cM5omJqyKl" alt=""><figcaption></figcaption></figure></div>

{% hint style="success" %}
**Important!** Based on user research, we've moved **"High Cube (HC)"** option to a separate checkbox, as this container type is widely used in international shipping.
{% endhint %}
{% endstep %}

{% step %}
Go to the **"Note"** field and provide any additional important shipping information. Then, attach any necessary files, photos and documents for detailed calculations and proposals from freight forwarders and carriers.

<div align="left"><figure><img src="/files/ioims9zgJVmUltIcOnZD" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Next, fill in all the fields related to the terms of transportation, bidding mode and payment terms.

<div align="left"><figure><img src="/files/SuTEE9FYOgeUnL3S0Pzk" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Configure access and privacy settings to suit your business needs and proceed to "Transportation requirements" section.

<div align="left"><figure><img src="/files/2D3F8uWfhxlKy1jCYOvI" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
In the "Transportation requirements" section, check the "Multimodal transportation" box if the shipment requires the use of multiple modes of transport.

If this box is unchecked, the offer will be created for shipment using one of the available modes of transport.

<div align="left"><figure><img src="/files/tirgxz7mM0osEUHQinPw" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Next, add the required modes of transport using the "+ Add" button. For each stage of the shipment, fill in the required fields and, if necessary, specify additional parameters. This will allow you to describe the shipping terms more accurately and create the most informative offer.

<div align="left"><figure><img src="/files/stR0CtqdxC8qeG4fAf6w" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Go to the **"Route"** section of the offer and fill in all required fields: specify the the pickup and delivery location of the cargo, and select the appropriate transport icons for each stage of the route. If necessary, add intermediate stops by clicking **"+Add a waypoint"**. As intermediate waypoints, it is recommended to specify warehouses, seaports, airports, railway stations, and other locations through which the shipment route should pass.

<div align="left"><figure><img src="/files/54kBlNQ6C8qzU9B4UpJB" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Publish the offer. If the "Multimodal transportation" checkbox was selected when creating the offer and the vehicle types were specified, it will appear in the list of published offers as follows:

<div align="left"><figure><img src="/files/ay1u92aOA8mRMPVYdra0" alt=""><figcaption></figcaption></figure></div>

\
If the "Multimodal transportation" checkbox was selected when creating the offer but the vehicle types were not specified, the preview of the published offer will display the note "Transportation mode: Any."

<div align="left"><figure><img src="/files/NH29GtvO74ubwwaQgftM" alt=""><figcaption></figcaption></figure></div>

### Done!

Now you can receive offers from carriers and forwarders and conduct electronic bidding across your entire supply chain within a single offer.

[Start using multimodal shipping on Roolz](https://roolz.net/?utm_source=helpcenter\&utm_medium=instructions\&utm_campaign=release_26.12)
{% endstep %}
{% endstepper %}


# "Bargain" bidding mode

Create an offer in "Bargain" mode on Roolz logistics platform. Read the steps for successfully creating an offer and submitting bids in "Bargain" mode.

{% hint style="info" %}
All notifications regarding bids on your offers are sent to the email address indicated in your profile (on the Login and Security page).
{% endhint %}

### Bargain:

* The most flexible bidding mode, where competition both in terms of cost and transportation is important;
* Bidder has 4 statuses of their active bid: "Best", "Among the best", "Mid" and "Losing";
* Each user can make an unlimited number of bids, but only the last bid will be active;
* Even if the user is a member of several companies, they can submit an unlimited number of bids;
* The price specified in the offer is a guideline for bidders;
* You determine the winner yourself.

### In order to create an offer for the "Bargain" mode, do the following:

{% hint style="danger" %}
**Note!** "Bargain" mode is available for freight offers only.
{% endhint %}

{% stepper %}
{% step %}
Click "Create an offer" in the upper left corner and select "Freight".

<div align="left"><figure><img src="/files/glu4HVwVIxfWPjaITOez" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Fill in the obligatory data about your shipment, delivery time and other conditions.

<div align="left"><figure><img src="/files/drvjkmxUqXM4edKjgHtZ" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
In "Rate and payment" block, select "Bargain" mode.

<div align="left"><figure><img src="/files/F19CLwRMmKnETVWdT8y6" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Indicate the cost of transportation (participants' bids may be higher or lower than the indicated cost), select the type of taxation.

It is also possible to select "Accept bids without VAT" (if you specify that bids with and without VAT are allowed, participants will be able to choose the type of taxation independently when submitting bids).

<div align="left"><figure><img src="/files/3RZbtoOIb7aExWDbz3yV" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Set a deadline for the winner to confirm their bid. Once you selected the winner, they must confirm their bid. If the winner does not confirm their bid within the specified time, the bid is automatically rejected.

{% hint style="danger" %}
**Important!** If the winner does not have time to confirm their bid on time, and the offer owner wants to give them additional time to confirm, they can extend the bid confirmation period in the offer itself, or via **"My offers"** section on the page of the relevant offer.

If the winner still does not confirm the bid on time, the owner can still select this bid as the winning one. In this case, the confirmation cycle will start over.

If an offer was manually removed from publication by the offer manager, it is not archived, and the winner can be selected at any time.

If the offer's publication period expires automatically, it will be moved to the **"Not Published"** section. The offer manager will still be able to select a winner within the next 7 days (168 hours). After this period, the offer will automatically move to the **"Archive"**.
{% endhint %}

<div align="left"><figure><img src="/files/Z7eVj6mMydn9XjTbcKG8" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
If you want to schedule bargain in advance for a specific time and to set the exact start and end times, click "Scheduled bidding start" checkbox. This allows carriers to review cargo and calculate bids in advance, while the bidding itself will start and end strictly at the specified times, ensuring flexible scheduling and maximum transparency.

{% hint style="danger" %}
**Important!** This feature is available to companies on Pro, Expert, and Enterprise plans and works on both public and private exchange. It is not available to Starter and Free plan or to individuals.
{% endhint %}

<div align="left"><figure><img src="/files/rY8Kb3HCEzamHVFLuKH5" alt=""><figcaption></figcaption></figure></div>

{% endstep %}

{% step %}
Publish the offer on a private or public exchange (or both). Once the offer is published, it can accept bids from participants. As the owner of the offer, you will be able to see all bids participating in the bargain. To do this, you must click on your offer.

<div align="left"><figure><img src="/files/jjmXs88YQOhHB0RqXLYw" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
If you want to find new partners, let them know by selecting "Private Exchange" option. Afterwards, "Duplicate on public exchange" and "Partner selection" checkboxes will appear. Check both boxes and wait for the bids from potential partners.

<div align="left"><figure><img src="/files/cjBqispT9RTcYlpqoOTR" alt=""><figcaption></figcaption></figure></div>

{% hint style="danger" %}
**Note!** Available for "Bargain" and "Ad" modes only.
{% endhint %}
{% endstep %}

{% step %}
Specify the duration of the publication, i.e. how long your bargain will take place on the exchange. The default value is 72h, but you can choose shorter time, such as 24h or 48h.

You can also choose different duration by selecting "Specify your own time" or "Since first bid" checkboxes (the countdown of the duration of publication will start when the first bid is received).

<div align="left"><figure><img src="/files/rSW9AHqBKRi4xqSmVYkQ" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
You can optionally adjust bid's privacy settings for the bidding participants. You can read more in the ["Bid's Privacy"](/en/bids-privacy) section.

<div align="left"><figure><img src="/files/RSnDgvbEcfVElazGkt9N" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Offers also have an option to extend the bidding period automatically. When "Auto-renewal on late bid" checkbox is selected, the bidding period will be extended by 10 minutes if a bid was placed 10 minutes before the scheduled end of the publication. Automatic extension can be enabled for up to five times.

This feature automatically extends the bidding period if someone places bid in the last minutes, giving other bidders an opportunity to respond with a new bid.

<div align="left"><figure><img src="/files/VPPVO8MG6nWlfz1OXoMB" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Click "Publish now" button at the top and bottom of the screen. Done! The offer has been published in "Bargain" mode.

<div align="left"><figure><img src="/files/YGthZS0HlbVU6DRN6dWN" alt=""><figcaption></figcaption></figure></div>
{% endstep %}
{% endstepper %}

### How to place bids on offers in "Bargain" mode?

{% hint style="danger" %}
**Note!** A user can only have one active bid on a particular offer.

For example, you are a member of both company A and company B. You bid on an offer from company A and then bid on the same offer from company B. In this case, the bid from company A is automatically canceled because both bids were placed by the same user.

You can only place bid on an offer that is in the "Published" status.
{% endhint %}

{% stepper %}
{% step %}
In the "Search freights and transport" tab, go to the offer with the "Bargain" indicator.

<div align="left"><figure><img src="/files/mEIwECIXDr0VzAZwyeDb" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Click "Make a bid" button on the right.

<div align="left"><figure><img src="/files/Mf1NIDtnVeuknG99TI0E" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
In the window that opens, specify the cost and select taxation type for your offered cost.&#x20;

If the offer owner specified the price with VAT and selected "‎Accept bids without VAT"‎, you can also select this types of taxation.&#x20;

If the owner only specified one type, you will only be able to place bid with this type of taxation.&#x20;

If you wish, you can enter a note. For example, you have an interesting offer both in terms of price and transportation conditions. When all information is filled in, click "Make a bid" button.

{% hint style="info" %}
When creating an offer, the offer manager selects the currency (the default currency is the region, in which the offer manager is located). Bids can then be placed in the currency selected by the offer manager.
{% endhint %}

<div align="left"><figure><img src="/files/BvxXqVvZiqGZyNoPyPnw" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
The status of the placed bid can be tracked in the offer itself. Depending on whether the bid is active or not, it will be displayed in the corresponding block (e.g. if you have canceled the bid, it will no longer be "Active"). Your bid will be marked as "Best", "Among the Best", "Mid" or "Losing" depending on your competitor's bids.

<div align="left"><figure><img src="/files/8c3b9sqHud6vMSu7Qg9P" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
You can also view bids status on ["My bids"](/en/my-bids-section) page. All bids are displayed according to their status.

For example, if you placed a bid and the bidding is in progress, your bid appears in the "Bidding" column. Once the bid wins, you need to confirm it and it will then appear in the "Confirmation" column.

On "My bids" page, you can also cancel a bid or make a new one.&#x20;

<div align="left"><figure><img src="/files/XtxYwp8G3ZGeaBQWCKHp" alt=""><figcaption></figcaption></figure></div>

{% hint style="danger" %}
**Important!** Do not forget to refresh the page manually to keep track of competitors bids and win!
{% endhint %}
{% endstep %}
{% endstepper %}


# "Auction" bidding mode

Create an offer in "Auction" mode on Roolz logistics platform. Read the steps for successfully creating an offer and submitting a bid in "Auction" mode.

{% hint style="info" %}
All notifications regarding bids on your offers are sent to the email address indicated in your profile (on the Login and Security page).
{% endhint %}

### Auction:

* A mode where each participant can make their own bid;
* Suitable when you mostly care about the cost of transportation;
* The lowest bid wins automatically when the auction duration ends;
* You can select the winner manually and the offer will be marked as "Winner selected manually";
* If the offer does not specify the price, then the first bid sets the initial price;
* If the price is specified in the offer, the first bid must match this price or be lower;
* There are 2 active bid statuses in the auction: “Best” and “Outbid”;
* All subsequent bids must differ from the current best bid by the minimum step specified by the offer owner when creating an offer. This allows to avoid slight decreases in cost.

### In order to create an offer in "Auction" mode, you need to:

{% hint style="danger" %}
**Note!** "Auction" mode is available for freight offers only.
{% endhint %}

{% stepper %}
{% step %}
Click "Create an offer" in the upper left corner and select "Freight".

<div align="left"><figure><img src="/files/fORNcOD5B6UvniTsNlSC" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Fill in the obligatory information about your shipment, delivery time and other conditions.

<div align="left"><figure><img src="/files/BqzKIGNJaIq0eaTI6YKT" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
In "Rate and payment" block, select "Auction" mode.

<div align="left"><figure><img src="/files/4sMdCUeqgXsTkMdbtyEE" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Indicate the cost of transportation, select the type of taxation.

{% hint style="info" %}
You can start an auction without specifying the price. The first participant places any bid that the next participants must outbid, subject to a minimum bid step.
{% endhint %}

It is also possible to select "Accept bids without VAT" (if you specify that bids with and without VAT are allowed, participants will be able to choose the type of taxation independently when submitting a bid).

{% hint style="info" %}
To determine the best price between VAT and non-VAT bids, all values are brought to a single tax measurement by deducting VAT percentage in VAT bids. This is useful when you refund VAT, but also want to work with non-VAT companies if they offer a better net value.
{% endhint %}

<div align="left"><figure><img src="/files/TdHcpsjL56xB0T5rBFnL" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Specify the minimum step size between the value of the current best bid and a new bid. To place a bid, the value must be lower than the current best bid, taking into account the minimum step. Example: If the minimum step is $50 and the current best bid is $500, the new bid must be $450 or less.

<div align="left"><figure><img src="/files/3drbDUD3fMazRDR8ralH" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Set a deadline for the winner to confirm the bid.

The winner is automatically selected based on the lowest cost criterion when the publishing period ends. However, the owner of the offer can select the winner manually. In this case it will be marked in the offer that the winner was selected manually. This will only be visible to the owner of the offer.

Once you select a winner, they must confirm their bid. If the winner does not confirm the bid within the specified deadline, the bid is automatically rejected.

{% hint style="danger" %}
**Important!** If the winner does not have time to confirm their bid on time, and the offer owner wants to give them additional time to confirm, they can extend the bid confirmation period in the offer itself, or via "My offers" section on the page of the relevant offer.

If the winner still does not confirm the bid on time, the owner can still select this bid as the winning one. In this case, the confirmation cycle will start over.

If an offer was manually removed from publication by the offer manager, it is not archived, and the winner can be selected at any time.

If the offer's publication period expires automatically, it will be moved to the **"Not published"** section. The offer manager will still be able to select a winner within the next 7 days (168 hours). After this period, the offer will automatically move to the **"Archive"**.
{% endhint %}

<div align="left"><figure><img src="/files/qE7ntnolUOtbZx9twdM5" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
If you want to attract more participants and ensure quick start to your auction, enable "The first bid from a bidder is any" checkbox. This lowers the barrier to entry, helps generate the required level of participation and facilitates more efficient auctions.

{% hint style="danger" %}
**Important!** This feature is available to companies on **Pro, Expert,** and **Enterprise** plans and works on both public and private exchange. It is not available to Starter and Free plans and to Individuals.
{% endhint %}

<div align="left"><figure><img src="/files/EBjjX7GMXkJiGu9KZJW3" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
If you want to schedule an auction in advance for a specific time and to set the exact start and end times, select "Scheduled bidding start" checkbox. This allows carriers to review cargo and calculate bids in advance, while the auction itself will start and end strictly at the specified times, ensuring flexible scheduling and maximum transparency.

{% hint style="danger" %}
**Important!** This feature is available to companies on **Pro, Expert,** and **Enterprise** plans and works on both public and private exchange. It is not available for Starter and Free plans or to Individuals.
{% endhint %}

<div align="left"><figure><img src="/files/iQDsIscgzLe53Eco4Swp" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Publish the offer on a private or public exchange (or both). Once the offer is published, it can accept bids from participants. As the owner of the offer, you will be able to see all bids participating in the auction. To do this, you must click on your offer.

<div align="left"><figure><img src="/files/jjmXs88YQOhHB0RqXLYw" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Specify the duration of publication, i.e. how long your auction will be relevant on the exchange. The default value is 72h, but you can choose shorter time, such as 24h or 48h.

You can also choose different duration by selecting "Specify your own time" or "Since first bid" checkboxes (the countdown of the duration of publication will start when the first bid is received).

<div align="left"><figure><img src="/files/rSW9AHqBKRi4xqSmVYkQ" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
You can optionally adjust bid's privacy settings for the auction participants. You can read more in the ["Bid's Privacy"](/en/bids-privacy) section.

<div align="left"><figure><img src="/files/RSnDgvbEcfVElazGkt9N" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Offers also have an option to extend the bidding period automatically. When "Auto renewal on late bid" checkbox is selected, the bidding period will be extended by 10 minutes if a bid was placed 10 minutes before the scheduled end of an auction. Automatic extension can be enabled for up to five times.

This feature automatically extends the bidding period if someone places bid in the last minutes, giving other bidders an opportunity to respond with a new bid.

<div align="left"><figure><img src="/files/VPPVO8MG6nWlfz1OXoMB" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Click "Publish now" at the bottom of the screen. Done! The offer has been published in "Auction" mode.

<div align="left"><figure><img src="/files/2IKo25qmMD3wkAb9ZxiH" alt=""><figcaption></figcaption></figure></div>
{% endstep %}
{% endstepper %}

### How to place bids on offers in "Auction" mode?

{% hint style="danger" %}
**Note!** A user can only have one active bid on a particular offer.

For example, you are a member of both company A and company B. You bid on an offer from company A and then bid on the same offer from company B. In this case, the bid from company A is automatically canceled because both bids were placed by the same user.

You can only place bid on an offer that is in the "Published" status.
{% endhint %}

{% stepper %}
{% step %}
In the "Search freights and transport" tab, go to the offer with the "Auction" indicator.

<div align="left"><figure><img src="/files/sUewQbXyynx3KL25s2zL" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Click "Make a bid" button on the right.

<div align="left"><figure><img src="/files/VAcJ8GDfJ787PrBL0YdK" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
In the window that opens, specify the cost and select taxation type for your offered cost.&#x20;

If the offer owner specified the price with VAT and selected "‎Accept bids without VAT"‎, you can also select this types of taxation.&#x20;

If the owner only specified one type, you will only be able to place bid with this type of taxation.&#x20;

If you wish, you can write a note. For example, you have an interesting offer both in terms of price and transportation conditions. When all information is filled in, click "Make a bid" button.

{% hint style="info" %}
When creating an offer, the offer manager selects the currency (the default currency is the region, in which the offer manager is located). Bids can then be placed in the currency selected by the offer manager.
{% endhint %}

<div align="left"><figure><img src="/files/dNzg7o1LgDlFmegBrR0v" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
The status of the placed bid can be tracked in the offer itself. Depending on whether the bid is active or not, it will be displayed in the corresponding block (e.g. if you canceled the bid, it will no longer be "Active"). Your bid will be marked as "Best" or "Outbid" depending on your competitor's bids.

<div align="left"><figure><img src="/files/MRMQ4nUVbckXP7T8SRVT" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
You can also view bids statuses on ["My bids"](/en/my-bids-section) page. All bids are displayed according to their status.

<div align="left"><figure><img src="/files/XtxYwp8G3ZGeaBQWCKHp" alt=""><figcaption></figcaption></figure></div>

For example, if you placed a bid and the bidding is in progress, your bid appears in the "Bidding" column. Once the bid wins, you need to confirm it and it will then appear in the "Confirmation" column.

On "My bids" page, you can also cancel bids or make new ones.&#x20;

{% hint style="danger" %}
**Important!** Do not forget to refresh the page manually to keep track of competitors bids and win!
{% endhint %}
{% endstep %}
{% endstepper %}

### Resuming the auction

{% hint style="danger" %}
**Important!** The auction is considered complete if:

1. Completed **automatically** (after the specified time);
2. Completed **manually** (via "Complete auction" button);
3. Completed by **manually selecting the winner** (via "Make winner" button).
   {% endhint %}

#### After the auction is completed, auction rounds can be held for the same offer

If ["Do not select a winner automatically"](/en/auction-bidding-mode/do-not-select-a-winner-automatically-feature) checkbox is active, the auction can only be continued by **republishing the offer**. In this case, all existing bids remain unchanged.

<div align="left"><figure><img src="/files/wikNrlr0z9xauDl2IgRk" alt=""><figcaption></figcaption></figure></div>

#### "Continue auction" button

When this action is selected, all active bids are retained. The current **winning** bid behaves differently:

* If the **"Reject the current winner's bid"** checkbox is selected, the winning bid is rejected. To participate, the user must place a new bid.
* If the checkbox is not selected, the auction continues, and all active bids remain valid.

<div align="left"><figure><img src="/files/pd24GSjHiAyoiQ3MWLyJ" alt=""><figcaption></figcaption></figure></div>

#### "Restart" button

When an auction is restarted, **all bids are rejected** and the auction is restarted.

<div align="left"><figure><img src="/files/tc1w5pROGZiFAXldEOYz" alt=""><figcaption></figcaption></figure></div>


# "The first bid from a bidder is any" feature

**"The first bid from a bidder is any" setting changes the rules for submitting the first bid (only in the "Auction" mode) and affects the availability of information about the auction progress.**

{% hint style="danger" %}
**Important!** This feature is available to companies on the Pro, Expert, and Enterprise plans and works on both public and private exchanges. It is not available to Starter and Free plans or to individuals.
{% endhint %}

**With this setting enabled, a potential bidder can submit the first bid at any price, regardless of the current best bid, minimum increment or starting price.**

This gives companies more flexibility when starting bidding and helps attract carriers and freight forwarders quicker, even if some participants are hesitant to make the first move in an already active bidding process.

Furthermore, this setting allows customers to see interest from carriers even if bidding is already underway and competition is intense. In some cases, the auction winner is not the carrier with the lowest bid, but the one assessed by the customer as the best fit for a specific cargo.

This is especially important for large customers, as their procurement regulations may require a certain "quorum" of participants. Without it the additional complications may arise when organizing a non-competitive procurement or restarting an auction. With "The first bid from a bidder is any" feature, customers can meet these requirements and simplify the bidding process.

#### The system still monitors the correctness of the bid:

* If the price is higher than the starting price, the bid is automatically rejected.
* If the price is equal to the current best bid, the bid is created and becomes the outbid (immediately after the best bid).
* If the price is higher than the current best bid, the bid is immediately outbid.
* If the price is lower than the current best bid, the bid becomes the best bid.
* If there are no bids in the auction, any bid ≤ the starting price becomes the best bid.

After submitting the first bid, the company automatically becomes a bidder and gains full access to all auction information.&#x20;

If the company already has a bid (regardless of its status), subsequent bids are submitted according to the standard Auction rules, taking into account the minimum bid increment.

<details>

<summary><strong>What does an offer look like for a non-auction participant?</strong></summary>

With this feature enabled, potential bidders are not exposed to any data that could influence their decision.

Hidden:

* All bids,
* Number of bids,
* Number of participants,
* Starting price,
* Current best bid,
* Estimated price.

In the preview, the offer appears as if the bidding hasn't yet begun, and the starting price isn't specified. This creates a fair environment: each participant has a clean start, and only those actually participating in the bidding have access to the information.

</details>

<details>

<summary><strong>How does it work inside the company?</strong></summary>

* If one of the company's employee places a bid, all colleagues see the offer as bidding participants.
* If the user switches to another space that hasn't placed a bid, that space again sees the offer as "empty."

</details>

<details>

<summary><strong>Data export and public API</strong></summary>

If "The first bid from a bidder is any" feature is enabled:

* Bid data, including the planned price, is not transmitted to non-bidders in the API;
* Bidders receive full data within the current bid privacy setting.

When exporting to Excel/CSV/JSON, bid information is displayed according to the bidder's status.

</details>

<details>

<summary><strong>If company downgrades from Pro, Expert or Enterprise plan to Basic plan:</strong></summary>

* The setting remains in existing offers;
* It is unavailable in new offers.
* When applying a template or creating a duplicate, the value is ignored.

</details>

<details>

<summary><strong>If company gains access (upgrades the tariff):</strong></summary>

* "The first bid from a bidder is any" feature becomes available even in existing offers.

A potential participant can submit a bid at any price.

* If the bid price exceeds the auction's starting price, the system will reject the bid.
* If the price is lower than the current best bid, the bid becomes active and participates in the auction.

When this setting is enabled, only participants who have placed at least one bid have access to auction information. Non-participants see the offer as "empty", without any bids or starting price.

</details>


# "Do not select a winner automatically" feature

{% hint style="danger" %}
**Important!** This feature is only available in "Auction" mode.
{% endhint %}

#### What does this mean?

When this setting is enabled, the offer will be removed from publication when the publication time expires or when you click "End auction" instead of automatically selecting the winner. New bids will not be accepted and all existing bids will retain their status, allowing you to manually select the winner.

This feature allows for flexible **auction rounds** (these are bidding iterations), for example:

* The first round: collecting bids and pre-selecting participants (checking carriers, adjusting terms, eliminating unsuitable bids);
* The second and subsequent rounds: conduct the auction itself, i.e. republishing the offer, accepting bids and selecting the winner;
* If no winner is selected and the offer is republished, a new bidding round begins.

When republishing an offer with this setting enabled, all previously received bids are retained.

{% hint style="info" %}
If an offer with this setting is removed from publication and republished, all bids from participants are retained.
{% endhint %}

#### Where can I find and enable the "Do not select a winner automatically" setting?

{% stepper %}
{% step %}
When creating an offer, fill in all the required fields and select "Auction" mode in the "Rate and payment" section.

<div align="left"><figure><img src="/files/kT6YFOHYwUM0qxFXw5S1" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Fill in all the information about the price and conditions of the auction.

<div align="left"><figure><img src="/files/fWOy1LYieHV8fOx6Otk5" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Click "Open advanced options" button and additional checkboxes will open.

<div align="left"><figure><img src="/files/6xUr6k1BPkR9utap9uTL" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Activate "Do not select a winner automatically" checkbox, fill in the remaining details of your offer and publish it.

<div align="left"><figure><img src="/files/HdEuNRiN9kSmCzKB6E8g" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Done! Your offer will accept bids from participants but you will select the winner manually.
{% endstep %}
{% endstepper %}

#### What else is useful to know?

* When creating an offer **template**, the state of this setting is saved in the template.
* When creating a **duplicate** offer, the state of this setting is saved.
* Offers with this setting are archived manually by the user running the auction.


# "Planned price" feature

#### What does this mean?

This functionality is primarily intended for companies where bonus calculations for logistics specialists and managers are based on a comparison of planned and actual transportation costs.

#### Why is the "Planned price" feature needed?

For many large companies it's important to record the expected cost of a shipment at the offer publishing stage in addition to the initial auction price field.

In practice, the planned price most often includes:

* the historical price for similar shipments;
* the target budget allocated for a specific route or flight;
* the internal planned rate used for calculating KPIs and employee bonuses.

In conjunction with the actual cost of closing a shipment, this allows:

* to calculate "planned/actual" indicators;
* to use data in Excel, CSV and JSON exports;
* to accurately determine employee bonus amounts;
* to increase the transparency and manageability of logistics processes.

{% hint style="danger" %}
**Important!** The "Planned price" feature is only available by default for companies on paid plans: Pro, Expert, and Enterprise. It is not available for individuals or other plans.
{% endhint %}

#### Where can I find and enable the "Planned price" feature?

To enable the "Planned price" setting in Auction mode:

{% stepper %}
{% step %}
When creating an offer fill in all the required fields and select "Auction" mode in the "Rate and payment" section.

<div align="left"><figure><img src="/files/kT6YFOHYwUM0qxFXw5S1" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Click "Open advanced options" to display additional checkboxes available with your plan.

<div align="left"><figure><img src="/files/6xUr6k1BPkR9utap9uTL" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Activate the "Planned price" setting and select "Hide price" option if necessary.

<div align="left"><figure><img src="/files/6kkuY1xXDbrOYss6Imw0" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Fill in the remaining details and publish the offer.

{% hint style="danger" %}
**Important!**

* The planned price currency always matches the offer currency.
* The tax type for the planned price is not applied.

"Planned price" is only available for viewing when the offer is fully disclosed and the privacy setting is disabled.
{% endhint %}
{% endstep %}
{% endstepper %}

#### Setting the planned price privacy: "Hide price"

If privacy is enabled:

* The planned price is visible only to you and your colleagues within the company.
* Bidders do not see or receive the field value either in the interface or through the API.

If privacy is disabled:

* The planned price may be available to auction participants, depending on the bid acceptance settings.

If "The first bid from a bidder is any" setting is enabled in the auction:

* if privacy is disabled, the bidder will see the planned price only after their first bid;
* if privacy is enabled, they will not see it under any circumstances.

#### Templates, Duplicates and Rates

* When creating an offer template, the field's state and privacy settings are saved.
* When duplicating an offer, the field's privacy settings are also saved if the company has access to the feature.

If a company loses access to the feature (for example, switching from Pro to Starter plan):

* the field remains unchanged in existing offers;
* the field is unavailable in new offers;
* when applying a template or creating a duplicate, the field values ​​are ignored.

When switching to a plan that supports the feature, the planned price also becomes available in existing offers.


# "Fix" bidding mode

Create an offer in "Fix" mode on Roolz logistics platform. Read the steps for successfully creating an offer and submitting a bid in "Fix" mode.

{% hint style="info" %}
All notifications regarding bids on your offers are sent to the email address indicated in your profile (on the Login and Security page).
{% endhint %}

### Fix:

* A mode where each participant competes for transportation, offering transportation conditions;
* The cost of transportation is fixed and is set by the owner of the offer;
* When you have a fixed cost of transportation, no one can bargain on the cost;
* If "Book now" setting is not disabled, then fix mode allows you to conduct competition between the participants, but only on the terms of transportation;
* This mode is great for holding competition among your carriers with a set contract cost.

#### *Fix mode with "Book now" function.*

Used in two cases:

* The first participant to agree wins the transportation;
* If you sent the offer to only one partner, then this is a direct assignment of the offer to the partner, as in case of a contract plan.

### To create an offer in "Fix" mode, you need to:

{% hint style="danger" %}
**Important!** "Fix" mode is only available for freight offers.
{% endhint %}

{% stepper %}
{% step %}
Click "Create an offer" in the upper left corner and select "Freight".

<div align="left"><figure><img src="/files/6o041Am0K8JfYvnHiVoR" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Fill in the obligatory data about your shipment, delivery time and other conditions.

<div align="left"><figure><img src="/files/33lQKIZTGcjDceBFiXv4" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
In “Rate and payment” block, select “Fix” mode.

<div align="left"><figure><img src="/files/UNyVAXhHvTyMsrRtOhP5" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Specify fixed cost for transportation, select the type of taxation.

<div align="left"><figure><img src="/files/ORxSKL9E5xGZETGEqqj9" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Set a deadline for the winner to confirm the bid. Once you selected the winner, they must confirm their bid. If the winner does not confirm the bid within the specified time, the bid is automatically rejected.

<div align="left"><figure><img src="/files/nMgcODFVLaapLM5q1BaZ" alt=""><figcaption></figcaption></figure></div>

If an offer was manually removed from publication by the offer manager, it is not archived, and the winner can be selected at any time.

If the offer's publication period expires automatically, it will be moved to the **"Not published"** section. The offer manager will still be able to select a winner within the next 7 days (168 hours). After this period, the offer will automatically move to the **"Archive"**.

{% hint style="success" %}
You can activate "Book now" function, and then the first participant to respond will automatically become the winner.&#x20;
{% endhint %}
{% endstep %}

{% step %}
If you want to schedule bidding in advance for a specific time and to set the exact start and end times, select "Scheduled bidding start" checkbox. This allows carriers to review cargo and calculate bids in advance, while the bidding itself will start and end strictly at the specified times, ensuring flexible scheduling and maximum transparency.

{% hint style="danger" %}
**Important!** This feature is available to companies on Pro, Expert, and Enterprise plans and works on both public and private exchange. It is not available to Starter and Free plans or to individuals.
{% endhint %}

<div align="left"><figure><img src="/files/kimWLkHUvcqedkKsUlB3" alt=""><figcaption></figcaption></figure></div>

{% endstep %}

{% step %}
Publish offer on the private or public exchange (or both). Once the offer is published, it can accept bids from participants. As the owner of the offer, you will be able to see all bids participating in the bidding. To do this, you must click on your offer.

<div align="left"><figure><img src="/files/jjmXs88YQOhHB0RqXLYw" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Specify the duration of publication, i.e. how long your offer will be relevant on the exchange. The default time is 72h, but you can choose shorter duration, such as 24h or 48h.

You can also set different duration by selecting "Specify your own time" or "Since first bid" checkboxes (the countdown of the duration of publication will start once the first bid is received).

<div align="left"><figure><img src="/files/rSW9AHqBKRi4xqSmVYkQ" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
You can optionally adjust bid's privacy settings for the bidding participants. You can read more in the ["Bid's Privacy"](/en/bids-privacy) section.

<div align="left"><figure><img src="/files/RSnDgvbEcfVElazGkt9N" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Offers also have an option to extend the bidding period automatically. When "Auto renewal on late bid" checkbox is selected, the bidding period will be extended by 10 minutes if a bid was placed 10 minutes before the scheduled end of a publication. Automatic extension can be enabled for up to five times.

This feature automatically extends the bidding period if someone places bid in the last minutes, giving other bidders an opportunity to respond with a new bid.

<figure><img src="/files/VPPVO8MG6nWlfz1OXoMB" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
Click "Publish now" button at the top and bottom of the screen. Done! The offer has been published in "Fix" mode.

<div align="left"><figure><img src="/files/jR2JC7FkJ5YfKiFEMm88" alt=""><figcaption></figcaption></figure></div>
{% endstep %}
{% endstepper %}

### How to place bids on offers in "Fix" mode?

{% hint style="danger" %}
**Note!** A user can only have one active bid on a particular offer.

For example, you are a member of both company A and company B. You bid on an offer from company A and then bid on the same offer from company B. In this case, the bid from company A is automatically canceled because both bids were placed by the same user.

You can only place bid on an offer that is in the "Published" status.
{% endhint %}

{% stepper %}
{% step %}
In "Search freights and transport" tab, go to the offer with "Fix" indicator.

<div align="left"><figure><img src="/files/1iKVl1y2UZBFSRfaayFG" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Click "Make a bid" button on the right.

<div align="left"><figure><img src="/files/OckDP4Q7MJc50BPBEFFN" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
In the window that opens, specify the taxation type and cargo delivery terms.&#x20;

If the offer owner specified the price with VAT and selected "‎Accept bids without VAT"‎, you can also choose this types of taxation.&#x20;

If the owner only specified one type, you will only be able to place bid with this type of taxation.&#x20;

If you wish, you can also write a note. For example, you have an interesting offer in terms of transportation conditions. When all information is filled in, click "Make a bid" button.

{% hint style="info" %}
When creating an offer, the offer manager selects the currency (the default currency is the region, in which the offer manager is located). Bids can then be placed in the currency selected by the offer manager.
{% endhint %}

<div align="left"><figure><img src="/files/fGbOn36T3F49Bom8UAEz" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Bid status is the same for all participants: "Your bid has been submitted". Depending on whether the bid is active or not, it will be displayed in the corresponding block (e.g. if you have canceled the bid, it will no longer be "Active").

<div align="left"><figure><img src="/files/vyHkMqn6Vsv0szEr9Ied" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
You can also view bids statuses on ["My bids"](/en/my-bids-section) page. All bids are displayed according to their status.

For example, if you placed a bid and the bidding is in progress, your bid appears in the "Bidding" column. Once the bid wins, you need to confirm it and it will then appear in the "Confirmation" column.

On "My bids" page, you can also cancel a bid or make a new one.

<figure><img src="/files/XtxYwp8G3ZGeaBQWCKHp" alt=""><figcaption></figcaption></figure>

{% hint style="danger" %}
**Important!** Don't forget to refresh the page manually to avoid missing competitors' bids and win!
{% endhint %}
{% endstep %}
{% endstepper %}


# Bid's privacy

**Bid's privacy** is an additional setting in the offer, thanks to which the owner of the offer can regulate what information participants can see about competitors' bids.

<div align="left"><figure><img src="/files/rev4tzS7Jo8ZsMz6dXSc" alt="" width="375"><figcaption></figcaption></figure></div>

{% hint style="danger" %}
**Note!** Available for freight offers in "Bargain" and "Auction" bidding modes only.
{% endhint %}

### Information that can be made private:

* **Participants**. Only other participants of your offer are visible.

<div align="left"><figure><img src="/files/7LXDZCEtELlsVF71jeL8" alt="" width="375"><figcaption></figcaption></figure></div>

* **Bids**. Only the information about the bids made on your offer is visible.

<div align="left"><figure><img src="/files/UI3ttGHs8ziZlBeH6lon" alt="" width="375"><figcaption></figcaption></figure></div>

* **Comments**. Only comments from other bidders in your offer are visible.

{% hint style="danger" %}
**Note!** When comments are hidden from other users, the delivery time field is also hidden.
{% endhint %}

<div align="left"><figure><img src="/files/Zh0FRw1pYtnXDCV02lyV" alt="" width="375"><figcaption></figcaption></figure></div>

{% hint style="info" %}
If no checkbox is selected in the "Bids privacy" block, then no information is visible.
{% endhint %}

<div align="left"><figure><img src="/files/Zac4dmjgZdGSw1K01KnX" alt="" width="375"><figcaption></figcaption></figure></div>


# Files in bids

To make working with offers more convenient and transparent, we've added a new feature: **file attachment to the bids**.

#### Attaching files to the bids: how it works and what benefits it offers to the users

Bidding participants on the platform can now:

* Attach comprehensive price offers as files along with the bid;
* Add documents and explanations to the offers;
* Attach photos and videos, such as loading and delivery methods;
* Exchange additional information with the customer within the same bid.

<div align="left"><figure><img src="/files/MurLQX6EqLJbdl8TZT21" alt=""><figcaption></figcaption></figure></div>

#### Who can add files to bids?

Only the user responsible for the bid can add or delete the files for this bid.

Colleagues from the same company can view and download the files, but cannot edit them.

Files are only visible to:

* The bidding company (the company that owns the bid);
* The owner of the offer (the customer).

Other bidding participants do not have access to these files.

{% hint style="danger" %}
**Important!** Colleagues from the bidder's company cannot add or delete files in the bid, as they are not responsible for it.
{% endhint %}

The bidder can add to and remove files from the bids with the following statuses:

* Created;
* Accepted;
* Confirmed;
* Won.

Files can also be added during bid submission when the offer has "Published" status.

If the offer status is "Closed," file operations are not available.

#### Limits on the number and size of files

For convenience and stable operation of the system, the following limits have been established:

* Up to 15 active files per bid;
* Maximum file size: 35 MB;
* Up to 30 files in total (including deleted files).

If there are already 15 active files in the bid, "Add file" button becomes inactive.

#### Supported file formats

You can upload files of the following types: CSV, TSV, XLSX, XLS, ODS, PDF, DOCX, DOC, ODT, RTF, TXT, PNG, JPG/JPEG, TIFF, HEIC, SVG, PPTX, PPT, MP4, MOV, ZIP, RAR.

#### Archiving, history of adding and deleting the files

If more than two files are attached to a bid, "Download archive (.zip)" button appears. This allows you to download all files in a single archive.

If there are more than six files, "N more files" button will appear. The user responsible for the bid can see the full list of files.

For each file, the following information is displayed:

* Date and time of addition;
* Date and time of deletion (if the file was deleted).

<div align="left"><figure><img src="/files/RPUjOf5oZDCSyCDpTph3" alt=""><figcaption></figcaption></figure></div>

The time is displayed in the local time zone of the user viewing the bid.

{% hint style="danger" %}
**Important!** If a file is deleted within 10 minutes of being added, the system will not display the deletion mark, i.e. it will appear as if the file had never been added.
{% endhint %}

#### Security and privacy

All files undergo security checks. If malware is detected during upload, the file will not be added and the user will see a notification: "Malware detected. Cannot be added."

Files are also completely isolated within the offer and are only accessible to:

* the bidding company;
* the customer.

{% hint style="danger" %}
**Important!** Files you attach to the bid are only visible to you, your company and the customer. Others will not be able to view or download them.
{% endhint %}


# "Partners selection" mode

{% hint style="danger" %}
Available only for private offers in the “Bargain” and “Auction” modes.
{% endhint %}

#### What is it?

When publishing an offer on the public exchange, you can enable **"Partners Selection"** mode. This is a unique tool for finding new carriers who could become your long-term partners.

How it works:

1. You place freight offer with "Partners Selection" marking.
2. Carriers submit their bids by participating in the bidding process.
3. Once the winner has been selected you can invite them to your private exchange.

Thus, Roolz turns every offer into an opportunity to expand business relationships. It's not not just about transportation, but rather about the selection of the best offers.

#### To enable "Partners selection" mode you need to:

{% stepper %}
{% step %}
Fill out all necessary fields when creating the offer

<div align="left"><figure><img src="/files/6OLwm9wN8hr055yrJf8n" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Select "Private exchange" publishing option.

<div align="left"><figure><img src="/files/UXdhDg4FiaZRYNUSRpOW" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Click "Duplicate on public exchange" checkbox.

<div align="left"><figure><img src="/files/WIyQmNRAj3qDnafRCxPc" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Click on the "Partners selection" checkbox.

<div align="left"><figure><img src="/files/lBSziNWgOo5mBF2hmAsD" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Click "Publish now" button. Done! Your offer will accept bids from both current and potential partners.

<div align="left"><figure><img src="/files/7PSMxLKcuy8W28z2cwyW" alt=""><figcaption></figcaption></figure></div>
{% endstep %}
{% endstepper %}


# "Scheduled bidding start" feature

The scheduled bidding feature helps you plan your bids and publish your shipment in advance. Explore this section to learn how to use this feature in your bidding.

{% hint style="danger" %}
**Important!** This feature is available in the following offer modes: **Bargain, Auction** and **Fixed.**
{% endhint %}

#### What is it?

This tool allows cargo owners to publish offers in advance and set precise start and end times for the bidding process. This allows carriers to preview cargo and calculate rates in advance, while bidding begins and ends strictly within the specified timeframes, ensuring flexible planning and maximum transparency.

{% hint style="danger" %}
**Important!** This feature is available to companies on the **Pro, Expert** and **Enterprise** plans and works on both public and private exchange. It is not available to **Beginner** and **Free** plans or to **individuals**.
{% endhint %}

#### How will this feature help?

* Plan auctions and publish cargo in advance;
* Establish regulated processes;
* Provide carriers and forwarders with sufficient time to review offers and prepare for the auctions;
* Minimize errors and eliminate non-contractual changes during the auction.

#### How does it work?

{% stepper %}
{% step %}
Please fill in all required fields of the freight offer.

<div align="left"><figure><img src="/files/Q4YtNvWghrh9aNFntAQM" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
In the "Rate and payment" section, click "Open advanced options" block.

<div align="left"><figure><img src="/files/3ejX3iqD88s2PlvdIxmw" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Check "Scheduled bidding start" checkbox. Once enabled, two options will be available:

1. "Start in" — specify the time period, after which bids will begin to be accepted (from 30 minutes to 168 hours);
2. "Specify exact date and time" - manually select date and time.

<div align="left"><figure><img src="/files/yQDAeDN9ETxMI4eDS11r" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Specify duration of the bidding

<div align="left"><figure><img src="/files/5sQ81gfuhHHAXYXJxLHj" alt=""><figcaption></figcaption></figure></div>
{% endstep %}
{% endstepper %}

#### Features of the function:

1. If the "Specify exact date and time" option is selected:&#x20;

   * The time is specified in the user's local time zone;
   * A past date or time cannot be specified;
   * The start date cannot be later than the first loading date;
   * The system verifies the correctness of the values ​​when publishing the offer.

   Roolz continues to develop tools that simplify interactions between cargo owners and carriers, making processes more flexible, transparent and convenient.
2. The bidding duration is a mandatory parameter and affects the bidding behavior in each mode:

   * Auction: At the end of the duration, the system automatically selects a winner (unless the "Do not select a winner automatically" option is enabled).
   * Bargain and Fixed: At the end of the bidding, the bid is automatically removed from publication and goes into the archive cycle.

   If the specified duration extends beyond the first loading period, the system correctly ends the bidding when this date is reached—the bid is removed from publication and goes into the archive cycle.
3. The new mechanism is especially relevant for companies that frequently reopen offers. Now, when republishing an offer, the offer manager can:

   * reopen bids immediately,
   * or schedule the start time for a new bidding window (for example, tomorrow from 11:00 AM to 1:00 PM).

   The function settings are not available for editing in published and archived offers, eliminating any errors or changes to terms during the bidding process.
4. The system accommodates a wide range of scenarios:

   * When publishing an offer outside the editing form, a pop-up confirming the settings is displayed.
   * When automatically republishing (canceling or rejecting the winning bid), the delayed bid settings are reset and the offer is published immediately.
   * If the bidding time has partially elapsed, or if the auction is replayed or continued, the countdown is not saved; the user must reconfirm the settings.

   Furthermore, when this feature is enabled, the publication duration settings are hidden, preventing parameter conflicts.
5. The "Scheduled bidding start" feature is fully integrated with the platform's key mechanisms:
   * When creating an offer template, the deferred start settings are saved and applied when reusing the template;
   * When downgrading to a lower tariff, the feature disappears from new offers but remains active in existing ones;
   * When upgrading to a tariff that supports the feature, it automatically becomes available in previously created offers;
   * When the feature is enabled, the duplicate offer on the public exchange and the partner selection mechanism are unavailable, ensuring the correct operation of the deferred start logic.
6. The launch of the "Scheduled bidding start" feature allows companies to:
   * plan bidding in advance,
   * establish regulated processes,
   * provide carriers with sufficient time to review bids,
   * minimize errors and eliminate non-contractual changes during bidding.


# "My bids" section

### How do bids work?

{% stepper %}
{% step %}

### Like the cargo? Place a bid.

Cargo offers accept bids in the "Bargain" mode (bids are not accepted in the Ad mode). When submitting a bid, specify the price that corresponds to the currency and the type of taxation of the offer. You can offer your terms in the note section. If the bidding is no longer interesting for you, then simply cancel the bid and place it in the archive.

### Your bids are displayed in the following column

<div align="left"><figure><img src="/files/uqkAntZSsKbfBm1NZoR0" alt="" width="375"><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}

### Have you won? Confirm your bid.

Confirm your intention within the specified period. If you do not confirm the bid, it will be automatically rejected.

### Your bids are displayed in the following column

<div align="left"><figure><img src="/files/6SMvDMA2N6YFhYBuXL40" alt="" width="375"><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}

### Ready? Wait for the final acceptance

After confirming your bid, simply wait for the final acceptance from the shipper.

### Your bids are displayed in the following column

<div align="left"><figure><img src="/files/eXBIYsvfu1WqVMQkQScB" alt="" width="375"><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}

### The deal has been concluded

When the shipper accepts your bid, congratulations - the deal has been concluded 🎉 and the bid gets archived.

### Your bids are displayed in the following column

<div align="left"><figure><img src="/files/Pwsbw4wq76qSlzCImZKX" alt="" width="375"><figcaption></figcaption></figure></div>
{% endstep %}
{% endstepper %}


# Bid's status types

### Steps of processing your bid:

1. `created` — You have placed a bid on the offer that you like. This bid is considered active.
2. `accepted` — Your bid has been selected by the shipper and you have to confirm it.
3. `confirmed` — You have confirmed your win.
4. `won` — Your bid has won and the transportation is yours - congratulations! 🎉

But your bid can also have "Cancelled" status  `cancelled` (if you cancelled it) or "Rejected" `rejected` (if the shipper cancelled it manually or selected another bid).

#### If your bid was cancelled, there can be 3 reasons:

1. If the shipper has rejected your bid manually or the offer has been deleted/closed, then you will see "Rejected" indicator `rejected`.
2. If the shipper has chosen another bid, then you will see "Lost: another bid has been chosen" `lost_to_another`.
3. If you have not confirmed your bid on time, then you will see "You have not confirmed the bid" `confirm_runout`.

#### "Bargain" mode also has additional labels for the top-1 bid accounting for the taxation type:

* "Best with VAT" - if your bid is the best and includes VAT.
* "Best without VAT" - if your bid is the best and the tax is not included.

{% hint style="info" %}
A rejected bid may end up in the archive `archived`, but even a rejected bid may become a winning bid, in which case it returns to the active status.
{% endhint %}

#### An active bid (`created` ) has cost competitiveness indicators:

* In the "Bargain" mode: "Best", "Among the best", "Mid", "Losing".
* In the "Auction" mode: "Best" and "Outbid" (i.e. someone made a better bid).
* In the "Fix" mode, only the "Bid placed" indication will be displayed, since participants do not have the opportunity to offer their own price.

In the screenshot below you can see an example of what the bid cost competitiveness indicators look like.

<div align="left"><figure><img src="/files/ifPhUKc5RLpqdAdqJ0v3" alt=""><figcaption></figcaption></figure></div>


# Email notifications on offers and bids

The types of notifications sent to the users of Roolz transportation platform: about bidding modes, offers and bids.

We've added simple and clear email notifications so you don't miss important events related to your offers and bids and can respond promptly.

{% hint style="danger" %}
**Important!** Notification emails may end up in "Spam" or "Promotions" folder due to your email's corporate settings. Mark emails as "Not spam" to receive them in your Inbox.
{% endhint %}

All emails regarding offers and bids are sent from <team@roolz.net>. Each email has an option to unsubscribe.

### How notifications work:

Each email always contains a section with information about the specific offer. Email notifications are only sent to the user responsible for the following:

* The offer — the email is sent to the user assigned by the offer manager (not to all company users);
* The bid — the email is sent to the user responsible for that bid (i.e. the one who created and is managing it).

An exception is private offers. When sending a private offer (for freight or transport) to the partner, all users of the recipient company receive an email notification, not just the responsible user.

The email content language is selected automatically:

* if RU is specified on your profile, the message will be sent in Russian;
* if any other language is specified, the message will be sent in English.

### Email notifications on your offers (if you are responsible for the offer)

You will receive an email if:

1. **The winner has not confirmed their bid within the specified timeframe.**\
   If the winner fails to confirm their bid within the specified timeframe, the bid will be automatically rejected. You will receive an email and will be able to select a new winner.
2. **The winner has confirmed their bid (an email is sent for all bidding modes except for Fixed with "book now" feature selected).**\
   You will receive an email when the selected contractor has confirmed their bid and is ready to work. After this, you will need to confirm the deal.
3. **The winner has cancelled their bid.**\
   If the carrier/forwarder you selected cancels their bid, you will be immediately notified and can select another winner.
4. **A new bid has been placed on your offer.**\
   You will receive an email when a new bid from a carrier/forwarder has appeared for your offer. The email will include the amount, VAT type and carrier name so you can accept the bid or wait for the other bids.

<div align="left"><figure><img src="/files/i4cDkrPUTmkAeIIcXs6g" alt=""><figcaption></figcaption></figure></div>

### Email notifications on your bids (if you are responsible for the bid)

You will receive an email if:

1. **Your bid has won** (sent in all bidding modes except for Ad and Fixed mode with "Book now" feature selected).\
   You will receive an email if your bid wins. You must confirm your intention within the specified timeframe, otherwise another participant will be selected as the winner.
2. **Your bid has been accepted**\
   You will receive an email once your bid has been accepted. This means the shipment has been confirmed.
3. **Your bid has been rejected**\
   You will receive an email if your bid has been rejected for any reason.\
   A bid may be considered rejected in the following cases:

* the bid lost, i.e. the bidder selected a different bid;
* the offer owner manually rejected your bid;
* you were selected as the winner but failed to confirm your bid within the confirmation deadline.

### Email notifications regarding outbids in Auction mode

You will receive an email notification if another participant has offered a better bid in Auction mode and your bid is no longer the best.

{% hint style="danger" %}
**Important!** In this case, your bid is not rejected. Only its competitive status changes, i.e. there is now a bid with a better price in the auction.
{% endhint %}

This is especially important in Auction mode, as the winner is determined automatically based on the best price.

You'll see your bid value and freight information in the email, and you can immediately place a new bid if you want to continue bidding in the auction.

### Email notifications regarding a lost bid (in Bargain, Auction and Fix modes)

You will receive an email notification if the bidding time has ended and your bid has been defeated by another bidder (i.e. another bid has won).

The notification is sent for the following bidding modes: Bargain, Auction and Fix.

The email will indicate your bid value and the freight you bid on. This allows you to immediately see that the bidding has ended and that another bidder has been selected as the winner.

### Email notifications on private offers

When sending a private offer (for cargo or transport) to the partner, all users of the recipient company get an email notification about the new offer.

This helps your partner to immediately see the private offer and start working quicker.

<div align="left"><figure><img src="/files/GZuYJJwQ0liuKJ6k2GL1" alt=""><figcaption></figcaption></figure></div>

### Email notifications regarding the prolongation of the Auction when the winner has been selected

In Auction mode, a situation may arise where the bidding is extended.

If a winning bid is returned to bidding status, an email notification is sent to the user, which placed that bid.

This means that the auction has been extended and your bid is again included in the auction along with other bids.

<div align="left"><figure><img src="/files/Kx8cId34WmLdQju77xBC" alt=""><figcaption></figcaption></figure></div>

### Email notifications regarding automatic matching of cargo and transport

If you have an email address specified as your account login method and you have published public offers, for which the system has found matches, you will receive special email notifications about suitable offers.

{% hint style="info" %}
Automatic matching notifications are not sent for private offers.
{% endhint %}

In the future, you will be able to choose, which email notifications you want to receive in your settings.

There are 2 types of such notifications:

1. **Suitable offers found immediately after publication.**&#x20;

   You will receive an email as soon as your offer receives its first match after publication.

   This email is sent separately for each of your offers if matches are found. The email displays one offer that matches your published offer.
2. **Daily selection of suitable offers.**

   If you published offers and matches have been found, you will receive a daily email with the selection of suitable offers.

   Up to 10 matching offers are displayed in a single email. Offers are sorted from the most recently published to the oldest ones.

<div align="left"><figure><img src="/files/8FUpRB5p1bhBFx7k38AV" alt=""><figcaption></figcaption></figure></div>

{% hint style="info" %}
We recommend checking your email frequently while using Roolz platform to ensure you don't miss anything and stay up-to-date.
{% endhint %}


# Full guide

### What is a messenger, chats and what are they for?

In logistics, speed and consistency of communication are important.

Roolz messenger allows you to communicate with users directly in the system. You don't have to switch to a third-party messenger or email to clarify the details of transportation or send documents.

Roolz messenger is like a new social network, but in the world of logistics.

> "Using traditional messengers for work is one of the deadly sins of productivity".
>
> Constantine Ignatenko, co-founder of Roolz, a platform for organizing freight transportation.

<details>

<summary><strong>How to delete a message?</strong></summary>

Select message that you wish to delete. Use the right mouse click to view possible actions and select "Delete". Click "Confirm" in the window that appears.

Please, note that **in the chat you can only delete messages within 15 minutes of sending.** All deleted messages will be marked as "Message deleted". This is to prevent other participants from distorting the correspondence history and agreements.

In "Notes" chat, you can delete messages at any time.

</details>

<details>

<summary><strong>How to edit a message?</strong></summary>

Select message that you want to edit. Use the right mouse click to open the menu and select "Edit" option. You can now edit the message.&#x20;

Please, note that **in the chats you can only edit messages within 15 minutes of sending.** This is to prevent the other party from distorting the history of correspondence and agreements.

In "Notes" chat, you can edit your messages at any time.

</details>

<details>

<summary><strong>How to forward a message?</strong></summary>

1. Select message that you want to forward and right-click.
2. Select "Forward" from the menu that appears.

<img src="/files/NHutwHHTAHZd31FwOyt8" alt="" data-size="original">

3. A search box for your chats and contacts will open, where you can find the chat or the user than you want to send message to.

<img src="/files/qKkaM9NVY3O2x1C2s8l5" alt="" data-size="original">

4. When you find the recipient, click on them and the message will be forwarded.

</details>

<details>

<summary><strong>How to report a user?</strong></summary>

Send an email at **<support@roolz.net>** with the user's nickname and the reason for the complaint. We will review it and take action within two days.

</details>

<details>

<summary><strong>What types of files can be shared in chats?</strong></summary>

You can send almost any file format, including pdf, doc, xlsx, csv, etc.

If you send a photo or video file, the quality will be fully preserved.&#x20;

2GB is the maximum size for a single file to send. There is no limit to how long you can keep your files.

**❕Note.** When uploading a file, do not close the page or the download will be interrupted.

</details>


# Chat types and what you can do with them

### Messenger is actively developing. Now there are 2 types of chats available:

1. **Notes.** A special type of chat where you can keep notes and files just for yourself. Messages in Notes are only available to yourself. You cannot delete this chat, but you can clear all history, including the files.

<div align="left"><figure><img src="/files/S5Dm4sUIC6L8bYqW38Ie" alt="" width="375"><figcaption></figcaption></figure></div>

2. **Personal chat.** Your private chats. Your chat history is only available to you and the person you are chatting with. Deleting a personal chat means that your chat history will only be deleted for you, but will be kept for the receiver. If the person who sent you a message is not your contact, you can block them or add them to your contacts.

<div align="left"><figure><img src="/files/OXu9405SFI5HBYUiLwhG" alt="" width="375"><figcaption></figcaption></figure></div>

### What you can do with the chats:

* **Pin.** You can pin up to 5 chats, which will appear at the top of the chat list in the left menu. To pin a chat, click on the chat you wish to pin. Click on the three dots in the upper right corner. Select "Pin" from the actions drop-down list.

<div align="left"><figure><img src="/files/SNTlBwDHuPoEmu2Q7Wdf" alt="" width="375"><figcaption></figcaption></figure></div>

* **Turn notifications on and off**. In the upper right corner of the chat, click on the three dots and select "Mute/Unmute" from the actions drop-down list.

<div align="left"><figure><img src="/files/L6gk0cmnvR4tQOgeiSmO" alt="" width="375"><figcaption></figcaption></figure></div>

* **Mark as read**. If you don't want to read chat messages right now, you can mark the chat as read. Open menu with the right-click and select "Mark as read". You will mark the chat as read, but the messages themselves will not be read.\
  You can also do the opposite. If you want to mark a chat that you've already read so that you don't forget about it, open the menu with the right-click and select "Mark as unread". In this case, a blue circle will appear to the right of the selected chat in the chat list.

<div align="left"><figure><img src="/files/uQE7S6gr5ksHjXxHV4pL" alt="" width="375"><figcaption></figcaption></figure></div>

* **Delete.** Click on the chat that you want to delete. Click on the three dots in the upper right corner and select "Delete" from the drop down list.

<div align="left"><figure><img src="/files/aFcTaAdVAqJPtBztv0uD" alt="" width="375"><figcaption></figcaption></figure></div>

* **Expand, change the position and size of the chat window.** You can expand an open chat to almost the whole page. Click the button: <img src="/files/BQoaTbpDMCA0UAvLoAVZ" alt="" data-size="line">

<div align="left"><figure><img src="/files/mfTLQRGVRoqZL3fU1VFA" alt="" width="375"><figcaption></figcaption></figure></div>

You can change the position of the chat window by moving it to the right or left and stretching it. To do this, move the cursor across the top of the window between the chat name (or the name of the person you are talking to) and the buttons on the right. Once the cursor changes to a "hand", press and hold the cursor to change the position and/or size of the chat window.

<div align="left"><figure><img src="/files/AmeAtwQLy0JGyuvUlZoD" alt="" width="375"><figcaption></figcaption></figure></div>

### You can do the following messaging operations:

* **Send text messages**. A message can contain up to 4096 characters. Message storage history is unlimited.
* **Send files**. Files are sent one message at a time. Almost all file formats are available, including pdf, doc, xlsx and csv. When uploading a file, do not close the page or the upload will fail. If you are sending a photo or video file, the quality will be fully preserved. 2 GB is the maximum size of one file. The file storage history is unlimited.
* **Forward**. You can forward a text message or file from one chat to another. Often important messages are forwarded to notes so you don't forget anything important.
* **Reply**. This quotes the message you are about to reply to. You can send a text message as a reply to a specific message or as an attachment to another message.
* **Copy**. Allows you to copy text from a message.
* **Edit**. You can only edit your own messages, but the ability to edit depends on the type of chat. In the case of a personal chat, you can only edit messages within 15 minutes of sending. This is to prevent other participants from distorting the correspondence history and agreements. In case of "Notes" chat, you can edit any message regardless of the time it was sent.
* **Delete**. You can only delete your own messages, but the ability to delete depends on the type of chat. In case of "Notes" chat, you can delete any message.

{% hint style="danger" %}
**Note!** In a personal chat, you can only delete messages within 15 minutes after sending, and deleted messages are marked as "Message deleted". In this way, participants cannot distort the history of correspondence and agreements.
{% endhint %}


# How do I know if someone read my message?

There are 5 message statuses:

1. **Loading and sending.** The clock icon <img src="/files/0C2mZAebUbXcDNk2pjKx" alt="" data-size="line"> is displayed. When the message is being sent, do not close the page.

<div align="left"><figure><img src="/files/vFUOBKl8Tf0skdqVbD8b" alt="" width="375"><figcaption></figcaption></figure></div>

2. **Loading and sending error.** The red icon <img src="/files/mw82ysuatni7NQCb30Sz" alt="" data-size="line"> is displayed. You can delete message and send it again.

<div align="left"><figure><img src="/files/DVtaQ0dL704XmkCO2Lt5" alt="" width="375"><figcaption></figcaption></figure></div>

3. **Sent.** A single gray check mark <img src="/files/OZcB25GqglNR57aXXfFX" alt="" data-size="line"> appears, indicating that the message has been sent but not yet delivered to the recipient's device.

<div align="left"><figure><img src="/files/CkB9Qgf9Ilz8pUcjzSU1" alt="" width="375"><figcaption></figcaption></figure></div>

{% hint style="danger" %}
**Note!** If a message stays in this status for a long time, the person you are messaging is probably logged out of their Roolz account on all devices. When they log in again, they will see the message that you sent.
{% endhint %}

4. **Delivered.** 2 gray check marks <img src="/files/nnA6FMBqNmCl40Z1Ux4n" alt="" data-size="line"> are displayed. The user received the message, i.e. it has been delivered to the user's active device, but has not yet been read.

<div align="left"><figure><img src="/files/CH1Y4dlCysOc0qytcmhf" alt="" width="375"><figcaption></figcaption></figure></div>

5. **Read.** 2 blue check marks <img src="/files/ykSO4X0UXOYzmU7iTnWy" alt="" data-size="line"> are displayed. The user open the chat and read your message.

<div align="left"><figure><img src="/files/ZMAGBAUfxkxQh4CzaUCl" alt="" width="375"><figcaption></figcaption></figure></div>


# Blocking users and blacklist

### What is user blocking?

**Blocking a user** is adding a user to your personal blacklist.

If you do not want a particular user to be able to find you and send you messages, you can block them.

When a user is blocked:

* Both you and the user cannot send messages to each other in the personal chat. Instead of the message input field you will see a notification that you blocked the user or that the user blocked you.

<figure><img src="/files/9TDIize4BUsTyVlIsXV3" alt=""><figcaption></figcaption></figure>

* When a user is blocked, they cannot be in your contacts. You will also be removed from their contact list (if you were previously in it).
* A blocked user cannot view blacklisted user's profile.
* A blocked user cannot find blocked user through the search.

### How to block and unblock a user?

There are 3 ways:

* **In the user's profile.** Tap the three dots in the user's profile to display the block or unblock button.

<div align="left"><figure><img src="/files/A1Bs7ZS3YfKLTBtozgU1" alt="" width="375"><figcaption></figcaption></figure></div>

* **On the "Blocked users page".** Click on your photo in the upper right corner, expand "Settings" in the menu that appears, and click "Blocked users".\
  This page displays a list of users that you blocked. You can unblock them and add new users to the blacklist through the search.

<div align="left"><figure><img src="/files/lTDVHjXGTfRyjICqSqKr" alt="" width="375"><figcaption></figcaption></figure></div>

* **In the chat box**, if the user is not in your contacts.

  If the user is blocked, an unblock button appears at the bottom of the chat correspondence window.

<figure><img src="/files/nqNDciSbpXZ3bYv2WS6b" alt=""><figcaption></figcaption></figure>

{% hint style="danger" %}
**Note!** You cannot block a user who is in the same company as you.
{% endhint %}


# SpotGo

An interactive window will help you find out how to integrate your company with SpotGo (browse):

{% embed url="<https://app.storylane.io/share/pobt9z7uq2ov>" %}

### Text instruction:

If you are planning to use SpotGo to publish offers, please note that it is a paid platform that has more than 12 top European marketplaces with shipments for transportation to/from Europe (it does not have Russian exchanges). And now Roolz users can receive real-time freight offers from SpotGo, choose the best conditions and place offers instantly, optimizing work and reducing search time.

{% hint style="danger" %}
**Note!** To fully access all integration features, you must be working in Roolz space on behalf of the company.
{% endhint %}

{% hint style="danger" %}
**Note!** The email used to register with Roolz must match the email registered with SpotGo and vice versa.
{% endhint %}

### Step-by-step guide on how to connect to SpotGo:

{% stepper %}
{% step %}
Open "Settings" section in the upper right corner of Roolz platform.
{% endstep %}

{% step %}
In the "Company account" window that appears, click "API Key: Generate".
{% endstep %}

{% step %}
Copy your company's API key, go to SpotGo website and use it to set up the integration.
{% endstep %}
{% endstepper %}

### The next step is to set up the integration on SpotGo side.

{% stepper %}
{% step %}
Register or login to SpotGo platform. Once logged in, you will be taken to the homepage.
{% endstep %}

{% step %}
Go to "Integrations" section on the left, which provides a list of transportation exchanges already integrated with SpotGo.
{% endstep %}

{% step %}
In "Company Settings" section, find Roolz platform.

* In the "API KEY" field, paste the copied key from Roolz.
* Click "Update" to save settings.
  {% endstep %}

{% step %}
Open the "User settings" section and find Roolz platform again.
{% endstep %}

{% step %}
Make sure your "User ID" appears in Roolz field. If the field is empty, contact Roolz at **<support@roolz.net>** and they will help you resolve the issue.
{% endstep %}
{% endstepper %}

Congratulations! The integration has been successfully set up 🎉 Now you get more feedback on your offers and can choose the best options for your company! **Digital logistics is easy when you have the right tools. 🚀**


# Introduction

Welcome! This documentation and our public API will help you integrate your internal systems with our freight exchange platform.

### Test Environment

To begin integration and test your requests, you’ll need to create a company account in our test environment: [test.roolz.tech](https://test.roolz.tech).

### Getting an API Key

To start working with our public API, you need to generate an API key, which will be used to authorize requests within our system. Follow these steps:

1. Open **"Management"** section at the top right of Roolz exchange.
2. In the pop-up window titled **"Company Account"**, click **"API Key: Yes, generate"**.
3. Copy your company’s API key and use it to enable integration.

### Switching environment from Test to Production

Once you completed and configured your integration in our test environment, please contact our [technical support team](mailto:support@roolz.net) to receive access credentials for the production server. After that, you’ll be able to generate an API key on the main platform and then, by using the server address provided by the support, to fully activate your integration with Roolz.


# Offers

{% hint style="info" %}
Useful links: [Offers: editing, activity and statuses](/en/offers-editing-activity-and-statuses) and [What are the offer statuses?](/en/offers-editing-activity-and-statuses/what-are-the-offer-statuses)
{% endhint %}

## POST /exchange/offer

> Creating a single offer

```json
{"openapi":"3.0.1","info":{"title":"Roolz Public API","version":"1.1"},"servers":[{"url":"https://api.test.roolz.tech/public-api/v1","description":"Test environment for development"}],"security":[{"getKey":[]},{"headerKey":[]}],"components":{"securitySchemes":{"getKey":{"type":"apiKey","description":"API key for authorizing requests in GET parameters","name":"apikey","in":"query"},"headerKey":{"type":"apiKey","description":"API key for authorizing requests in header","name":"X-Api-Key","in":"header"}},"parameters":{"ContentTypeHeader":{"in":"header","name":"Content-Type","required":true,"description":"","schema":{"type":"string","default":"application/json","enum":["application/json"]}},"AcceptEncodingHeader":{"in":"header","name":"Accept-Encoding","required":true,"description":"","schema":{"type":"string","default":"gzip","enum":["gzip"]}}},"schemas":{"ExchangeOfferCreateRequest":{"required":["status","type","is_public","is_private","payment","route"],"properties":{"status":{"type":"string","description":"The status of the created offer. At the moment, only offers in the not published status are allowed to be created","enum":["not_published"]},"type":{"type":"string","description":"Type of offer (transport/cargo). Also determines the requirements for the request","enum":["transport","cargo"]},"is_public":{"type":"boolean","description":"The offer is published on a public exchange"},"is_private":{"type":"boolean","description":"The offer is published on a private exchange"},"is_all_private_partners":{"type":"boolean","description":"The offer on the private exchange will be received by all partners of the owner company. The field is displayed only in personal offers"},"private_partners":{"type":"array","minItems":0,"description":"IDs of partner companies that will receive private offer. The field is displayed only in personal offers","items":{"type":"string","format":"UUID"}},"description":{"type":"string","description":"Additional description in the offer"},"payment":{"$ref":"#/components/schemas/PaymentDataCreateRequest"},"route":{"type":"array","items":{"$ref":"#/components/schemas/RoutepointCreateRequest"}},"cargo_units":{"description":"Description of cargo (currently the array size should be equal to 1)","type":"array","items":{"$ref":"#/components/schemas/CargoUnitCreateRequest"}},"transportation_requirement":{"description":"Transportation requirements (for freight offer only)","allOf":[{"$ref":"#/components/schemas/TransportRequirementsCreateRequest"}]},"transport":{"description":"Transport description (only for transport offer)","allOf":[{"$ref":"#/components/schemas/TransportSpecificationCreateRequest"}]},"publication_lifetime":{"$ref":"#/components/schemas/PublicationLifetimeCreateRequest"},"bid_privacy":{"$ref":"#/components/schemas/BidPrivacyCreateRequest"}}},"PaymentDataCreateRequest":{"type":"object","properties":{"quote_is_vat":{"type":"boolean","description":"Bid with VAT"},"is_prepay":{"type":"boolean","description":"Is there a prepayment"},"bid_is_vat":{"type":"boolean","description":"Accept bids with VAT"},"bid_is_no_vat":{"type":"boolean","description":"Accept bids without VAT"},"bid_is_not_unique":{"type":"boolean","description":"Uniqueness of the bid within the space. Forbids/allows to give several bids at the same time (for example, to give different conditions in \"bidding mode\")"},"currency":{"type":"string","description":"Currency"},"payment_condition":{"type":"string","description":"Payment terms"},"payment_method":{"type":"string","description":"Payment method"},"bid_mode":{"type":"string","description":"Bidding mode"},"quote":{"type":"number","format":"decimal","nullable":true,"description":"Target transportation bid in the specified currency in the freight offer"},"extra_quote":{"type":"number","format":"decimal","nullable":true,"description":"Additional bid. If the main bid is specified as a bid with VAT, then the additional bid is displayed as \"without VAT\""},"quote_mileage":{"type":"number","format":"decimal","nullable":true,"description":"Bid in a transport offer; set per unit of mileage (kilometer, mile, etc.)"},"bid_auction_step":{"type":"number","format":"decimal","nullable":true,"description":"Minimum auction step size"},"vat":{"type":"number","format":"decimal","nullable":true,"description":"VAT bid"},"mileage_format":{"type":"string","nullable":true,"description":"Mileage unit for the bid in the transport offer (km, miles, etc.)"},"prepay_percent":{"type":"integer","format":"int64","nullable":true,"description":"Prepayment amount as a percentage of the bid. Only integer values ​​up to 100"},"payment_period":{"type":"integer","format":"int64","nullable":true,"description":"Payment period in days"},"bid_confirm_timeframe":{"type":"integer","format":"int64","nullable":true,"description":"Time for bid confirmation (in seconds)"}},"required":["quote_is_vat","is_prepay","bid_is_vat","bid_is_no_vat","bid_is_not_unique","currency","payment_condition","payment_method","bid_mode"]},"RoutepointCreateRequest":{"properties":{"order":{"type":"integer","description":"Waypoint ordinal number"},"point_type":{"type":"string","description":"Type of waypoint on Roolz exchange platform","enum":["loading","unloading","border","customs","waypoint"]},"time_zone":{"type":"string","description":"Time zone of the waypoint in minute offset from UTC"},"location":{"$ref":"#/components/schemas/LocationDataCreateRequest","description":"Information about the location"},"start_datetime":{"$ref":"#/components/schemas/DateTimeObject","description":"Start date of the transportation operations at the waypoint","nullable":true},"end_datetime":{"$ref":"#/components/schemas/DateTimeObject","description":"End date of the transportation operations at the waypoint","nullable":true},"loading_type":{"description":"Method of loading/unloading a vehicle","type":"array","nullable":true,"items":{"type":"string"}}}},"LocationDataCreateRequest":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"Object ID (from object search query)"},"is_radius":{"type":"boolean"},"type":{"type":"string","description":"Object type (from object search query)"},"position_type":{"type":"string","description":"Point type"},"radius":{"type":"integer","format":"int32","nullable":true,"description":"Radius"}},"required":["id","is_radius","type","position_type"]},"DateTimeObject":{"required":["date","time"],"properties":{"date":{"type":"string","format":"Y-m-d","description":"Date"},"time":{"type":"string","format":"HH:mm:ss","description":"Time"}}},"CargoUnitCreateRequest":{"description":"Cargo information for the cargo offer","required":["weight","volume"],"properties":{"name":{"type":"string","description":"Name of cargo"},"type":{"type":"string","description":"Type of cargo","enum":["liquid_bulk","break_bulk","dry_bulk","groupage","oversized","container","eur_pallet","fin_pallet","oth_pallet","bag","big_bag","icb","carton","barrel","roll","reel","coil","crate"]},"quantity":{"type":"integer","description":"Quantity of cargo, pcs.","nullable":true},"weight":{"type":"integer","format":"float","description":"Cargo weight, tons"},"volume":{"type":"integer","format":"float","description":"Cargo volume, cubic meters"},"adr_class":{"type":"string","description":"ADR cargo class","nullable":true,"enum":["no","any_dangerous","adr_1","adr_2_1","adr_2_2","adr_2_3","adr_3","adr_4_1","adr_4_2","adr_4_3","adr_5_1","adr_5_2","adr_6_1","adr_6_2","adr_7","adr_8","adr_9"]},"length":{"type":"integer","format":"float","description":"Cargo length, meters","nullable":true},"width":{"type":"integer","format":"float","description":"Cargo width, meters","nullable":true},"height":{"type":"integer","format":"float","description":"Cargo height, meters","nullable":true},"temperature_min_c":{"type":"integer","format":"float","description":"Minimum required transportation temperature, degrees Celsius","nullable":true},"temperature_max_c":{"type":"integer","format":"float","description":"Maximum required transportation temperature, degrees Celsius","nullable":true},"price":{"$ref":"#/components/schemas/CargoPriceCreateRequest","description":"Cargo price","nullable":true}}},"CargoPriceCreateRequest":{"properties":{"currency":{"type":"string","description":"Price currency"},"value":{"type":"integer","format":"float","description":"Price of cargo in the specified currency"}}},"TransportRequirementsCreateRequest":{"description":"Requirements for cargo transportation","required":["body"],"properties":{"is_trailer_interchange":{"type":"boolean","description":"Trailer interchange required"},"shipping_mode":{"type":"string","description":"Type of transportation. Possible options: FTL, LTL, Special and Any","enum":["any","ftl","ltl","special"]},"type":{"type":"string","description":"The type of vehicle required for cargo transportation. For example, LCV, special machinery, etc.","enum":["any","lcv","solo","special_machinery","lorry"]},"body":{"type":"array","description":"Vehicle body types required for cargo transportation","items":{"type":"string","enum":["curtainside","box","insulated","ref","open_body","flat_bed","deeploader","tipper","cont_carrier","cont_open","cont_closed","tank_cont","tank_fuel","tank_bitumen","tank_gas","tank_chemical","tank_food","silo_food","silo_non_food","tank_other","car_carrier","log_carrier","cattle_carrier","grain_truck","meat_hooker","road_tractor","other","crane_truck","lift_truck","tow_truck","tractor","dozer","loader"]}},"equipment":{"type":"array","description":"Additional required equipment","nullable":true,"items":{"type":"string"}},"quantity":{"type":"string","description":"Number of cargo units","nullable":true}}},"TransportSpecificationCreateRequest":{"description":"Transport characteristics for the transport offer","required":["type","body","available_weight","available_volume"],"properties":{"is_trailer_interchange":{"type":"boolean","description":"Possibility of trailer interchange"},"type":{"type":"string","enum":["any","lcv","solo","special_machinery","lorry"]},"temperature_min_c":{"type":"integer","format":"float","description":"Minimum transportation temperature maintained by the vehicle, degrees Celsius","nullable":true},"temperature_max_c":{"type":"integer","format":"float","description":"Maximum transportation temperature maintained by the vehicle, degrees Celsius","nullable":true},"available_weight":{"type":"integer","format":"float","description":"Weight available for loading, tons"},"available_volume":{"type":"integer","format":"float","description":"Volume available for loading, cubic meters"},"length":{"type":"integer","format":"float","description":"Length available for loading, meters","nullable":true},"width":{"type":"integer","format":"float","description":"Width available for loading, meters","nullable":true},"height":{"type":"integer","format":"float","description":"Height available for loading, meters","nullable":true},"shipping_mode":{"type":"array","description":"Type of transportation. Possible options: FTL, LTL, Special and Any","minItems":0,"items":{"type":"string","enum":["any","ftl","ltl","special"]}},"adr_class":{"type":"array","description":"ADR class (cargo hazard class) approved for transportation","minItems":1,"items":{"type":"string","enum":["no","any_dangerous","adr_1","adr_2_1","adr_2_2","adr_2_3","adr_3","adr_4_1","adr_4_2","adr_4_3","adr_5_1","adr_5_2","adr_6_1","adr_6_2","adr_7","adr_8","adr_9"]}},"body":{"type":"array","minItems":0,"description":"Vehicle body type"},"equipment":{"type":"string","description":"Additional equipment","nullable":true},"loading_type":{"type":"array","minItems":0,"description":"Possible methods of loading into a vehicle.","items":{"type":"string","enum":["rear","side","side_by_side","rack_off","top","tent_off"]}}}},"PublicationLifetimeCreateRequest":{"description":"Publication duration settings","required":["lifetime"],"properties":{"lifetime":{"type":"integer","description":"Publication duration (in seconds)"},"is_first_bid":{"type":"boolean","description":"Start publication countdown only after the first bid"}}},"BidPrivacyCreateRequest":{"description":"Bidding privacy settings in the offer","properties":{"allow_view_bidder":{"type":"boolean","description":"Show bid owner"},"allow_view_quote":{"type":"boolean","description":"Show bid"},"allow_view_comment":{"type":"boolean","description":"Show bid comments"}}},"ExchangeOffer":{"required":["id","name","type","status","creation_method","is_public","is_private","company_id","description","assignee_users","is_autoclosed","is_publication_autocanceled","publication_autocancel_type","publication_autocancel_at","status_changed_at","published_at","closed_at","autoclose_at","is_all_private_partners","private_partners","payment","route","route_way","transportation_requirement","cargo_units","transport","created_at","updated_at"],"properties":{"id":{"type":"string","description":"Offer ID on Roolz exchange platform"},"name":{"type":"string","description":"Public name of the offer"},"type":{"type":"string","description":"Offer type","enum":["cargo","transport"]},"status":{"type":"string","description":"Current offer status","enum":["not_published","published","await_confirm","confirmation","deal_made","closed"]},"creation_method":{"type":"string","description":"Method of creating an offer. Possible options: manual, via API (api)","enum":["manual","api"]},"is_public":{"type":"boolean","description":"The offer is published on a public exchange"},"is_private":{"type":"boolean","description":"The offer is published on a private exchange"},"is_public_duplicate":{"type":"boolean","description":"A public duplicate has been created based on this offer."},"is_partners_selection":{"type":"boolean","description":"Partner selection option activated (for public duplicate)"},"company_id":{"type":"string","format":"UUID","description":"Internal owner-company ID of the offer on Roolz exchange platform"},"description":{"type":"string","description":"Additional description of the offer"},"assignee_users":{"type":"array","minItems":1,"description":"Users assigned as responsible for the offer. The field is only displayed for the owner of the offer and the for the incoming offers of the private exchange","items":{"$ref":"#/components/schemas/OfferAssigneeUser"}},"is_autoclosed":{"type":"boolean","description":"The offer has been closed (sent to archive) automatically"},"is_publication_autocanceled":{"type":"boolean","description":"The offer has been removed from publication automatically"},"publication_autocancel_type":{"type":"string","description":"Type (reason) of automatic offer removal from publication","nullable":true},"publication_autocancel_at":{"type":"string","description":"Date and time of the automatic offer removal from publication (in UTC)","nullable":true},"status_changed_at":{"type":"string","description":"Date and time of the last change in the offer status","nullable":true},"published_at":{"type":"string","description":"Date and time of the offer publication","nullable":true},"closed_at":{"type":"string","description":"Date and time of the offer closing (archiving)","nullable":true},"autoclose_at":{"type":"string","description":"Date and time of the automatic offer closing (archiving)","nullable":true},"is_all_private_partners":{"type":"boolean","description":"The offer on the private exchange will be received by all partners of the owner company. The field is only displayed in personal offers"},"private_partners":{"type":"array","minItems":0,"description":"IDs of partner companies that will receive private offer. The field is only displayed in personal offers","items":{"type":"string","format":"UUID"}},"payment":{"description":"Payment settings and details","$ref":"#/components/schemas/Payment"},"route":{"type":"array","description":"Waypoints in the offer","items":{"$ref":"#/components/schemas/OfferRoute"}},"route_way":{"description":"Calculated route","$ref":"#/components/schemas/OfferRouteWay"},"transportation_requirement":{"description":"Transportation requirements for cargo offers","$ref":"#/components/schemas/OfferTransportationRequirement"},"cargo_units":{"type":"array","description":"Cargo characteristics for cargo offers","nullable":true,"items":{"$ref":"#/components/schemas/OfferCargoUnit"}},"transport":{"description":"Transport characteristics for transport offers","nullable":true,"$ref":"#/components/schemas/OfferTransport"},"publication_lifetime":{"description":"Publication duration","nullable":true,"$ref":"#/components/schemas/PublicationLifetime"},"bid_privacy":{"description":"Bidding privacy","nullable":true,"$ref":"#/components/schemas/BidPrivacy"},"created_at":{"type":"string","description":"Date and time of the offer creation (in UTC)"},"updated_at":{"type":"string","description":"Date and time of the last offer change (in UTC)"}}},"OfferAssigneeUser":{"required":["id","contact_methods"],"properties":{"id":{"type":"string","format":"UUID","description":"User ID on Roolz exchange platform"},"contact_methods":{"type":"array","minItems":1,"description":"Methods of communication with the user","items":{"$ref":"#/components/schemas/UserContactMethod"}}}},"UserContactMethod":{"required":["method","value"],"properties":{"method":{"type":"string","description":"Methods of communication with the user","enum":["phone","email"]},"value":{"type":"string","description":"Communication method"}}},"Payment":{"properties":{"is_prepay":{"type":"boolean","description":"Is there a prepayment"},"currency":{"type":"string","description":"Bidding currency"},"quote_is_vat":{"type":"boolean","description":"Bid with VAT","nullable":true},"quote":{"type":"number","format":"decimal","nullable":true,"description":"Target transportation bid in the specified currency in the freight offer"},"extra_quote":{"type":"number","format":"decimal","nullable":true,"description":"Additional bid. If the main bid was specified as a bid with VAT, then the additional bid is displayed as \"without VAT\""},"vat":{"type":"number","format":"decimal","nullable":true,"description":"VAT bid"},"quote_mileage":{"type":"number","format":"decimal","nullable":true,"description":"Bid in a transport offer; set per unit of mileage (kilometer, mile, etc.)"},"prepay_amount":{"type":"number","format":"decimal","nullable":true,"description":"Amount of prepayment in currency"},"prepay_percent":{"type":"integer","format":"int64","nullable":true,"description":"Prepayment amount as a percentage of the bid. Only integer values ​​up to 100"},"payment_period":{"type":"integer","format":"int64","nullable":true,"description":"Payment period in days"},"mileage_format":{"type":"string","nullable":true,"description":"Mileage unit for the bid in the transport offer (km, miles, etc.)"},"payment_condition":{"type":"string","description":"Payment terms","nullable":true},"payment_method":{"type":"string","description":"Payment method","nullable":true},"bid_mode":{"type":"string","description":"Bidding mode"},"bid_is_vat":{"type":"boolean","description":"Accept bids with VAT","nullable":true},"bid_is_no_vat":{"type":"boolean","description":"Accept bids without VAT","nullable":true},"bid_auction_step":{"type":"number","format":"decimal","nullable":true,"description":"Minimum auction step size"},"bid_is_auto_accept":{"type":"boolean","nullable":true},"bid_is_not_unique":{"type":"boolean","description":"Uniqueness of the bid within the space. Forbids/allows to place several bids at the same time (for example, to give different conditions in \"bidding mode\")"},"bid_confirm_timeframe":{"type":"integer","format":"int64","nullable":true,"description":"Time for bid confirmation (in seconds)"},"allow_first_bid_no_step":{"type":"boolean","nullable":true}}},"OfferRoute":{"description":"Waypoint","required":["order","point_type","time_zone","point_timezone","location","start_datetime","end_datetime","loading_type"],"properties":{"order":{"type":"integer","description":"Waypoint ordinal number"},"point_type":{"type":"string","description":"Type of waypoint on Roolz exchange platform","enum":["loading","unloading","border","customs","waypoint"]},"time_zone":{"type":"string","description":"Time zone of the waypoint in minute offset from UTC"},"point_timezone":{"type":"string","description":"TZ time zone ID of the waypoint"},"location":{"$ref":"#/components/schemas/OfferRouteLocation","description":"Waypoint data"},"start_datetime":{"$ref":"#/components/schemas/DateTimeObject","description":"Start date of the transportation operations at the waypoint"},"end_datetime":{"$ref":"#/components/schemas/DateTimeObject","description":"End date of the transportation operations at the waypoint","nullable":true},"loading_type":{"type":"array","description":"Method of loading/unloading a vehicle","nullable":true,"items":{"type":"string"}}}},"OfferRouteLocation":{"description":"Waypoint data","required":["osm_id","osm_type","full_osm_id","position_type","is_radius","address","radius","access_point"],"properties":{"osm_id":{"type":"integer","description":"Waypoint ID in OSM database"},"osm_type":{"type":"string","description":"Waypoint type in OSM database"},"full_osm_id":{"type":"string","description":"Full ID of the waypoint in OSM database"},"position_type":{"type":"string","description":"General type of the waypoint in OSM database"},"is_radius":{"type":"boolean","description":"Determines whether a radius to extend the waypoint is set"},"address":{"$ref":"#/components/schemas/OfferRouteLocationAddress"},"radius":{"type":"integer","description":"Radius (if specified) extending the waypoint, in meters","nullable":true},"access_point":{"$ref":"#/components/schemas/OfferRouteLocationAccessPoint"}}},"OfferRouteLocationAddress":{"description":"Address of the waypoint","required":["title","name","lang","country_code","country_name","state_name","state_code","city","district","sub_district","street","postal_code","house_number"],"properties":{"title":{"type":"string","description":"Full name of the waypoint object"},"name":{"type":"string","description":"Given name of the waypoint object"},"lang":{"type":"string","description":"ISO 639-1 waypoint language code","nullable":true},"country_code":{"type":"string","description":"Alpha2 waypoint country code"},"country_name":{"type":"string","description":"Name of the waypoint country"},"state_name":{"type":"string","description":"The name of the internal administrative unit that the waypoint belongs to","nullable":true},"state_code":{"type":"string","description":"Code of the internal administrative unit that the waypoint belongs to","nullable":true},"city":{"type":"string","description":"The city that the waypoint belongs to","nullable":true},"district":{"type":"string","description":"The district of ​​the city that the waypoint belongs to","nullable":true},"sub_district":{"type":"string","description":"The microdistrict of the city that the waypoint belongs to","nullable":true},"street":{"type":"string","description":"The name of the street that the waypoint belongs to","nullable":true},"postal_code":{"type":"string","description":"The postal code that the waypoint belongs to","nullable":true},"house_number":{"type":"string","description":"The house number that the waypoint belongs to","nullable":true}}},"OfferRouteLocationAccessPoint":{"description":"Geo json route points","required":["type","coordinates"],"properties":{"type":{"type":"string","enum":["Point"]},"coordinates":{"type":"array","minItems":2,"maxItems":2,"items":{"type":"integer","format":"float"}}}},"OfferRouteWay":{"description":"Data of the calculated cargo transportation route","required":["total_length","total_dur"],"properties":{"total_length":{"type":"integer","description":"Distance of the calculated route in meters"},"total_dur":{"type":"integer","description":"Duration of the calculated route in seconds"}}},"OfferTransportationRequirement":{"description":"Cargo transportation requirements","required":["is_trailer_interchange","shipping_mode","type","body","equipment","quantity"],"properties":{"is_trailer_interchange":{"type":"boolean","description":"Trailer interchange required"},"shipping_mode":{"type":"string","description":"Type of transportation. Possible options: FTL, LTL, Special and Any","enum":["any","ftl","ltl","special"]},"type":{"type":"string","description":"The type of vehicle required for cargo transportation. For example, LCV, special machinery, etc.","enum":["any","lcv","solo","special_machinery","lorry"]},"body":{"type":"array","description":"Vehicle body types required for cargo transportation","items":{"type":"string","enum":["curtainside","box","insulated","ref","open_body","flat_bed","deeploader","tipper","cont_carrier","cont_open","cont_closed","tank_cont","tank_fuel","tank_bitumen","tank_gas","tank_chemical","tank_food","silo_food","silo_non_food","tank_other","car_carrier","log_carrier","cattle_carrier","grain_truck","meat_hooker","road_tractor","other","crane_truck","lift_truck","tow_truck","tractor","dozer","loader"]}},"equipment":{"type":"string","description":"Additional equipment required","nullable":true},"quantity":{"type":"string","description":"Number of cargo units","nullable":true}}},"OfferCargoUnit":{"description":"Cargo information for the cargo offer","required":["name","type","quantity","weight","volume","adr_class","length","width","height","temperature_min_c","temperature_max_c","price"],"properties":{"name":{"type":"string","description":"Name of cargo"},"type":{"type":"string","description":"Type of cargo","enum":["liquid_bulk","break_bulk","dry_bulk","groupage","oversized","container","eur_pallet","fin_pallet","oth_pallet","bag","big_bag","icb","carton","barrel","roll","reel","coil","crate"]},"quantity":{"type":"integer","description":"Quantity of cargo, pcs.","nullable":true},"weight":{"type":"integer","format":"float","description":"Cargo weight, tons","nullable":true},"volume":{"type":"integer","format":"float","description":"Cargo volume, cubic meters","nullable":true},"adr_class":{"type":"string","description":"ADR cargo class","nullable":true,"enum":["no","any_dangerous","adr_1","adr_2_1","adr_2_2","adr_2_3","adr_3","adr_4_1","adr_4_2","adr_4_3","adr_5_1","adr_5_2","adr_6_1","adr_6_2","adr_7","adr_8","adr_9"]},"length":{"type":"integer","format":"float","description":"Cargo length, meters","nullable":true},"width":{"type":"integer","format":"float","description":"Cargo width, meters","nullable":true},"height":{"type":"integer","format":"float","description":"Cargo height, meters","nullable":true},"temperature_min_c":{"type":"integer","format":"float","description":"Minimum required transportation temperature, degrees Celsius","nullable":true},"temperature_max_c":{"type":"integer","format":"float","description":"Maximum required transportation temperature, degrees Celsius","nullable":true},"price":{"$ref":"#/components/schemas/OfferCargoPrice","description":"Cargo price","nullable":true}}},"OfferCargoPrice":{"properties":{"currency":{"type":"string","description":"Cargo price currency"},"value":{"type":"integer","format":"float","description":"Cargo price in the specified currency"},"value_mask":{"type":"string","description":"Masked cargo price in the specified currency"}}},"OfferTransport":{"description":"Transport characteristics for transport offer","required":["is_trailer_interchange","type","temperature_min_c","temperature_max_c","available_weight","available_volume","length","width","height","shipping_mode","adr_class","curtainside","equipment","loading_type"],"properties":{"is_trailer_interchange":{"type":"boolean","description":"Trailer interchange possibility"},"type":{"type":"string","enum":["any","lcv","solo","special_machinery","lorry"]},"temperature_min_c":{"type":"integer","format":"float","description":"Minimum transportation temperature maintained by the vehicle, degrees Celsius","nullable":true},"temperature_max_c":{"type":"integer","format":"float","description":"Maximum transportation temperature maintained by the vehicle, degrees Celsius","nullable":true},"available_weight":{"type":"integer","format":"float","description":"Weight available for loading, tons","nullable":true},"available_volume":{"type":"integer","format":"float","description":"Volume available for loading, cubic meters","nullable":true},"length":{"type":"integer","format":"float","description":"Length available for loading, meters","nullable":true},"width":{"type":"integer","format":"float","description":"Width available for loading, meters","nullable":true},"height":{"type":"integer","format":"float","description":"Height available for loading, meters","nullable":true},"shipping_mode":{"type":"array","description":"Type of transportation. Possible options: FTL, LTL, Special and Any","minItems":0,"items":{"type":"string","enum":["any","ftl","ltl","special"]}},"adr_class":{"type":"array","description":"ADR class (cargo hazard class) approved for transportation","minItems":1,"items":{"type":"string","enum":["no","any_dangerous","adr_1","adr_2_1","adr_2_2","adr_2_3","adr_3","adr_4_1","adr_4_2","adr_4_3","adr_5_1","adr_5_2","adr_6_1","adr_6_2","adr_7","adr_8","adr_9"]}},"body":{"type":"array","minItems":0,"description":"Vehicle body type"},"equipment":{"type":"string","description":"Additional equipment","nullable":true},"loading_type":{"type":"array","minItems":0,"description":"Possible methods of loading into a vehicle.","items":{"type":"string","enum":["rear","side","side_by_side","rack_off","top","tent_off"]}}}},"PublicationLifetime":{"properties":{"is_first_bid":{"type":"boolean","nullable":true},"lifetime":{"type":"integer"},"formatted_lifetime":{"type":"string","nullable":true},"is_late_bid_prolong":{"type":"boolean","nullable":true},"prolong_step":{"type":"integer"},"formatted_prolong_step":{"type":"string","nullable":true},"prolong_times":{"type":"integer"}}},"BidPrivacy":{"properties":{"allow_view_bidder":{"type":"boolean","description":"Show bid owner"},"allow_view_quote":{"type":"boolean","description":"Show bid"},"allow_view_comment":{"type":"boolean","description":"Show bid comments"}}},"ErrorObject":{"required":["state","message","internal"],"properties":{"state":{"type":"string","description":"Request execution status","enum":["error"]},"message":{"type":"string","description":"Additional information"},"validations":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"path":{"type":"string"},"reason":{"type":"string"}}}},"internal":{"type":"object","description":"Internal information from Roolz exchange platform to analyze the problem when executing a request","required":["roolz_debug_id"],"properties":{"roolz_debug_id":{"type":"string"}}}}}}},"paths":{"/exchange/offer":{"post":{"tags":["exchange"],"operationId":"createSingleExchangeOfferById","summary":"Creating a single offer","parameters":[{"$ref":"#/components/parameters/ContentTypeHeader"},{"$ref":"#/components/parameters/AcceptEncodingHeader"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExchangeOfferCreateRequest"}}}},"responses":{"200":{"description":"Successful execution of the request","content":{"application/json":{"schema":{"type":"object","required":["offer"],"properties":{"offer":{"$ref":"#/components/schemas/ExchangeOffer"}}}}}},"400":{"description":"Error in input data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorObject"}}}},"401":{"description":"Request not authorized. API key may be missing."},"403":{"description":"This operation is not permitted."}}}}}}
```

{% hint style="info" %}
This offer creation method allows creating an offer only in the `not_published` status. To publish an offer on the exchange, update the status of a single offer by unique ID (see below).
{% endhint %}

## PATCH /exchange/offer/{id}/status

> Updating the status of a single offer by unique ID

```json
{"openapi":"3.0.1","info":{"title":"Roolz Public API","version":"1.1"},"servers":[{"url":"https://api.test.roolz.tech/public-api/v1","description":"Test environment for development"}],"security":[{"getKey":[]},{"headerKey":[]}],"components":{"securitySchemes":{"getKey":{"type":"apiKey","description":"API key for authorizing requests in GET parameters","name":"apikey","in":"query"},"headerKey":{"type":"apiKey","description":"API key for authorizing requests in header","name":"X-Api-Key","in":"header"}},"parameters":{"ContentTypeHeader":{"in":"header","name":"Content-Type","required":true,"description":"","schema":{"type":"string","default":"application/json","enum":["application/json"]}},"AcceptEncodingHeader":{"in":"header","name":"Accept-Encoding","required":true,"description":"","schema":{"type":"string","default":"gzip","enum":["gzip"]}}},"schemas":{"ErrorObject":{"required":["state","message","internal"],"properties":{"state":{"type":"string","description":"Request execution status","enum":["error"]},"message":{"type":"string","description":"Additional information"},"validations":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"path":{"type":"string"},"reason":{"type":"string"}}}},"internal":{"type":"object","description":"Internal information from Roolz exchange platform to analyze the problem when executing a request","required":["roolz_debug_id"],"properties":{"roolz_debug_id":{"type":"string"}}}}}}},"paths":{"/exchange/offer/{id}/status":{"patch":{"tags":["exchange"],"operationId":"updateSingleExchangeOfferStatusById","summary":"Updating the status of a single offer by unique ID","parameters":[{"$ref":"#/components/parameters/ContentTypeHeader"},{"$ref":"#/components/parameters/AcceptEncodingHeader"},{"name":"id","in":"path","required":true,"description":"Unique offer ID","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string"}}}}}},"responses":{"200":{"description":"Successful execution of the request","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Error in input data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorObject"}}}},"401":{"description":"Request not authorized. API key may be missing."},"403":{"description":"This operation is not permitted."}}}}}}
```

## DELETE /exchange/offer/{id}

> Deleting a single offer by unique ID

```json
{"openapi":"3.0.1","info":{"title":"Roolz Public API","version":"1.1"},"servers":[{"url":"https://api.test.roolz.tech/public-api/v1","description":"Test environment for development"}],"security":[{"getKey":[]},{"headerKey":[]}],"components":{"securitySchemes":{"getKey":{"type":"apiKey","description":"API key for authorizing requests in GET parameters","name":"apikey","in":"query"},"headerKey":{"type":"apiKey","description":"API key for authorizing requests in header","name":"X-Api-Key","in":"header"}},"parameters":{"ContentTypeHeader":{"in":"header","name":"Content-Type","required":true,"description":"","schema":{"type":"string","default":"application/json","enum":["application/json"]}},"AcceptEncodingHeader":{"in":"header","name":"Accept-Encoding","required":true,"description":"","schema":{"type":"string","default":"gzip","enum":["gzip"]}}},"schemas":{"ErrorObject":{"required":["state","message","internal"],"properties":{"state":{"type":"string","description":"Request execution status","enum":["error"]},"message":{"type":"string","description":"Additional information"},"validations":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"path":{"type":"string"},"reason":{"type":"string"}}}},"internal":{"type":"object","description":"Internal information from Roolz exchange platform to analyze the problem when executing a request","required":["roolz_debug_id"],"properties":{"roolz_debug_id":{"type":"string"}}}}}}},"paths":{"/exchange/offer/{id}":{"delete":{"tags":["exchange"],"operationId":"deleteSingleExchangeOfferById","summary":"Deleting a single offer by unique ID","parameters":[{"$ref":"#/components/parameters/ContentTypeHeader"},{"$ref":"#/components/parameters/AcceptEncodingHeader"},{"name":"id","in":"path","required":true,"description":"Unique offer ID","schema":{"type":"string"}}],"responses":{"204":{"description":"Successful execution of the request"},"400":{"description":"Error in input data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorObject"}}}},"401":{"description":"Request not authorized. API key may be missing."},"403":{"description":"This operation is not permitted."}}}}}}
```

## GET /exchange/company/offers/incoming

> Getting a paginated list of incoming offers on the private exchange

```json
{"openapi":"3.0.1","info":{"title":"Roolz Public API","version":"1.1"},"servers":[{"url":"https://api.test.roolz.tech/public-api/v1","description":"Test environment for development"}],"security":[{"getKey":[]},{"headerKey":[]}],"components":{"securitySchemes":{"getKey":{"type":"apiKey","description":"API key for authorizing requests in GET parameters","name":"apikey","in":"query"},"headerKey":{"type":"apiKey","description":"API key for authorizing requests in header","name":"X-Api-Key","in":"header"}},"parameters":{"ContentTypeHeader":{"in":"header","name":"Content-Type","required":true,"description":"","schema":{"type":"string","default":"application/json","enum":["application/json"]}},"AcceptEncodingHeader":{"in":"header","name":"Accept-Encoding","required":true,"description":"","schema":{"type":"string","default":"gzip","enum":["gzip"]}}},"schemas":{"ExchangeOffer":{"required":["id","name","type","status","creation_method","is_public","is_private","company_id","description","assignee_users","is_autoclosed","is_publication_autocanceled","publication_autocancel_type","publication_autocancel_at","status_changed_at","published_at","closed_at","autoclose_at","is_all_private_partners","private_partners","payment","route","route_way","transportation_requirement","cargo_units","transport","created_at","updated_at"],"properties":{"id":{"type":"string","description":"Offer ID on Roolz exchange platform"},"name":{"type":"string","description":"Public name of the offer"},"type":{"type":"string","description":"Offer type","enum":["cargo","transport"]},"status":{"type":"string","description":"Current offer status","enum":["not_published","published","await_confirm","confirmation","deal_made","closed"]},"creation_method":{"type":"string","description":"Method of creating an offer. Possible options: manual, via API (api)","enum":["manual","api"]},"is_public":{"type":"boolean","description":"The offer is published on a public exchange"},"is_private":{"type":"boolean","description":"The offer is published on a private exchange"},"is_public_duplicate":{"type":"boolean","description":"A public duplicate has been created based on this offer."},"is_partners_selection":{"type":"boolean","description":"Partner selection option activated (for public duplicate)"},"company_id":{"type":"string","format":"UUID","description":"Internal owner-company ID of the offer on Roolz exchange platform"},"description":{"type":"string","description":"Additional description of the offer"},"assignee_users":{"type":"array","minItems":1,"description":"Users assigned as responsible for the offer. The field is only displayed for the owner of the offer and the for the incoming offers of the private exchange","items":{"$ref":"#/components/schemas/OfferAssigneeUser"}},"is_autoclosed":{"type":"boolean","description":"The offer has been closed (sent to archive) automatically"},"is_publication_autocanceled":{"type":"boolean","description":"The offer has been removed from publication automatically"},"publication_autocancel_type":{"type":"string","description":"Type (reason) of automatic offer removal from publication","nullable":true},"publication_autocancel_at":{"type":"string","description":"Date and time of the automatic offer removal from publication (in UTC)","nullable":true},"status_changed_at":{"type":"string","description":"Date and time of the last change in the offer status","nullable":true},"published_at":{"type":"string","description":"Date and time of the offer publication","nullable":true},"closed_at":{"type":"string","description":"Date and time of the offer closing (archiving)","nullable":true},"autoclose_at":{"type":"string","description":"Date and time of the automatic offer closing (archiving)","nullable":true},"is_all_private_partners":{"type":"boolean","description":"The offer on the private exchange will be received by all partners of the owner company. The field is only displayed in personal offers"},"private_partners":{"type":"array","minItems":0,"description":"IDs of partner companies that will receive private offer. The field is only displayed in personal offers","items":{"type":"string","format":"UUID"}},"payment":{"description":"Payment settings and details","$ref":"#/components/schemas/Payment"},"route":{"type":"array","description":"Waypoints in the offer","items":{"$ref":"#/components/schemas/OfferRoute"}},"route_way":{"description":"Calculated route","$ref":"#/components/schemas/OfferRouteWay"},"transportation_requirement":{"description":"Transportation requirements for cargo offers","$ref":"#/components/schemas/OfferTransportationRequirement"},"cargo_units":{"type":"array","description":"Cargo characteristics for cargo offers","nullable":true,"items":{"$ref":"#/components/schemas/OfferCargoUnit"}},"transport":{"description":"Transport characteristics for transport offers","nullable":true,"$ref":"#/components/schemas/OfferTransport"},"publication_lifetime":{"description":"Publication duration","nullable":true,"$ref":"#/components/schemas/PublicationLifetime"},"bid_privacy":{"description":"Bidding privacy","nullable":true,"$ref":"#/components/schemas/BidPrivacy"},"created_at":{"type":"string","description":"Date and time of the offer creation (in UTC)"},"updated_at":{"type":"string","description":"Date and time of the last offer change (in UTC)"}}},"OfferAssigneeUser":{"required":["id","contact_methods"],"properties":{"id":{"type":"string","format":"UUID","description":"User ID on Roolz exchange platform"},"contact_methods":{"type":"array","minItems":1,"description":"Methods of communication with the user","items":{"$ref":"#/components/schemas/UserContactMethod"}}}},"UserContactMethod":{"required":["method","value"],"properties":{"method":{"type":"string","description":"Methods of communication with the user","enum":["phone","email"]},"value":{"type":"string","description":"Communication method"}}},"Payment":{"properties":{"is_prepay":{"type":"boolean","description":"Is there a prepayment"},"currency":{"type":"string","description":"Bidding currency"},"quote_is_vat":{"type":"boolean","description":"Bid with VAT","nullable":true},"quote":{"type":"number","format":"decimal","nullable":true,"description":"Target transportation bid in the specified currency in the freight offer"},"extra_quote":{"type":"number","format":"decimal","nullable":true,"description":"Additional bid. If the main bid was specified as a bid with VAT, then the additional bid is displayed as \"without VAT\""},"vat":{"type":"number","format":"decimal","nullable":true,"description":"VAT bid"},"quote_mileage":{"type":"number","format":"decimal","nullable":true,"description":"Bid in a transport offer; set per unit of mileage (kilometer, mile, etc.)"},"prepay_amount":{"type":"number","format":"decimal","nullable":true,"description":"Amount of prepayment in currency"},"prepay_percent":{"type":"integer","format":"int64","nullable":true,"description":"Prepayment amount as a percentage of the bid. Only integer values ​​up to 100"},"payment_period":{"type":"integer","format":"int64","nullable":true,"description":"Payment period in days"},"mileage_format":{"type":"string","nullable":true,"description":"Mileage unit for the bid in the transport offer (km, miles, etc.)"},"payment_condition":{"type":"string","description":"Payment terms","nullable":true},"payment_method":{"type":"string","description":"Payment method","nullable":true},"bid_mode":{"type":"string","description":"Bidding mode"},"bid_is_vat":{"type":"boolean","description":"Accept bids with VAT","nullable":true},"bid_is_no_vat":{"type":"boolean","description":"Accept bids without VAT","nullable":true},"bid_auction_step":{"type":"number","format":"decimal","nullable":true,"description":"Minimum auction step size"},"bid_is_auto_accept":{"type":"boolean","nullable":true},"bid_is_not_unique":{"type":"boolean","description":"Uniqueness of the bid within the space. Forbids/allows to place several bids at the same time (for example, to give different conditions in \"bidding mode\")"},"bid_confirm_timeframe":{"type":"integer","format":"int64","nullable":true,"description":"Time for bid confirmation (in seconds)"},"allow_first_bid_no_step":{"type":"boolean","nullable":true}}},"OfferRoute":{"description":"Waypoint","required":["order","point_type","time_zone","point_timezone","location","start_datetime","end_datetime","loading_type"],"properties":{"order":{"type":"integer","description":"Waypoint ordinal number"},"point_type":{"type":"string","description":"Type of waypoint on Roolz exchange platform","enum":["loading","unloading","border","customs","waypoint"]},"time_zone":{"type":"string","description":"Time zone of the waypoint in minute offset from UTC"},"point_timezone":{"type":"string","description":"TZ time zone ID of the waypoint"},"location":{"$ref":"#/components/schemas/OfferRouteLocation","description":"Waypoint data"},"start_datetime":{"$ref":"#/components/schemas/DateTimeObject","description":"Start date of the transportation operations at the waypoint"},"end_datetime":{"$ref":"#/components/schemas/DateTimeObject","description":"End date of the transportation operations at the waypoint","nullable":true},"loading_type":{"type":"array","description":"Method of loading/unloading a vehicle","nullable":true,"items":{"type":"string"}}}},"OfferRouteLocation":{"description":"Waypoint data","required":["osm_id","osm_type","full_osm_id","position_type","is_radius","address","radius","access_point"],"properties":{"osm_id":{"type":"integer","description":"Waypoint ID in OSM database"},"osm_type":{"type":"string","description":"Waypoint type in OSM database"},"full_osm_id":{"type":"string","description":"Full ID of the waypoint in OSM database"},"position_type":{"type":"string","description":"General type of the waypoint in OSM database"},"is_radius":{"type":"boolean","description":"Determines whether a radius to extend the waypoint is set"},"address":{"$ref":"#/components/schemas/OfferRouteLocationAddress"},"radius":{"type":"integer","description":"Radius (if specified) extending the waypoint, in meters","nullable":true},"access_point":{"$ref":"#/components/schemas/OfferRouteLocationAccessPoint"}}},"OfferRouteLocationAddress":{"description":"Address of the waypoint","required":["title","name","lang","country_code","country_name","state_name","state_code","city","district","sub_district","street","postal_code","house_number"],"properties":{"title":{"type":"string","description":"Full name of the waypoint object"},"name":{"type":"string","description":"Given name of the waypoint object"},"lang":{"type":"string","description":"ISO 639-1 waypoint language code","nullable":true},"country_code":{"type":"string","description":"Alpha2 waypoint country code"},"country_name":{"type":"string","description":"Name of the waypoint country"},"state_name":{"type":"string","description":"The name of the internal administrative unit that the waypoint belongs to","nullable":true},"state_code":{"type":"string","description":"Code of the internal administrative unit that the waypoint belongs to","nullable":true},"city":{"type":"string","description":"The city that the waypoint belongs to","nullable":true},"district":{"type":"string","description":"The district of ​​the city that the waypoint belongs to","nullable":true},"sub_district":{"type":"string","description":"The microdistrict of the city that the waypoint belongs to","nullable":true},"street":{"type":"string","description":"The name of the street that the waypoint belongs to","nullable":true},"postal_code":{"type":"string","description":"The postal code that the waypoint belongs to","nullable":true},"house_number":{"type":"string","description":"The house number that the waypoint belongs to","nullable":true}}},"OfferRouteLocationAccessPoint":{"description":"Geo json route points","required":["type","coordinates"],"properties":{"type":{"type":"string","enum":["Point"]},"coordinates":{"type":"array","minItems":2,"maxItems":2,"items":{"type":"integer","format":"float"}}}},"DateTimeObject":{"required":["date","time"],"properties":{"date":{"type":"string","format":"Y-m-d","description":"Date"},"time":{"type":"string","format":"HH:mm:ss","description":"Time"}}},"OfferRouteWay":{"description":"Data of the calculated cargo transportation route","required":["total_length","total_dur"],"properties":{"total_length":{"type":"integer","description":"Distance of the calculated route in meters"},"total_dur":{"type":"integer","description":"Duration of the calculated route in seconds"}}},"OfferTransportationRequirement":{"description":"Cargo transportation requirements","required":["is_trailer_interchange","shipping_mode","type","body","equipment","quantity"],"properties":{"is_trailer_interchange":{"type":"boolean","description":"Trailer interchange required"},"shipping_mode":{"type":"string","description":"Type of transportation. Possible options: FTL, LTL, Special and Any","enum":["any","ftl","ltl","special"]},"type":{"type":"string","description":"The type of vehicle required for cargo transportation. For example, LCV, special machinery, etc.","enum":["any","lcv","solo","special_machinery","lorry"]},"body":{"type":"array","description":"Vehicle body types required for cargo transportation","items":{"type":"string","enum":["curtainside","box","insulated","ref","open_body","flat_bed","deeploader","tipper","cont_carrier","cont_open","cont_closed","tank_cont","tank_fuel","tank_bitumen","tank_gas","tank_chemical","tank_food","silo_food","silo_non_food","tank_other","car_carrier","log_carrier","cattle_carrier","grain_truck","meat_hooker","road_tractor","other","crane_truck","lift_truck","tow_truck","tractor","dozer","loader"]}},"equipment":{"type":"string","description":"Additional equipment required","nullable":true},"quantity":{"type":"string","description":"Number of cargo units","nullable":true}}},"OfferCargoUnit":{"description":"Cargo information for the cargo offer","required":["name","type","quantity","weight","volume","adr_class","length","width","height","temperature_min_c","temperature_max_c","price"],"properties":{"name":{"type":"string","description":"Name of cargo"},"type":{"type":"string","description":"Type of cargo","enum":["liquid_bulk","break_bulk","dry_bulk","groupage","oversized","container","eur_pallet","fin_pallet","oth_pallet","bag","big_bag","icb","carton","barrel","roll","reel","coil","crate"]},"quantity":{"type":"integer","description":"Quantity of cargo, pcs.","nullable":true},"weight":{"type":"integer","format":"float","description":"Cargo weight, tons","nullable":true},"volume":{"type":"integer","format":"float","description":"Cargo volume, cubic meters","nullable":true},"adr_class":{"type":"string","description":"ADR cargo class","nullable":true,"enum":["no","any_dangerous","adr_1","adr_2_1","adr_2_2","adr_2_3","adr_3","adr_4_1","adr_4_2","adr_4_3","adr_5_1","adr_5_2","adr_6_1","adr_6_2","adr_7","adr_8","adr_9"]},"length":{"type":"integer","format":"float","description":"Cargo length, meters","nullable":true},"width":{"type":"integer","format":"float","description":"Cargo width, meters","nullable":true},"height":{"type":"integer","format":"float","description":"Cargo height, meters","nullable":true},"temperature_min_c":{"type":"integer","format":"float","description":"Minimum required transportation temperature, degrees Celsius","nullable":true},"temperature_max_c":{"type":"integer","format":"float","description":"Maximum required transportation temperature, degrees Celsius","nullable":true},"price":{"$ref":"#/components/schemas/OfferCargoPrice","description":"Cargo price","nullable":true}}},"OfferCargoPrice":{"properties":{"currency":{"type":"string","description":"Cargo price currency"},"value":{"type":"integer","format":"float","description":"Cargo price in the specified currency"},"value_mask":{"type":"string","description":"Masked cargo price in the specified currency"}}},"OfferTransport":{"description":"Transport characteristics for transport offer","required":["is_trailer_interchange","type","temperature_min_c","temperature_max_c","available_weight","available_volume","length","width","height","shipping_mode","adr_class","curtainside","equipment","loading_type"],"properties":{"is_trailer_interchange":{"type":"boolean","description":"Trailer interchange possibility"},"type":{"type":"string","enum":["any","lcv","solo","special_machinery","lorry"]},"temperature_min_c":{"type":"integer","format":"float","description":"Minimum transportation temperature maintained by the vehicle, degrees Celsius","nullable":true},"temperature_max_c":{"type":"integer","format":"float","description":"Maximum transportation temperature maintained by the vehicle, degrees Celsius","nullable":true},"available_weight":{"type":"integer","format":"float","description":"Weight available for loading, tons","nullable":true},"available_volume":{"type":"integer","format":"float","description":"Volume available for loading, cubic meters","nullable":true},"length":{"type":"integer","format":"float","description":"Length available for loading, meters","nullable":true},"width":{"type":"integer","format":"float","description":"Width available for loading, meters","nullable":true},"height":{"type":"integer","format":"float","description":"Height available for loading, meters","nullable":true},"shipping_mode":{"type":"array","description":"Type of transportation. Possible options: FTL, LTL, Special and Any","minItems":0,"items":{"type":"string","enum":["any","ftl","ltl","special"]}},"adr_class":{"type":"array","description":"ADR class (cargo hazard class) approved for transportation","minItems":1,"items":{"type":"string","enum":["no","any_dangerous","adr_1","adr_2_1","adr_2_2","adr_2_3","adr_3","adr_4_1","adr_4_2","adr_4_3","adr_5_1","adr_5_2","adr_6_1","adr_6_2","adr_7","adr_8","adr_9"]}},"body":{"type":"array","minItems":0,"description":"Vehicle body type"},"equipment":{"type":"string","description":"Additional equipment","nullable":true},"loading_type":{"type":"array","minItems":0,"description":"Possible methods of loading into a vehicle.","items":{"type":"string","enum":["rear","side","side_by_side","rack_off","top","tent_off"]}}}},"PublicationLifetime":{"properties":{"is_first_bid":{"type":"boolean","nullable":true},"lifetime":{"type":"integer"},"formatted_lifetime":{"type":"string","nullable":true},"is_late_bid_prolong":{"type":"boolean","nullable":true},"prolong_step":{"type":"integer"},"formatted_prolong_step":{"type":"string","nullable":true},"prolong_times":{"type":"integer"}}},"BidPrivacy":{"properties":{"allow_view_bidder":{"type":"boolean","description":"Show bid owner"},"allow_view_quote":{"type":"boolean","description":"Show bid"},"allow_view_comment":{"type":"boolean","description":"Show bid comments"}}},"ErrorObject":{"required":["state","message","internal"],"properties":{"state":{"type":"string","description":"Request execution status","enum":["error"]},"message":{"type":"string","description":"Additional information"},"validations":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"path":{"type":"string"},"reason":{"type":"string"}}}},"internal":{"type":"object","description":"Internal information from Roolz exchange platform to analyze the problem when executing a request","required":["roolz_debug_id"],"properties":{"roolz_debug_id":{"type":"string"}}}}}}},"paths":{"/exchange/company/offers/incoming":{"get":{"tags":["exchange","companies"],"operationId":"getPrivateIncomingEchangeOffers","summary":"Getting a paginated list of incoming offers on the private exchange","parameters":[{"$ref":"#/components/parameters/ContentTypeHeader"},{"$ref":"#/components/parameters/AcceptEncodingHeader"},{"name":"limit","in":"query","required":false,"description":"Limit on the number of offers listed per pagination iteration","schema":{"type":"integer","minimum":1,"maximum":50,"default":25}},{"name":"offset","in":"query","required":false,"description":"Offset of the paginated selection of offers relative to the previous selection","schema":{"type":"integer","minimum":0,"default":0}}],"responses":{"200":{"description":"Successful execution of the request","content":{"application/json":{"schema":{"type":"object","required":["total","count","offers"],"properties":{"total":{"type":"integer","description":"Total number of offers listed"},"count":{"type":"integer","description":"Number of offers in this pagination iteration"},"offers":{"type":"array","items":{"$ref":"#/components/schemas/ExchangeOffer"}}}}}}},"400":{"description":"Error in input data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorObject"}}}},"401":{"description":"Request not authorized. API key may be missing."},"403":{"description":"This operation is not permitted."}}}}}}
```

## GET /exchange/company/offers

> Receiving a paginated list of your offers

```json
{"openapi":"3.0.1","info":{"title":"Roolz Public API","version":"1.1"},"servers":[{"url":"https://api.test.roolz.tech/public-api/v1","description":"Test environment for development"}],"security":[{"getKey":[]},{"headerKey":[]}],"components":{"securitySchemes":{"getKey":{"type":"apiKey","description":"API key for authorizing requests in GET parameters","name":"apikey","in":"query"},"headerKey":{"type":"apiKey","description":"API key for authorizing requests in header","name":"X-Api-Key","in":"header"}},"parameters":{"ContentTypeHeader":{"in":"header","name":"Content-Type","required":true,"description":"","schema":{"type":"string","default":"application/json","enum":["application/json"]}},"AcceptEncodingHeader":{"in":"header","name":"Accept-Encoding","required":true,"description":"","schema":{"type":"string","default":"gzip","enum":["gzip"]}}},"schemas":{"ExchangeOffer":{"required":["id","name","type","status","creation_method","is_public","is_private","company_id","description","assignee_users","is_autoclosed","is_publication_autocanceled","publication_autocancel_type","publication_autocancel_at","status_changed_at","published_at","closed_at","autoclose_at","is_all_private_partners","private_partners","payment","route","route_way","transportation_requirement","cargo_units","transport","created_at","updated_at"],"properties":{"id":{"type":"string","description":"Offer ID on Roolz exchange platform"},"name":{"type":"string","description":"Public name of the offer"},"type":{"type":"string","description":"Offer type","enum":["cargo","transport"]},"status":{"type":"string","description":"Current offer status","enum":["not_published","published","await_confirm","confirmation","deal_made","closed"]},"creation_method":{"type":"string","description":"Method of creating an offer. Possible options: manual, via API (api)","enum":["manual","api"]},"is_public":{"type":"boolean","description":"The offer is published on a public exchange"},"is_private":{"type":"boolean","description":"The offer is published on a private exchange"},"is_public_duplicate":{"type":"boolean","description":"A public duplicate has been created based on this offer."},"is_partners_selection":{"type":"boolean","description":"Partner selection option activated (for public duplicate)"},"company_id":{"type":"string","format":"UUID","description":"Internal owner-company ID of the offer on Roolz exchange platform"},"description":{"type":"string","description":"Additional description of the offer"},"assignee_users":{"type":"array","minItems":1,"description":"Users assigned as responsible for the offer. The field is only displayed for the owner of the offer and the for the incoming offers of the private exchange","items":{"$ref":"#/components/schemas/OfferAssigneeUser"}},"is_autoclosed":{"type":"boolean","description":"The offer has been closed (sent to archive) automatically"},"is_publication_autocanceled":{"type":"boolean","description":"The offer has been removed from publication automatically"},"publication_autocancel_type":{"type":"string","description":"Type (reason) of automatic offer removal from publication","nullable":true},"publication_autocancel_at":{"type":"string","description":"Date and time of the automatic offer removal from publication (in UTC)","nullable":true},"status_changed_at":{"type":"string","description":"Date and time of the last change in the offer status","nullable":true},"published_at":{"type":"string","description":"Date and time of the offer publication","nullable":true},"closed_at":{"type":"string","description":"Date and time of the offer closing (archiving)","nullable":true},"autoclose_at":{"type":"string","description":"Date and time of the automatic offer closing (archiving)","nullable":true},"is_all_private_partners":{"type":"boolean","description":"The offer on the private exchange will be received by all partners of the owner company. The field is only displayed in personal offers"},"private_partners":{"type":"array","minItems":0,"description":"IDs of partner companies that will receive private offer. The field is only displayed in personal offers","items":{"type":"string","format":"UUID"}},"payment":{"description":"Payment settings and details","$ref":"#/components/schemas/Payment"},"route":{"type":"array","description":"Waypoints in the offer","items":{"$ref":"#/components/schemas/OfferRoute"}},"route_way":{"description":"Calculated route","$ref":"#/components/schemas/OfferRouteWay"},"transportation_requirement":{"description":"Transportation requirements for cargo offers","$ref":"#/components/schemas/OfferTransportationRequirement"},"cargo_units":{"type":"array","description":"Cargo characteristics for cargo offers","nullable":true,"items":{"$ref":"#/components/schemas/OfferCargoUnit"}},"transport":{"description":"Transport characteristics for transport offers","nullable":true,"$ref":"#/components/schemas/OfferTransport"},"publication_lifetime":{"description":"Publication duration","nullable":true,"$ref":"#/components/schemas/PublicationLifetime"},"bid_privacy":{"description":"Bidding privacy","nullable":true,"$ref":"#/components/schemas/BidPrivacy"},"created_at":{"type":"string","description":"Date and time of the offer creation (in UTC)"},"updated_at":{"type":"string","description":"Date and time of the last offer change (in UTC)"}}},"OfferAssigneeUser":{"required":["id","contact_methods"],"properties":{"id":{"type":"string","format":"UUID","description":"User ID on Roolz exchange platform"},"contact_methods":{"type":"array","minItems":1,"description":"Methods of communication with the user","items":{"$ref":"#/components/schemas/UserContactMethod"}}}},"UserContactMethod":{"required":["method","value"],"properties":{"method":{"type":"string","description":"Methods of communication with the user","enum":["phone","email"]},"value":{"type":"string","description":"Communication method"}}},"Payment":{"properties":{"is_prepay":{"type":"boolean","description":"Is there a prepayment"},"currency":{"type":"string","description":"Bidding currency"},"quote_is_vat":{"type":"boolean","description":"Bid with VAT","nullable":true},"quote":{"type":"number","format":"decimal","nullable":true,"description":"Target transportation bid in the specified currency in the freight offer"},"extra_quote":{"type":"number","format":"decimal","nullable":true,"description":"Additional bid. If the main bid was specified as a bid with VAT, then the additional bid is displayed as \"without VAT\""},"vat":{"type":"number","format":"decimal","nullable":true,"description":"VAT bid"},"quote_mileage":{"type":"number","format":"decimal","nullable":true,"description":"Bid in a transport offer; set per unit of mileage (kilometer, mile, etc.)"},"prepay_amount":{"type":"number","format":"decimal","nullable":true,"description":"Amount of prepayment in currency"},"prepay_percent":{"type":"integer","format":"int64","nullable":true,"description":"Prepayment amount as a percentage of the bid. Only integer values ​​up to 100"},"payment_period":{"type":"integer","format":"int64","nullable":true,"description":"Payment period in days"},"mileage_format":{"type":"string","nullable":true,"description":"Mileage unit for the bid in the transport offer (km, miles, etc.)"},"payment_condition":{"type":"string","description":"Payment terms","nullable":true},"payment_method":{"type":"string","description":"Payment method","nullable":true},"bid_mode":{"type":"string","description":"Bidding mode"},"bid_is_vat":{"type":"boolean","description":"Accept bids with VAT","nullable":true},"bid_is_no_vat":{"type":"boolean","description":"Accept bids without VAT","nullable":true},"bid_auction_step":{"type":"number","format":"decimal","nullable":true,"description":"Minimum auction step size"},"bid_is_auto_accept":{"type":"boolean","nullable":true},"bid_is_not_unique":{"type":"boolean","description":"Uniqueness of the bid within the space. Forbids/allows to place several bids at the same time (for example, to give different conditions in \"bidding mode\")"},"bid_confirm_timeframe":{"type":"integer","format":"int64","nullable":true,"description":"Time for bid confirmation (in seconds)"},"allow_first_bid_no_step":{"type":"boolean","nullable":true}}},"OfferRoute":{"description":"Waypoint","required":["order","point_type","time_zone","point_timezone","location","start_datetime","end_datetime","loading_type"],"properties":{"order":{"type":"integer","description":"Waypoint ordinal number"},"point_type":{"type":"string","description":"Type of waypoint on Roolz exchange platform","enum":["loading","unloading","border","customs","waypoint"]},"time_zone":{"type":"string","description":"Time zone of the waypoint in minute offset from UTC"},"point_timezone":{"type":"string","description":"TZ time zone ID of the waypoint"},"location":{"$ref":"#/components/schemas/OfferRouteLocation","description":"Waypoint data"},"start_datetime":{"$ref":"#/components/schemas/DateTimeObject","description":"Start date of the transportation operations at the waypoint"},"end_datetime":{"$ref":"#/components/schemas/DateTimeObject","description":"End date of the transportation operations at the waypoint","nullable":true},"loading_type":{"type":"array","description":"Method of loading/unloading a vehicle","nullable":true,"items":{"type":"string"}}}},"OfferRouteLocation":{"description":"Waypoint data","required":["osm_id","osm_type","full_osm_id","position_type","is_radius","address","radius","access_point"],"properties":{"osm_id":{"type":"integer","description":"Waypoint ID in OSM database"},"osm_type":{"type":"string","description":"Waypoint type in OSM database"},"full_osm_id":{"type":"string","description":"Full ID of the waypoint in OSM database"},"position_type":{"type":"string","description":"General type of the waypoint in OSM database"},"is_radius":{"type":"boolean","description":"Determines whether a radius to extend the waypoint is set"},"address":{"$ref":"#/components/schemas/OfferRouteLocationAddress"},"radius":{"type":"integer","description":"Radius (if specified) extending the waypoint, in meters","nullable":true},"access_point":{"$ref":"#/components/schemas/OfferRouteLocationAccessPoint"}}},"OfferRouteLocationAddress":{"description":"Address of the waypoint","required":["title","name","lang","country_code","country_name","state_name","state_code","city","district","sub_district","street","postal_code","house_number"],"properties":{"title":{"type":"string","description":"Full name of the waypoint object"},"name":{"type":"string","description":"Given name of the waypoint object"},"lang":{"type":"string","description":"ISO 639-1 waypoint language code","nullable":true},"country_code":{"type":"string","description":"Alpha2 waypoint country code"},"country_name":{"type":"string","description":"Name of the waypoint country"},"state_name":{"type":"string","description":"The name of the internal administrative unit that the waypoint belongs to","nullable":true},"state_code":{"type":"string","description":"Code of the internal administrative unit that the waypoint belongs to","nullable":true},"city":{"type":"string","description":"The city that the waypoint belongs to","nullable":true},"district":{"type":"string","description":"The district of ​​the city that the waypoint belongs to","nullable":true},"sub_district":{"type":"string","description":"The microdistrict of the city that the waypoint belongs to","nullable":true},"street":{"type":"string","description":"The name of the street that the waypoint belongs to","nullable":true},"postal_code":{"type":"string","description":"The postal code that the waypoint belongs to","nullable":true},"house_number":{"type":"string","description":"The house number that the waypoint belongs to","nullable":true}}},"OfferRouteLocationAccessPoint":{"description":"Geo json route points","required":["type","coordinates"],"properties":{"type":{"type":"string","enum":["Point"]},"coordinates":{"type":"array","minItems":2,"maxItems":2,"items":{"type":"integer","format":"float"}}}},"DateTimeObject":{"required":["date","time"],"properties":{"date":{"type":"string","format":"Y-m-d","description":"Date"},"time":{"type":"string","format":"HH:mm:ss","description":"Time"}}},"OfferRouteWay":{"description":"Data of the calculated cargo transportation route","required":["total_length","total_dur"],"properties":{"total_length":{"type":"integer","description":"Distance of the calculated route in meters"},"total_dur":{"type":"integer","description":"Duration of the calculated route in seconds"}}},"OfferTransportationRequirement":{"description":"Cargo transportation requirements","required":["is_trailer_interchange","shipping_mode","type","body","equipment","quantity"],"properties":{"is_trailer_interchange":{"type":"boolean","description":"Trailer interchange required"},"shipping_mode":{"type":"string","description":"Type of transportation. Possible options: FTL, LTL, Special and Any","enum":["any","ftl","ltl","special"]},"type":{"type":"string","description":"The type of vehicle required for cargo transportation. For example, LCV, special machinery, etc.","enum":["any","lcv","solo","special_machinery","lorry"]},"body":{"type":"array","description":"Vehicle body types required for cargo transportation","items":{"type":"string","enum":["curtainside","box","insulated","ref","open_body","flat_bed","deeploader","tipper","cont_carrier","cont_open","cont_closed","tank_cont","tank_fuel","tank_bitumen","tank_gas","tank_chemical","tank_food","silo_food","silo_non_food","tank_other","car_carrier","log_carrier","cattle_carrier","grain_truck","meat_hooker","road_tractor","other","crane_truck","lift_truck","tow_truck","tractor","dozer","loader"]}},"equipment":{"type":"string","description":"Additional equipment required","nullable":true},"quantity":{"type":"string","description":"Number of cargo units","nullable":true}}},"OfferCargoUnit":{"description":"Cargo information for the cargo offer","required":["name","type","quantity","weight","volume","adr_class","length","width","height","temperature_min_c","temperature_max_c","price"],"properties":{"name":{"type":"string","description":"Name of cargo"},"type":{"type":"string","description":"Type of cargo","enum":["liquid_bulk","break_bulk","dry_bulk","groupage","oversized","container","eur_pallet","fin_pallet","oth_pallet","bag","big_bag","icb","carton","barrel","roll","reel","coil","crate"]},"quantity":{"type":"integer","description":"Quantity of cargo, pcs.","nullable":true},"weight":{"type":"integer","format":"float","description":"Cargo weight, tons","nullable":true},"volume":{"type":"integer","format":"float","description":"Cargo volume, cubic meters","nullable":true},"adr_class":{"type":"string","description":"ADR cargo class","nullable":true,"enum":["no","any_dangerous","adr_1","adr_2_1","adr_2_2","adr_2_3","adr_3","adr_4_1","adr_4_2","adr_4_3","adr_5_1","adr_5_2","adr_6_1","adr_6_2","adr_7","adr_8","adr_9"]},"length":{"type":"integer","format":"float","description":"Cargo length, meters","nullable":true},"width":{"type":"integer","format":"float","description":"Cargo width, meters","nullable":true},"height":{"type":"integer","format":"float","description":"Cargo height, meters","nullable":true},"temperature_min_c":{"type":"integer","format":"float","description":"Minimum required transportation temperature, degrees Celsius","nullable":true},"temperature_max_c":{"type":"integer","format":"float","description":"Maximum required transportation temperature, degrees Celsius","nullable":true},"price":{"$ref":"#/components/schemas/OfferCargoPrice","description":"Cargo price","nullable":true}}},"OfferCargoPrice":{"properties":{"currency":{"type":"string","description":"Cargo price currency"},"value":{"type":"integer","format":"float","description":"Cargo price in the specified currency"},"value_mask":{"type":"string","description":"Masked cargo price in the specified currency"}}},"OfferTransport":{"description":"Transport characteristics for transport offer","required":["is_trailer_interchange","type","temperature_min_c","temperature_max_c","available_weight","available_volume","length","width","height","shipping_mode","adr_class","curtainside","equipment","loading_type"],"properties":{"is_trailer_interchange":{"type":"boolean","description":"Trailer interchange possibility"},"type":{"type":"string","enum":["any","lcv","solo","special_machinery","lorry"]},"temperature_min_c":{"type":"integer","format":"float","description":"Minimum transportation temperature maintained by the vehicle, degrees Celsius","nullable":true},"temperature_max_c":{"type":"integer","format":"float","description":"Maximum transportation temperature maintained by the vehicle, degrees Celsius","nullable":true},"available_weight":{"type":"integer","format":"float","description":"Weight available for loading, tons","nullable":true},"available_volume":{"type":"integer","format":"float","description":"Volume available for loading, cubic meters","nullable":true},"length":{"type":"integer","format":"float","description":"Length available for loading, meters","nullable":true},"width":{"type":"integer","format":"float","description":"Width available for loading, meters","nullable":true},"height":{"type":"integer","format":"float","description":"Height available for loading, meters","nullable":true},"shipping_mode":{"type":"array","description":"Type of transportation. Possible options: FTL, LTL, Special and Any","minItems":0,"items":{"type":"string","enum":["any","ftl","ltl","special"]}},"adr_class":{"type":"array","description":"ADR class (cargo hazard class) approved for transportation","minItems":1,"items":{"type":"string","enum":["no","any_dangerous","adr_1","adr_2_1","adr_2_2","adr_2_3","adr_3","adr_4_1","adr_4_2","adr_4_3","adr_5_1","adr_5_2","adr_6_1","adr_6_2","adr_7","adr_8","adr_9"]}},"body":{"type":"array","minItems":0,"description":"Vehicle body type"},"equipment":{"type":"string","description":"Additional equipment","nullable":true},"loading_type":{"type":"array","minItems":0,"description":"Possible methods of loading into a vehicle.","items":{"type":"string","enum":["rear","side","side_by_side","rack_off","top","tent_off"]}}}},"PublicationLifetime":{"properties":{"is_first_bid":{"type":"boolean","nullable":true},"lifetime":{"type":"integer"},"formatted_lifetime":{"type":"string","nullable":true},"is_late_bid_prolong":{"type":"boolean","nullable":true},"prolong_step":{"type":"integer"},"formatted_prolong_step":{"type":"string","nullable":true},"prolong_times":{"type":"integer"}}},"BidPrivacy":{"properties":{"allow_view_bidder":{"type":"boolean","description":"Show bid owner"},"allow_view_quote":{"type":"boolean","description":"Show bid"},"allow_view_comment":{"type":"boolean","description":"Show bid comments"}}},"ErrorObject":{"required":["state","message","internal"],"properties":{"state":{"type":"string","description":"Request execution status","enum":["error"]},"message":{"type":"string","description":"Additional information"},"validations":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"path":{"type":"string"},"reason":{"type":"string"}}}},"internal":{"type":"object","description":"Internal information from Roolz exchange platform to analyze the problem when executing a request","required":["roolz_debug_id"],"properties":{"roolz_debug_id":{"type":"string"}}}}}}},"paths":{"/exchange/company/offers":{"get":{"tags":["exchange","companies"],"operationId":"getMyExchangeOffers","summary":"Receiving a paginated list of your offers","parameters":[{"$ref":"#/components/parameters/ContentTypeHeader"},{"$ref":"#/components/parameters/AcceptEncodingHeader"},{"name":"limit","in":"query","required":false,"description":"Limit on the number of offers listed per pagination iteration","schema":{"type":"integer","minimum":1,"maximum":50,"default":25}},{"name":"offset","in":"query","required":false,"description":"Offset of the paginated selection of offers relative to the previous selection","schema":{"type":"integer","minimum":0,"default":0}},{"name":"offers_status","in":"query","required":false,"description":"Select offers of a certain status (except the deleted ones)","schema":{"type":"string","enum":["not_published","published","await_confirm","confirmation","deal_made","closed"]}},{"name":"offers_type","in":"query","required":false,"description":"Select offers of a certain type","schema":{"type":"string","enum":["cargo","transport"]}}],"responses":{"200":{"description":"Successful execution of the request","content":{"application/json":{"schema":{"type":"object","required":["total","count","offers"],"properties":{"total":{"type":"integer","description":"Total number of offers listed"},"count":{"type":"integer","description":"Number of offers in this pagination iteration"},"offers":{"type":"array","items":{"$ref":"#/components/schemas/ExchangeOffer"}}}}}}},"400":{"description":"Error in input data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorObject"}}}},"401":{"description":"Request not authorized. API key may be missing."},"403":{"description":"This operation is not permitted."}}}}}}
```

## GET /exchange/offer/{id}

> Getting an offer by the unique ID

```json
{"openapi":"3.0.1","info":{"title":"Roolz Public API","version":"1.1"},"servers":[{"url":"https://api.test.roolz.tech/public-api/v1","description":"Test environment for development"}],"security":[{"getKey":[]},{"headerKey":[]}],"components":{"securitySchemes":{"getKey":{"type":"apiKey","description":"API key for authorizing requests in GET parameters","name":"apikey","in":"query"},"headerKey":{"type":"apiKey","description":"API key for authorizing requests in header","name":"X-Api-Key","in":"header"}},"parameters":{"ContentTypeHeader":{"in":"header","name":"Content-Type","required":true,"description":"","schema":{"type":"string","default":"application/json","enum":["application/json"]}},"AcceptEncodingHeader":{"in":"header","name":"Accept-Encoding","required":true,"description":"","schema":{"type":"string","default":"gzip","enum":["gzip"]}}},"schemas":{"ExchangeOffer":{"required":["id","name","type","status","creation_method","is_public","is_private","company_id","description","assignee_users","is_autoclosed","is_publication_autocanceled","publication_autocancel_type","publication_autocancel_at","status_changed_at","published_at","closed_at","autoclose_at","is_all_private_partners","private_partners","payment","route","route_way","transportation_requirement","cargo_units","transport","created_at","updated_at"],"properties":{"id":{"type":"string","description":"Offer ID on Roolz exchange platform"},"name":{"type":"string","description":"Public name of the offer"},"type":{"type":"string","description":"Offer type","enum":["cargo","transport"]},"status":{"type":"string","description":"Current offer status","enum":["not_published","published","await_confirm","confirmation","deal_made","closed"]},"creation_method":{"type":"string","description":"Method of creating an offer. Possible options: manual, via API (api)","enum":["manual","api"]},"is_public":{"type":"boolean","description":"The offer is published on a public exchange"},"is_private":{"type":"boolean","description":"The offer is published on a private exchange"},"is_public_duplicate":{"type":"boolean","description":"A public duplicate has been created based on this offer."},"is_partners_selection":{"type":"boolean","description":"Partner selection option activated (for public duplicate)"},"company_id":{"type":"string","format":"UUID","description":"Internal owner-company ID of the offer on Roolz exchange platform"},"description":{"type":"string","description":"Additional description of the offer"},"assignee_users":{"type":"array","minItems":1,"description":"Users assigned as responsible for the offer. The field is only displayed for the owner of the offer and the for the incoming offers of the private exchange","items":{"$ref":"#/components/schemas/OfferAssigneeUser"}},"is_autoclosed":{"type":"boolean","description":"The offer has been closed (sent to archive) automatically"},"is_publication_autocanceled":{"type":"boolean","description":"The offer has been removed from publication automatically"},"publication_autocancel_type":{"type":"string","description":"Type (reason) of automatic offer removal from publication","nullable":true},"publication_autocancel_at":{"type":"string","description":"Date and time of the automatic offer removal from publication (in UTC)","nullable":true},"status_changed_at":{"type":"string","description":"Date and time of the last change in the offer status","nullable":true},"published_at":{"type":"string","description":"Date and time of the offer publication","nullable":true},"closed_at":{"type":"string","description":"Date and time of the offer closing (archiving)","nullable":true},"autoclose_at":{"type":"string","description":"Date and time of the automatic offer closing (archiving)","nullable":true},"is_all_private_partners":{"type":"boolean","description":"The offer on the private exchange will be received by all partners of the owner company. The field is only displayed in personal offers"},"private_partners":{"type":"array","minItems":0,"description":"IDs of partner companies that will receive private offer. The field is only displayed in personal offers","items":{"type":"string","format":"UUID"}},"payment":{"description":"Payment settings and details","$ref":"#/components/schemas/Payment"},"route":{"type":"array","description":"Waypoints in the offer","items":{"$ref":"#/components/schemas/OfferRoute"}},"route_way":{"description":"Calculated route","$ref":"#/components/schemas/OfferRouteWay"},"transportation_requirement":{"description":"Transportation requirements for cargo offers","$ref":"#/components/schemas/OfferTransportationRequirement"},"cargo_units":{"type":"array","description":"Cargo characteristics for cargo offers","nullable":true,"items":{"$ref":"#/components/schemas/OfferCargoUnit"}},"transport":{"description":"Transport characteristics for transport offers","nullable":true,"$ref":"#/components/schemas/OfferTransport"},"publication_lifetime":{"description":"Publication duration","nullable":true,"$ref":"#/components/schemas/PublicationLifetime"},"bid_privacy":{"description":"Bidding privacy","nullable":true,"$ref":"#/components/schemas/BidPrivacy"},"created_at":{"type":"string","description":"Date and time of the offer creation (in UTC)"},"updated_at":{"type":"string","description":"Date and time of the last offer change (in UTC)"}}},"OfferAssigneeUser":{"required":["id","contact_methods"],"properties":{"id":{"type":"string","format":"UUID","description":"User ID on Roolz exchange platform"},"contact_methods":{"type":"array","minItems":1,"description":"Methods of communication with the user","items":{"$ref":"#/components/schemas/UserContactMethod"}}}},"UserContactMethod":{"required":["method","value"],"properties":{"method":{"type":"string","description":"Methods of communication with the user","enum":["phone","email"]},"value":{"type":"string","description":"Communication method"}}},"Payment":{"properties":{"is_prepay":{"type":"boolean","description":"Is there a prepayment"},"currency":{"type":"string","description":"Bidding currency"},"quote_is_vat":{"type":"boolean","description":"Bid with VAT","nullable":true},"quote":{"type":"number","format":"decimal","nullable":true,"description":"Target transportation bid in the specified currency in the freight offer"},"extra_quote":{"type":"number","format":"decimal","nullable":true,"description":"Additional bid. If the main bid was specified as a bid with VAT, then the additional bid is displayed as \"without VAT\""},"vat":{"type":"number","format":"decimal","nullable":true,"description":"VAT bid"},"quote_mileage":{"type":"number","format":"decimal","nullable":true,"description":"Bid in a transport offer; set per unit of mileage (kilometer, mile, etc.)"},"prepay_amount":{"type":"number","format":"decimal","nullable":true,"description":"Amount of prepayment in currency"},"prepay_percent":{"type":"integer","format":"int64","nullable":true,"description":"Prepayment amount as a percentage of the bid. Only integer values ​​up to 100"},"payment_period":{"type":"integer","format":"int64","nullable":true,"description":"Payment period in days"},"mileage_format":{"type":"string","nullable":true,"description":"Mileage unit for the bid in the transport offer (km, miles, etc.)"},"payment_condition":{"type":"string","description":"Payment terms","nullable":true},"payment_method":{"type":"string","description":"Payment method","nullable":true},"bid_mode":{"type":"string","description":"Bidding mode"},"bid_is_vat":{"type":"boolean","description":"Accept bids with VAT","nullable":true},"bid_is_no_vat":{"type":"boolean","description":"Accept bids without VAT","nullable":true},"bid_auction_step":{"type":"number","format":"decimal","nullable":true,"description":"Minimum auction step size"},"bid_is_auto_accept":{"type":"boolean","nullable":true},"bid_is_not_unique":{"type":"boolean","description":"Uniqueness of the bid within the space. Forbids/allows to place several bids at the same time (for example, to give different conditions in \"bidding mode\")"},"bid_confirm_timeframe":{"type":"integer","format":"int64","nullable":true,"description":"Time for bid confirmation (in seconds)"},"allow_first_bid_no_step":{"type":"boolean","nullable":true}}},"OfferRoute":{"description":"Waypoint","required":["order","point_type","time_zone","point_timezone","location","start_datetime","end_datetime","loading_type"],"properties":{"order":{"type":"integer","description":"Waypoint ordinal number"},"point_type":{"type":"string","description":"Type of waypoint on Roolz exchange platform","enum":["loading","unloading","border","customs","waypoint"]},"time_zone":{"type":"string","description":"Time zone of the waypoint in minute offset from UTC"},"point_timezone":{"type":"string","description":"TZ time zone ID of the waypoint"},"location":{"$ref":"#/components/schemas/OfferRouteLocation","description":"Waypoint data"},"start_datetime":{"$ref":"#/components/schemas/DateTimeObject","description":"Start date of the transportation operations at the waypoint"},"end_datetime":{"$ref":"#/components/schemas/DateTimeObject","description":"End date of the transportation operations at the waypoint","nullable":true},"loading_type":{"type":"array","description":"Method of loading/unloading a vehicle","nullable":true,"items":{"type":"string"}}}},"OfferRouteLocation":{"description":"Waypoint data","required":["osm_id","osm_type","full_osm_id","position_type","is_radius","address","radius","access_point"],"properties":{"osm_id":{"type":"integer","description":"Waypoint ID in OSM database"},"osm_type":{"type":"string","description":"Waypoint type in OSM database"},"full_osm_id":{"type":"string","description":"Full ID of the waypoint in OSM database"},"position_type":{"type":"string","description":"General type of the waypoint in OSM database"},"is_radius":{"type":"boolean","description":"Determines whether a radius to extend the waypoint is set"},"address":{"$ref":"#/components/schemas/OfferRouteLocationAddress"},"radius":{"type":"integer","description":"Radius (if specified) extending the waypoint, in meters","nullable":true},"access_point":{"$ref":"#/components/schemas/OfferRouteLocationAccessPoint"}}},"OfferRouteLocationAddress":{"description":"Address of the waypoint","required":["title","name","lang","country_code","country_name","state_name","state_code","city","district","sub_district","street","postal_code","house_number"],"properties":{"title":{"type":"string","description":"Full name of the waypoint object"},"name":{"type":"string","description":"Given name of the waypoint object"},"lang":{"type":"string","description":"ISO 639-1 waypoint language code","nullable":true},"country_code":{"type":"string","description":"Alpha2 waypoint country code"},"country_name":{"type":"string","description":"Name of the waypoint country"},"state_name":{"type":"string","description":"The name of the internal administrative unit that the waypoint belongs to","nullable":true},"state_code":{"type":"string","description":"Code of the internal administrative unit that the waypoint belongs to","nullable":true},"city":{"type":"string","description":"The city that the waypoint belongs to","nullable":true},"district":{"type":"string","description":"The district of ​​the city that the waypoint belongs to","nullable":true},"sub_district":{"type":"string","description":"The microdistrict of the city that the waypoint belongs to","nullable":true},"street":{"type":"string","description":"The name of the street that the waypoint belongs to","nullable":true},"postal_code":{"type":"string","description":"The postal code that the waypoint belongs to","nullable":true},"house_number":{"type":"string","description":"The house number that the waypoint belongs to","nullable":true}}},"OfferRouteLocationAccessPoint":{"description":"Geo json route points","required":["type","coordinates"],"properties":{"type":{"type":"string","enum":["Point"]},"coordinates":{"type":"array","minItems":2,"maxItems":2,"items":{"type":"integer","format":"float"}}}},"DateTimeObject":{"required":["date","time"],"properties":{"date":{"type":"string","format":"Y-m-d","description":"Date"},"time":{"type":"string","format":"HH:mm:ss","description":"Time"}}},"OfferRouteWay":{"description":"Data of the calculated cargo transportation route","required":["total_length","total_dur"],"properties":{"total_length":{"type":"integer","description":"Distance of the calculated route in meters"},"total_dur":{"type":"integer","description":"Duration of the calculated route in seconds"}}},"OfferTransportationRequirement":{"description":"Cargo transportation requirements","required":["is_trailer_interchange","shipping_mode","type","body","equipment","quantity"],"properties":{"is_trailer_interchange":{"type":"boolean","description":"Trailer interchange required"},"shipping_mode":{"type":"string","description":"Type of transportation. Possible options: FTL, LTL, Special and Any","enum":["any","ftl","ltl","special"]},"type":{"type":"string","description":"The type of vehicle required for cargo transportation. For example, LCV, special machinery, etc.","enum":["any","lcv","solo","special_machinery","lorry"]},"body":{"type":"array","description":"Vehicle body types required for cargo transportation","items":{"type":"string","enum":["curtainside","box","insulated","ref","open_body","flat_bed","deeploader","tipper","cont_carrier","cont_open","cont_closed","tank_cont","tank_fuel","tank_bitumen","tank_gas","tank_chemical","tank_food","silo_food","silo_non_food","tank_other","car_carrier","log_carrier","cattle_carrier","grain_truck","meat_hooker","road_tractor","other","crane_truck","lift_truck","tow_truck","tractor","dozer","loader"]}},"equipment":{"type":"string","description":"Additional equipment required","nullable":true},"quantity":{"type":"string","description":"Number of cargo units","nullable":true}}},"OfferCargoUnit":{"description":"Cargo information for the cargo offer","required":["name","type","quantity","weight","volume","adr_class","length","width","height","temperature_min_c","temperature_max_c","price"],"properties":{"name":{"type":"string","description":"Name of cargo"},"type":{"type":"string","description":"Type of cargo","enum":["liquid_bulk","break_bulk","dry_bulk","groupage","oversized","container","eur_pallet","fin_pallet","oth_pallet","bag","big_bag","icb","carton","barrel","roll","reel","coil","crate"]},"quantity":{"type":"integer","description":"Quantity of cargo, pcs.","nullable":true},"weight":{"type":"integer","format":"float","description":"Cargo weight, tons","nullable":true},"volume":{"type":"integer","format":"float","description":"Cargo volume, cubic meters","nullable":true},"adr_class":{"type":"string","description":"ADR cargo class","nullable":true,"enum":["no","any_dangerous","adr_1","adr_2_1","adr_2_2","adr_2_3","adr_3","adr_4_1","adr_4_2","adr_4_3","adr_5_1","adr_5_2","adr_6_1","adr_6_2","adr_7","adr_8","adr_9"]},"length":{"type":"integer","format":"float","description":"Cargo length, meters","nullable":true},"width":{"type":"integer","format":"float","description":"Cargo width, meters","nullable":true},"height":{"type":"integer","format":"float","description":"Cargo height, meters","nullable":true},"temperature_min_c":{"type":"integer","format":"float","description":"Minimum required transportation temperature, degrees Celsius","nullable":true},"temperature_max_c":{"type":"integer","format":"float","description":"Maximum required transportation temperature, degrees Celsius","nullable":true},"price":{"$ref":"#/components/schemas/OfferCargoPrice","description":"Cargo price","nullable":true}}},"OfferCargoPrice":{"properties":{"currency":{"type":"string","description":"Cargo price currency"},"value":{"type":"integer","format":"float","description":"Cargo price in the specified currency"},"value_mask":{"type":"string","description":"Masked cargo price in the specified currency"}}},"OfferTransport":{"description":"Transport characteristics for transport offer","required":["is_trailer_interchange","type","temperature_min_c","temperature_max_c","available_weight","available_volume","length","width","height","shipping_mode","adr_class","curtainside","equipment","loading_type"],"properties":{"is_trailer_interchange":{"type":"boolean","description":"Trailer interchange possibility"},"type":{"type":"string","enum":["any","lcv","solo","special_machinery","lorry"]},"temperature_min_c":{"type":"integer","format":"float","description":"Minimum transportation temperature maintained by the vehicle, degrees Celsius","nullable":true},"temperature_max_c":{"type":"integer","format":"float","description":"Maximum transportation temperature maintained by the vehicle, degrees Celsius","nullable":true},"available_weight":{"type":"integer","format":"float","description":"Weight available for loading, tons","nullable":true},"available_volume":{"type":"integer","format":"float","description":"Volume available for loading, cubic meters","nullable":true},"length":{"type":"integer","format":"float","description":"Length available for loading, meters","nullable":true},"width":{"type":"integer","format":"float","description":"Width available for loading, meters","nullable":true},"height":{"type":"integer","format":"float","description":"Height available for loading, meters","nullable":true},"shipping_mode":{"type":"array","description":"Type of transportation. Possible options: FTL, LTL, Special and Any","minItems":0,"items":{"type":"string","enum":["any","ftl","ltl","special"]}},"adr_class":{"type":"array","description":"ADR class (cargo hazard class) approved for transportation","minItems":1,"items":{"type":"string","enum":["no","any_dangerous","adr_1","adr_2_1","adr_2_2","adr_2_3","adr_3","adr_4_1","adr_4_2","adr_4_3","adr_5_1","adr_5_2","adr_6_1","adr_6_2","adr_7","adr_8","adr_9"]}},"body":{"type":"array","minItems":0,"description":"Vehicle body type"},"equipment":{"type":"string","description":"Additional equipment","nullable":true},"loading_type":{"type":"array","minItems":0,"description":"Possible methods of loading into a vehicle.","items":{"type":"string","enum":["rear","side","side_by_side","rack_off","top","tent_off"]}}}},"PublicationLifetime":{"properties":{"is_first_bid":{"type":"boolean","nullable":true},"lifetime":{"type":"integer"},"formatted_lifetime":{"type":"string","nullable":true},"is_late_bid_prolong":{"type":"boolean","nullable":true},"prolong_step":{"type":"integer"},"formatted_prolong_step":{"type":"string","nullable":true},"prolong_times":{"type":"integer"}}},"BidPrivacy":{"properties":{"allow_view_bidder":{"type":"boolean","description":"Show bid owner"},"allow_view_quote":{"type":"boolean","description":"Show bid"},"allow_view_comment":{"type":"boolean","description":"Show bid comments"}}},"ErrorObject":{"required":["state","message","internal"],"properties":{"state":{"type":"string","description":"Request execution status","enum":["error"]},"message":{"type":"string","description":"Additional information"},"validations":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"path":{"type":"string"},"reason":{"type":"string"}}}},"internal":{"type":"object","description":"Internal information from Roolz exchange platform to analyze the problem when executing a request","required":["roolz_debug_id"],"properties":{"roolz_debug_id":{"type":"string"}}}}}}},"paths":{"/exchange/offer/{id}":{"get":{"tags":["exchange"],"operationId":"getSimgleExchangeOfferById","summary":"Getting an offer by the unique ID","parameters":[{"$ref":"#/components/parameters/ContentTypeHeader"},{"$ref":"#/components/parameters/AcceptEncodingHeader"},{"name":"id","in":"path","required":true,"description":"Unique offer ID","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful execution of the request","content":{"application/json":{"schema":{"type":"object","required":["offer"],"properties":{"offer":{"$ref":"#/components/schemas/ExchangeOffer"}}}}}},"400":{"description":"Error in input data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorObject"}}}},"401":{"description":"Request not authorized. API key may be missing."},"403":{"description":"This operation is not permitted."}}}}}}
```

## The ErrorObject object

```json
{"openapi":"3.0.1","info":{"title":"Roolz Public API","version":"1.1"},"components":{"schemas":{"ErrorObject":{"required":["state","message","internal"],"properties":{"state":{"type":"string","description":"Request execution status","enum":["error"]},"message":{"type":"string","description":"Additional information"},"validations":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"path":{"type":"string"},"reason":{"type":"string"}}}},"internal":{"type":"object","description":"Internal information from Roolz exchange platform to analyze the problem when executing a request","required":["roolz_debug_id"],"properties":{"roolz_debug_id":{"type":"string"}}}}}}}}
```

## The DateTimeObject object

```json
{"openapi":"3.0.1","info":{"title":"Roolz Public API","version":"1.1"},"components":{"schemas":{"DateTimeObject":{"required":["date","time"],"properties":{"date":{"type":"string","format":"Y-m-d","description":"Date"},"time":{"type":"string","format":"HH:mm:ss","description":"Time"}}}}}}
```

## The OfferRouteLocationAccessPoint object

```json
{"openapi":"3.0.1","info":{"title":"Roolz Public API","version":"1.1"},"components":{"schemas":{"OfferRouteLocationAccessPoint":{"description":"Geo json route points","required":["type","coordinates"],"properties":{"type":{"type":"string","enum":["Point"]},"coordinates":{"type":"array","minItems":2,"maxItems":2,"items":{"type":"integer","format":"float"}}}}}}}
```

## The OfferRouteLocationAddress object

```json
{"openapi":"3.0.1","info":{"title":"Roolz Public API","version":"1.1"},"components":{"schemas":{"OfferRouteLocationAddress":{"description":"Address of the waypoint","required":["title","name","lang","country_code","country_name","state_name","state_code","city","district","sub_district","street","postal_code","house_number"],"properties":{"title":{"type":"string","description":"Full name of the waypoint object"},"name":{"type":"string","description":"Given name of the waypoint object"},"lang":{"type":"string","description":"ISO 639-1 waypoint language code","nullable":true},"country_code":{"type":"string","description":"Alpha2 waypoint country code"},"country_name":{"type":"string","description":"Name of the waypoint country"},"state_name":{"type":"string","description":"The name of the internal administrative unit that the waypoint belongs to","nullable":true},"state_code":{"type":"string","description":"Code of the internal administrative unit that the waypoint belongs to","nullable":true},"city":{"type":"string","description":"The city that the waypoint belongs to","nullable":true},"district":{"type":"string","description":"The district of ​​the city that the waypoint belongs to","nullable":true},"sub_district":{"type":"string","description":"The microdistrict of the city that the waypoint belongs to","nullable":true},"street":{"type":"string","description":"The name of the street that the waypoint belongs to","nullable":true},"postal_code":{"type":"string","description":"The postal code that the waypoint belongs to","nullable":true},"house_number":{"type":"string","description":"The house number that the waypoint belongs to","nullable":true}}}}}}
```

## The OfferRouteLocation object

```json
{"openapi":"3.0.1","info":{"title":"Roolz Public API","version":"1.1"},"components":{"schemas":{"OfferRouteLocation":{"description":"Waypoint data","required":["osm_id","osm_type","full_osm_id","position_type","is_radius","address","radius","access_point"],"properties":{"osm_id":{"type":"integer","description":"Waypoint ID in OSM database"},"osm_type":{"type":"string","description":"Waypoint type in OSM database"},"full_osm_id":{"type":"string","description":"Full ID of the waypoint in OSM database"},"position_type":{"type":"string","description":"General type of the waypoint in OSM database"},"is_radius":{"type":"boolean","description":"Determines whether a radius to extend the waypoint is set"},"address":{"$ref":"#/components/schemas/OfferRouteLocationAddress"},"radius":{"type":"integer","description":"Radius (if specified) extending the waypoint, in meters","nullable":true},"access_point":{"$ref":"#/components/schemas/OfferRouteLocationAccessPoint"}}},"OfferRouteLocationAddress":{"description":"Address of the waypoint","required":["title","name","lang","country_code","country_name","state_name","state_code","city","district","sub_district","street","postal_code","house_number"],"properties":{"title":{"type":"string","description":"Full name of the waypoint object"},"name":{"type":"string","description":"Given name of the waypoint object"},"lang":{"type":"string","description":"ISO 639-1 waypoint language code","nullable":true},"country_code":{"type":"string","description":"Alpha2 waypoint country code"},"country_name":{"type":"string","description":"Name of the waypoint country"},"state_name":{"type":"string","description":"The name of the internal administrative unit that the waypoint belongs to","nullable":true},"state_code":{"type":"string","description":"Code of the internal administrative unit that the waypoint belongs to","nullable":true},"city":{"type":"string","description":"The city that the waypoint belongs to","nullable":true},"district":{"type":"string","description":"The district of ​​the city that the waypoint belongs to","nullable":true},"sub_district":{"type":"string","description":"The microdistrict of the city that the waypoint belongs to","nullable":true},"street":{"type":"string","description":"The name of the street that the waypoint belongs to","nullable":true},"postal_code":{"type":"string","description":"The postal code that the waypoint belongs to","nullable":true},"house_number":{"type":"string","description":"The house number that the waypoint belongs to","nullable":true}}},"OfferRouteLocationAccessPoint":{"description":"Geo json route points","required":["type","coordinates"],"properties":{"type":{"type":"string","enum":["Point"]},"coordinates":{"type":"array","minItems":2,"maxItems":2,"items":{"type":"integer","format":"float"}}}}}}}
```

## The OfferRoute object

```json
{"openapi":"3.0.1","info":{"title":"Roolz Public API","version":"1.1"},"components":{"schemas":{"OfferRoute":{"description":"Waypoint","required":["order","point_type","time_zone","point_timezone","location","start_datetime","end_datetime","loading_type"],"properties":{"order":{"type":"integer","description":"Waypoint ordinal number"},"point_type":{"type":"string","description":"Type of waypoint on Roolz exchange platform","enum":["loading","unloading","border","customs","waypoint"]},"time_zone":{"type":"string","description":"Time zone of the waypoint in minute offset from UTC"},"point_timezone":{"type":"string","description":"TZ time zone ID of the waypoint"},"location":{"$ref":"#/components/schemas/OfferRouteLocation","description":"Waypoint data"},"start_datetime":{"$ref":"#/components/schemas/DateTimeObject","description":"Start date of the transportation operations at the waypoint"},"end_datetime":{"$ref":"#/components/schemas/DateTimeObject","description":"End date of the transportation operations at the waypoint","nullable":true},"loading_type":{"type":"array","description":"Method of loading/unloading a vehicle","nullable":true,"items":{"type":"string"}}}},"OfferRouteLocation":{"description":"Waypoint data","required":["osm_id","osm_type","full_osm_id","position_type","is_radius","address","radius","access_point"],"properties":{"osm_id":{"type":"integer","description":"Waypoint ID in OSM database"},"osm_type":{"type":"string","description":"Waypoint type in OSM database"},"full_osm_id":{"type":"string","description":"Full ID of the waypoint in OSM database"},"position_type":{"type":"string","description":"General type of the waypoint in OSM database"},"is_radius":{"type":"boolean","description":"Determines whether a radius to extend the waypoint is set"},"address":{"$ref":"#/components/schemas/OfferRouteLocationAddress"},"radius":{"type":"integer","description":"Radius (if specified) extending the waypoint, in meters","nullable":true},"access_point":{"$ref":"#/components/schemas/OfferRouteLocationAccessPoint"}}},"OfferRouteLocationAddress":{"description":"Address of the waypoint","required":["title","name","lang","country_code","country_name","state_name","state_code","city","district","sub_district","street","postal_code","house_number"],"properties":{"title":{"type":"string","description":"Full name of the waypoint object"},"name":{"type":"string","description":"Given name of the waypoint object"},"lang":{"type":"string","description":"ISO 639-1 waypoint language code","nullable":true},"country_code":{"type":"string","description":"Alpha2 waypoint country code"},"country_name":{"type":"string","description":"Name of the waypoint country"},"state_name":{"type":"string","description":"The name of the internal administrative unit that the waypoint belongs to","nullable":true},"state_code":{"type":"string","description":"Code of the internal administrative unit that the waypoint belongs to","nullable":true},"city":{"type":"string","description":"The city that the waypoint belongs to","nullable":true},"district":{"type":"string","description":"The district of ​​the city that the waypoint belongs to","nullable":true},"sub_district":{"type":"string","description":"The microdistrict of the city that the waypoint belongs to","nullable":true},"street":{"type":"string","description":"The name of the street that the waypoint belongs to","nullable":true},"postal_code":{"type":"string","description":"The postal code that the waypoint belongs to","nullable":true},"house_number":{"type":"string","description":"The house number that the waypoint belongs to","nullable":true}}},"OfferRouteLocationAccessPoint":{"description":"Geo json route points","required":["type","coordinates"],"properties":{"type":{"type":"string","enum":["Point"]},"coordinates":{"type":"array","minItems":2,"maxItems":2,"items":{"type":"integer","format":"float"}}}},"DateTimeObject":{"required":["date","time"],"properties":{"date":{"type":"string","format":"Y-m-d","description":"Date"},"time":{"type":"string","format":"HH:mm:ss","description":"Time"}}}}}}
```

## The OfferRouteWay object

```json
{"openapi":"3.0.1","info":{"title":"Roolz Public API","version":"1.1"},"components":{"schemas":{"OfferRouteWay":{"description":"Data of the calculated cargo transportation route","required":["total_length","total_dur"],"properties":{"total_length":{"type":"integer","description":"Distance of the calculated route in meters"},"total_dur":{"type":"integer","description":"Duration of the calculated route in seconds"}}}}}}
```

## The OfferTransportationRequirement object

```json
{"openapi":"3.0.1","info":{"title":"Roolz Public API","version":"1.1"},"components":{"schemas":{"OfferTransportationRequirement":{"description":"Cargo transportation requirements","required":["is_trailer_interchange","shipping_mode","type","body","equipment","quantity"],"properties":{"is_trailer_interchange":{"type":"boolean","description":"Trailer interchange required"},"shipping_mode":{"type":"string","description":"Type of transportation. Possible options: FTL, LTL, Special and Any","enum":["any","ftl","ltl","special"]},"type":{"type":"string","description":"The type of vehicle required for cargo transportation. For example, LCV, special machinery, etc.","enum":["any","lcv","solo","special_machinery","lorry"]},"body":{"type":"array","description":"Vehicle body types required for cargo transportation","items":{"type":"string","enum":["curtainside","box","insulated","ref","open_body","flat_bed","deeploader","tipper","cont_carrier","cont_open","cont_closed","tank_cont","tank_fuel","tank_bitumen","tank_gas","tank_chemical","tank_food","silo_food","silo_non_food","tank_other","car_carrier","log_carrier","cattle_carrier","grain_truck","meat_hooker","road_tractor","other","crane_truck","lift_truck","tow_truck","tractor","dozer","loader"]}},"equipment":{"type":"string","description":"Additional equipment required","nullable":true},"quantity":{"type":"string","description":"Number of cargo units","nullable":true}}}}}}
```

## The OfferCargoUnit object

```json
{"openapi":"3.0.1","info":{"title":"Roolz Public API","version":"1.1"},"components":{"schemas":{"OfferCargoUnit":{"description":"Cargo information for the cargo offer","required":["name","type","quantity","weight","volume","adr_class","length","width","height","temperature_min_c","temperature_max_c","price"],"properties":{"name":{"type":"string","description":"Name of cargo"},"type":{"type":"string","description":"Type of cargo","enum":["liquid_bulk","break_bulk","dry_bulk","groupage","oversized","container","eur_pallet","fin_pallet","oth_pallet","bag","big_bag","icb","carton","barrel","roll","reel","coil","crate"]},"quantity":{"type":"integer","description":"Quantity of cargo, pcs.","nullable":true},"weight":{"type":"integer","format":"float","description":"Cargo weight, tons","nullable":true},"volume":{"type":"integer","format":"float","description":"Cargo volume, cubic meters","nullable":true},"adr_class":{"type":"string","description":"ADR cargo class","nullable":true,"enum":["no","any_dangerous","adr_1","adr_2_1","adr_2_2","adr_2_3","adr_3","adr_4_1","adr_4_2","adr_4_3","adr_5_1","adr_5_2","adr_6_1","adr_6_2","adr_7","adr_8","adr_9"]},"length":{"type":"integer","format":"float","description":"Cargo length, meters","nullable":true},"width":{"type":"integer","format":"float","description":"Cargo width, meters","nullable":true},"height":{"type":"integer","format":"float","description":"Cargo height, meters","nullable":true},"temperature_min_c":{"type":"integer","format":"float","description":"Minimum required transportation temperature, degrees Celsius","nullable":true},"temperature_max_c":{"type":"integer","format":"float","description":"Maximum required transportation temperature, degrees Celsius","nullable":true},"price":{"$ref":"#/components/schemas/OfferCargoPrice","description":"Cargo price","nullable":true}}},"OfferCargoPrice":{"properties":{"currency":{"type":"string","description":"Cargo price currency"},"value":{"type":"integer","format":"float","description":"Cargo price in the specified currency"},"value_mask":{"type":"string","description":"Masked cargo price in the specified currency"}}}}}}
```

## The OfferCargoPrice object

```json
{"openapi":"3.0.1","info":{"title":"Roolz Public API","version":"1.1"},"components":{"schemas":{"OfferCargoPrice":{"properties":{"currency":{"type":"string","description":"Cargo price currency"},"value":{"type":"integer","format":"float","description":"Cargo price in the specified currency"},"value_mask":{"type":"string","description":"Masked cargo price in the specified currency"}}}}}}
```

## The OfferTransport object

```json
{"openapi":"3.0.1","info":{"title":"Roolz Public API","version":"1.1"},"components":{"schemas":{"OfferTransport":{"description":"Transport characteristics for transport offer","required":["is_trailer_interchange","type","temperature_min_c","temperature_max_c","available_weight","available_volume","length","width","height","shipping_mode","adr_class","curtainside","equipment","loading_type"],"properties":{"is_trailer_interchange":{"type":"boolean","description":"Trailer interchange possibility"},"type":{"type":"string","enum":["any","lcv","solo","special_machinery","lorry"]},"temperature_min_c":{"type":"integer","format":"float","description":"Minimum transportation temperature maintained by the vehicle, degrees Celsius","nullable":true},"temperature_max_c":{"type":"integer","format":"float","description":"Maximum transportation temperature maintained by the vehicle, degrees Celsius","nullable":true},"available_weight":{"type":"integer","format":"float","description":"Weight available for loading, tons","nullable":true},"available_volume":{"type":"integer","format":"float","description":"Volume available for loading, cubic meters","nullable":true},"length":{"type":"integer","format":"float","description":"Length available for loading, meters","nullable":true},"width":{"type":"integer","format":"float","description":"Width available for loading, meters","nullable":true},"height":{"type":"integer","format":"float","description":"Height available for loading, meters","nullable":true},"shipping_mode":{"type":"array","description":"Type of transportation. Possible options: FTL, LTL, Special and Any","minItems":0,"items":{"type":"string","enum":["any","ftl","ltl","special"]}},"adr_class":{"type":"array","description":"ADR class (cargo hazard class) approved for transportation","minItems":1,"items":{"type":"string","enum":["no","any_dangerous","adr_1","adr_2_1","adr_2_2","adr_2_3","adr_3","adr_4_1","adr_4_2","adr_4_3","adr_5_1","adr_5_2","adr_6_1","adr_6_2","adr_7","adr_8","adr_9"]}},"body":{"type":"array","minItems":0,"description":"Vehicle body type"},"equipment":{"type":"string","description":"Additional equipment","nullable":true},"loading_type":{"type":"array","minItems":0,"description":"Possible methods of loading into a vehicle.","items":{"type":"string","enum":["rear","side","side_by_side","rack_off","top","tent_off"]}}}}}}}
```

## The UserContactMethod object

```json
{"openapi":"3.0.1","info":{"title":"Roolz Public API","version":"1.1"},"components":{"schemas":{"UserContactMethod":{"required":["method","value"],"properties":{"method":{"type":"string","description":"Methods of communication with the user","enum":["phone","email"]},"value":{"type":"string","description":"Communication method"}}}}}}
```

## The OfferAssigneeUser object

```json
{"openapi":"3.0.1","info":{"title":"Roolz Public API","version":"1.1"},"components":{"schemas":{"OfferAssigneeUser":{"required":["id","contact_methods"],"properties":{"id":{"type":"string","format":"UUID","description":"User ID on Roolz exchange platform"},"contact_methods":{"type":"array","minItems":1,"description":"Methods of communication with the user","items":{"$ref":"#/components/schemas/UserContactMethod"}}}},"UserContactMethod":{"required":["method","value"],"properties":{"method":{"type":"string","description":"Methods of communication with the user","enum":["phone","email"]},"value":{"type":"string","description":"Communication method"}}}}}}
```

## The PublicationLifetime object

```json
{"openapi":"3.0.1","info":{"title":"Roolz Public API","version":"1.1"},"components":{"schemas":{"PublicationLifetime":{"properties":{"is_first_bid":{"type":"boolean","nullable":true},"lifetime":{"type":"integer"},"formatted_lifetime":{"type":"string","nullable":true},"is_late_bid_prolong":{"type":"boolean","nullable":true},"prolong_step":{"type":"integer"},"formatted_prolong_step":{"type":"string","nullable":true},"prolong_times":{"type":"integer"}}}}}}
```

## The BidPrivacy object

```json
{"openapi":"3.0.1","info":{"title":"Roolz Public API","version":"1.1"},"components":{"schemas":{"BidPrivacy":{"properties":{"allow_view_bidder":{"type":"boolean","description":"Show bid owner"},"allow_view_quote":{"type":"boolean","description":"Show bid"},"allow_view_comment":{"type":"boolean","description":"Show bid comments"}}}}}}
```

## The Payment object

```json
{"openapi":"3.0.1","info":{"title":"Roolz Public API","version":"1.1"},"components":{"schemas":{"Payment":{"properties":{"is_prepay":{"type":"boolean","description":"Is there a prepayment"},"currency":{"type":"string","description":"Bidding currency"},"quote_is_vat":{"type":"boolean","description":"Bid with VAT","nullable":true},"quote":{"type":"number","format":"decimal","nullable":true,"description":"Target transportation bid in the specified currency in the freight offer"},"extra_quote":{"type":"number","format":"decimal","nullable":true,"description":"Additional bid. If the main bid was specified as a bid with VAT, then the additional bid is displayed as \"without VAT\""},"vat":{"type":"number","format":"decimal","nullable":true,"description":"VAT bid"},"quote_mileage":{"type":"number","format":"decimal","nullable":true,"description":"Bid in a transport offer; set per unit of mileage (kilometer, mile, etc.)"},"prepay_amount":{"type":"number","format":"decimal","nullable":true,"description":"Amount of prepayment in currency"},"prepay_percent":{"type":"integer","format":"int64","nullable":true,"description":"Prepayment amount as a percentage of the bid. Only integer values ​​up to 100"},"payment_period":{"type":"integer","format":"int64","nullable":true,"description":"Payment period in days"},"mileage_format":{"type":"string","nullable":true,"description":"Mileage unit for the bid in the transport offer (km, miles, etc.)"},"payment_condition":{"type":"string","description":"Payment terms","nullable":true},"payment_method":{"type":"string","description":"Payment method","nullable":true},"bid_mode":{"type":"string","description":"Bidding mode"},"bid_is_vat":{"type":"boolean","description":"Accept bids with VAT","nullable":true},"bid_is_no_vat":{"type":"boolean","description":"Accept bids without VAT","nullable":true},"bid_auction_step":{"type":"number","format":"decimal","nullable":true,"description":"Minimum auction step size"},"bid_is_auto_accept":{"type":"boolean","nullable":true},"bid_is_not_unique":{"type":"boolean","description":"Uniqueness of the bid within the space. Forbids/allows to place several bids at the same time (for example, to give different conditions in \"bidding mode\")"},"bid_confirm_timeframe":{"type":"integer","format":"int64","nullable":true,"description":"Time for bid confirmation (in seconds)"},"allow_first_bid_no_step":{"type":"boolean","nullable":true}}}}}}
```

## The ExchangeOffer object

```json
{"openapi":"3.0.1","info":{"title":"Roolz Public API","version":"1.1"},"components":{"schemas":{"ExchangeOffer":{"required":["id","name","type","status","creation_method","is_public","is_private","company_id","description","assignee_users","is_autoclosed","is_publication_autocanceled","publication_autocancel_type","publication_autocancel_at","status_changed_at","published_at","closed_at","autoclose_at","is_all_private_partners","private_partners","payment","route","route_way","transportation_requirement","cargo_units","transport","created_at","updated_at"],"properties":{"id":{"type":"string","description":"Offer ID on Roolz exchange platform"},"name":{"type":"string","description":"Public name of the offer"},"type":{"type":"string","description":"Offer type","enum":["cargo","transport"]},"status":{"type":"string","description":"Current offer status","enum":["not_published","published","await_confirm","confirmation","deal_made","closed"]},"creation_method":{"type":"string","description":"Method of creating an offer. Possible options: manual, via API (api)","enum":["manual","api"]},"is_public":{"type":"boolean","description":"The offer is published on a public exchange"},"is_private":{"type":"boolean","description":"The offer is published on a private exchange"},"is_public_duplicate":{"type":"boolean","description":"A public duplicate has been created based on this offer."},"is_partners_selection":{"type":"boolean","description":"Partner selection option activated (for public duplicate)"},"company_id":{"type":"string","format":"UUID","description":"Internal owner-company ID of the offer on Roolz exchange platform"},"description":{"type":"string","description":"Additional description of the offer"},"assignee_users":{"type":"array","minItems":1,"description":"Users assigned as responsible for the offer. The field is only displayed for the owner of the offer and the for the incoming offers of the private exchange","items":{"$ref":"#/components/schemas/OfferAssigneeUser"}},"is_autoclosed":{"type":"boolean","description":"The offer has been closed (sent to archive) automatically"},"is_publication_autocanceled":{"type":"boolean","description":"The offer has been removed from publication automatically"},"publication_autocancel_type":{"type":"string","description":"Type (reason) of automatic offer removal from publication","nullable":true},"publication_autocancel_at":{"type":"string","description":"Date and time of the automatic offer removal from publication (in UTC)","nullable":true},"status_changed_at":{"type":"string","description":"Date and time of the last change in the offer status","nullable":true},"published_at":{"type":"string","description":"Date and time of the offer publication","nullable":true},"closed_at":{"type":"string","description":"Date and time of the offer closing (archiving)","nullable":true},"autoclose_at":{"type":"string","description":"Date and time of the automatic offer closing (archiving)","nullable":true},"is_all_private_partners":{"type":"boolean","description":"The offer on the private exchange will be received by all partners of the owner company. The field is only displayed in personal offers"},"private_partners":{"type":"array","minItems":0,"description":"IDs of partner companies that will receive private offer. The field is only displayed in personal offers","items":{"type":"string","format":"UUID"}},"payment":{"description":"Payment settings and details","$ref":"#/components/schemas/Payment"},"route":{"type":"array","description":"Waypoints in the offer","items":{"$ref":"#/components/schemas/OfferRoute"}},"route_way":{"description":"Calculated route","$ref":"#/components/schemas/OfferRouteWay"},"transportation_requirement":{"description":"Transportation requirements for cargo offers","$ref":"#/components/schemas/OfferTransportationRequirement"},"cargo_units":{"type":"array","description":"Cargo characteristics for cargo offers","nullable":true,"items":{"$ref":"#/components/schemas/OfferCargoUnit"}},"transport":{"description":"Transport characteristics for transport offers","nullable":true,"$ref":"#/components/schemas/OfferTransport"},"publication_lifetime":{"description":"Publication duration","nullable":true,"$ref":"#/components/schemas/PublicationLifetime"},"bid_privacy":{"description":"Bidding privacy","nullable":true,"$ref":"#/components/schemas/BidPrivacy"},"created_at":{"type":"string","description":"Date and time of the offer creation (in UTC)"},"updated_at":{"type":"string","description":"Date and time of the last offer change (in UTC)"}}},"OfferAssigneeUser":{"required":["id","contact_methods"],"properties":{"id":{"type":"string","format":"UUID","description":"User ID on Roolz exchange platform"},"contact_methods":{"type":"array","minItems":1,"description":"Methods of communication with the user","items":{"$ref":"#/components/schemas/UserContactMethod"}}}},"UserContactMethod":{"required":["method","value"],"properties":{"method":{"type":"string","description":"Methods of communication with the user","enum":["phone","email"]},"value":{"type":"string","description":"Communication method"}}},"Payment":{"properties":{"is_prepay":{"type":"boolean","description":"Is there a prepayment"},"currency":{"type":"string","description":"Bidding currency"},"quote_is_vat":{"type":"boolean","description":"Bid with VAT","nullable":true},"quote":{"type":"number","format":"decimal","nullable":true,"description":"Target transportation bid in the specified currency in the freight offer"},"extra_quote":{"type":"number","format":"decimal","nullable":true,"description":"Additional bid. If the main bid was specified as a bid with VAT, then the additional bid is displayed as \"without VAT\""},"vat":{"type":"number","format":"decimal","nullable":true,"description":"VAT bid"},"quote_mileage":{"type":"number","format":"decimal","nullable":true,"description":"Bid in a transport offer; set per unit of mileage (kilometer, mile, etc.)"},"prepay_amount":{"type":"number","format":"decimal","nullable":true,"description":"Amount of prepayment in currency"},"prepay_percent":{"type":"integer","format":"int64","nullable":true,"description":"Prepayment amount as a percentage of the bid. Only integer values ​​up to 100"},"payment_period":{"type":"integer","format":"int64","nullable":true,"description":"Payment period in days"},"mileage_format":{"type":"string","nullable":true,"description":"Mileage unit for the bid in the transport offer (km, miles, etc.)"},"payment_condition":{"type":"string","description":"Payment terms","nullable":true},"payment_method":{"type":"string","description":"Payment method","nullable":true},"bid_mode":{"type":"string","description":"Bidding mode"},"bid_is_vat":{"type":"boolean","description":"Accept bids with VAT","nullable":true},"bid_is_no_vat":{"type":"boolean","description":"Accept bids without VAT","nullable":true},"bid_auction_step":{"type":"number","format":"decimal","nullable":true,"description":"Minimum auction step size"},"bid_is_auto_accept":{"type":"boolean","nullable":true},"bid_is_not_unique":{"type":"boolean","description":"Uniqueness of the bid within the space. Forbids/allows to place several bids at the same time (for example, to give different conditions in \"bidding mode\")"},"bid_confirm_timeframe":{"type":"integer","format":"int64","nullable":true,"description":"Time for bid confirmation (in seconds)"},"allow_first_bid_no_step":{"type":"boolean","nullable":true}}},"OfferRoute":{"description":"Waypoint","required":["order","point_type","time_zone","point_timezone","location","start_datetime","end_datetime","loading_type"],"properties":{"order":{"type":"integer","description":"Waypoint ordinal number"},"point_type":{"type":"string","description":"Type of waypoint on Roolz exchange platform","enum":["loading","unloading","border","customs","waypoint"]},"time_zone":{"type":"string","description":"Time zone of the waypoint in minute offset from UTC"},"point_timezone":{"type":"string","description":"TZ time zone ID of the waypoint"},"location":{"$ref":"#/components/schemas/OfferRouteLocation","description":"Waypoint data"},"start_datetime":{"$ref":"#/components/schemas/DateTimeObject","description":"Start date of the transportation operations at the waypoint"},"end_datetime":{"$ref":"#/components/schemas/DateTimeObject","description":"End date of the transportation operations at the waypoint","nullable":true},"loading_type":{"type":"array","description":"Method of loading/unloading a vehicle","nullable":true,"items":{"type":"string"}}}},"OfferRouteLocation":{"description":"Waypoint data","required":["osm_id","osm_type","full_osm_id","position_type","is_radius","address","radius","access_point"],"properties":{"osm_id":{"type":"integer","description":"Waypoint ID in OSM database"},"osm_type":{"type":"string","description":"Waypoint type in OSM database"},"full_osm_id":{"type":"string","description":"Full ID of the waypoint in OSM database"},"position_type":{"type":"string","description":"General type of the waypoint in OSM database"},"is_radius":{"type":"boolean","description":"Determines whether a radius to extend the waypoint is set"},"address":{"$ref":"#/components/schemas/OfferRouteLocationAddress"},"radius":{"type":"integer","description":"Radius (if specified) extending the waypoint, in meters","nullable":true},"access_point":{"$ref":"#/components/schemas/OfferRouteLocationAccessPoint"}}},"OfferRouteLocationAddress":{"description":"Address of the waypoint","required":["title","name","lang","country_code","country_name","state_name","state_code","city","district","sub_district","street","postal_code","house_number"],"properties":{"title":{"type":"string","description":"Full name of the waypoint object"},"name":{"type":"string","description":"Given name of the waypoint object"},"lang":{"type":"string","description":"ISO 639-1 waypoint language code","nullable":true},"country_code":{"type":"string","description":"Alpha2 waypoint country code"},"country_name":{"type":"string","description":"Name of the waypoint country"},"state_name":{"type":"string","description":"The name of the internal administrative unit that the waypoint belongs to","nullable":true},"state_code":{"type":"string","description":"Code of the internal administrative unit that the waypoint belongs to","nullable":true},"city":{"type":"string","description":"The city that the waypoint belongs to","nullable":true},"district":{"type":"string","description":"The district of ​​the city that the waypoint belongs to","nullable":true},"sub_district":{"type":"string","description":"The microdistrict of the city that the waypoint belongs to","nullable":true},"street":{"type":"string","description":"The name of the street that the waypoint belongs to","nullable":true},"postal_code":{"type":"string","description":"The postal code that the waypoint belongs to","nullable":true},"house_number":{"type":"string","description":"The house number that the waypoint belongs to","nullable":true}}},"OfferRouteLocationAccessPoint":{"description":"Geo json route points","required":["type","coordinates"],"properties":{"type":{"type":"string","enum":["Point"]},"coordinates":{"type":"array","minItems":2,"maxItems":2,"items":{"type":"integer","format":"float"}}}},"DateTimeObject":{"required":["date","time"],"properties":{"date":{"type":"string","format":"Y-m-d","description":"Date"},"time":{"type":"string","format":"HH:mm:ss","description":"Time"}}},"OfferRouteWay":{"description":"Data of the calculated cargo transportation route","required":["total_length","total_dur"],"properties":{"total_length":{"type":"integer","description":"Distance of the calculated route in meters"},"total_dur":{"type":"integer","description":"Duration of the calculated route in seconds"}}},"OfferTransportationRequirement":{"description":"Cargo transportation requirements","required":["is_trailer_interchange","shipping_mode","type","body","equipment","quantity"],"properties":{"is_trailer_interchange":{"type":"boolean","description":"Trailer interchange required"},"shipping_mode":{"type":"string","description":"Type of transportation. Possible options: FTL, LTL, Special and Any","enum":["any","ftl","ltl","special"]},"type":{"type":"string","description":"The type of vehicle required for cargo transportation. For example, LCV, special machinery, etc.","enum":["any","lcv","solo","special_machinery","lorry"]},"body":{"type":"array","description":"Vehicle body types required for cargo transportation","items":{"type":"string","enum":["curtainside","box","insulated","ref","open_body","flat_bed","deeploader","tipper","cont_carrier","cont_open","cont_closed","tank_cont","tank_fuel","tank_bitumen","tank_gas","tank_chemical","tank_food","silo_food","silo_non_food","tank_other","car_carrier","log_carrier","cattle_carrier","grain_truck","meat_hooker","road_tractor","other","crane_truck","lift_truck","tow_truck","tractor","dozer","loader"]}},"equipment":{"type":"string","description":"Additional equipment required","nullable":true},"quantity":{"type":"string","description":"Number of cargo units","nullable":true}}},"OfferCargoUnit":{"description":"Cargo information for the cargo offer","required":["name","type","quantity","weight","volume","adr_class","length","width","height","temperature_min_c","temperature_max_c","price"],"properties":{"name":{"type":"string","description":"Name of cargo"},"type":{"type":"string","description":"Type of cargo","enum":["liquid_bulk","break_bulk","dry_bulk","groupage","oversized","container","eur_pallet","fin_pallet","oth_pallet","bag","big_bag","icb","carton","barrel","roll","reel","coil","crate"]},"quantity":{"type":"integer","description":"Quantity of cargo, pcs.","nullable":true},"weight":{"type":"integer","format":"float","description":"Cargo weight, tons","nullable":true},"volume":{"type":"integer","format":"float","description":"Cargo volume, cubic meters","nullable":true},"adr_class":{"type":"string","description":"ADR cargo class","nullable":true,"enum":["no","any_dangerous","adr_1","adr_2_1","adr_2_2","adr_2_3","adr_3","adr_4_1","adr_4_2","adr_4_3","adr_5_1","adr_5_2","adr_6_1","adr_6_2","adr_7","adr_8","adr_9"]},"length":{"type":"integer","format":"float","description":"Cargo length, meters","nullable":true},"width":{"type":"integer","format":"float","description":"Cargo width, meters","nullable":true},"height":{"type":"integer","format":"float","description":"Cargo height, meters","nullable":true},"temperature_min_c":{"type":"integer","format":"float","description":"Minimum required transportation temperature, degrees Celsius","nullable":true},"temperature_max_c":{"type":"integer","format":"float","description":"Maximum required transportation temperature, degrees Celsius","nullable":true},"price":{"$ref":"#/components/schemas/OfferCargoPrice","description":"Cargo price","nullable":true}}},"OfferCargoPrice":{"properties":{"currency":{"type":"string","description":"Cargo price currency"},"value":{"type":"integer","format":"float","description":"Cargo price in the specified currency"},"value_mask":{"type":"string","description":"Masked cargo price in the specified currency"}}},"OfferTransport":{"description":"Transport characteristics for transport offer","required":["is_trailer_interchange","type","temperature_min_c","temperature_max_c","available_weight","available_volume","length","width","height","shipping_mode","adr_class","curtainside","equipment","loading_type"],"properties":{"is_trailer_interchange":{"type":"boolean","description":"Trailer interchange possibility"},"type":{"type":"string","enum":["any","lcv","solo","special_machinery","lorry"]},"temperature_min_c":{"type":"integer","format":"float","description":"Minimum transportation temperature maintained by the vehicle, degrees Celsius","nullable":true},"temperature_max_c":{"type":"integer","format":"float","description":"Maximum transportation temperature maintained by the vehicle, degrees Celsius","nullable":true},"available_weight":{"type":"integer","format":"float","description":"Weight available for loading, tons","nullable":true},"available_volume":{"type":"integer","format":"float","description":"Volume available for loading, cubic meters","nullable":true},"length":{"type":"integer","format":"float","description":"Length available for loading, meters","nullable":true},"width":{"type":"integer","format":"float","description":"Width available for loading, meters","nullable":true},"height":{"type":"integer","format":"float","description":"Height available for loading, meters","nullable":true},"shipping_mode":{"type":"array","description":"Type of transportation. Possible options: FTL, LTL, Special and Any","minItems":0,"items":{"type":"string","enum":["any","ftl","ltl","special"]}},"adr_class":{"type":"array","description":"ADR class (cargo hazard class) approved for transportation","minItems":1,"items":{"type":"string","enum":["no","any_dangerous","adr_1","adr_2_1","adr_2_2","adr_2_3","adr_3","adr_4_1","adr_4_2","adr_4_3","adr_5_1","adr_5_2","adr_6_1","adr_6_2","adr_7","adr_8","adr_9"]}},"body":{"type":"array","minItems":0,"description":"Vehicle body type"},"equipment":{"type":"string","description":"Additional equipment","nullable":true},"loading_type":{"type":"array","minItems":0,"description":"Possible methods of loading into a vehicle.","items":{"type":"string","enum":["rear","side","side_by_side","rack_off","top","tent_off"]}}}},"PublicationLifetime":{"properties":{"is_first_bid":{"type":"boolean","nullable":true},"lifetime":{"type":"integer"},"formatted_lifetime":{"type":"string","nullable":true},"is_late_bid_prolong":{"type":"boolean","nullable":true},"prolong_step":{"type":"integer"},"formatted_prolong_step":{"type":"string","nullable":true},"prolong_times":{"type":"integer"}}},"BidPrivacy":{"properties":{"allow_view_bidder":{"type":"boolean","description":"Show bid owner"},"allow_view_quote":{"type":"boolean","description":"Show bid"},"allow_view_comment":{"type":"boolean","description":"Show bid comments"}}}}}}
```

## The ExchangeOfferCreateRequest object

```json
{"openapi":"3.0.1","info":{"title":"Roolz Public API","version":"1.1"},"components":{"schemas":{"ExchangeOfferCreateRequest":{"required":["status","type","is_public","is_private","payment","route"],"properties":{"status":{"type":"string","description":"The status of the created offer. At the moment, only offers in the not published status are allowed to be created","enum":["not_published"]},"type":{"type":"string","description":"Type of offer (transport/cargo). Also determines the requirements for the request","enum":["transport","cargo"]},"is_public":{"type":"boolean","description":"The offer is published on a public exchange"},"is_private":{"type":"boolean","description":"The offer is published on a private exchange"},"is_all_private_partners":{"type":"boolean","description":"The offer on the private exchange will be received by all partners of the owner company. The field is displayed only in personal offers"},"private_partners":{"type":"array","minItems":0,"description":"IDs of partner companies that will receive private offer. The field is displayed only in personal offers","items":{"type":"string","format":"UUID"}},"description":{"type":"string","description":"Additional description in the offer"},"payment":{"$ref":"#/components/schemas/PaymentDataCreateRequest"},"route":{"type":"array","items":{"$ref":"#/components/schemas/RoutepointCreateRequest"}},"cargo_units":{"description":"Description of cargo (currently the array size should be equal to 1)","type":"array","items":{"$ref":"#/components/schemas/CargoUnitCreateRequest"}},"transportation_requirement":{"description":"Transportation requirements (for freight offer only)","allOf":[{"$ref":"#/components/schemas/TransportRequirementsCreateRequest"}]},"transport":{"description":"Transport description (only for transport offer)","allOf":[{"$ref":"#/components/schemas/TransportSpecificationCreateRequest"}]},"publication_lifetime":{"$ref":"#/components/schemas/PublicationLifetimeCreateRequest"},"bid_privacy":{"$ref":"#/components/schemas/BidPrivacyCreateRequest"}}},"PaymentDataCreateRequest":{"type":"object","properties":{"quote_is_vat":{"type":"boolean","description":"Bid with VAT"},"is_prepay":{"type":"boolean","description":"Is there a prepayment"},"bid_is_vat":{"type":"boolean","description":"Accept bids with VAT"},"bid_is_no_vat":{"type":"boolean","description":"Accept bids without VAT"},"bid_is_not_unique":{"type":"boolean","description":"Uniqueness of the bid within the space. Forbids/allows to give several bids at the same time (for example, to give different conditions in \"bidding mode\")"},"currency":{"type":"string","description":"Currency"},"payment_condition":{"type":"string","description":"Payment terms"},"payment_method":{"type":"string","description":"Payment method"},"bid_mode":{"type":"string","description":"Bidding mode"},"quote":{"type":"number","format":"decimal","nullable":true,"description":"Target transportation bid in the specified currency in the freight offer"},"extra_quote":{"type":"number","format":"decimal","nullable":true,"description":"Additional bid. If the main bid is specified as a bid with VAT, then the additional bid is displayed as \"without VAT\""},"quote_mileage":{"type":"number","format":"decimal","nullable":true,"description":"Bid in a transport offer; set per unit of mileage (kilometer, mile, etc.)"},"bid_auction_step":{"type":"number","format":"decimal","nullable":true,"description":"Minimum auction step size"},"vat":{"type":"number","format":"decimal","nullable":true,"description":"VAT bid"},"mileage_format":{"type":"string","nullable":true,"description":"Mileage unit for the bid in the transport offer (km, miles, etc.)"},"prepay_percent":{"type":"integer","format":"int64","nullable":true,"description":"Prepayment amount as a percentage of the bid. Only integer values ​​up to 100"},"payment_period":{"type":"integer","format":"int64","nullable":true,"description":"Payment period in days"},"bid_confirm_timeframe":{"type":"integer","format":"int64","nullable":true,"description":"Time for bid confirmation (in seconds)"}},"required":["quote_is_vat","is_prepay","bid_is_vat","bid_is_no_vat","bid_is_not_unique","currency","payment_condition","payment_method","bid_mode"]},"RoutepointCreateRequest":{"properties":{"order":{"type":"integer","description":"Waypoint ordinal number"},"point_type":{"type":"string","description":"Type of waypoint on Roolz exchange platform","enum":["loading","unloading","border","customs","waypoint"]},"time_zone":{"type":"string","description":"Time zone of the waypoint in minute offset from UTC"},"location":{"$ref":"#/components/schemas/LocationDataCreateRequest","description":"Information about the location"},"start_datetime":{"$ref":"#/components/schemas/DateTimeObject","description":"Start date of the transportation operations at the waypoint","nullable":true},"end_datetime":{"$ref":"#/components/schemas/DateTimeObject","description":"End date of the transportation operations at the waypoint","nullable":true},"loading_type":{"description":"Method of loading/unloading a vehicle","type":"array","nullable":true,"items":{"type":"string"}}}},"LocationDataCreateRequest":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"Object ID (from object search query)"},"is_radius":{"type":"boolean"},"type":{"type":"string","description":"Object type (from object search query)"},"position_type":{"type":"string","description":"Point type"},"radius":{"type":"integer","format":"int32","nullable":true,"description":"Radius"}},"required":["id","is_radius","type","position_type"]},"DateTimeObject":{"required":["date","time"],"properties":{"date":{"type":"string","format":"Y-m-d","description":"Date"},"time":{"type":"string","format":"HH:mm:ss","description":"Time"}}},"CargoUnitCreateRequest":{"description":"Cargo information for the cargo offer","required":["weight","volume"],"properties":{"name":{"type":"string","description":"Name of cargo"},"type":{"type":"string","description":"Type of cargo","enum":["liquid_bulk","break_bulk","dry_bulk","groupage","oversized","container","eur_pallet","fin_pallet","oth_pallet","bag","big_bag","icb","carton","barrel","roll","reel","coil","crate"]},"quantity":{"type":"integer","description":"Quantity of cargo, pcs.","nullable":true},"weight":{"type":"integer","format":"float","description":"Cargo weight, tons"},"volume":{"type":"integer","format":"float","description":"Cargo volume, cubic meters"},"adr_class":{"type":"string","description":"ADR cargo class","nullable":true,"enum":["no","any_dangerous","adr_1","adr_2_1","adr_2_2","adr_2_3","adr_3","adr_4_1","adr_4_2","adr_4_3","adr_5_1","adr_5_2","adr_6_1","adr_6_2","adr_7","adr_8","adr_9"]},"length":{"type":"integer","format":"float","description":"Cargo length, meters","nullable":true},"width":{"type":"integer","format":"float","description":"Cargo width, meters","nullable":true},"height":{"type":"integer","format":"float","description":"Cargo height, meters","nullable":true},"temperature_min_c":{"type":"integer","format":"float","description":"Minimum required transportation temperature, degrees Celsius","nullable":true},"temperature_max_c":{"type":"integer","format":"float","description":"Maximum required transportation temperature, degrees Celsius","nullable":true},"price":{"$ref":"#/components/schemas/CargoPriceCreateRequest","description":"Cargo price","nullable":true}}},"CargoPriceCreateRequest":{"properties":{"currency":{"type":"string","description":"Price currency"},"value":{"type":"integer","format":"float","description":"Price of cargo in the specified currency"}}},"TransportRequirementsCreateRequest":{"description":"Requirements for cargo transportation","required":["body"],"properties":{"is_trailer_interchange":{"type":"boolean","description":"Trailer interchange required"},"shipping_mode":{"type":"string","description":"Type of transportation. Possible options: FTL, LTL, Special and Any","enum":["any","ftl","ltl","special"]},"type":{"type":"string","description":"The type of vehicle required for cargo transportation. For example, LCV, special machinery, etc.","enum":["any","lcv","solo","special_machinery","lorry"]},"body":{"type":"array","description":"Vehicle body types required for cargo transportation","items":{"type":"string","enum":["curtainside","box","insulated","ref","open_body","flat_bed","deeploader","tipper","cont_carrier","cont_open","cont_closed","tank_cont","tank_fuel","tank_bitumen","tank_gas","tank_chemical","tank_food","silo_food","silo_non_food","tank_other","car_carrier","log_carrier","cattle_carrier","grain_truck","meat_hooker","road_tractor","other","crane_truck","lift_truck","tow_truck","tractor","dozer","loader"]}},"equipment":{"type":"array","description":"Additional required equipment","nullable":true,"items":{"type":"string"}},"quantity":{"type":"string","description":"Number of cargo units","nullable":true}}},"TransportSpecificationCreateRequest":{"description":"Transport characteristics for the transport offer","required":["type","body","available_weight","available_volume"],"properties":{"is_trailer_interchange":{"type":"boolean","description":"Possibility of trailer interchange"},"type":{"type":"string","enum":["any","lcv","solo","special_machinery","lorry"]},"temperature_min_c":{"type":"integer","format":"float","description":"Minimum transportation temperature maintained by the vehicle, degrees Celsius","nullable":true},"temperature_max_c":{"type":"integer","format":"float","description":"Maximum transportation temperature maintained by the vehicle, degrees Celsius","nullable":true},"available_weight":{"type":"integer","format":"float","description":"Weight available for loading, tons"},"available_volume":{"type":"integer","format":"float","description":"Volume available for loading, cubic meters"},"length":{"type":"integer","format":"float","description":"Length available for loading, meters","nullable":true},"width":{"type":"integer","format":"float","description":"Width available for loading, meters","nullable":true},"height":{"type":"integer","format":"float","description":"Height available for loading, meters","nullable":true},"shipping_mode":{"type":"array","description":"Type of transportation. Possible options: FTL, LTL, Special and Any","minItems":0,"items":{"type":"string","enum":["any","ftl","ltl","special"]}},"adr_class":{"type":"array","description":"ADR class (cargo hazard class) approved for transportation","minItems":1,"items":{"type":"string","enum":["no","any_dangerous","adr_1","adr_2_1","adr_2_2","adr_2_3","adr_3","adr_4_1","adr_4_2","adr_4_3","adr_5_1","adr_5_2","adr_6_1","adr_6_2","adr_7","adr_8","adr_9"]}},"body":{"type":"array","minItems":0,"description":"Vehicle body type"},"equipment":{"type":"string","description":"Additional equipment","nullable":true},"loading_type":{"type":"array","minItems":0,"description":"Possible methods of loading into a vehicle.","items":{"type":"string","enum":["rear","side","side_by_side","rack_off","top","tent_off"]}}}},"PublicationLifetimeCreateRequest":{"description":"Publication duration settings","required":["lifetime"],"properties":{"lifetime":{"type":"integer","description":"Publication duration (in seconds)"},"is_first_bid":{"type":"boolean","description":"Start publication countdown only after the first bid"}}},"BidPrivacyCreateRequest":{"description":"Bidding privacy settings in the offer","properties":{"allow_view_bidder":{"type":"boolean","description":"Show bid owner"},"allow_view_quote":{"type":"boolean","description":"Show bid"},"allow_view_comment":{"type":"boolean","description":"Show bid comments"}}}}}}
```

## The BidPrivacyCreateRequest object

```json
{"openapi":"3.0.1","info":{"title":"Roolz Public API","version":"1.1"},"components":{"schemas":{"BidPrivacyCreateRequest":{"description":"Bidding privacy settings in the offer","properties":{"allow_view_bidder":{"type":"boolean","description":"Show bid owner"},"allow_view_quote":{"type":"boolean","description":"Show bid"},"allow_view_comment":{"type":"boolean","description":"Show bid comments"}}}}}}
```

## The PublicationLifetimeCreateRequest object

```json
{"openapi":"3.0.1","info":{"title":"Roolz Public API","version":"1.1"},"components":{"schemas":{"PublicationLifetimeCreateRequest":{"description":"Publication duration settings","required":["lifetime"],"properties":{"lifetime":{"type":"integer","description":"Publication duration (in seconds)"},"is_first_bid":{"type":"boolean","description":"Start publication countdown only after the first bid"}}}}}}
```

## The TransportRequirementsCreateRequest object

```json
{"openapi":"3.0.1","info":{"title":"Roolz Public API","version":"1.1"},"components":{"schemas":{"TransportRequirementsCreateRequest":{"description":"Requirements for cargo transportation","required":["body"],"properties":{"is_trailer_interchange":{"type":"boolean","description":"Trailer interchange required"},"shipping_mode":{"type":"string","description":"Type of transportation. Possible options: FTL, LTL, Special and Any","enum":["any","ftl","ltl","special"]},"type":{"type":"string","description":"The type of vehicle required for cargo transportation. For example, LCV, special machinery, etc.","enum":["any","lcv","solo","special_machinery","lorry"]},"body":{"type":"array","description":"Vehicle body types required for cargo transportation","items":{"type":"string","enum":["curtainside","box","insulated","ref","open_body","flat_bed","deeploader","tipper","cont_carrier","cont_open","cont_closed","tank_cont","tank_fuel","tank_bitumen","tank_gas","tank_chemical","tank_food","silo_food","silo_non_food","tank_other","car_carrier","log_carrier","cattle_carrier","grain_truck","meat_hooker","road_tractor","other","crane_truck","lift_truck","tow_truck","tractor","dozer","loader"]}},"equipment":{"type":"array","description":"Additional required equipment","nullable":true,"items":{"type":"string"}},"quantity":{"type":"string","description":"Number of cargo units","nullable":true}}}}}}
```

## The TransportSpecificationCreateRequest object

```json
{"openapi":"3.0.1","info":{"title":"Roolz Public API","version":"1.1"},"components":{"schemas":{"TransportSpecificationCreateRequest":{"description":"Transport characteristics for the transport offer","required":["type","body","available_weight","available_volume"],"properties":{"is_trailer_interchange":{"type":"boolean","description":"Possibility of trailer interchange"},"type":{"type":"string","enum":["any","lcv","solo","special_machinery","lorry"]},"temperature_min_c":{"type":"integer","format":"float","description":"Minimum transportation temperature maintained by the vehicle, degrees Celsius","nullable":true},"temperature_max_c":{"type":"integer","format":"float","description":"Maximum transportation temperature maintained by the vehicle, degrees Celsius","nullable":true},"available_weight":{"type":"integer","format":"float","description":"Weight available for loading, tons"},"available_volume":{"type":"integer","format":"float","description":"Volume available for loading, cubic meters"},"length":{"type":"integer","format":"float","description":"Length available for loading, meters","nullable":true},"width":{"type":"integer","format":"float","description":"Width available for loading, meters","nullable":true},"height":{"type":"integer","format":"float","description":"Height available for loading, meters","nullable":true},"shipping_mode":{"type":"array","description":"Type of transportation. Possible options: FTL, LTL, Special and Any","minItems":0,"items":{"type":"string","enum":["any","ftl","ltl","special"]}},"adr_class":{"type":"array","description":"ADR class (cargo hazard class) approved for transportation","minItems":1,"items":{"type":"string","enum":["no","any_dangerous","adr_1","adr_2_1","adr_2_2","adr_2_3","adr_3","adr_4_1","adr_4_2","adr_4_3","adr_5_1","adr_5_2","adr_6_1","adr_6_2","adr_7","adr_8","adr_9"]}},"body":{"type":"array","minItems":0,"description":"Vehicle body type"},"equipment":{"type":"string","description":"Additional equipment","nullable":true},"loading_type":{"type":"array","minItems":0,"description":"Possible methods of loading into a vehicle.","items":{"type":"string","enum":["rear","side","side_by_side","rack_off","top","tent_off"]}}}}}}}
```

## The CargoUnitCreateRequest object

```json
{"openapi":"3.0.1","info":{"title":"Roolz Public API","version":"1.1"},"components":{"schemas":{"CargoUnitCreateRequest":{"description":"Cargo information for the cargo offer","required":["weight","volume"],"properties":{"name":{"type":"string","description":"Name of cargo"},"type":{"type":"string","description":"Type of cargo","enum":["liquid_bulk","break_bulk","dry_bulk","groupage","oversized","container","eur_pallet","fin_pallet","oth_pallet","bag","big_bag","icb","carton","barrel","roll","reel","coil","crate"]},"quantity":{"type":"integer","description":"Quantity of cargo, pcs.","nullable":true},"weight":{"type":"integer","format":"float","description":"Cargo weight, tons"},"volume":{"type":"integer","format":"float","description":"Cargo volume, cubic meters"},"adr_class":{"type":"string","description":"ADR cargo class","nullable":true,"enum":["no","any_dangerous","adr_1","adr_2_1","adr_2_2","adr_2_3","adr_3","adr_4_1","adr_4_2","adr_4_3","adr_5_1","adr_5_2","adr_6_1","adr_6_2","adr_7","adr_8","adr_9"]},"length":{"type":"integer","format":"float","description":"Cargo length, meters","nullable":true},"width":{"type":"integer","format":"float","description":"Cargo width, meters","nullable":true},"height":{"type":"integer","format":"float","description":"Cargo height, meters","nullable":true},"temperature_min_c":{"type":"integer","format":"float","description":"Minimum required transportation temperature, degrees Celsius","nullable":true},"temperature_max_c":{"type":"integer","format":"float","description":"Maximum required transportation temperature, degrees Celsius","nullable":true},"price":{"$ref":"#/components/schemas/CargoPriceCreateRequest","description":"Cargo price","nullable":true}}},"CargoPriceCreateRequest":{"properties":{"currency":{"type":"string","description":"Price currency"},"value":{"type":"integer","format":"float","description":"Price of cargo in the specified currency"}}}}}}
```

## The CargoPriceCreateRequest object

```json
{"openapi":"3.0.1","info":{"title":"Roolz Public API","version":"1.1"},"components":{"schemas":{"CargoPriceCreateRequest":{"properties":{"currency":{"type":"string","description":"Price currency"},"value":{"type":"integer","format":"float","description":"Price of cargo in the specified currency"}}}}}}
```

## The RoutepointCreateRequest object

```json
{"openapi":"3.0.1","info":{"title":"Roolz Public API","version":"1.1"},"components":{"schemas":{"RoutepointCreateRequest":{"properties":{"order":{"type":"integer","description":"Waypoint ordinal number"},"point_type":{"type":"string","description":"Type of waypoint on Roolz exchange platform","enum":["loading","unloading","border","customs","waypoint"]},"time_zone":{"type":"string","description":"Time zone of the waypoint in minute offset from UTC"},"location":{"$ref":"#/components/schemas/LocationDataCreateRequest","description":"Information about the location"},"start_datetime":{"$ref":"#/components/schemas/DateTimeObject","description":"Start date of the transportation operations at the waypoint","nullable":true},"end_datetime":{"$ref":"#/components/schemas/DateTimeObject","description":"End date of the transportation operations at the waypoint","nullable":true},"loading_type":{"description":"Method of loading/unloading a vehicle","type":"array","nullable":true,"items":{"type":"string"}}}},"LocationDataCreateRequest":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"Object ID (from object search query)"},"is_radius":{"type":"boolean"},"type":{"type":"string","description":"Object type (from object search query)"},"position_type":{"type":"string","description":"Point type"},"radius":{"type":"integer","format":"int32","nullable":true,"description":"Radius"}},"required":["id","is_radius","type","position_type"]},"DateTimeObject":{"required":["date","time"],"properties":{"date":{"type":"string","format":"Y-m-d","description":"Date"},"time":{"type":"string","format":"HH:mm:ss","description":"Time"}}}}}}
```

## The LocationDataCreateRequest object

```json
{"openapi":"3.0.1","info":{"title":"Roolz Public API","version":"1.1"},"components":{"schemas":{"LocationDataCreateRequest":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"Object ID (from object search query)"},"is_radius":{"type":"boolean"},"type":{"type":"string","description":"Object type (from object search query)"},"position_type":{"type":"string","description":"Point type"},"radius":{"type":"integer","format":"int32","nullable":true,"description":"Radius"}},"required":["id","is_radius","type","position_type"]}}}}
```

## The PaymentDataCreateRequest object

```json
{"openapi":"3.0.1","info":{"title":"Roolz Public API","version":"1.1"},"components":{"schemas":{"PaymentDataCreateRequest":{"type":"object","properties":{"quote_is_vat":{"type":"boolean","description":"Bid with VAT"},"is_prepay":{"type":"boolean","description":"Is there a prepayment"},"bid_is_vat":{"type":"boolean","description":"Accept bids with VAT"},"bid_is_no_vat":{"type":"boolean","description":"Accept bids without VAT"},"bid_is_not_unique":{"type":"boolean","description":"Uniqueness of the bid within the space. Forbids/allows to give several bids at the same time (for example, to give different conditions in \"bidding mode\")"},"currency":{"type":"string","description":"Currency"},"payment_condition":{"type":"string","description":"Payment terms"},"payment_method":{"type":"string","description":"Payment method"},"bid_mode":{"type":"string","description":"Bidding mode"},"quote":{"type":"number","format":"decimal","nullable":true,"description":"Target transportation bid in the specified currency in the freight offer"},"extra_quote":{"type":"number","format":"decimal","nullable":true,"description":"Additional bid. If the main bid is specified as a bid with VAT, then the additional bid is displayed as \"without VAT\""},"quote_mileage":{"type":"number","format":"decimal","nullable":true,"description":"Bid in a transport offer; set per unit of mileage (kilometer, mile, etc.)"},"bid_auction_step":{"type":"number","format":"decimal","nullable":true,"description":"Minimum auction step size"},"vat":{"type":"number","format":"decimal","nullable":true,"description":"VAT bid"},"mileage_format":{"type":"string","nullable":true,"description":"Mileage unit for the bid in the transport offer (km, miles, etc.)"},"prepay_percent":{"type":"integer","format":"int64","nullable":true,"description":"Prepayment amount as a percentage of the bid. Only integer values ​​up to 100"},"payment_period":{"type":"integer","format":"int64","nullable":true,"description":"Payment period in days"},"bid_confirm_timeframe":{"type":"integer","format":"int64","nullable":true,"description":"Time for bid confirmation (in seconds)"}},"required":["quote_is_vat","is_prepay","bid_is_vat","bid_is_no_vat","bid_is_not_unique","currency","payment_condition","payment_method","bid_mode"]}}}}
```

## The Company object

```json
{"openapi":"3.0.1","info":{"title":"Roolz Public API","version":"1.1"},"components":{"schemas":{"Company":{"required":["id","owner_id","name","nickname","company_form","exchange_role","is_public","is_verified","offers_count","total_offers_count","employee_amount","order_amount","fleet_amount","foundation_year","registration_date","registration_number","legal_form","legal_form_short","legal_name","transport_license_number","forwarder_license_number","legal_address","mail_address","tax_number","momo","email","phone","website","description","registration_country_alpha2","is_transport_license","is_forwarder_license","is_transport_license_company","is_forwarder_license_company","goal","associations","international_direction","national_direction","transportation_type","cargo_type","logistics_service","customs_service","created_at","updated_at"],"properties":{"id":{"type":"string","format":"UUID","description":"Internal company ID on Roolz exchange"},"owner_id":{"type":"string","format":"UUID","description":"User ID of the company owner on Roolz exchange"},"name":{"type":"string","description":"Public name of the company on Roolz exchange"},"nickname":{"type":"string","description":"Unique nickname of the company on Roolz exchange"},"company_form":{"type":"string","description":"Legal form of organization","enum":["private_company","self_employed","partnership","public_company","government_agency","non_profit"]},"exchange_role":{"type":"string","description":"Company role on Roolz exchange","enum":["shipper","carrier","forwarder","forwarder_carrier","dispatcher","freight_broker","customs_agent","storage_provider","shipper_carrier","other"]},"is_public":{"type":"boolean","description":"This company is available for public viewing and search"},"is_verified":{"type":"boolean","description":"This company has been checked and verified on Roolz exchange"},"offers_count":{"type":"integer","description":"Number of active (published) offers"},"total_offers_count":{"type":"integer","description":"Total number of offers created on Roolz exchange since the registration"},"employee_amount":{"type":"string","description":"Average number of employees in the company","enum":["1_15","16_50","51_150","151_500","501_1500","1501_5000","5000_more"]},"order_amount":{"type":"string","description":"Number of shipments per month","enum":[0,"1_30","31_100","101_500","501_2000","2001_10000","10001_50000","50000_more"]},"fleet_amount":{"type":"string","description":"Size of the company's fleet (number of units)","nullable":true,"enum":["1_5","6_15","16_50","51_100","101_500","501_1000","1000_more"]},"foundation_year":{"type":"integer","description":"Year when the company was founded"},"registration_date":{"type":"string","description":"Date of registration of the company by the authorized body","nullable":true},"registration_number":{"type":"string","description":"Company registration number, assigned upon registration with the authorized body of the country"},"legal_form":{"type":"string","description":"Full legal form (company type)"},"legal_form_short":{"type":"string","description":"Abbreviated organizational and legal form (company type: LLC, Inc., etc.)"},"legal_name":{"type":"string","description":"Full legal name of the company with the registration form"},"transport_license_number":{"type":"string","description":"Transport license number","nullable":true},"forwarder_license_number":{"type":"string","description":"Freight forwarder license number","nullable":true},"legal_address":{"type":"string","description":"Legal address of the company"},"mail_address":{"type":"string","description":"Company mailing address"},"tax_number":{"type":"string","description":"Tax number or company ID"},"momo":{"type":"string","description":"A short slogan or motto for the company"},"email":{"type":"string","format":"email","description":"Company email address"},"phone":{"type":"string","description":"Company phone number"},"website":{"type":"string","description":"Company website"},"description":{"type":"string","description":"Company description"},"registration_country_alpha2":{"type":"string","description":"Alpha2 country code of company registration"},"is_transport_license":{"type":"boolean","description":"Availability of a transport license"},"is_forwarder_license":{"type":"boolean","description":"Availability of a carrier license"},"is_transport_license_company":{"type":"boolean","description":"Transport license is issued to this legal entity"},"is_forwarder_license_company":{"type":"boolean","description":"Carrier's license is issued to this legal entity"},"goal":{"type":"array","minItems":0,"description":"","items":{"type":"string","enum":["find_cargo","find_transport","private_exchange","api_integration","visibility","communication","crm","tms","fms","offer_service","other"]}},"associations":{"type":"array","minItems":0,"description":"List of associations the company is a member of","items":{"type":"string","enum":["us_tia","us_ooida","us_ata","tw_iofflat","cn_crta","cn_cifa","tw_tafla","tw_tfla","jp_jiffa","jp_jafa","jp_jfff","mx_amacarga","id_ilfa","th_tiffa","br_actc","ru_asmap","ru_far","fr_aftri","fr_tlf","in_ficci","in_acaai","in_fffai","es_astic","es_feteia","it_uicciaa","it_fdespedi","tr_tobb","tr_und","tr_utikad","gb_logistics_uk","gb_bifa","gb_rha","kr_kiffa","au_afif","au_cbfca","pl_zmpd","pl_piffa","de_bgl","de_dslv","de_aist","ar_aaaci","za_saaff","sy_snc_icc","sy_siffa","co_fitac","sa_sata","sa_nlc","ua_asmap_ua","ua_aiffu","ua_ukrzovnihtrans","ir_iccima","ir_itca","eg_eiffa","cl_alog_chile","ec_aseaci","pt_antram","pt_apat","my_fmff","gt_agac","ca_ciffa","gr_ofae","gr_iffag_l","nl_fenex","ma_amtri","ma_affm","ro_untrr","ro_user","be_febetra","be_forward_belgium","do_adacam","lk_slffa","cz_cesmad_boemia","cz_ssl","nz_cbaff","se_sa","se_sifa","no_nlf","no_nho_lt","kz_kazato","kz_kffa","ke_kifwa","hu_mkfe","hu_ahf","pk_pnc_icc","pk_piffa","bg_aebtri","bg_nsbs","by_bamap","by_baif","ph_pmtlai","tn_ccit","at_zv","at_aiso","kg_airto_kr","dk_dsf","dk_dtl","ch_spedlogswiss","ch_asag","af_acci","ni_anac","il_irtb","il_iffcca","sk_cesmad_slovakia","sk_zlz_sr","ug_uffa","ie_irha","ie_iifa","gh_giff","qa_qcci","kw_kiac","py_atolpar","bd_baffa","cr_acacia","om_sinyar","rs_ccis_at","md_aem_trans","md_aita","sg_saaa__singapore","sg_sla","az_abada","vn_va","hr_cce","hr_hgk","sv_asac","ge_girca","ge_afg","pa_apac","ae_atcuae","tz_taffa","tz_zfb","ae_nafl","hk_haffa","jo_racj","jo_jla","hn_ahaci","uy_audaca","zm_zcfaa","lb_cciabml","lb_lfs","zw_sfaaz","lt_linava","lt_lineka","ee_eraa","ee_elfa","cy_tda","cy_ccfaa","si_giz_itt","s_ccis","fi_skal","fi_shll","lv_latvijas_auto","lv_laff","cm_synautratra","ba_airh","ba_vtk_stk_bih","al_analtir","et_effsaa","mt_atto","mt_malta_chamber","mu_apt","mk_amerit","bn_brufa","uz_aircuz","kh_camffa","am_airca","am_aaff","mn_nartam","dj_atd","tj_abbat","mm_miffa","tm_hada","uz_uifa","me_pkcg","mn_fmff"]}},"international_direction":{"type":"array","minItems":0,"description":"Alpha2 codes of countries to/from which the company carries out international transportation","items":{"type":"string"}},"national_direction":{"type":"array","minItems":0,"description":"Alpha2 codes of countries to/from which the company carries out domestic transportation","items":{"type":"string"}},"transportation_type":{"type":"array","minItems":0,"description":"Types of transportation available","items":{"type":"string","enum":["road","ocean","air","railway","multimodal"]}},"cargo_type":{"type":"array","minItems":0,"description":"Types of cargo transported","items":{"type":"string","enum":["general","groupage","cep","last_mile","adr","oversize","project","temperature","perishable","bulk","liquid","container","passenger","animals","other_special"]}},"logistics_service":{"type":"array","minItems":0,"description":"Provided logistics services","items":{"type":"string","enum":["transportation","forwarding","dispatching","freight_brokerage","inventory_mngmt","order_mngmt","responsible_storage","storage_rent","transport_rent","cargo_consolidation","cross_docking","loader_work","cargo_insurance","transport_insurance","return_mngmt"]}},"customs_service":{"type":"array","minItems":0,"description":"Additional provided services","items":{"type":"string","enum":["declaration","statistical_declaration","document_handling","representation","consulting","customs_guarantee","temporary_storage"]}},"created_at":{"type":"string","description":"Date and time of the company profile creation (in UTC)"},"updated_at":{"type":"string","description":"Date and time of the last modification of the company profile (in UTC)"}}}}}}
```

## The GeoFeature object

```json
{"openapi":"3.0.1","info":{"title":"Roolz Public API","version":"1.1"},"components":{"schemas":{"GeoFeature":{"properties":{"type":{"type":"string"},"center":{"type":"object","properties":{"lat":{"type":"number"},"lon":{"type":"number"}}},"properties":{"type":"object","properties":{"location_id":{"type":"integer"},"location_type":{"type":"string"},"location_attribute_key":{"type":"string"},"location_attribute_value":{"type":"string"},"name":{"type":"string"},"state":{"type":"string"},"country":{"type":"string"},"country_code":{"type":"string"},"county":{"type":"string","nullable":true},"postcode":{"type":"string","nullable":true}}}}}}}}
```

## The User object

```json
{"openapi":"3.0.1","info":{"title":"Roolz Public API","version":"1.1"},"components":{"schemas":{"User":{"required":["id","phone","email","nickname","first_name","last_name","middle_name","work_email","work_phone","own_email","own_phone","site"],"properties":{"id":{"type":"string","format":"UUID","description":"Internal user ID on Roolz exchange"},"phone":{"type":"string","description":"User's phone number specified during registration and/or used to log into the account","nullable":true},"email":{"type":"string","description":"User's email specified during registration and/or used to log into the account","nullable":true},"nickname":{"type":"string","description":"Unique username of the user on Roolz exchange"},"first_name":{"type":"string","description":"First name of the user"},"last_name":{"type":"string","description":"Last name of the user"},"middle_name":{"type":"string","description":"Middle name of the user","nullable":true},"work_email":{"type":"string","description":"Work email address","nullable":true},"work_phone":{"type":"string","description":"Work phone number","nullable":true},"own_email":{"type":"string","description":"Personal email address","nullable":true},"own_phone":{"type":"string","description":"Personal phone number","nullable":true},"site":{"type":"string","description":"Website","nullable":true}}}}}}
```


# Company

## GET /company

> Getting your company profile

```json
{"openapi":"3.0.1","info":{"title":"Roolz Public API","version":"1.1"},"servers":[{"url":"https://api.test.roolz.tech/public-api/v1","description":"Test environment for development"}],"security":[{"getKey":[]},{"headerKey":[]}],"components":{"securitySchemes":{"getKey":{"type":"apiKey","description":"API key for authorizing requests in GET parameters","name":"apikey","in":"query"},"headerKey":{"type":"apiKey","description":"API key for authorizing requests in header","name":"X-Api-Key","in":"header"}},"parameters":{"ContentTypeHeader":{"in":"header","name":"Content-Type","required":true,"description":"","schema":{"type":"string","default":"application/json","enum":["application/json"]}},"AcceptEncodingHeader":{"in":"header","name":"Accept-Encoding","required":true,"description":"","schema":{"type":"string","default":"gzip","enum":["gzip"]}}},"schemas":{"Company":{"required":["id","owner_id","name","nickname","company_form","exchange_role","is_public","is_verified","offers_count","total_offers_count","employee_amount","order_amount","fleet_amount","foundation_year","registration_date","registration_number","legal_form","legal_form_short","legal_name","transport_license_number","forwarder_license_number","legal_address","mail_address","tax_number","momo","email","phone","website","description","registration_country_alpha2","is_transport_license","is_forwarder_license","is_transport_license_company","is_forwarder_license_company","goal","associations","international_direction","national_direction","transportation_type","cargo_type","logistics_service","customs_service","created_at","updated_at"],"properties":{"id":{"type":"string","format":"UUID","description":"Internal company ID on Roolz exchange"},"owner_id":{"type":"string","format":"UUID","description":"User ID of the company owner on Roolz exchange"},"name":{"type":"string","description":"Public name of the company on Roolz exchange"},"nickname":{"type":"string","description":"Unique nickname of the company on Roolz exchange"},"company_form":{"type":"string","description":"Legal form of organization","enum":["private_company","self_employed","partnership","public_company","government_agency","non_profit"]},"exchange_role":{"type":"string","description":"Company role on Roolz exchange","enum":["shipper","carrier","forwarder","forwarder_carrier","dispatcher","freight_broker","customs_agent","storage_provider","shipper_carrier","other"]},"is_public":{"type":"boolean","description":"This company is available for public viewing and search"},"is_verified":{"type":"boolean","description":"This company has been checked and verified on Roolz exchange"},"offers_count":{"type":"integer","description":"Number of active (published) offers"},"total_offers_count":{"type":"integer","description":"Total number of offers created on Roolz exchange since the registration"},"employee_amount":{"type":"string","description":"Average number of employees in the company","enum":["1_15","16_50","51_150","151_500","501_1500","1501_5000","5000_more"]},"order_amount":{"type":"string","description":"Number of shipments per month","enum":[0,"1_30","31_100","101_500","501_2000","2001_10000","10001_50000","50000_more"]},"fleet_amount":{"type":"string","description":"Size of the company's fleet (number of units)","nullable":true,"enum":["1_5","6_15","16_50","51_100","101_500","501_1000","1000_more"]},"foundation_year":{"type":"integer","description":"Year when the company was founded"},"registration_date":{"type":"string","description":"Date of registration of the company by the authorized body","nullable":true},"registration_number":{"type":"string","description":"Company registration number, assigned upon registration with the authorized body of the country"},"legal_form":{"type":"string","description":"Full legal form (company type)"},"legal_form_short":{"type":"string","description":"Abbreviated organizational and legal form (company type: LLC, Inc., etc.)"},"legal_name":{"type":"string","description":"Full legal name of the company with the registration form"},"transport_license_number":{"type":"string","description":"Transport license number","nullable":true},"forwarder_license_number":{"type":"string","description":"Freight forwarder license number","nullable":true},"legal_address":{"type":"string","description":"Legal address of the company"},"mail_address":{"type":"string","description":"Company mailing address"},"tax_number":{"type":"string","description":"Tax number or company ID"},"momo":{"type":"string","description":"A short slogan or motto for the company"},"email":{"type":"string","format":"email","description":"Company email address"},"phone":{"type":"string","description":"Company phone number"},"website":{"type":"string","description":"Company website"},"description":{"type":"string","description":"Company description"},"registration_country_alpha2":{"type":"string","description":"Alpha2 country code of company registration"},"is_transport_license":{"type":"boolean","description":"Availability of a transport license"},"is_forwarder_license":{"type":"boolean","description":"Availability of a carrier license"},"is_transport_license_company":{"type":"boolean","description":"Transport license is issued to this legal entity"},"is_forwarder_license_company":{"type":"boolean","description":"Carrier's license is issued to this legal entity"},"goal":{"type":"array","minItems":0,"description":"","items":{"type":"string","enum":["find_cargo","find_transport","private_exchange","api_integration","visibility","communication","crm","tms","fms","offer_service","other"]}},"associations":{"type":"array","minItems":0,"description":"List of associations the company is a member of","items":{"type":"string","enum":["us_tia","us_ooida","us_ata","tw_iofflat","cn_crta","cn_cifa","tw_tafla","tw_tfla","jp_jiffa","jp_jafa","jp_jfff","mx_amacarga","id_ilfa","th_tiffa","br_actc","ru_asmap","ru_far","fr_aftri","fr_tlf","in_ficci","in_acaai","in_fffai","es_astic","es_feteia","it_uicciaa","it_fdespedi","tr_tobb","tr_und","tr_utikad","gb_logistics_uk","gb_bifa","gb_rha","kr_kiffa","au_afif","au_cbfca","pl_zmpd","pl_piffa","de_bgl","de_dslv","de_aist","ar_aaaci","za_saaff","sy_snc_icc","sy_siffa","co_fitac","sa_sata","sa_nlc","ua_asmap_ua","ua_aiffu","ua_ukrzovnihtrans","ir_iccima","ir_itca","eg_eiffa","cl_alog_chile","ec_aseaci","pt_antram","pt_apat","my_fmff","gt_agac","ca_ciffa","gr_ofae","gr_iffag_l","nl_fenex","ma_amtri","ma_affm","ro_untrr","ro_user","be_febetra","be_forward_belgium","do_adacam","lk_slffa","cz_cesmad_boemia","cz_ssl","nz_cbaff","se_sa","se_sifa","no_nlf","no_nho_lt","kz_kazato","kz_kffa","ke_kifwa","hu_mkfe","hu_ahf","pk_pnc_icc","pk_piffa","bg_aebtri","bg_nsbs","by_bamap","by_baif","ph_pmtlai","tn_ccit","at_zv","at_aiso","kg_airto_kr","dk_dsf","dk_dtl","ch_spedlogswiss","ch_asag","af_acci","ni_anac","il_irtb","il_iffcca","sk_cesmad_slovakia","sk_zlz_sr","ug_uffa","ie_irha","ie_iifa","gh_giff","qa_qcci","kw_kiac","py_atolpar","bd_baffa","cr_acacia","om_sinyar","rs_ccis_at","md_aem_trans","md_aita","sg_saaa__singapore","sg_sla","az_abada","vn_va","hr_cce","hr_hgk","sv_asac","ge_girca","ge_afg","pa_apac","ae_atcuae","tz_taffa","tz_zfb","ae_nafl","hk_haffa","jo_racj","jo_jla","hn_ahaci","uy_audaca","zm_zcfaa","lb_cciabml","lb_lfs","zw_sfaaz","lt_linava","lt_lineka","ee_eraa","ee_elfa","cy_tda","cy_ccfaa","si_giz_itt","s_ccis","fi_skal","fi_shll","lv_latvijas_auto","lv_laff","cm_synautratra","ba_airh","ba_vtk_stk_bih","al_analtir","et_effsaa","mt_atto","mt_malta_chamber","mu_apt","mk_amerit","bn_brufa","uz_aircuz","kh_camffa","am_airca","am_aaff","mn_nartam","dj_atd","tj_abbat","mm_miffa","tm_hada","uz_uifa","me_pkcg","mn_fmff"]}},"international_direction":{"type":"array","minItems":0,"description":"Alpha2 codes of countries to/from which the company carries out international transportation","items":{"type":"string"}},"national_direction":{"type":"array","minItems":0,"description":"Alpha2 codes of countries to/from which the company carries out domestic transportation","items":{"type":"string"}},"transportation_type":{"type":"array","minItems":0,"description":"Types of transportation available","items":{"type":"string","enum":["road","ocean","air","railway","multimodal"]}},"cargo_type":{"type":"array","minItems":0,"description":"Types of cargo transported","items":{"type":"string","enum":["general","groupage","cep","last_mile","adr","oversize","project","temperature","perishable","bulk","liquid","container","passenger","animals","other_special"]}},"logistics_service":{"type":"array","minItems":0,"description":"Provided logistics services","items":{"type":"string","enum":["transportation","forwarding","dispatching","freight_brokerage","inventory_mngmt","order_mngmt","responsible_storage","storage_rent","transport_rent","cargo_consolidation","cross_docking","loader_work","cargo_insurance","transport_insurance","return_mngmt"]}},"customs_service":{"type":"array","minItems":0,"description":"Additional provided services","items":{"type":"string","enum":["declaration","statistical_declaration","document_handling","representation","consulting","customs_guarantee","temporary_storage"]}},"created_at":{"type":"string","description":"Date and time of the company profile creation (in UTC)"},"updated_at":{"type":"string","description":"Date and time of the last modification of the company profile (in UTC)"}}},"ErrorObject":{"required":["state","message","internal"],"properties":{"state":{"type":"string","description":"Request execution status","enum":["error"]},"message":{"type":"string","description":"Additional information"},"validations":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"path":{"type":"string"},"reason":{"type":"string"}}}},"internal":{"type":"object","description":"Internal information from Roolz exchange platform to analyze the problem when executing a request","required":["roolz_debug_id"],"properties":{"roolz_debug_id":{"type":"string"}}}}}}},"paths":{"/company":{"get":{"tags":["companies"],"operationId":"getMyCompanyProfile","summary":"Getting your company profile","parameters":[{"$ref":"#/components/parameters/ContentTypeHeader"},{"$ref":"#/components/parameters/AcceptEncodingHeader"}],"responses":{"200":{"description":"Successful execution of the request","content":{"application/json":{"schema":{"type":"object","required":["company"],"properties":{"company":{"$ref":"#/components/schemas/Company"}}}}}},"400":{"description":"Error in input data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorObject"}}}},"401":{"description":"Request not authorized. API key may be missing."},"403":{"description":"This operation is not permitted."}}}}}}
```

## GET /company/users

> Getting a list of the users of your company

```json
{"openapi":"3.0.1","info":{"title":"Roolz Public API","version":"1.1"},"servers":[{"url":"https://api.test.roolz.tech/public-api/v1","description":"Test environment for development"}],"security":[{"getKey":[]},{"headerKey":[]}],"components":{"securitySchemes":{"getKey":{"type":"apiKey","description":"API key for authorizing requests in GET parameters","name":"apikey","in":"query"},"headerKey":{"type":"apiKey","description":"API key for authorizing requests in header","name":"X-Api-Key","in":"header"}},"parameters":{"ContentTypeHeader":{"in":"header","name":"Content-Type","required":true,"description":"","schema":{"type":"string","default":"application/json","enum":["application/json"]}},"AcceptEncodingHeader":{"in":"header","name":"Accept-Encoding","required":true,"description":"","schema":{"type":"string","default":"gzip","enum":["gzip"]}}},"schemas":{"User":{"required":["id","phone","email","nickname","first_name","last_name","middle_name","work_email","work_phone","own_email","own_phone","site"],"properties":{"id":{"type":"string","format":"UUID","description":"Internal user ID on Roolz exchange"},"phone":{"type":"string","description":"User's phone number specified during registration and/or used to log into the account","nullable":true},"email":{"type":"string","description":"User's email specified during registration and/or used to log into the account","nullable":true},"nickname":{"type":"string","description":"Unique username of the user on Roolz exchange"},"first_name":{"type":"string","description":"First name of the user"},"last_name":{"type":"string","description":"Last name of the user"},"middle_name":{"type":"string","description":"Middle name of the user","nullable":true},"work_email":{"type":"string","description":"Work email address","nullable":true},"work_phone":{"type":"string","description":"Work phone number","nullable":true},"own_email":{"type":"string","description":"Personal email address","nullable":true},"own_phone":{"type":"string","description":"Personal phone number","nullable":true},"site":{"type":"string","description":"Website","nullable":true}}},"ErrorObject":{"required":["state","message","internal"],"properties":{"state":{"type":"string","description":"Request execution status","enum":["error"]},"message":{"type":"string","description":"Additional information"},"validations":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"path":{"type":"string"},"reason":{"type":"string"}}}},"internal":{"type":"object","description":"Internal information from Roolz exchange platform to analyze the problem when executing a request","required":["roolz_debug_id"],"properties":{"roolz_debug_id":{"type":"string"}}}}}}},"paths":{"/company/users":{"get":{"tags":["companies"],"operationId":"getMyCompanyUsers","summary":"Getting a list of the users of your company","parameters":[{"$ref":"#/components/parameters/ContentTypeHeader"},{"$ref":"#/components/parameters/AcceptEncodingHeader"},{"name":"limit","in":"query","required":false,"description":"Limit on the number of users listed per pagination iteration","schema":{"type":"integer","minimum":1,"maximum":50,"default":25}},{"name":"offset","in":"query","required":false,"description":"Offset of the paginated users selection relative to the previous selection","schema":{"type":"integer","minimum":0,"default":0}}],"responses":{"200":{"description":"Successful execution of the request","content":{"application/json":{"schema":{"type":"object","required":["total","count","users"],"properties":{"total":{"type":"integer","description":"Total number of users listed"},"count":{"type":"integer","description":"Number of users listed in this pagination iteration"},"users":{"type":"array","items":{"$ref":"#/components/schemas/User"}}}}}}},"400":{"description":"Error in input data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorObject"}}}},"401":{"description":"Request not authorized. API key may be missing."},"403":{"description":"This operation is not permitted."}}}}}}
```

## The Company object

```json
{"openapi":"3.0.1","info":{"title":"Roolz Public API","version":"1.1"},"components":{"schemas":{"Company":{"required":["id","owner_id","name","nickname","company_form","exchange_role","is_public","is_verified","offers_count","total_offers_count","employee_amount","order_amount","fleet_amount","foundation_year","registration_date","registration_number","legal_form","legal_form_short","legal_name","transport_license_number","forwarder_license_number","legal_address","mail_address","tax_number","momo","email","phone","website","description","registration_country_alpha2","is_transport_license","is_forwarder_license","is_transport_license_company","is_forwarder_license_company","goal","associations","international_direction","national_direction","transportation_type","cargo_type","logistics_service","customs_service","created_at","updated_at"],"properties":{"id":{"type":"string","format":"UUID","description":"Internal company ID on Roolz exchange"},"owner_id":{"type":"string","format":"UUID","description":"User ID of the company owner on Roolz exchange"},"name":{"type":"string","description":"Public name of the company on Roolz exchange"},"nickname":{"type":"string","description":"Unique nickname of the company on Roolz exchange"},"company_form":{"type":"string","description":"Legal form of organization","enum":["private_company","self_employed","partnership","public_company","government_agency","non_profit"]},"exchange_role":{"type":"string","description":"Company role on Roolz exchange","enum":["shipper","carrier","forwarder","forwarder_carrier","dispatcher","freight_broker","customs_agent","storage_provider","shipper_carrier","other"]},"is_public":{"type":"boolean","description":"This company is available for public viewing and search"},"is_verified":{"type":"boolean","description":"This company has been checked and verified on Roolz exchange"},"offers_count":{"type":"integer","description":"Number of active (published) offers"},"total_offers_count":{"type":"integer","description":"Total number of offers created on Roolz exchange since the registration"},"employee_amount":{"type":"string","description":"Average number of employees in the company","enum":["1_15","16_50","51_150","151_500","501_1500","1501_5000","5000_more"]},"order_amount":{"type":"string","description":"Number of shipments per month","enum":[0,"1_30","31_100","101_500","501_2000","2001_10000","10001_50000","50000_more"]},"fleet_amount":{"type":"string","description":"Size of the company's fleet (number of units)","nullable":true,"enum":["1_5","6_15","16_50","51_100","101_500","501_1000","1000_more"]},"foundation_year":{"type":"integer","description":"Year when the company was founded"},"registration_date":{"type":"string","description":"Date of registration of the company by the authorized body","nullable":true},"registration_number":{"type":"string","description":"Company registration number, assigned upon registration with the authorized body of the country"},"legal_form":{"type":"string","description":"Full legal form (company type)"},"legal_form_short":{"type":"string","description":"Abbreviated organizational and legal form (company type: LLC, Inc., etc.)"},"legal_name":{"type":"string","description":"Full legal name of the company with the registration form"},"transport_license_number":{"type":"string","description":"Transport license number","nullable":true},"forwarder_license_number":{"type":"string","description":"Freight forwarder license number","nullable":true},"legal_address":{"type":"string","description":"Legal address of the company"},"mail_address":{"type":"string","description":"Company mailing address"},"tax_number":{"type":"string","description":"Tax number or company ID"},"momo":{"type":"string","description":"A short slogan or motto for the company"},"email":{"type":"string","format":"email","description":"Company email address"},"phone":{"type":"string","description":"Company phone number"},"website":{"type":"string","description":"Company website"},"description":{"type":"string","description":"Company description"},"registration_country_alpha2":{"type":"string","description":"Alpha2 country code of company registration"},"is_transport_license":{"type":"boolean","description":"Availability of a transport license"},"is_forwarder_license":{"type":"boolean","description":"Availability of a carrier license"},"is_transport_license_company":{"type":"boolean","description":"Transport license is issued to this legal entity"},"is_forwarder_license_company":{"type":"boolean","description":"Carrier's license is issued to this legal entity"},"goal":{"type":"array","minItems":0,"description":"","items":{"type":"string","enum":["find_cargo","find_transport","private_exchange","api_integration","visibility","communication","crm","tms","fms","offer_service","other"]}},"associations":{"type":"array","minItems":0,"description":"List of associations the company is a member of","items":{"type":"string","enum":["us_tia","us_ooida","us_ata","tw_iofflat","cn_crta","cn_cifa","tw_tafla","tw_tfla","jp_jiffa","jp_jafa","jp_jfff","mx_amacarga","id_ilfa","th_tiffa","br_actc","ru_asmap","ru_far","fr_aftri","fr_tlf","in_ficci","in_acaai","in_fffai","es_astic","es_feteia","it_uicciaa","it_fdespedi","tr_tobb","tr_und","tr_utikad","gb_logistics_uk","gb_bifa","gb_rha","kr_kiffa","au_afif","au_cbfca","pl_zmpd","pl_piffa","de_bgl","de_dslv","de_aist","ar_aaaci","za_saaff","sy_snc_icc","sy_siffa","co_fitac","sa_sata","sa_nlc","ua_asmap_ua","ua_aiffu","ua_ukrzovnihtrans","ir_iccima","ir_itca","eg_eiffa","cl_alog_chile","ec_aseaci","pt_antram","pt_apat","my_fmff","gt_agac","ca_ciffa","gr_ofae","gr_iffag_l","nl_fenex","ma_amtri","ma_affm","ro_untrr","ro_user","be_febetra","be_forward_belgium","do_adacam","lk_slffa","cz_cesmad_boemia","cz_ssl","nz_cbaff","se_sa","se_sifa","no_nlf","no_nho_lt","kz_kazato","kz_kffa","ke_kifwa","hu_mkfe","hu_ahf","pk_pnc_icc","pk_piffa","bg_aebtri","bg_nsbs","by_bamap","by_baif","ph_pmtlai","tn_ccit","at_zv","at_aiso","kg_airto_kr","dk_dsf","dk_dtl","ch_spedlogswiss","ch_asag","af_acci","ni_anac","il_irtb","il_iffcca","sk_cesmad_slovakia","sk_zlz_sr","ug_uffa","ie_irha","ie_iifa","gh_giff","qa_qcci","kw_kiac","py_atolpar","bd_baffa","cr_acacia","om_sinyar","rs_ccis_at","md_aem_trans","md_aita","sg_saaa__singapore","sg_sla","az_abada","vn_va","hr_cce","hr_hgk","sv_asac","ge_girca","ge_afg","pa_apac","ae_atcuae","tz_taffa","tz_zfb","ae_nafl","hk_haffa","jo_racj","jo_jla","hn_ahaci","uy_audaca","zm_zcfaa","lb_cciabml","lb_lfs","zw_sfaaz","lt_linava","lt_lineka","ee_eraa","ee_elfa","cy_tda","cy_ccfaa","si_giz_itt","s_ccis","fi_skal","fi_shll","lv_latvijas_auto","lv_laff","cm_synautratra","ba_airh","ba_vtk_stk_bih","al_analtir","et_effsaa","mt_atto","mt_malta_chamber","mu_apt","mk_amerit","bn_brufa","uz_aircuz","kh_camffa","am_airca","am_aaff","mn_nartam","dj_atd","tj_abbat","mm_miffa","tm_hada","uz_uifa","me_pkcg","mn_fmff"]}},"international_direction":{"type":"array","minItems":0,"description":"Alpha2 codes of countries to/from which the company carries out international transportation","items":{"type":"string"}},"national_direction":{"type":"array","minItems":0,"description":"Alpha2 codes of countries to/from which the company carries out domestic transportation","items":{"type":"string"}},"transportation_type":{"type":"array","minItems":0,"description":"Types of transportation available","items":{"type":"string","enum":["road","ocean","air","railway","multimodal"]}},"cargo_type":{"type":"array","minItems":0,"description":"Types of cargo transported","items":{"type":"string","enum":["general","groupage","cep","last_mile","adr","oversize","project","temperature","perishable","bulk","liquid","container","passenger","animals","other_special"]}},"logistics_service":{"type":"array","minItems":0,"description":"Provided logistics services","items":{"type":"string","enum":["transportation","forwarding","dispatching","freight_brokerage","inventory_mngmt","order_mngmt","responsible_storage","storage_rent","transport_rent","cargo_consolidation","cross_docking","loader_work","cargo_insurance","transport_insurance","return_mngmt"]}},"customs_service":{"type":"array","minItems":0,"description":"Additional provided services","items":{"type":"string","enum":["declaration","statistical_declaration","document_handling","representation","consulting","customs_guarantee","temporary_storage"]}},"created_at":{"type":"string","description":"Date and time of the company profile creation (in UTC)"},"updated_at":{"type":"string","description":"Date and time of the last modification of the company profile (in UTC)"}}}}}}
```

## The User object

```json
{"openapi":"3.0.1","info":{"title":"Roolz Public API","version":"1.1"},"components":{"schemas":{"User":{"required":["id","phone","email","nickname","first_name","last_name","middle_name","work_email","work_phone","own_email","own_phone","site"],"properties":{"id":{"type":"string","format":"UUID","description":"Internal user ID on Roolz exchange"},"phone":{"type":"string","description":"User's phone number specified during registration and/or used to log into the account","nullable":true},"email":{"type":"string","description":"User's email specified during registration and/or used to log into the account","nullable":true},"nickname":{"type":"string","description":"Unique username of the user on Roolz exchange"},"first_name":{"type":"string","description":"First name of the user"},"last_name":{"type":"string","description":"Last name of the user"},"middle_name":{"type":"string","description":"Middle name of the user","nullable":true},"work_email":{"type":"string","description":"Work email address","nullable":true},"work_phone":{"type":"string","description":"Work phone number","nullable":true},"own_email":{"type":"string","description":"Personal email address","nullable":true},"own_phone":{"type":"string","description":"Personal phone number","nullable":true},"site":{"type":"string","description":"Website","nullable":true}}}}}}
```


# System

## GET /system/offers/types

> Getting a list of offer types supported by the system

```json
{"openapi":"3.0.1","info":{"title":"Roolz Public API","version":"1.1"},"servers":[{"url":"https://api.test.roolz.tech/public-api/v1","description":"Test environment for development"}],"security":[{"getKey":[]},{"headerKey":[]}],"components":{"securitySchemes":{"getKey":{"type":"apiKey","description":"API key for authorizing requests in GET parameters","name":"apikey","in":"query"},"headerKey":{"type":"apiKey","description":"API key for authorizing requests in header","name":"X-Api-Key","in":"header"}},"parameters":{"ContentTypeHeader":{"in":"header","name":"Content-Type","required":true,"description":"","schema":{"type":"string","default":"application/json","enum":["application/json"]}},"AcceptEncodingHeader":{"in":"header","name":"Accept-Encoding","required":true,"description":"","schema":{"type":"string","default":"gzip","enum":["gzip"]}}},"schemas":{"ErrorObject":{"required":["state","message","internal"],"properties":{"state":{"type":"string","description":"Request execution status","enum":["error"]},"message":{"type":"string","description":"Additional information"},"validations":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"path":{"type":"string"},"reason":{"type":"string"}}}},"internal":{"type":"object","description":"Internal information from Roolz exchange platform to analyze the problem when executing a request","required":["roolz_debug_id"],"properties":{"roolz_debug_id":{"type":"string"}}}}}}},"paths":{"/system/offers/types":{"get":{"tags":["system"],"operationId":"getSupportedExchangeOffersTypes","summary":"Getting a list of offer types supported by the system","parameters":[{"$ref":"#/components/parameters/ContentTypeHeader"},{"$ref":"#/components/parameters/AcceptEncodingHeader"}],"responses":{"200":{"description":"Successful execution of the request","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"400":{"description":"Error in input data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorObject"}}}},"401":{"description":"Request not authorized. API key may be missing."},"403":{"description":"This operation is not permitted."}}}}}}
```

## GET /system/offers/statuses

> Getting a list of offer statuses supported by the system

```json
{"openapi":"3.0.1","info":{"title":"Roolz Public API","version":"1.1"},"servers":[{"url":"https://api.test.roolz.tech/public-api/v1","description":"Test environment for development"}],"security":[{"getKey":[]},{"headerKey":[]}],"components":{"securitySchemes":{"getKey":{"type":"apiKey","description":"API key for authorizing requests in GET parameters","name":"apikey","in":"query"},"headerKey":{"type":"apiKey","description":"API key for authorizing requests in header","name":"X-Api-Key","in":"header"}},"parameters":{"ContentTypeHeader":{"in":"header","name":"Content-Type","required":true,"description":"","schema":{"type":"string","default":"application/json","enum":["application/json"]}},"AcceptEncodingHeader":{"in":"header","name":"Accept-Encoding","required":true,"description":"","schema":{"type":"string","default":"gzip","enum":["gzip"]}}},"schemas":{"ErrorObject":{"required":["state","message","internal"],"properties":{"state":{"type":"string","description":"Request execution status","enum":["error"]},"message":{"type":"string","description":"Additional information"},"validations":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"path":{"type":"string"},"reason":{"type":"string"}}}},"internal":{"type":"object","description":"Internal information from Roolz exchange platform to analyze the problem when executing a request","required":["roolz_debug_id"],"properties":{"roolz_debug_id":{"type":"string"}}}}}}},"paths":{"/system/offers/statuses":{"get":{"tags":["system"],"operationId":"getSupportedExchangeOffersStatuses","summary":"Getting a list of offer statuses supported by the system","parameters":[{"$ref":"#/components/parameters/ContentTypeHeader"},{"$ref":"#/components/parameters/AcceptEncodingHeader"}],"responses":{"200":{"description":"Successful execution of the request","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"400":{"description":"Error in input data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorObject"}}}},"401":{"description":"Request not authorized. API key may be missing."},"403":{"description":"This operation is not permitted."}}}}}}
```

## GET /system/geo-search

> Geo objects search

```json
{"openapi":"3.0.1","info":{"title":"Roolz Public API","version":"1.1"},"servers":[{"url":"https://api.test.roolz.tech/public-api/v1","description":"Test environment for development"}],"security":[{"getKey":[]},{"headerKey":[]}],"components":{"securitySchemes":{"getKey":{"type":"apiKey","description":"API key for authorizing requests in GET parameters","name":"apikey","in":"query"},"headerKey":{"type":"apiKey","description":"API key for authorizing requests in header","name":"X-Api-Key","in":"header"}},"parameters":{"ContentTypeHeader":{"in":"header","name":"Content-Type","required":true,"description":"","schema":{"type":"string","default":"application/json","enum":["application/json"]}},"AcceptEncodingHeader":{"in":"header","name":"Accept-Encoding","required":true,"description":"","schema":{"type":"string","default":"gzip","enum":["gzip"]}}},"schemas":{"GeoFeature":{"properties":{"type":{"type":"string"},"center":{"type":"object","properties":{"lat":{"type":"number"},"lon":{"type":"number"}}},"properties":{"type":"object","properties":{"location_id":{"type":"integer"},"location_type":{"type":"string"},"location_attribute_key":{"type":"string"},"location_attribute_value":{"type":"string"},"name":{"type":"string"},"state":{"type":"string"},"country":{"type":"string"},"country_code":{"type":"string"},"county":{"type":"string","nullable":true},"postcode":{"type":"string","nullable":true}}}}},"ErrorObject":{"required":["state","message","internal"],"properties":{"state":{"type":"string","description":"Request execution status","enum":["error"]},"message":{"type":"string","description":"Additional information"},"validations":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"path":{"type":"string"},"reason":{"type":"string"}}}},"internal":{"type":"object","description":"Internal information from Roolz exchange platform to analyze the problem when executing a request","required":["roolz_debug_id"],"properties":{"roolz_debug_id":{"type":"string"}}}}}}},"paths":{"/system/geo-search":{"get":{"tags":["system"],"operationId":"geoSearch","summary":"Geo objects search","parameters":[{"$ref":"#/components/parameters/ContentTypeHeader"},{"$ref":"#/components/parameters/AcceptEncodingHeader"},{"name":"q","in":"query","required":true,"description":"Search bar. Search by name and coordinates is allowed","schema":{"type":"string","minimum":3,"maximum":100}}],"responses":{"200":{"description":"Successful execution of the request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GeoFeature"}}}}},"400":{"description":"Error in input data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorObject"}}}},"401":{"description":"Request not authorized. API key may be missing."},"403":{"description":"This operation is not permitted."}}}}}}
```

## The ErrorObject object

```json
{"openapi":"3.0.1","info":{"title":"Roolz Public API","version":"1.1"},"components":{"schemas":{"ErrorObject":{"required":["state","message","internal"],"properties":{"state":{"type":"string","description":"Request execution status","enum":["error"]},"message":{"type":"string","description":"Additional information"},"validations":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"path":{"type":"string"},"reason":{"type":"string"}}}},"internal":{"type":"object","description":"Internal information from Roolz exchange platform to analyze the problem when executing a request","required":["roolz_debug_id"],"properties":{"roolz_debug_id":{"type":"string"}}}}}}}}
```

## The GeoFeature object

```json
{"openapi":"3.0.1","info":{"title":"Roolz Public API","version":"1.1"},"components":{"schemas":{"GeoFeature":{"properties":{"type":{"type":"string"},"center":{"type":"object","properties":{"lat":{"type":"number"},"lon":{"type":"number"}}},"properties":{"type":"object","properties":{"location_id":{"type":"integer"},"location_type":{"type":"string"},"location_attribute_key":{"type":"string"},"location_attribute_value":{"type":"string"},"name":{"type":"string"},"state":{"type":"string"},"country":{"type":"string"},"country_code":{"type":"string"},"county":{"type":"string","nullable":true},"postcode":{"type":"string","nullable":true}}}}}}}}
```


# Field values

### Company field values

{% content-ref url="/pages/MeM1MM2mK5TFQWomMmgH" %}
[Role in logistics | exchange\_role](/en/open-api/field-values/company/role-in-logistics-or-exchange_role)
{% endcontent-ref %}

{% content-ref url="/pages/X78RidHwKgdHm6lAt0uX" %}
[Number of shipments per month | order\_amount](/en/open-api/field-values/company/number-of-shipments-per-month-or-order_amount)
{% endcontent-ref %}

{% content-ref url="/pages/e6IlaiP16LdDPlkjUftK" %}
[Types of cargo and packaging | cargo\_type](/en/open-api/field-values/company/types-of-cargo-and-packaging-or-cargo_type)
{% endcontent-ref %}

{% content-ref url="/pages/gycjLg86HK16czb5Xi04" %}
[Company types | company\_form](/en/open-api/field-values/company/company-types-or-company_form)
{% endcontent-ref %}

{% content-ref url="/pages/4e2jzr3csl9w9zpcfOcz" %}
[Customs services | customs\_service](/en/open-api/field-values/company/customs-services-or-customs_service)
{% endcontent-ref %}

{% content-ref url="/pages/KtaNdlNmPmlJE8NSGILA" %}
[Number of employees | employee\_amount](/en/open-api/field-values/company/number-of-employees-or-employee_amount)
{% endcontent-ref %}

{% content-ref url="/pages/0k5EQ1PdkbGiCQOJC2wZ" %}
[Fleet size | fleet\_amount](/en/open-api/field-values/company/fleet-size-or-fleet_amount)
{% endcontent-ref %}

{% content-ref url="/pages/3H87pcCZDb9X5GfAAok9" %}
[Logistics services | logistics\_service](/en/open-api/field-values/company/logistics-services-or-logistics_service)
{% endcontent-ref %}

{% content-ref url="/pages/qAsvnuJ9IHLNRZ3qkWMp" %}
[Types of transportation | transportation\_type](/en/open-api/field-values/company/types-of-transportation-or-transportation_type)
{% endcontent-ref %}

{% content-ref url="/pages/BjjWeiLMyxs3VUjbslS1" %}
[Associations | associations](/en/open-api/field-values/company/associations-or-associations)
{% endcontent-ref %}

### Offers field values

{% content-ref url="/pages/edOuINLUZQRwkK50YYAf" %}
[Types of cargo and packaging | cargo\_types](/en/open-api/field-values/offers/types-of-cargo-and-packaging-or-cargo_types)
{% endcontent-ref %}

{% content-ref url="/pages/Jl82N70UTR3rX4zTsN8r" %}
[Shipping modes | shipping\_modes](/en/open-api/field-values/offers/shipping-modes-or-shipping_modes)
{% endcontent-ref %}

{% content-ref url="/pages/pwyFMzD8S2LvQAPbm685" %}
[Vehicle categories | transport\_types](/en/open-api/field-values/offers/vehicle-categories-or-transport_types)
{% endcontent-ref %}

{% content-ref url="/pages/LKmgUKvYYpr2pQTcBAbm" %}
[Truck body types | truck\_bodies](/en/open-api/field-values/offers/truck-body-types-or-truck_bodies)
{% endcontent-ref %}

{% content-ref url="/pages/dCAMrBFPUfmH0XOQkK2D" %}
[Options and truck body features | extra\_equipment](/en/open-api/field-values/offers/options-and-truck-body-features-or-extra_equipment)
{% endcontent-ref %}

{% content-ref url="/pages/uVf9SRhN5STjlN2XbemA" %}
[Loading/unloading methods | loading\_types](/en/open-api/field-values/offers/loading-unloading-methods-or-loading_types)
{% endcontent-ref %}

{% content-ref url="/pages/t1XGEo1BwTiGQ6nlmGnh" %}
[Waypoint types | point\_types](/en/open-api/field-values/offers/waypoint-types-or-point_types)
{% endcontent-ref %}

{% content-ref url="/pages/qQN4YxvUjdvvb23hASs4" %}
[Payment terms | payment\_cond](/en/open-api/field-values/offers/payment-terms-or-payment_cond)
{% endcontent-ref %}

{% content-ref url="/pages/uxMaMtVdAc7PySVth2gL" %}
[Payment methods | payment\_methods](/en/open-api/field-values/offers/payment-methods-or-payment_methods)
{% endcontent-ref %}

{% content-ref url="/pages/Z9qoQU50QujvD6pJAXrT" %}
[Reasons for removing offer from publication | publ\_autocancel\_reasons](/en/open-api/field-values/offers/reasons-for-removing-offer-from-publication-or-publ_autocancel_reasons)
{% endcontent-ref %}


# Company


# Role in logistics | exchange\_role

<table><thead><tr><th>Value</th><th width="165.50390625">Display</th><th width="397.1171875">Additional info</th></tr></thead><tbody><tr><td><code>shipper</code></td><td>Shipper</td><td>Fleet size field (<code>fleet_amount</code>) and customs services field (<code>customs_service</code>) are not available for filling. </td></tr><tr><td><code>carrier</code></td><td>Carrier</td><td>Customs services field (<code>customs_service</code>) is not available for filling.</td></tr><tr><td><code>forwarder</code></td><td>Freight forwarder</td><td>Fleet size field (<code>fleet_amount</code>) and customs services field (<code>customs_service</code>) are not available for filling.</td></tr><tr><td><code>forwarder_carrier</code></td><td>Freight forwarder-carrier</td><td>Customs services field (<code>customs_service</code>) is not available for filling.</td></tr><tr><td><code>dispatcher</code></td><td>Dispatcher</td><td>All fields are available for filling.</td></tr><tr><td><code>freight_broker</code></td><td>Freight broker</td><td>Fleet size field (<code>fleet_amount</code>) and customs services field (<code>customs_service</code>) are not available for filling. </td></tr><tr><td><code>customs_agent</code></td><td>Customs broker</td><td>Only customs services field (<code>customs_service</code>) is available for filling. </td></tr><tr><td><code>storage_provider</code></td><td>Warehouse provider</td><td>None of the fields are available for filling (<code>fleet_amount</code>,  <code>international_direction</code>, <code>national_direction</code> ,  <code>transportation_type</code>, <code>cargo_type</code>, <code>customs_service</code>)</td></tr><tr><td><code>shipper_carrier</code></td><td>Shipper-carrier</td><td>Customs services field (<code>customs_service</code>) is not available for filling.</td></tr><tr><td><code>other</code></td><td>Other role</td><td>None of the fields are available for filling (<code>fleet_amount</code>,  <code>international_direction</code>, <code>national_direction</code> ,  <code>transportation_type</code>, <code>cargo_type</code>, <code>customs_service</code>)</td></tr></tbody></table>


# Number of shipments per month | order\_amount

The field is available to all roles in logistics.

| Value              | Display         | Description                               |
| ------------------ | --------------- | ----------------------------------------- |
| `0`&#xD;           | 0               | There are no regular shipments            |
| `1_30`&#xD;        | 1 - 30          | Up to 30 shipments per month              |
| `31_100`&#xD;      | 31 - 100        | From 31 to 100 shipments per month        |
| `101_500`&#xD;     | 101 - 500       | From 101 to 500 shipments per month       |
| `501_2000`&#xD;    | 501 - 2 000     | From 501 to 2 000 shipments per month     |
| `2001_10000`&#xD;  | 2 001 - 10 000  | From 2 001 to 10 000 shipments per month  |
| &#xD;`10001_50000` | 10 001 - 50 000 | From 10 001 to 50 000 shipments per month |
| `50000_more`       | 50 000+         | More than 50 000 shipments per month      |


# Types of cargo and packaging | cargo\_type

Types of cargo a company typically handles. The selected values ​​are displayed in the "Logistics services" section.

| Value              | Display                                    |
| ------------------ | ------------------------------------------ |
| `general`&#xD;     | General cargo                              |
| `groupage`         | Groupage cargo                             |
| `cep`              | Courier, Express and Parcel services (CEP) |
| &#xD;`last_mile`   | Last-mile delivery                         |
| `adr`              | Dangerous cargo (ADR)                      |
| &#xD;`oversize`    | Oversize cargo                             |
| `project`&#xD;     | Project transportation                     |
| `temperature`&#xD; | Temperature cargo                          |
| `perishable`&#xD;  | Perishable goods                           |
| `bulk`&#xD;        | Dry bulk cargo                             |
| `liquid`&#xD;      | Liquid cargo                               |
| `container`&#xD;   | Container transportation                   |
| `passenger`&#xD;   | Passenger transportation                   |
| `animals`&#xD;     | Livestock                                  |
| `other_special`    | Other types of cargo and transportation    |


# Company types | company\_form

| Value               | Display                                |
| ------------------- | -------------------------------------- |
| `private_company`   | Private company                        |
| `self_employed`     | Individual entrepreneur, self-employed |
| `partnership`       | Partnership                            |
| `public_company`    | Publicly-traded company                |
| `government_agency` | Governmental organization              |
| `non_profit`        | Non-profit organization                |


# Customs services | customs\_service

Displayed only for the *Customs agent* role  (`customs_agent`) in the "Logistics services" section.

| Value                     | Display                             |
| ------------------------- | ----------------------------------- |
| `declaration`             | Goods declaration                   |
| `statistical_declaration` | Statistical declaration             |
| `document_handling`       | Document preparation and management |
| `representation`          | Customs brokerage                   |
| `consulting`              | Consulting                          |
| `customs_guarantee`       | Customs guarantee                   |
| `temporary_storage`       | Bonded warehouse                    |


# Number of employees | employee\_amount

| Value       | Display       |
| ----------- | ------------- |
| `1_15`      | 1 - 15        |
| `16_50`     | 16 -  50      |
| `51_150`    | 51 - 150      |
| `151_500`   | 151 - 500     |
| `501_1500`  | 501 - 1 500   |
| `1501_5000` | 1 501 - 5 000 |
| `5000_more` | 5 000+        |


# Fleet size | fleet\_amount

Displayed for companies with the Carrier (`carrier`), Forwarder-carrier (`forwarder_carrier`), Dispatcher ( `dispatcher`) and Shipper-carrier ( `shipper_carrier`) roles.

| Value       | Display     |
| ----------- | ----------- |
| `1_5`       | 1 - 5       |
| `6_15`      | 6 - 15      |
| `16_50`     | 16 - 50     |
| `51_100`    | 51 - 100    |
| `101_500`   | 101 - 500   |
| `501_1000`  | 501 - 1 000 |
| `1000_more` | 1 000+      |


# Logistics services | logistics\_service

The selected values ​​are displayed in the "Logistics services" section.

| Value                 | Display                      |
| --------------------- | ---------------------------- |
| `transportation`      | Transportation               |
| `forwarding`          | Freight forwarding           |
| `dispatching`         | Dispatching                  |
| `freight_brokerage`   | Freight broker               |
| `inventory_mngmt`     | Inventory management         |
| `order_mngmt`         | Order management             |
| `responsible_storage` | Safekeeping                  |
| `storage_rent`        | Warehouse and storage rental |
| `transport_rent`      | Transport rental             |
| `cargo_consolidation` | Cargo consolidation          |
| `cross_docking`       | Cross-docking                |
| `loader_work`         | Loading operations (loaders) |
| `cargo_insurance`     | Cargo insurance              |
| `transport_insurance` | Transport insurance          |
| `return_mngmt`        | Returns management           |


# Types of transportation | transportation\_type

Displayed for companies with the following roles: Shipper (`shipper`), Carrier (`carrier`), Freight forwarder (`forwarder`), Forwarder-carrier (`forwarder_carrier`), Dispatcher ( `dispatcher`), Freight broker (`freight_broker`) and Shipper-carrier ( `shipper_carrier`)  in the "Logistics services" section.

| Value        | Display                           |
| ------------ | --------------------------------- |
| `road`       | Road cargo transportation         |
| `ocean`      | Maritime and river transportation |
| `air`        | Air cargo transportation          |
| `railway`    | Railway transportation            |
| `multimodal` | Multimodal cargo transportation   |


# Associations | associations

Associations that the company is a member of.

<table data-full-width="true"><thead><tr><th width="206.3636474609375">Value</th><th width="103.54541015625">Countries</th><th>Display</th></tr></thead><tbody><tr><td><code>us_tia</code></td><td>US</td><td>TIA – Transportation Intermediaries Association</td></tr><tr><td><code>us_ooida</code></td><td>US</td><td>OOIDA – Owner-Operator Independent Drivers Association</td></tr><tr><td><code>us_ata</code></td><td>US</td><td>ATA – American Trucking Statuses, Inc</td></tr><tr><td><code>tw_iofflat</code></td><td>TW</td><td>IOFFLAT – Chinese Taipei International Ocean Freight Forwarders &#x26; Logistics Association, Taiwan</td></tr><tr><td><code>cn_crta</code></td><td>CN</td><td>CRTA – China Road Transport Association</td></tr><tr><td><code>cn_cifa</code></td><td>CN</td><td>CIFA – China International Freightforwarders Association</td></tr><tr><td><code>tw_tafla</code></td><td>TW</td><td>TAFLA – Chinese Taipei Taipei Airfreight Forwarders &#x26; Logistics Association Of Taiwan</td></tr><tr><td><code>tw_tfla</code></td><td>TW</td><td>TFLA – Chinese Taipei Taiwan Freight Logistics Association</td></tr><tr><td><code>jp_jiffa</code></td><td>JP</td><td>JIFFA – 一般社団法人 国際フレイトフォワーダーズ協会（JIFFA）</td></tr><tr><td><code>jp_jafa</code></td><td>JP</td><td>JAFA – Japan Aircargo Forwarders Association</td></tr><tr><td><code>jp_jfff</code></td><td>JP</td><td>JFFF – Japan Freight Forwarders Federation</td></tr><tr><td><code>mx_amacarga</code></td><td>MX</td><td>AMACARGA – Asociacion Mexicana De Agentes Decarga, A.C.</td></tr><tr><td><code>id_ilfa</code></td><td>ID</td><td>ALFI/ILFA – Asosiasi Logistik Dan Forwarder Indonesia</td></tr><tr><td><code>th_tiffa</code></td><td>TH</td><td>TIFFA – Thai International Freight Forwarders Association</td></tr><tr><td><code>br_actc</code></td><td>BR</td><td>ACTC – Associacao Nacional Das Empresas Transitarias Decarga Aerea, Comissarias De Despachos E Operadores Intermodais</td></tr><tr><td><code>ru_asmap</code></td><td>RU</td><td>АСМАП – Ассоциация международных автомобильных перевозчиков</td></tr><tr><td><code>ru_far</code></td><td>RU</td><td>Российская ассоциация экспедиторских и логистических организаций</td></tr><tr><td><code>fr_aftri</code></td><td>FR</td><td>AFTRI – Association Française du Transport Routier International</td></tr><tr><td><code>fr_tlf</code></td><td>FR</td><td>TLF – Union Des Entreprises De Transport Et Logistique Defrance</td></tr><tr><td><code>in_ficci</code></td><td>IN</td><td>FICCI – Federation of Indian Chambers of Commerce and Industry</td></tr><tr><td><code>in_acaai</code></td><td>IN</td><td>ACAAI – The Air Cargo Agents Association Of India</td></tr><tr><td><code>in_fffai</code></td><td>IN</td><td>FFFAI – Federation Of Freight Forwarders’ Statuses In India</td></tr><tr><td><code>es_astic</code></td><td>ES</td><td>ASTIC – Asociación del Transporte Internacional por Carretera</td></tr><tr><td><code>es_feteia</code></td><td>ES</td><td>FETEIA – Federacion Espanola De Transitarios, Expedidoresinternacionales Y Asimilados</td></tr><tr><td><code>it_uicciaa</code></td><td>IT</td><td>UICCIAA – Unione Italiana delle Camere di Commercio, Industria, Artigianato e Agricoltura </td></tr><tr><td><code>it_fedespedi</code></td><td>IT</td><td>FEDESPEDI – Federazione Nazionale delle Imprese di Spedizioni Internazionali</td></tr><tr><td><code>tr_tobb</code></td><td>TR</td><td>TOBB – Türkiye Odalar ve Borsalar Birliği</td></tr><tr><td><code>tr_und</code></td><td>TR</td><td>U.N.D. – Uluslararası Nakliyeciler Derneği</td></tr><tr><td><code>tr_utikad</code></td><td>TR</td><td>UTIKAD – Uluslararasi Tasimacilik Ve Lojistik Hizmeturetenleri Dernegi</td></tr><tr><td><code>gb_logistics_uk</code></td><td>GB</td><td>Logistics UK</td></tr><tr><td><code>gb_bifa</code></td><td>GB</td><td>BIFA – British International Freight Association</td></tr><tr><td><code>gb_rha</code></td><td>GB</td><td>RHA – Road Haulage Association Ltd</td></tr><tr><td><code>kr_kiffa</code></td><td>KR</td><td>KIFFA – 한국국제물류협회 </td></tr><tr><td><code>au_afif</code></td><td>AU</td><td>AFIF – Australian Federation Of International Forwarders</td></tr><tr><td><code>au_cbfca</code></td><td>AU</td><td>CBFCA – Customs Brokers Forwarders Council Of Australia Limited</td></tr><tr><td><code>pl_zmpd</code></td><td>PL</td><td>ZMPD – Zrzeszenie Miedzynarodowych Przewozników Drogowych w Polsce</td></tr><tr><td><code>pl_piffa</code></td><td>PL</td><td>PISiL – Polska Izba Spedycji i Logistyki</td></tr><tr><td><code>de_bgl</code></td><td>DE</td><td>BGL – Bundesverband Güterkraftverkehr Logistik und Entsorgung</td></tr><tr><td><code>de_dslv</code></td><td>DE</td><td>DSLV – Bundesverband Spedition Und Logistik E.V.</td></tr><tr><td><code>de_aist</code></td><td>DE</td><td>AIST – Arbeitsgemeinschaft zur Förderung und Entwicklung des Internationalen Strassenverkehrs</td></tr><tr><td><code>ar_aaaci</code></td><td>AR</td><td>AAACI – Asociacion Argentina De Agentes De Cargainternacional</td></tr><tr><td><code>za_saaff</code></td><td>ZA</td><td>SAAFF – The South African Association Of Freight Forwarders </td></tr><tr><td><code>sy_snc_icc</code></td><td>SY</td><td>ICC-Syria – غرفة التجارة الدولية سورية</td></tr><tr><td><code>sy_siffa</code></td><td>SY</td><td>SIFFA</td></tr><tr><td><code>co_fitac</code></td><td>CO</td><td>FITAC – Federación Colombiana De Agentes Logisticos Encomercio Internacional</td></tr><tr><td><code>sa_sata</code></td><td>SA</td><td>SATA ساتا – النادي السعودي للسيارات والسياحة</td></tr><tr><td><code>sa_nlc</code></td><td>SA</td><td>NLC – اللجنة الوطنية اللوجستية</td></tr><tr><td><code>ua_asmap_ua</code></td><td>UA</td><td>АсМАП України – Асоціація міжнародних автомобільних перевізників України</td></tr><tr><td><code>ua_aiffu</code></td><td>UA</td><td>АМЕУ – Асоціація міжнародних експедиторів України  </td></tr><tr><td><code>ua_ukrzovnishtrans</code></td><td>UA</td><td>Укрзовніштранс – Асоціація «Транспортні, Експедиторські Та Логістичні Організації В Україні «Укрзовніштранс»</td></tr><tr><td><code>ir_iccima</code></td><td>IR</td><td>ICCIMA – Iran Chamber of Commerce, Industries, Mines &#x26; Agriculture</td></tr><tr><td><code>ir_itca</code></td><td>IR</td><td>ITCA – International Transport Companies Association Of Iran</td></tr><tr><td><code>eg_eiffa</code></td><td>EG</td><td>EIFFA – شعبة خدمات النقل الدولى واللوجيستيات</td></tr><tr><td><code>cl_alog_chile</code></td><td>CL</td><td>ALOG CHILE – Asociación Logistica De Chile A.G.</td></tr><tr><td><code>ec_aseaci</code></td><td>EC</td><td>ASEACI – Asociación Ecuatoriana De Agencias De Carga Y Logistica Internacional</td></tr><tr><td><code>pt_antram</code></td><td>PT</td><td>ANTRAM – Associação Nacional de Transportadores Públicos Rodoviários de Mercadorias</td></tr><tr><td><code>pt_apat</code></td><td>PT</td><td>APAT – Associacao Dos Transitarios De Portugal</td></tr><tr><td><code>my_fmff</code></td><td>MY</td><td>FMFF – Federation Of Malaysian Freight Forwarders</td></tr><tr><td><code>gt_agac</code></td><td>GT</td><td>AGAC – Asociación Guatemalteca De Agencias De Carga</td></tr><tr><td><code>ca_ciffa</code></td><td>CA</td><td>CIFFA – Canadian International Freightforwarders Association, Inc.</td></tr><tr><td><code>gr_ofae</code></td><td>GR</td><td>Ο.Φ.Α.Ε. – Ομοσπονδία Φορτηγών Αυτοκινητιστών Ελλάδας</td></tr><tr><td><code>gr_iffag_l</code></td><td>GR</td><td>ΣΥΝΔΔΕ&#x26;L – Σύνδεσμος Επιχειρήσεων Διεθνούς Διαμεταφοράς και Επιχειρήσεων Logistics Ελλάδος</td></tr><tr><td><code>nl_fenex</code></td><td>NL</td><td>FENEX – De Nederlandse organisatie voor expeditie en logistiek</td></tr><tr><td><code>ma_amtri</code></td><td>MA</td><td>AMTRI – Association Marocaine des Transports Routiers Internationaux</td></tr><tr><td><code>ma_affm</code></td><td>MA</td><td>AFFM – Association Des Freightforwarders Du Maroc</td></tr><tr><td><code>ro_untrr</code></td><td>RO</td><td>UNTRR – Uniunea Naţională a Transportatorilor Rutieri din România</td></tr><tr><td><code>ro_user</code></td><td>RO</td><td>USER – Uniunea Societăților de Expediții din România</td></tr><tr><td><code>be_febetra</code></td><td>BE</td><td>FEBETRA – Fédération Royale Belge des Transporteurs et des Prestataires de Services Logistiques</td></tr><tr><td><code>be_forward_belgium</code></td><td>BE</td><td>Forward Belgium</td></tr><tr><td><code>do_adacam</code></td><td>DO</td><td>ADACAM – Asociación Dominicana De Agentes De Carga Aerea Y Maritima</td></tr><tr><td><code>lk_slffa</code></td><td>LK</td><td>SLFFA – Sri Lanka Logistics &#x26; Freightforwarders Association</td></tr><tr><td><code>cz_cesmad_bohemia</code></td><td>CZ</td><td>CESMAD Bohemia – Sdružení automobilových dopravců ČESMAD BOHEMIA, z.s.</td></tr><tr><td><code>cz_ssl</code></td><td>CZ</td><td>SSL – Czech Republic Association Of Forwarding And Logistics Of The Czech Republic</td></tr><tr><td><code>nz_cbaff</code></td><td>NZ</td><td>CBAFF – Customs Brokers &#x26; Freight Forwarders Fed. Of New Zealand Inc.</td></tr><tr><td><code>se_sa</code></td><td>SE</td><td>SA – Sveriges Akeriföretag</td></tr><tr><td><code>se_sifa</code></td><td>SE</td><td>Transportföretagen</td></tr><tr><td><code>no_nlf</code></td><td>NO</td><td>NLF – Norges Lastebileier-Forbund</td></tr><tr><td><code>no_nho_lt</code></td><td>NO</td><td>NHO LT – NHO Logistikk og Transport</td></tr><tr><td><code>kz_kazato</code></td><td>KZ</td><td>КазАТО – Союз международных автомобильных перевозчиков Республики Казахстан</td></tr><tr><td><code>kz_kffa</code></td><td>KZ</td><td>АНЭК – Ассоциация Национальных Экспедиторов Республики Казахстан</td></tr><tr><td><code>ke_kifwa</code></td><td>KE</td><td>KIFWA – Kenya International Freight And Warehousing Association</td></tr><tr><td><code>hu_mkfe</code></td><td>HU</td><td>MKFE – Magyar közúti fuvarozók Egyesülete</td></tr><tr><td><code>hu_ahf</code></td><td>HU</td><td>Magyar Szallitmanyozok Szovetsege</td></tr><tr><td><code>pk_pnc_icc</code></td><td>PK</td><td>PNC-ICC – Pakistan National Committee of the International Chamber of Commerce</td></tr><tr><td><code>pk_piffa</code></td><td>PK</td><td>PIFFA – Pakistan International Freightforwarders Association</td></tr><tr><td><code>bg_aebtri</code></td><td>BG</td><td>АЕБТРИ – Асоциацията на българските предприятия за международни превози и пътищата</td></tr><tr><td><code>bg_nsbs</code></td><td>BG</td><td>НСБС – Националното сдружение на българските спедитори</td></tr><tr><td><code>by_bamap</code></td><td>BY</td><td>БАМАП – Ассоциация международных автомобильных перевозчиков «БАМАП»</td></tr><tr><td><code>by_baif</code></td><td>BY</td><td>БАМЭ – Ассоциация международных экспедиторов и логистики «БАМЭ» </td></tr><tr><td><code>ph_pmtlai</code></td><td>PH</td><td>PMTLAI – Philippines Multimodal Transport And Logisticsassociation, Inc.</td></tr><tr><td><code>tn_ccit</code></td><td>TN</td><td>CCIT – Chambre de Commerce et d’Industrie de Tunis</td></tr><tr><td><code>at_zv</code></td><td>AT</td><td>ZV – Zentralverband Spedition &#x26; Logistik</td></tr><tr><td><code>at_aiso</code></td><td>AT</td><td>AISÖ – Arbeitsgemeinschaft Internationaler Strassenverkehrsunternehmer Österreichs </td></tr><tr><td><code>kg_airto_kr</code></td><td>KG</td><td>АМАП КР – Ассоциация международных автомобильных перевозчиков Кыргызской Республики</td></tr><tr><td><code>dk_dsf</code></td><td>DK</td><td>DSF – Danske Speditører</td></tr><tr><td><code>dk_dtl</code></td><td>DK</td><td>DTL – Danish Transport and Logistics Association</td></tr><tr><td><code>ch_spedlogswiss</code></td><td>CH</td><td>Spedlogswiss</td></tr><tr><td><code>ch_astag</code></td><td>CH</td><td>ASTAG – Association Suisse des Transports Routiers</td></tr><tr><td><code>af_acci</code></td><td>AF</td><td>ACCI – اتاق تجارت و صنایع افغنستان</td></tr><tr><td><code>ni_anac</code></td><td>NI</td><td>ANAC – Asociacion Nicaraguense De Agencias De Carga</td></tr><tr><td><code>il_irtb</code></td><td>IL</td><td>IRTB – מועצת המובילים והתאחדות בעלי מפעלי הובלה בישראל</td></tr><tr><td><code>il_iffcca</code></td><td>IL</td><td>IFFCCA – The Israeli Federation Of Forwarders And Customsclearing Agents</td></tr><tr><td><code>sk_cesmad_slovakia</code></td><td>SK</td><td>CESMAD Slovakia – Association des Transporteurs Internationaux Slovaques </td></tr><tr><td><kbd><code>sk_zlz_sr</code></kbd></td><td>SK</td><td>ZLZ SR – Zväz logistiky a zasielateľstva SR</td></tr><tr><td><code>ug_uffa</code></td><td>UG</td><td>UFFA – Uganda Freight Forwarders’ Association</td></tr><tr><td><code>ie_irha</code></td><td>IE</td><td>IRHA – Irish Road Haulage Association</td></tr><tr><td><code>ie_iifa</code></td><td>IE</td><td>IIFA – Irish International Freight Association</td></tr><tr><td><code>gh_giff</code></td><td>GH</td><td>GIFF – Ghana Institute Of Freight Forwarders</td></tr><tr><td><code>qa_qcci</code></td><td>QA</td><td>QCCI – Qatar Chamber of Commerce and Industry</td></tr><tr><td><code>kw_kiac</code></td><td>KW</td><td>KIAC – Kuwait International Automobile Club</td></tr><tr><td><code>py_atolpar</code></td><td>PY</td><td>ATOLPAR – Asociación De Transitarios Del Paraguay Y Operadores Logisticos</td></tr><tr><td><code>bd_baffa</code></td><td>BD</td><td>BAFFA – Bangladesh Freight Forwarders Association</td></tr><tr><td><code>cr_acacia</code></td><td>CR</td><td>ACACIA – Asociación Costarricense De Agencias De Carga Y logistica Internacional</td></tr><tr><td><code>om_sinyar</code></td><td>OM</td><td>Sinyar  – سنيار</td></tr><tr><td><code>rs_ccis_at</code></td><td>RS</td><td>Привредна комора Србије</td></tr><tr><td><code>md_aem_trans</code></td><td>MD</td><td>AEM-TRANS</td></tr><tr><td><code>md_aita</code></td><td>MD</td><td>AITA – Asociaţia Internaţională a Transportatorilor Auto din Moldova</td></tr><tr><td><code>sg_saaa__singapore</code></td><td>SG</td><td>SAAA@Singapore – Singapore Aircargo Agents Association</td></tr><tr><td><code>sg_sla</code></td><td>SG</td><td>SLA – Singapore Logistics Association</td></tr><tr><td><code>az_abada</code></td><td>AZ</td><td>ABADA – Azərbaycan Beynəlxalq Avtomobil Daşıyıcıları Assosiasiyası</td></tr><tr><td><code>vn_vla</code></td><td>VN</td><td>VLA – HIỆP HỘI DOANH NGHIỆP DỊCH VỤ</td></tr><tr><td><code>hr_cce</code></td><td>HR</td><td>CCE – Croatian Chamber of Economy</td></tr><tr><td><code>hr_hgk</code></td><td>HR</td><td>HGK – Hrvatska gospodarska komora</td></tr><tr><td><code>sv_asac</code></td><td>SV</td><td>ASAC – Asociación Salvadorena De Agencias De Carga Yservicios Conexos De Exportacion</td></tr><tr><td><code>ge_girca</code></td><td>GE</td><td>GIRCA – საქართველოს საერთაშორისო საავტომობილო გადამზიდავთა ასოციაცა</td></tr><tr><td><code>ge_afg</code></td><td>GE</td><td>AFG – საქართველოს ექსპედიტორთა ასოციაცია</td></tr><tr><td><code>pa_apac</code></td><td>PA</td><td>APAC – Asociación Panamena De Agencias De Carga</td></tr><tr><td><code>ae_atcuae</code></td><td>AE</td><td>ATCUAE – Automobile and Touring Club of U.A.E</td></tr><tr><td><code>tz_taffa</code></td><td>TZ</td><td>TAFFA – Tanzania Freight Forwarders Association</td></tr><tr><td><code>tz_zfb</code></td><td>TZ</td><td>ZFB – Zanzibar Freight Forwarders Bureau</td></tr><tr><td><code>ae_nafl</code></td><td>AE</td><td>NAFL – National Association Of Freight And Logistics</td></tr><tr><td><code>hk_haffa</code></td><td>HK</td><td>HAFFA – Hong Kong Sarhongkong Association Of Freight Forwarding And Logistics Ltd.</td></tr><tr><td><code>jo_racj</code></td><td>JO</td><td>RACJ – The Royal Automobile Club of Jordan</td></tr><tr><td><code>jo_jla</code></td><td>JO</td><td>JLA – Jordanian Logistics Association</td></tr><tr><td><code>hn_ahaci</code></td><td>HN</td><td>AHACI – Asociación Hondurena De Agencias De Carga Y Logistica Internacional</td></tr><tr><td><code>uy_audaca</code></td><td>UY</td><td>AUDACA – Asociación Uruguaya De Agentes De Carga</td></tr><tr><td><code>zm_zcfaa</code></td><td>ZM</td><td>ZCFAA – Zambia Customs &#x26; Forwarding Agents Association</td></tr><tr><td><code>lb_cciabml</code></td><td>LB</td><td>CCIABML – غرفة التجارة و الصناعة والزراعة في بيروت وجبل لبنان.</td></tr><tr><td><code>lb_lfs</code></td><td>LB</td><td>LFS – Lebanese Forwarders Syndicate</td></tr><tr><td><code>zw_sfaaz</code></td><td>ZW</td><td>SFAAZ – The Shipping And Forwarding Agents Association Of Zimbabwe</td></tr><tr><td><code>lt_linava</code></td><td>LT</td><td>LINAVA – Lietuvos nacionalinė vežėjų automobiliais asociacija</td></tr><tr><td><code>lt_lineka</code></td><td>LT</td><td>LINEKA – Lietuvos nacionalinės ekspeditorių ir logistų asociacijos</td></tr><tr><td><code>ee_eraa</code></td><td>EE</td><td>ERAA – Eesti Rahvusvaheliste Autovedajate Assotsiatsioon</td></tr><tr><td><code>ee_elfa</code></td><td>EE</td><td>ELEA – Eesti Logistika ja Ekspedeerimise Assotsiatsioon</td></tr><tr><td><code>cy_tda</code></td><td>CY</td><td>TDA – Transport Development Association</td></tr><tr><td><code>cy_ccfaa</code></td><td>CY</td><td>CCFAA – Cyprus Clearing And Forwarding Agents Association</td></tr><tr><td><code>si_giz_itt</code></td><td>SI</td><td>ITT – GIZ Intertransport</td></tr><tr><td><code>si_ccis</code></td><td>SI</td><td>GZS – Gospodarska zbornica Slovenije</td></tr><tr><td><code>fi_skal</code></td><td>FI</td><td>SKAL – Suomen Kuljetus ja Logistiikka</td></tr><tr><td><code>fi_shll</code></td><td>FI</td><td>SHLL – Suomen Huolinta- ja Logistiikkaliitto ry</td></tr><tr><td><code>lv_latvijas_auto</code></td><td>LV</td><td>Latvijas Auto</td></tr><tr><td><code>lv_laff</code></td><td>LV</td><td>LAFF – Latvijas nacionala kravas ekspeditoru un logistikas asociacija</td></tr><tr><td><code>cm_synautratra</code></td><td>CM</td><td>SYNAUTRATRA – Syndicat National Des Auxiliaires De Transports Et Detransit</td></tr><tr><td><code>ba_airh</code></td><td>BA</td><td>AIRH – Udruženje međunarodnih cestovnih prijevoznika tereta </td></tr><tr><td><code>ba_vtk_stk_bih</code></td><td>BA</td><td>VTK /STK BiH – Vanjskotrgovinska/Spoljnotrgovinska komora Bosne i Hercegovine</td></tr><tr><td><code>al_analtir</code></td><td>AL</td><td>ANALTIR – Shoqata Kombëtare Shqiptare e Transportuesve Ndërkombëtarë Rrugorë</td></tr><tr><td><code>et_effsaa</code></td><td>ET</td><td>EFFSAA – Ethiopian Freight Forwarders And Shipping Agents Association</td></tr><tr><td><code>mt_atto</code></td><td>MT</td><td>ATTO – Association of Tractor and Trailer Operators/Owners</td></tr><tr><td><code>mt_malta_chamber</code></td><td>MT</td><td>Malta Chamber – The Malta Chamber Of Commerce, Enterprise Andindustry</td></tr><tr><td><code>mu_apt</code></td><td>MU</td><td>APT – Association Professionnelle Des Transitaires Etassimiles</td></tr><tr><td><code>mk_amerit</code></td><td>MK</td><td>АМЕРИТ – СИЗ Македонија сообраќај </td></tr><tr><td><code>bn_brufa</code></td><td>BN</td><td>BRUFA – Brunei Freight Forwarders Association</td></tr><tr><td><code>uz_aircuz</code></td><td>UZ</td><td>Ассоциация международных автомобильных перевозчиков Узбекистана</td></tr><tr><td><code>kh_camffa</code></td><td>KH</td><td>CAMFFA – Cambodian Freight Forwarders Association</td></tr><tr><td><code>am_airca</code></td><td>AM</td><td>AIRCA – Հայաստանի միջազգային փոխադրողների ասոցիացիա</td></tr><tr><td><code>am_aaff</code></td><td>AM</td><td>AAFF – Association Of Armenian Freight Forwarders</td></tr><tr><td><code>mn_nartam</code></td><td>MN</td><td>NARTAM – Монголын Авто Тээвэрчдийн Нэгдсэн Холбоо</td></tr><tr><td><code>dj_atd</code></td><td>DJ</td><td>ATD – Association Des Transitaires De Djibouti</td></tr><tr><td><code>tj_abbat</code></td><td>TJ</td><td>ABBAT – Ассосиатсияи Боркашонҳои Байналмилалии Автомобилии Ҷумҳурии  Тоқикистон</td></tr><tr><td><code>mm_miffa</code></td><td>MM</td><td>MIFFA – Myanmar International Freight Forwarders’ Association</td></tr><tr><td><code>tm_thada</code></td><td>TM</td><td>THADA – Туркменская ассоциация международных автомобильных перевозчиков</td></tr><tr><td><code>uz_uifa</code></td><td>UZ</td><td>UIFA – Uzbek International Forwarders Association</td></tr><tr><td><code>me_pkcg</code></td><td>ME</td><td>PKCG – Privredna komora Crne Gore</td></tr><tr><td><code>mn_fmff</code></td><td>MN</td><td>Монголын Тээвэр Зуучлагчдын Нэгдсэн Холбоо</td></tr><tr><td><code>by_aipl</code></td><td>BY</td><td>АИПЛ — Ассоциация интермодальных перевозок и логистики</td></tr></tbody></table>


# Offers


# Types of cargo and packaging | cargo\_types

<table><thead><tr><th width="188">Value</th><th width="283">Display</th><th>Additional details</th></tr></thead><tbody><tr><td><code>liquid_bulk</code></td><td>Liquid cargo</td><td></td></tr><tr><td><code>break_bulk</code></td><td>Break bulk</td><td></td></tr><tr><td><code>dry_bulk</code></td><td>Dry bulk</td><td></td></tr><tr><td><code>groupage</code></td><td>Groupage / Different cargo</td><td></td></tr><tr><td><code>oversized</code></td><td>Oversize cargo</td><td></td></tr><tr><td><code>container</code></td><td>Container cargo</td><td>Allows to enter the number of cargo units</td></tr><tr><td><code>eur_pallet</code></td><td>EUR-pallets</td><td>Allows to enter the number of cargo units</td></tr><tr><td><code>fin_pallet</code></td><td>FIN-pallets</td><td>Allows to enter the number of cargo units</td></tr><tr><td><code>oth_pallet</code></td><td>Special pallets</td><td>Allows to enter the number of cargo units</td></tr><tr><td><code>bag</code></td><td>Bags</td><td>Allows to enter the number of cargo units</td></tr><tr><td><code>big_bag</code></td><td>Big bags</td><td>Allows to enter the number of cargo units</td></tr><tr><td><code>icb</code></td><td>Eurocubes</td><td>Allows to enter the number of cargo units</td></tr><tr><td><code>carton</code></td><td>Boxes</td><td>Allows to enter the number of cargo units</td></tr><tr><td><code>barrel</code></td><td>Barrels</td><td>Allows to enter the number of cargo units</td></tr><tr><td><code>roll</code></td><td>Rolls</td><td>Allows to enter the number of cargo units</td></tr><tr><td><code>reel</code></td><td>Reels</td><td>Allows to enter the number of cargo units</td></tr><tr><td><code>coil</code></td><td>Coils</td><td>Allows to enter the number of cargo units</td></tr><tr><td><code>crate</code></td><td>Crates</td><td>Allows to enter the number of cargo units</td></tr></tbody></table>


# Shipping modes | shipping\_modes

<table><thead><tr><th width="129">Value</th><th width="213">Display</th><th>Additional details</th></tr></thead><tbody><tr><td><code>any</code></td><td>Any: FTL or LTL</td><td>Entering the number of transport units is not available. Cannot be selected for transport offer.</td></tr><tr><td><code>ftl</code></td><td>FTL (Full Truckload)</td><td>Activates the field for entering the number of transport units for freight offers</td></tr><tr><td><code>ltl</code></td><td>LTL (Less-Than-Truckload)</td><td>Entering the number of transport units is not available.</td></tr><tr><td><code>special</code></td><td>Project, oversize</td><td>Activates the field for entering the number of transport units for freight offers</td></tr></tbody></table>




---

[Next Page](/llms-full.txt/1)