Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Info |
---|
Warning! Resource available only in the following countries: PL, IT |
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 | Availability |
---|---|---|---|
| String | Unique sending method identifier. Available values:
| PL, IT |
| String | Shipment method name. | PL, IT |
| String | Sending method description, can be used in integrations. | PL, IT |
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 List
Retrieving the list of available sending methods
Code Block | ||
---|---|---|
| ||
GET /v1/sending_methods |
Search criteria
Parameter | Description | Availability |
---|---|---|
service | Service name for which the list is retrieved | PL, IT |
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 { "href": "https://api-shipx-pl.easypack24.net/v1/sending_methods", "items": [ { "id": "parcel_locker", "name": "Post at parcel locker", "description": "I will post a package at parcel locker" }, { "id": "pok", "name": "Post at Customer Service Office", "description": "I will post a package at Customer Service Office" }, { "id": "courier_pok", "name": "Post at Customer Service Office", "description": "I will post a package at Customer Service Office" }, { "id": "branch", "name": "Post at branch", "description": "I will deliver a package at InPost branch" }, { "id": "dispatch_order", "name": "Collect by courier", "description": "I will create dispatch order - package will be collected by InPost courier" }, { "id": "pop", "name": "Post at Shipping Point", "description": "I will post a package at Shipping Point" }, ] } |
Sending Method per Shipment Service
The table beneath represents the available sending methods for available services
Service name | parcel_locker | dispatch_order | pop |
---|---|---|---|
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
|