The IBC Air AMS API allows you to integrate the submission of your U.S. bound manifests to your system. This service has two purposes:
This RESTful service accepts your manifest data using a JSON structure that can be easily generated from many popular programming languages.
The Web API adheres to the REST architecture and returns notifications in JSON format.
The service URL is:
Your client must use POST HTTP method to successfully submit your JSON structure.
To test the content of your submission please use the following service URL:
If you are testing a CFS Manifest:
For standard submissions, you will receive either an accept or failure email notification to the address list your provided.
Attention: Your API submission is not the final step in the process. If it is denied, the email will contain messages that require your immediate attention. Upon fixing these errors, you will be able to resubmit with the ultimate goal of receiving a standard acknowledgment from the Air AMS system. The final successful message is your official notice that we have accepted your data for CBP processing and that it is integrated into our systems.
For test submissions, the system will run tests of your data and respond back with a report via email to the address list you provided.
Please see the JSON structure on how to set up your submission.
For your submissions you must create the following JSON structure:
Successful JSON structure
The easiest way to test your POST request is to use cURL from the system's command line.
We recommend saving your JSON structure into a text file ( input-file.txt ) and then execute this command:
This is a submission as 'application/x-www-form-urlencoded'.
You can also submit strictly as JSON object with the following command. Note the JSON structure should not have the parameter name 'aams'.
This is a sample JSON structure ready for testing.
We highly recommend that you test your applications by submitting POST requests to this service's
test URL first: https://api.pactrak.com/manifest/aams?_test, and that you follow
up with the
IBC IT Department, until you receive your official Air AMS production email address from IBC. Please review the notes in the JSON structure above for details on how your manifest request object should be setup for tests.
As a backup, we also recommend that your operations team is capable of submitting the form data manually through the IBC Air AMS Web form, in cases where a manual submittal of your data is required.
If you desire to test the format of your files offline, you can review the source code used within this project and execute your tests by downloading the project source from: IBC Manifest Analyzer Project.