com.shippo.model

Class Track

java.lang.Object

com.shippo.serialization.ShippoObject

com.shippo.net.APIResource

com.shippo.model.Track

public final class Track
extends APIResource

Use this class to track shipments. Represents object defined in https://api.goshippo.com/tracks endpoint. The endpoint's documentation can be found in https://goshippo.com/docs/reference#tracks

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Track.Address
static class	Track.ServiceLevel
static class	Track.TrackingEvent
static class	Track.TrackingStatus

Nested classes/interfaces inherited from class com.shippo.net.APIResource

APIResource.RequestMethod

Field Summary

Fields inherited from class com.shippo.net.APIResource

CHARSET

Fields inherited from class com.shippo.serialization.ShippoObject

PRETTY_PRINT_GSON

Constructor Summary

Constructors

Constructor and Description
Track()

Method Summary

Modifier and Type	Method and Description
Track.Address	getAddressFrom()
Track.Address	getAddressTo()
String	getCarrier()
Date	getETA()
String	getMetadata()
Track.ServiceLevel	getServiceLevel()
Track.TrackingEvent[]	getTrackingHistory()
static Track	getTrackingInfo(String carrier, String trackingNumber, String apiKey) Get tracking information of any package from given carrier.
String	getTrackingNumber()
Track.TrackingEvent	getTrackingStatus()
static Track	registerTrackingWebhook(String carrier, String trackingNumber, String metadata, String apiKey) Register webhook for tracking shipment of a package.
String	toString()

Methods inherited from class com.shippo.net.APIResource

_request, classURL, classURLWithTrailingSlash, instanceURL, request, singleClassURL, urlEncode

Methods inherited from class java.lang.Object

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

Constructor Detail

Track

public Track()

Method Detail

toString

public String toString()

Overrides:

toString in class ShippoObject

getCarrier

public String getCarrier()

getTrackingNumber

public String getTrackingNumber()

getAddressFrom

public Track.Address getAddressFrom()

getAddressTo

public Track.Address getAddressTo()

getETA

public Date getETA()

getServiceLevel

public Track.ServiceLevel getServiceLevel()

getMetadata

public String getMetadata()

getTrackingStatus

public Track.TrackingEvent getTrackingStatus()

getTrackingHistory

public Track.TrackingEvent[] getTrackingHistory()

getTrackingInfo

public static Track getTrackingInfo(String carrier,
                                    String trackingNumber,
                                    String apiKey)
                             throws AuthenticationException,
                                    InvalidRequestException,
                                    APIConnectionException,
                                    APIException

Get tracking information of any package from given carrier. This corresponds to https://api.goshippo.com/tracks/carrier/tracking_number API defined in https://goshippo.com/docs/reference#tracks-retrieve

Parameters:

carrier - Name of the carrier (like "usps") tracking the package

trackingNumber - Tracking number provided by the carrier for a package

Returns:

Track object containing tracking info

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

APIException

registerTrackingWebhook

public static Track registerTrackingWebhook(String carrier,
                                            String trackingNumber,
                                            String metadata,
                                            String apiKey)
                                     throws AuthenticationException,
                                            InvalidRequestException,
                                            APIConnectionException,
                                            APIException

Register webhook for tracking shipment of a package. This corresponds to API defined in https://goshippo.com/docs/reference#tracks-create. Please note that the webhook where information will be posted need to be already provided in https://app.goshippo.com

Parameters:

carrier - Name of the carrier (like "usps") tracking the packing

trackingNumber - Tracking number provided by the carrier for a package

metadata - Generic information related to this tracking

Returns:

Track object containing tracking info

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

APIException