The PubSub tracking API is used by high-volume cusomters and third parties while decreasing overall load on the Track API. A request holds up to 100 tracking number which has a 34 character limit.

• You will need to have Maven and the Java Development Kit installed.

• You can either download a local copy or clone the repository:

git clone https://github.com/UPS-API/java-api-examples.git

• Update your OAuth Client information in /src/main/resources/application.properties file. These values can be found in the UPS Developer Portal under Apps and your specific application's information.

• Update your client information in any tags marked with "< >" within the /src/main/resources/ json files. For this API there are the following fields:

• Build the project using Maven

cd <project home>
mvn clean package

• Run the project that is generated in the /target directory.

java -jar pubsub-x.x.x.jar

• Check the console for the application's REST response.

There are 2 notable classes in this tutorial, namely com.ups.api.app.AppConfig and com.ups.api.app.PubSubDemo. The AppConfig class is a configuration class leveraging Spring injection to incorporate the property value from src/main/resources/application.properties file. The PubSubDemo is to illustrate how to use the PubSub api.

	PubSubTrackingRequest pubSubTrackingRequest = Util.createRequestFromJsonFile(entry.getKey(),
											entry.getValue().get(AppConfig.SCENARIO_PROPERTIES_JSON_FILE_NAME),
											PubSubTrackingRequest.class,
											appConfig,
											Arrays.asList(new CreateRequestEnricher() {}));

It reconstructs a PubSubTrackingRequest object from a json file which includes shipper account number and a tracking number list. In a typical application, a PubSubTrackingRequest object would be created via a default constructor followed by a set of setter to populate the necessary attribute.

	// Get a tracking response for a list of tracking number.
	PubSubResponseWrapper pubSubResponseWrapper = sendRequest(pubSubTrackingRequest, transId, acceptParameter);

The sendRequest function creates a PubSub api object and set the access token expiry tolerance if it haven't created one yet as well as populating with a valid access token. A PubSubResponseWrapper will be returned from a backend server for a list of tracking number specified in the PubSubTrackingRequest object. The PubSubResponseWrapper contains a list of valid tracking number and a list of invalid number if exists.

• Request Schema PubSubTrackingRequest

• Response Schema PubSubResponseWrapper

• PubSub request

{
  "countryCode": "US",
  "locale": "en_US",
  "shipperAccountNumber": "",
  "trackingNumberList": [
    "<Tracking Number A>",
    "<Tracking Number B>"
  ],
  "scanPreference": [],
  "destination": {
    "url": "<Your Message Receiver URL>",
    "credential": "<Your Message Endpoint Access Token>",
    "credentialType": "Bearer"
  }
}

• Successful PubSub Response

{
  "validTrackingNumbers": [
    "<Tracking Number A>",
    "<Tracking Number B>"
  ],
  "invalidTrackingNumbers": []
}