Form validation

target_point

String

The attribute is required for the following services:
inpost_locker_standard, inpost_locker_allegro, inpost_locker_pass_thru, inpost_letter_allegro.

dropoff_point

String

The attribute is required for the following services:
inpost_locker_pass_thru inpost_letter_allegro.

Attribute is not required, dropoff_point  attribute is required together with sending_method attribute

The above condition is required only for the following values of sending_method  attribute (parcel_locker, pok, courier_pok) 

sending_method

String

Attribute is not required, acceptable values (parcel_locker, pok, pop, courier_pok, branch, dispatch_order), empty value allowed

insurance_amount

Decimal

The attribute is required for the following services:
inpost_courier_standard, inpost_courier_express_1000, inpost_courier_express_1200, inpost_courier_express_1700, inpost_courier_palette when passing the COD attribute.

Attribute is not required, greater than or equal to 1, less than 10000000

insurance_currency

String

Attribute is not required, default value: PLN

template

String

Attribute is not required

dimensions

Dimensions Simple Form

Attribute is not required, it becomes required when the template  attribute is not provided

weight

Weight Simple Form

Attribute is not required, it becomes required when the template  attribute is not provided

id

String

Attribute is not required

When passing a collection of parcels, it is required to pass the id  attribute. If the id  attribute is not passed, or if it is not unique in scope of the request, the user will receive validation message.

is_non_standard

Boolean

Attribute is not required, default value: null

height

Float

Attribute is required, greater than or equal to 1, less than 1000000, empty value allowed

length

Float

Attribute is required, greater than or equal to 1, less than 1000000, empty value allowed

width

Float

Attribute is required, greater than or equal to 1, less than 1000000, empty value allowed

unit

String

Attribute is not required, default value: mm

amount

Float

Attribute is required, greater than or equal to 1, less than 10000000, empty value allowed

unit

String

Attribute is not required, default value: kg

company_name

String

Attribute is not required, it becomes required when first_name,last_name, address attributes are not provided

maximum length 255.

email

String

Attribute is required only for parcel locker shipments, in other cases attribute is not required

address

Address Form

Attribute is required

first_name

String

Attribute is not required, it becomes required when company_name, email, phone attributes are not provided 

last_name

String

Attribute is not required, it becomes required when company_name, email, phone attributes are not provided 

phone

String

regex

country

digits

PL: \A(\(?((\+)|00)48\)?)

PL (Poland

9 digits

FR: \A(\(?((\+)|00)33\)?)

FR (France)

9 digits

 ES: \A(\(?((\+)|00)34\)?)

ES (Spain)

9 digits

 BE: \A(\(?((\+)|00)32\)?)

BE (Belgium)

8-9 digits

 DE: \A(\(?((\+)|00)49\)?)

DE (Germany)

10-11 digits

 LU: \A(\(?((\+)|00)352\)?)

LU (Luxembourg)

9 digits

 PT: \A(\(?((\+)|00)351\)?)

PT (Portugal)

9 digits

 AT: \A(\(?((\+)|00)43\)?)

AT (Austria)

7-13 digits

 GB: \A(\(?((\+)|00)44\)?)

GB (United Kingdom)

10 digits

 IT: \A(\(?((\+)|00)39\)?)

IT (Italy)

9-10 digits

 NL: \A(\(?((\+)|00)31\)?)

NL (Netherlands)

10 digits

 IE: \A(\(?((\+)|00)353\)?)

IE (Ireland)

10 digits

 MC: \A(\(?((\+)|00)377\)?)

MC (Monaco)

8 digits

 CH: \A(\(?((\+)|00)41\)?)

CH (Switzerland)

9 digits

 UA: \A(\(?((\+)|00)380\)?)

UA (Ukraine)

9 digits

 BY: \A(\(?((\+)|00)375\)?)

BY (Belarus)

9 digits

 BG: \A(\(?((\+)|00)359\)?)

BG (Bulgaria)

8-9 digits

 CY: \A(\(?((\+)|00)357\)?)

CY (Cyprus)

8 digits

 CZ: \A(\(?((\+)|00)420\)?)

CZ (Czech Republic)

9 digits

 DK: \A(\(?((\+)|00)45\)?)

DK (Denmark)

8 digits

 EE: \A(\(?((\+)|00)372\)?)

EE (Estonia)

7-8 digits

 FI: \A(\(?((\+)|00)358\)?)

FI (Finland)

8-10 digits

 GR: \A(\(?((\+)|00)30\)?)

GR (Greece)

10 digits

 HU: \A(\(?((\+)|00)36\)?)

HU (Hungary)

9 digits

 LT: \A(\(?((\+)|00)370\)?)

LT (Lithuania)

8 digits

 LV: \A(\(?((\+)|00)371\)?)

LV (Latvia)

8 digits

 MT: \A(\(?((\+)|00)356\)?)

MT (Malta)

8 digits

 SE: \A(\(?((\+)|00)46\)?)

SE (Sweden)

9 digits

company_name

String

Attribute is not required, it becomes required when first_name, last_name attributes are not provided  

email

String

The attribute is required

phone

String

Attribute is required. Only 9 digits (333222111)

address

Address Form

The attribute is required for the following services:

inpost_courier_standard, inpost_courier_express_1000, inpost_courier_express_1200, inpost_courier_express_1700, inpost_courier_palette.

first_name

String

Attribute is not required, it becomes required when company_name, first_name, last_name attributes are not provided 

last_name

String

Attribute is not required, it becomes required when company_name, first_name, last_name attributes are not provided

line1

String

The attribute is not required, the requirement appears when the address attribute is passed

Maximum of 255 characters.

city

String

The attribute is not required, the requirement appears when the address attribute is passed

Maximum of 255 characters.

post_code

String

The attribute is not required, the requirement appears when the address attribute is passed

Maximum of 255 characters.

country_code

String

Attribute is required

street

String

The attribute is not required, the requirement appears when the address attribute is passed

Maximum of 255 characters.

building_number

String

The attribute is not required, the requirement appears when the address attribute is passed

Maximum of 255 characters.

street

String

Attribute is required, maximum length 255, It is a condition for attribute validation that attributes are not passed line1 / line2  or building_number

building_number

String

Attribute is required, maximum length 255, It is a condition for attribute validation that attributes are not passed line1 / line2 or street

line1

String

Attribute is required, maximum length 255, It is a condition for attribute validation that attributes are not passed line2

line2

String

Attribute is not required, maximum length 255

city

String

Attribute is required, maximum length 255

post_code

String

Attribute is required, address format according to the address convention of the post office in the user's country

country_code

String

Attribute is not required, minimum length 2, maximum length 3