PHP Class EasyPost\Shipment

Inheritance: extends EasypostResource
Exibir arquivo Open project: easypost/easypost-php Class Usage Examples

Public Methods

Method Description
all ( mixed $params = null, string $apiKey = null ) : mixed retrieve all shipments
barcode ( mixed $params = null ) : mixed get the shipment barcode
buy ( mixed $params = null ) buy a shipment
create ( mixed $params = null, string $apiKey = null ) : mixed create a shipment
create_from_tracking_code ( mixed $params = null, string $apiKey = null ) : mixed create a shipment from tracking code
get_rates ( mixed $params = null ) get rates for a shipment
insure ( mixed $params = null ) insure the shipment
label ( mixed $params = null ) get the shipment label
lowest_rate ( array $carriers = [], array $services = [] ) : boolean get the lowest rate for the shipment
refund ( mixed $params = null ) refund a shipment
retrieve ( string $id, string $apiKey = null ) : mixed retrieve a shipment
save ( ) save a shipment
stamp ( mixed $params = null ) : mixed get the shipment stamp

Method Details

all() public static method

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

barcode() public method

get the shipment barcode
public barcode ( mixed $params = null ) : mixed
$params mixed
return mixed

buy() public method

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

create() public static method

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

create_from_tracking_code() public static method

create a shipment from tracking code
public static create_from_tracking_code ( mixed $params = null, string $apiKey = null ) : mixed
$params mixed
$apiKey string
return mixed

get_rates() public method

get rates for a shipment
public get_rates ( mixed $params = null )
$params mixed

insure() public method

insure the shipment
public insure ( mixed $params = null )
$params mixed

label() public method

get the shipment label
public label ( mixed $params = null )
$params mixed

lowest_rate() public method

get the lowest rate for the shipment
public lowest_rate ( array $carriers = [], array $services = [] ) : boolean
$carriers array
$services array
return boolean

refund() public method

refund a shipment
public refund ( mixed $params = null )
$params mixed

retrieve() public static method

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

save() public method

save a shipment
public save ( )

stamp() public method

get the shipment stamp
public stamp ( mixed $params = null ) : mixed
$params mixed
return mixed