Scribd
Upload
68 views2 pages

API Communicaton (Prealert) : Nombre Variable Descripción

This document provides instructions for communicating with an API to register a prealert by sending a POST or GET request to a specified URL. It lists the required variables, their descriptions, and types that must be included in the request. Upon processing, any confirmation details will be sent to a provided URL, otherwise no information will be returned.

Uploaded by

Ronald Mojica
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
68 views2 pages

API Communicaton (Prealert) : Nombre Variable Descripción

This document provides instructions for communicating with an API to register a prealert by sending a POST or GET request to a specified URL. It lists the required variables, their descriptions, and types that must be included in the request. Upon processing, any confirmation details will be sent to a provided URL, otherwise no information will be returned.

Uploaded by

Ronald Mojica
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd

API Communicaton [Prealert]

Execute a POST or GET to the following URL: [Link]


[Link], “[Link]” 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:
prealert : register a prealert
api_confirmation URL where you want to receive confirmation details, for example
“[Link]”.

Once processed the following variables will be sent to the confirmation page provided. If no
confirmation URL, no information will be sent.

Variable Name Description


status Error code, 0 no errors found, or a number to identify the type of error
tid Transaction reference char(25)
* Can’t be left blank
Nombre variable Tipo Descripción
client_id int(11) * Client ID, unique customer identifier
store char(50) Store name where items have been purchased
commodity text(unlimited) Description of items purchased
order_number char(25) Purchase order number
value dec(10,2) Value of items purchased
carrier char(25) Carrier name
tracking char(25) * Tracking number
shipping_instructions char(1) A for Air
O for Ocean
shipping_type char(15) D - Direct
C - Consolidated

You might also like