com.shippo.model

Class Batch

java.lang.Object

com.shippo.serialization.ShippoObject

com.shippo.net.APIResource

com.shippo.model.Batch

public final class Batch
extends APIResource

Represents /batches endpoint documented at https://goshippo.com/docs/reference#batches

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Batch.BatchShipmentCollection
static class	Batch.BatchStatus
static class	Batch.Counts
static class	Batch.ShipmentStatus

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

Method Summary

Modifier and Type	Method and Description
static Batch	addShipments(String id, String[] shipmentIds) Add shipments to an existing batch provided by id.
static Batch[]	all() Get all batches created in the account.
static Batch	create(String carrierAccount, String serviceLevelToken, LabelFileType labelFileType, String metadata, BatchShipment[] shipments) Create a batch.
static Batch	get(String id, int page, Batch.ShipmentStatus objectResults) Get batch based on its ID.
Batch.BatchShipmentCollection	getBatchShipments()
Date	getCreated()
String	getDefaultCarrierAccount()
String	getDefaultServiceLevelToken()
String	getId()
LabelFileType	getLabelFileType()
String[]	getLabelURLs()
String	getMetadata()
Batch.Counts	getObjectResults()
String	getOwner()
Batch.BatchStatus	getStatus()
Date	getUpdated()
static Batch	purchase(String id) Purchase batch provided by id.
static Batch	removeShipments(String id, String[] shipmentIds) Remove shipments to an existing batch provided by id.
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

Batch

public Batch()

Method Detail

toString

public String toString()

Overrides:

toString in class ShippoObject

all

public static Batch[] all()
                   throws AuthenticationException,
                          InvalidRequestException,
                          APIConnectionException,
                          APIException,
                          UnsupportedEncodingException,
                          MalformedURLException

Get all batches created in the account.

Returns:

Array of Batch object

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

APIException

UnsupportedEncodingException

MalformedURLException

create

public static Batch create(String carrierAccount,
                           String serviceLevelToken,
                           LabelFileType labelFileType,
                           String metadata,
                           BatchShipment[] shipments)
                    throws AuthenticationException,
                           InvalidRequestException,
                           APIConnectionException,
                           APIException

Create a batch. This function corresponds to POSTing to https://api.goshippo.com/batches endpoint documented at https://goshippo.com/docs/reference#batches-create

Parameters:

carrierAccount - Carrier account ID used if not provided in individual shipments

serviceLevelToken - Associated service level token used if not provided in shipments

labelFileType - Print format of the label

metadata - Optional user content associated with the batch

shipments - Array of BatchShipment objects that will be added to the batch

Returns:

The newly created Batch object

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

APIException

get

public static Batch get(String id,
                        int page,
                        Batch.ShipmentStatus objectResults)
                 throws AuthenticationException,
                        InvalidRequestException,
                        APIConnectionException,
                        APIException

Get batch based on its ID. Optionally filter shipments inside the batch using page and objectResults parameter. This function corresponds to https://api.goshippo.com/batches/BATCH OBJECT ID endpoint documented at https://goshippo.com/docs/reference#batches-retrieve

Parameters:

id - ID of batch to retrieve

page: - the page to return. Is ignored if it is 0.

objectResults - filter shipments that have this status. Can be null if filtering is not required.

Returns:

The Batch object

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

APIException

addShipments

public static Batch addShipments(String id,
                                 String[] shipmentIds)
                          throws AuthenticationException,
                                 InvalidRequestException,
                                 APIConnectionException,
                                 APIException

Add shipments to an existing batch provided by id. This takes shipment IDs which means shipments should have been already been created using Shipment.create(java.util.Map<java.lang.String, java.lang.Object>). This method corresponds to https://api.goshippo.com/batches/BATCH OBJECT ID/add_shipments endpoint defined in https://goshippo.com/docs/reference#batches-add-shipments

Parameters:

id - Batch object ID

shipmentIds - Array of shipment Ids to be added to the batch

Returns:

The Batch object after shipments have been added

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

APIException

removeShipments

public static Batch removeShipments(String id,
                                    String[] shipmentIds)
                             throws AuthenticationException,
                                    InvalidRequestException,
                                    APIConnectionException,
                                    APIException

Remove shipments to an existing batch provided by id. This method corresponds to https://api.goshippo.com/batches/BATCH OBJECT ID/remove_shipments endpoint defined in https://goshippo.com/docs/reference#batches-remove-shipments

Parameters:

id - Batch object ID

shipmentIds - Array of shipment Ids to be removed from the batch

Returns:

The Batch object after shipments have been removed

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

APIException

purchase

public static Batch purchase(String id)
                      throws AuthenticationException,
                             InvalidRequestException,
                             APIConnectionException,
                             APIException

Purchase batch provided by id. This method corresponds to https://api.goshippo.com/batches/BATCH OBJECT ID/purchase endpoint defined in https://goshippo.com/docs/reference#batches-purchase

Parameters:

id - Batch object ID

Returns:

The Batch object after purchasing

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

APIException

getId

public String getId()

getOwner

public String getOwner()

getStatus

public Batch.BatchStatus getStatus()

getCreated

public Date getCreated()

getUpdated

public Date getUpdated()

getMetadata

public String getMetadata()

getDefaultCarrierAccount

public String getDefaultCarrierAccount()

getDefaultServiceLevelToken

public String getDefaultServiceLevelToken()

getLabelFileType

public LabelFileType getLabelFileType()

getBatchShipments

public Batch.BatchShipmentCollection getBatchShipments()

getLabelURLs

public String[] getLabelURLs()

getObjectResults

public Batch.Counts getObjectResults()