Overview

This API provides details for a given shipment number. There are three primary sections to this API:

Shipment Summary: Shipment-level information, including current status, vessel name, and key dates
Shipment Line: Indicates which purchase orders are part of this shipment
Shipment Events: Events received by APLL for this shipment


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 shipment overview request will return the below fields in a JSON format.

Entry Field Definition
ShipmentSummary customerName

Customer Name in APLL System

ShipmentSummary shipmentNumber

Bill of Lading number as given by carrier

ShipmentSummary status

Current status of the equipment

ShipmentSummary transportMode

Method of transportation (e.g., Ocean, Rail, Truck)

ShipmentSummary 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)

ShipmentSummary 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

ShipmentSummary carrierCode

Carrier SCAC Code

ShipmentSummary updatedVesselName

Current/Latest Vessel Name

ShipmentSummary updatedVesselVoyage

Current/Latest Vessel Voyage Number

ShipmentSummary previousVesselName

Previous Vessel Name

ShipmentSummary previousVesselVoyage

Previous Vessel Voyage Number

ShipmentSummary equipmentCount

Number of containers (equipment) associated with the shipment

ShipmentSummary shipperBookingCount

Number of bookings associated with the container

ShipmentSummary purchaseOrderCount

Number of purchase orders associated with the shipment

ShipmentSummary volume

Total volume of cargo

ShipmentSummary volumeUOM

Volume unit of measure code. Typically, cubic meters (CBM)

ShipmentSummary weight

Total weight of cargo

ShipmentSummary weightUOM

Weight unit of measure code. Typically, kilograms (KG)

ShipmentSummary cartons

Number of cartons or boxes in the container

ShipmentSummary cartonUOM

Carton Unit of Measure Code. Typically, cartons (CT)

ShipmentSummary quantity

Total quantity of items or units in the container

ShipmentSummary quantityUOM

Weight unit of measure code. Typically, Units (UNIT).

ShipmentSummary carbon

Estimated carbon dioxide equivalent emissions for the shipment

ShipmentSummary carbonUOM

Unit of measure for CO2e. Typically in metric tons (MT)

ShipmentSummary customsStatus

Customs status of the shipment

ShipmentSummary departureLocation

Port or location where the cargo is loaded onto the vessel

ShipmentSummary arrivalLocation

Port or location where cargo is discharged from the vessel

ShipmentSummary destinationLocation

Final destination of the cargo

ShipmentSummary cyDeliveryDate

Date the container was delivered to the container yard

ShipmentSummary cyDeliveryDateType

Indicates Estimated or Actual date

ShipmentSummary departureDate

Port of Loading departure date/time

ShipmentSummary departureDateType

Indicates Estimated or Actual date

ShipmentSummary arrivalDate

Port of Discharge arrival date/time

ShipmentSummary arrivalDateType

Indicates Estimated or Actual date

ShipmentSummary destinationDate

Arrival date/time at the final destination

ShipmentSummary destinationDateType

Indicates Estimated or Actual date

ShipmentLine equipmentNumber

Equipment/Container Number

ShipmentLine poNumber

Purchase Order number associated with the container

ShipmentLine poLineNumber

Purchase Order line number

ShipmentLine productNumber

Product number or style code

ShipmentLine productDescription

Description of the product

ShipmentLine shipperBookingNumber

APLL shipper booking number

ShipmentLine volume

Total volume of cargo

ShipmentLine volumeUOM

Volume unit of measure code. Typically, cubic meters (CBM)

ShipmentLine weight

Total weight of cargo

ShipmentLine weightUOM

Weight unit of measure code. Typically, kilograms (KG)

ShipmentLine cartons

Number of cartons or boxes in the container

ShipmentLine cartonUOM

Carton Unit of Measure Code. Typically, cartons (CT)

ShipmentLine quantity

Total quantity of items or units in the container

ShipmentLine quantityUOM

Weight unit of measure code. Typically, Units (UNIT).

ShipmentLine gohFlag

Indicates whether the shipment includes Garment-on-Hanger items

ShipmentLine gohPieces

Number of GOH pieces

ShipmentLine gohBars

Number of bars used for hanging garments

ShipmentEvents eventName

Type of event (e.g., loaded, departed, arrived)

ShipmentEvents equipmentNumber

Equipment/Container Number

ShipmentEvents sender

Originator of the event data

ShipmentEvents locationName

Location where the event occurred

ShipmentEvents eventDateTime

Timestamp of the event

ShipmentEvents eventType

Type of event: Scheduled, Estimated, Actual

ShipmentEvents portFunctionCode

Code indicating the function of the port (e.g., L = Load, D = Discharge)

ShipmentEvents portFunction

Name indicating the function of the port (e.g., L = Load, D = Discharge)

ShipmentEvents reference

Internal or external reference ID for tracking

ShipmentEvents portTermnialCode

Code of the terminal at the port

ShipmentEvents portTerminalName

Name of the terminal at the port

ShipmentEvents eventCreateDateTime

Timestamp when the event was first received

ShipmentEvents eventLastUpdateDateTime

Timestamp of the most recent update to the event