1. Strona główna
  2. Dokumentacja
  3. REST API xSale
  4. Przykłady wykorzystania R...
  5. Tworzenie listu przewozowego i pobieranie etykiety

Tworzenie listu przewozowego i pobieranie etykiety

Obsługa dokumentów przewozowych dla kurierów to jeden z podstawowych mechanizmów w procesie realizacji zamówienia. Zarówno utworzenie przesyłki z listem przewozowym, jak i wydruk etykiety kurierskiej, są możliwe do wykonania z poziomu aplikacji xSale (instrukcja krok po kroku dostępna jest tutaj).

REST API xSale daje możliwość obsłużenia tych procesów z poziomu aplikacji back-endowej.

Tworzenie listu przewozowego

Aby utworzyć list przewozowy, wykorzystaj poniższy endpoint (z tego samego zasobu korzysta proces tworzenia listu inicjowany przez system Futuriti WMS):

POST /{organizationName}/notify/wm-realized

Do utworzenia listu konieczne będzie podanie wartości FGUID zamówienia oraz szczegółów dotyczących przesyłki i jej obsługi.
Aby uzyskać FGUID, odpytaj o szczegóły zamówienia zasób:

GET /{organizationName}/orders/{id} 

Endpoint umożliwia i wymaga podania parametrów związanych z wymiarami i wagą przesyłki. Należy także przesłać id dokumentu (w polu DocumentId). Dla przesyłek realizowanych za pośrednictwem InPost można ustawić gabaryt.

Pobranie i wydruk etykiety

Wydruk etykiety można zrealizować z poziomu interfejsu xSale. Do pobrania etykiety można również wykorzystać poniższą metodę w REST API. W odpowiedzi na żądanie zwrócony zostanie plik etykiety w formacie pdf.

GET /{organizationName}/shipments/{id}/label

Numer przesyłki potrzebny do pobrania etykiety należy uzyskać z danych zamówienia:

GET /{organizationName}/orders/{id}