SendingMethod resource object represents the sending method of a shipment.

On this page

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®),

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

  • dispatch_order - courier dispatch

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

  • any_point - sending via any parcel locker (APM  - Paczkomat® or Parcel 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:

{
  "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

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_c2c 

(tick)

(tick)

(tick)

Sending Method List

Retrieving the list of available sending methods

GET /v1/sending_methods

Search criteria

Parameter

Description

service

Service name for which the list is retrieved

Request example

curl -X GET https://api-shipx-pl.easypack24.net/v1/sending_methods -H 'Content-Type: application/json'

Response

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"
        }
    ]
}