io.snapcx.tracking.client.api

Class ShippingApi

java.lang.Object

io.snapcx.tracking.client.api.ShippingApi

@Generated(value="class io.swagger.codegen.languages.JavaClientCodegen",
           date="2017-01-03T19:17:01.024-05:00")
public class ShippingApi
extends Object

Constructor Summary

Constructors

Constructor and Description
ShippingApi()
ShippingApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
InlineResponse200	getTrackingDetails(String carrier, String trackId, String userKey) Get Shipping Tracking Details This API provides real time shipping tracking status (along with tracking events) for multiple carriers.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ShippingApi

public ShippingApi()

ShippingApi

public ShippingApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getTrackingDetails

public InlineResponse200 getTrackingDetails(String carrier,
                                            String trackId,
                                            String userKey)
                                     throws ApiException

Get Shipping Tracking Details This API provides real time shipping tracking status (along with tracking events) for multiple carriers. It takes carrier code (UPS or USPS or FEDEX or DHL) and tracking number as input. To invoke this API, you need to have your own private api key (aka user_key). You can always sign up for FREE plan to get user_key.

Parameters:

carrier - Shipper Carrier code (UPS or USPS or FEDEX or DHL Or CAN (Canada Post) OR use AUTO for automatic detection.). (required)

trackId - Carrier tracking number, which is being tracked. (required)

userKey - Your private key, given after opening account with snapcx.io (required)

Returns:

InlineResponse200

Throws:

ApiException - if fails to make API call