Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
SendingMethod
resource object represents the sending method of a shipment.
On this page
Table of Contents |
---|
Structure
SendingMethod
resource object has the following attributes:
Attribute | Type | Description |
---|---|---|
| String | Unique sending method identifier. Available values:
|
| String | Shipment method name. |
| String | Sending method description, can be used in integrations. |
SendingMethod
resource example in JSON format:
Code Block | ||
---|---|---|
| ||
{ "id": "parcel_locker", "name": "Nadanie w Paczkomacie", "description": "Nadam przesyłkę w Paczkomacie" } |
Authentication
Resource access does not require authentication.
Sending Method per Shipment Service
The table beneath represents the available sending methods for available services
Service name | parcel_locker | dispatch_order | pop | branch | any_point |
---|---|---|---|---|---|
|
|
| |||
|
|
| |||
|
|
| |||
|
|
| |||
|
|
| |||
|
|
| |||
|
|
| |||
|
|
| |||
|
|
| |||
|
|
|
Sending Method List
Retrieving the list of available sending methods
Code Block | ||
---|---|---|
| ||
GET /v1/sending_methods |
Search criteria
Parameter | Description |
---|---|
service | Service name for which the list is retrieved |
Request example
Code Block | ||
---|---|---|
| ||
curl -X GET https://api-shipx-pl.easypack24.net/v1/sending_methods -H 'Content-Type: application/json' |
Response
Code Block | ||
---|---|---|
| ||
HTTP/1.1 200 OK Content-Type: application/json [ { "id": "parcel_locker", "name": "Nadanie w automacie Paczkomat", "description": "Nadam przesyłkę w automacie Paczkomat" }, { "id": "pok", "name": "Nadanie w POK", "description": "Nadam przesyłkę w Punkcie Obsługi Klienta" }, { "id": "pop", "name": "Nadanie w POP", "description": "Nadam przesyłkę w Punkcie Obsługi Przesyłek" }, { "id": "courier_pok", "name": "Nadanie w POK", "description": "Nadam przesyłkę w Punkcie Obsługi Klienta" }, { "id": "branch", "name": "Nadanie w Oddziale", "description": "Dostarczę przesyłkę do Oddziału InPost" }, { "id": "dispatch_order", "name": "Odbiór przez Kuriera", "description": "Utworzę zelecenie odbioru - przesyłkę odbierze Kurier InPost" }, { "id": "any_point", "name": "Nadanie w dowolnym punkcie", "description": "Nadam przesyłkę w dowolnym automacie Paczkomat lub PaczkoPunkcie" } ] } |