[1.6.0] Form validation

When sending a request, the values provided are subject to validation, ensuring that the transferred data are consistent with the assumptions of the platform receiving the request.

Data that does not fulfil the validation assumptions are not saved by the platform. In such case, the user is informed by a legible return message.

The resource has information concerning validation of the forms used in ShipX.


Custom Attributes Form

Attribute

Type

Validation

Attribute

Type

Validation

target_point

String

Attribute is not required

dropoff_point

String

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 Form

Attribute

Type

Validation

Attribute

Type

Validation

insurance_amount

Decimal

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

insurance_currency

String

Attribute is not required, default value: PLN


 

Parcels Simple Form

Attribute

Type

Validation

Attribute

Type

Validation

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


 

Dimensions Simple Form

Attribute

Type

Validation

Attribute

Type

Validation

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


 

Weight Simple Form

Attribute

Type

Validation

Attribute

Type

Validation

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


 

Receiver Form

Attribute

Type

Validation

Attribute

Type

Validation

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

phone

String

Attribute is required. Only 9 digits (333222111)

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 


 

Sender Form

Attribute

Type

Validation

Attribute

Type

Validation

company_name

String

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

email

String

Attribute is not required, empty value allowed

phone

String

Attribute is required. Only 9 digits (333222111)

address

Address Form

Attribute is required

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


 

Address Form

Attribute

Type

Validation

Attribute

Type

Validation

line1

String

Attribute is not required

city

String

Attribute is not required

post_code

String

Attribute is not required

country_code

String

Attribute is not required

street

String

Attribute is not required

building_number

String

Attribute is not required


 

Create Address Form

Attribute

Type

Validation

Attribute

Type

Validation

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


 

Cod Form

Attribute

Type

Validation

Attribute

Type

Validation

cod_amount 

Decimal

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

cod_currency 

String

Attribute is not required, default value: PLN


 

Shipment Select Offers Form

Attribute

Type

Validation

Attribute

Type

Validation

id

String

Attribute is not required

shipment_id

Integer

Attribute is required, acceptable format Integer

offer_id

Integer

Attribute is required, acceptable format Integer


 

Bulk Buy Shipments Form

Attribute

Type

Validation

Attribute

Type

Validation

id 

String

Attribute is not required

shipment_id 

Integer

Attribute is required

offer_id 

Integer

Attribute is required


 

Format Parameters Form

Attribute

Type

Validation

Attribute

Type

Validation

field_separator

String

Attribute is not required

character_encoding

String

Attribute is not required

text_qualifier

String

Attribute is not required

sheets_index

Array[Integer]

Attribute is not required


 

Mapping Form

Attribute

Type

Validation

Attribute

Type

Validation

custom_attributes

String

Attribute is not required, default value: null

insurance

String

Attribute is not required, default value: null

cod

String

Attribute is not required, default value: null

additional_services

String

Attribute is not required, default value: null

service

String

Attribute is not required, default value: null

parcels

String

Attribute is not required, default value: null

receiver

String

Attribute is not required, default value: null

sender

String

Attribute is not required, default value: null