Struktura ShipmentFullData
W strukturze przekazywane są pełne dane na temat wybranej przesyłki. Wypełnione struktury tego typu służą do definiowania przesyłek metodą createShipments.
Pola struktury
Nazwa pola | Typ | Wymagane? | Opis |
---|---|---|---|
shipper | Address | Tak | Dane nadawcy przekazywane w strukturze adresowej |
receiver | ReceiverAddress | Tak | Dane odbiorcy przekazywane w strukturze adresowej |
pieceList | array | Tak | Dane dotyczące paczek, lista elementów typu PieceDefinition |
payment | PaymentData | Tak | Dane dotyczące płatnika oraz płatności |
service | ServiceDefinition | Tak | Dane dotyczące wybranej usługi przewozowej i usług dodatkowych |
shipmentDate | string | Tak | Data nadania (widoczna na liście przewozowym) - w formacie RRRR-MM-DD |
skipRestrictionCheck | bool | Nie | Czy pominąć sprawdzenie restrykcji |
comment | string(100) | Nie | Dodatkowy komentarz (widoczny na liście przewozowym) |
content | string(30) | Tak | Zawartość przesyłki |
reference | string(200) | Nie | Numer referencyjny przesyłki |
wayBill | string(11) | Nie | Numer listu przewozowego przesyłki |
servicePointAccountNumber | string | Nie | Wymagany, jeśli nie są podane dane odbiorcy i wybrano doręczenie do punktu |
customs | CustomsData | Nie (wymagane dla przesyłek dostarczanych poza UE) | Dane dotyczące odprawy celnej. |
shipmentId | integer | - | Tylko odpowiedź Identyfikator przesyłki (jeśli przesyłka jest już utworzona, w przeciwnym wypadku pole puste) |
created | string | - | Tylko odpowiedź Data utworzenia przesyłki, w formacie RRRR-MM-DD (jeśli przesyłka jest już utworzona, w przeciwnym wypadku pole puste) |
orderStatus | string | - | Tylko odpowiedź Informacja czy do tej przesyłki jest zamówiony kurier |
Przykład
<ShipmentFullData> <shipper> (ciało struktury adresowej) </shipper> <receiver> (ciało struktury adresowej) </receiver> <pieceList> <item> (ciało struktury definicji paczki) </item> <item> (ciało struktury definicji paczki) </item> </pieceList> <payment> (ciało metody definiującej płatność) </payment> <service> (ciało struktury definicji usługi) </service> <shipmentDate>2012-05-15</shipmentDate> <content>Biżuteria</content> <customs> (ciało metody definiującej odprawę celną) </customs> </ShipmentFullData>