US flag Official website of the Department of Homeland Security

AESDirect WebLink Submission API

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.

AESDirect WebLink Submission API Table

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 satisfied: 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; and the EMAIL Field must be empty or missing
  5. The field names in the table below refer to the field name in the CBP Proprietary Commodity Format specification. Refer to the field for field length, data type and when the fields are required to be reported. The CBP Proprietary Commodity Format specification can be found at https://www.cbp.gov/document/guidance/cbp-proprietary-format
Last modified: 
May 5, 2017