Page Comparison

Walidator (ang. validator) – jest skryptem sprawdzającym poprawność przekazywanych informacji w strukturze o określonej składni (Json w przypadku metody POST lub jako parametr w przypadku metody GET). W przypadku platformy ShipX przeprowadzamy kilka wariantów walidacji jednocześnie.

Wraz z wysłaniem żądania, przekazywane są wartości podlegające walidacji, dzięki której przekazywane dane zgodne są z założeniami platformy, przyjmującej żądanie.

Dane, które nie spełniają założeń walidacji, nie są zapisywane przez platformę. Użytkownik w takim przypadku informowany jest czytelnym komunikatem zwrotnym.

Zasób posiada informacje dot. walidacji formularzy wykorzystywanych w ShipX

Panel

bgColor	#f0f0f0
titleBGColor	#f0f0f0
title	Na tej stronie

Table of Contents

minLevel	2

Custom Attributes Form

Atrybut Typ Walidacja

target_point String Atrybut nie jest wymagany

dropoff_point

String

Atrybut nie jest wymagany, wymagalność przekazania atrybutu dropoff_point występuje wraz z przekazaniem atrybutu sending_method

Powyższa wymagalność występuje wyłącznie dla następujących wartości atrybutu sending_method (parcel_locker, pok, courier_pok)

sending_method String Atrybut nie jest wymagany, dopuszczalne wartości (parcel_locker, pok, pop, courier_pok, branch, dispatch_order), możliwość przekazania pustego atrybutu.

Insurance Form

Atrybut Typ Walidacja

amount

Decimal

Atrybut nie jest wymagany

Minimum 1 mniej niż 10000000

currency String Atrybut nie jest wymagany, defoultowa wartość PLN

Parcels Simple Form

Atrybut	Typ	Walidacja
`dimensions`	Dimensions Simple Form	Atrybut nie jest wymagany, wymagalność pojawia się z chwilą kiedy template nie zostanie przekazany.
`template`	String	Atrybut nie jest wymagany
`weight`	Weight Simple Form	Atrybut nie jest wymagany, wymagalność pojawia się z chwilą kiedy template nie zostanie przekazany.
`id`	String	Atrybut nie jest wymagany
`is_non_standard`	Boolean	Atrybut nie jest wymagany, defoultowa wartość `null`

Dodatkowa walidacja:

Przekazując kolekcję, pojawia się wymagalność przekazania atrybutu id w obiekcie paczki, jeśli atrybut id nie zostanie przekazany, użytkownik otrzyma stosowny komunikat.

Przekazując kolekcję, pojawia się wymagalność przekazania atrybutu id w obiekcie paczki, jeśli atrybut id nie będzie unikatowy w ramach żądania, użytkownik otrzyma stosowny komunikat.

Dimensions Simple Form

Atrybut	Typ	Walidacja
`height`	Float	Atrybut jest wymagany, minimum 1 mniej niż 1000000, możliwość przekazania pustego atrybutu.
`length`	Float	Atrybut jest wymagany, minimum 1 mniej niż 1000000, możliwość przekazania pustego atrybutu.
`width`	Float	Atrybut jest wymagany, minimum 1 mniej niż 1000000, możliwość przekazania pustego atrybutu.
`unit`	String	Atrybut nie jest wymagany, defoultowa wartość mm

Weight Simple Form

Atrybut	Typ	Walidacja
`amount`	Float	Atrybut jest wymagany, minimum 1 mniej niż 10000000, możliwość przekazania pustego atrybutu.
`unit`	String	Atrybut nie jest wymagany, defoultowa wartość kg

Receiver Form

Atrybut	Typ	Walidacja
`company_name`	String	Atrybut nie jest wymagany, wymagalność pojawia się w momencie kiedy nie zostanie przekazany atrybut `first_name,last_name` oraz `address.` Maksimum 255 znaków.
`email`	String	Atrybut nie jest wymagany, możliwość przekazania pustego atrybutu, w przypadku przesyłek paczkomatowych atrybut jest wymagany.
`phone`	String	Atrybut jest wymagany,
`address`	Address Form	Atrybut jest wymagany,
`first_name`	String	Atrybut nie jest wymagany, wymagalność pojawia się w momencie kiedy nie zostanie przekazany atrybut `company_name`, `email` oraz `phone`
`last_name`	String	Atrybut nie jest wymagany, wymagalność pojawia się w momencie kiedy nie zostanie przekazany atrybut `company_name`, `email` oraz `phone`

Sender Form

Atrybut	Typ	Walidacja
`company_name`	String	Atrybut nie jest wymagany, wymagalność pojawia się w momencie kiedy nie zostanie przekazany atrybut `first_name` oraz `last_name`
`email`	String	Atrybut nie jest wymagany, możliwość przekazania pustego atrybutu.
`phone`	String	Atrybut jest wymagany.
`address`	Address Form	Atrybut jest wymagany.
`first_name`	String	Atrybut nie jest wymagany, wymagalność pojawia się w momencie kiedy nie zostanie przekazany atrybut `company_name`, `first_name` lub last_name
`last_name`	String	Atrybut nie jest wymagany, wymagalność pojawia się w momencie kiedy nie zostanie przekazany atrybut `company_name`, `first_name` lub `last_name`

Address Form

Atrybut	Typ	Walidacja
`line1`	String	Atrybut nie jest wymagany
`city`	String	Atrybut nie jest wymagany
post_code	String	Atrybut nie jest wymagany
country_code	String	Atrybut nie jest wymagany
street	String	Atrybut nie jest wymagany
building_number	String	Atrybut nie jest wymagany

Create Address Form

Atrybut	Typ	Walidacja
`street`	String	Atrybut jest wymagany, maksymalna długość 255 znaków, warunkiem walidacji atrybutu jest nieprzekazanie atrybutów `line1` / `line2` lub przekazanie atrybutu `building_number`
`building_number`	String	Atrybut jest wymagany, maksymalna długość 255 znaków, warunkiem walidacji atrybutu jest nieprzekazanie atrybutów `line1` / `line2` lub przekazanie atrybutu `street`
`line1`	String	Atrybut jest wymagany, maksymalna długość 255 znaków, warunkiem walidacji atrybutu jest przekazanie atrybutu `line2`
`line2`	String	Atrybut nie jest wymagany, maksymalna długość 255 znaków
`city`	String	Atrybut jest wymagany, maksymalna długość 255 znaków
`post_code`	String	Atrybut jest wymagany, format adresu zgodnie z konwencją Polskiego adresu pocztowego np. `00-000`
`country_code`	String	Atrybut nie jest wymagany, minimum 2 znaki, maksimum 3 znaki

Cod Form

Atrybut	Typ	Walidacja
amount	Decimal	Atrybut nie jest wymagany, Z chwilą przekazania danych system oczekuje wartości z przedziału od `1` do `10000000`
currency	String	Atrybut nie jest wymagany, defoultowa wartość PLN

Shipment Select Offers Form

Atrybut Typ Walidacja

id String Atrybut nie jest wymagany

shipment_id

Integer

Atrybut jest wymagany

Dopuszczalny format Integer

offer_id

Integer

Atrybut jest wymagany

Dopuszczalny format Integer

Bulk Buy Shipments Form

Atrybut Typ Walidacja

id String Atrybut nie jest wymagany

shipment_id

Integer

Atrybut jest wymagany

Dopuszczalny format Integer

offer_id

Integer

Atrybut jest wymagany

Dopuszczalny format Integer

Format Parameters Form

Atrybut	Typ	Walidacja
`field_separator`	String	Atrybut nie jest wymagany
`character_encoding`	String	Atrybut nie jest wymagany
`text_qualifier`	String	Atrybut nie jest wymagany
`sheets_index`	Array[Integer]	Atrybut nie jest wymagany

Mapping Form

Atrybut	Typ	Walidacja
`custom_attributes`	String	Atrybut nie jest wymagany, defaultowa wartość nil
`insurance`	String	Atrybut nie jest wymagany, defaultowa wartość nil
`cod`	String	Atrybut nie jest wymagany, defaultowa wartość nil
`additional_services`	String	Atrybut nie jest wymagany, defaultowa wartość nil
`service`	String	Atrybut nie jest wymagany, defaultowa wartość nil
`parcels`	String	Atrybut nie jest wymagany, defaultowa wartość nil
`receiver`	String	Atrybut nie jest wymagany, defaultowa wartość nil
`sender`	String	Atrybut nie jest wymagany, defaultowa wartość nil

Versions Compared

Old Version 4

New Version 5

Key

Custom Attributes Form

Insurance Form

Parcels Simple Form

Dimensions Simple Form

Weight Simple Form

Receiver Form

Sender Form

Address Form

Create Address Form

Cod Form

Shipment Select Offers Form

Bulk Buy Shipments Form

Format Parameters Form

Mapping Form