Field Description

Attribute Names pertaining to date and time for example "createDttm" is represented as "MM-dd-yyyy HH:mm".
Attention: The field descriptions are for the reference purposes only.

The field descriptions for the attributes listed in the JSON code block are provided below:

Table 1. Field Description Tables
Attribute Name Type Required/Optional/Conditional/Read Only Max Length Condition Values Description Additional Notes
bookingNumber string Conditional 100 A booking number is a unique identifier that is assigned to a specific booking of goods. It is used to track the movement of goods throughout the logistics process and is assigned by the logistics provider or carrier.
requestNumber string Required 20 A request number refers to a unique identifier assigned to a reservation or booking request. This number is used to track the status of the request and can be used by both the customer and the service provider to reference the booking.
pickupDate datetime Conditional It is mandatory to provide the pickupDate for all booking statuses except for draft, where it is optional. The pickup date refers to the date on which a service or item will be picked up by the customer.
masterWaybillNumber string Optional 100 It refers to a unique identification number assigned to a consolidated shipment of goods.
houseWaybillNumber string Optional 100 A House Waybill Number is a unique identification number assigned to an individual shipment within a consolidated shipment.
earliestReceiptDate datetime Optional The earliest receipt date refers to the earliest possible date on which a customer can receive a product or service after making a booking request.
cutoffDate datetime Optional A cutoff date refers to the last date by which a customer can make a reservation for a particular service or event.
vgmCutoffDate datetime Optional A VGM cutoff date refers to the last date by which a Verified Gross Mass (VGM) must be submitted for a container to be loaded onto a vessel.
transitDate datetime Optional A transit date refers to the estimated or actual date on which a shipment will move or transit from the origin to the destination. It is the date or period between the time when the shipment is picked up from the origin and when it is delivered to the final destination.
contractNumber string Optional 100 A contract number is a unique identifier assigned to a specific contract or agreement between a customer and a service provider. The service provider assigns the contract number and uses it to identify the specific contract or agreement in all communications, transactions, and other interactions related to the booking.
documentationCutoffDate datetime Optional The documentation cutoff date refers to the deadline by which all required shipping documentation must be submitted and verified in order for a shipment to be cleared for transport.
deliveryDate datetime Optional The delivery date refers to the date on which a shipment is expected to be delivered to its final destination.
uuid string Optional 50 A Universally Unique Identifier (UUID) is a unique identifier that is used to identify a specific address or location in a computer system or database.
plusCode string Optional 20 The Plus Code is a system developed by Google to provide a shorthand way of representing a specific location or address.
code string Conditional 50 This is Required when UUID is absent. This is a code that is used to identify the location in the Blume Platform.
unloccode string Conditional 50 This is Required when UUID is absent. This is an industry-standard code used in the shipping and logistics industry to identify specific locations, such as ports or warehouses.
address1 string Conditional 255 This is Required when UUID is absent. This is the street address or specific location of the address.
type string Conditional 20 This is Required when UUID is absent. This refers to the type of address, which can be used to identify the function or purpose of the location.
name string Conditional 100 This is Required when UUID is absent. This is the name of the location or business associated with the address.
city string Conditional 50 This is Required when UUID is absent. This is the name of the city in which the address is located.
state string Conditional 50 This is Required when UUID is absent. This is the name or abbreviation of the state in which the address is located.
country string Conditional 50 This is Required when UUID is absent. This is the name or abbreviation of the country in which the address is located.
postalCode string Conditional 20 This is Required when UUID is absent. This is a postal code, which is used to identify a specific geographic area for the purpose of delivering mail or other packages.
timezone string Optional 50 This is the time zone in which the address is located.
portOfLoading Object If the UUID is not available, the UNLOcode attribute must be provided as Required. The port of loading refers to the port where the cargo will be loaded onto the vessel for transport.
destination Object Optional 50 The final destination where the cargo is intended to be delivered.
portOfDischarge Object If the UUID is not available, the UNLOcode attribute must be provided as Required. The port where the cargo will be discharged from the vessel and delivered to the consignee or their agent.
originator Object The party who initiated or created the booking. This could be the shipper or the freight forwarder who is acting on behalf of the shipper.
code string Required 50 The unique identifier given to the party who initiated or created the booking. This could be the shipper or the freight forwarder who is acting on behalf of the shipper.
receiver Object The party who will receive the cargo at the final destination. This could be the consignee, the buyer, or their agent, depending on the terms of the sale and the shipping arrangements.
code string Conditional 50

It is required solely for the customer user persona.

 The unique identifier given to the party who will receive the cargo at the final destination. This could be the consignee, the buyer, or their agent, depending on the terms of the sale and the shipping arrangements.
serviceProvider Object The party that will provide the transportation service for the cargo. This is a carrier, such as a shipping line, airline, or trucking company, that handles transporting the cargo from the point of origin to the final destination.
code string Conditional 50 This is a mandatory requirement exclusively for the BCO user. The unique identifier given to the party that will provide the transportation service for the cargo. This is a carrier, such as a shipping line, airline, or trucking company, that handles transporting the cargo from the point of origin to the final destination.
mode string Required 20 The method of transportation that will be used to move the cargo from the point of origin to the final destination.
cargoType string Required 50 The type of equipment that is being used to transport the cargo, such as "pallets", "containers", "Packages", or "breakbulk".
cargoDescription string Optional 1000 A brief description of the goods being transported. This field can include details such as the type of goods, quantity, weight, dimensions, and any special handling requirements. "20 pallets of electronics components, each measuring 1.2m x 1.0m x 1.5m and weighing 500kg"
status string Optional 50 Draft Pending Confirmation Acknowledged Rejected Cancelled Pending Cancellation Confirmed Active Completed The current state of a particular booking or shipment.
acknowledgementStatus string Optional 50 Not Acknowledged Acknowledged with Errors Acknowledged with Warnings Acknowledged Successfully The status of the acknowledgment of the booking request by the receiver or service provider. This field indicates whether the receiver or service provider has acknowledged the booking request, and if so, whether the acknowledgment was successful or unsuccessful.
carrierBookingOffice string Optional 200 The office or location of the carrier that is responsible for handling the booking.
serviceType string Required 50 Door to Door Door to Port Door to Rail Port to Port Port to Door Port to Rail Rail to Port Rail to Door The serviceType field refers to the type of shipping service requested by the customer.
paymentTerm string Optional 50 Prepaid Collect Third Party Non-Revenue Company Material The terms of payment that have been agreed upon between the customer and the service provider.
vesselName string Optional 28 The name of the vessel that will be transporting the cargo. "MS Maersk Mc-Kinney Moller"
vesselCode string Optional 100 A unique identifier for the specific vessel that will be transporting the cargo.
voyageNumber string Optional 10 The "voyageNumber" refers to the specific voyage that the cargo will be transported on. A voyage is a specific journey taken by a vessel between two or more ports, and a voyage number is a unique identifier for that journey.
houseBooking boolean Conditional

True: If BCO flow

False:If Customer flow

 A "house booking" refers to a booking made by a freight forwarder or non-vessel operating common carrier (NVOCC) on behalf of their customer, who is the actual owner of the goods being transported.
quantity Integer Conditional 11 In case the cargo type attribute is specified as container or pallet, the quantity attribute becomes mandatory.
containerType string Conditional 50 In case the cargo type attribute is specified as container or pallet, the quantity attribute becomes mandatory. The type of container that is used to transport the cargo.
containerSize string Conditional 50 In case the cargo type attribute is specified as container or pallet, the quantity attribute becomes mandatory. The physical dimensions of the container used for transporting goods.
containerNumber string Conditional 20 containerNumber is only applicable if the cargo type attribute is set to container. A unique identification number is assigned to a shipping container used to transport cargo.
refrigerated boolean

True

False

 The "refrigerated" attribute indicates whether a container requires refrigeration or not.
hazmat boolean

True

False

 The hazmat attribute refers to a field used to indicate whether the cargo being booked contains hazardous materials or not.
party string Required 50 Both the first name and last name of the party are mandatory. A party is an individual or organization involved in moving or managing goods or information. Examples include shippers, carriers, warehouses, customs brokers, and retailers. These parties work together to ensure the safe and efficient movement and delivery of goods.
addressLine1 string Optional 100 The "address1" attribute usually refers to the first line of an address. This line may contain the street number, street name, apartment or suite number, or any other details that identify the location.
addressLine2 string Optional 100 The "address2" attribute is used to capture extra information about an address that doesn't fit on the first line. This includes things like building or unit numbers, floor or suite numbers, or any other unique identifiers that help identify the location.
email string Optional 50 The email address of the person who is responsible for the booking.
phone string Optional 15 The phone attribute refers to the phone number of the person responsible for the booking.
orgName string 255 The "orgName" attribute refers to the name of the organization or company that is responsible for the booking. It's used to identify the entity that's responsible for the shipment and ensure that all parties involved have accurate information.
orgCode string 255 The "orgCode" attribute refers to a unique identifier assigned to the organization or company that's responsible for the shipment. This identifier is used to track and identify the organization throughout the booking process.
parentOrgCode string 50 The "parentOrgCode" attribute in a booking API refers to a unique identifier assigned to the parent organization or company of the entity responsible for the booking. This identifier is used to identify the larger entity to which the organization belongs. Providing a parent organization code makes it easier to accurately track and identify all entities involved in the booking process.
bookingComments Object 1000 The "bookingComments" attribute enables users to include additional comments or instructions related to a booking. These comments can be used to provide important information to carriers, freight forwarders, or other parties involved in the shipment.
bookingReferences Object The "bookingReferences" attribute enables users to add relevant references related to the booking. These references can include order numbers, purchase order numbers or any other relevant references that help track the booking.
type string 20 Type of the booking reference.
name string 50 Name of the booking refernce.
value string 100 Value of the booking reference.