BookingLineItem

Endpoints relating to BookingLineItem objects. The Booking Line Item endpoints need special permission to access. Please contact your Flexport Sales representative if you are interested in using these endpoints.

List all booking line items

Returns a list of booking line items linked to submitted bookings

Request
query Parameters
page
integer >= 1
Default: 1

Page number of the page to retrieve

Example: page=1
per
integer [ 1 .. 100 ]
Default: 20

Count of items in each page. Should be between 1 and 100 (inclusive)

Example: per=20
sort
string

Sort results by the specified field

Enum: "cargo_ready_date" "created_at"
direction
string
Default: "desc"

Set sort order. Allows "asc" (ascending) or "desc" (descending)

Enum: "asc" "desc"
f.purchase_order.id
integer

Filters for all booking line items from a purchase order

Example: f.purchase_order.id=123
Responses
200

collection of booking line items

Response Schema: application/json
_object
string
self
string
version
integer
object
_object
string
prev
string or null
next
string or null
Array of objects (BookingLineItem)
get/booking_line_items
Response samples
application/json

Success

{}

Create a booking line item

Creates and returns a booking line item

Request
Request Body schema: application/json
purchase_order_line_item_id
required
integer

Always required. The identifier of the PO line item to book

booking_id
required
integer

Always required. The identifier of the booking to add the PO line item to

units
required
integer

Always required. Number of units to book

Responses
200

The created booking line item

Response Schema: application/json
_object
string
self
string
version
integer
object (BookingLineItem)
_object
string

Type of the object

id
integer

Unique identifier for the booking line item

object (BookingRef)
object (PurchaseOrderLineItemRef)
units
integer

Number of units of purchase_order_line_item booked on booking

post/booking_line_items
Request samples
application/json
{
  • "purchase_order_line_item_id": 112358,
  • "booking_id": 9876,
  • "units": 200
}
Response samples
application/json

Success

{}

Retrieves the details of a single booking line item.

Returns a list of booking line items

Request
path Parameters
id
required
integer

The unique id for the booking line item to be retrieved

Responses
200

A collection of booking line items

Response Schema: application/json
_object
string
self
string
version
integer
object (BookingLineItem)
_object
string

Type of the object

id
integer

Unique identifier for the booking line item

object (BookingRef)
object (PurchaseOrderLineItemRef)
units
integer

Number of units of purchase_order_line_item booked on booking

get/booking_line_items/{id}
Response samples
application/json

Success

{}