Page Comparison

Obiekt przesyłki wykorzystywany jest do uzyskania dostępnych ofert, a jednocześnie reprezentuje ona fizyczną paczkę (lub paczki), która będzie przesłana pomiędzy określonymi adresami.

...

Code Block
POST /v1/organizations/:organization_id/shipments

...

Parametr	Typ	Opis	Walidacja
`receiver`	ReceiverForm	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 w `additional_services` podane zostaną "sms", lub "email", to analigocznie wymagane jest podanie `phone`, lub `email` jeśli zostanie przekazany atrybut `is_return == true`, atrybut `receiver` nie będzie wymagany
`sender`	SenderForm	Dane 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.
`parcels`	Array[ParcelsSimpleForm]	Dane paczek zawartych w przesyłce.	Atrybut jest wymagany. Kolekcja minimum 1, maksimum 1000
`custom_attributes`	CustomAttributesForm	Dodatkowe atrybuty przesyłki.	Atrybut nie jest wymagany. Lista dodatkowych atrybutów została opisana we wstępie. Wymagane jest podanie paczkomatu w przypadku przesyłki paczkomatowej.
`cod`	CodForm	Wartość pobrania.	Atrybut nie jest wymagany. Walidacja oraz wymagalność przekazania atrybutu występuje w momencie przekazania serwisu.
`insurance`	InsuranceForm	Kwota ubezpieczenia przesyłki.	Atrybut nie jest wymagany. Walidacja oraz wymagalność przekazania atrybutu występuje w momencie przekazania serwisu.
`reference`	String	Dodatkowy opis przesyłki, np. numer zamówienia.	Atrybut nie jest wymagany. Minimum 3 znaki, maksimum 100 znaków, możliwość przekazania pustego atrybutu.
`is_return`	Bool	Okreś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.
`additional_services`	Array[String]	Usługi dodatkowe. Dostępne usługi dodatkowe: `sms`, `email`, `saturday`. 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	String	Identyfikator broker'a generującego przesyłki w ramach innej organizacji	Atrybut nie jest wymagany.
`only_choice_of_offer`	`Boolean`	Ustawienie parametru na `true` powoduje że oferta we wszystkich przesyłkach 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). Parametr ten można ustawić również dla każdej przesyłki z osobna (w takim przypadku parametr ustawiony w przesyłce ma wyższy priorytet).	Atrybut nie jest wymagany. Defoultowa wartość `false`
`mpk`	String	Nazwa miejsca 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.
`comments`	String	Dowolny komentarz	Atrybut nie jest wymagany. maksymalnie 100 znaków możliwosć przekazania pustego atrybutu

...

Code Block

POST /v1/organizations/123/shipments HTTP/1.1
Host: api-shipx-pl.easypack24.net
Content-Type: application/json
Authorization: Bearer lkfjasd9f70y43ohriw...[ommited for brevity]...
 
{
    "mpk":"miejsce_powstania_kosztow",
	"comments": "dowolny komentarz",
    "external_customer_id": "8877xxx",
	"receiver": {
		"first_name": "Jan",
        "last_name": "Kowalski",
		"name": "Nazwa",
		"email": "receiver@example.com",
		"phone": "888000000",
		"address": {
            "id": "123",
            "street": "Malborska",
            "building_number": "130",
            "city": "Kraków",
            "post_code": "30-624",
            "country_code": "PL"
        }
	},
	"parcels": [
		{
			"id": "small package",
			"template": "small",
			"dimensions": {
				"length": "80",
				"width": "360",
				"height": "640",
				"unit": "mm"
			},
			"weight": {
				"amount": "25",
				"unit": "kg"
			},
			"tracking_number": null,
            "is_non_standard": false
		}
	],
	"custom_attributes": {
		"target_point": "KRA010"
	},
	"insurance": {
		"amount": 25,
		"currency": "PLN"
	},
	"cod": {
		"amount": 12.50,
		"currency": "PLN"
	},
	"additional_services": ["email", "sms"],
	"mpk": "Nazwa miejsca powstania kosztów."
}

...

W odpowiedzi serwer zwróci status 201 wraz z obiektem nowo utworzonej przesyłki.

...

Versions Compared

Old Version 1

New Version 2

Key

Obiekt przesyłki wykorzystywany jest do uzyskania dostępnych ofert, a jednocześnie reprezentuje ona fizyczną paczkę (lub paczki), która będzie przesłana pomiędzy określonymi adresami.