Attribute | Type | Validation |
---|---|---|
target_point | String | The attribute is not required |
dropoff_point | String | The attribute is not required, the dropoff_point attribute is required together with the sending_method attribute. The above is required only for the following values of the sending_method attribute (parcel__locker, pok, courier_pok) |
sending_method | String | The attribute is not required, acceptable values (parcel_locker, pok, pop, courier_pok, branch, dispatch_order), possibility to provide an empty attribute. |
Attribute | Type | Validation |
---|---|---|
insurance_amount | Decimal | The attribute is not required Minimum 1 less than 10000000 |
insurance_currency | String | The attribute is not required, default value PLN |
Attribute | Type | Validation |
---|---|---|
dimensions | Dimensions Simple Form | The attribute is not required, it becomes required when the template is not provided. |
template | String | The attribute is not required |
weight | Weight Simple Form | The attribute is not required, it becomes required when the template is not provided. |
id | String | The attribute is not required |
is_non_standard | Boolean | The attribute is not required, default value null |
Additional validation:
When providing a collection, it is necessary to provide the id attribute in the parcel object, if the id attribute is not provided, the user will get the respective message.
When providing a collection, it is necessary to provide the id attribute in the parcel object, if the id attribute is not unique within the request, the user will get the respective message.
Attribute | Type | Validation |
---|---|---|
height | Float | The attribute is required, minimum 1 less than 1000000, possibility to provide an empty attribute. |
length | Float | The attribute is required, minimum 1 less than 1000000, possibility to provide an empty attribute. |
width | Float | The attribute is required, minimum 1 less than 1000000, possibility to provide an empty attribute. |
unit | String | The attribute is not required, default value mm |
Attribute | Type | Validation |
---|---|---|
amount | Float | The attribute is required, minimum 1 less than 10000000, possibility to provide an empty attribute. |
unit | String | The attribute is not required, default value kg |
Attribute | Type | Validation |
---|---|---|
company_name | String | The attribute is not required, it becomes required when the first_name, last_name and address attribute is not provided. Maximum 255 characters. |
email | String | The attribute is not required, possibility to provide an empty attribute, for parcel station shipments the attribute is required. |
phone | String | The attribute is required. |
address | Address Form | The attribute is required. |
first_name | String | The attribute is not required, it becomes required when the company_name, email and phone attribute is not provided |
last_name | String | The attribute is not required, it becomes required when the company_name, email and phone attribute is not provided |
Attribute | Type | Validation |
---|---|---|
company_name | String | The attribute is not required, it becomes required when the first_name and last_name attribute is not provided. |
email | String | The attribute is not required, possibility to provide an empty attribute. |
phone | String | The attribute is required. |
address | Address Form | The attribute is required. |
first_name | String | The attribute is not required, it becomes required when the company_name, first_name or last_name attribute is not provided |
last_name | String | The attribute is not required, it becomes required when the company_name, first_name or last_name attribute is not provided |
Attribute | Type | Validation |
---|---|---|
line1 | String | The attribute is not required |
city | String | The attribute is not required |
post_code | String | The attribute is not required |
country_code | String | The attribute is not required |
street | String | The attribute is not required |
building_number | String | The attribute is not required |
Attribute | Type | Validation |
---|---|---|
street | String | The attribute is required, maximum length 255 characters, a requirement for attribute validation is no provision of the line1/line2 attributes/or provision of the building_number attribute |
building_number | String | The attribute is required, maximum length 255 characters, a requirement for attribute validation is no provision of the line1/line2 attributes/or provision of the street attribute |
line1 | String | The attribute is required, maximum length 255 characters, a requirement for attribute validation is provision of the line2 attribute |
line2 | String | The attribute is not required, maximum length 255 characters |
city | String | The attribute is required, maximum length 255 characters |
post_code | String | The attribute is required, address format according to the Polish e-mail address convention e.g. 00-000 |
country_code | String | The attribute is not required, minimum 2 characters, maximum 3 characters |
Attribute | Type | Validation |
---|---|---|
cod_amount | Decimal | The attribute is not required. Upon transfer of the data, the system is expecting values from the range from 1 to 10000000 |
cod_currency | String | The attribute is not required, default value PLN |
Attribute | Type | Validation |
---|---|---|
id | String | The attribute is not required |
shipment_id | Integer | The attribute is required • Acceptable format Integer |
offer_id | Integer | The attribute is required • Acceptable format Integer |
Attribute | Type | Validation |
---|---|---|
id | String | The attribute is not required |
shipment_id | Integer | The attribute is required • Acceptable format Integer |
offer_id | Integer | The attribute is required • Acceptable format Integer |
Attribute | Type | Validation |
---|---|---|
field_separator | String | The attribute is not required |
character_encoding | String | The attribute is not required |
text_qualifier | String | The attribute is not required |
sheets_index | Array[Integer] | The attribute is not required |
Attribute | Type | Validation |
---|---|---|
custom_attributes | String | The attribute is not required, default value nil |
insurance | String | The attribute is not required, default value nil |
cod | String | The attribute is not required, default value nil |
additional_services | String | The attribute is not required, default value nil |
service | String | The attribute is not required, default value nil |
parcels | String | The attribute is not required, default value nil |
receiver | String | The attribute is not required, default value nil |
sender | String | The attribute is not required, default value nil |