Class BatchService

java.lang.Object

com.easypost.service.BatchService

public class BatchService
extends Object

Method Summary

Modifier and Type	Method	Description
Batch	addShipments(String id, List<Shipment> shipments)	Add shipments to this Batch object.
Batch	addShipments(String id, Map<String,Object> params)	Add shipments to this Batch object.
BatchCollection	all(Map<String,Object> params)	List all Batch objects.
Batch	buy(String id)	Buy this batch.
Batch	buy(String id, Map<String,Object> params)	Buy this batch.
Batch	create()	Create a Batch object.
Batch	create(Map<String,Object> params)	Create a Batch object.
Batch	createScanForm(String id)	Create a scan form for this batch.
Batch	createScanForm(String id, Map<String,Object> params)	Create a scan form for this batch.
Batch	label(String id, Map<String,Object> params)	Label this Batch object.
Batch	removeShipments(String id, List<Shipment> shipments)	Remove shipments from this Batch object.
Batch	removeShipments(String id, Map<String,Object> params)	Remove shipments from this Batch object.
Batch	retrieve(String id)	Retrieve a Batch object from the API.

Methods inherited from class java.lang.Object

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

Method Details

create

public Batch create()
             throws EasyPostException

Create a Batch object.

Returns:

Batch object.

Throws:

EasyPostException - when the request fails.

create

public Batch create(Map<String,Object> params)
             throws EasyPostException

Create a Batch object.

Parameters:

params - Map of parameters.

Returns:

Batch object.

Throws:

EasyPostException - when the request fails.

retrieve

public Batch retrieve(String id)
               throws EasyPostException

Retrieve a Batch object from the API.

Parameters:

id - ID of the Batch to retrieve.

Returns:

Batch object.

Throws:

EasyPostException - when the request fails.

all

public BatchCollection all(Map<String,Object> params)
                    throws EasyPostException

List all Batch objects.

Parameters:

params - Map of parameters.

Returns:

BatchCollection object.

Throws:

EasyPostException - when the request fails.

label

public Batch label(String id,
 Map<String,Object> params)
            throws EasyPostException

Label this Batch object.

Parameters:

id - The ID of batch.

params - Map of parameters.

Returns:

Batch object.

Throws:

EasyPostException - when the request fails.

addShipments

public Batch addShipments(String id,
 Map<String,Object> params)
                   throws EasyPostException

Add shipments to this Batch object.

Parameters:

id - The ID of batch.

params - Map of parameters.

Returns:

Batch object.

Throws:

EasyPostException - when the request fails.

addShipments

public Batch addShipments(String id,
 List<Shipment> shipments)
                   throws EasyPostException

Add shipments to this Batch object.

Parameters:

id - The ID of batch.

shipments - List of Shipment objects.

Returns:

Batch object.

Throws:

EasyPostException - when the request fails.

removeShipments

public Batch removeShipments(String id,
 Map<String,Object> params)
                      throws EasyPostException

Remove shipments from this Batch object.

Parameters:

id - The ID of batch.

params - Map of parameters.

Returns:

Batch object.

Throws:

EasyPostException - when the request fails.

removeShipments

public Batch removeShipments(String id,
 List<Shipment> shipments)
                      throws EasyPostException

Remove shipments from this Batch object.

Parameters:

id - The ID of batch.

shipments - List of Shipment objects.

Returns:

Batch object.

Throws:

EasyPostException - when the request fails.

buy

public Batch buy(String id)
          throws EasyPostException

Buy this batch.

Parameters:

id - The ID of batch.

Returns:

Batch object.

Throws:

EasyPostException - when the request fails.

buy

public Batch buy(String id,
 Map<String,Object> params)
          throws EasyPostException

Buy this batch.

Parameters:

id - The ID of batch.

params - Map of parameters.

Returns:

Batch object.

Throws:

EasyPostException - when the request fails.

createScanForm

public Batch createScanForm(String id)
                     throws EasyPostException

Create a scan form for this batch.

Parameters:

id - The ID of batch.

Returns:

Batch object.

Throws:

EasyPostException - when the request fails.

createScanForm

public Batch createScanForm(String id,
 Map<String,Object> params)
                     throws EasyPostException

Create a scan form for this batch.

Parameters:

id - The ID of batch.

params - Map of parameters.

Returns:

Batch object.

Throws:

EasyPostException - when the request fails.