Przewoźnicy

Przewoźników nie można tworzyć – są utworzeni na podstawie pluginów i kont do nich podłączonych.

Struktura danych JSON
Obiekt Carrier
  • id – ID w bazie danych
  • name – nazwa przewoźnika
  • pluginUniqueId – ID przewoźnika w pluginie
  • methods – tablica metod przewoźnika (obiekty CarrierMethod)
Obiekt CarrierMethod
  • id – ID w bazie danych
  • name – nazwa metody przewoźnika
  • subName – nazwa dodatkowa (zazwyczaj nazwa podłączonego konta w programie)
  • inPluginName – nazwa metody w pluginie
  • sendType – typ dostaw, enum: ONLY_ADDRESS, ONLY_PICKUP_POINT, ADDRESS_AND_PICKUP_POINT
  • availCod – czy dostępna dostawa za pobraniem?

Pobieranie przewoźników

GET

/carriers

Odpowiedź JSON - zawiera tablicę obiektów Carrier
{
    "carriers": [
        ...
    ]
}

Sprawdzanie poprawności punktu odbioru

Sprawdza poprawność punktu odbioru dla danej metody dostawy.

GET

/check_pickup_point

Parametry w ścieżce zapytania
  • pickupPoint – punkt odbioru
  • methodId – ID metody dostawy
Odpowiedź JSON
{
    "status":true
}
Pole status może przyjąć następujace wartości:
  • true – poprawny punkt odbioru
  • false – błędny punkt odbioru,
  • null – przewoźnik nie oferuje możliwości sprawdzenia poprawności punktu odbioru.