Logibids logo
API docs by Redocly

Logibids (2.0.0)

Download OpenAPI specification:

LOGIBIDS, your all-in-one Transportation, Rental, and Delivery solution from LTS INTERNATIONAL LOGISTICS SERVICES CO WLL.

Our commitment to ideal reliability and safety ensures your goods reach their destination promptly, and our unique auction system guarantees competitive prices.

LOGIBIDS is your gateway to a future where connectivity, efficiency, and savings converge in the world of logistics.

Join us and experience a transportation revolution today!

Authorization

Use the API key obtained from Logibids to generate a JWT access token. Provide this token in the Authorization header for all protected API requests. The system will return the token along with its expiry time.

Authorization Header Format:

Authorization: Bearer <TOKEN>

Important:
The term Bearer in the Authorization header is case-sensitive. Access tokens carry sensitive privileges; ensure they are stored securely.

Login

Authorizations:
bearerAuth
header Parameters
Accept-Language
required
string
Example: en

User preferred language

x-device-type
required
string
Enum: "WEB" "ANDROID" "IOS"

Type of your device

x-portal
required
string
Value: "CLIENT"

Specifies the portal type.

Request Body schema: application/json
required
apiKey
required
string^[a-f0-9]{64}$

Responses

Request samples

Content type
application/json
{
  • "apiKey": "string"
}

Response samples

Content type
application/json
{
  • "statusCode": 200,
  • "message": "Login successfully.",
  • "data": {
    }
}

Cancel Reason

Use this API to retrieve a list of valid reasons for cancelling a delivery.

Delivery Cancel Reason Listing

Retrieve a paginated list of delivery cancel reasons

Authorizations:
bearerAuth
query Parameters
language
string
Example: language=en

Name translations

module_id
string
Example: module_id=DELIVERY

DELIVERY

search
string
from
integer
size
integer
header Parameters
Accept-Language
required
string
Example: en

User preferred language

x-portal
required
string
Value: "CLIENT"

Specifies the portal type.

Responses

Response samples

Content type
application/json
{
  • "statusCode": 200,
  • "message": "string",
  • "status": 1,
  • "data": {
    }
}

Enquiry

Use this API to create and manage delivery enquiries.

Default Details:

  • Weight: 0 to 50 kg
  • Dimensions: 100.00 × 100.00 × 100.00 cm
  • Commodity: Food
  • Immediate Delivery Timing: 30 minutes

Multiple Drop-off Support (Multi-Stop): This system supports enquiries with multiple stops. You can specify one pickup point followed by one or more delivery points.

  • Pickup Point: The first location where the driver collects the items.
  • Delivery Points: One or more locations where the driver drops off the items.
  • Order of Service: The driver will visit each location in the sequential order provided in the list. For example, if you list Drop-off A and then Drop-off B, the driver will go to A first, then B.

Statuses:

  • 'RUNNING': The enquiry is actively seeking drivers and is open for Service Providers (SPs) to accept.
  • 'ACCEPTED': A driver has accepted the enquiry. The client is now required to process payment.
  • 'TIMEOUT': No action was taken by any SP in the allotted time.
  • 'FAILED': The client's payment could not be completed successfully.
  • 'PAID': The payment was successfully processed, and the ride is finalized.
  • 'NOT-STARTED': The client has paid, but the trip has not yet commenced.
  • 'IN-PROCESS': The driver is heading to the pickup location.
  • 'ARRIVED': The driver has arrived at the pickup location.
  • 'STARTED': The trip has officially begun (driver picked up the items).
  • 'CANCELLED': The trip has been cancelled.
  • 'REFUNDED': The trip has been refunded.
  • 'COMPLETED': The first dropoff in a trip has been completed.
  • 'ENDED': The entire trip has concluded successfully.

Enquiry Status

Retrieve detailed information regarding a specific delivery enquiry by its ID

Authorizations:
bearerAuth
path Parameters
id
required
number
Example: 8841
header Parameters
Accept-Language
required
string
Example: en

User preferred language

x-portal
required
string
Value: "CLIENT"

Specifies the portal type.

Responses

Response samples

Content type
application/json
{
  • "statusCode": 200,
  • "message": null,
  • "status": 1,
  • "data": {
    }
}

Cancel Delivery Ride

Use this API to cancel an active delivery ride.

Conditions:

  • You can only cancel an enquiry after payment has been successfully completed (status === ENDED).
  • Cancellations are only permitted before the trip is officially started by the driver (allowed statuses: NOT_STARTED, IN_PROCESS, ARRIVED). Once the trip status is STARTED (driver has picked up the delivery item), cancellations are strictly prohibited.

Cancellation Charges:

  • If the driver is already heading towards the pickup location (trip is IN_PROCESS), cancellation fees will apply.
  • The cancellation charge is dynamically calculated based on the distance and duration the driver has already covered en route to the pickup.
Authorizations:
bearerAuth
path Parameters
enquiry_id
required
number
Example: 8841

The ID of the delivery enquiry

header Parameters
Accept-Language
required
string
Example: en

User preferred language

x-portal
required
string
Value: "CLIENT"

Specifies the portal type.

Request Body schema: application/json
required
reason_id
required
number

Responses

Request samples

Content type
application/json
{
  • "reason_id": 1
}

Response samples

Content type
application/json
{
  • "statusCode": 200,
  • "message": "Ride cancelled successfully",
  • "status": 1
}

Rate

Calculates payment details including commission, taxes, and total.

Authorizations:
bearerAuth
header Parameters
Accept-Language
required
string
Example: en

User preferred language

x-portal
required
string
Value: "CLIENT"

Specifies the portal type.

Request Body schema: application/json
required
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "locations": [
    ]
}

Response samples

Content type
application/json
{
  • "statusCode": 200,
  • "message": null,
  • "data": {
    },
  • "status": 1
}

Create Enquiry

Use this API to submit a new delivery enquiry.

Note: This endpoint supports multiple stops. In the locations list, provide one pickup point first, followed by one or more delivery points. The driver will visit them in the specified order.

Authorizations:
bearerAuth
header Parameters
Accept-Language
required
string
Example: en

User preferred language

x-portal
required
string
Value: "CLIENT"

Specifies the portal type.

Request Body schema: application/json
required
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "locations": [
    ]
}

Response samples

Content type
application/json
{
  • "statusCode": 200,
  • "message": "The enquiry posted succesfully",
  • "data": "8841",
  • "status": 1
}