Page tree
Skip to end of metadata
Go to start of metadata

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

On this page

 

Authentication

Access to the SendingMethod resource does not require authentication.

List of sending methods

Collecting the list of available sending methods

GET /v1/sending_methods

Sample request

GET /v1/sending_methods HTTP/1.1
Host: api-shipx-pl.easypack24.net
Content-Type: application/json

Response

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 w Paczkomacie",
      "description": "Nadam przesyłkę w Paczkomacie"
    },
    {
      "id": "pok",
      "name": "Nadanie w POK",
      "description": "Nadam przesyłkę w Punkcie Obsługi Klienta"
    },
    {
      "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": "pop",
      "name": "Nadanie w POP",
      "description": "Nadam przesyłkę w Punkcie Obsługi Przesyłek"
    },
  ]
}


It is possible to search sending methods available for the selected service by providing the service parameter:

Sample request

GET /v1/sending_methods?service=inpost_letter_allegro

Response

HTTP/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",
      "name": "Odbiór przez Kuriera",
      "description": "Utworzę zelecenie odbioru - przesyłkę odbierze Kurier InPost"
    },
    {
      "id": "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": "pop",
      "name": "Nadanie w POP",
      "description": "Nadam przesyłkę w Punkcie Obsługi Przesyłek"
    },
  ]
}

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 available sending methods for particular services

Service name
parcel_locker
dispatch_orderpop
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)(tick)
inpost_courier_local_express(error)(tick)(tick)
inpost_courier_local_super_express(error)(tick)(tick)
inpost_courier_c2c
(tick)(tick)(tick)
  • No labels