PHP Class EasyPost\Batch

Inheritance: extends easypost\Resource
Show file Open project: easypost/easypost-php Class Usage Examples

Public Methods

Method Description
add_shipments ( mixed $params = null ) add shipments to a batch
all ( mixed $params = null, string $apiKey = null ) : mixed retrieve all batches
buy ( mixed $params = null ) buy a batch
create ( mixed $params = null, string $apiKey = null ) : mixed create a batch
create_and_buy ( mixed $params = null, string $apiKey = null ) : mixed create and buy a batch
create_scan_form ( mixed $params = null ) : mixed create a batch scan form
label ( mixed $params = null )
remove_shipments ( mixed $params = null ) remove shipments from a batch
retrieve ( string $id, string $apiKey = null ) : mixed retrieve a batch

Method Details

add_shipments() public method

add shipments to a batch
public add_shipments ( mixed $params = null )
$params mixed

all() public static method

retrieve all batches
public static all ( mixed $params = null, string $apiKey = null ) : mixed
$params mixed
$apiKey string
return mixed

buy() public method

buy a batch
public buy ( mixed $params = null )
$params mixed

create() public static method

create a batch
public static create ( mixed $params = null, string $apiKey = null ) : mixed
$params mixed
$apiKey string
return mixed

create_and_buy() public static method

create and buy a batch
public static create_and_buy ( mixed $params = null, string $apiKey = null ) : mixed
$params mixed
$apiKey string
return mixed

create_scan_form() public method

create a batch scan form
public create_scan_form ( mixed $params = null ) : mixed
$params mixed
return mixed

label() public method

public label ( mixed $params = null )
$params mixed

remove_shipments() public method

remove shipments from a batch
public remove_shipments ( mixed $params = null )
$params mixed

retrieve() public static method

retrieve a batch
public static retrieve ( string $id, string $apiKey = null ) : mixed
$id string
$apiKey string
return mixed