MI - Mile, sometimes called the international mile or statute mile to
distinguish it from other miles, is a British imperial unit and US customary unit of distance. Defined with respect to SI
units as exactly 1,609.344 meters.
KM - Kilometre (kilometer in American English), is a unit of length
in the metric system, equal to one thousand meters.
CUBIC_INCHES - Cubic inch (symbol in3) is a unit of volume in the
Imperial units and United States customary units systems. It is the volume of a cube with each of its three dimensions
(length, width, and depth) being one inch long, which is equivalent to 1/231 of a US gallon.
CUBIC_FEET - Cubic foot is an imperial and US customary (non-metric)
unit of volume, used in the United States and the United Kingdom. It is defined as the volume of a cube with sides of one
foot (0.3048 m) in length. Its volume is 28.3168 L (about 1⁄35 of a cubic metre).
CUBIC_CENTIMETERS - The cubic centimetre (cubic centimeter in
American English) is a commonly used unit of volume that corresponds to the volume of a cube that measures 1 cm × 1 cm × 1
cm. One cubic centimetre corresponds to a volume of one millilitre.
CUBIC_METERS - The cubic metre (cubic meter in American English) is
the SI derived unit of volume. It is the volume of a cube with edges one metre in length.
Validations exist for location codes, when used in integrations. The TMS only differentiates between these in particular places
(and
rarely so).
CUSTOMER_DEFINED - limited by MercuryGate TMP location code format standards - 2 or more characters in length, ascii
letters, numbers, space, and the following characters: * -, ., /, :, /, _.
Region validation exists for Canadian provinces, Mexico states, and states in The United States of America. In these countries,
the
region code must be a two-letter code found in the list of abbreviations used in those countries. For these countries, the
region code
is also required.
For all other countries, the region is not required or validated. It is expected that the region is included and correct if it
is
needed in a country; additional region code validation will be added over time.
Contact Information
The types of contact information:
PHONE_NUMBER - A phone number used for calling or texting.
FAX_NUMBER - A phone number meant to be called by a FAX machine instead of a person.
Validations exist for the following item classification systems. These values are stored in various places in the TMS, mostly on
item/ship units, sometimes in references.
CUSTOMER_DEFINED - Customer-defined item classification (aka "commodity code" in the TMS) -
MercuryGate standards - 2 to 50 alphanumeric characters (plus -)
FREIGHT_CLASS - National Motor Freight
Traffic Association (NMFTA) - Freight Class (FC).
NMFC_CODE - National Motor Freight Traffic Association (NMFTA) - National
Motor Freight Classification (NMFC).
SITC - United Nations - Standard International Trade
Classification (SITC)
STCC - Railinc - Standard
Transportation Commodity Code (STCC)
HARMONIZED_COMMODITY - World Customs Organization (WCO) -
Harmonized Commodity Description and Coding System (HS).
SCTG - US Bureau of Transportation Statistics
(US BTS) - Standard Classification of Transported Goods (SCTG)
UN NUMBER - United Nations Economic and Social Council (UNECE). Used
outside of North America.
NA NUMBER - United States Department of Transportation.
Identical to UN numbers, except that some substances without a UN number may have an NA number. Used only in North America.
The TMS currently only stores one hazmat number. In domain-based integrations, if all stops are inside of North America (US, CA,
MX) then the NA number is assumed, otherwise it's assume that the number is a UN number.
Some carriers want the regulations for a load specified.
CFR - Code of Federal Regulations
(CFR) - Title 49 of the CFR is the US Department of Transportation regulations that includes hazardous material
transportation regulations and federal motor carrier regulations
ADR - Accord relatif au transport international des marchandises
Dangereuses par Route (ADR) - a 1957 United Nations treaty that governs transnational transport of hazardous materials
There are some exceptions and modifications to hazardous material transportation. U.S. and international regulations require
that all individuals involved in shipping limited and excepted quantities of dangerous goods receive training. See US
CFR Title 49 Section 172 for more details.
FULLY_REGULATED - No exception; full regulations must be followed. This is the default, and assumed if an
exception is not provided.
LIGHTLY_REGULATED - Modified regulations for this quantity; not commonly used.
FLAMMABLE_SOLID -
Flammable solids, substances liable to spontaneous combustion, or substances which emit flammable gasses when they come in
contact with water.
OXIDIZER -
Oxidizing substances and organic peroxides.
CUSTOM - Customer-specific tracking numbering; this should only be used for specific customer numbering
schemes, not industry standards. Maximum 40 characters.
PRO_NUMBER - Progressive Rotating Order Number, used in LTL and TL
trucking. ISO 15459-1. 6 to 40 alphanumeric characters
UPU_S10_IDENTIFIER - Universal Postal Union (UPU) S10
identifier for international postal items for the purpose of tracking and tracing them during shipping.
EDI - ANSI X12 EDI 214 status code - 2-character alphanumeric value
UN EDIFACT - United Nations Directories for
Electronic Data Interchange for Administration, Commerce and Transport (UN/EDIFACT) - 3-character alphanumeric value.
IATA CARGOIMP - International Air Transport Association (IATA) Status
Code - three-letter code
BARREL - A barrel is a hollow cylindrical container with a bulging center, longer than it is wide. They
are traditionally made of wood but can be made from other materials.
BUNDLE
BAG
BOX
BASKET
BUCKET
CAGE
CASE
CRATE
CARTON
DRUM - A drum is a cylindrical shipping container used for shipping bulk cargo. Drums can be made of
steel, dense paperboard (commonly called a fiber drum), or plastic, and are generally used for the transportation and
storage of liquids and powders.
ENVELOPE - An envelope is a common packaging item, usually made of thin, flat material. It is designed to
contain a flat object, such as a letter or card.
KEG - A keg is a small barrel, commonly used to store, transport, and serve beer or other alcoholic or
non-alcoholic drinks.
LOG - A log is a tree trunk, cut down for making lumber. Logs cut to a specific length are called "bolts";
this package type covers both logs and bolts.
PACKAGE - A small box, of small weight, typically having a smaller height than width and length.
PALLET - A pallet is a flat transport structure, which supports goods in a stable fashion while being
lifted by a forklift, a pallet jack, a front loader, a jacking device, or an erect crane. While most pallets are wooden,
pallets can also be made of plastic, metal, paper, or other materials.
PIECE - Raw, unpackaged items. Sometimes called "each".
ROLL - Flat goods rolled up for shipping; not enclosed by a tube.
SHEET - Thin, flat goods, such as plywood, plastic sheets, or sheet metal.
SPOOL - Goods wound around a spool for shipping, such as a cable reel.
TANK - Closed container for holding liquid or gas, having an inlet and an outlet.
TRAY - A shallow platform designed for the carrying of items.
TUB - An open-top (or with removable top) circular or oblong container. Modern tubs used in industry might
be made from concrete, metal or plastic.
TUBE - Cylindrical packaging, longer than it is wide, sealed on both ends, containing a small volume and
weight of goods.
STANDARD - Standard Service is the standard service provided by the carrier for a particular mode; the
exact definition varies by carrier and mode.
PRIORITY - Priority Service includes priority handling or faster delivery speed; the exact definition
varies by carrier and options selected.
EXPEDITED - Expedited delivery; in trucking, a higher level of service than standard.
EXPRESS - Express delivery; the exact definition varies by carrier and options selected.
GUARANTEED - Guaranteed delivery; in trucking, delivery is guaranteed within a specific transit time.
DEFERRED - Deferred delivery; in trucking, the slowest level of service.
SAME_DAY - Same-day delivery.
NEXT_DAY_EARLY_AM - Next-day delivery; the exact definition of "Early A.M.", "A.M.",
and "P.M." may vary by carrier.
NEXT_DAY_AM - Next-day delivery; the exact definition of "Early A.M.", "A.M.",
and "P.M." may vary by carrier.
NEXT_DAY_PM - Next-day delivery; the exact definition of "Early A.M.", "A.M.",
and "P.M." may vary by carrier.
SECOND_DAY_AM - Second-day delivery; the exact definition of "A.M." and "P.M."
may vary by carrier.
SECOND_DAY_PM - Second-day delivery; the exact definition of "A.M." and "P.M."
may vary by carrier.
THIRD_DAY - Third-day delivery.
GROUND - Ground transport; transit time will vary by carrier and is expected to be returned with a rate.
ECONOMY - Economy transport; typically a less-expensive version of GROUND; transit time will vary by
carrier and is expected to be returned with a rate.
ADULT_SIGNATURE - Request that the carrier obtain an adult's signature upon delivery; this is the same
as SIGNATURE, except the person signing must be an adult.
DANGEROUS_GOODS - Service for handling of dangerous goods; additional information may be required by the
carrier when selecting this service.
IMPORT_LABEL_DELIVERY - Indicates this booking is for an import, and the partner should deliver
labels (outside of the API response) to the shipper for use. Also known as "Import Control Label"
INSIDE_DELIVERY - Goods need to be delivered inside the location, meaning they will be left inside the
door of the business. Typically, the carrier will bring the freight only a few feet inside the main entrance.
INSIDE_PICKUP - Goods need to be picked up inside the lxocation, meaning they will be left inside the door
of the business. Typically, the carrier will bring the freight only a few feet inside the main entrance.
INSURANCE - The carrier should include additional insurance on the goods involved in the shipment, beyond
what the carrier normally includes. Each individual Shipping Unit or Item must have an insured value associated with it.
LIFT_GATE_DELIVERY - A lift gate is needed to deliver goods. A lift gate is an electric or
hydraulic piece of equipment on a truck that allows it to lift heavy cargo. The cargo can be either lowered from the truck's
bed to the ground or raised from the ground to the tailgate of the truck.
LIFT_GATE_PICKUP - A lift gate is needed to pick up goods. A lift gate is an electric or hydraulic
piece of equipment on a truck that allows it to lift heavy cargo. The cargo can be either lowered from the truck's bed
to the ground or raised from the ground to the tailgate of the truck.
LIMITED_ACCESS_DELIVERY - There is limited access at the location where goods are being delivered,
meaning that the delivery location takes extra time or effort to navigate. The reasons may be due to traffic congestion,
extra security, or drives that are difficult to travel.
LIMITED_ACCESS_PICKUP - There is limited access at the location where goods are being picked up,
meaning that the pick-up location takes extra time or effort to navigate. The reasons may be due to traffic congestion,
extra security, or drives that are difficult to travel.
PIECE_COUNT_VERIFICATION - The carrier should count the total number of packages received and
delivered. What counts as a package to be counted will vary by carrier and mode.
PROOF_OF_DELIVERY - The carrier must provide Proof of Delivery, aka (Delivery Confirmation); some
carriers may always or never send a proof of delivery regardless of this service being present or not, but some carriers
will only do it conditionally based on this service value being present. Therefore, it is best if the tenant adds this
service whenever they desire that a proof of delivery be returned.
RESIDENTIAL_DELIVERY - Goods are being delivered at a residential location instead of a business with a
loading dock. Typically, the delivery is to the curbside or doorstep, and inside delivery must be specified if desired. A
lift-gate may also need to be requested if the goods are too heavy to manually unload.
RESIDENTIAL_PICKUP - Goods are being picked up at a residential location instead of a business with a
loading dock. Typically, the pick-up is to the curbside or doorstep, and inside pickup must be specified if desired. A
lift-gate may also need to be requested if the goods are too heavy to manually load.
RETURN - Return shipping is a service provided where the shipment is returning defective or unwanted to
goods to the original shipper. There may be additional data necessary when this service is selected. This is also known as
return merchandise authorization (RMA), return authorization (RA), or return goods authorization (RGA)
SATURDAY_DELIVERY - Goods are being delivered on a Saturday.
SATURDAY_PICKUP - Goods are being picked up on a Saturday.
SIGNATURE - Request that the carrier obtain a signature upon delivery; some carriers may always or never
obtain a signature regardless of this service being present or not, but some carriers will only do it conditionally based
on this service value being present. Therefore, it is best if the tenant adds this service whenever they desire that a
signature be obtained.
SORT_AND_SEGREGATE - Sort and segregate is a service in which the cargo unloading process and
sorting activities are included. These activities can include piece counting, repacking, sorting, and quality checking,
among various other tasks.
TRAILER_EUROPEAN - Due to maximum length regulations and the need to maximize cargo within said
regulations, almost all European trailers are 13.60m in length.
FLATBED - Flatbed trailer.
REFRIGERATED - Refrigerated trailer (sometimes called a "Refer")
LINEAR_FEET - Linear Feet are loading dimensions
used in the United States, representing the amount of space cargo uses in a trailer, measuring the number of feet of the
trailer's length taken by the cargo.
LOADING_METERS - Loading meters are loading
dimensions used internationally, and represents the amount of space cargo uses in a trailer measuring the number of meters
of the trailer's length taken by the cargo.
FLAT_RATE - The charge is a flat-rate; quantity must be 1 for this charge type and the rate will also be
the total rate for the charge.
PER_POUND - The charge is a per-weight (per-pound) charge; the quantity (in pounds) and rate are
multiplied together to find the total rate for the charge.
PER_HUNDRED_WEIGHT - The charge is a per-hundred-weight (per-hundred-pounds) charge; the quantity
(in pounds / 100) and rate are multiplied together to find the total rate for the charge; it is also known as "short
hundredweight" or "centum weight".
PER_KILOGRAM - The charge is a per-weight (per-kilogram) charge; the quantity (in kilograms) and rate are
multiplied together to find the total rate for the charge.
PER_MILE - The charge is a per-distance (per-mile) charge; the quantity (in miles) and rate are multiplied
together to find the total rate for the charge.
PER_KILOMETER - The charge is a per-distance (per-kilometer) charge; the quantity (in kilometers) and rate
are multiplied together to find the total rate for the charge.
PER_SHORT_TON - The charge is a per-weight (per-ton) charge; the quantity (in tons) and rate are
multiplied together to find the total rate for the charge; a short ton is used in the United States, where it is commonly
known as a "ton", or 2000 pounds.
PER_METRIC_TON - The charge is a per-weight (per-metric-ton) charge; the quantity (in metric tons)
and rate are multiplied together to find the total rate for the charge; a metric ton is 1000 kg.
PER_HOUR - The charge is a per-hour charge; the quantity (in hours) and rate are multiplied together to
find the total rate for the charge.
PER_PIECE - The charge is a per-piece/per-unit charge; the quantity (in number of pieces of freight) and
rate are multiplied together to find the total rate for the charge.
PERCENTAGE - The charge is a percentage charge; the quantity (as a whole-number percentage / 100) and rate
are multiplied together to find the total rate for the charge; percentages less than 1% are not supported.
SPOT - This is a one-time rate for shipping goods on a specific occasion or for a particular shipment. It's often used for shipments that are outside of regular, ongoing contracts.
NEGOTIATED - This involves a prearranged agreement between the shipper and the carrier for a specific rate, often part of a broader contract. Negotiated rates are typically established for an extended period and are not tied to individual shipments.
Incoterms are managed by the
International Chamber of Commerce, and are a legal framework. The Incoterms listed below
are currently supported by MercuryGate; for a full list of terms and what they mean, please contact the ICC.
EXW - Ex Works, plus place of delivery; the seller delivers the goods to the buyer by unloading them at a
place which may or may not be the buyer's premises. This Incoterm can be used with any mode of transport. Incoterms
2020.
FCA - Free Carrier, plus named place of delivery; the seller delivers the goods to the buyer either by
loading them at the seller's premises, or when the goods arrive at the named place and are ready for unloading. This
Incoterm can be used with any mode of transport. Incoterms 2020.
CPT - Carriage Paid to, plus place of destination; the seller delivers the goods to the buyer by handing
them over to a carrier contracted by the seller, or by giving the carrier physical possession of the goods appropriate to
the mode. Once the goods have been delivered to the buyer in this way, the seller does not guarantee that the goods will
reach the place of destination in sound condition, in the stated quantity or indeed at all. This Incoterm can be used with
any mode of transport. Incoterms 2020.
CIP - Carriage and Insurance Paid To, plus place of destination; this is identical to CPT except that the
seller must also contract for insurance cover against the buyer’s risk of loss of or damage to the goods from the point of
delivery to at least the point of destination. This Incoterm can be used with any mode of transport. Incoterms 2020.
DAP - Delivered at Place, plus named place of destination; the seller delivers the goods when the goods
are placed at the disposal of the buyer, ready for unloading, at the named place of destination. This Incoterm can be used
with any mode of transport. Incoterms 2020.
DAT - Delivered at Terminal, plus terminal information; replaced in 2020 specification by DPU. Here for
legacy contracts which have not been updated to use 2020 Incoterms. This Incoterm can be used with any mode of transport.
Incoterms 2020.
DPU - Delivered at Place Unloaded, plus of place of destination; the seller delivers the goods when the
goods are unloaded and placed at the disposal of the buyer at the named place of destination. DPU is the only Incoterms
rule that requires the seller to unload goods at destination. DPU replaces DAT, with additional requirements for the seller
to unload the goods from the arriving means of transport. This Incoterm can be used with any mode of transport. Incoterms
2020.
DDP - Delivered Duty Paid, plus place of destination; the seller delivers the goods to the buyer when the
goods are cleared for import, placed the the disposal of the buyer, and ready for unloading at the place of destination.
DDP, with delivery happening at destination and with the seller being responsible for the payment of import duty and
applicable taxes, is the Incoterms rule imposing on the seller the maximum level of obligation of all of the Incoterms
rules. This Incoterm can be used with any mode of transport. Incoterms 2020.
FAX, - Free Alongside Ship, plus named of port of shipment; the seller delivers the goods to the buyer
when the goods are placed alongside the ship (eg on a barge) nominated by the buyer, at the named port of shipment. The FAS
rule is not appropriate where goods are handed over to the carrier before they are alongside the vessel, for example where
goods are handed over to a carrier at a container terminal. This Incoterm is only used for sea and inland waterway
transport. Incoterms 2020.
FOB - Free on Board, plus named port of shipment; the seller delivers the goods to the buyer when the
goods are on board the vessel nominated by the buyer, at the named port of shipment. The carriage of the goods is arranged
and paid for by the buyer. The FOB rule is not appropriate where goods are handed over to the carrier before they are
placed onboard the vessel, for example where goods are handed over to a carrier at a container terminal. This Incoterm is
only used for sea and inland waterway transport. Incoterms 2020.
CFR - Cost and Freight, plus named port of destination; the seller delivers the goods to the buyer on
board the vessel. The carriage of the goods is arranged and paid for by the seller, but they are not obligated to purchase
insurance to cover any loss by the buyer. This Incoterm is only used for sea and inland waterway transport. Incoterms 2020.
CIF - Cost Insurance and Freight, plus named port of destination; the seller delivers the goods to the
buyer on board the vessel. The carriage of the goods is arranged and paid for by the seller, and the seller is obligated to
purchase insurance to cover any loss by the buyer. This Incoterm is only used for sea and inland waterway transport.
Incoterms 2020.
SHIPPERS_EXPORT_DECLARATION - A Shippers Export Declaration (SED) serves two purposes. 1) As a census
record of U.S. exports. 2) As a regulatory document, because it includes the commodity's export license designation and
value. The Shippers Export Declaration is delivered to the exporting carrier (airline or vessel line) and then presented to
the U.S. Customs Service at the port of export, but does not leave the US.
CERTIFICATE_OF_ORIGIN - A Certificate of Origin
(CO), also known as a Declaration of Origin (DOO) attests that the product listed therein has met certain criteria to be
considered as originating in a particular country. It is essential in international trade transactions because it is the
proof certifying the origin of the product, which is in turn the basis to determine the tariffs and other trade measures
that will be applied.
NAFTA_CERTIFICATE_OF_ORIGIN - A trilaterally
agreed upon form used by Canada, Mexico, and the United States to certify that goods qualify for the preferential tariff
treatment accorded by NAFTA
CUSTOMS_INVOICE
PARTIAL_CUSTOMS_INVOICE
COMMERCIAL_INVOICE - The commercial invoice is a legal document
between the exporter and the buyer (in this case, the foreign buyer) that clearly states the goods being sold and the
amount the customer is to pay. The commercial invoice is one of the main documents used by customs in determining customs
duties.
MercuryGate APIs: Standard Data and Codes (beta)