Versions Compared

Old Version 5

changes.mady.by.user Michał Machowski

Saved on

compared with

New Version 6

changes.mady.by.user Michał Machowski

Saved on

Key

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


The SendingMethod resource object represents the sending method of a shipment created in API X.

Panel
bgColor#f0f0f0
titleBGColor#f0f0f0
titleOn this page

Table of Contents
minLevel2
 

Authentication

Access to the SendingMethod resource does not require authentication.

List of sending methods

Collecting

.

On this page

Table of Contents

Structure

SendingMethod resource object has the following attributes:

Attribute

Type

Description

id

String

Unique sending method identifier. Available values:

  • parcel_locker - sending via parcel locker (APM  - Paczkomat),

  • pok - sending via Customer Service Office (Punkt Obsługi Klienta),

  • courier_pok - sending via Customer Service Office (Punkt Obsługi Klienta) that processes courier shipments

  • branch - sending via an InPost branch (Oddział)

  • dispatch_order - courier dispatch

  • pop - sending via Shipping Point (Punkcie Obsługi Przesyłek)

name

String

Shipment method name.

description

String

Sending method description, can be used in integrations.

SendingMethod resource example in JSON format:

Code Block
languagejson
{
  "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
languagejson
GET /v1/sending_methods

Sample request

Code BlockGET /v1/sending_methods HTTP/1.1 Host: 
Search criteria
Parameter
Description
service
Service name for which the list is retrieved
Request example
 Code Block
languagejson
curl -X GET https://api-shipx-pl.easypack24.net/v1/sending_methods -H 'Content-Type: application/json'
Response
 Code Block
languagejson
HTTP/1.1 200 OK
Content-Type: application/json
 


{
  "href": "https://api-shipx-pl.easypack24.net/v1/sending_methods",
  "items": [
    {
      "id": "parcel_locker",
      "name": "
Nadanie
Post at 
w
parcel 
Paczkomacie
locker",
      "description": "
Nadam
I 
przesyłkę
will 
w
post 
Paczkomacie"
a package at 
  },
    {
      "id": "pok",
      "name": "Nadanie w POK",
      "description": "Nadam przesyłkę w Punkcie Obsługi Klienta
parcel locker"
    },
    {
      "id": "
courier_
pok",
      "name": "
Nadanie
Post 
w
at 
POK",
Customer 
      "description": "Nadam przesyłkę w Punkcie Obsługi Klienta"
    },
 
Service Office",
  
{
    
   
"
id
description": "
branch",
I will post a package at Customer 
"name":
Service Office"
Nadanie


w
 
Oddziale",
   
   
"description": "Dostarczę przesyłkę do Oddziału InPost"
    
},
    {
      "id": "
dispatch
courier_
order
pok",
      "name": "
Odbiór
Post 
przez
at 
Kuriera",
Customer 
      "description": "Utworzę zelecenie odbioru - przesyłkę odbierze Kurier InPost"
    },
	{
Service Office",
      "
id
description": "
pop",
I will post a package at Customer 
"name": "Nadanie w POP",
      "description": "Nadam przesyłkę w Punkcie Obsługi Przesyłek"
    
Service Office"
    },
  
]
 
}
It is possible to search sending methods available for the selected service by providing the service parameter:
Sample request
 Code BlockGET
 
/v1/sending_methods?service=inpost_letter_allegro
Response
 Code BlockHTTP/1.1 200 OK
Content-Type: application/json
 

{
  
"href":
 
"https://api-shipx-pl.easypack24.net/v1/sending_methods?service=inpost_letter_allegro",
   "
items": [
    {
      "
id": "
dispatch_order
branch",
      "name": "
Odbiór
Post 
przez
at 
Kuriera
branch",
      "description": "
Utworzę
I 
zelecenie
will 
odbioru
deliver 
-
a 
przesyłkę
package 
odbierze
at 
Kurier
InPost 
InPost
branch"
    },
    {
      "id": "
pok
dispatch_order",
      "name": "
Nadanie
Collect 
w
by 
POK
courier",
      "description": "
Nadam
I 
przesyłkę
will 
w
create 
Punkcie
dispatch 
Obsługi
order 
Klienta"
- package will be collected 
},
by 
    {
      "id": "branch",
      "name": "Nadanie w Oddziale",
      "description": "Dostarczę przesyłkę do Oddziału InPost"
    
InPost courier"
    },
	{
      "id": "pop",
      "name": "
Nadanie
Post at 
w
Shipping 
POP
Point",
      "description": "
Nadam przesyłkę w Punkcie Obsługi Przesyłek
I will post a package at Shipping Point"
    },
  ]
}
Structure
The SendingMethod resource has the following attributes:
AttributeType
Description
idString
Unique sending method ID. Possible values:
• parcel_locker - sent in an automatic parcel station,      
• pok - sent in the Customer Service Point,       
• courier_pok - sent in the Customer Service Point handling shipping of courier shipments      
• branch - sent in a Branch,  
• dispatch_order - Collection order - courier order,        
• pop - sent in the Shipment Service Point        
nameString
Sending method name.
descriptionString
Description of the sending method that can be used in the integration.
Shipment sending methods
The table below presents 
Sending Method per Shipment Service 
The table beneath represents the available sending methods for 
 particular 
available services
Service name
parcel_locker
dispatch_order
pop
inpost_locker_standard
(tick)
(tick)
(tick)
inpost_locker_pass_thru 
(tick)
(error)
(error)
inpost_courier_standard
(error)
(tick)
(tick)
inpost_courier_express_1000
(error)
(tick)
(tick)
inpost_courier_express_1200
(error)
(tick)
(tick)
inpost_courier_express_1700
(error)
(tick)
(tick)
inpost_locker_allegro
(tick)
(tick)
(tick)
inpost_courier_allegro
(tick)
(tick)
(tick)
inpost_letter_allegro
(tick)
(tick)
(tick)
inpost_courier_local_standard
(error)
(tick)
(error)
inpost_courier_local_express
(error)
(tick)
(error)
inpost_courier_local_super_express
(error)
(tick)
(error)
inpost_courier_c2c 
(tick)
(tick)
(tick)