Shipment

Type: object

Type: string

Reference number provided by the agent.

Type: boolean

Whether AMS filing is needed for this shipment.

Type: string

The port of arrival in the final destination country.

Type: string

Actual date the shipment arrived at the final air or ocean port (not including final inland transportation).

Type: string

Estimated date the shipment will arrive at the final air or ocean port (not including final inland transportation).

Type: string

Type of bill of lading like Straight.

Type: string

Confirmation number from party receiving initial booking.

Type: string

The time that the party receiving the initial booking confirmed it. If there is a forwarder or NVO involved, then this is the time they confirmed the booking with the shipper, not the time they confirmed the booking with the carrier.

Type: string

The name for the booking notification party.

Type: string

The address for the booking notification party.

Type: string

Additional reference number assigned to the booking by the booking party.

Type: string

Booking reference number provided by the party making the booking.

Type: string

The date the booking was submitted by the shipper.

Type: string

The name of the buying party responsible for the underlying purchase orders on this shipment. This may represent a specific buying office or buyer within the consignee's organization.

Type: string

The address of the buying party responsible for the underlying purchase orders on this shipment. This may represent a specific buying office or buyer within the consignee's organization.

Type: string

Actual date and time the cargo was be available.

Type: string

Estimated date and time the cargo will be available.

Type: string

The booking number provided by the carrier.

Type: string

Instructions to the carrier.

Type: string

The terms of payment that the forwarder / NVOCC has agreed to with the carrier issuing the master bill of lading.

Type: string

Carrier's Standard Carrier Alpha Code (SCAC).

Type: number

Greater of the dimensional or actual gross weight.

Type: string

The master Bill of Lading Number associated with the co-loader.

Type: string

The name of the party responsible for the co-loading the consolidation associated with the shipment.

Type: string

The address of the party responsible for the co-loading the consolidation associated with the shipment.

Type: string

The invoice number or numbers for the commercial invoice(s) used as the instrument of payment for the goods provided in the shipment.

Type: string

The name of the party to whom the goods are consigned.

Type: string

The address of the party to whom the goods are consigned.

Type: string

A reference number provided by the consignee which will be used to identify the shipment upon receipt.

Type: string

The name of the party who is consigning the goods.

Type: string

The address of the party who is consigning the goods.

Type: enum (of string)

How the shipment will be containerized (FCL, LCL, Loose, FTL, LTL).

Must be one of:

  • "FCL"
  • "LCL"
  • "Loose"
  • "FTL"
  • "LTL"

Type: string

The contract number for the shipment.

Type: string

The final cutoff date and time for submitting the final bill of lading instructions.

Type: string

The final cutoff date and time for submitting the final bill of lading instructions.

Type: string

The final cutoff date and time for the physical delivery of the freight.

Type: string

Timestamp of when the shipment instructions are due.

Type: string

The final cutoff date and time for submitting the verified gross mass (VGM) information.

Type: enum (of string)

The mode of delivery like CY/CY, CFS/CY, etc.

Must be one of:

  • "CY/CY"
  • "CFS/CY"

Type: string

A reference printed on the delivery note or packing list used to identify the shipment upon receipt.

Type: string

Actual date and time the cargo departed from it's origin point.

Type: string

Estimated date and time the cargo will depart from it's origin point.

Type: string

Description of goods in the shipment.

Type: number

Calculated dimensional (volumetric weight) of the shipment.

Type: boolean

Does the shipment contain Environmental Pollutants?

Type: string

The timestamp of when the export license will expire.

Type: string

The timestamp of when the export license was issued.

Type: string

Export license number used for this shipment.

Type: string

The final port including any inland transportation.

Type: string

The forwarder's main branch responsible for the shipment.

Type: string

The forwarder's main branch responsible for the shipment.

Type: string

The forwarder's main company responsible for the shipment.

Type: string

The forwarder's main company responsible for the shipment.

Type: string

The forwarder's main department responsible for the shipment.

Type: string

The forwarder's main department responsible for the shipment.

Type: string

The branch of freight forwarder responsible for shipment.

Type: string

The department of freight forwarder responsible for shipment.

Type: string

Shipment reference number assigned by the freight forwarder.

Type: string

SCAC or other assigned code for the freight forwarder.

Type: enum (of string)

The terms by which the freight will be paid, like Prepaid or Collect.

Must be one of:

  • "Prepaid"
  • "Collect"

Type: string

The name of the party that will be paid for the main leg freight costs by the shipping party. When a shipper is buying from an NVOCC, this is the NVOCC, not the carrier. When a shipper, forwarder, or NVOCC is buying from a carrier directly, this is the carrier.

Type: string

The address of the party that will be paid for the main leg freight costs by the shipping party. When a shipper is buying from an NVOCC, this is the NVOCC, not the carrier. When a shipper, forwarder, or NVOCC is buying from a carrier directly, this is the carrier.

Type: string

The tariff number for the freight being shipped.

Type: string

The name of the party responsible for dropping off the filled shipment.

Type: string

The address of the party responsible for dropping off the filled shipment.

Type: integer

Gross weight of the shipment in kilograms.

Type: number

Gross weight of the shipment in pounds.

Type: boolean

Does the shipment contain Hazardous Materials?

Type: boolean

If true, then the shipment is considered important and should be tracked with additional care by the forwarder.

Type: string

House bill of lading number.

Type: string

The name for the importer of record.

Type: string

The address for the importer of record.

Type: string

The INCOTerm under which the product is moving like FOB, DDP, etc.

Type: string

Is this shipment being sent in parts.

Type: string

The port of lading.

Type: string

Actual date the shipment was loaded onto the vessel.

Type: string

Estimated date the shipment will be loaded onto the vessel.

Type: string

The name for the local cartage yard container terminal operator.

Type: string

The address for the local cartage yard container terminal operator.

Type: string

The name of the local cartage yard.

Type: string

The address for the local cartage yard.

Type: string

The name for the local cartage yard exporter.

Type: string

The address for the local cartage yard exporter.

Type: string

The name for the local cartage yard importer.

Type: string

The address for the local cartage yard importer.

Type: string

Reference number provided by 4PL, Lead Logistics Provider, or other independent logistics management entity.

Type: string

Master bill of lading number.

Type: string

The date & time by which the carrier should deliver the shipment to the terimination point.

Type: number

Net weight of the shipment in kilograms.

Type: number

Net weight of the shipment in pounds.

Type: string

The name of the notify party on the bill of lading.

Type: string

The address of the notify party on the bill of lading.

Type: integer

Number of packages in the shipment.

Type: integer

Number of pieces in the shipment.

Type: string

Actual date the shipment will gated in at origin.

Type: string

Estimated date the shipment will gate in at origin.

Type: boolean

Does the shipment contain out of gauge freight?

Type: array

Each item of this array must be:

Type: object

Type: number

The total chargeable weight of all of the packages in the group.

Type: string

Commodity representing the product being moved. Often at the 6 digit level for the package group.

Type: string

A description of the goods within the packaging.

Type: integer

The total gross weight of all of the packages in the group. To calculate the gross weight of an individual package within the group, divide the gross weight of the group by the number of packages.

Type: string

Marks and numbers on the packages.

Type: integer

The height of the package group measured in centimeters.

Type: integer

The length of the package group measured in centimeters.

Type: string

An unique identifier for the package group. (If sending unique records per carton, use the SSCC number. If multiple packages in one group, use the license plate number or pallet number.

Type: integer

The total number of packages within the group.

Type: string

The code that represents the type of packaging. Standardized package type codes preferred.

Type: string

A description of the type of packaging.

Type: integer

The width of the package group measured in centimeters.

Type: string

The product code of the items in the package group.

Type: string

The HTS of the items in the package group. If all items do not have the same HTS, use the hts number at the PackItem level.

Type: string

The package group's unique identification number within a container from the source system.

Type: string

The package group's unique identification number at the same packaging level from the source system.

Type: integer

The total volume of all of the packages in the group. To calculate the volume for an individual package in the group, divide the total volume of the group by the number of packages.

Type: string

Appointment date to pickup the container from the starting point of the shipment.

Type: string

Purchase orders associated with the shipment.

Type: enum (of string)

The bill of lading release type. Generally STRAIGHT, EBL, TELEX.

Must be one of:

  • "STRAIGHT"
  • "EBL"
  • "TELEX"

Type: string

Time the record was sent by the source system.

Type: string

Service level to be used (like EXP or STD). These will vary per service provider.

Type: string

Service level description like (Standard or Express Overnight).

Type: string

The name of the starting point of the shipment.

Type: string

The address starting point of the shipment.

Type: string

The name of the ending point of the shipment.

Type: string

The address of the ending point of the shipment.

Type: string

The latest time that the shipment should depart origin.

Type: string

The earliest time that the shipment should depart origin.

Type: string

A code or description indicating the current overall status of the shipment. This may be used to indicate anything from a shipment delay to stage the shipment is in (Transit, Picked-Up, etc).

Type: string

Type code for the shipment.

Type: string

The name of the party that is responsible for causing the the goods to be shipped. Often the Beneficial Cargo Owner (BCO).

Type: string

The address of the party that is responsible for causing the the goods to be shipped. Often the Beneficial Cargo Owner (BCO).

Type: string

Reference number provided by the shipper.

Type: string

A unique identifying code for the account that controls the shipment in a multi-tenant environment.

Type: string

A unique identifying code from the system of record for this shipment.

Type: string

Original booking number of which this shipment is a part of.

Type: string

Reason code for this split shipment.

Type: string

Description of the reason this shipment was split.

Type: string

Description of this split shipment's sequence.

Type: boolean

Must the shipment be transported in temperature controlled conditions?

Type: string

The transaction type code for the shipment sent on an EDI document.

Type: string

A one-time unique identifying code for this transmission of the shipment in question. Used for tracing and logging purposes.

Type: enum (of string)

Mode of transportation (AIR, ROAD, SEA, RAIL).

Must be one of:

  • "AIR"
  • "ROAD"
  • "SEA"
  • "RAIL"

Type: string

Name of vessel (for multi-leg shipments, use the primary leg information).

Type: integer

Volume of the shipment in cubic meters.

Type: string

Voyage or flight number (for multi-leg shipments, use the primary leg information).