Sending method

Owned by Former user (Deleted)
Last updated: Jul 23, 2024 by Michał Machowski
3 min read



 

SendingMethod resource object represents the sending method of a shipment.

Structure

SendingMethod resource object has the following attributes:

Attribute

Type

Description

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

branch

any_point

Service name

parcel_locker

dispatch_order

pop

branch

any_point

inpost_locker_standard

inpost_locker_pass_thru 

inpost_courier_standard

inpost_courier_express_1000

inpost_courier_express_1200

inpost_courier_express_1700

inpost_locker_allegro

inpost_courier_allegro

inpost_letter_allegro

inpost_courier_c2c 

 

 

 

Sending Method List

Retrieving the list of available sending methods

GET /v1/sending_methods

Search criteria

Parameter

Description

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