Pickup
extends AbstractApiObject
in package
Pickup class represents a pickup request for a shipment.
Tags
Table of Contents
- $id : id
- $required : required
- $carrier : string
- Acronym of the carrier you want to use.
- $pickup_address : pickup_address
- Address where the shipment should be picked up.
- $pickup_time : pickup_time
- Defined time window when the carrier should pickup shipments.
- $shipments : shipments
- Array of shipments to be picked up.
- __construct() : void
- Pickup constructor.
- get_carrier() : string
- Getter method for carrier.
- get_id() : string|null
- Getter method for id.
- get_pickup_address() : Address
- Getter method for pickup_address.
- get_pickup_time() : PickupTime
- Getter method for pickup time.
- get_required_fields() : array<string|int, mixed>
- Getter method for id.
- get_shipments() : array<string|int, mixed>
- Getter method for shipments.
- set_carrier() : void
- Setter method for carrier.
- set_id() : void
- Setter method for id.
- set_pickup_address() : void
- Setter method for pickup_address.
- set_pickup_time() : void
- Setter method for pickup time.
- set_shipments() : void
- Setter method for shipments.
- to_array() : array<string|int, mixed>
- Getter method for parameter array.
- to_string() : string
- Getter method for string representation.
Properties
$id
protected
id
$id
$required
protected
required
$required
$carrier
Acronym of the carrier you want to use.
private
string
$carrier
$pickup_address
Address where the shipment should be picked up.
private
pickup_address
$pickup_address
$pickup_time
Defined time window when the carrier should pickup shipments.
private
pickup_time
$pickup_time
$shipments
Array of shipments to be picked up.
private
shipments
$shipments
Methods
__construct()
Pickup constructor.
public
__construct(string $carrier, PickupTime $pickup_time[, Address $pickup_address = null ]) : void
Parameters
- $carrier : string
- $pickup_time : PickupTime
- $pickup_address : Address = null
Tags
Return values
void —get_carrier()
Getter method for carrier.
public
get_carrier() : string
Return values
string —The carrier.
get_id()
Getter method for id.
public
get_id() : string|null
Return values
string|null —The id.
get_pickup_address()
Getter method for pickup_address.
public
get_pickup_address() : Address
Tags
Return values
Address —The pickup_address.
get_pickup_time()
Getter method for pickup time.
public
get_pickup_time() : PickupTime
Tags
Return values
PickupTime —The pickup time.
get_required_fields()
Getter method for id.
public
get_required_fields() : array<string|int, mixed>
Return values
array<string|int, mixed> —The id.
get_shipments()
Getter method for shipments.
public
get_shipments() : array<string|int, mixed>
Return values
array<string|int, mixed> —The shipments list.
set_carrier()
Setter method for carrier.
public
set_carrier(string $carrier) : void
Parameters
- $carrier : string
-
The carrier to set.
Tags
Return values
void —set_id()
Setter method for id.
public
set_id(string $id) : void
Parameters
- $id : string
-
The id to set.
Return values
void —set_pickup_address()
Setter method for pickup_address.
public
set_pickup_address(Address $pickup_address) : void
Parameters
- $pickup_address : Address
-
The pickup_address to set.
Tags
Return values
void —set_pickup_time()
Setter method for pickup time.
public
set_pickup_time(PickupTime $pickup_time) : void
Parameters
- $pickup_time : PickupTime
-
The pickup time to set.
Tags
Return values
void —set_shipments()
Setter method for shipments.
public
set_shipments(array<string|int, mixed> $shipments) : void
Parameters
- $shipments : array<string|int, mixed>
-
The shipments to set.
Return values
void —to_array()
Getter method for parameter array.
public
to_array() : array<string|int, mixed>
Return values
array<string|int, mixed> —The class object as array.
to_string()
Getter method for string representation.
public
to_string() : string
Return values
string —The object as string representation.