API Communicaton [Accounts]

Execute a POST or GET to the following URL: http://yourcompany.cargotrack.net/appl2.0/auto/

api.asp, “yourcompany.cargotrack.net” must be replaced by your system’s URL address.

Nombre variable Descripción

api_key Alphanumeric of 10 digits that we will provided to identify you as a
valid source
api_action To determine what we want to do:
account_create : create a new account
account_modify : modify an account
contact_create : create a contact related to an account
contact_modify : modify a contact
retrieve_password : send user an email with their password
api_confirmation URL where you want to receive confirmation details, for example
“www.yourdomain.com”.

Once processed the following variables will be sent to the confirmation page provided.

Variable Name Description

status Error code, 0 no errors found, or a number to identify the type of error
tid Transaction reference char(25)
cod_control Unique control digit to identify record created. Necessary to request
updates
box_number Box number assigned to the account, also used as the username to
log into the system’s client interface
password Password to access the system’s client interface

email Email address registered on the account

If no confirmation URL is provided, results will be provided on an XML format. See sample
below.

<xml>
<account>
<status>0</status>
<tid>20191004221345</tid>
<cod_control>16743</cod_control>
<box_number>VE16743</box_number>
<password>g4az6</password>
<email>name@customer.com</email>
</account>
</xml>
account_create, account_modify* Can’t be left blank
Nombre variable Tipo Descripción
account_id int(11) Agent ID, used only when the customer account must
be associated to an agent
company char(50) * Name of the company or Person
address1 char(50) * Main address field
address2 char(50) Additional address field
city char(50) * City
state char(50) State
zipcode char(10) Zip Code
country char(2) * Two digit ISO code
phone_cc char(4) Phone country code
phone_ac char(4) Phone area code
phone char(15) Phone number
fax_cc char(4) Fax country code
fax_ac char(4) Fax area code
fax char(15) Fax number
mobile_cc char(4) Mobile country code
mobile_ac char(4) Mobile area code
mobile char(15) Mobile number
location char(3) * Three digit closest airport code
contact char(50) Name of contact person
email char(75) Email
client char(1) To classify as a client identify with a Y or N
vendor char(1) To classify as a vendor identify with a Y or N
shipper char(1) To classify as a shipper identify with a Y or N
consignee char(1) To classify as a consignee identify with a Y or N
agent char(1) To classify as an agent identify with a Y or N
carrier char(1) To classify as a carrier identify with a Y or N
broker char(1) To classify as a broker identify with a Y or N
pay_terms int(3) Payment terms, specify number of days:
0 - Cash
7 - 7 days of credit
15 - 15 days of credit
30 - 30 days of credit
45 - 45 days of credit
60 - 60 days of credit
90 - 90 days of credit
120 - 120 days of credit
If left blank “cash” will be pre-determined
pay_terms_vendor int(3) If selected as vendor you can specify payment terms
as a vendor following the same rule as for customers
notify_whs char(1) To receive warehouse notification indicate Y
notify_master char(1) To receive shipment notification indicate Y
notify_stmt char(1) To receive statements indicate Y
language char(2) Language in which the system communicates with the
account, if left blank will be pre-determined to english:
EN - English
ES - Spanish
PT - Portuguese
cif char(15) Tax ID number
cod_cliente char(15) To specify customer account number
cod_control int(11) To be used only when updating a previously created
account. This number is provided in the confirmation
message when the account is created
contact_create, contact_modify
* Can’t be left blank

Nombre variable Tipo Descripción

cod_account int(11) * Control code assigned to the account the contact
belongs
first_name char(50) * First name
last_name char(50) * Last name
phone_cc char(4) Phone country code
phone_ac char(4) Phone area code
phone char(15) Phone number
fax_cc char(4) Fax country code
fax_ac char(4) Fax area code
fax char(15) Fax number
mobile_cc char(4) Mobile country code
mobile_ac char(4) Mobile area code
mobile char(15) Mobile number
email char(75) Email
notify_air char(1) To notify air export shipments specify Y or N
notify_imp_air char(1) To notify air import shipments specify Y or N
notify_ocean char(1) To notify ocean export shipments specify Y or N
notify_imp_ocean char(1) To notify ocean import shipments specify Y or N
notify_truck char(1) To notify ground shipments specify Y or N
notify_whs char(1) To notify warehouse specify Y or N
notify_inv char(1) To send invoices specify Y or N
notify_statement char(1) To send statements specify Y or N
notify_quote char(1) To send quotations specify Y or N
pos char(50) Title
dob_month int(2) Date of birth, month 00
dob_day int(2) Date of birth, day 00
phone_extension char(5) Phone extension
retrieve_password
* Can’t be left blank

Nombre variable Tipo Descripción

email* char(75) Email