Logiware Inc.

The is the official documentation for the Logiware Freight API

Logiware

Authentication

User login

User logout

Refresh token

Forgot password

Reset password

User Permissions

User profile

Container Freight Station (CFS)

Search Master BL/House BL

Master B/L (MBL)

House B/L (HBL)

Charges

Invoices

API endpoint to get attachment s3 signed urls

Attachments

Reports

Freight

API for managing vendor bills and related finance operations in the Logiware system.
This specification covers endpoints under `/finances` including bill creation, update, deletion, listing, posting, voiding, and payments.


Finance

Quote

Booking

Parties

Documents

Create Party

Get Party

Update Party

Activate/Deactivate Party

Default

Production

Sandbox

<p class="slate-p " >The is the official documentation for the Logiware API</p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

The is the official documentation for the Logiware API

<p class="slate-p " >The Container Freight Station (CFS) Product allows users to manage the storage and handling of cargo containers within a designated area. Users can track container movements, schedule pickups and deliveries, and monitor inventory levels efficiently through this API.</p><p class="slate-p " ></p><p class="slate-p " ></p>

The Container Freight Station (CFS) Product allows users to manage the storage and handling of cargo containers within a designated area. Users can track container movements, schedule pickups and deliveries, and monitor inventory levels efficiently through this API.

<p class="slate-p " >API for managing vendor bills and related finance operations in the Logiware system.
This specification covers endpoints under <code class="slate-code">/finances</code> including bill creation, update, deletion, listing, posting, voiding, and payments.</p><p class="slate-p " ></p>

API for managing vendor bills and related finance operations in the Logiware system.
This specification covers endpoints under 

 including bill creation, update, deletion, listing, posting, voiding, and payments.

<p class="slate-p " >A freight quote is <span style="background-color:rgb(211, 227, 253);"><strong class="slate-bold">a document provided by a freight carrier or forwarder that estimates the total cost of shipping goods from one location to another</strong></span>. It includes details about the shipment, mode of transportation, and any additional services or surcharges. Essentially, it&apos;s an estimate of the shipping price, helping shippers budget and compare different options. </p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">What it is:</strong> A freight quote is a formal estimate of the shipping cost, outlining the price a carrier will charge for transporting goods. </div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">What it includes:</strong> It typically includes the base shipping rate, any accessorial fees (like special handling or insurance), and potential surcharges (like fuel surcharges).</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Why it&apos;s important:</strong> Freight quotes help shippers understand the total cost of shipping before committing to a particular carrier or method, allowing for better budgeting and comparison of different options. </div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">How it&apos;s used:</strong> Shippers can request multiple quotes from different carriers to compare rates and services and choose the best option for their needs. </div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Factors affecting the price:</strong> The cost of a freight quote is influenced by various factors, including the distance of the shipment, the weight and dimensions of the goods, the type of transportation used, and any special services required. </div></li></ul><p class="slate-p " >
</p><p class="slate-p " ></p>

a document provided by a freight carrier or forwarder that estimates the total cost of shipping goods from one location to another

. It includes details about the shipment, mode of transportation, and any additional services or surcharges. Essentially, it's an estimate of the shipping price, helping shippers budget and compare different options. 

<p class="slate-p " >A freight booking is <span style="background-color:rgb(211, 227, 253);"><strong class="slate-bold">a formal request to reserve space and equipment for shipping goods with a transportation provider</strong></span>.</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Essential Information:</strong> You&apos;ll need to provide details about your shipment, like the type of goods, weight, dimensions, origin, and destination. </div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Carrier Selection:</strong> You&apos;ll also need to choose a carrier (shipping line, airline, trucking company) and potentially a specific vessel or flight. </div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Confirmation:</strong> Once the booking is confirmed, you&apos;ll receive a booking confirmation, securing your space on the chosen transport. </div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Documentation:</strong> Preparing necessary documentation, like bills of lading, is also part of the booking process. </div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Beyond the Basics:</strong> Some bookings may also include details about specific requirements like liftgates, insurance, or customs brokerage. </div></li></ul><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

a formal request to reserve space and equipment for shipping goods with a transportation provider

Create a new booking

ID of the sub-organization associated with the booking

suborganizationId

suborganizationName

Type of shipment (e.g., FCL, LCL, air, etc.)

shipmentType

shipmentDirection

Route and transport details for the booking

route

_status

status

number

tenant

deleted

Main parties involved in the booking (shipper, consignee, etc.)

parties

Additional parties related to the booking

additionalParties

LCL (Less than Container Load) goods details

lcl_goods

fcl_goods

ltl_goods

ftl_goods

uld_goods

palletized_goods

Currency code for the booking (e.g., USD)

baseCurrency

shipmentOptions

rates

charges

invoices

costs

bills

createdBy

List of user IDs who modified the booking

usersModified

activatedBy

Date and time when the booking was activated

activatedAt

associatedUsers

workflow

voyage

reference

linkedQuote

Information about the booking this was copied from

copiedFromBooking

customFields

linkedBookings

inventory

Source of the booking (e.g., portal, user)

source

billing

summary

goodsSummary

HBL (House Bill of Lading) release details

hblRelease

MBL (Master Bill of Lading) release details

mblRelease

optimalData

integrations

configuration

suborganizations

discrepancy

currentLocations

houseBookings

financeStatus

Indicates if tax is enabled for the booking

taxEnabled

invoicedDate

additionalNotifications

subNumber

warehouse

documents

plannedVoyagesView

ratesInvalidationInfo

automations

Date and time when the booking was created

createdAt

Date and time when the booking was last updated

updatedAt

<p class="slate-p " >Retrieve a single Logiware booking by its unique MongoDB ObjectId.</p><p class="slate-p " >A Logiware booking represents a comprehensive shipment record in the Logiware logistics platform, capturing all essential details for international and domestic freight movements. Each booking includes:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Parties involved (shipper, consignee, forwarder, etc.)</div></li><li class="slate-li " ><div style="position:relative">Goods and cargo details (containerized, LCL, FCL, air, etc.)</div></li><li class="slate-li " ><div style="position:relative">Route and transport information (origin, destination, ports, stops, etc.)</div></li><li class="slate-li " ><div style="position:relative">Financials (charges, invoices, costs, bills)</div></li><li class="slate-li " ><div style="position:relative">Workflow, status, and audit information</div></li><li class="slate-li " ><div style="position:relative">Custom fields, integrations, and more</div></li></ul><p class="slate-p " >This endpoint returns the full booking object, including all nested subcomponents, for use in shipment tracking, management, and integration scenarios.</p><p class="slate-p " ></p>

Retrieve a single Logiware booking by its unique MongoDB ObjectId.

A Logiware booking represents a comprehensive shipment record in the Logiware logistics platform, capturing all essential details for international and domestic freight movements. Each booking includes:

This endpoint returns the full booking object, including all nested subcomponents, for use in shipment tracking, management, and integration scenarios.

Get booking by ID

Get booking by number

Replace a booking by ID

Update a booking by ID

<p class="slate-p " >The Parties section allows users to manage information related to individual parties involved in a project. This includes adding or updating party details, uploading documents, and retrieving pre-signed URLs for document uploads. Users can also retrieve specific party information by ID.</p><p class="slate-p " ></p><p class="slate-p " ></p>

The Parties section allows users to manage information related to individual parties involved in a project. This includes adding or updating party details, uploading documents, and retrieving pre-signed URLs for document uploads. Users can also retrieve specific party information by ID.

Sections