Overview

This API provides details for a given equipment/container number. There are three primary sections to this API.

Equipment Summary: Equipment level information, including current status, sizing, and key dates
Equipment Line: Indicates what purchase orders are loaded into this equipment
Equipment Events: Events received by APLL for this container


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

Entry Field Definition
EquipmentSummary customerName

Customer Name in APLL System

EquipmentSummary equipmentNumber

Equipment/Container Number

EquipmentSummary status

Current status of the equipment

EquipmentSummary equipmentType

Type and size of the container

EquipmentSummary sealNumber

Security seal number used to verify equipment integrity

EquipmentSummary transportMode

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

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

EquipmentSummary 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

EquipmentSummary carrierCode

Carrier SCAC Code

EquipmentSummary vesselName

Name of the ship transporting the equipment

EquipmentSummary vesselVoyageNumber

Voyage number or identifier for the vessel’s journey

EquipmentSummary equipmentLineCount

Number of equipment lines associated with the container

EquipmentSummary shipperBookingCount

Number of bookings associated with the container

EquipmentSummary volume

Total volume of cargo

EquipmentSummary volumeUOM

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

EquipmentSummary weight

Total weight of cargo

EquipmentSummary weightUOM

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

EquipmentSummary cartons

Number of cartons or boxes in the container

EquipmentSummary cartonUOM

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

EquipmentSummary quantity

Total quantity of items or units in the container

EquipmentSummary quantityUOM

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

EquipmentSummary carbon

Estimated carbon dioxide equivalent emissions for the shipment

EquipmentSummary carbonUOM

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

EquipmentSummary departureLocation

Port or location where the cargo is loaded onto the vessel

EquipmentSummary arrivalLocation

Port or location where cargo is discharged from the vessel

EquipmentSummary destinationLocation

Final destination of the cargo

EquipmentSummary cyDeliveryDate

Date the container was delivered to the container yard

EquipmentSummary cyDeliveryDateType

Indicates Estimated or Actual date

EquipmentSummary departureDate

Port of Loading departure date/time

EquipmentSummary departureDateType

Indicates Estimated or Actual date

EquipmentSummary arrivalDate

Port of Discharge arrival date/time

EquipmentSummary arrivalDateType

Indicates Estimated or Actual date

EquipmentSummary destinationDate

Arrival date/time at the final destination

EquipmentSummary destinationDateType

Indicates Estimated or Actual date

EquipmentLine poNumber

Purchase Order number associated with the container

EquipmentLine poLineNumber

Purchase Order line number

EquipmentLine productNumber

Product number or style code

EquipmentLine productDescription

Description of the product

EquipmentLine shipperBookingNumber

APLL shipper booking number

EquipmentLine volume

Volume of cargo for the individual line

EquipmentLine volumeUOM

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

EquipmentLine weight

Weight of cargo for the individual line

EquipmentLine weightUOM

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

EquipmentLine cartons

Number of cartons or boxes for the individual line

EquipmentLine cartonUOM

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

EquipmentLine quantity

Total quantity of items or units for the individual line

EquipmentLine quantityUOM

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

EquipmentLine gohFlag

Indicates whether the shipment includes Garment-on-Hanger items

EquipmentLine gohPieces

Number of GOH pieces

EquipmentLine gohBars

Number of bars used for hanging garments

EquipmentEvents eventName

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

EquipmentEvents sender

Originator of the event data

EquipmentEvents locationName

Location where the event occurred

EquipmentEvents eventDateTime

Timestamp of the event

EquipmentEvents eventType

Type of event: Scheduled, Estimated, Actual

EquipmentEvents portFunctionCode

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

EquipmentEvents portFunction

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

EquipmentEvents reference

Internal or external reference ID for tracking

EquipmentEvents portTermnialCode

Code of the terminal at the port

EquipmentEvents portTerminalName

Name of the terminal at the port

EquipmentEvents eventCreateDateTime

Timestamp when the event was first received

EquipmentEvents eventLastUpdateDateTime

Timestamp of the most recent update to the event