CustomsDeclarationItem
extends AbstractApiObject
in package
CustomsDeclarationItem class represents a declaration of customs related information.
Tags
Table of Contents
- $id : id
- $required : required
- $description : string
- Description of the item.
- $gross_weight : float
- Gross weight of a single item of this kind.
- $hs_tariff_number : string
- Customs tariff number.
- $net_weight : float
- Net weight of a single item of this kind.
- $origin_country : string
- Country as uppercase ISO 3166-1 alpha-2 code.
- $quantity : int
- Number that defines how many items of this kind are in the shipment.
- $value_amount : string
- Value of a single item of this kind.
- __construct() : void
- CustomsDeclarationItem constructor.
- get_description() : string
- Getter method for description.
- get_gross_weight() : float
- Getter method for gross_weight.
- get_hs_tariff_number() : string
- Getter method for hs_tariff_number.
- get_id() : string|null
- Getter method for id.
- get_net_weight() : float
- Getter method for net_weight.
- get_origin_country() : string
- Getter method for origin_country.
- get_quantity() : int
- Getter method for quantity.
- get_required_fields() : array<string|int, mixed>
- Getter method for id.
- get_value_amount() : string
- Getter method for value_amount.
- set_description() : void
- Setter method for description.
- set_gross_weight() : void
- Setter method for gross_weight.
- set_hs_tariff_number() : void
- Setter method for hs_tariff_number.
- set_id() : void
- Setter method for id.
- set_net_weight() : void
- Setter method for net_weight.
- set_origin_country() : void
- Setter method for origin_country.
- set_quantity() : void
- Setter method for quantity.
- set_value_amount() : void
- Setter method for value_amount.
- 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
$description
Description of the item.
private
string
$description
$gross_weight
Gross weight of a single item of this kind.
private
float
$gross_weight
$hs_tariff_number
Customs tariff number.
private
string
$hs_tariff_number
Tags
$net_weight
Net weight of a single item of this kind.
private
float
$net_weight
$origin_country
Country as uppercase ISO 3166-1 alpha-2 code.
private
string
$origin_country
$quantity
Number that defines how many items of this kind are in the shipment.
private
int
$quantity
$value_amount
Value of a single item of this kind.
private
string
$value_amount
Methods
__construct()
CustomsDeclarationItem constructor.
public
__construct(string $origin_country[, string $description = '' ], int $quantity, string $value_amount, float $net_weight) : void
Parameters
- $origin_country : string
- $description : string = ''
- $quantity : int
- $value_amount : string
- $net_weight : float
Tags
Return values
void —get_description()
Getter method for description.
public
get_description() : string
Return values
string —The description.
get_gross_weight()
Getter method for gross_weight.
public
get_gross_weight() : float
Return values
float —The gross_weight.
get_hs_tariff_number()
Getter method for hs_tariff_number.
public
get_hs_tariff_number() : string
Return values
string —The hs_tariff_number.
get_id()
Getter method for id.
public
get_id() : string|null
Return values
string|null —The id.
get_net_weight()
Getter method for net_weight.
public
get_net_weight() : float
Return values
float —The net_weight.
get_origin_country()
Getter method for origin_country.
public
get_origin_country() : string
Return values
string —The origin_country.
get_quantity()
Getter method for quantity.
public
get_quantity() : int
Return values
int —The quantity.
get_required_fields()
Getter method for id.
public
get_required_fields() : array<string|int, mixed>
Return values
array<string|int, mixed> —The id.
get_value_amount()
Getter method for value_amount.
public
get_value_amount() : string
Return values
string —The value_amount.
set_description()
Setter method for description.
public
set_description(string $description) : void
Parameters
- $description : string
-
The description to set.
Return values
void —set_gross_weight()
Setter method for gross_weight.
public
set_gross_weight(float $gross_weight) : void
Parameters
- $gross_weight : float
-
The gross_weight to set.
Return values
void —set_hs_tariff_number()
Setter method for hs_tariff_number.
public
set_hs_tariff_number(string $hs_tariff_number) : void
Parameters
- $hs_tariff_number : string
-
The hs_tariff_number to set.
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_net_weight()
Setter method for net_weight.
public
set_net_weight(float $net_weight) : void
Parameters
- $net_weight : float
-
The net_weight to set.
Tags
Return values
void —set_origin_country()
Setter method for origin_country.
public
set_origin_country(string $origin_country) : void
Parameters
- $origin_country : string
-
The origin_country to set.
Tags
Return values
void —set_quantity()
Setter method for quantity.
public
set_quantity(int $quantity) : void
Parameters
- $quantity : int
-
The quantity to set.
Tags
Return values
void —set_value_amount()
Setter method for value_amount.
public
set_value_amount(string $value_amount) : void
Parameters
- $value_amount : string
-
The value_amount to set.
Tags
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.