IBC. Inc.

IBC Zipx Prealerts - Documentation

Introduction

This is JSON REST API service, to report pre-alerts into the zipx system.

The service responds to JSON and JSONP requests to the following URL:
https://api.pactrak.com/v1/zipxalerts/

Default response JSON structure for POST Requests.
{
/**
* The HTTP response code.
* @type Integer.
*/
"code": 200,

/**
* Response message relevant to the action requested.
* @type String.
*/
"message":"",

/**
* Response message for the developer relevant to the errors received.
* @type String.
*/
"developerMessage":"",

/**
* A link to the resource.
* @type String.
*/
"href":"",

/**
* The method requested by the caller.
* @type String.
*/
"http_method":"",

/**
* A boolean flag notice, true for JSONP requests.
* @type String.
*/
"jsonpresponse":""
}

New Alerts

To create a new alert you will need:

  • Submit a HTTP POST request to the server.
  • Add the following header to your request to transmit JSON "Content-Type" "application/json"
  • The following JSON structure should be transmitted with your JSON requests:
  • /** Main Submission object */
    {
    "zipx_number": "", /* required, Zipx Account in the form ##-##### */
    "zipx_carrier": "", /* required 3 chars max, choose between "DHL", "DRP", "FDX", "IBC", "TNT", "UPS", "USP", "LAS", "OTH" */
    "seller_name": "", /*required, name where the goods where purchased, Ebay, Amazon, etc. 20 chars max */
    "carrier_bill_number": "", /* required, report the tracking number assigned */
    "description": "", /* required */
    "value": "" /* required, value of the goods received. Must be numeric.*/
    }