Dodanie do xSale listu przewozowego z zewnętrznego systemu

Do czego służy ta instrukcja

Ten artykuł pokazuje, jak zapisać w xSale dane listu przewozowego utworzonego w zewnętrznym systemie — tak, aby numer listu był widoczny na zamówieniu i mógł być dalej wykorzystywany w procesie realizacji.

Na początku znajdziesz skrótowy opis kroków i wymagania, a dalej część techniczną z endpointem i przykładem (pozostawioną bez zmian).

W tym artykule znajdziesz

• kiedy warto dodać list przewozowy do zamówienia przez API
• wymagania i dane wejściowe
• szybki przepis krok po kroku
• typowe problemy i sposób weryfikacji

Kiedy stosować

To rozwiązanie jest przydatne, gdy generowanie przesyłek i etykiet odbywa się poza xSale (np. w ERP lub w dedykowanym narzędziu), a w xSale chcesz zachować numer listu przewozowego przy zamówieniu. Dzięki temu w jednym miejscu widać status wysyłki i numer przesyłki.

Wymagania

• dostęp do REST API xSale (autoryzacja) dla właściwej organizacji
• wartość organizationName
• identyfikator zamówienia w xSale
• dane listu przewozowego z systemu zewnętrznego (np. numer, przewoźnik/usługa — zgodnie z wymaganiami endpointu)

Szybki przepis (krok po kroku)

1. Ustal ID zamówienia w xSale, do którego chcesz dopisać list przewozowy.
2. Przygotuj dane listu przewozowego z systemu zewnętrznego.
3. Wyślij zapytanie API zapisujące dane listu przewozowego na zamówieniu.
4. Zweryfikuj w xSale, czy numer listu przewozowego jest widoczny na zamówieniu.

Typowe problemy i jak je sprawdzić

• Błąd autoryzacji — sprawdź dane logowania/token oraz uprawnienia do REST API.
• Nieprawidłowy identyfikator zamówienia — upewnij się, że przekazujesz poprawne ID zamówienia w xSale.
• Numer listu nie pojawia się na zamówieniu — odśwież widok zamówienia i sprawdź odpowiedź API.
• Niepoprawny format danych — porównaj body zapytania z przykładem w części technicznej.

Szczegóły techniczne

Ten wpis opisuje proces zapisywania przez REST API w xSale danych listu przewozowego utworzonego przez zewnętrzne oprogramowanie.

Aby zapisać w zamówieniu informacje o liście przewozowym, należy skorzystać z endpointu:

PUT /{organizationName}/orders/{id}/waybill

W zapytaniu należy przekazać numer zamówienia, id kuriera, numer listu przewozowego oraz numer etykiety zwrotnej (opcjonalnie).
Dostęp do pełnej listy kurierów umożliwia zasób:

GET /{organizationName}/couriers