IBC Label Service - REST Service

Introduction

This REST service allows your system to create shipping labels using standalone, web or script based program.

Your client should use POST HTTP method to successfully submit your label create requests.

The service URL is:
 https://api.pactrak.com/shiplabel/v1/ 

Default values

Your service requests URLs will need to use these variable parameters:

1. STATION_CODE: select between MIA, NYC, LAX, DFW or ORD.
2. SERVICE_CODE:
   • - For Fedex labels use S for SmartPost, G for Ground, GH for Ground Home Delivery, E for Standard Express

URL parameters

Your service request URL can contain these optional parameters:

• _test: use this parameter to treat this transaction as a test (development mode).
• label_size: use this to modify the label size for your response.
• label_type: use this to modify the output format of your label request.

For example - for a Fedex Ground test label for MIA station:
  https://api.pactrak.com/shiplabel/v1/MIA/G?_test  

Label Create Requests

Fedex Service Codes

Use these codes for Fedex Labels

• S: SmartPost - requires close manifest
• G: Ground - requires close manifest
• GH: Ground Home Delivery - requires close manifest
• E: Fedex Express label

See shipment label options for optional label configurations, default is ZPLII 4x6 Stock label

Optional Label type and Size Options

The requests allow you to modify the return typle. You can modify the label type by appending the following parameters to your URL:

Label Delete Requests

How to submit your data

You will need to obtain a security token before submitting your test or production requests.

The easiest way to test your POST request is to use cURL from the system's command line. Use the url parameter code _test for TEST entries.

For example - for a Fedex Ground test label for MIA station:
  https://api.pactrak.com/shiplabel/v1/MIA/G?_test  

We recommend saving your JSON structure into a text file ( input-file.txt ).

Sample JSON structures ready for testing.

How to cancel labels

Response JSON structure

After making a successful submission you should expect a return of one of the following JSON structures:

                    
{ /**
    * The HTTP response code
    * @type Integer.
    */
    "code": , /** Successful response: 200, Error response: 40x */
    
    /**
    * Response message relevant to the action requested.
    * @type String.
    */
    "message":"",
    
    /**
    * Detailed Response message relevant to the action requested.
    * @type String.
    */
    "developerMessage":"",
    
    /**
    * A link to the resource.
    * @type String.
    */
    "href":"/shiplabel/v1/..",
    
    /**
    * The direct response from the label provider with the details of your label transaction. Note:
    may not appear on error responses.
    * @type JSON Object.
    */
    "service_answer": [ 
        { 
            /** Note: not all items will be available on all responses. Most are for informational purposes only. */
            "message": "", /** */
            "label_feed": "", /** The data feed that is used to create your physical label. The data is base64 encoded.*/
            "labelResponse": "", /** informational details about the label feed */
            "label_type": "LABEL-ZPLII", /** Defaults to LABEL-ZPLII*/
            "trackNumbers": [ "" ], /** This is an array object. The first item in the array is your main track number.  */
            "service": "", /** Service requested */
            "notes": "",
            "notices": "",
            "jobId": "", /** A unique Job Id created by the service provider. */
            "barcode": "", /** The data that created the barcode printed on the label.. */
        }
    ],
    "trackNumber": "" /** This is the internal number IBC will use for your shipment */ 
    "is_error": false, /** true or false */ 
    "completion_time": "" /** informational purposes */
}
                    
                

On error responses the Developer message object will contain a validity report with details of the issues found with the input provided. It is formatted with end of line chars "\n" so that it will be readable in your browser's web console.

Developer Resources

Restful services are capable of receiving requests form web based or standalone applications. We have tested our services to comply with REST standards, returning appropriate HTTP codes to help developers using commonly used frameworks as JQuery or Prototype.

Additionally, there are many examples from many different programming languages such as C#, Java, PHP and C++.

If you desire to test or need Java sample code, the following project is an example of how to call an HTTP Rest service using HTTP Post protocol, IBCPost.

Useful Links

ZPL printing

• Zebra Windows help
• Linux printing



Base64

• Encode / Decode and samples