Build
Entry shape
The entry object that POST /api/v1/entries takes. Field names and types; ? marks an optional field. Where CBP calls a field something else, its CBP name is listed.
Trade parties are sent in place as { individualContactIndex?, resolved: { data: TradePartyData } }, with no ids.
entry
| Field | Type |
|---|---|
filer | object |
importerProfile | object |
lineItems | object[] |
shipping | object |
entry.filer
| Field | Type |
|---|---|
id | string |
entry.importerProfile
| Field | Type |
|---|---|
importerOfRecord | string |
entry.shipping
| Field | Type | CBP field |
|---|---|---|
associatedWarehouseEntryFilerCode? | string | |
associatedWarehouseEntryNumber? | string | |
associatedWarehouseEntryPortCode? | string | |
bond1ContinuousIndicator? | "S" | "Y" | Continuous Bond |
bond1DesignationType? | "A" | "B" | "U" | "E" | Bond Designation Type Code |
bond1StbAccount? | string | Single transaction bond account |
bond1StbAmount? | number | Single transaction bond amount |
bond1SuretyCode? | string | Surety company |
bond1Type? | "8" | "9" | Bond Type Code |
bond2StbAccount? | string | Single transaction bond account |
bond2StbAmount? | number | Single transaction bond amount |
bond2SuretyCode? | string | Surety company |
bondWaived? | boolean | |
bondWaiverReason? | "995" | "996" | "997" | "998" | "999" | |
brokerReferenceNumber? | string | |
buyerEntity? | TradeParty | |
cargoManifests? | object[] | |
cargoManifests[].conveyances? | object[] | |
cargoManifests[].conveyances[].carrierCode? | string | Conveyance carrier code |
cargoManifests[].conveyances[].conveyanceName? | string | |
cargoManifests[].conveyances[].dateOfArrival? | string | |
cargoManifests[].conveyances[].quantity? | number | Conveyance quantity |
cargoManifests[].conveyances[].trip? | string | Conveyance trip |
cargoManifests[].conveyances[].unitOfMeasure? | string | Conveyance unit of measure |
cargoManifests[].equipment? | object[] | |
cargoManifests[].equipment[].equipmentCheckDigit? | number | |
cargoManifests[].equipment[].equipmentDescriptionCode? | string | |
cargoManifests[].equipment[].equipmentInitial? | string | |
cargoManifests[].equipment[].equipmentNumber? | string | |
cargoManifests[].equipment[].equipmentSizeTypeCode? | string | |
cargoManifests[].manifests? | object[] | |
cargoManifests[].manifests[].issuer? | string | Manifest Component Issuer Code |
cargoManifests[].manifests[].nonAmsIndicator? | boolean | |
cargoManifests[].manifests[].number? | string | Manifest Component Identifier |
cargoManifests[].manifests[].quantity? | number | Bill of lading quantity |
cargoManifests[].manifests[].type? | "R" | "I" | "M" | "H" | "S" | "T" | Cargo Manifests Manifest Component Type Code |
cargoManifests[].quantity? | number | Cargo manifest quantity |
cargoManifests[].unitOfMeasure? | string | Cargo manifest unit of measure |
cargoReleaseContactName? | string | |
cargoReleaseContactPhone? | string | Cargo Release contact phone number |
cargoReleaseDisIndicator? | boolean | |
carrierCode? | string | |
consignee? | TradeParty | |
consigneeEntity? | TradeParty | |
consolidatedExpressInformal? | boolean | |
consolidatorEntity? | TradeParty | |
conveyanceName? | string | |
dateOfImportation? | string | |
designatedExamPortCode? | string | |
dis? | boolean | DIS indicator |
distributorEntity? | TradeParty | |
electedEntryDate? | string | |
electedExamSiteFirms? | string | Elected exam site FIRMS code |
entryDateElectionCode? | boolean | Weekly entry election |
entryFilerCode? | string | Original filer code |
entryNumber? | number | |
estimatedDateOfArrival? | string | |
estimatedEntryDate? | string | |
estimatedEntryValue? | number | |
exporterEntity? | TradeParty | |
filingMode? | "ES" | "CR" | "ISF" | |
finalDeliveredToPartyEntity? | TradeParty | |
finalWarehouseWithdrawal? | boolean | |
foreignTradeZoneIdentifier? | string | FTZ identifier |
formAction? | "A" | "D" | "R" | |
generalOrderNumber? | string | |
headerFees? | object[] | |
headerFees[].amount? | number | Header fee amount |
headerFees[].code? | "311" | "496" | "500" | Header Fee Accounting Code |
immediateDeliveryIndicator? | boolean | |
inBondInTransitDate? | string | |
includesIsf? | boolean | Include an ISF-10 with this filing |
internalName? | string | |
isCargoRelease? | boolean | Cargo release |
isElectronicInvoice? | boolean | Electronic invoice indicator |
isExpeditedRelease? | boolean | Expedited release |
isfActionCode? | "A" | "D" | "R" | ISF action |
isfActionReasonCode? | "CT" | "FR" | "FT" | "FX" | ISF action reason |
isfBondActivityCode? | string | Bond activity code |
isfBondHolder? | string | Bond holder |
isfBondType? | string | Bond type |
isfBookingPartyEntity? | TradeParty | |
isfCountryOfIssuance? | string | Country of issuance |
isfDateOfBirth? | string | |
isfFrobDetails? | object | |
isfFrobDetails.deliveryQualifier? | string | Delivery code qualifier |
isfFrobDetails.foreignPortOfUnlading? | string | |
isfFrobDetails.placeOfDelivery? | string | |
isfFrobDetails.unladingQualifier? | string | Unlading code qualifier |
isfImporterNumber? | string | |
isfImporterNumberQualifier? | "34" | "2" | "EI" | "ANI" | "AEF" | |
isfReferenceData? | object[] | |
isfReferenceData[].identifier? | string | ISF reference identifier |
isfReferenceData[].qualifier? | "CR" | "6B" | "6C" | "MB" | "SBN" | "V1" | … (7 values) | ISF reference qualifier |
isfScacIdentifier? | string | SCAC |
isfShipmentInformation? | object | |
isfShipmentInformation.estimatedQuantity? | number | |
isfShipmentInformation.estimatedValue? | number | |
isfShipmentInformation.estimatedWeight? | number | |
isfShipmentInformation.shipmentSubType? | string | |
isfShipmentInformation.unitOfMeasure? | string | |
isfShipmentInformation.weightQualifier? | string | |
isfShipmentReferences? | object[] | |
isfShipmentReferences[].identifier? | string | Bill of lading |
isfShipmentReferences[].qualifier? | string | Bill type qualifier |
isfShipmentTypeCode? | "01" | "02" | "03" | "06" | "07" | "11" | … (11 values) | ISF shipment type |
isfSubmissionType? | string | |
isfTransactionNumber? | string | |
isfType? | "ISF10" | "ISF5" | |
isLiveEntry? | boolean | Live entry indicator |
isPostSummaryCorrection? | boolean | Post summary correction indicator |
isWeeklyRelease? | boolean | Weekly FTZ release |
lloydsCode? | string | |
locationOfGoods? | string | |
missingDocuments? | object[] | |
missingDocuments[].missingDocument? | "01" | "11" | "21" | "22" | "23" | "10" | … (15 values) | Missing Document Code |
modeOfTransportation? | "11" | "12" | "21" | "31" | "32" | "34" | … (15 values) | Mode of transportation (MOT) |
originatingFilerCode? | string | |
packagerEntity? | TradeParty | |
paymentType? | "1" | "2" | "3" | "5" | "6" | "7" | … (7 values) | Payment Type Code |
periodicStatementMonth? | number | |
pgaCorrectionMode? | boolean | |
portOfEntry? | string | |
portOfUnlading? | string | |
preliminaryStatementPrintDate? | string | |
pscOtherHeaderComments? | string | PSC Header other general comments |
pscReasonCodes? | object[] | |
pscReasonCodes[].reasonCode? | "H01" | "H02" | "H04" | "H05" | "H06" | "H07" | … (14 values) | PSC Header Reason Code |
reconciliationIssue? | "001" | "002" | "003" | "004" | "005" | "006" | … (7 values) | Reconciliation Issue Code |
referenceData? | object[] | |
referenceData[].identifier? | string | Reference data identifier |
referenceData[].qualifier? | "FTZ" | "CR " | "EN " | "IB " | "DIS" | "V1 " | … (18 values) | Reference Qualifier |
releasedOutsideTarifflo? | boolean | |
releaseEntries? | object[] | |
releaseEntries[].entryNumber? | string | number | Release entry number |
releaseEntries[].filerCode? | string | |
requestAcceleratedLiquidation? | boolean | |
sellerEntity? | TradeParty | |
shipmentUsageType? | "P" | "X" | " " | |
shipperEntity? | TradeParty | |
shipToEntity? | TradeParty | |
splitShipmentReleaseCode? | "1" | "2" | |
statementClientBranch? | string | |
stuffingLocationEntity? | TradeParty | |
tibDeclaration? | boolean | TIB declaration indicator |
tradeAgreementReconciliation? | boolean | Trade agreement reconciliation indicator |
trip? | string | Conveyance trip |
type? | "01" | "02" | "03" | "06" | "07" | "11" | … (18 values) | Entry type |
usStateOfDestinationCode? | "AL" | "AK" | "AZ" | "AR" | "CA" | "CO" | … (53 values) |
entry.lineItems[]
| Field | Type | CBP field |
|---|---|---|
adCase? | object | |
adCase.bondCashClaimCode? | "B" | "C" | |
adCase.caseNumber? | string | |
adCase.depositRate? | number | |
adCase.dutyAmount? | number | |
adCase.nonReimbursementDeclarationId? | string | |
adCase.quantity? | number | |
adCase.rateType? | "A" | "S" | |
adCase.valueOfGoodsAmount? | number | |
adCaseNonReimbursementStatement? | boolean | |
adCvdCertification? | boolean | |
adOverride? | boolean | AD Out-of-Scope Attestation |
aluminumCastCountryCode? | string | Cast Country Code |
aluminumPrimarySmeltApplicabilityCode? | "Y" | "N" | |
aluminumPrimarySmeltCountryCode? | string | Primary Smelter Country Code |
aluminumProductExclusionIdentifier? | string | Aluminum Exclusion Identifier |
aluminumSecondarySmeltApplicabilityCode? | "Y" | "N" | |
aluminumSecondarySmeltCountryCode? | string | Secondary Smelter Country Code |
articleSetIndicator? | "X" | " " | "V" | |
autoPartsOffsetLicenseNumber? | string | |
avocadoFee? | number | |
beefFee? | number | |
bifacialCertification? | boolean | 201 Bifacial Certification |
blueberryFee? | number | |
cbmaAllocationQuantity? | number | Allocation Quantity |
cbmaControlledGroupName? | string | Controlled Group Name |
cbmaFlavorContentCreditIndicator? | "Y" | "N" | |
cbmaForeignProducerIdentifier? | string | Foreign Producer Identifier |
cbmaForeignProducerName? | string | Foreign Producer Name |
cbmaRateDesignationCode? | string | |
censusWarningOverrides? | object[] | |
censusWarningOverrides[].overrideCode? | "01" | "02" | "03" | "06" | "07" | "11" | … (30 values) | Census Override Code |
censusWarningOverrides[].warningCode? | "27A" | "27P" | "27B" | "27M" | "27D" | "27F" | … (13 values) | Census Warning Code |
charges? | number | Charges Amount |
christmasTreeFee? | number | |
commercialDescription? | string | |
consigneeEntity? | TradeParty | |
consolidatorEntity? | TradeParty | |
copperMostRecentCastCountryCode? | string | Copper Country of Most Recent Cast |
copperPrimarySmeltCountryCode? | string | |
copperSecondarySmeltCountryCode? | string | |
cottonFee? | number | |
countryOfExport? | string | |
countryOfOrigin? | string | |
currency? | string | |
cvdCase? | object | |
cvdCase.bondCashClaimCode? | "B" | "C" | |
cvdCase.caseNumber? | string | |
cvdCase.depositRate? | number | |
cvdCase.dutyAmount? | number | |
cvdCase.nonReimbursementDeclarationId? | string | |
cvdCase.quantity? | number | |
cvdCase.rateType? | "A" | "S" | |
cvdCase.valueOfGoodsAmount? | number | |
cvOverride? | boolean | CVD Out-of-Scope Attestation |
dairyProductFee? | number | |
dateOfExportation? | string | |
feeExemption? | boolean | |
finalDeliveredToPartyEntity? | TradeParty | |
foreignExporterEntity? | TradeParty | |
foreignPortOfLading? | string | |
ftzLineItemQuantity? | number | |
ftzMerchandiseStatusCode? | "D" | "P" | "N" | "Z" | |
ftzPrivilegedMerchandiseFilingDate? | string | |
grossShippingWeight? | number | |
hmfFee? | number | HMF |
honeyFee? | number | |
invoices? | object[] | |
invoices[].invoiceId? | string | |
invoices[].invoiceLineRanges? | object[] | |
invoices[].invoiceLineRanges[].begin? | number | Invoice Line Range Begin |
invoices[].invoiceLineRanges[].end? | number | Invoice Line Range End |
invoices[].invoiceNumber? | string | |
invoices[].supplierIdCode? | string | |
irTaxAccountingClassCode? | "016" | "017" | "018" | "022" | |
irTaxAmount? | number | |
koreanExportSteelCertificateNumber? | string | Certificate Number |
limeFee? | number | |
lineItemIdentifier? | number | CBP line number |
mangoFee? | number | |
manufacturerEntity? | TradeParty | |
mpfFee? | number | MPF |
mushroomFee? | number | |
naftaNetCost? | boolean | |
otherRevenueAccountingClassCode? | "672" | |
otherRevenueAmount? | number | |
partNumber? | string | |
pecanFee? | number | |
permitNumber? | string | |
permitTypeCode? | "01" | "02" | "03" | "06" | "07" | "11" | … (28 values) | |
porkFee? | number | |
position? | number | |
potatoFee? | number | |
productClaimCode? | "M" | "H" | "C" | "F" | "G" | |
pscReasonCodes? | object[] | |
pscReasonCodes[].reasonCode? | "L01" | "L02" | "L03" | "L04" | "L05" | "L06" | … (31 values) | PSC Line Reason Code |
raspberryFee? | number | |
relatedParties? | boolean | |
rulingNumber? | number | |
rulingType? | "R" | "P" | "C" | |
sellerEntity? | TradeParty | |
shipToEntity? | TradeParty | |
shipToShoreCraneCertification? | boolean | |
softwoodLumberDeclarationIndicator? | "Y" | "N" | |
softwoodLumberExportCharges? | number | Export Charges |
softwoodLumberExportPrice? | number | Export Price |
softwoodLumberFee? | number | |
softwoodLumberImportCharges? | number | Import Charges |
soldToEntity? | TradeParty | |
sorghumFee? | number | |
steelMeltAndPourCountryCode? | string | Melt & Pour Country Code |
steelProductExclusionIdentifier? | string | Steel Exclusion Identifier |
stuffingLocationEntity? | TradeParty | |
sugarFee? | number | |
textileCategory? | number | |
textileDateOfExportation? | string | |
tradeAgreement? | "A" | "D" | "R" | "P" | "CA" | "CO" | … (38 values) | |
visa? | string | |
watermelonFee? | number |
entry.lineItems[].tariffRows[]
| Field | Type | CBP field |
|---|---|---|
chapter? | "ch98" | "ch99" | |
currency? | string | |
currentHTSNumber? | string | Current HTS Number |
description? | string | |
dutyAmount? | number | |
exchangeRate? | string | Rate |
fishingInfo? | object[] | |
fishingInfo[].countryOfHarvest? | "ES" | "CR" | "AL" | "AZ" | "AR" | "CA" | … (243 values) | |
fishingInfo[].methodOfHarvest? | "VESSEL" | "HCF" | "HBA" | "SVH" | |
fishingInfo[].vesselFlag? | "ES" | "CR" | "AL" | "AZ" | "AR" | "CA" | … (243 values) | |
fishingInfo[].vesselImo? | string | |
fishingInfo[].vesselName? | string | |
foreignValueOfGoods? | number | |
htsNumber? | string | |
miningInfo? | object[] | |
miningInfo[].countryOfMining? | "ES" | "CR" | "AL" | "AZ" | "AR" | "CA" | … (243 values) | |
quantity1? | number | Quantity 1 |
quantity2? | number | Quantity 2 |
quantity3? | number | Quantity 3 |
sanctionDisclaim? | boolean | |
sequence? | number | |
suppressed? | boolean | |
unitOfMeasure1? | string | Unit of Measure 1 |
unitOfMeasure2? | string | Unit of Measure 2 |
unitOfMeasure3? | string | Unit of Measure 3 |
valueOfGoodsAmount? | number |
entry.lineItems[].aacApqAvsAbs[]
| Field | Type | CBP field |
|---|---|---|
aphisCommodityAge? | string | Age |
aphisCommodityBreed? | string | Breed |
aphisCommodityColor? | string | Color |
aphisCommodityDescription? | string | Commodity Description |
aphisCommodityGender? | "M" | "S" | "U" | "N" | "F" | Gender |
aphisCommodityGestationalAge? | string | Gestational Age |
aphisCommodityPhysicalState? | "SSL" | "SEO" | "SLL" | "WIRT" | "WORT" | Physical State |
aphisCommodityPregnant? | boolean | Fertilized / Pregnant / Gestating |
aphisCommodityProductMix? | "SGL" | "MIX" | Product Mix Type |
aphisCommodityProtected? | boolean | Protected Species |
arrivalDate? | string | |
arrivalLocation? | string | |
arrivalStatus? | "A" | "P" | |
citation? | string | |
commodityCategoryCode? | "ADD" | "11" | "12" | "13" | "21" | "22" | … (278 values) | Category Code |
commodityCategoryType? | "AP0100" | "AP0200" | "AP0300" | "AP0400" | "AP0500" | "AP0600" | … (9 values) | Category Type |
commodityRouting? | object[] | |
commodityRouting[].commodityPoliticalSubunitOfRoutingName? | string | State / Province |
commodityRouting[].commodityRoutingCountryCode? | "ES" | "CR" | "AL" | "AZ" | "AR" | "CA" | … (243 values) | Routing Country |
commodityRouting[].commodityRoutingTypeCode? | "13" | "49" | "198" | Routing Type |
commonName? | string | |
consolidatorEntity? | TradeParty | |
containers? | object[] | |
containers[].containerLength? | number | Container Length (ft) |
containers[].containerNumber? | string | |
containers[].containerType? | "1" | "2" | |
correctionIndicator? | "A" | "D" | "R" | |
cropGrowerEntity? | TradeParty | |
customsBrokerEntity? | TradeParty | |
deboningOrigin? | object | |
deboningOrigin.countryCode? | "ES" | "CR" | "AL" | "AZ" | "AR" | "CA" | … (243 values) | Country |
deboningOrigin.geographicLocation? | string | State / Province |
deboningOrigin.processingDescription? | string | Treatment Notes |
deboningOrigin.processingEndDate? | string | |
deboningOrigin.processingStartDate? | string | |
deboningOrigin.processingTypeCode? | "ATR" | "AAD01" | "ACD01" | "ACGR1" | "ACH01" | "ACHW1" | … (41 values) | Treatment |
disclaimer? | "A" | "B" | |
electronicImageSubmittedFlag? | boolean | Electronic Image Submitted to DIS |
govAgencyProcessingCode? | "A01" | "A02" | "A03" | "A04" | "A05" | Processing Code |
govAgencyProgramCode? | "AAC" | "APQ" | "AVS" | "ABS" | APHIS Program Code |
growerDistributorEntity? | TradeParty | |
harvestOrigin? | object | |
harvestOrigin.countryCode? | "ES" | "CR" | "AL" | "AZ" | "AR" | "CA" | … (243 values) | Country |
harvestOrigin.geographicLocation? | string | State / Province |
harvestOrigin.processingDescription? | string | Treatment Notes |
harvestOrigin.processingEndDate? | string | |
harvestOrigin.processingStartDate? | string | |
harvestOrigin.processingTypeCode? | "ATR" | "AAD01" | "ACD01" | "ACGR1" | "ACH01" | "ACHW1" | … (41 values) | Treatment |
importerEntity? | TradeParty | |
intendedUseCode? | string | |
intendedUseDescription? | string | |
itemIdentification? | object[] | |
itemIdentification[].numbers? | object[] | |
itemIdentification[].numbers[].itemIdNumber? | string | ID Number |
itemIdentification[].qualifier? | "TO" | "NMT" | "BND" | "BRD" | "CHP" | "LAT" | … (9 values) | ID Type |
labTestReportAccessKey? | string | |
labTestReportNumber? | string | |
labTestReportUrl? | string | |
lpcoAuthorizedPartyEntity? | TradeParty | |
lpcos? | object[] | |
lpcos[].lpcoDate? | string | |
lpcos[].lpcoIssuerCountry? | "ES" | "CR" | "AL" | "AZ" | "AR" | "CA" | … (243 values) | Issuer Country |
lpcos[].lpcoIssuerRegion? | string | Issuer State / Province |
lpcos[].lpcoNumberOrName? | string | LPCO Number / Name |
lpcos[].lpcoQuantity? | number | |
lpcos[].lpcoType? | "A10" | "A11" | "A01" | "A02" | "A03" | "A05" | … (37 values) | |
lpcos[].lpcoUnitOfMeasure? | "L" | "G" | "KG" | "ML" | "NO" | |
manipulationOrigin? | object | |
manipulationOrigin.countryCode? | "ES" | "CR" | "AL" | "AZ" | "AR" | "CA" | … (243 values) | Country |
manipulationOrigin.geographicLocation? | string | State / Province |
manipulationOrigin.processingDescription? | string | Treatment Notes |
manipulationOrigin.processingEndDate? | string | |
manipulationOrigin.processingStartDate? | string | |
manipulationOrigin.processingTypeCode? | "ATR" | "AAD01" | "ACD01" | "ACGR1" | "ACH01" | "ACHW1" | … (41 values) | Treatment |
manufacturerEntity? | TradeParty | |
meatCuttingOrigin? | object | |
meatCuttingOrigin.countryCode? | "ES" | "CR" | "AL" | "AZ" | "AR" | "CA" | … (243 values) | Country |
meatCuttingOrigin.geographicLocation? | string | State / Province |
meatCuttingOrigin.processingDescription? | string | Treatment Notes |
meatCuttingOrigin.processingEndDate? | string | |
meatCuttingOrigin.processingStartDate? | string | |
meatCuttingOrigin.processingTypeCode? | "ATR" | "AAD01" | "ACD01" | "ACGR1" | "ACH01" | "ACHW1" | … (41 values) | Treatment |
offshoreGreenhouseEntity? | TradeParty | |
origins? | object[] | |
origins[].countryCode? | "ES" | "CR" | "AL" | "AZ" | "AR" | "CA" | … (243 values) | Country |
origins[].geographicLocation? | string | State / Province |
origins[].processingDescription? | string | Treatment Notes |
origins[].processingEndDate? | string | |
origins[].processingStartDate? | string | |
origins[].processingTypeCode? | "ATR" | "AAD01" | "ACD01" | "ACGR1" | "ACH01" | "ACHW1" | … (41 values) | Treatment |
origins[].sourceTypeCode? | "30" | "267" | "CDB" | "CMN" | "244" | "CPK" | … (14 values) | Source Type |
packaging? | object[] | |
packaging[].quantity? | number | |
packaging[].unitOfMeasure? | "CT" | "FL" | "M" | "T" | "BH" | "L" | … (29 values) | |
packerEntity? | TradeParty | |
packingOrigin? | object | |
packingOrigin.countryCode? | "ES" | "CR" | "AL" | "AZ" | "AR" | "CA" | … (243 values) | Country |
packingOrigin.geographicLocation? | string | State / Province |
packingOrigin.processingDescription? | string | Treatment Notes |
packingOrigin.processingEndDate? | string | |
packingOrigin.processingStartDate? | string | |
packingOrigin.processingTypeCode? | "ATR" | "AAD01" | "ACD01" | "ACGR1" | "ACH01" | "ACHW1" | … (41 values) | Treatment |
permittedDestinationEntity? | TradeParty | |
placeOfGrowth? | object | |
placeOfGrowth.countryCode? | "ES" | "CR" | "AL" | "AZ" | "AR" | "CA" | … (243 values) | Country |
placeOfGrowth.geographicLocation? | string | State / Province |
placeOfGrowth.processingDescription? | string | Treatment Notes |
placeOfGrowth.processingEndDate? | string | |
placeOfGrowth.processingStartDate? | string | |
placeOfGrowth.processingTypeCode? | "ATR" | "AAD01" | "ACD01" | "ACGR1" | "ACH01" | "ACHW1" | … (41 values) | Treatment |
placeOfPacking? | object | |
placeOfPacking.countryCode? | "ES" | "CR" | "AL" | "AZ" | "AR" | "CA" | … (243 values) | Country |
placeOfPacking.geographicLocation? | string | State / Province |
placeOfPacking.processingDescription? | string | Treatment Notes |
placeOfPacking.processingEndDate? | string | |
placeOfPacking.processingStartDate? | string | |
placeOfPacking.processingTypeCode? | "ATR" | "AAD01" | "ACD01" | "ACGR1" | "ACH01" | "ACHW1" | … (41 values) | Treatment |
processingOrigin? | object | |
processingOrigin.countryCode? | "ES" | "CR" | "AL" | "AZ" | "AR" | "CA" | … (243 values) | Country |
processingOrigin.geographicLocation? | string | State / Province |
processingOrigin.processingDescription? | string | Treatment Notes |
processingOrigin.processingEndDate? | string | |
processingOrigin.processingStartDate? | string | |
processingOrigin.processingTypeCode? | "ATR" | "AAD01" | "ACD01" | "ACGR1" | "ACH01" | "ACHW1" | … (41 values) | Treatment |
producerEntity? | TradeParty | |
productCodes? | object[] | |
productCodes[].productCodeNumber? | string | |
productCodes[].productCodeQualifier? | "AVB" | "GPC" | "SKU" | "TSN" | "UNS" | |
productionOrigin? | object | |
productionOrigin.countryCode? | "ES" | "CR" | "AL" | "AZ" | "AR" | "CA" | … (243 values) | Country |
productionOrigin.geographicLocation? | string | State / Province |
productionOrigin.processingDescription? | string | Treatment Notes |
productionOrigin.processingEndDate? | string | |
productionOrigin.processingStartDate? | string | |
productionOrigin.processingTypeCode? | "ATR" | "AAD01" | "ACD01" | "ACGR1" | "ACH01" | "ACHW1" | … (41 values) | Treatment |
remarks? | object | |
remarks.embassyRelatedToImporter? | boolean | |
remarks.embassyRelatedToImporterText? | string | Embassy Remarks |
remarks.pestEstablishment? | "A53" | "A54" | |
remarks.pestEstablishmentText? | string | Pest Establishment Remarks |
researcherEntity? | TradeParty | |
scientificGenusName? | string | |
scientificSpeciesName? | string | |
scientificSubSpeciesName? | string | Scientific Subspecies Name |
shipperEntity? | TradeParty | |
slaughterEstablishmentEntity? | TradeParty | |
slaughterOrigin? | object | |
slaughterOrigin.countryCode? | "ES" | "CR" | "AL" | "AZ" | "AR" | "CA" | … (243 values) | Country |
slaughterOrigin.geographicLocation? | string | State / Province |
slaughterOrigin.processingDescription? | string | Treatment Notes |
slaughterOrigin.processingEndDate? | string | |
slaughterOrigin.processingStartDate? | string | |
slaughterOrigin.processingTypeCode? | "ATR" | "AAD01" | "ACD01" | "ACGR1" | "ACH01" | "ACHW1" | … (41 values) | Treatment |
slicingOrigin? | object | |
slicingOrigin.countryCode? | "ES" | "CR" | "AL" | "AZ" | "AR" | "CA" | … (243 values) | Country |
slicingOrigin.geographicLocation? | string | State / Province |
slicingOrigin.processingDescription? | string | Treatment Notes |
slicingOrigin.processingEndDate? | string | |
slicingOrigin.processingStartDate? | string | |
slicingOrigin.processingTypeCode? | "ATR" | "AAD01" | "ACD01" | "ACGR1" | "ACH01" | "ACHW1" | … (41 values) | Treatment |
sourceOrigin? | object | |
sourceOrigin.countryCode? | "ES" | "CR" | "AL" | "AZ" | "AR" | "CA" | … (243 values) | Country |
sourceOrigin.geographicLocation? | string | State / Province |
sourceOrigin.processingDescription? | string | Treatment Notes |
sourceOrigin.processingEndDate? | string | |
sourceOrigin.processingStartDate? | string | |
sourceOrigin.processingTypeCode? | "ATR" | "AAD01" | "ACD01" | "ACGR1" | "ACH01" | "ACHW1" | … (41 values) | Treatment |
speciesOrigin? | object | |
speciesOrigin.countryCode? | "ES" | "CR" | "AL" | "AZ" | "AR" | "CA" | … (243 values) | Country |
speciesOrigin.geographicLocation? | string | State / Province |
speciesOrigin.processingDescription? | string | Treatment Notes |
speciesOrigin.processingEndDate? | string | |
speciesOrigin.processingStartDate? | string | |
speciesOrigin.processingTypeCode? | "ATR" | "AAD01" | "ACD01" | "ACGR1" | "ACH01" | "ACHW1" | … (41 values) | Treatment |
storageOrigin? | object | |
storageOrigin.countryCode? | "ES" | "CR" | "AL" | "AZ" | "AR" | "CA" | … (243 values) | Country |
storageOrigin.geographicLocation? | string | State / Province |
storageOrigin.processingDescription? | string | Treatment Notes |
storageOrigin.processingEndDate? | string | |
storageOrigin.processingStartDate? | string | |
storageOrigin.processingTypeCode? | "ATR" | "AAD01" | "ACD01" | "ACGR1" | "ACH01" | "ACHW1" | … (41 values) | Treatment |
ultimateConsigneeEntity? | TradeParty |
entry.lineItems[].apl[]
| Field | Type | CBP field |
|---|---|---|
constituents? | object[] | |
constituents[].constituentName? | string | Constituent Element Name |
constituents[].countriesOfHarvest? | object[] | |
constituents[].countriesOfHarvest[].countryCode? | string | Country of Harvest |
constituents[].percentOfConstituentElement? | number | |
constituents[].pg29GrossQuantity? | number | |
constituents[].pg29UnitOfMeasure? | "M" | "L" | "G" | "CG" | "CM" | "KG" | … (16 values) | |
constituents[].quantity? | number | Quantity of Constituent Element |
constituents[].species? | object[] | |
constituents[].species[].scientificGenusName? | string | |
constituents[].species[].scientificSpeciesName? | string | |
constituents[].unitOfMeasure? | "M" | "L" | "G" | "CG" | "CM" | "KG" | … (16 values) | |
constituents[].unknownSourceOrSpecies? | boolean | |
containers? | object[] | |
containers[].containerNumber1? | string | Container Number 1 |
containers[].containerNumber2? | string | Container Number 2 |
containers[].containerNumber3? | string | Container Number 3 |
correctionIndicator? | "A" | "D" | "R" | |
customsBrokerEntity? | TradeParty | |
dateOfSignature? | string | |
disclaimer? | "A" | "D" | "B" | "C" | "G" | |
importerEntity? | TradeParty | |
pgaLineDescription? | string | |
pgaLineValue? | number |
entry.lineItems[].biologics[]
| Field | Type | CBP field |
|---|---|---|
brandName? | string | |
containerNumbers? | object[] | |
containerNumbers[].containerNumber? | string | |
correctionIndicator? | "A" | "D" | "R" | |
deliveredToEntity? | TradeParty | |
disclaimer? | "A" | "F" | |
fdaImporterEntity? | TradeParty | |
govAgencyProcessingCode? | "ALG" | "BLO" | "HCT" | "VAC" | "XEN" | "BDP" | … (10 values) | Processing Code |
intendedUseCode? | "080.000" | "082.000" | "110.000" | "150.007" | "155.000" | "170.000" | … (14 values) | |
lotNumbers? | object[] | |
lotNumbers[].lotNumber? | string | |
manufacturerEntity? | TradeParty | |
pg04? | object[] | |
pg04[].constituentActiveIngredient? | boolean | Active Ingredient |
pg04[].constituentName? | string | |
pg04[].constituentPercentage? | number | |
pg04[].constituentQuantity? | number | |
pg04[].constituentUnitOfMeasure? | string | Unit of Measure |
pg06? | object[] | |
pg06[].countryCode? | string | |
pg06[].sourceTypeCode? | "30" | "39" | "294" | |
pg23? | object[] | |
pg23[].affirmationOfComplianceCode? | "HCT" | "STN" | "BLN" | "CPT" | "DA" | "DLS" | … (10 values) | AoC Code |
pg23[].affirmationOfComplianceQualifier? | string | AoC Qualifier |
pg26? | object[] | |
pg26[].packagingQualifier? | number | Packaging Level |
pg26[].quantity? | number | Packaging Quantity |
pg26[].unitOfMeasure? | string | Packaging Unit of Measure |
pg30? | object[] | |
pg30[].anticipatedArrivalInfo? | "A" | "F" | Arrival Info Type |
pg30[].arrivalDate? | string | |
pg30[].arrivalTime? | string | |
pg30[].inspectionOrArrivalLocation? | string | FIRMS Code |
pg30[].inspectionOrArrivalLocationCode? | string | Location Code |
pgaLineValue? | number | |
pointOfContactEntity? | TradeParty | |
productCodeNumber? | string | FDA Product Code |
productDescription? | string | |
remarksText? | string | Remarks |
shipperEntity? | TradeParty | |
temperatureQualifier? | "A" | "D" | "R" | "P" | "H" | "U" | … (7 values) |
entry.lineItems[].cosmeticMedicalRadiation[]
| Field | Type | CBP field |
|---|---|---|
affirmations? | object[] | |
affirmations[].code? | string | AoC Code |
affirmations[].qualifier? | string | AoC Qualifier |
arrivalDate? | string | |
arrivalLocation? | string | |
arrivalTime? | string | Anticipated Arrival Time |
brandName? | string | Trade/Brand Name |
containers? | object[] | |
containers[].containerNumber? | string | |
correctionIndicator? | "A" | "D" | "R" | |
deliveredToEntity? | TradeParty | |
disclaimer? | "A" | "F" | |
fdaImporterEntity? | TradeParty | |
govAgencyProcessingCode? | "RED" | "NED" | "REP" | Processing Code |
govAgencyProgramCode? | "COS" | "DEV" | "RAD" | FDA Program Code |
intendedUseCode? | "980.000" | "081.001" | "081.002" | "081.003" | "081.004" | "081.005" | … (30 values) | |
lotNumbers? | object[] | |
lotNumbers[].lotNumber? | string | |
manufacturerEntity? | TradeParty | |
packaging? | object[] | |
packaging[].quantity? | number | |
packaging[].unitOfMeasure? | "CR" | "CA" | "CO" | "CT" | "FL" | "IN" | … (198 values) | |
pointOfContactEntity? | TradeParty | |
productCodeNumber? | string | FDA Product Code |
productDescription? | string | |
remarksText? | string | Remarks |
shipperEntity? | TradeParty | |
sources? | object[] | |
sources[].countryCode? | string | |
sources[].sourceTypeCode? | "30" | "39" | "294" | |
temperatureQualifier? | "A" | "D" | "R" | "P" | "H" | "U" | … (7 values) |
entry.lineItems[].dea[]
| Field | Type |
|---|---|
arrivalDate? | string |
authorizedPartyEntity? | TradeParty |
countryOfShipment? | "ES" | "CR" | "AL" | "AZ" | "AR" | "CA" | … (243 values) |
disclaimer? | "A" |
documentIdentifier? | "911" | "921" | "922" | "923" |
lpcoNumber? | string |
substances? | object[] |
substances[].baseWeight? | number |
substances[].drugCode? | string |
substances[].unitOfMeasure? | "G" | "KG" | "MG" | "MCG" |
entry.lineItems[].drugs[]
| Field | Type | CBP field |
|---|---|---|
affirmations? | object[] | |
affirmations[].code? | "DA" | "DLS" | "ERR" | "FSR" | "IDE" | "IFE" | … (12 values) | AoC Code |
affirmations[].qualifier? | string | AoC Qualifier |
apiProducerEntity? | TradeParty | |
arrivalInfo? | object[] | |
arrivalInfo[].arrivalDate? | string | |
arrivalInfo[].arrivalTime? | string | |
arrivalInfo[].inspectionLocation? | string | FIRMS Code |
arrivalInfo[].inspectionLocationCode? | string | Location Code |
arrivalInfo[].statusCode? | "A" | "F" | Arrival Status Code |
brandName? | string | |
constituentElements? | object[] | |
constituentElements[].isActiveIngredient? | boolean | Active Ingredient |
constituentElements[].name? | string | Constituent Name |
constituentElements[].percentage? | number | Constituent Percentage |
constituentElements[].quantity? | number | Constituent Quantity |
constituentElements[].unitOfMeasure? | string | Constituent UoM |
correctionIndicator? | "A" | "D" | "R" | |
deliveredToEntity? | TradeParty | |
disclaimer? | "A" | "F" | |
fdaImporterEntity? | TradeParty | |
intendedUseCode? | "980.000" | "080.012" | "100.000" | "110.000" | "130.000" | "130.033" | … (16 values) | |
lotDetails? | object[] | |
lotDetails[].lineValue? | number | |
lotDetails[].lotNumber? | string | |
lotDetails[].productionEndDate? | string | |
lotDetails[].productionStartDate? | string | |
lotDetails[].temperatureQualifier? | "A" | "D" | "R" | "P" | "H" | "U" | … (7 values) | |
manufacturerEntity? | TradeParty | |
packaging? | object[] | |
packaging[].packagingQualifier? | number | Packaging Level |
packaging[].quantity? | number | |
packaging[].unitOfMeasure? | string | Packaging UoM |
pointOfContactEntity? | TradeParty | |
processingCode? | "PRE" | "INV" | "RND" | "PHN" | "OTC" | "804" | |
productCodeNumber? | string | |
productDescription? | string | |
remarksText? | string | Remarks |
shipperEntity? | TradeParty | |
sourceCountries? | object[] | |
sourceCountries[].countryCode? | string | |
sourceCountries[].sourceTypeCode? | "30" | "39" | "294" | |
sponsorEntity? | TradeParty |
entry.lineItems[].egMOORPN[]
| Field | Type | CBP field |
|---|---|---|
applicantEntity? | TradeParty | |
containers? | object[] | |
containers[].containerLength1? | number | Container Length |
containers[].containerNumber1? | string | Container Number 1 |
containers[].containerNumber2? | string | Container Number 2 |
containers[].containerNumber3? | string | Container Number 3 |
containers[].containerType1? | "1" | "2" | Container Type |
customsBrokerEntity? | TradeParty | |
declarationCode? | "AM4" | |
description? | string | Commercial Description |
disclaimer? | "A" | |
electronicImageSubmittedFlag? | boolean | Electronic Image Submitted |
globalProductIdCode? | string | |
globalProductIdQualifier? | "AI" | "SRV" | |
goodsCustodianEntity? | TradeParty | |
govAgencyProcessingCode? | "1" | "2" | "3" | "5" | "6" | "7" | … (8 values) | Processing Code |
govAgencyProgramCode? | "MO" | "OR" | "EG" | "PN" | AMS Program Code |
importerEntity? | TradeParty | |
inspectionRecords? | object[] | |
inspectionRecords[].date? | string | |
inspectionRecords[].dateQualifier? | "A" | "I" | |
inspectionRecords[].inspectionRemark? | string | |
inspectionRecords[].time? | string | Inspection Time |
intendedUseCode? | string | |
intendedUseDescription? | string | |
locationOfGoodsEntity? | TradeParty | |
lotNumbers? | object[] | |
lotNumbers[].lotNumber? | string | |
lotNumbers[].lotNumberQualifier? | "4" | |
lpcoIssuer? | string | LPCO Issuer Name |
lpcoIssuerGeoQualifier? | "MS" | "PR" | "US" | "ISO" | "EU" | LPCO Issuer Geographic Qualifier |
lpcoIssuerLocation? | string | LPCO Issuer Location Code |
lpcoRecords? | object[] | |
lpcoRecords[].lpcoDate? | string | |
lpcoRecords[].lpcoDateQualifier? | "1" | "2" | "3" | "4" | |
lpcoRecords[].lpcoNumber? | string | |
lpcoRecords[].lpcoQuantity? | number | |
lpcoRecords[].lpcoTransactionType? | "1" | "2" | "3" | |
lpcoRecords[].lpcoType? | "AM1" | "AM2" | "AM3" | "AM6" | "AM7" | "AM9" | |
lpcoRecords[].lpcoUnitOfMeasure? | string | |
netQuantity? | number | |
netUnitOfMeasure? | string | Net Weight Unit of Measure |
packaging? | object[] | |
packaging[].packageIdentifier? | string | |
packaging[].packagingQualifier? | "1" | "2" | "3" | "5" | "6" | "4" | |
packaging[].quantity? | number | Packaging Quantity |
packaging[].unitOfMeasure? | string | |
productCodeNumber? | string | UNSPSC Product Code |
remarks? | object[] | |
remarks[].remarksCode? | "A10" | "A11" | Organic Standard |
remarks[].remarksText? | string | |
remarks[].remarksTypeCode? | "AM1" |
entry.lineItems[].foodCombined[]
| Field | Type | CBP field |
|---|---|---|
arrivalDate? | string | |
arrivalLocation? | string | Port of Arrival |
arrivalTime? | string | |
brandName? | string | |
canDimension1? | number | Container Dimension 1 |
canDimension2? | number | Container Dimension 2 |
canDimension3? | number | Container Dimension 3 |
commodityCharacteristicDescription? | string | Product Description |
correctionIndicator? | "A" | "D" | "R" | |
countriesOfRefusal? | object[] | |
countriesOfRefusal[].countryCode? | "ES" | "CR" | "AL" | "AZ" | "AR" | "CA" | … (243 values) | |
countryOfProduction? | "ES" | "CR" | "AL" | "AZ" | "AR" | "CA" | … (243 values) | Country of Production / Place of Growth |
countryOfShipment? | "ES" | "CR" | "AL" | "AZ" | "AR" | "CA" | … (243 values) | |
dfiEntity? | TradeParty | |
disclaimer? | "A" | "F" | |
fdaFoodCombinedPG13PG14? | object[] | |
fdaFoodCombinedPG13PG14[].locationOfLPCOIssuer? | string | Location of Issuer |
fdaFoodCombinedPG13PG14[].lpcoIssuerGovGeographicCodeQualifier? | "MS" | "PR" | "US" | "ISO" | Geographic Code Qualifier |
fdaFoodCombinedPG13PG14[].lpcoNumberOrName? | string | License Plate Number |
fdaFoodCombinedPG13PG14[].regionalDescriptionLocationOfLPCOIssuerAgency? | string | Regional Description |
fdaFoodCombinedPG23? | object[] | |
fdaFoodCombinedPG23[].affirmationOfComplianceCode? | "FTZ" | "SE" | "FCC" | "COS" | "DEV" | "VIN" | … (87 values) | AoC Code |
fdaFoodCombinedPG23[].affirmationOfComplianceQualifier? | string | AoC Qualifier |
fdaFoodCombinedPG25? | object[] | |
fdaFoodCombinedPG25[].lot? | string | Lot Number |
fdaFoodCombinedPG26? | object[] | |
fdaFoodCombinedPG26[].quantity? | number | |
fdaFoodCombinedPG26[].unitOfMeasure? | "CR" | "CA" | "CO" | "CT" | "FL" | "IN" | … (198 values) | |
fdaFoodCombinedPG27? | object[] | |
fdaFoodCombinedPG27[].containerNumber? | string | |
fdaImporterEntity? | TradeParty | |
fdcEntity? | TradeParty | |
foreignSupplierEntity? | TradeParty | |
govAgencyProcessingCode? | "ADD" | "PRO" | "DSU" | "FEE" | "NSF" | Processing Code |
intendedUseCode? | "210.000" | "015.000" | "260.000" | |
mfEntity? | TradeParty | |
ownerEntity? | TradeParty | |
pnsEntity? | TradeParty | |
pntEntity? | TradeParty | |
pointOfContactEntity? | TradeParty | |
productCodeNumber? | string | FDA Product Code |
remarksText? | string | Remarks |
secureHoldingFacilityEntity? | TradeParty | |
shipperEntity? | TradeParty | |
temperatureQualifier? | "A" | "D" | "R" | "P" | "H" | "U" | … (7 values) | |
trackingNumber? | string | |
trackingNumberCode? | string | |
ultimateConsigneeEntity? | TradeParty |
entry.lineItems[].foodNonPN[]
| Field | Type | CBP field |
|---|---|---|
arrivalDate? | string | |
arrivalLocation? | string | FIRMS Code |
arrivalTime? | string | |
brandName? | string | |
canDimensions1? | number | Can Dimensions 1 |
canDimensions2? | number | Can Dimensions 2 |
canDimensions3? | number | Can Dimensions 3 |
commodityCharacteristicDescription? | string | |
countriesOfRefusal? | object[] | |
countriesOfRefusal[].countryCode? | "ES" | "CR" | "AL" | "AZ" | "AR" | "CA" | … (243 values) | |
countryOfProduction? | "ES" | "CR" | "AL" | "AZ" | "AR" | "CA" | … (243 values) | Country of Production / Place of Growth |
deliveredToPartyEntity? | TradeParty | |
disclaimer? | "A" | "D" | "B" | "E" | "C" | "F" | … (7 values) | |
fdaFoodNonPNPG23? | object[] | |
fdaFoodNonPNPG23[].affirmationOfComplianceCode? | "FTZ" | "SE" | "FCC" | "COS" | "DEV" | "VIN" | … (87 values) | |
fdaFoodNonPNPG23[].affirmationOfComplianceDescription? | string | |
fdaFoodNonPNPG25? | object[] | |
fdaFoodNonPNPG25[].lot? | string | |
fdaFoodNonPNPG26? | object[] | |
fdaFoodNonPNPG26[].quantity? | number | |
fdaFoodNonPNPG26[].unitOfMeasure? | "CR" | "CA" | "CO" | "CT" | "FL" | "IN" | … (198 values) | |
fdaFoodNonPNPG27? | object[] | |
fdaFoodNonPNPG27[].containerNumber? | string | |
fdaImporterEntity? | TradeParty | |
foreignSupplierEntity? | TradeParty | |
govAgencyProcessingCode? | "ADD" | "1" | "2" | "3" | "5" | "6" | … (77 values) | Government Agency Processing Code |
intendedUseCode? | "210.000" | "980.000" | "015.000" | "130.029" | "260.000" | "970.000" | |
lineValue? | number | |
mfEntity? | TradeParty | |
pncNumber? | string | |
pointOfContactEntity? | TradeParty | |
productCodeNumber? | string | |
remarksText? | string | |
shipperEntity? | TradeParty | |
temperatureQualifier? | "A" | "D" | "R" | "P" | "H" | "U" | … (7 values) | Temperature Category |
entry.lineItems[].fsi[]
| Field | Type | CBP field |
|---|---|---|
categoryCode? | "11" | "12" | "13" | "21" | "22" | "23" | … (29 values) | Product Species |
certifyingIndividualEntity? | TradeParty | |
commodityCharacteristicQualifier? | string | Commodity Characteristic |
commodityGrossQuantity? | number | |
commodityNetQuantity? | number | |
commodityQualifierCode? | "FRE" | "FRZ" | "RPNI" | "RPI" | "TPCS" | "NHTS" | … (11 values) | Commodity Qualifier |
consigneeEntity? | TradeParty | |
correctionIndicator? | "A" | "D" | "R" | |
customsBrokerEntity? | TradeParty | |
disclaimer? | "A" | "D" | "B" | "E" | "C" | "F" | … (7 values) | |
electronicImageSubmittedFlag? | boolean | Electronic Image Submitted |
exportingEstablishmentEntity? | TradeParty | |
fsiLPCO? | object[] | |
fsiLPCO[].lpcoNumber? | string | |
fsiLPCO[].lpcoTypeCode? | "FS1" | "FS2" | "FS3" | "FS4" | "FS6" | "FS7" | … (9 values) | LPCO Type |
fsiPG22? | object[] | |
fsiPG22[].dateOfSignature? | string | |
fsiPG22[].declarationCode? | "FS2" | "FS3" | |
fsiPG22[].documentIdentifier? | "956" | |
fsiPG25? | object[] | |
fsiPG25[].actualTemperature? | number | |
fsiPG25[].degreeType? | string | |
fsiPG25[].lotNumber? | string | |
fsiPG25[].pgaLineValue? | number | |
fsiPG25[].productionEndDate? | string | |
fsiPG25[].productionStartDate? | string | |
fsiPG25[].temperatureQualifier? | string | |
fsiPG26? | object[] | |
fsiPG26[].packageIdentifier? | string | |
fsiPG26[].packagingQualifier? | "1" | "2" | Packaging Level |
fsiPG26[].quantity? | number | |
fsiPG26[].unitOfMeasure? | string | |
importerEntity? | TradeParty | |
inspectionDate? | string | |
inspectionLocation? | string | |
inspectionLocationCode? | "11" | "12" | "13" | "10" | "1" | "2" | … (12 values) | |
inspectionStatusCode? | "A" | "R" | "P" | "I" | "S" | "L" | … (7 values) | Inspection Status |
producingEstablishmentEntity? | TradeParty | |
sourceEstablishmentEntity? | TradeParty | |
unitOfMeasureGross? | string | Gross Unit of Measure |
unitOfMeasureNet? | string | Net Unit of Measure |
entry.lineItems[].fws[]
| Field | Type | CBP field |
|---|---|---|
arrivalDate? | string | |
cartonsContainingWildlife? | number | |
commodityNetQuantity? | number | Net Quantity |
commonNameGeneral? | string | |
commonNameSpecific? | string | |
customsBrokerEntity? | TradeParty | |
disclaimer? | "D" | "E" | "C" | |
electronicImageSubmittedFlag? | boolean | Electronic Image Submitted |
foreignExporterEntity? | TradeParty | |
fwsDescriptionCode? | string | |
fwsImporterEntity? | TradeParty | |
fwsLPCO? | object[] | |
fwsLPCO[].lpcoNumber? | string | |
fwsLPCO[].lpcoType? | "DPE" | "FWL" | "FWU" | "FWF" | "FWC" | "FWP" | |
inspectionLocation? | string | |
intendedUseCode? | "010.000" | "020.001" | "035.001" | "100.007" | "100.008" | "110.001" | … (22 values) | |
liveVenomousWildlifeCode? | boolean | Live Venomous Wildlife |
markingLabelingInfo? | string | Marking/Labeling Information |
pgaLineValue? | number | |
processingCode? | "EDS" | "LDS" | |
scientificGenusName? | string | |
scientificSpeciesName? | string | |
scientificSubSpeciesName? | string | |
sourceCode? | "D" | "R" | "X" | "I" | "C" | "W" | … (9 values) | Animal Source Code |
speciesCountryOfOrigin? | string | |
unitOfMeasure? | "M" | "L" | "G" | "CM" | "KG" | "MG" | … (12 values) |
entry.lineItems[].hfc[]
| Field | Type | CBP field |
|---|---|---|
certifyingIndividualEntity? | TradeParty | |
commodityNetQuantityPGANet? | number | Commodity Net Quantity |
consigneeEntity? | TradeParty | |
correctionIndicator? | "A" | "D" | "R" | |
disclaimer? | "A" | |
electronicImageSubmittedFlag? | boolean | Electronic Image Submitted |
hfcPG02? | object[] | |
hfcPG02[].constituentElementName? | string | |
hfcPG02[].itemType? | "P" | "C" | |
hfcPG02[].percentOfConstituentElement? | number | |
hfcPG02[].productCodeNumber? | string | |
hfcPG02[].productCodeQualifier? | "CAS" | |
hfcPG22? | object[] | |
hfcPG22[].declarationCertification? | boolean | |
hfcPG22[].declarationCode? | "EP4" | |
hfcPG22[].entityRoleCode? | "CI" | |
hfcPG27? | object[] | |
hfcPG27[].containerNumber1? | string | Container Number 1 |
hfcPG27[].containerNumber2? | string | Container Number 2 |
hfcPG27[].containerNumber3? | string | Container Number 3 |
hfcPG55? | object[] | |
hfcPG55[].entityRoleCode? | "CI" | PG55 Entity Role Code |
importerEntity? | TradeParty | |
itemIdNumber? | string | ASHRAE Number |
entry.lineItems[].hms[]
| Field | Type | CBP field |
|---|---|---|
correctionIndicator? | "A" | "D" | "R" | |
customsBrokerEntity? | TradeParty | |
disclaimer? | "A" | "D" | "B" | "C" | |
electronicImageSubmittedFlag? | boolean | Electronic Image Submitted |
exporterEntity? | TradeParty | |
grossQuantity? | number | |
grossUnitOfMeasure? | string | |
importerEntity? | TradeParty | |
netQuantity? | number | |
netUnitOfMeasure? | string | |
pg05pg06? | object[] | |
pg05pg06[].countryCode? | string | |
pg05pg06[].geographicLocation? | string | |
pg05pg06[].processingDescription? | string | |
pg05pg06[].processingEndDate? | string | |
pg05pg06[].processingStartDate? | string | |
pg05pg06[].processingTypeCode? | "TN" | "BB" | "GN" | "PL" | "TL" | "AM1" | … (87 values) | Fishing Gear Type |
pg05pg06[].scientificGenusName? | string | |
pg05pg06[].scientificSpeciesCode? | string | |
pg05pg06[].scientificSpeciesName? | string | |
pg05pg06[].scientificSubSpeciesName? | string | |
pg05pg06[].sourceTypeCode? | "30" | "HCF" | "HBA" | "SVH" | "267" | "268" | … (21 values) | |
pg14? | object[] | |
pg14[].lpcoDate? | string | |
pg14[].lpcoDateQualifier? | "1" | "2" | "3" | "4" | |
pg14[].lpcoNumberOrName? | string | |
pg14[].lpcoQuantity? | number | |
pg14[].lpcoTransactionType? | "1" | "2" | "3" | |
pg14[].lpcoType? | "EXP" | "TZ1" | "TZ3" | "TZ4" | "TZ5" | "AM1" | … (105 values) | |
pg14[].lpcoUnitOfMeasure? | string | |
pg22? | object[] | |
pg22[].complianceDescription? | string | |
pg22[].conformanceDeclaration? | string | |
pg22[].dateOfSignature? | string | |
pg22[].declarationCode? | "COA1" | |
pg22[].documentIdentifier? | "877" | "878" | "879" | "880" | "881" | "882" | … (17 values) | |
pg22[].importersSubstantiatingSignedDocumentConfirmationLetter? | boolean | Importer's Substantiating Document on File |
pg22[].invoiceNumber? | string | |
pg31? | object[] | |
pg31[].commodityHarvestingVesselCharacteristic? | string | Vessel Characteristic Value |
pg31[].commodityHarvestingVesselCharacteristicTypeCode? | "OTH" | "PMT" | "NRN" | "IMO" | "LRN" | "CAT" | … (15 values) | Vessel Characteristic Type |
pg31[].harvestedCommodityNetWeight? | number | |
pg31[].unitOfMeasureConveyance? | string | |
pg32? | object[] | |
pg32[].commodityPoliticalSubunitOfRoutingName? | string | Subunit Name |
pg32[].commodityPoliticalSubunitOfRoutingNumber? | string | Subunit Number |
pg32[].commodityPoliticalSubunitOfRoutingQualifier? | "1" | "2" | Subunit Qualifier |
pg32[].commodityRoutingCountryCode? | "ES" | "CR" | "AL" | "AZ" | "AR" | "CA" | … (243 values) | Routing Country Code |
pg32[].commodityRoutingTypeCode? | "11" | "13" | "49" | "198" | Routing Type Code |
pg33? | object[] | |
pg33[].geographicAreaCode? | "A" | "WA" | "NP" | "GM" | "OTH" | "CAR" | … (17 values) | |
pg33[].geographicAreaName? | string | |
productCategoryCode? | "NDR" | "NFL" | "NGG" | "NOT" | "NRD" | "NST" | … (8 values) |
entry.lineItems[].nhtsa[]
| Field | Type | CBP field |
|---|---|---|
certifyingIndividualEntity? | TradeParty | |
consigneeEntity? | TradeParty | |
customsBrokerEntity? | TradeParty | |
disclaimer? | "A" | |
fabricatingMfrEntity? | TradeParty | |
govAgencyProgramCode? | "MVS" | "REI" | "TPE" | "OEI" | "OFF" | Government Agency Program Code |
hs7Box? | "11" | "12" | "13" | "10" | "1" | "3" | … (14 values) | HS-7 Box |
hs7DocDeclarationForm? | object | |
hs7DocDeclarationForm.dateOfSignature? | string | |
hs7DocDeclarationForm.entityRoleCode? | "CI" | "CN" | "FM" | "RD" | "CB" | "IM" | … (8 values) | |
hs7DocDotBond? | object | |
hs7DocDotBond.dateOfSignature? | string | |
hs7DocDotBond.entityRoleCode? | "CI" | "CN" | "FM" | "RD" | "CB" | "IM" | … (8 values) | |
hs7DocEquipmentMfrStatement? | object | |
hs7DocEquipmentMfrStatement.dateOfSignature? | string | |
hs7DocEquipmentMfrStatement.entityRoleCode? | "CI" | "CN" | "FM" | "RD" | "CB" | "IM" | … (8 values) | |
hs7DocIncompleteVehicleDoc? | object | |
hs7DocIncompleteVehicleDoc.dateOfSignature? | string | |
hs7DocIncompleteVehicleDoc.entityRoleCode? | "CI" | "CN" | "FM" | "RD" | "CB" | "IM" | … (8 values) | |
hs7DocMfrComplianceLetter? | object | |
hs7DocMfrComplianceLetter.dateOfSignature? | string | |
hs7DocMfrComplianceLetter.entityRoleCode? | "CI" | "CN" | "FM" | "RD" | "CB" | "IM" | … (8 values) | |
hs7DocOfficialOrders? | object | |
hs7DocOfficialOrders.dateOfSignature? | string | |
hs7DocOfficialOrders.entityRoleCode? | "CI" | "CN" | "FM" | "RD" | "CB" | "IM" | … (8 values) | |
hs7DocRegisteredImporterContract? | object | |
hs7DocRegisteredImporterContract.dateOfSignature? | string | |
hs7DocRegisteredImporterContract.entityRoleCode? | "CI" | "CN" | "FM" | "RD" | "CB" | "IM" | … (8 values) | |
hs7DocSubstantiatingStatement? | object | |
hs7DocSubstantiatingStatement.dateOfSignature? | string | |
hs7DocSubstantiatingStatement.entityRoleCode? | "CI" | "CN" | "FM" | "RD" | "CB" | "IM" | … (8 values) | |
importerEntity? | TradeParty | |
intendedUseCode? | "090.001" | "090.002" | "100.009" | "100.010" | "130.018" | "130.019" | … (8 values) | |
intendedUseDescription? | string | |
lpcoPermissionLetter? | object | |
lpcoPermissionLetter.date? | string | |
lpcoPermissionLetter.numberOrName? | string | |
lpcoPermissionLetter.quantity? | number | |
lpcoRegisteredImporter? | object | |
lpcoRegisteredImporter.date? | string | |
lpcoRegisteredImporter.numberOrName? | string | |
lpcoVehicleEligibility? | object | |
lpcoVehicleEligibility.date? | string | |
lpcoVehicleEligibility.numberOrName? | string | |
nhtsaPG24? | object | |
nhtsaPG24.embassyCountry? | "ES" | "CR" | "AL" | "AZ" | "AR" | "CA" | … (243 values) | |
nhtsaPG34? | object | |
nhtsaPG34.countryOfPassport? | "ES" | "CR" | "AL" | "AZ" | "AR" | "CA" | … (243 values) | |
nhtsaPG34.passportNumber? | string | |
nhtsaPG35? | object | |
nhtsaPG35.bondAmount? | number | |
nhtsaPG35.bondSerialNumber? | string | |
nhtsaPG35.suretyCode? | string | |
originalVehicleMfrEntity? | TradeParty | |
ownerEntity? | TradeParty | |
products? | object[] | |
products[].categoryCode? | "MVS1" | "MVS2" | "MVS3" | "MVS4" | "MVS5" | "MVS6" | … (42 values) | |
products[].categoryTypeCode? | "MVSTYP" | "REITYP" | "TPETYP" | "OEITYP" | "OFFTYP" | |
products[].driveSide? | "R" | "L" | "N" | |
products[].itemIdNumberQualifier? | "MN" | "SE" | "AKG" | "ENN" | |
products[].itemIdNumbers? | object[] | |
products[].itemIdNumbers[].itemIdNumber? | string | |
products[].make? | string | |
products[].manufactureMonthAndYear? | string | |
products[].model? | string | |
products[].modelYear? | string | |
retailerDistributorEntity? | TradeParty |
entry.lineItems[].nmfAmr[]
| Field | Type | CBP field |
|---|---|---|
correctionIndicator? | "A" | "D" | "R" | |
customsBrokerEntity? | TradeParty | |
disclaimer? | "A" | "D" | "B" | "C" | |
documentIdentifier? | "888" | "889" | "893" | |
documentNumber? | string | |
electronicImageSubmittedFlag? | boolean | Electronic Image Submitted |
exporterEntity? | TradeParty | |
geographicAreaCode? | string | |
geographicAreaName? | string | |
importerEntity? | TradeParty | |
lpcoNumber? | string | |
lpcoTransactionType? | "1" | "2" | "3" | |
lpcoTypeCode? | "NM4" | "NM6" | "NM2" | |
netQuantity? | number | |
netWeightUom? | string | |
processingCode? | "FRE" | "FRZ" | |
processingEndDate? | string | |
processingStartDate? | string | |
productCategoryCode? | "NDR" | "NFL" | "NGG" | "NOT" | "NRD" | "NST" | … (7 values) | |
sourceCountryCode? | "ES" | "CR" | "AL" | "AZ" | "AR" | "CA" | … (243 values) | |
sourceGeographicLocation? | string | |
sourceTypeCode? | "HCF" | "HBA" | "SVH" | "268" | "CPK" | "CPR" | … (9 values) | |
speciesCode? | string | |
vesselCharacteristics? | object[] | |
vesselCharacteristics[].characteristicTypeCode? | "NAM" | "OTH" | "PMT" | "FLG" | "NRN" | "IMO" | … (14 values) | Vessel Characteristic Type |
vesselCharacteristics[].characteristicValue? | string | Vessel Characteristic Value |
entry.lineItems[].nmfSection370[]
| Field | Type | CBP field |
|---|---|---|
correctionIndicator? | "A" | "D" | "R" | |
countryCode? | string | |
disclaimer? | "A" | "D" | "B" | "C" | |
documents? | object[] | |
documents[].dateOfSignature? | string | |
documents[].documentIdentifier? | "877" | "897" | "898" | "899" | |
documents[].invoiceNumber? | string | |
electronicImageSubmittedFlag? | boolean | Electronic Image Submitted |
fishingMethodCode? | "TN" | "BB" | "GN" | "PL" | "TL" | "TRA" | … (35 values) | |
processingCode? | "NOT" | "YFT" | |
processingEndDate? | string | |
processingStartDate? | string | |
productCategoryCode? | "NDR" | "NFL" | "NGG" | "NOT" | "NRD" | "NST" | … (8 values) | |
scientificSpeciesCode? | string | |
sourceTypeCode? | "30" | "HCF" | "HBA" | "SVH" | "268" | "CPR" | … (9 values) | |
vesselCharacteristics? | object[] | |
vesselCharacteristics[].characteristicTypeCode? | "OTH" | "PMT" | "NRN" | "IMO" | "LRN" | "CAT" | … (14 values) | Vessel Characteristic Type Code |
vesselCharacteristics[].characteristicValue? | string | Vessel Characteristic Value |
entry.lineItems[].nmfSim[]
| Field | Type | CBP field |
|---|---|---|
correctionIndicator? | "A" | "D" | "R" | |
customsBrokerEntity? | TradeParty | |
disclaimer? | "A" | "D" | "B" | "C" | |
electronicImageSubmittedFlag? | boolean | Electronic Image Submitted |
exporterEntity? | TradeParty | |
grossQuantity? | number | |
grossUnitOfMeasure? | string | |
importerEntity? | TradeParty | |
netQuantity? | number | |
netUnitOfMeasure? | string | |
pg05pg06? | object[] | |
pg05pg06[].countryCode? | string | |
pg05pg06[].geographicLocation? | string | |
pg05pg06[].processingDescription? | string | |
pg05pg06[].processingEndDate? | string | |
pg05pg06[].processingStartDate? | string | |
pg05pg06[].processingTypeCode? | "TN" | "BB" | "GN" | "PL" | "TL" | "AM1" | … (87 values) | Fishing Gear Type |
pg05pg06[].scientificGenusName? | string | |
pg05pg06[].scientificSpeciesCode? | string | |
pg05pg06[].scientificSpeciesName? | string | |
pg05pg06[].scientificSubSpeciesName? | string | |
pg05pg06[].sourceTypeCode? | "30" | "HCF" | "HBA" | "SVH" | "267" | "268" | … (21 values) | |
pg14? | object[] | |
pg14[].lpcoDate? | string | |
pg14[].lpcoDateQualifier? | "1" | "2" | "3" | "4" | |
pg14[].lpcoNumberOrName? | string | |
pg14[].lpcoQuantity? | number | |
pg14[].lpcoTransactionType? | "1" | "2" | "3" | |
pg14[].lpcoType? | "EXP" | "TZ1" | "TZ3" | "TZ4" | "TZ5" | "AM1" | … (105 values) | |
pg14[].lpcoUnitOfMeasure? | string | |
pg22? | object[] | |
pg22[].complianceDescription? | string | |
pg22[].conformanceDeclaration? | string | |
pg22[].dateOfSignature? | string | |
pg22[].declarationCode? | "COA1" | |
pg22[].documentIdentifier? | "877" | "894" | |
pg22[].importersSubstantiatingSignedDocumentConfirmationLetter? | boolean | Importer's Substantiating Document on File |
pg22[].invoiceNumber? | string | |
pg31? | object[] | |
pg31[].commodityHarvestingVesselCharacteristic? | string | Vessel Characteristic Value |
pg31[].commodityHarvestingVesselCharacteristicTypeCode? | "OTH" | "PMT" | "NRN" | "IMO" | "LRN" | "CAT" | … (15 values) | Vessel Characteristic Type |
pg31[].harvestedCommodityNetWeight? | number | |
pg31[].unitOfMeasureConveyance? | string | |
pg32? | object[] | |
pg32[].commodityPoliticalSubunitOfRoutingName? | string | Subunit Name |
pg32[].commodityPoliticalSubunitOfRoutingNumber? | string | Subunit Number |
pg32[].commodityPoliticalSubunitOfRoutingQualifier? | "1" | "2" | Subunit Qualifier |
pg32[].commodityRoutingCountryCode? | "ES" | "CR" | "AL" | "AZ" | "AR" | "CA" | … (243 values) | Routing Country Code |
pg32[].commodityRoutingTypeCode? | "11" | "13" | "49" | "198" | Routing Type Code |
pg33? | object[] | |
pg33[].geographicAreaCode? | "A" | "WA" | "NP" | "GM" | "OTH" | "CAR" | … (17 values) | |
pg33[].geographicAreaName? | string | |
productCategoryCode? | "NDR" | "NFL" | "NGG" | "NOT" | "NRD" | "NST" | … (8 values) |
entry.lineItems[].ods[]
| Field | Type | CBP field |
|---|---|---|
certifyingIndividualEntity? | TradeParty | |
correctionIndicator? | "A" | "D" | "R" | |
declarationCode? | "EP5" | "EP4" | |
disclaimer? | "A" | "D" | "B" | "C" | |
electronicImageSubmittedFlag? | boolean | Electronic Image Submitted |
entry.lineItems[].omc[]
| Field | Type | CBP field |
|---|---|---|
anticipatedArrivalDate? | string | |
exportExemptionCode? | "123.6" | "123.12" | "123.13" | "123.23" | "126.2" | "126.3" | … (44 values) | |
importExemptionCode? | "123.4a1" | "123.4a2" | "123.4a3" | "123.4a4" | "123.4a5" | "123.4b" | … (32 values) | |
licenseNumber? | string | DDTC License Number |
licenseTypeCode? | "S61" | "S62" | "S73" | "S74" | "S85" | DDTC License Type |
registrationNumber? | string | DDTC Registration Number |
entry.lineItems[].pesticide[]
| Field | Type | CBP field |
|---|---|---|
brandName? | string | Brand / Trade Name |
carrierEntity? | TradeParty | |
certifyingIndividualEntity? | TradeParty | |
commodityNetQuantityPGANet? | number | Commodity Net Quantity |
confidentialInfoFlag? | boolean | Confidential Information Indicator |
correctionIndicator? | "A" | "D" | "R" | |
customsBrokerEntity? | TradeParty | |
dateOfSignature? | string | |
disclaimer? | "A" | "D" | "C" | |
electronicImageSubmittedFlag? | boolean | Electronic Image Submitted |
govAgencyProgramCode? | "PS1" | "PS2" | "PS3" | Pesticide Program Code |
importerEntity? | TradeParty | |
intendedUseCode? | string | |
intendedUseDescription? | string | |
locationOfGoodsEntity? | TradeParty | |
notifyingPartyEntity? | TradeParty | |
pesticidePG02? | object[] | |
pesticidePG02[].itemType? | "P" | "C" | |
pesticidePG02[].pg04? | object[] | |
pesticidePG02[].pg04[].constituentActiveIngredient? | boolean | Active Ingredient |
pesticidePG02[].pg04[].constituentName? | string | |
pesticidePG02[].pg04[].constituentPercentage? | number | |
pesticidePG02[].productCodeNumber? | string | |
pesticidePG02[].productCodeQualifier? | "PC" | "CAS" | |
pesticidePG14? | object[] | |
pesticidePG14[].lpcoNumberOrName? | string | |
pesticidePG14[].lpcoType? | "EP8" | |
pesticidePG24? | object[] | |
pesticidePG24[].remarksCode? | "DSP" | "OTR" | "RD" | "EUP" | "EEX" | "REX" | … (8 values) | |
pesticidePG24[].remarksText? | string | |
pesticidePG24[].remarksTypeCode? | "GEN" | "EP5" | |
pesticidePG26? | object[] | |
pesticidePG26[].packagingQualifier? | "1" | "2" | "3" | "5" | "6" | "4" | |
pesticidePG26[].quantity? | number | |
pesticidePG26[].unitOfMeasure? | string | |
producerEstablishmentEntity? | TradeParty | |
shipperEntity? | TradeParty | |
unitOfMeasurePGANet? | string | Net Weight Unit of Measure |
entry.lineItems[].priorNotice[]
| Field | Type | CBP field |
|---|---|---|
commodityCharacteristicDescription? | string | Product Description |
dfiEntity? | TradeParty | |
disclaimer? | "A" | "F" | |
fdaImporterEntity? | TradeParty | |
fdcEntity? | TradeParty | |
foreignSupplierEntity? | TradeParty | |
govAgencyProcessingCode? | "ADD" | "PRO" | "DSU" | "FEE" | "NSF" | Processing Code |
intendedUseCode? | string | |
mfEntity? | TradeParty | |
ownerEntity? | TradeParty | |
pnsEntity? | TradeParty | |
pntEntity? | TradeParty | |
pointOfContactEntity? | TradeParty | |
priorNoticePG06? | object[] | |
priorNoticePG06[].countryCode? | string | |
priorNoticePG06[].sourceTypeCode? | "39" | "CSH" | "294" | "262" | |
priorNoticePG13PG14? | object[] | |
priorNoticePG13PG14[].locationOfLPCOIssuer? | string | Location of Issuer |
priorNoticePG13PG14[].lpcoIssuerGovGeographicCodeQualifier? | "MS" | "PR" | "US" | "ISO" | Geographic Code Qualifier |
priorNoticePG13PG14[].lpcoNumberOrName? | string | License Plate Number |
priorNoticePG13PG14[].regionalDescriptionLocationOfLPCOIssuerAgency? | string | Regional Description |
priorNoticePG23? | object[] | |
priorNoticePG23[].affirmationOfComplianceCode? | "FTZ" | "SE" | "FCC" | "COS" | "DEV" | "VIN" | … (87 values) | AoC Code |
priorNoticePG23[].affirmationOfComplianceQualifier? | string | AoC Qualifier |
priorNoticePG25? | object[] | |
priorNoticePG25[].lot? | string | Lot Number |
priorNoticePG25[].lotQualifier? | "1" | "3" | Lot Number Qualifier |
priorNoticePG25[].temperatureQualifier? | "A" | "D" | "R" | "P" | "H" | "U" | … (7 values) | |
priorNoticePG26? | object[] | |
priorNoticePG26[].packagingQualifier? | "1" | "2" | "3" | "5" | "6" | "4" | Packaging Level |
priorNoticePG26[].quantity? | number | |
priorNoticePG26[].unitOfMeasure? | string | |
priorNoticePG27? | object[] | |
priorNoticePG27[].containerNumber1? | string | Container Number 1 |
priorNoticePG27[].containerNumber2? | string | Container Number 2 |
priorNoticePG27[].containerNumber3? | string | Container Number 3 |
priorNoticePG28? | object[] | |
priorNoticePG28[].trackingNumber? | string | |
priorNoticePG28[].trackingNumberCode? | string | |
priorNoticePG30? | object[] | |
priorNoticePG30[].arrivalDate? | string | |
priorNoticePG30[].arrivalTime? | string | |
priorNoticePG30[].inspectionLabTestingStatus? | "A" | "R" | "P" | "I" | "S" | "L" | … (7 values) | Arrival Status |
priorNoticePG30[].inspectionOrArrivalLocation? | string | Port/FIRMS Code |
priorNoticePG30[].inspectionOrArrivalLocationCode? | string | Location Code |
productCodeNumber? | string | FDA Product Code |
remarksText? | string | Remarks |
secureHoldingFacilityEntity? | TradeParty | |
shipperEntity? | TradeParty | |
ultimateConsigneeEntity? | TradeParty |
entry.lineItems[].tobacco[]
| Field | Type | CBP field |
|---|---|---|
aocEntries? | object[] | |
aocEntries[].aocCode? | "SE" | "EXE" | "CMT" | "ERR" | "HPC" | "PMT" | … (7 values) | AoC Code |
aocEntries[].aocQualifier? | string | AoC Qualifier |
arrivalInfo? | object[] | |
arrivalInfo[].arrivalDate? | string | |
arrivalInfo[].arrivalTime? | string | |
arrivalInfo[].inspectionLocation? | string | FIRMS Code |
arrivalInfo[].inspectionLocationCode? | string | Location Code |
arrivalInfo[].statusCode? | "A" | "F" | Arrival Status Code |
commodityDescription? | string | |
correctionIndicator? | "A" | "D" | "R" | |
countryCode? | string | |
deliveredToEntity? | TradeParty | |
disclaimer? | "A" | "F" | |
fdaImporterEntity? | TradeParty | |
govAgencyProcessingCode? | "INV" | "CSU" | "FFM" | Processing Code |
intendedUseCode? | "980.000" | "085.000" | "090.000" | "100.000" | "110.000" | "120.000" | … (13 values) | |
investigationalLabEntity? | TradeParty | |
labelEntity? | TradeParty | |
lotNumber? | string | |
manufacturerEntity? | TradeParty | |
packaging? | object[] | |
packaging[].packagingQualifier? | number | Packaging Level |
packaging[].quantity? | number | |
packaging[].unitOfMeasure? | string | Packaging UoM |
pgaLineValue? | number | |
pointOfContactEntity? | TradeParty | |
productCodeNumber? | string | |
remarksText? | string | Remarks |
retailerDistributorEntity? | TradeParty | |
shipperEntity? | TradeParty | |
sourceTypeCode? | "30" | "39" | |
submitterEntity? | TradeParty | |
temperatureQualifier? | "A" | "D" | "R" | "P" | "H" | "U" | … (7 values) | |
tradeName? | string |
entry.lineItems[].ts1Ts2[]
| Field | Type | CBP field |
|---|---|---|
certifyingIndividualEntity? | TradeParty | |
correctionIndicator? | "A" | "D" | "R" | |
declarationCode? | "EP5" | "EP4" | |
disclaimer? | "A" | "D" | "B" | "C" | |
electronicImageSubmittedFlag? | boolean | Electronic Image Submitted |
govAgencyProgramCode? | "TS1" | "TS2" | TSCA Program Code |
entry.lineItems[].ttb[]
| Field | Type | CBP field |
|---|---|---|
correctionIndicator? | "A" | "D" | "R" | |
disclaimer? | "A" | "D" | "B" | "C" | |
electronicImageSubmittedFlag? | boolean | Electronic Image Submitted |
govAgencyProcessingCode? | "T01" | "T02" | "T03" | "T12" | "T13" | "T14" | … (37 values) | TTB Processing Code |
govAgencyProgramCode? | "BER" | "DSP" | "TOB" | "WIN" | TTB Program Code |
lpcos? | object[] | |
lpcos[].exemptionCode? | "TTBEX2" | "TTBEX3" | "TTBEX4" | "TTBEX5" | "TTBEX7" | "TTBEX8" | … (15 values) | |
lpcos[].lpcoNumber? | string | |
lpcos[].lpcoType? | "TZ1" | "TZ3" | "TZ4" | "TZ5" | |
manufacturerEntity? | TradeParty |
entry.lineItems[].vAndE[]
| Field | Type | CBP field |
|---|---|---|
additionalItemIdNumbers? | object[] | |
additionalItemIdNumbers[].itemIdNumber? | string | |
bondExemption? | "E1Y" | "E1N" | |
bondPolicyNumber? | string | |
certifyingIndividualEntity? | TradeParty | |
componentIncluded? | boolean | Component Reported Separately |
correctionIndicator? | "A" | "D" | "R" | |
dateOfSignature? | string | |
disclaimer? | "A" | "D" | "B" | "C" | |
electronicImageSubmittedFlag? | boolean | Electronic Image Submitted |
enginePowerUnit? | "KW" | "HP" | |
enginePowerValue? | number | |
exemptionNumber? | string | EPA Exemption Number |
formNumber? | "3520-1" | "3520-21" | EPA Form |
generalRemarks? | string | |
importCode? | "A" | "11" | "12" | "13" | "21" | "22" | … (47 values) | |
importerEntity? | TradeParty | |
industryCode? | "A" | "D" | "I" | "H" | "B" | "E" | … (10 values) | |
itemIdNumber? | string | Item Identity Number |
itemIdNumberQualifier? | "SE" | "AKG" | "ENN" | Item Identity Number Qualifier |
manufactureDateSource? | "ENG" | "VEH" | "OTH" | |
manufactureDateSourceDescription? | string | |
manufactureMonthAndYear? | string | |
manufacturerEntity? | TradeParty | |
model? | string | |
modelYear? | number | |
naicBondIssuerEntity? | TradeParty | |
ownerEntity? | TradeParty | |
regulationCited? | string | |
storageLocationEntity? | TradeParty | |
testGroupOrEngineFamilyName? | string | Test Group / Engine Family Name |
TradeParty
| Field | Type |
|---|---|
individualContactIndex? | number |
resolved | object |
resolved.data | TradePartyData |
TradePartyData
| Field | Type | CBP field |
|---|---|---|
abbreviatedName? | string | |
address? | string | Address information |
cityName? | string | |
countryCode? | string | |
countrySubEntityCode? | string | Country subentity code |
deaRegistrationNumber? | string | |
dunsNumber? | string | |
feiNumber? | string | FDA FEI Number |
gbiInfo? | object[] | |
gbiInfo[].identifier? | string | GBI Identifier |
gbiInfo[].identifierQualifier? | "DUNS" | "LEI " | "GLN " | "ALTA" | GBI Identifier Qualifier |
gbiInfo[].partyTypeDescription? | string | GBI Party Type Description |
hasGbi? | boolean | |
identifier? | string | Entity identifier |
identifierQualifier? | "ANI" | "EI " | "34 " | Party Number Types |
individualContacts? | object[] | |
individualContacts[].email? | string | Email or fax |
individualContacts[].name? | string | Individual name |
individualContacts[].phone? | string | Phone number |
individualContacts[].role? | "CR" | "CO" | "LA" | "NP" | "PE" | "CI" | … (90 values) | Individual Role |
legalName? | string | |
manufacturerIdentifier? | string | |
notes? | string | |
postalCode? | string |