Documentation

Shipment extends EasyPostObject
in package

Table of Contents

$batch_id  : string
$batch_message  : string
$batch_status  : string
$buyer_address  : Address
$created_at  : string
$customs_info  : CustomsInfo
$fees  : array<string|int, Fee>
$forms  : array<string|int, mixed>
$from_address  : Address
$id  : string
$insurance  : Insurance
$is_return  : bool
$messages  : array<string|int, Message>
$mode  : string
$object  : string
$options  : object
$parcel  : Parcel
$postage_label  : PostageLabel
$rates  : array<string|int, Rate>
$reference  : string
$refund_status  : string
$return_address  : Address
$scan_form  : ScanForm
$selected_rate  : Rate
$status  : string
$to_address  : Address
$tracker  : Tracker
$tracking_code  : string
$updated_at  : string
$usps_zone  : bool
$_immutableValues  : array<string|int, mixed>
$_values  : array<string|int, mixed>
$_name  : mixed
$_parent  : mixed
__construct()  : mixed
Constructor for EasyPost objects.
__get()  : mixed
Getter.
__isset()  : bool
`isset` magic method.
__set()  : void
Standard accessor magic methods.
__toArray()  : array<string|int, mixed>
Convert object to an array.
__toJSON()  : string|bool
Convert object to JSON.
__toString()  : string
Convert object to a string.
__unset()  : void
`unset` magic method.
constructFrom()  : mixed
Construct EasyPost objects from a response.
convertEach()  : void
Convert each piece of an EasyPost object.
current()  : mixed
Iterator methods.
key()  : mixed
Iterator methods.
lowestRate()  : Rate
Get the lowest rate for the shipment.
next()  : void
Iterator methods.
offsetExists()  : bool
ArrayAccess methods.
offsetGet()  : mixed
ArrayAccess methods.
offsetSet()  : void
ArrayAccess methods.
offsetUnset()  : void
ArrayAccess methods.
rewind()  : void
Iterator methods.
valid()  : bool
Iterator methods.

Properties

$batch_message

public string $batch_message

$batch_status

public string $batch_status

$forms

public array<string|int, mixed> $forms

$refund_status

public string $refund_status

$tracking_code

public string $tracking_code

$_immutableValues

protected array<string|int, mixed> $_immutableValues

Methods

__construct()

Constructor for EasyPost objects.

public __construct([mixed $parent = null ][, mixed $name = null ]) : mixed
Parameters
$parent : mixed = null
$name : mixed = null
Return values
mixed —

__get()

Getter.

public __get(string $k) : mixed
Parameters
$k : string
Return values
mixed —

__isset()

`isset` magic method.

public __isset(string $k) : bool
Parameters
$k : string
Return values
bool —

__set()

Standard accessor magic methods.

public __set(string $k, mixed $v) : void
Parameters
$k : string
$v : mixed
Return values
void —

__toArray()

Convert object to an array.

public __toArray([bool|null $recursive = false ]) : array<string|int, mixed>
Parameters
$recursive : bool|null = false
Return values
array<string|int, mixed> —

__toJSON()

Convert object to JSON.

public __toJSON() : string|bool
Return values
string|bool —

__toString()

Convert object to a string.

public __toString() : string
Return values
string —

__unset()

`unset` magic method.

public __unset(string $k) : void
Parameters
$k : string
Return values
void —

constructFrom()

Construct EasyPost objects from a response.

public static constructFrom(EasyPostClient|null $client, array<string|int, mixed> $values, string $class) : mixed
Parameters
$client : EasyPostClient|null
$values : array<string|int, mixed>
$class : string
Return values
mixed —

convertEach()

Convert each piece of an EasyPost object.

public convertEach(EasyPostClient|null $client, array<string|int, mixed> $values) : void
Parameters
$client : EasyPostClient|null
$values : array<string|int, mixed>
Return values
void —

current()

Iterator methods.

public current() : mixed
Return values
mixed —

key()

Iterator methods.

public key() : mixed
Return values
mixed —

lowestRate()

Get the lowest rate for the shipment.

public lowestRate([array<string|int, string>|null $carriers = [] ][, array<string|int, string>|null $services = [] ]) : Rate

To exclude a carrier or service, prepend the string with !.

Parameters
$carriers : array<string|int, string>|null = []
$services : array<string|int, string>|null = []
Return values
Rate —

next()

Iterator methods.

public next() : void
Return values
void —

offsetExists()

ArrayAccess methods.

public offsetExists(mixed $k) : bool
Parameters
$k : mixed
Return values
bool —

offsetGet()

ArrayAccess methods.

public offsetGet(mixed $k) : mixed
Parameters
$k : mixed
Return values
mixed —

offsetSet()

ArrayAccess methods.

public offsetSet(mixed $k, mixed $v) : void
Parameters
$k : mixed
$v : mixed
Return values
void —

offsetUnset()

ArrayAccess methods.

public offsetUnset(mixed $k) : void
Parameters
$k : mixed
Return values
void —

rewind()

Iterator methods.

public rewind() : void
Return values
void —

valid()

Iterator methods.

public valid() : bool
Return values
bool —

Search results