Skip navigation links
A B C D E G H I L M O P Q R S T U V _ 

A

Address - Class in com.shippo.model
 
Address() - Constructor for class com.shippo.model.Address
 
Address() - Constructor for class com.shippo.model.Track.Address
 
Address.ValidationMessage - Class in com.shippo.model
 
Address.ValidationResults - Class in com.shippo.model
 
AddressCollection - Class in com.shippo.model
 
AddressCollection() - Constructor for class com.shippo.model.AddressCollection
 
addShipments(String, String[]) - Static method in class com.shippo.model.Batch
Add shipments to an existing batch provided by id.
all(Map<String, Object>) - Static method in class com.shippo.model.Address
 
all(Map<String, Object>, String) - Static method in class com.shippo.model.Address
 
all() - Static method in class com.shippo.model.Batch
Get all batches created in the account.
all() - Static method in class com.shippo.model.CarrierAccount
 
all(String) - Static method in class com.shippo.model.CarrierAccount
 
all(Map<String, Object>) - Static method in class com.shippo.model.CustomsDeclaration
 
all(Map<String, Object>, String) - Static method in class com.shippo.model.CustomsDeclaration
 
all(Map<String, Object>) - Static method in class com.shippo.model.CustomsItem
 
all(Map<String, Object>, String) - Static method in class com.shippo.model.CustomsItem
 
all(Map<String, Object>) - Static method in class com.shippo.model.Manifest
 
all(Map<String, Object>, String) - Static method in class com.shippo.model.Manifest
 
all(Map<String, Object>) - Static method in class com.shippo.model.Parcel
 
all(Map<String, Object>, String) - Static method in class com.shippo.model.Parcel
 
all(Map<String, Object>) - Static method in class com.shippo.model.Refund
 
all(Map<String, Object>, String) - Static method in class com.shippo.model.Refund
 
all(Map<String, Object>) - Static method in class com.shippo.model.Shipment
 
all(Map<String, Object>, String) - Static method in class com.shippo.model.Shipment
 
all(Map<String, Object>) - Static method in class com.shippo.model.Transaction
 
all(Map<String, Object>, String) - Static method in class com.shippo.model.Transaction
 
APIConnectionException - Exception in com.shippo.exception
 
APIConnectionException(String) - Constructor for exception com.shippo.exception.APIConnectionException
 
APIConnectionException(String, Throwable) - Constructor for exception com.shippo.exception.APIConnectionException
 
APIException - Exception in com.shippo.exception
 
APIException(String, Throwable) - Constructor for exception com.shippo.exception.APIException
 
apiKey - Static variable in class com.shippo.Shippo
 
APIResource - Class in com.shippo.net
 
APIResource() - Constructor for class com.shippo.net.APIResource
 
APIResource.RequestMethod - Enum in com.shippo.net
 
apiVersion - Static variable in class com.shippo.Shippo
 
AuthenticationException - Exception in com.shippo.exception
 
AuthenticationException(String) - Constructor for exception com.shippo.exception.AuthenticationException
 

B

Batch - Class in com.shippo.model
Represents /batches endpoint documented at https://goshippo.com/docs/reference#batches
Batch() - Constructor for class com.shippo.model.Batch
 
Batch.BatchShipmentCollection - Class in com.shippo.model
 
Batch.BatchStatus - Enum in com.shippo.model
 
Batch.Counts - Class in com.shippo.model
 
Batch.ShipmentStatus - Enum in com.shippo.model
 
BatchShipment - Class in com.shippo.model
This class represents a shipment inside a Batch documented at https://goshippo.com/docs/reference#batches-batch-shipments
BatchShipment() - Constructor for class com.shippo.model.BatchShipment
 
BatchShipment.Status - Enum in com.shippo.model
 
BatchShipmentCollection() - Constructor for class com.shippo.model.Batch.BatchShipmentCollection
 

C

CarrierAccount - Class in com.shippo.model
 
CarrierAccount() - Constructor for class com.shippo.model.CarrierAccount
 
CarrierAccountCollection - Class in com.shippo.model
 
CarrierAccountCollection() - Constructor for class com.shippo.model.CarrierAccountCollection
 
CHARSET - Static variable in class com.shippo.net.APIResource
 
classURL(Class<?>) - Static method in class com.shippo.net.APIResource
 
classURLWithTrailingSlash(Class<?>) - Static method in class com.shippo.net.APIResource
 
com.shippo - package com.shippo
 
com.shippo.exception - package com.shippo.exception
 
com.shippo.model - package com.shippo.model
 
com.shippo.net - package com.shippo.net
 
com.shippo.serialization - package com.shippo.serialization
 
com.shippo.util - package com.shippo.util
 
Counts() - Constructor for class com.shippo.model.Batch.Counts
 
create(Map<String, Object>) - Static method in class com.shippo.model.Address
 
create(Map<String, Object>, String) - Static method in class com.shippo.model.Address
 
create(String, String, LabelFileType, String, BatchShipment[]) - Static method in class com.shippo.model.Batch
Create a batch.
create(Map<String, Object>) - Static method in class com.shippo.model.CarrierAccount
 
create(Map<String, Object>, String) - Static method in class com.shippo.model.CarrierAccount
 
create(Map<String, Object>) - Static method in class com.shippo.model.CustomsDeclaration
 
create(Map<String, Object>, String) - Static method in class com.shippo.model.CustomsDeclaration
 
create(Map<String, Object>) - Static method in class com.shippo.model.CustomsItem
 
create(Map<String, Object>, String) - Static method in class com.shippo.model.CustomsItem
 
create(Map<String, Object>) - Static method in class com.shippo.model.Manifest
 
create(Map<String, Object>, String) - Static method in class com.shippo.model.Manifest
 
create(Map<String, Object>) - Static method in class com.shippo.model.Parcel
 
create(Map<String, Object>, String) - Static method in class com.shippo.model.Parcel
 
create(Map<String, Object>) - Static method in class com.shippo.model.Refund
 
create(Map<String, Object>, String) - Static method in class com.shippo.model.Refund
 
create(Map<String, Object>) - Static method in class com.shippo.model.Shipment
 
create(Map<String, Object>, String) - Static method in class com.shippo.model.Shipment
 
create(Map<String, Object>) - Static method in class com.shippo.model.Transaction
 
create(Map<String, Object>, String) - Static method in class com.shippo.model.Transaction
 
createForBatch(Address, Address, List<Parcel>) - Static method in class com.shippo.model.Shipment
 
createForPurchase(String, String, String, String, String, String, String) - Static method in class com.shippo.model.Address
 
createForShipment(Shipment, String, String) - Static method in class com.shippo.model.BatchShipment
 
createForShipment(double, double, double, String, double, String) - Static method in class com.shippo.model.Parcel
 
createSync(Map<String, Object>) - Static method in class com.shippo.model.Transaction
 
createSync(Map<String, Object>, String) - Static method in class com.shippo.model.Transaction
 
CustomsDeclaration - Class in com.shippo.model
 
CustomsDeclaration() - Constructor for class com.shippo.model.CustomsDeclaration
 
CustomsDeclarationCollection - Class in com.shippo.model
 
CustomsDeclarationCollection() - Constructor for class com.shippo.model.CustomsDeclarationCollection
 
CustomsItem - Class in com.shippo.model
 
CustomsItem() - Constructor for class com.shippo.model.CustomsItem
 
CustomsItemCollection - Class in com.shippo.model
 
CustomsItemCollection() - Constructor for class com.shippo.model.CustomsItemCollection
 

D

DEBUG - Static variable in class com.shippo.Shippo
 
DEFAULT_GSON - Static variable in class com.shippo.serialization.GsonFactory
 
deserialize(JsonElement, Type, JsonDeserializationContext) - Method in class com.shippo.serialization.ShipmentDeserializer
 
deserialize(JsonElement, Type, JsonDeserializationContext) - Method in class com.shippo.serialization.ShippoRawJsonObjectDeserializer
 

E

Example - Class in com.shippo
 
Example() - Constructor for class com.shippo.Example
 

G

get(String, int, Batch.ShipmentStatus) - Static method in class com.shippo.model.Batch
Get batch based on its ID.
getAccountId() - Method in class com.shippo.model.CarrierAccount
 
getActive() - Method in class com.shippo.model.CarrierAccount
 
getAddressFrom() - Method in class com.shippo.model.Manifest
 
getAddressFrom() - Method in class com.shippo.model.Shipment
 
getAddressFrom() - Method in class com.shippo.model.Track
 
getAddressReturn() - Method in class com.shippo.model.Shipment
 
getAddressTo() - Method in class com.shippo.model.Shipment
 
getAddressTo() - Method in class com.shippo.model.Track
 
getAesItn() - Method in class com.shippo.model.CustomsDeclaration
 
getAmount() - Method in class com.shippo.model.Rate
 
getAmountLocal() - Method in class com.shippo.model.Rate
 
getApiBase() - Static method in class com.shippo.Shippo
 
getApiKey() - Static method in class com.shippo.Shippo
 
getApiVersion() - Static method in class com.shippo.Shippo
 
getAttributes() - Method in class com.shippo.model.Rate
 
getBatchShipments() - Method in class com.shippo.model.Batch
 
getCarrier() - Method in class com.shippo.model.CarrierAccount
 
getCarrier() - Method in class com.shippo.model.Track
 
getCarrierAccount() - Method in class com.shippo.model.BatchShipment
 
getCertificate() - Method in class com.shippo.model.CustomsDeclaration
 
getCertify() - Method in class com.shippo.model.CustomsDeclaration
 
getCertifySigner() - Method in class com.shippo.model.CustomsDeclaration
 
getCity() - Method in class com.shippo.model.Address
 
getCode() - Method in class com.shippo.model.Address.ValidationMessage
 
getCommercialInvoiceUrl() - Method in class com.shippo.model.Transaction
 
getCompany() - Method in class com.shippo.model.Address
 
getContentsExplanation() - Method in class com.shippo.model.CustomsDeclaration
 
getContentsType() - Method in class com.shippo.model.CustomsDeclaration
 
getCount() - Method in class com.shippo.model.Batch.BatchShipmentCollection
 
getCount() - Method in class com.shippo.model.ShippoColllectionAPIResource
3/2014: Legacy (from before newstyle pagination API)
getCountry() - Method in class com.shippo.model.Address
 
getCreated() - Method in class com.shippo.model.Batch
 
getCreationFailed() - Method in class com.shippo.model.Batch.Counts
 
getCreationSucceeded() - Method in class com.shippo.model.Batch.Counts
 
getCurrency() - Method in class com.shippo.model.Rate
 
getCurrencyLocal() - Method in class com.shippo.model.Rate
 
getCustomsDeclaration() - Method in class com.shippo.model.Shipment
 
getData() - Method in class com.shippo.model.ShippoCollection
 
getData() - Method in class com.shippo.model.ShippoColllectionAPIResource
 
getDays() - Method in class com.shippo.model.Rate
 
getDefaultCarrierAccount() - Method in class com.shippo.model.Batch
 
getDefaultServiceLevelToken() - Method in class com.shippo.model.Batch
 
getDescription() - Method in class com.shippo.model.CustomsItem
 
getDisclaimer() - Method in class com.shippo.model.CustomsDeclaration
 
getDistanceUnit() - Method in class com.shippo.model.Parcel
 
getDocuments() - Method in class com.shippo.model.Manifest
 
getDuration_terms() - Method in class com.shippo.model.Rate
 
getEelPfc() - Method in class com.shippo.model.CustomsDeclaration
 
getEmail() - Method in class com.shippo.model.Address
 
getETA() - Method in class com.shippo.model.Track
 
getExporterReference() - Method in class com.shippo.model.CustomsDeclaration
 
getExtra() - Method in class com.shippo.model.Shipment
 
getGson(Class) - Static method in class com.shippo.serialization.GsonFactory
 
getHasMore() - Method in class com.shippo.model.ShippoCollection
 
getHasMore() - Method in class com.shippo.model.ShippoColllectionAPIResource
 
getHeight() - Method in class com.shippo.model.Parcel
 
getId() - Method in class com.shippo.model.Batch
 
getId() - Method in class com.shippo.model.BatchShipment
 
getImporterReference() - Method in class com.shippo.model.CustomsDeclaration
 
getIncoterm() - Method in class com.shippo.model.CustomsDeclaration
 
getInstanceURL() - Method in class com.shippo.model.CarrierAccount
 
getInstanceURL() - Method in class com.shippo.model.CustomsDeclaration
 
getInstanceURL() - Method in class com.shippo.model.CustomsItem
 
getInstanceURL() - Method in class com.shippo.model.Manifest
 
getInstanceURL() - Method in class com.shippo.model.Parcel
 
getInstanceURL() - Method in class com.shippo.model.Refund
 
getInstanceURL() - Method in class com.shippo.model.Shipment
 
getInstanceURL() - Method in class com.shippo.model.Transaction
 
getInvoice() - Method in class com.shippo.model.CustomsDeclaration
 
getIs_Residential() - Method in class com.shippo.model.Address
 
getIsComplete() - Method in class com.shippo.model.Address
 
getIsValid() - Method in class com.shippo.model.Address.ValidationResults
 
getItems() - Method in class com.shippo.model.CustomsDeclaration
 
getLabelFileType() - Method in class com.shippo.model.Batch
 
getLabelUrl() - Method in class com.shippo.model.Transaction
 
getLabelURLs() - Method in class com.shippo.model.Batch
 
getLength() - Method in class com.shippo.model.Parcel
 
getLicense() - Method in class com.shippo.model.CustomsDeclaration
 
getLocation() - Method in class com.shippo.model.Track.TrackingEvent
 
getMassUnit() - Method in class com.shippo.model.CustomsItem
 
getMassUnit() - Method in class com.shippo.model.Parcel
 
getMessages() - Method in class com.shippo.model.Address
 
getMessages() - Method in class com.shippo.model.BatchShipment
 
getMessages() - Method in class com.shippo.model.Rate
 
getMessages() - Method in class com.shippo.model.Shipment
 
getMessages() - Method in class com.shippo.model.Transaction
 
getMetadata() - Method in class com.shippo.model.Address
 
getMetadata() - Method in class com.shippo.model.Batch
 
getMetadata() - Method in class com.shippo.model.BatchShipment
 
getMetadata() - Method in class com.shippo.model.CustomsDeclaration
 
getMetadata() - Method in class com.shippo.model.CustomsItem
 
getMetadata() - Method in interface com.shippo.model.MetadataStore
 
getMetadata() - Method in class com.shippo.model.Parcel
 
getMetadata() - Method in class com.shippo.model.Shipment
 
getMetadata() - Method in class com.shippo.model.Track
 
getMetadata() - Method in class com.shippo.model.Transaction
 
getName() - Method in class com.shippo.model.Address
 
getName() - Method in class com.shippo.model.Track.ServiceLevel
 
getNetWeight() - Method in class com.shippo.model.CustomsItem
 
getNext() - Method in class com.shippo.model.Batch.BatchShipmentCollection
 
getNonDeliveryOption() - Method in class com.shippo.model.CustomsDeclaration
 
getNotes() - Method in class com.shippo.model.CustomsDeclaration
 
getObject_created() - Method in class com.shippo.model.Refund
 
getObject_id() - Method in class com.shippo.model.Refund
 
getObject_owner() - Method in class com.shippo.model.Refund
 
getObject_purpose() - Method in class com.shippo.model.CustomsItem
 
getObject_updated() - Method in class com.shippo.model.Refund
 
getObjectCreated() - Method in class com.shippo.model.Address
 
getObjectCreated() - Method in class com.shippo.model.CustomsDeclaration
 
getObjectCreated() - Method in class com.shippo.model.CustomsItem
 
getObjectCreated() - Method in class com.shippo.model.Manifest
 
getObjectCreated() - Method in class com.shippo.model.Parcel
 
getObjectCreated() - Method in class com.shippo.model.Rate
 
getObjectCreated() - Method in class com.shippo.model.Shipment
 
getObjectCreated() - Method in class com.shippo.model.Track.TrackingEvent
 
getObjectCreated() - Method in class com.shippo.model.Transaction
 
getObjectId() - Method in class com.shippo.model.Address
 
getObjectId() - Method in class com.shippo.model.CarrierAccount
 
getObjectId() - Method in class com.shippo.model.CustomsDeclaration
 
getObjectId() - Method in class com.shippo.model.CustomsItem
 
getObjectId() - Method in class com.shippo.model.Manifest
 
getObjectId() - Method in class com.shippo.model.Parcel
 
getObjectId() - Method in class com.shippo.model.Rate
 
getObjectId() - Method in class com.shippo.model.Shipment
 
getObjectId() - Method in class com.shippo.model.Track.TrackingEvent
 
getObjectId() - Method in class com.shippo.model.Transaction
 
getObjectOwner() - Method in class com.shippo.model.Address
 
getObjectOwner() - Method in class com.shippo.model.CustomsDeclaration
 
getObjectOwner() - Method in class com.shippo.model.CustomsItem
 
getObjectOwner() - Method in class com.shippo.model.Manifest
 
getObjectOwner() - Method in class com.shippo.model.Parcel
 
getObjectOwner() - Method in class com.shippo.model.Rate
 
getObjectOwner() - Method in class com.shippo.model.Shipment
 
getObjectOwner() - Method in class com.shippo.model.Transaction
 
getObjectResults() - Method in class com.shippo.model.Batch
 
getObjectState() - Method in class com.shippo.model.CustomsDeclaration
 
getObjectState() - Method in class com.shippo.model.CustomsItem
 
getObjectState() - Method in class com.shippo.model.Manifest
 
getObjectState() - Method in class com.shippo.model.Parcel
 
getObjectStatus() - Method in class com.shippo.model.CustomsItem
 
getObjectStatus() - Method in class com.shippo.model.Parcel
 
getObjectUpdated() - Method in class com.shippo.model.Address
 
getObjectUpdated() - Method in class com.shippo.model.CustomsDeclaration
 
getObjectUpdated() - Method in class com.shippo.model.CustomsItem
 
getObjectUpdated() - Method in class com.shippo.model.Manifest
 
getObjectUpdated() - Method in class com.shippo.model.Parcel
 
getObjectUpdated() - Method in class com.shippo.model.Shipment
 
getObjectUpdated() - Method in class com.shippo.model.Track.TrackingEvent
 
getOriginCountry() - Method in class com.shippo.model.CustomsItem
 
getOwner() - Method in class com.shippo.model.Batch
 
getParam() - Method in exception com.shippo.exception.InvalidRequestException
 
getParam() - Method in exception com.shippo.exception.RequestTimeoutException
 
getParameters() - Method in class com.shippo.model.CarrierAccount
 
getParcels() - Method in class com.shippo.model.Shipment
 
getPhone() - Method in class com.shippo.model.Address
 
getPrevious() - Method in class com.shippo.model.Batch.BatchShipmentCollection
 
getProvider() - Method in class com.shippo.model.Manifest
 
getProvider() - Method in class com.shippo.model.Rate
 
getProvider_image_200() - Method in class com.shippo.model.Rate
 
getProviderImage75() - Method in class com.shippo.model.Rate
 
getPurchaseFailed() - Method in class com.shippo.model.Batch.Counts
 
getPurchaseSucceeded() - Method in class com.shippo.model.Batch.Counts
 
getQuantity() - Method in class com.shippo.model.CustomsItem
 
getRate() - Method in class com.shippo.model.Transaction
 
getRates() - Method in class com.shippo.model.Shipment
 
getRatesUrl() - Method in class com.shippo.model.Shipment
 
getResponseBody() - Method in class com.shippo.net.ShippoResponse
 
getResponseCode() - Method in class com.shippo.net.ShippoResponse
 
getResponseHeaders() - Method in class com.shippo.net.ShippoResponse
 
getServicelevel() - Method in class com.shippo.model.Rate
 
getServiceLevel() - Method in class com.shippo.model.Track
 
getServiceLevelToken() - Method in class com.shippo.model.BatchShipment
 
getShipment() - Method in class com.shippo.model.BatchShipment
Returned object will be either String containing shipment ID when retrieving or Shipment object
getShipment() - Method in class com.shippo.model.Rate
 
getShipmentDate() - Method in class com.shippo.model.Manifest
 
getShipmentDate() - Method in class com.shippo.model.Shipment
 
getShipments() - Method in class com.shippo.model.Batch.BatchShipmentCollection
 
getShippingRates(Map<String, Object>) - Static method in class com.shippo.model.Shipment
 
getShippingRates(String, String) - Static method in class com.shippo.model.Shipment
 
getShippingRates(String, String, String) - Static method in class com.shippo.model.Shipment
 
getShippingRates(Map<String, Object>, String) - Static method in class com.shippo.model.Shipment
 
getShippingRatesSync(String) - Static method in class com.shippo.model.Shipment
 
getShippingRatesSync(Map<String, Object>) - Static method in class com.shippo.model.Shipment
 
getShippingRatesSync(Map<String, Object>, String) - Static method in class com.shippo.model.Shipment
 
getSource() - Method in class com.shippo.model.Address.ValidationMessage
 
getState() - Method in class com.shippo.model.Address
 
getStatus() - Method in class com.shippo.model.Batch
 
getStatus() - Method in class com.shippo.model.BatchShipment
 
getStatus() - Method in class com.shippo.model.Manifest
 
getStatus() - Method in class com.shippo.model.Refund
 
getStatus() - Method in class com.shippo.model.Shipment
 
getStatus() - Method in class com.shippo.model.Track.TrackingEvent
 
getStatus() - Method in class com.shippo.model.Transaction
 
getStatusDate() - Method in class com.shippo.model.Track.TrackingEvent
 
getStatusDetails() - Method in class com.shippo.model.Track.TrackingEvent
 
getStreet1() - Method in class com.shippo.model.Address
 
getStreet2() - Method in class com.shippo.model.Address
 
getStreetNo() - Method in class com.shippo.model.Address
 
getTariffNumber() - Method in class com.shippo.model.CustomsItem
 
getTest() - Method in class com.shippo.model.CarrierAccount
 
getText() - Method in class com.shippo.model.Address.ValidationMessage
 
getToken() - Method in class com.shippo.model.Track.ServiceLevel
 
getTotalCount() - Method in class com.shippo.model.ShippoColllectionAPIResource
 
getTrackingHistory() - Method in class com.shippo.model.Track
 
getTrackingInfo(String, String, String) - Static method in class com.shippo.model.Track
Get tracking information of any package from given carrier.
getTrackingNumber() - Method in class com.shippo.model.Track
 
getTrackingNumber() - Method in class com.shippo.model.Transaction
 
getTrackingStatus() - Method in class com.shippo.model.Track
 
getTrackingStatus() - Method in class com.shippo.model.Transaction
 
getTrackingUrlProvider() - Method in class com.shippo.model.Transaction
 
getTransaction() - Method in class com.shippo.model.BatchShipment
 
getTransaction() - Method in class com.shippo.model.Refund
 
getUpdated() - Method in class com.shippo.model.Batch
 
getUrl() - Method in class com.shippo.model.ShippoCollection
 
getURL() - Method in class com.shippo.model.ShippoColllectionAPIResource
 
getValidationMessages() - Method in class com.shippo.model.Address.ValidationResults
 
getValidationResults() - Method in class com.shippo.model.Address
 
getValueAmount() - Method in class com.shippo.model.CustomsItem
 
getValueCurrency() - Method in class com.shippo.model.CustomsItem
 
getVerifySSL() - Static method in class com.shippo.Shippo
 
getWasTest() - Method in class com.shippo.model.Transaction
 
getWeight() - Method in class com.shippo.model.Parcel
 
getWidth() - Method in class com.shippo.model.Parcel
 
getZip() - Method in class com.shippo.model.Address
 
GsonFactory - Class in com.shippo.serialization
This class generates and stores all the Gson deserializers.
GsonFactory() - Constructor for class com.shippo.serialization.GsonFactory
 

H

HttpUtil - Class in com.shippo.util
Collection of random HTTP utility functions
HttpUtil() - Constructor for class com.shippo.util.HttpUtil
 

I

instanceURL(Class<?>, String) - Static method in class com.shippo.net.APIResource
 
InvalidRequestException - Exception in com.shippo.exception
 
InvalidRequestException(String, String, Throwable) - Constructor for exception com.shippo.exception.InvalidRequestException
 
isDEBUG() - Static method in class com.shippo.Shippo
 

L

LabelFileType - Enum in com.shippo.model
 
LIVE_API_BASE - Static variable in class com.shippo.Shippo
 

M

main(String[]) - Static method in class com.shippo.Example
 
Manifest - Class in com.shippo.model
 
Manifest() - Constructor for class com.shippo.model.Manifest
 
ManifestCollection - Class in com.shippo.model
 
ManifestCollection() - Constructor for class com.shippo.model.ManifestCollection
 
MetadataStore<T> - Interface in com.shippo.model
Common interface for Shippo objects that can store metadata.

O

overrideApiBase(String) - Static method in class com.shippo.Shippo
(FOR TESTING ONLY) If you'd like your API requests to hit your own (mocked) server, you can set this up here by overriding the base api URL.

P

Parcel - Class in com.shippo.model
 
Parcel() - Constructor for class com.shippo.model.Parcel
 
ParcelCollection - Class in com.shippo.model
 
ParcelCollection() - Constructor for class com.shippo.model.ParcelCollection
 
PRETTY_PRINT_GSON - Static variable in class com.shippo.serialization.ShippoObject
 
purchase(String) - Static method in class com.shippo.model.Batch
Purchase batch provided by id.

Q

queryToParams(String) - Static method in class com.shippo.util.HttpUtil
Parse given query string of the form name1=value1&name2=value2 and return it as Map

R

Rate - Class in com.shippo.model
 
Rate() - Constructor for class com.shippo.model.Rate
 
RateCollection - Class in com.shippo.model
 
RateCollection() - Constructor for class com.shippo.model.RateCollection
 
RATES_REQ_TIMEOUT - Static variable in class com.shippo.Shippo
 
Refund - Class in com.shippo.model
 
Refund() - Constructor for class com.shippo.model.Refund
 
RefundCollection - Class in com.shippo.model
 
RefundCollection() - Constructor for class com.shippo.model.RefundCollection
 
registerTrackingWebhook(String, String, String, String) - Static method in class com.shippo.model.Track
Register webhook for tracking shipment of a package.
removeShipments(String, String[]) - Static method in class com.shippo.model.Batch
Remove shipments to an existing batch provided by id.
request(APIResource.RequestMethod, String, Map<String, Object>, Class<T>, String) - Static method in class com.shippo.net.APIResource
 
RequestTimeoutException - Exception in com.shippo.exception
 
RequestTimeoutException(String, String, Throwable) - Constructor for exception com.shippo.exception.RequestTimeoutException
 
RequestTimeoutException(String) - Constructor for exception com.shippo.exception.RequestTimeoutException
 
retrieve(String) - Static method in class com.shippo.model.Address
 
retrieve(String, String) - Static method in class com.shippo.model.Address
 
retrieve(String) - Static method in class com.shippo.model.CarrierAccount
 
retrieve(String, String) - Static method in class com.shippo.model.CarrierAccount
 
retrieve(String) - Static method in class com.shippo.model.CustomsDeclaration
 
retrieve(String, String) - Static method in class com.shippo.model.CustomsDeclaration
 
retrieve(String) - Static method in class com.shippo.model.CustomsItem
 
retrieve(String, String) - Static method in class com.shippo.model.CustomsItem
 
retrieve(String) - Static method in class com.shippo.model.Manifest
 
retrieve(String, String) - Static method in class com.shippo.model.Manifest
 
retrieve(String) - Static method in class com.shippo.model.Parcel
 
retrieve(String, String) - Static method in class com.shippo.model.Parcel
 
retrieve(String) - Static method in class com.shippo.model.Rate
 
retrieve(String, String) - Static method in class com.shippo.model.Rate
 
retrieve(String) - Static method in class com.shippo.model.Refund
 
retrieve(String, String) - Static method in class com.shippo.model.Refund
 
retrieve(String) - Static method in class com.shippo.model.Shipment
 
retrieve(String, String) - Static method in class com.shippo.model.Shipment
 
retrieve(String) - Static method in class com.shippo.model.Transaction
 
retrieve(String, String) - Static method in class com.shippo.model.Transaction
 

S

ServiceLevel() - Constructor for class com.shippo.model.Track.ServiceLevel
 
setAccountId(String) - Method in class com.shippo.model.CarrierAccount
 
setActive(Boolean) - Method in class com.shippo.model.CarrierAccount
 
setAddressFrom(Object) - Method in class com.shippo.model.Manifest
 
setAddressFrom(Object) - Method in class com.shippo.model.Shipment
 
setAddressReturn(Object) - Method in class com.shippo.model.Shipment
 
setAddressTo(Object) - Method in class com.shippo.model.Shipment
 
setAesItn(Object) - Method in class com.shippo.model.CustomsDeclaration
 
setAmount(Object) - Method in class com.shippo.model.Rate
 
setAmountLocal(Object) - Method in class com.shippo.model.Rate
 
setApiKey(String) - Static method in class com.shippo.Shippo
 
setApiVersion(String) - Static method in class com.shippo.Shippo
 
setAttributes(Object) - Method in class com.shippo.model.Rate
 
setCarrier(String) - Method in class com.shippo.model.CarrierAccount
 
setCertificate(Object) - Method in class com.shippo.model.CustomsDeclaration
 
setCertify(Object) - Method in class com.shippo.model.CustomsDeclaration
 
setCertifySigner(Object) - Method in class com.shippo.model.CustomsDeclaration
 
setCity(Object) - Method in class com.shippo.model.Address
 
setCode() - Method in class com.shippo.model.Address.ValidationMessage
 
setCommercialInvoiceUrl(Object) - Method in class com.shippo.model.Transaction
 
setCompany(Object) - Method in class com.shippo.model.Address
 
setContentsExplanation(Object) - Method in class com.shippo.model.CustomsDeclaration
 
setContentsType(Object) - Method in class com.shippo.model.CustomsDeclaration
 
setCount(Integer) - Method in class com.shippo.model.ShippoColllectionAPIResource
3/2014: Legacy (from before newstyle pagination API)
setCountry(Object) - Method in class com.shippo.model.Address
 
setCurrency(Object) - Method in class com.shippo.model.Rate
 
setCurrencyLocal(Object) - Method in class com.shippo.model.Rate
 
setCustomsDeclaration(Object) - Method in class com.shippo.model.Shipment
 
setData(List<T>) - Method in class com.shippo.model.ShippoCollection
 
setData(List<T>) - Method in class com.shippo.model.ShippoColllectionAPIResource
 
setDays(Object) - Method in class com.shippo.model.Rate
 
setDEBUG(boolean) - Static method in class com.shippo.Shippo
 
setDescription(Object) - Method in class com.shippo.model.CustomsItem
 
setDisclaimer(Object) - Method in class com.shippo.model.CustomsDeclaration
 
setDistanceUnit(Object) - Method in class com.shippo.model.Parcel
 
setDocuments(Object) - Method in class com.shippo.model.Manifest
 
setDuration_terms(Object) - Method in class com.shippo.model.Rate
 
setEelPfc(Object) - Method in class com.shippo.model.CustomsDeclaration
 
setEmail(Object) - Method in class com.shippo.model.Address
 
setExporterReference(Object) - Method in class com.shippo.model.CustomsDeclaration
 
setExtra(Object) - Method in class com.shippo.model.Shipment
 
setHasMore(Boolean) - Method in class com.shippo.model.ShippoCollection
 
setHasMore(Boolean) - Method in class com.shippo.model.ShippoColllectionAPIResource
 
setHeight(Object) - Method in class com.shippo.model.Parcel
 
setImporterReference(Object) - Method in class com.shippo.model.CustomsDeclaration
 
setIncoterm(Object) - Method in class com.shippo.model.CustomsDeclaration
 
setInvoice(Object) - Method in class com.shippo.model.CustomsDeclaration
 
setIs_Residential(Object) - Method in class com.shippo.model.Address
 
setIsComplete(boolean) - Method in class com.shippo.model.Address
 
setIsValid() - Method in class com.shippo.model.Address.ValidationResults
 
setItems(Object) - Method in class com.shippo.model.CustomsDeclaration
 
setLabelUrl(Object) - Method in class com.shippo.model.Transaction
 
setLength(Object) - Method in class com.shippo.model.Parcel
 
setLicense(Object) - Method in class com.shippo.model.CustomsDeclaration
 
setMassUnit(Object) - Method in class com.shippo.model.CustomsItem
 
setMassUnit(Object) - Method in class com.shippo.model.Parcel
 
setMessages(Object) - Method in class com.shippo.model.Address
 
setMessages(Object) - Method in class com.shippo.model.Rate
 
setMessages(Object) - Method in class com.shippo.model.Shipment
 
setMessages(Object) - Method in class com.shippo.model.Transaction
 
setMetadata(Object) - Method in class com.shippo.model.Address
 
setMetadata(Object) - Method in class com.shippo.model.CustomsDeclaration
 
setMetadata(Object) - Method in class com.shippo.model.CustomsItem
 
setMetadata(Map<String, String>) - Method in interface com.shippo.model.MetadataStore
 
setMetadata(Object) - Method in class com.shippo.model.Parcel
 
setMetadata(Object) - Method in class com.shippo.model.Shipment
 
setMetadata(Object) - Method in class com.shippo.model.Transaction
 
setName(Object) - Method in class com.shippo.model.Address
 
setNetWeight(Object) - Method in class com.shippo.model.CustomsItem
 
setNonDeliveryOption(Object) - Method in class com.shippo.model.CustomsDeclaration
 
setNotes(Object) - Method in class com.shippo.model.CustomsDeclaration
 
setObject_created(Object) - Method in class com.shippo.model.Refund
 
setObject_id(String) - Method in class com.shippo.model.Refund
 
setObject_owner(String) - Method in class com.shippo.model.Refund
 
setObject_purpose(String) - Method in class com.shippo.model.CustomsItem
 
setObject_updated(Object) - Method in class com.shippo.model.Refund
 
setObjectCreated(Object) - Method in class com.shippo.model.Address
 
setObjectCreated(Object) - Method in class com.shippo.model.CustomsDeclaration
 
setObjectCreated(Object) - Method in class com.shippo.model.CustomsItem
 
setObjectCreated(Object) - Method in class com.shippo.model.Manifest
 
setObjectCreated(Object) - Method in class com.shippo.model.Parcel
 
setObjectCreated(Object) - Method in class com.shippo.model.Rate
 
setObjectCreated(Object) - Method in class com.shippo.model.Shipment
 
setObjectCreated(Object) - Method in class com.shippo.model.Transaction
 
setObjectId(String) - Method in class com.shippo.model.Address
 
setObjectId(String) - Method in class com.shippo.model.CarrierAccount
 
setObjectId(String) - Method in class com.shippo.model.CustomsDeclaration
 
setObjectId(String) - Method in class com.shippo.model.CustomsItem
 
setObjectId(String) - Method in class com.shippo.model.Manifest
 
setObjectId(String) - Method in class com.shippo.model.Parcel
 
setObjectId(String) - Method in class com.shippo.model.Rate
 
setObjectId(String) - Method in class com.shippo.model.Shipment
 
setObjectId(String) - Method in class com.shippo.model.Transaction
 
setObjectOwner(String) - Method in class com.shippo.model.Address
 
setObjectOwner(String) - Method in class com.shippo.model.CustomsDeclaration
 
setObjectOwner(String) - Method in class com.shippo.model.CustomsItem
 
setObjectOwner(String) - Method in class com.shippo.model.Manifest
 
setObjectOwner(String) - Method in class com.shippo.model.Parcel
 
setObjectOwner(String) - Method in class com.shippo.model.Rate
 
setObjectOwner(String) - Method in class com.shippo.model.Shipment
 
setObjectOwner(String) - Method in class com.shippo.model.Transaction
 
setObjectState(String) - Method in class com.shippo.model.CustomsDeclaration
 
setObjectState(String) - Method in class com.shippo.model.CustomsItem
 
setObjectState(String) - Method in class com.shippo.model.Manifest
 
setObjectState(String) - Method in class com.shippo.model.Parcel
 
setObjectStatus(String) - Method in class com.shippo.model.CustomsItem
 
setObjectStatus(String) - Method in class com.shippo.model.Parcel
 
setObjectUpdated(Object) - Method in class com.shippo.model.Address
 
setObjectUpdated(Object) - Method in class com.shippo.model.CustomsDeclaration
 
setObjectUpdated(Object) - Method in class com.shippo.model.CustomsItem
 
setObjectUpdated(Object) - Method in class com.shippo.model.Manifest
 
setObjectUpdated(Object) - Method in class com.shippo.model.Parcel
 
setObjectUpdated(Object) - Method in class com.shippo.model.Shipment
 
setOriginCountry(Object) - Method in class com.shippo.model.CustomsItem
 
setParameters(Object) - Method in class com.shippo.model.CarrierAccount
 
setParcels(List<Parcel>) - Method in class com.shippo.model.Shipment
 
setPhone(Object) - Method in class com.shippo.model.Address
 
setProvider(Object) - Method in class com.shippo.model.Manifest
 
setProvider(Object) - Method in class com.shippo.model.Rate
 
setProvider_image_200(Object) - Method in class com.shippo.model.Rate
 
setProviderImage75(Object) - Method in class com.shippo.model.Rate
 
setQuantity(Object) - Method in class com.shippo.model.CustomsItem
 
setRate(Object) - Method in class com.shippo.model.Transaction
 
setRates(List<Rate>) - Method in class com.shippo.model.Shipment
 
setRatesUrl(Object) - Method in class com.shippo.model.Shipment
 
setResponseBody(String) - Method in class com.shippo.net.ShippoResponse
 
setResponseCode(int) - Method in class com.shippo.net.ShippoResponse
 
setServicelevel(Object) - Method in class com.shippo.model.Rate
 
setShipment(Object) - Method in class com.shippo.model.Rate
 
setShipmentDate(Object) - Method in class com.shippo.model.Manifest
 
setShipmentDate(Object) - Method in class com.shippo.model.Shipment
 
setSource() - Method in class com.shippo.model.Address.ValidationMessage
 
setState(Object) - Method in class com.shippo.model.Address
 
setStatus(String) - Method in class com.shippo.model.Manifest
 
setStatus(String) - Method in class com.shippo.model.Refund
 
setStatus(String) - Method in class com.shippo.model.Shipment
 
setStatus(String) - Method in class com.shippo.model.Transaction
 
setStreet1(Object) - Method in class com.shippo.model.Address
 
setStreet2(Object) - Method in class com.shippo.model.Address
 
setStreetNo(Object) - Method in class com.shippo.model.Address
 
setTariffNumber(Object) - Method in class com.shippo.model.CustomsItem
 
setTest(Boolean) - Method in class com.shippo.model.CarrierAccount
 
setText() - Method in class com.shippo.model.Address.ValidationMessage
 
setTotalCount(Integer) - Method in class com.shippo.model.ShippoColllectionAPIResource
 
setTrackingNumber(Object) - Method in class com.shippo.model.Transaction
 
setTrackingStatus(Object) - Method in class com.shippo.model.Transaction
 
setTrackingUrlProvider(Object) - Method in class com.shippo.model.Transaction
 
setTransaction(Object) - Method in class com.shippo.model.Refund
 
setUrl(String) - Method in class com.shippo.model.ShippoCollection
 
setURL(String) - Method in class com.shippo.model.ShippoColllectionAPIResource
 
setValidationMessages() - Method in class com.shippo.model.Address.ValidationResults
 
setValidationResults(Address.ValidationResults) - Method in class com.shippo.model.Address
 
setValueAmount(Object) - Method in class com.shippo.model.CustomsItem
 
setValueCurrency(Object) - Method in class com.shippo.model.CustomsItem
 
setVerifySSL(boolean) - Static method in class com.shippo.Shippo
(FOR TESTING ONLY) Only disable SSL verification if you're using your own (mocked) server.
setWasTest(Object) - Method in class com.shippo.model.Transaction
 
setWeight(Object) - Method in class com.shippo.model.Parcel
 
setWidth(Object) - Method in class com.shippo.model.Parcel
 
setZip(Object) - Method in class com.shippo.model.Address
 
Shipment - Class in com.shippo.model
 
Shipment() - Constructor for class com.shippo.model.Shipment
 
SHIPMENT_GSON - Static variable in class com.shippo.serialization.GsonFactory
Shipment serializer uses a different deserializer so it can do special handling for addresses.
ShipmentCollection - Class in com.shippo.model
 
ShipmentCollection() - Constructor for class com.shippo.model.ShipmentCollection
 
ShipmentDeserializer - Class in com.shippo.serialization
 
ShipmentDeserializer() - Constructor for class com.shippo.serialization.ShipmentDeserializer
 
Shippo - Class in com.shippo
 
Shippo() - Constructor for class com.shippo.Shippo
 
ShippoCollection<T> - Class in com.shippo.model
 
ShippoCollection() - Constructor for class com.shippo.model.ShippoCollection
 
ShippoColllectionAPIResource<T> - Class in com.shippo.model
 
ShippoColllectionAPIResource() - Constructor for class com.shippo.model.ShippoColllectionAPIResource
 
ShippoException - Exception in com.shippo.exception
 
ShippoException(String) - Constructor for exception com.shippo.exception.ShippoException
 
ShippoException(String, Throwable) - Constructor for exception com.shippo.exception.ShippoException
 
ShippoObject - Class in com.shippo.serialization
 
ShippoObject() - Constructor for class com.shippo.serialization.ShippoObject
 
ShippoRawJsonObject - Class in com.shippo.serialization
Fallback class for when we do not recognize the object that we have received.
ShippoRawJsonObject() - Constructor for class com.shippo.serialization.ShippoRawJsonObject
 
ShippoRawJsonObjectDeserializer - Class in com.shippo.serialization
 
ShippoRawJsonObjectDeserializer() - Constructor for class com.shippo.serialization.ShippoRawJsonObjectDeserializer
 
ShippoResponse - Class in com.shippo.net
 
ShippoResponse(int, String) - Constructor for class com.shippo.net.ShippoResponse
 
ShippoResponse(int, String, Map<String, List<String>>) - Constructor for class com.shippo.net.ShippoResponse
 
singleClassURL(Class<?>) - Static method in class com.shippo.net.APIResource
 

T

toString() - Method in class com.shippo.model.Batch.BatchShipmentCollection
 
toString() - Method in class com.shippo.model.Batch.Counts
 
toString() - Method in enum com.shippo.model.Batch.ShipmentStatus
 
toString() - Method in class com.shippo.model.Batch
 
toString() - Method in class com.shippo.model.BatchShipment
 
toString() - Method in class com.shippo.model.Track.Address
 
toString() - Method in class com.shippo.model.Track.ServiceLevel
 
toString() - Method in class com.shippo.model.Track
 
toString() - Method in class com.shippo.model.Track.TrackingEvent
 
toString() - Method in class com.shippo.serialization.ShippoObject
 
Track - Class in com.shippo.model
Use this class to track shipments.
Track() - Constructor for class com.shippo.model.Track
 
Track.Address - Class in com.shippo.model
 
Track.ServiceLevel - Class in com.shippo.model
 
Track.TrackingEvent - Class in com.shippo.model
 
Track.TrackingStatus - Enum in com.shippo.model
 
TrackingEvent() - Constructor for class com.shippo.model.Track.TrackingEvent
 
Transaction - Class in com.shippo.model
 
Transaction() - Constructor for class com.shippo.model.Transaction
 
TRANSACTION_REQ_TIMEOUT - Static variable in class com.shippo.Shippo
 
TransactionCollection - Class in com.shippo.model
 
TransactionCollection() - Constructor for class com.shippo.model.TransactionCollection
 

U

update(String, Map<String, Object>) - Static method in class com.shippo.model.CarrierAccount
 
update(String, Map<String, Object>, String) - Static method in class com.shippo.model.CarrierAccount
 
update(Map<String, Object>) - Method in interface com.shippo.model.MetadataStore
 
update(Map<String, Object>, String) - Method in interface com.shippo.model.MetadataStore
 
urlEncode(String) - Static method in class com.shippo.net.APIResource
 

V

validate(String) - Static method in class com.shippo.model.Address
 
validate(String, String) - Static method in class com.shippo.model.Address
 
ValidationMessage() - Constructor for class com.shippo.model.Address.ValidationMessage
 
ValidationResults() - Constructor for class com.shippo.model.Address.ValidationResults
 
valueOf(String) - Static method in enum com.shippo.model.Batch.BatchStatus
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.shippo.model.Batch.ShipmentStatus
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.shippo.model.BatchShipment.Status
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.shippo.model.LabelFileType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.shippo.model.Track.TrackingStatus
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.shippo.net.APIResource.RequestMethod
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.shippo.model.Batch.BatchStatus
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.shippo.model.Batch.ShipmentStatus
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.shippo.model.BatchShipment.Status
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.shippo.model.LabelFileType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.shippo.model.Track.TrackingStatus
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.shippo.net.APIResource.RequestMethod
Returns an array containing the constants of this enum type, in the order they are declared.
VERSION - Static variable in class com.shippo.Shippo
 

_

_request(APIResource.RequestMethod, String, Map<String, Object>, Class<T>, String) - Static method in class com.shippo.net.APIResource
 
A B C D E G H I L M O P Q R S T U V _ 
Skip navigation links

Copyright © 2017 Shippo. All rights reserved.