Packet attributes and packet items attributes
Types
Every values are represented as string. The type only determines the format of this string.
Bool
It can be 0
(false) or 1
(true).
Country
It's country code defined by ISO-3166-1, Alpha 2. See https://en.wikipedia.org/wiki/ISO_3166-1. For example CZ
is Czech Republic, DE
is Germany.
Currency
It's currency code defined by ISO-4217. See https://en.wikipedia.org/wiki/ISO_4217. For example CZK
, USD
or EUR
.
Date
Date in format YYYY-MM-DD. For example 2028-12-31
or 1998-01-08
.
Decimal
Decimal number. It can have 1 to 8 decimal places before the decimal point and 1 to 8 places after the decimal point. For example 0
, 1520
, 2.72
or -0.1551
.
Int
Integer number. For example 0
, 152
or -25420
.
String
String. For example red hat with Packet logo
.
Attributes by carrier
Carrier chpost, chpost_priority
Packet attributes
Key |
Type |
Required |
Summary |
Description |
Conditions |
deliveryCost |
decimal |
yes |
Delivery cost |
Delivery cost in the currency of the parcel |
Positive value |
deliveryCostEur |
decimal |
yes |
Delivery cost (EUR) |
Delivery cost in EUR |
Positive value |
Packet items attributes
Key |
Type |
Required |
Summary |
Description |
Conditions |
countryOfOrigin |
Country |
yes |
Country of origin code (2 chars) |
|
|
currency |
Currency |
yes |
Currency code (3 chars) |
|
|
customsCode |
string |
yes |
Customs code |
|
|
invoiceIssueDate |
date |
yes |
Invoice issue date |
Invoice issue date (Y-M-D format) |
|
invoiceNumber |
string |
yes |
Invoice number |
|
|
isFoodBook |
bool |
yes |
Is food/book? |
Is food or book? |
|
isVoc |
bool |
yes |
Is VOC? |
Is volatile organic compound? |
|
productEan |
string |
yes |
Product EAN |
|
|
productName |
string |
yes |
Product name |
|
|
productNameEn |
string |
yes |
Product name (EN) |
Product name in English |
|
unitsCount |
int |
yes |
Units count |
|
Positive value |
value |
decimal |
yes |
Value |
Value of packet in the currency of the parcel |
Positive value |
valueEur |
decimal |
yes |
Value (EUR) |
Value of packet in EUR |
Positive value |
weight |
int |
yes |
Weight (g) |
Weight in grams |
Positive value |
Carrier uarosan
Packet attributes
Key |
Type |
Required |
Summary |
Description |
Conditions |
deliveryCost |
decimal |
yes |
Delivery cost |
Delivery cost in the currency of the parcel |
Positive value |
deliveryCostEur |
decimal |
yes |
Delivery cost (EUR) |
Delivery cost in EUR |
Positive value |
Packet items attributes
Key |
Type |
Required |
Summary |
Description |
Conditions |
countryOfOrigin |
Country |
yes |
Country of origin code (2 chars) |
|
|
customsCode |
string |
yes |
Customs code |
|
|
productEan |
string |
yes |
Product EAN |
|
|
productName |
string |
yes |
Product name |
|
|
productNameEn |
string |
yes |
Product name (EN) |
Product name in English |
|
unitsCount |
int |
yes |
Units count |
|
Positive value |
value |
decimal |
yes |
Value |
Value of packet in the currency of the parcel |
Positive value |
valueEur |
decimal |
yes |
Value (EUR) |
Value of packet in EUR |
Positive value |
weight |
int |
yes |
Weight (g) |
Weight in grams |
Positive value |
Carrier uanovaposhta
Packet attributes
Key |
Type |
Required |
Summary |
Description |
Conditions |
deliveryCost |
decimal |
yes |
Delivery cost |
Delivery cost in the currency of the parcel |
Positive value |
deliveryCostEur |
decimal |
yes |
Delivery cost (EUR) |
Delivery cost in EUR |
Positive value |
Packet items attributes
Key |
Type |
Required |
Summary |
Description |
Conditions |
countryOfOrigin |
Country |
yes |
Country of origin code (2 chars) |
|
|
customsCode |
string |
yes |
Customs code |
|
|
productEan |
string |
yes |
Product EAN |
|
|
productName |
string |
yes |
Product name |
|
|
productNameEn |
string |
yes |
Product name (EN) |
Product name in English |
|
unitsCount |
int |
yes |
Units count |
|
Positive value |
value |
decimal |
yes |
Value |
Value of packet in the currency of the parcel |
Positive value |
valueEur |
decimal |
yes |
Value (EUR) |
Value of packet in EUR |
Positive value |
weight |
int |
yes |
Weight (g) |
Weight in grams |
Positive value |
Carrier rupost, ruposthome, ruposthomeems, ruposteconomy
Packet attributes
Key |
Type |
Required |
Summary |
Description |
Conditions |
deliveryCost |
decimal |
yes |
Delivery cost |
Delivery cost in the currency of the parcel |
Positive value |
deliveryCostEur |
decimal |
yes |
Delivery cost (EUR) |
Delivery cost in EUR |
Positive value |
Packet items attributes
Key |
Type |
Required |
Summary |
Description |
Conditions |
countryOfOrigin |
Country |
yes |
Country of origin code (2 chars) |
|
|
productNameEn |
string |
yes |
Product name (EN) |
Product name in English |
|
unitsCount |
int |
yes |
Units count |
|
Positive value |
valueEur |
decimal |
yes |
Value (EUR) |
Value of packet in EUR |
Positive value |
weight |
int |
yes |
Weight (g) |
Weight in grams |
Positive value |
Carrier gbroyal24, gbroyal48
Packet attributes
Key |
Type |
Required |
Summary |
Description |
Conditions |
deliveryCost |
decimal |
yes |
Delivery cost |
Delivery cost in the currency of the parcel |
Positive value |
deliveryCostEur |
decimal |
yes |
Delivery cost (EUR) |
Delivery cost in EUR |
Positive value |
Packet items attributes
Key |
Type |
Required |
Summary |
Description |
Conditions |
countryOfOrigin |
Country |
yes |
Country of origin code (2 chars) |
|
|
customsCode |
string |
yes |
Customs code |
|
|
productNameEn |
string |
yes |
Product name (EN) |
Product name in English |
|
unitsCount |
int |
yes |
Units count |
|
Positive value |
value |
decimal |
yes |
Value |
Value of packet in the currency of the parcel |
Positive value |
weight |
int |
yes |
Weight (g) |
Weight in grams |
Positive value |
Other carriers
Other carriers has no packet attributes and packet items attributes.