com.shippo.model

Class Shipment

java.lang.Object

com.shippo.serialization.ShippoObject

com.shippo.net.APIResource

com.shippo.model.Shipment

public class Shipment
extends APIResource

Nested Class Summary

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
Shipment()

Method Summary

Modifier and Type	Method and Description
static ShipmentCollection	all(Map<String,Object> params)
static ShipmentCollection	all(Map<String,Object> params, String apiKey)
static Shipment	create(Map<String,Object> params)
static Shipment	create(Map<String,Object> params, String apiKey)
static Shipment	createForBatch(Address from, Address to, List<Parcel> parcels)
Object	getAddressFrom()
Object	getAddressReturn()
Object	getAddressTo()
Object	getCustomsDeclaration()
Object	getExtra()
String	getInstanceURL()
Object	getMessages()
Object	getMetadata()
Object	getObjectCreated()
String	getObjectId()
String	getObjectOwner()
Object	getObjectUpdated()
List<Parcel>	getParcels()
List<Rate>	getRates()
Object	getRatesUrl()
Object	getShipmentDate()
static RateCollection	getShippingRates(Map<String,Object> params)
static RateCollection	getShippingRates(Map<String,Object> params, String apiKey)
static RateCollection	getShippingRates(String id, String apiKey)
static RateCollection	getShippingRates(String id, String currency_code, String apiKey)
static RateCollection	getShippingRatesSync(Map<String,Object> params)
static RateCollection	getShippingRatesSync(Map<String,Object> params, String apiKey)
static RateCollection	getShippingRatesSync(String object_id)
String	getStatus()
static Shipment	retrieve(String id)
static Shipment	retrieve(String id, String apiKey)
void	setAddressFrom(Object addressFrom)
void	setAddressReturn(Object addressReturn)
void	setAddressTo(Object addressTo)
void	setCustomsDeclaration(Object customsDeclaration)
void	setExtra(Object extra)
void	setMessages(Object messages)
void	setMetadata(Object metadata)
void	setObjectCreated(Object objectCreated)
void	setObjectId(String objectId)
void	setObjectOwner(String objectOwner)
void	setObjectUpdated(Object objectUpdated)
void	setParcels(List<Parcel> parcels)
void	setRates(List<Rate> rates)
void	setRatesUrl(Object ratesUrl)
void	setShipmentDate(Object shipmentDate)
void	setStatus(String status)

Methods inherited from class com.shippo.net.APIResource

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

Methods inherited from class com.shippo.serialization.ShippoObject

toString

Methods inherited from class java.lang.Object

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

Constructor Detail

Shipment

public Shipment()

Method Detail

createForBatch

public static Shipment createForBatch(Address from,
                                      Address to,
                                      List<Parcel> parcels)

create

public static Shipment create(Map<String,Object> params)
                       throws AuthenticationException,
                              InvalidRequestException,
                              APIConnectionException,
                              APIException

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

APIException

getInstanceURL

public String getInstanceURL()

create

public static Shipment create(Map<String,Object> params,
                              String apiKey)
                       throws AuthenticationException,
                              InvalidRequestException,
                              APIConnectionException,
                              APIException

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

APIException

getShippingRatesSync

public static RateCollection getShippingRatesSync(String object_id)
                                           throws AuthenticationException,
                                                  InvalidRequestException,
                                                  APIConnectionException,
                                                  APIException,
                                                  RequestTimeoutException

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

APIException

RequestTimeoutException

getShippingRatesSync

public static RateCollection getShippingRatesSync(Map<String,Object> params)
                                           throws AuthenticationException,
                                                  InvalidRequestException,
                                                  APIConnectionException,
                                                  APIException,
                                                  RequestTimeoutException

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

APIException

RequestTimeoutException

getShippingRatesSync

public static RateCollection getShippingRatesSync(Map<String,Object> params,
                                                  String apiKey)
                                           throws AuthenticationException,
                                                  InvalidRequestException,
                                                  APIConnectionException,
                                                  APIException,
                                                  RequestTimeoutException

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

APIException

RequestTimeoutException

retrieve

public static Shipment retrieve(String id)
                         throws AuthenticationException,
                                InvalidRequestException,
                                APIConnectionException,
                                APIException

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

APIException

retrieve

public static Shipment retrieve(String id,
                                String apiKey)
                         throws AuthenticationException,
                                InvalidRequestException,
                                APIConnectionException,
                                APIException

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

APIException

all

public static ShipmentCollection all(Map<String,Object> params)
                              throws AuthenticationException,
                                     InvalidRequestException,
                                     APIConnectionException,
                                     APIException

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

APIException

all

public static ShipmentCollection all(Map<String,Object> params,
                                     String apiKey)
                              throws AuthenticationException,
                                     InvalidRequestException,
                                     APIConnectionException,
                                     APIException

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

APIException

getShippingRates

public static RateCollection getShippingRates(Map<String,Object> params)
                                       throws AuthenticationException,
                                              InvalidRequestException,
                                              APIConnectionException,
                                              APIException

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

APIException

getShippingRates

public static RateCollection getShippingRates(String id,
                                              String apiKey)
                                       throws AuthenticationException,
                                              InvalidRequestException,
                                              APIConnectionException,
                                              APIException

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

APIException

getShippingRates

public static RateCollection getShippingRates(String id,
                                              String currency_code,
                                              String apiKey)
                                       throws AuthenticationException,
                                              InvalidRequestException,
                                              APIConnectionException,
                                              APIException

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

APIException

getShippingRates

public static RateCollection getShippingRates(Map<String,Object> params,
                                              String apiKey)
                                       throws AuthenticationException,
                                              InvalidRequestException,
                                              APIConnectionException,
                                              APIException

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

APIException

getStatus

public String getStatus()

setStatus

public void setStatus(String status)

getObjectId

public String getObjectId()

setObjectId

public void setObjectId(String objectId)

getObjectOwner

public String getObjectOwner()

setObjectOwner

public void setObjectOwner(String objectOwner)

getObjectCreated

public Object getObjectCreated()

setObjectCreated

public void setObjectCreated(Object objectCreated)

getObjectUpdated

public Object getObjectUpdated()

setObjectUpdated

public void setObjectUpdated(Object objectUpdated)

getAddressFrom

public Object getAddressFrom()

setAddressFrom

public void setAddressFrom(Object addressFrom)

getAddressTo

public Object getAddressTo()

setAddressTo

public void setAddressTo(Object addressTo)

getAddressReturn

public Object getAddressReturn()

setAddressReturn

public void setAddressReturn(Object addressReturn)

getParcels

public List<Parcel> getParcels()

setParcels

public void setParcels(List<Parcel> parcels)

getShipmentDate

public Object getShipmentDate()

setShipmentDate

public void setShipmentDate(Object shipmentDate)

getExtra

public Object getExtra()

setExtra

public void setExtra(Object extra)

getCustomsDeclaration

public Object getCustomsDeclaration()

setCustomsDeclaration

public void setCustomsDeclaration(Object customsDeclaration)

getRatesUrl

public Object getRatesUrl()

setRatesUrl

public void setRatesUrl(Object ratesUrl)

getRates

public List<Rate> getRates()

setRates

public void setRates(List<Rate> rates)

getMetadata

public Object getMetadata()

setMetadata

public void setMetadata(Object metadata)

getMessages

public Object getMessages()

setMessages

public void setMessages(Object messages)