Metoda bookCourier

Metoda umożliwia zamówienie kuriera do zdefiniowanych wcześniej przesyłek, na konkretny dzień w ramach wskazanych godzin. Po otrzymaniu żądania metoda sprawdza dane wejściowe: czy możliwy jest przyjazd kuriera w wyznaczonym czasie i czy wszystkie wskazane przesyłki mogą być odebrane w jednym miejscu (zgodność adresów nadania). W przypadku wystąpienia błędu komunikat zwrotny będzie wskazywał przyczynę problemu.

Zamówić kuriera można

dla listy przygotowanych wcześniej przesyłek (przez podanie identyfikatorów przesyłek w parametrze shipmentIdList)
bez podawanie przesyłek - wymagana jest wtedy struktura shipmentOrderInfo z podstawowymi danymi o zamówieniu

Uwaga - w przypadku zamawiania kuriera bez podania listy przesyłek, takie zamówienie będzie niewidoczne na liście przesyłek w serwisie www.

Parametry wejściowe

Nazwa pola	Typ	Wymagane?	Opis
authData	AuthData	Tak	Struktura autoryzacyjna
pickupDate	string	Tak	Data w formacie RRRR-MM-DD
pickupTimeFrom	string	Tak	Godzina, od której przesyłka jest gotowa do odebrania (w formacie GG:MM)
pickupTimeTo	string	Tak	Godzina, do której można odebrać przesyłkę (w formacie GG:MM)
additionalInfo	string(50)	Nie	Dodatkowe informacje dla kuriera
shipmentIdList	array	Tak(*)	Tablica elementów typu string, zawierająca identyfikatory przesyłek
shipmentOrderInfo	shipmentOrderInfo	Tak(*)	Zbiorcze dane dotyczące nadawcy oraz ilości oraz wagi przesyłek
courierWithLabel	boolean	Nie	Czy kurier ma przyjechać z etykietą

(*) - tylko jeden z tych elementów (lista zdefiniowanych przesyłek, lub podstawowe dane o przesyłkach) jest wymagany. Jeśli podane są oba struktura shipmentOrderInfo jest ignorowana.

Parametry wyjściowe

Nazwa pola	Typ	Wymagane?	Opis
orderId	array	Tak	Tablica elementów typu string z numerami zleceń

Przykłady wywołań

Zamówienie kuriera dla trzech utworzonych wcześniej przesyłek

<authData>
    <username>testomir</username>
    <password>testalski</password>
</authData>
<pickupDate>2012-10-23</pickupDate>
<pickupTimeFrom>10:00</pickupTimeFrom>
<pickupTimeTo>14:00</pickupTimeTo>
<additionalInfo>Uwaga, paczki zawierają szkło</additionalInfo>
<shipmentIdList>
    <item>1234567</item>
    <item>1234568</item>
    <item>1234569</item>
</shipmentIdList>

Zamówienie kuriera bez definiowania paczek

<authData>
    <username>testomir</username>
    <password>testalski</password>
</authData>
<pickupDate>2012-10-23</pickupDate>
<pickupTimeFrom>10:00</pickupTimeFrom>
<pickupTimeTo>14:00</pickupTimeTo>
<additionalInfo>Uwaga, paczki zawierają szkło</additionalInfo>
<shipmentOrderInfo>
    <shipper>
        <name>Testomir Testalski</name>
        <postalCode>02796</postalCode>
        <city>Warszawa</city>
        <street>Wąwozowa</street>
        <houseNumber>2</houseNumber>
        <contactPerson>Testomir Testalski</contactPerson>
        <contactEmail>testomir@jakasdomena.eu</contactEmail>
    </shipper>
    <numberOfExPieces>3</numberOfExPieces>
    <numberOfDrPieces>0</numberOfDrPieces>
    <totalWeight>40</totalWeight>
    <heaviestPieceWeight>15</heaviestPieceWeight>
</shipmentOrderInfo>

Wróć do listy tematów