Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

ParametrTypOpisWalidacja
receiverReceiverForm

Dane odbiorcy paczki

Atrybut jest wymagany.

  • jeśli ma być przedstawiona oferta usługi kurierskiej, należy podać co najmniej receiver.company_name i/lub receiver.first_name i receiver.last_name oraz obiekt address
  • jeśli ma być przedstawiona oferta paczkomatowa należy podać receiver.phone_number i receiver.email
  • podanie wszystkich danych umożliwi przedstawienie ofert obu typów
  • jeśli zostanie przekazany atrybut is_return == true, atrybut receiver nie będzie wymagany
senderSenderFormDane nadawcy paczki.

Atrybut nie jest wymagany.

  • Jeśli nie zostaną podane żadne dane, domyślnie zostaną użyte dane organizacji, w ramach której tworzona jest przesyłka.
parcelsArray[ParcelsSimpleForm]

Dane paczek zawartych w przesyłce.

Atrybut jest wymagany.

  • Kolekcja minimum 1, maksimum 1000
custom_attributesCustomAttributesForm

Dodatkowe atrybuty przesyłki, np.

"custom_attributes": {
"target_point": "KRA010"
}

Atrybut nie jest wymagany.

  • Lista dodatkowych atrybutów została opisana we wstępie.
  • Wymagane jest podanie paczkomatu w przypadku przesyłki paczkomatowej.
codCodFormWartość pobrania.

Atrybut nie jest wymagany.

  • Walidacja oraz wymagalność przekazania atrybutu występuje w momencie przekazania serwisu.
insuranceInsuranceFormKwota ubezpieczenia przesyłki.

Atrybut nie jest wymagany.

  • Walidacja oraz wymagalność przekazania atrybutu występuje w momencie przekazania serwisu.
referenceStringDodatkowy opis przesyłki, np. numer zamówienia.

Atrybut nie jest wymagany.

  • Minimum 3 znaki, maksimum 100 znaków, możliwość przekazania pustego atrybutu.
is_returnBoolOkreśla przesyłkę jako zwrotną.

Atrybut nie jest wymagany.

  • Dopuszczalne wartości (true, false)
  • Możliwość przekazania pustego atrybutu.
  • Jeśli ustawione na true, określa przesyłkę jako zwrotną. W takiej sytuacji dane nadawcy i odbiorcy zostaną automatycznie zamienione miejscami.
serviceString

Wybrana przez klienta usługa.

Dostępne wartości patrz API X Rozmiary i usługi dla przesyłek.

Atrybut jest wymagany.


additional_servicesArray[String]

Usługi dodatkowe.

Dostępne usługi dodatkowe: smsemailsaturday.

API X Rozmiary i usługi dla przesyłek 

Atrybut nie jest wymagany.

  • Atrybut walidowany w momencie przekazania wartości.
  • Przekazując atrybut additional_services system sprawdza przekazanie atrybutu service, jeśli atrybut service nie zostanie przekazany lub przekazany atrybut additional_services nie mieści się w zakresie przekazanego serwisu, użytkownik otrzyma błąd.
external_customer_id
StringIdentyfikator broker'a generującego przesyłki w ramach innej organizacji.Atrybut nie jest wymagany.
only_choice_of_offerBooleanUstawienie parametru na truepowoduje że oferta zostanie wybrana dla podanego serwisu, ale nie zostanie automatycznie opłacona. Taka przesyłkę trzeba opłacić przed końcem wygaśnięcia oferty wykonując operacje (Opłacanie przesyłki)

Atrybut nie jest wymagany.



tracking_number


String

Numer paczki.
Aby móc nadawać numer paczki, należy posiadać odpowiednie uprawnienia.
Numery paczek można nadawać tylko dla przesyłek paczkomatowych. 

Atrybut nie jest wymagany.

  • Atrybut walidowany w momencie przekazania wartości.
  • Możliwość przekazania pustego atrybutu.
  • Atrybut jest walidowany na podstawie przypisanego do organizacji wyrażenia regularnego, jeśli ogranizacja posiada odpowiednie uprawnienia.
mpkStringMiejsce powstania kosztów

Atrybut nie jest wymagany.

  • maksymalnie 255 znaków
  • jeśli atrybut jest podany, weryfikujemy czy przynależy do organizacji, z której wykonywane jest żądanie
  • możliwość przekazania pustego atrybutu

Miejsce powstania kosztów musi najpierw być dodane do organizacji, aby można je było przypisać do przesyłki.

commentsStringDowolny komentarz

Atrybut nie jest wymagany

  • maksymalnie 100 znaków
  • możliwość przekazania pustego atrybutu

...

Tworzenie rozmiaru przesyłki w trybie uproszczonym, na podtsawie podstawie przekazywanych parametrów

Na temat rozmiarów można przczytać przeczytać osobnym dokumencie

Aplikacja umożiwia umożliwia wygenerowanie przesyłki z rozmiarem, bez podawania jego nazwy. Rozmiar generowany jest na podstawie przekazywanych parametrów,

...