A E S Direct - True Innovation In Export Automation

Home

Press enter to skip left navigation bar
Log In
AESDirect
Certification Quizzes

Account Set-up & Management
Register New Account
Registration Help
Re-Activate an Account
Terms & Conditions
Privacy Policy
Privacy Act Statement
Account Administration

Vendor Account Set-up
Developers Center
Register Vendor Account

Training
User Guides
Sample Shipments
Online Training
Workshops
AES Compliance

Using AESDirect
Who to Contact
Support Center
Browser Support
Developers Center
News

AESPcLink
About AESPcLink
Getting Started
Terms & Conditions

AESDirect VPN
About AESDirect VPN
Set up AESDirect VPN

Related Sites
Government Sites
Partner Sites

A E S Direct Developers Center

AESWebLink Submission API
[Developers Center Home]

Introduction:

The AESWebLink Submission API is a definition of the protocol by which an AESWebLink Enabled Application will interface and interact with AESWebLink.

The AESWebLink Submission API consists of the URL for the AESWebLink application on the AESDirect server, and the data elements that can be passed to it. The transaction to AESDirect AESWebLink should be an HTTP POST transaction. HTTP GET transactions should not be used due to restrictions on the length of the QUERY_STRING that can be passed with a GET.

Recent Updates:

  • 12/3/2004 - Added Inbond Type validations
  • 12/14/2003 - Added VPN and NOEMAIL Fields for AES VPN eResponse System
  • 09/04/2002 - Added DDTC Data Elements.
  • 07/29/2002 - Added note clarifying submission of DEC internal numbers as the USPPI ID and minor cosmetic changes to the API page.
  • Previous AESWebLink API Updates

URL:

All submissions should go to the following URL: https://www.aesdirect.gov/weblink/weblink.cgi

Key:

Variable: The name of the variable used to send this data element

Description: Description of the Variable

Editable: User can edit this data element in AESWebLink IF it is missing or incorrect

Required By:

  • WebLink - This element is required for submission to AESWebLink. AESWebLink will reject the submission if this is missing.
  • AES - This element is required by AES. Unless otherwise noted, it is not required by AESWebLink, however it will have to be entered by the end user prior to submission to AES.
Value(s): Codes or acceptable value(s) for this element. When this is left blank the element is free text.

Size: Maximum length of data that can be passed in this element.

Notes:

  1. AESWebLink is designed to provide the ability to pass information back to the enabled application at certain points in the process (see AESWebLink Process Overview for details). In order to enable this, the return URLs in the system variables section need to be passed to AESWebLink. If these cannot be passed AESWebLink will use default pages on AESWebLink in place of the return URLs not passed.

  2. Should be a valid E-Mail address. You can send multiple E-Mail addresses separated by commas. If you do not send an E-Mail address, default address for the users account will be used.

  3. AES VPN e-Response Flag - If an account is set up for AES VPN e-Response, setting VPN=1 will direct a copy of responses to the VPN Download Client. If the VPN flag is set to 1 and the Account does not have AES VPN e-Response enabled, the VPN flag will be ignored.


  4. AES VPN Email Suppression Flag - This flag allows suppression of e-mail responses to AESWebLink shipments. To suppress e-mail responses the following 3 conditions have to be satisified:

    • The VPN Flag must be set to 1 AND the account must have VPN e-Response Enabled (see note 3).
    • The NOEMAIL Flag must be set to 1
    • The EMAIL Field must be empty or missing
System Variables
Variable Description Editable Required By Value(s) Size
wl_app_ident Enabled Application Identifier n/a WebLink assigned when you sign up for AESWebLink  
wl_app_name Enabled Application Name n/a WebLink    
wl_nologin_url Unsuccessful Login URL n/a See Note 1 Must be a URL  
wl_nosed_url No EEI Return URL n/a See Note 1 Must be a URL   
wl_success_url Success Return URL n/a See Note 1 Must be a URL  
EMAIL E-Mail Response Address n/a   See Note 2  
VPN New! - AES VPN e-Response Flag n/a Optional
See Note 3		 1 - Yes
 1
NOEMAIL New! - AES VPN E-Mail Response Suppression Flag n/a Optional
See Note 4		 1 - Yes 1
 
General Information - Required by AES
Variable Description Editable Required By Value(s) Size
SRN Shipment Reference Number No WebLink & AES   17
BN Transportation Reference Number Yes AES for vessel shipments For vessel shipments, this field should contain the booking number 30
ST State of Origin Yes AES State Code 2
FTZ Foreign Trade Zone Yes AES for IBN 67, 68, Export Code ZD   5
POE Port of Export Yes AES Schedule D or K Code 5
COD Country of Destination Yes AES ISO Code 2
POU Port of Unlading Yes AES for vessel shipments Schedule D or K Code 5
EDA Departure Date Yes AES Format: YYMMDD or MM/DD/YY
1 digit months or days must be padded with a 0 (07/01/01 instead of 7/1/01)		 8
MOT Mode of Transport Yes AES Codes 2
SCAC Carrier Yes AES SCAC or IATA Code 4
VN Conveyance Name Yes AES   23
VF Vessel Flag Yes   ISO Code 2
RCC Related Companies Yes AES Y=Yes
N=No		 1
HAZ Hazardous Cargo Yes AES Y=Yes
N=No		 1
RT Routed Transaction Flag Yes AES Y=Yes
N=No		 1
IBN Import Entry Number Yes AES for Inbond Types 36, 37, 67, 68   15
IBT Inbond Type Yes AES Inbond Types 2
 
U.S. Principal Party in Interest (USPPI) - Required by AES
Variable Description Editable Required By Value(s) Size
AD0_1 Name Yes AES   30
AD0_2 ID Number Yes AES   11
AD0_3 ID Type Yes AES E=EIN
T=Foreign
 1
AD0_4 Address Line 1 Yes AES   32
AD0_5 Address Line 2 Yes     32
AD0_6 City Yes AES   25
AD0_7 State Yes AES U.S. State Code 2
AD0_8 Zip Code Yes AES   9
AD0_9 Contact First Name Yes AES   13
AD0_10 Contact Middle Initial Yes     1
AD0_11 Contact Last Name Yes AES   20
AD0_12 Contact Phone Yes AES   11
 
Ultimate Consignee - Required by AES
Variable Description Editable Required By Value(s) Size
AD1_3 Name Yes AES   30
AD1_5 Contact Name Yes     35
AD1_7 Contact Phone Yes     11
AD1_8 Address Line 1 Yes AES   32
AD1_9 Address Line 2 Yes     32
AD1_10 City Yes AES   25
AD1_11 State Yes AES for consignees in USA, Mexico, and Puerto Rico State Code 2
AD1_12 Country Yes AES ISO Code 2
AD1_13 Postal Code Yes AES for consignees in US For US consignees the zip code must be valid for state indicated in AD1_11
US Zip Codes with State		 9
 
Intermediate Consignee - Required by AES
Variable Description Editable Required By Value(s) Size
AD4_3 Name Yes AES   30
AD4_5 Contact Name Yes     35
AD4_7 Contact Phone Yes     11
AD4_8 Address Line 1 Yes AES   32
AD4_9 Address Line 2 Yes     32
AD4_10 City Yes AES   25
AD4_11 State Yes AES for consignees in USA, Mexico, and Puerto Rico State Code 2
AD4_12 Country Yes AES ISO Code 2
AD4_13 Postal Code Yes AES for consignees in US For US consignees the zip code must be valid for state indicated in AD4_11
US Zip Codes with State		 9
 
Freight Forwarder
Variable Description Editable Required By Value(s) Size
AD3_2 ID Type Yes AES E=EIN
D=D-U-N-S
T=Foreign		 1
AD3_3 Name Yes AES   30
AD3_4 ID Number Yes AES   11
AD3_5 Contact Name Yes AES   35
AD3_7 Contact Phone Yes AES   11
AD3_8 Address Line 1 Yes AES   32
AD3_9 Address Line 2 Yes     32
AD3_10 City Yes AES   25
AD3_11 State Yes AES State Code 2
AD3_12 Country Yes AES ISO Code 2
AD3_13 Postal Code Yes AES For US forwarders the zip code must be valid for state indicated in AD3_11
US Zip Codes with State		 9
 
Line Items - Submit up to 99 Line Items, Replace X with Line Number
Variable Description Editable Required By Value(s) Size
isLineX Line Item Flag n/a WebLink Y 1
ITX_1 Export Code Yes AES Export Codes 2
ITX_2 Value in Whole US Dollars Yes AES Must be all numeric 10
ITX_3 First unit of measure Yes AES unless using a limited reporting Export Code Unit of Measure Codes 3
ITX_4 First Quantity (In first unit of measure) Yes AES unless using a limited reporting Export Code, or first unit of measure is X (No Unit Required) Must be all numeric 10
ITX_5 Second unit of measure Yes AES if required for commodity, unless using a limited reporting Export Code Unit of Measure Codes 3
ITX_6 Second Quantity (in second unit of measure) Yes AES if required for commodity, unless using a limited reporting Export Code Must be all numeric 10
ITX_7 Gross Weight (in whole Kilograms) Yes AES Must be all numeric 10
ITX_8 License Type Yes AES License Type Codes 3
ITX_9 License Number Yes AES if required by license
DDTC Requirements		   12
ITX_12 Description Yes AES   45
ITX_13 Commodity Code Yes AES unless using a limited reporting Export Code Schedule B/HTS Codes
do not send periods (.) in commodity code		 10
ITX_14 Marks and Numbers Yes     75
ITX_15 Vehicle Flag (Commodity Being Shipped is a Used Vehicle) Yes AES Y=Yes
N=No		 1
ITX_16 Vehicle ID Type Yes AES if Vehicle Flag=Y V=VIN
P=Product ID		 1
ITX_17 Vehicle ID Yes AES if Vehicle Flag=Y   25
ITX_18 Vehicle Title Yes AES if Vehicle Flag=Y   15
ITX_19 Vehicle Title State Yes AES if Vehicle Flag=Y State Codes 2
ITX_20 ECCN Yes AES if required by License Type   5
ITX_21 Origin Yes AES D=Domestic
F=Foreign		 1
ODTCX_1 DDTC ITAR Exemption Number Yes Requirements ITAR Exemption Codes 12
ODTCX_2 DDTC Registration Number Yes Requirements   6
ODTCX_3 DDTC Significant Military Equipment Indicator Yes Requirements Y - Yes
N - No		 1
ODTCX_4 DDTC Eligible Party Certification Indicator Yes Requirements Y - Yes
N - No		 1
ODTCX_5 DDTC USML Category Code Yes Requirements USML Category Codes 2
ODTCX_6 DDTC Unit of Measure Yes Requirements DDTC Units of Measure 3
ODTCX_7 DDTC Qauntity Yes Requirements 7
 
Equipment Details - Replace X with sequential Number starting at 1. Submit up to 50
Variable Description Editable Required By Value(s) Size
EQX Equipment Number Yes     14
SNX Seal Number Yes     15

U.S. Census Bureau Foreign Trade Logo U.S. Department of Commerce

[top of page]