Class OrderService

java.lang.Object

com.easypost.service.OrderService

public class OrderService
extends Object

Method Summary

Modifier and Type	Method	Description
Order	buy(String id, Rate rate)	Buy this Order.
Order	buy(String id, Map<String,Object> params)	Buy this Order.
Order	create(Map<String,Object> params)	Create an Order object from a map of parameters.
Order	newRates(String id)	Get new rates for this Order.
Order	newRates(String id, Map<String,Object> params)	Get new rates for this Order.
Order	retrieve(String id)	Retrieve an Order 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 Order create(Map<String,Object> params)
             throws EasyPostException

Create an Order object from a map of parameters.

Parameters:

params - Map of parameters.

Returns:

Order object.

Throws:

EasyPostException - when the request fails.

retrieve

public Order retrieve(String id)
               throws EasyPostException

Retrieve an Order object from the API.

Parameters:

id - ID of the Order to retrieve.

Returns:

Order object.

Throws:

EasyPostException - when the request fails.

newRates

public Order newRates(String id)
               throws EasyPostException

Get new rates for this Order.

Parameters:

id - The ID of order.

Returns:

Order object.

Throws:

EasyPostException - when the request fails.

newRates

public Order newRates(String id,
 Map<String,Object> params)
               throws EasyPostException

Get new rates for this Order.

Parameters:

id - The ID of order.

params - Map of parameters.

Returns:

Order object.

Throws:

EasyPostException - when the request fails.

buy

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

Buy this Order.

Parameters:

id - The ID of order.

params - Map of parameters.

Returns:

Order object.

Throws:

EasyPostException - when the request fails.

buy

public Order buy(String id,
 Rate rate)
          throws EasyPostException

Buy this Order.

Parameters:

id - The ID of order.

rate - Rate to buy.

Returns:

Order object.

Throws:

EasyPostException - when the request fails.