Versions Compared

Key

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


Info
title

Warning!

Resource available only in the following countries: PL, IT

SendingMethod resource object represents the sending method of a shipment.

PanelbgColor#f0f0f0titleBGColor#f0f0f0title


On this page

Table of Contents
minLevel2
 

Structure

SendingMethod resource object has the following attributes:

Attribute

Type

Description

Availability

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)

PL, IT

name

String

Shipment method name.

PL, IT

description

String

Sending method description, can be used in integrations.

PL, IT

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

Search criteria

Parametr

Parameter

Opis

Description

Dostępny

Availability

service

Service name for which the list is retrieved

PL, IT

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

Service 

The table beneath represents the available sending methods for available services

Nazwa usługi

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)

(tick)

(error)

inpost_courier_local_express

(error)

(tick)

(tick)

(error)

inpost_courier_local_super_express

(error)

(tick)

(tick)

(error)

inpost_courier_c2c 

(tick)

(tick)

(tick)