Overview
This API provides details of a given shipper booking number. There are three primary sections to this API.
Shipper Booking Summary: Booking level information, including booked locations, counts, and delivery dates.
Shipper Booking Line: Indicates what purchase orders are part of this booking
Shipper Booking Events: Events against the shipper booking
Call Limits
This API has the following limits on calls made:
| Calls per Minute | Calls Per Hour | Calls Per Day |
|---|---|---|
| 30 | 900 | 5000 |
Business Definition
Responses from shipper booking overview request will return the below fields in a JSON format.
| Entry | Field | Definition |
|---|---|---|
| ShipperBookingSummary | customerName | Customer Name in APLL System |
| ShipperBookingSummary | shipperBookingNumber | APLL shipper booking number |
| ShipperBookingSummary | status | Current status of the equipment |
| ShipperBookingSummary | shipperBookingOffice | APLL office location managing the shipper booking |
| ShipperBookingSummary | transportMode | Method of transportation (e.g., Ocean, Rail, Truck) |
| ShipperBookingSummary | loadType | ‘A’ indicates APLL Loaded (Shipper delivers cargo to APLL CFS for loading into a container), ‘F’ indicates Factory load (Shipper loads cargo into a container at his own factory and delivers the container to carrier yard directly), ‘C’ indicates CFS/CFS load (LCL/LCL shipments) . ‘X’ indicates Mixed Load (some cargo is APLL load and some cargo is Factory load) |
| ShipperBookingSummary | deliveryMode | Destination Load Type code. ‘CY’ means the entire FCL container will be taken by the consignee. ‘CFS’ means consignee only takes some of the cargo in the container. ‘SDD’ means that the cargo will be delivered to a location specified by the consignee whether it is CFS or CY load |
| ShipperBookingSummary | shipperName | Shipper Name |
| ShipperBookingSummary | consignee | The trading party name responsible for the cargo receiving at destination for the customer |
| ShipperBookingSummary | carrierCode | Carrier SCAC Code |
| ShipperBookingSummary | vesselName | Name of the ship transporting the equipment |
| ShipperBookingSummary | purchaseOrderCount | Number of purchase orders associated with the shipper booking |
| ShipperBookingSummary | carrierBookingCount | Number of carrier bookings associated with the shipper booking |
| ShipperBookingSummary | volume | Total volume of cargo |
| ShipperBookingSummary | volumeUOM | Volume unit of measure code. Typically, cubic meters (CBM) |
| ShipperBookingSummary | weight | Total weight of cargo |
| ShipperBookingSummary | weightUOM | Weight unit of measure code. Typically, kilograms (KG) |
| ShipperBookingSummary | cartons | Number of cartons or boxes in the container |
| ShipperBookingSummary | cartonUOM | Carton Unit of Measure Code. Typically, cartons (CT) |
| ShipperBookingSummary | quantity | Total quantity of items or units in the container |
| ShipperBookingSummary | quantityUOM | Weight unit of measure code. Typically, Units (UNIT). |
| ShipperBookingSummary | departureLocation | Port or location where the cargo is loaded onto the vessel |
| ShipperBookingSummary | arrivalLocation | Port or location where cargo is discharged from the vessel |
| ShipperBookingSummary | destinationLocation | Final destination of the cargo |
| ShipperBookingSummary | bookingSubmissionDate | Date the shipper booking was submitted to APLL |
| ShipperBookingSummary | bookingConfirmationDate | Date the booking was confirmed/accepted |
| ShipperBookingSummary | bookingDate | The date/timestamp when the booking was first created |
| ShipperBookingSummary | bookingLastUpdateDate | Date the shipper booking was last updated |
| ShipperBookingSummary | shipperEstimatedCargoDeliveryDate | Estimated Date of Delivery. For APLL Load or Shipper to APL CFS Load, this date represents the date when cargoes are received in APLL warehouse. For Factory load or Shipper to Carrier CFS load, this date is provided by shipper, which represents the date when cargoes are delivered to carrier |
| ShipperBookingSummary | shipperCargoDeliveryDate | Actual Date of Delivery. For APLL Load or Shipper to APL CFS Load, this date represents the date when cargoes are completely unloaded in ACS warehouse. For Factory load or Shipper to Carrier CFS load, this date represents the actual local date when the container is delivered to the yard |
| ShipperBookingSummary | cyDeliveryDate | Date the container was delivered to the container yard |
| ShipperBookingSummary | cyDeliveryDateType | Indicates Estimated or Actual date |
| ShipperBookingSummary | departureDate | Port of Loading departure date/time |
| ShipperBookingSummary | departureDateType | Indicates Estimated or Actual date |
| ShipperBookingSummary | arrivalDate | Port of Discharge arrival date/time |
| ShipperBookingSummary | arrivalDateType | Indicates Estimated or Actual date |
| ShipperBookingSummary | destinationDate | Arrival date/time at the final destination |
| ShipperBookingSummary | destinationDateType | Indicates Estimated or Actual date |
| ShipperBookingLine | poNumber | Purchase Order number associated with the container |
| ShipperBookingLine | poLineNumber | Purchase Order line number |
| ShipperBookingLine | productNumber | Product number or style code |
| ShipperBookingLine | productDescription | Description of the product |
| ShipperBookingLine | equipmentNumber | Equipment/Container Number |
| ShipperBookingLine | shipment Number | Bill of Lading number as given by carrier |
| ShipperBookingLine | volume | Total volume of cargo |
| ShipperBookingLine | volumeUOM | Volume unit of measure code. Typically, cubic meters (CBM) |
| ShipperBookingLine | weight | Total weight of cargo |
| ShipperBookingLine | weightUOM | Weight unit of measure code. Typically, kilograms (KG) |
| ShipperBookingLine | cartons | Number of cartons or boxes in the container |
| ShipperBookingLine | cartonUOM | Carton Unit of Measure Code. Typically, cartons (CT) |
| ShipperBookingLine | quantity | Total quantity of items or units in the container |
| ShipperBookingLine | quantityUOM | Weight unit of measure code. Typically, Units (UNIT). |
| ShipperBookingEvents | eventName | Type of event (e.g., loaded, departed, arrived) |
| ShipperBookingEvents | eventDateTime | Timestamp of the event |
| ShipperBookingEvents | sender | Originator of the event data |
| ShipperBookingEvents | locationName | Location where the event occurred |
| ShipperBookingEvents | remarks | Remarks on booking |
| ShipperBookingEvents | eventLastUpdateDateTime | Timestamp of the most recent update to the event |