IBC Virtual Shipping - 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, DELETE, PUT HTTP methods to successfully submit your label create and label delete requests.

The service URL is:
 https://api.pactrak.com/ibclabel/vitrual 

Default values

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

1. STATION_CODE: select between MIA, NYC, LAX, DFW or ORD ( you can also use TST for tests ).
2. SERVICE_CODE:
   • - For Fedex labels use S for SmartPost, R for SmartPost returns service, G for Ground, GH for Ground Home Delivery, 2D for 2 Day Service, E for Standard Express or P for Priority Express.
   • - For UPS labels use UPSG for Ground UPSN for NextDay, UPSNS NextDay Saver UPS2D 2Day Service, UPS3D 3Day Service, UPSM UPSSurePost < 1 lbs and UPSM1 UPSSurePost > 1 lbs.
3. MANIFEST_CODE: Fedex services require you to assign a manifest code to your shipments and close the day (manifest close) using this self assigned id.
4. ServiceTrackNumber: This number is received with your label feed and it is your vendor related tracking number.

URL parameters

Your service request URL can contain these optional parameters:

• _test: use this parameter to treat this transaction as a test (development mode).
• _gw: use this parameter when your solution is approved for virtual processing, you will be instructed to use or omit this parameter.
• 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.

Label Create Requests

Fedex Service Codes

Use these codes for Fedex Labels

• S: SmartPost - requires close manifest
• R: SmartPostReturn
• G: Ground - requires close manifest
• GH: Ground Home Delivery - requires close manifest
• 2D: Fedex 2Day service
• E: Fedex Express label
• P: Fedex Priority label

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

UPS Service Codes

Use these codes for UPS Labels

• UPSG: UPS Ground Service
• UPSN: UPS NextDay Service
• For residential delivery add ?residential as a parameter to your request URL.

The service supports returning ZPL, GIF, SPL, EPL or PNG image of the label. Use the stock_type parameter in your URL request to change the type. If you don't use the parameter the ZPL code is returned.

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

Manifest Closing

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 station code TST for TEST entries.

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":"https://api.pactrak.com/ibclabel/virtual/",

   /**
   * 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": "", /**  true when label data feed is available in the label_feed object */
	"label_type": "ZPL2", /** Defaults to ZPL2 */
     	"trackNumbers": [ "" ], /** This is an array object.  The first item in the array is your main track number.
			PBW services returns also a secondary track number for references. */
	"service": "", /** Service requested */
	"notes": "",
	"notices": "",
	"provider": "",
	"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 */
}

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