IBC. Inc.

IBC Fullman Documentation

Purpose

This page is only designed for those customers which have been instructed to review this file format. It is not meant to be a complete guide to sending manifest data to Pactrak®, but rather a guide to the file format only.

Fullman files are sent to us via email, via a web form, or via a HTTP POST submission service. The data can be sent at any time. If you are an Air-AMS customer, the timing needs to follow the US Customs regulations for Air-AMS.

Resources

Testing your integration

You can test your manifest records using the Manifest Test API Service, or using the web form.

For Air AMS customers, we recommend to use your actual shipment records when producing test manifests, in order to correctly test that your data will be successfully integrated and submitted to US CBP processing.

Going Live Air AMS

IBC will generate a trouble ticket in order to track your progress. Once you are approved you will be able to submit your live shipment data and send your alerts to the station's import team. Please follow up with your sales manager to confirm the minimum time periods required for your submission and to review the IBC Air AMS Standard Operating Procedures (SOP).

Follow these steps to complete your onboarding integration:

  1. Create a Fullman manifest using your active shipment data
  2. Use the Manifest Test API or the web form to confirm the quality of your manifest data
  3. Once you've completed several tests, please reply back to the ticket confirming that you have completed your tests. Please include in the ticket a sample of the responses you have received.
  4. IBC will respond back and send you a production address to make your live submissions.

The File Format

The data is in CSV format (commas between fields, double quotes around any field which contains a comma, a double quote inside a field is doubled.) Empty values (a.k.a. blank or null) are represented as two adjacent field separators, or as a field separator followed by end of line (or at the beginning of a line, but that can't happen with this format).

Most customers won't have data for all of the fields in the format. You should leave the fields you're not using empty.

The character encoding has to be either ASCII or ISO 8859-1 (Latin-1).

The first field of every record specifies what type of record it is (mawb, hawb, commodity, etc.). The second field is an integer which specifies the record type's version. This is used to retain backward compatibility when a change is made to the record format.

At a minimum your manifest should contain at least 3 different kinds of lines:

email, mawb, hawb
email line - for notifications
mawb line - manifest level details such as flight, master, arrival date
hawb line - shipment level detals, shipper, consignee, weight, value etc.
commodity line - for Type 11, FDA, Type 86 and to report multiple items in your shipments. value etc.
Type 11

For the this type of entry you will need to provide with your hawb lines:

  • hts_code, origin_country and MID declaration in hawb line
  • IOR declaration after the hawb line
  • if multi-piece, origin country for each commodity in commodity line
  • if multi-piece, manufacturer_id for each commodity in the commodity line
FDA Declarations

For the this type of entry you will need to provide with your hawb lines:

  • commodity line
  • fda declaration - see commodity line tab
  • commodity_misc declaration - see commodity line tab
  • commodity_entity declaration - see commodity entity type for manufacturer

Additional information for Air-AMS customers

For testing purposes, you will need to use the IBC Manifest Test Site to submit your data. The form will respond with a URL for your test result. Please share these results with our IT team so that your onboarding progress can be monitored.

In production, when you send a live file you will receive via email either an error message or a positive acknowledgment that the data was accepted. If you receive no acknowledgment something went seriously wrong; you should contact IBC. You will normally receive a response within 20 minutes of your transmission.

If you receive a positive response that manifest is "locked" — you cannot update it. If you were to resend that data you would get an error message for each HAWB saying it was a duplicate. If you need to make a change to data already submitted and accepted you will need to send an email message to aams-ZZZ-alert@ibcinc.com where ZZZ is DFW, JFK, LAX, MIA, or ORD (whichever IBC office is handling the manifest) and then a human in that office will update the data.

If you receive an error message it indicates that the entire manifest was rejected, as any error will cause the entire file to be rejected. If that occurs you must correct the errors and resend the file in its entirety. Until a positive response is received no data is available to US Customs.

You may receive warning messages about non-critical errors along with the "good data" acknowledgments. Those warnings are designed to give you time to identify sources of invalid data; we anticipate needing to enforce stricter data validation in the future. The warnings will start with the word "NOTICE" to differentiate them from errors. You will still see the line

 Successfully loaded Air AMS data

in the success email if there were no real errors, just warnings.

Programmer's Notes

As requirements change we add fields and/or change data validation. The semantics for a record version don't change, instead there is a new record version assigned to the updated format. The Programmer's Notes column indicates in which version of the record a field appeared for the first time.

The record_type field was added with hawb version 13. For backwards compatibility it isn't required on versions 13 and earlier. The same applies to version 1 mawb (previously record type 1) and email (previously types 6 and 7) records.

Email Lines
Required for AMS - at least 1 line per manifest

Record type email is used for reporting back to you the results of processing your data. You can specify different addresses for errors and for success reports. Currently this is only supported for Air-AMS customers.

email records are global in nature and must appear at the start of the file, before any other type of records.

For Air-AMS customers at least one email recipient for errors is required.

If you want to have messages sent to more than one email address, simply put more than one email record of the appropriate type in the file.

Field Name Type Required? Additional Information
record_type char(255) always always email
record_version integer always always 1
address_type char(255) always error, success, or all

error for an address to which we send errors, success for an address to which we send success messages, all to receive both types

email_address char(255) always a single email address

Rudimentary checking is performed on the email address supplied. Of course it should be a valid address, but it at least has to match *@*.* and not have more than one @ in it.

Samples

email,1,all,status1@example.com
email,1,all,status2@example.com
email,1,error,only-errors@example.com
email,1,success,only-success@example.com
Processing rules
  • Must preceed all lines
  • At least 1 email line is required, by default use 'all'
  • only 1 email per line, you can use multiple lines of the same kind

Manifest Line
Required for AMS - 1 line per manifest

A record of type mawb holds manifest information. This data applies to all following HAWB records until either the end of the file or another mawb record. There will normally be a mawb record near the top of the file, directly after any records which apply to the whole file.

For Air-AMS the mawb record is required, and all the fields must be supplied.

For non-Air-AMS you aren't required to have a mawb record. If you don't use one we won't be able to print out manifests of this data, but it will still be used for the HAWB in our database.

Field Name Type Required? Additional Information
record_type char(255) always always mawb
record_version integer always always 1
manifest_code char(15) never

If desired you can use this field to uniquely identify this manifest (e.g. if you sent several parts for the same MAWB).

manifest_date char(8) required for Air-AMS format YYYYMMDD

The date that the flight LEAVES the origin country.

For Air-AMS it can't be older than 7 days ago or newer than 4 days from now.

manifest_origin char(3) required for Air-AMS

The three letter IATA airport code (all upper case) for the origin of the final leg of the flight.

manifest_destination char(3) required for Air-AMS

The three letter IATA airport code (all upper case) for the final destination of the flight. If you ship to IBC within the United States this would be DFW, JFK, LAX, MIA, or ORD.

flight char(20) required for Air-AMS

The airline and flight number (such as AA1234 or BA179).

mawb char(11) required for Air-AMS

This field contains the consolidation's Master Air Waybill number (11 digits). For Air-AMS customers it is required and it must match the MAWB filed by the airline; if this is not the case US Customs will NOT release your material. Furthermore airline MAWBs have a mod-7 check digit, and we will reject files where the check-digit is invalid.

Samples

# record_type,record_version,man_code,man_date,man_origin,man_dest,flight_info,mawb
mawb,1,OBGBA100016602,20191218,SJO,JFK,VS0045,932-57321784
Processing rules
  • Must preceed all hawb lines

Miscellaneous Manifest records
Section 321 and Type 92 returns

Format

COL NUM FIELD          NOTES
--- --- ------         ------------
A   1   record_type    always file_misc
B   2   record_version always 1
C   3   code_type      section-321-originator-code or entry_type
D   4   value see      below

This line should be reported before the Manifest Record Line and after your Email Record lines.

Section 321

Once approved by US CBP, you will receive an Section 321 Filer ID. You will report it to IBC in the following manner

file_misc,1,section-321-originator-code,YOUR_ASSIGNED_CODE
Type 92 - used for returns

To declare an entire manifest as entry type 92 add:

file_misc,1,entry_type,92

after the email addresses at the top of the file. For example an entire file containing type 92 shipments would be declared like this:


email,1,all,person@example.com
file_misc,1,entry_type,92
mawb,1,,20250312,ABC,LAX,AA001,20500000011

followed by your hawb lines.

It is also possible to declare a single item in your manifest as a return, see the Hawb section for details.

Hawb Line
Required - at least 1 line per manifest

Record type hawb contains details about a single shipment. For each HAWB on the manifest you include a single hawb record.

Field Name Type Required? Additional Information Since
record_type char(255) always always hawb 13
record_version integer always always 14 2
profile_key integer never usually empty 2
hawb char(40) always your full HAWB (including letters)

Important: We will reference the shipment internally using the last 11 digits in your HAWB, ignoring any letters or other characters. Data sent back to you will use your full HAWB.

US CBP requires that the HAWB be unique among all the shipments on the same MAWB. Because of the conversion we do on your full HAWB this means that the last 11 digits of your HAWB have to be unique among shipments on the current MAWB. For example:

your full HAWB HAWB sent to US CBP result
543210987654321 10987654321 OK
54321098765432ABCD1 10987654321 HAWB rejected

This would be an error. Even though the 2 full HAWBs are different they are the same when converted to the values which are sent to US CBP.

2
reference char(11) never your customer's reference number 2
internal_reference char(40) never usually empty 3
vend_ref_num char(22) never if you are applying the delivery agent's labels you must include the tracking number here 2
origin char(3) required for Air-AMS the three letter IATA code of the origin 2
final_destination char(3) required for Air-AMS the three letter IATA code of the destination or a major airport in its country

Though it isn't an IATA code this field is allowed to be USA for US destinations.

2
outlying char(1) never X for outlying, empty otherwise 2
service_provider char(3) never leave empty unless told otherwise by IBC 10
dls_station char(3) never leave empty 2
dls_final_destination char(3) never leave empty 2
num_pieces decimal(3,0) required for Air-AMS the number of physical pieces (boxes, tubes, envelopes, etc.) associated with this HAWB (for multi-piece shipping) 2
weight decimal(7,2) required for Air-AMS raw weight, not rounded; must be positive if present

In pounds unless a type 4 or greater record, in which case the units are specified in the next field.

2
weight_units char(2) required if weight is not empty lb = pounds, kg = kilos, g = grams 4
contents char(3) required for Air-AMS DOC (documents) or APX (dutiable) 2
currency_code char(3) never type of currency used by monetary fields such as declared_value

It's preferred that you send monetary values to us already converted into US dollars in which case this field can be left empty. If you use a 3-letter ISO currency code here we will attempt to do the conversion for you.

11
declared_value decimal(7,0) required for Air-AMS APX shipments in US dollars or the given currency_code; must be empty or 0 for DOC shipments 2
insurance_amount decimal(9,2) never in US dollars or the given currency_code; must be empty unless you buy insurance from IBC (retail only) 3
description char(200) required for Air-AAMS APX shipments description of the goods (if APX) in English; required for AAMS APX 2
hts_code char(10) required for CFS entry type 86 filing the Harmonized Tariff (HS) code for the commodity being shipped

Must be a full 10 digit code if provided. Consult with our brokerage department to determine if this is required for your shipments. This should be associated with the first good in the shipment.

9
fda_prior_notice char(12) never the FDA Prior Notice number; must be exactly 12 digits if present

Consult with our brokerage department to find out if this is required for your shipments.

8
terms char(1) never leave empty unless told otherwise by IBC, when it is supplied the valid values are Prepaid, Specials, and Free Domicile (DDP) 2
packaging char(1) required for Air-AMS Use the following codes: L=Letter, P=IBC Pak, B=Box, T=Tube, C=Crate, M=Metal Film Can, O=Other 3
service_type char(2) never use ST for standard courier shipments (which is the default if the field is left empty), GD for ground service 3
collect_amount decimal(7,2) required for Air-AMS shipments with terms = C in US dollars or the given currency_code; use only when terms is C; cannot be negative 2
cust_key integer never leave empty unless told otherwise by IBC 2
acct_num char(4) never your account number with IBC, or empty 2
dls_acct_num char(12) never leave empty unless told otherwise by IBC 2
ext_cust_acct char(11) never leave empty unless told otherwise by IBC 3
shipper_name char(30) required for Air-AMS

Use the "true" shipper's information for these fields. If you are a wholesale account this would be your customer's information.

2
shipper_address1 char(25) required for Air-AMS 2
shipper_address2 char(25) never 2
shipper_city char(25) required for Air-AMS 2
shipper_state char(2) never 2
shipper_zip char(10) never 2
shipper_country char(15) required for Air-AMS country code or country name

For Air-AMS this must be the two letter ISO country code.

2
shipper_phone char(15) never 2
consignee_person char(35)

Air-AMS shipments require at least one of the consignee_person and consignee_company be supplied

recipient's name / department 2
consignee_company char(35) company name 2
consignee_street_1 char(35) required for Air-AMS street address, line 1 2
consignee_street_2 char(35) never street address, line 2 2
consignee_city char(35) required for Air-AMS non-abbreviated city name 2
consignee_state char(20) required for Air-AMS shipments to US and CA abbreviated state/province code

e.g. FL for Florida.

2
consignee_postal_code char(20) required for Air-AMS shipments to US and CA postal/zip code 5
consignee_country char(2) required for Air-AMS ISO country code 8
consignee_phone char(20) never phone number, including country code 2
consignee_email char(255) never recipient's email address 12
consignee_tax_id char(40) never recipient's country-specific tax identifier 12
comment char(512) never optional free-form text 8
goods_country_of_origin char(2) never

Origin country of included goods for customs' purpose. This should be associated with the first good in the shipment.

13
container_id char(255) never

identifier of the container/gaylord/etc. containing this shipment

13
manufacturer_id char(255) never

the mid code for the the first good associated with the shipment

14
Samples

#record_type,record_version,profile_key,hawb,ship_ref_num,internal_reference,vend_ref_num,origin,final_destination,outlying,service_provider,dls_station,dls_final_destination,num_pieces,weight,weight_unit,contents,currency_code,declared_value,insurance_amount,description,hts_code,fda_prior_notice,terms,packaging,service_type,collect_amount,cust_key,ship_acct_num,dls_acct_num,ext_cust_acct,shipper_name,shipper_address1,shipper_address2,shipper_city,shipper_state,shipper_zip,shipper_country,shipper_phone,consignee_person,consignee_company,consignee_street_1,consignee_street_2,consignee_city,consignee_state,consignee_postal_code,consignee_country,consignee_phone,consignee_email,consignee_tax_id,comment,goods_coo,incoming_container,mid
hawb,14,,"4475853025637753042180",,,,"HKG","JFK",,,,,1,"0.21","K","APX","USD",29,,"Collectible Toy",9503000090,,,"B",,,,,,,"Gsocpai","324 COMTUIQIR PD",,"SHENZHEN",,90045,"CN","18339688669","Tdggdtlpasl Ftyyrb",,"2277 KGNAIQGTU TKAZWIMK",,"MELBOURNE","FL","32904-8056","US",,,,,"CN",1049816,CNOZR92MEL
Processing rules
  • Must follow mawb line
  • 1 line per shipment
  • each can have commodity, package and commodity_entity lines

Miscellaneous Shipment declaration
Type 92 returns or Importer of record

Entry Definition


COL NUM FIELD          NOTES
--- --- ------         ------------
A   1   record_type    always hawb_misc
B   2   record_version always 1
C   3   code_type      entry_type or ior
D   4   value see      below
Type 92 Returns - Shipment level

This declaration is used when a single shipment in the manifest needs to be declared as return.

hawb_misc,1,entry_type,92
						

Sample - only the item with track '123464899' is declared as a return.


email,1,all,general-status@example.com
mawb,1,OBGBA100016602,20191218,LHR,JFK,VS0045,932-57321784
hawb,14,,"12346455",,,,"HKG","JFK",,,,,1,"0.21","K","APX","USD",29,,"CollectibleToy",9501002713,,,"B",,,,,,,"Gsocpai","324 COMTUIQIRPD",,"SHENZHEN",,90045,"CN","18339688669","Tdggdtlpasl Ftyyrb",,"2277 KGNAIQGTU TKAZWIMK",,"MELBOURNE","FL","32904-8056","US",,,,,"CN",1049816,
hawb,14,,"123464899",,,,"HKG","JFK",,,,,1,"0.32","K","APX","USD",200,,"painting",9801002600,,,"B",,,,,,,"Gsocpai","324 COMTUIQIR PD",,"SHENZHEN",,90045,"CN","18339688669","Mvcpnut Yudghe",,"30 DPKXBJDG ZVVSAWP","CTN J","CATONSVILLE","MD","21228-5044","US",,,,,"AU",1049755,
hawb_misc,1,entry_type,92
hawb,14,,"1234622",,,,"HKG","JFK",,,,,1,"0.32","K","APX","USD",200,,"painting",9801002600,,,"B",,,,,,,"Gsocpai","324COMTUIQIR PD",,"SHENZHEN",,90045,"CN","18339688669","Micale Yudghe",,"30 WestSt","","CATONSVILLE","MD","21224","US",,,,,"AU",1049755,
Importer of record - Shipment level

This declaration is used when an importer of record needs to be reported for a shipment.

This value of the entry is the importer's tax id number or a number assigned by US CBP.

hawb_misc,1,ior,##-#######00
hawb_misc,1,ior,#####-##### - CBP assigned

Sample - only the item with track '123464899' is declaring the tax id ##-######## as the importer of record.


email,1,all,general-status@example.com
mawb,1,OBGBA100016602,20191218,LHR,JFK,VS0045,932-57321784
hawb,14,,"12346455",,,,"HKG","JFK",,,,,1,"0.21","K","APX","USD",29,,"CollectibleToy",9501002713,,,"B",,,,,,,"Gsocpai","324 COMTUIQIRPD",,"SHENZHEN",,90045,"CN","18339688669","Tdggdtlpasl Ftyyrb",,"2277 KGNAIQGTU TKAZWIMK",,"MELBOURNE","FL","32904-8056","US",,,,,"CN",1049816,
hawb,14,,"123464899",,,,"HKG","JFK",,,,,1,"0.32","K","APX","USD",200,,"lantern, candle, candle holder",,,,"B",,,,,,,"Gsocpai","324 COMTUIQIR PD",,"SHENZHEN",,90045,"CN","18339688669","Mvcpnut Yudghe",,"30 DPKXBJDG ZVVSAWP","CTN J","CATONSVILLE","MD","21228-5044","US",,,,,CN,1049755,CNLAVIE243BRE
hawb_misc,1,ior,##-#######00
commodity,4,1,"Candle",https://www.thecandlemaker.com/item/2646524.html,3406000000,AU,,,,,,,,,,,AUOZR92MEL
commodity,4,1,"Candle Holder - brass",https://www.thecandlemaker.com/item/2646547.html,9405504000,CN,,,,,,,,,,,CNLAVIE243BRE
hawb,14,,"1234622",,,,"HKG","JFK",,,,,1,"0.32","K","APX","USD",200,,"painting",9801002600,,,"B",,,,,,,"Gsocpai","324COMTUIQIR PD",,"SHENZHEN",,90045,"CN","18339688669","Micale Yudghe",,"30 WestSt","","CATONSVILLE","MD","21224","US",,,,,"AU",1049755,
hawb,14,,"5845009938465331602455",,,,"HKG","JFK",,,,,2,"0.32","K","APX","USD",200,,"candle, candle holder",,,,"B",,,,,,,"Gsocpai","324 COMTUIQIR PD",,"SHENZHEN",,90045,"CN","18339688669","Mvcpnut Yudghe",,"30 DPKXBJDG ZVVSA WP","CTN J","CATONSVILLE","NJ","05044","US",,,,,,1049755,
hawb_misc,1,ior,##-#######00

Commodity Line
formerly goods line


COL NUM FIELD NAME            NOTES
--- --- --------------------- -------------
A   1   record_type           always "commodity"
B   2   record_version        always "4"
C   3   quantity
D   4   description
E   5   commodity_url
F   6   hts_code
G   7   origin_country
H   8   declared_value_per_quantity
I   9   declared_value_currency
J   10  weight_per_quantity
K   11  weight_units
L   12  order_id
M   13  order_date
N   14  list_price_per_quantity
O   15  list_price_currency
P   16  retail_price_per_quantity
Q   17  retail_price_currency
R   18  manufacturer_id (mid)
Samples

commodity,4,1,"Sweet Scented Candle - 100%Was",https://www.thecandlemaker.com/item/1234456.html,,FR,,,,,,,,,,,FRLAVIE243BRE
commodity,4,1,"Candle Holder -brass",https://www.thecandlemaker.com/item/2646547.html,,IT,,,,,,,,,,,ITBOCSPA61VER
commodity,4,1,"War Craddle-Fabric+Charcoal",https://thecandlemaker.com/item/1246543.html,,AU,,,,,,,,,,,AUOZR92MEL
Processing rules
  • Must follow "hawb" lines
  • All fields are optional except record type and record version
  • Typically used to report HTS codes on multiple item shipments

Miscellaneous Commodity declarations
to report FDA items

There are two different line definitions for FDA.

FDA record definition

COL NUM FIELD                           NOTES
--- --- ------                          ------------
A   1   record_type                     always "fda"
B   2   record_version                  always 1
C   3   fda_product_code                required - see FDA product Builder
D   4   fda_program_code                required [FOO, COS, DEV, RAD] 
E   5   fda_processing_code             required for FOO, DEV and RAD
F   6   fda_intended_use_code           required for COS, FOO-CCW, DEV and RAD
G   7   fda_registration_number_type    required for FOO
H   8   fda_registration_number         required for FOO
I   9   fda_brand_name                  optional / conditional
Sample pga declaration.

fda,1,31ACT03,FOO,PRO,210.000,PFR,###########,RichTeaBrand
Compliance code definition

COL NUM FIELD                           NOTES
--- --- ------                          ------------
A   1   record_type                     always "commodity_misc"
B   2   record_version                  always 1
C   3   name                            use "fda_compliance_code"
D   4   code_name                       declare your fda_compliance_code
E   5   code_value                      declare your fda_compliance_value
Sample pga declaration.

commodity_misc,1,fda_compliance_code,COS,1061499
Processing rules
  • must follow a commodity line
  • can be placed in any order - fda then commodity_misc or commodity_misc then fda
  • use 1 commodity_misc line per compliance code
  • if no compliance codes are needed, you can omit the commodity_misc line

Glossary
FDA information

See this Excel Worksheet for Intented Use Code informaiton
Required - Optional - Leave Blank
program_code product_code prefix processing_codes intended_use_code brand_name registration_number comp codes
COS 50 or 53
FOO 01-46, 48, 49, 50, 52, 54, 69, 70, 71 or 72 only for CCW except CCW only for LACF/AF
DEV 73-92 if intended use code
RAD 94-97 only if 2877 only if 2877
FDA Program Codes
Code Description
FOO Food
COS Cosmetics
DEV Medical Device
RAD Radiation Emitting Device
FDA Processing Codes
Code Description Use with
PRO Processed Food FOO
FEE Animal Feed FOO
DSU Dietary Supplement FOO
ADD Additives and Colors FOO
CCW Ceramicware or Food Contact Substance FOO
NED Non-Radiation Emmitting Device DEV
RED Radiation-Emitting Device DEV
REP Non Medical Product RAD
FDA Registration Number Type
Code Description Use with
PFR Food Facility Reg. Num. FOO
FME FDA PN MFR Reg. Exception FOO
GFR Growers Food Facility Reg. Num. FOO
CFR FDA Consolidator Food Facility Reg. Num. FOO
Compliance Codes
Code Description Used with
COS Cosmetic COS
FCE Food Canning Est. Num. FOO
SID Schedule ID Num. FOO
VOL Volume FOO - used when LACF/AF

Entity Line
formerly goods_entity / hawb_entity line


COL NUM FIELD NAME            NOTES
--- --- --------------------- -------------
A   1   record_type           always "commodity_entity"
B   2   record_version        always "1"
C   3   role_name             See Entity Role Section below
D   4   name
E   5   address
F   6   city
G   7   state
H   8   postal_code
I   9   country
J   10  phone
K   11  email
L   12  url

Entity Role Section
---------------------------------------------------------------------------------
The Entity role_name should be one of the following (defined by CBP)

ROLE
---------------------
manufacturer
carrier
buyer
consignee
seller
finalRecipient
shipmentInitiator
onlineMarketplace
other
broker
shipper
forwarder


Definitions
------------------------------------------------------------------------------
Shipment Initiator Name and Address (e.g., the entity that causes the movement
of a shipment, which may be a seller, shipper, or manufacturer, but not a
foreign consolidator).

Final Deliver to Party Name and Address (e.g., the final entity to receive the
shipment once it arrives in the United States, which may be a final purchaser
or a warehouse, but not a domestic deconsolidator)

Seller Name and Address (e.g., an international or domestic company that sells
products on marketplaces and other websites)

Buyer Name and Address, if applicable (e.g., the purchaser of a good from an
online marketplace. This entity is not always the same as the final deliver to
party.)

Further details would come from CBP, please review the documentation
provided by CBP for the section 321 pilot program.
Samples

# first commodity 
commodity,4,1,"Sweet Scented Candle - 100%Was",https://www.thecandlemaker.com/item/1234456.html,,,,,,,,,,,,,FRLAVIE243BRE
# info about the first commodity's seller
commodity_entity,1,seller,The Candle Maker,10 East Drive,San Jose,,,CR,800-222-3333,sales@thecandlemaker.com,https://www.thecandlemaker.com
# info about the first commodity's shipper and marketplace
commodity_entity,1,shipper,West Coast Shipper,11 Shipping Blvd,San Jose,,,CR,,,
commodity_entity,1,onlineMarketplace,Ebay,,,,,,,,https://www.ebay.com

# second commodity with entity records
commodity,4,1,"War Craddle-Fabric+Charcoal",https://thecandlemaker.com/item/1246543.html,,FR,,,,,,,,,,,FRLAVIE243BRE
commodity_entity,1,seller,The Candle Maker,10 East Drive,San Jose,,,CR,800-222-3333,sales@thecandlemaker.com,https://www.thecandlemaker.com
commodity_entity,1,onlineMarketplace,Ebay,,,,,,,,https://www.ebay.com
Processing rules
  • Must follow a "commodity" line
  • All fields are optional except record type, record version and role_name
  • Typically used to report entity details relating to the preceeding commodity line

Package Line


COL NUM FIELD_NAME            NOTES
--- --- --------------------- -------------
A   1   record_type           always "package"
B   2   record_version        always "1"
C   3   quantity
D   4   package_awb
E   5   barcode
F   6   reference
G   7   incoming_container
H   8   vendor_code
I   9   vendor_awb
J   10  packaging
K   11  description
L   12  declared_value
M   13  declared_value_currency
N   14  weight
O   15  weight_units lb/kg/g
P   16  dim_l
Q   17  dim_w
R   18  dim_h
S   19  dim_units in/m/cm/mm
Samples

package,1,1,4475853025637753042180,,ref123,1001,,,P,"collectible toy",,,"0.21","K",2,2,2,"in"
commodity,4,1,"Sweet Scented Candle - 100% Was",https://www.thecandlemaker.com/item/1234456.html,,FR,,,,,,,,,,,FRLAVIE243BRE
hawb,14,,"5845009938465331596614",,,,"HKG","JFK",,,,,1,"0.32","K","APX","USD",200,,"painting",9503000090,,,"B",,,,,,,"Gsocpai","324 COMTUIQIR PD",,"SHENZHEN",,90045,"CN","18339688669","Mvcpnut Yudghe",,"30 DPKXBJDG ZVVSA WP","CTN J","CATONSVILLE","MD","21228-5044","US",,,,,"AU",1049755,AUOZR92MEL
package,1,1,5845009938465331596614,,,,,,P,"painting",,,"0.16","K",6,2,8,"in"
commodity,4,1,"Candle Holder - brass",https://www.thecandlemaker.com/item/2646547.html,,FR,,,,,,,,,,,FRLAVIE243BRE
Processing rules
  • Must follow "hawb" lines and preceed "commodity" line
  • All fields are optional except record type and record version
  • Typically used to report the details relating to the preceeding hawb line
  • package lines are optional

Manifest Sample


# The file can contain blank lines and comments introduced with "#".

email,1,all,general-status@example.com

# record_type,record_version,man_code,man_date,man_origin,man_dest,flight_info,mawb
mawb,1,OBGBA100016602,20191218,SJO,JFK,VS0045,932-57321784

#record_type,record_version,profile_key,hawb,ship_ref_num,internal_reference,vend_ref_num,origin,final_destination,outlying,service_provider,dls_station,dls_final_destination,num_pieces,weight,weight_unit,contents,currency_code,declared_value,insurance_amount,description,hts_code,fda_prior_notice,terms,packaging,service_type,collect_amount,cust_key,ship_acct_num,dls_acct_num,ext_cust_acct,shipper_name,shipper_address1,shipper_address2,shipper_city,shipper_state,shipper_zip,shipper_country,shipper_phone,consignee_person,consignee_company,consignee_street_1,consignee_street_2,consignee_city,consignee_state,consignee_postal_code,consignee_country,consignee_phone,consignee_email,consignee_tax_id,comment,goods_coo,incoming_container
hawb,14,,"4475853025637753042180",,,,"HKG","JFK",,,,,1,"0.21","K","APX","USD",29,,"Collectible Toy",9503000090,,,"B",,,,,,,"Gsocpai","324 COMTUIQIR PD",,"SHENZHEN",,90045,"CN","18339688669","Tdggdtlpasl Ftyyrb",,"2277 KGNAIQGTU TKAZWI MK",,"MELBOURNE","FL","32904-8056","US",,,,,"CN",1049816,CNOZR92MEL
package,1,1,4475853025637753042180,,ref123,1001,,,P,"collectible toy",,,"0.21","K",2,2,2,"in"
commodity,4,1,"Sweet Scented Candle - 100% Was",https://www.thecandlemaker.com/item/1234456.html,,,,,,,,,,,,,FRLAVIE243BRE

#sample entry with multiple commodity, commodity_entity
hawb,14,,"5845009938465331596614",,,,"HKG","JFK",,,,,2,"0.32","K","APX","USD",200,,"painting",9503000090,,,"B",,,,,,,"Gsocpai","324 COMTUIQIR PD",,"SHENZHEN",,90045,"CN","18339688669","Mvcpnut Yudghe",,"30 DPKXBJDG ZVVSA WP","CTN J","CATONSVILLE","MD","21228-5044","US",,,,,"AU",1049755,AUOZR92MEL
package,1,1,5845009938465331596614,,,,,,P,"painting",,,"0.16","K",6,2,8,"in"
commodity,4,1,"Candle Holder - brass",https://www.thecandlemaker.com/item/2646547.html,,FR,,,,,,,,,,,FRLAVIE243BRE
commodity_entity,1,seller,The Candle Maker,10 East Drive,San Jose,,,CR,800-222-3333,sales@thecandlemaker.com,https://www.thecandlemaker.com
commodity_entity,1,shipper,West Coast Shipper,11 Shipping Blvd,San Jose,,,CR,,,
commodity,4,1,"War Craddle- Fabric+Charcoal",https://thecandlemaker.com/item/1246543.html,,FR,,,,,,,,,,,FRLAVIE243BRE
commodity_entity,1,seller,The Candle Maker,10 East Drive,San Jose,,,CR,800-222-3333,sales@thecandlemaker.com,https://www.thecandlemaker.com
commodity_entity,1,onlineMarketplace,Ebay,,,,,,,,https://www.ebay.com
package,1,1,5845009938465331596615,,,,,,P,"painting",,,"0.16","K",6,2,8,"in"
commodity,4,1,"Candle",https://www.thecandelmaker.com/item/12245.html,,FR,,,,,,,,,,,FRLAVIE243BRE

#sample Type 11 Declaration, sample hawb and commodity w hts codes (1 shipment 3 commodities) 
hawb,14,,"5845009938465331602455",,,,"HKG","JFK",,,,,3,"0.32","K","APX","USD",200,,"lantern, candle, candle holder",9405406000,,,"B",,,,,,,"Gsocpai","324 COMTUIQIR PD",,"SHENZHEN",,90045,"CN","18339688669","Mvcpnut Yudghe",,"30 DPKXBJDG ZVVSA WP","CTN J","CATONSVILLE","NJ","05044","US",,,,,CN,1049755,CNLAVIE243BRE
hawb_misc,1,ior,##-#######00
commodity,4,1,"Candle",https://www.thecandlemaker.com/item/2646524.html,3406000000,AU,40,USD,.10,K,,,,,,,AUOZR92MEL
commodity,4,1,"Candle Holder - brass",https://www.thecandlemaker.com/item/2646547.html,9405504000,CN,60,USD,.10,K,,,,,,,CNLAVIE243BRE

#sample PGA Declaration
hawb,14,,"5845009938465331602566",,,,"GUA","JFK",,,,,1,"0.91","K","APX","USD",100,,Herbal Chinese Tea,,,,"B",,,,,,,"Gsocpai","324 COMTUIQIR PD",,"SHENZHEN",,90045,"CN","18339688669","Cooling Yudghe",,"55 DPKXBJDG ZVVSA WP","CTN J","Orlando","Fl","33133","US",,,,,CN,1049775,CNOZR92MEL
hawb_misc,1,ior,##-#######00
commodity,4,1,"herbal tea",,3406000000,GT,,,,,,,,,,,GTTEAMAK28GUA
commodity_entity,1,manufacturer,The Tea Maker,28 El Sauce,Gautemala City,,,GT,502-224-3333,sales@theteamaker.com,https://www.theteamaker.com
fda,1,54JBT16,FOO,CCW,970.000,PFR,1356-4664,RichTeaBrand
commodity_misc,1,fda_compliance_code,COS,1061499

#commodity, package and commodity_entity lines are optional
#for Type 11 use the hawb, commodity, hawb_misc line
#for PGA declarations use the hawb, commodity, fda, commodity_misc and optionally commodity_entity