Wersja angielska: https://ordermanagerapi.mediaport.pl/api-doc
API służy do pobierania informacji o zamówieniach i generowaniu etykiet.
Wymagane jest zalogowanie, z użyciem loginu i hasła dostarczonego przez Media Port.
Identyfikator supplierId niezbędny do wywoływania metod API również musi być dostarczony przez Media Port.
API dostepne jest pod adresem
https://ordermanagerapi.mediaport.pl/
Dla ułatwienia procesu integracji udostępniona jest wersja Swaggera pod adresem
https://ordermanagerapi.mediaport.pl/swagger/index.html
Dla celów testowych udostępniona jest wersja Sandbox
https://sandbox-ordermanagerapi.mediaport.pl/
https://sandbox-ordermanagerapi.mediaport.pl/swagger/index.html
Użytkownikiem testowym jest użytkownik
| username: | testapimediaport1 |
| password: | 1passapimediaport |
| supplierId: | 100 |
Zamówienia trafiają do systemu jako zamówienia o statusie: Nowe
Zamówienia mogą być wieloelementowe, każdy element zamówienia dotyczy 1 sztuki produktu
Poki nie powstanie etykieta zamówienie może zostać anulowane, zarówno przez klienta jak i dostawcę
Zamówienie posiada unikalny numer zamówienia: orderNumber. Każdy element zamówienia posiada swoj unikalny numer elementu zamówienia: orderItemId
Każda z metod API oprocz metody logowania posiada parametr supplierId
W przypadku gdy dostawca posiada skonfigurowanych wiele miejsc wysylki (tzw. konta dzieci) dostawca rodzic może wygenerować etykietę za dziecko.
W sytuacji gdy dostawca nie posiada wielu miejsc wysyłki lub też pracuje w ramach głównego konta, podawać należy swój identyfikator dostawcy.
Po pobraniu informacji o nowych zamówieniach (metoda orders) dostawca przygotowuje paczkę do wysyłki
Jeśli dostawca musi anulować element zamówienia musi to zrobic przed wygenerowaniem etykiety metodą cancel-order-item.
Następnie dla każdego zamówienia dostawca generuje etykietę (metodą generate-label) podając numer zamówienia: orderNumber jak i kolekcję numerów elementów zamówienia: orderItemIds
Jedna etykieta jest generowana dla całego zamówienia dostawcy, dla wszystkich nieanulowanych elementów.
Parametr: orderItemIds jest konieczny by zapewnić spojnosć systemu, by uniknać sytuacji w ktorej w miedzyczasie miedzy pobraniem informacji o zamowieniu a wygenerowaniem etykiety zamówienie bedzie anulowane przez klienta.
Po wygenerowaniu etykiety, etykiety w formacie PDF należy pobrać metodą get-labels
Protokół dla etykiet należy pobrać metodą get-protocols
Etykiety jak i protokoły podzielone są na wiele plików. Jedeń plik dotyczy jednego kuriera.