TANIEPRZESYLKIKURIERSKIE.PL RESTFUL API
Witamy w Tanieprzesylkikurierskie.pl RESTful API, dzięki API uzyskasz dostęp do usług Tanieprzesylkikurierskie.pl.
Wykorzystanie
RESTful API Tanieprzesylkikurierskie.pl dostępne jest pod adresem https://api.tanieprzesylkikurierskie.pl/. Wersja testowa API dostępna jest pod adresem https://api-beta.tanieprzesylkikurierskie.pl/.
Klucz API
Do korzystania z API potrzebujesz specjalnego klucza.
Klucz możesz otrzymać, kontaktując się z działem IT poprzez e-mail [email protected].
Klucz API należy umieścić w nagłówku X-Api-Key: xyz
lub adresie URL jako parametr api_key
i wykorzystywać go do wszystkich zapytań.
Autoryzacja
Niektóre zasoby wymagają autoryzacji tokenem. Token uzyskasz za pomocą zasobu Token POST.
Token może być umieszczony w parametrze GET jako parametr token
(/?token=foo), w BODY zapytania
lub w nagłówku (Authorization: Bearer {token}
).
Wersja
Aktualna wersja RESTful API to v1. Prosimy o kontakt z naszym działem IT ([email protected]), aby otrzymywać informacje o planowanych zmianach.
API umożliwia korzystanie ze starszych wersji. W celu skorzystania z innej wersji API
należy w nagłówku zapytania przesłać parametr Accept: application/x.zk.v1+json
. Gdzie v1
oznacza wersje API.
Brak parametru spowoduje przyjęcie aktualnej wersji API, co w przypadku aktualizacji API może być niebezpieczne.
Należy zawsze przesyłać ww. parametr. Dokumentacja na tej stronie wyświetla zawsze aktualną wersję API.
Dostęp do dokumentacji wcześniejszych wersji API https://api.tanieprzesylkikurierskie.pl/vX
, gdzie vX
oznacza wersje API (np. v1).
Język
API może zwracać błędy w języku polskim oraz angielskim. Domyślnym językiem jest język polski.
Zmiany można dokonać ustawiając w nagłówku parametr Accept-Language: en
.
Kontakt
Wszystkie problemy z działaniem API oraz pytania należy kierować bezpośrednio na adres e-mail [email protected].
Zasoby ¶
Token ¶
Reprezentacja zasobu Token. Token pozwala na wykonywanie operacji wymagających wcześniejszej autoryzacji. Na podstawie parametru ‘token’ użytkownik jest autoryzowany. Ważność Tokena wynosi 120 minut. Konto musi zostać wcześniej utworzone w serwisie Tanieprzesylkikurierskie.pl.
StwórzPOST/token
Stwórz nowy token wykorzystując parametry username
oraz password
.
- Przyjmowane parametry
- email (string, wymagany) - Adres e-mail.
- password (string, wymagany) - Hasło.
URI
200
Headers
Content-Type: application/json
Body
{
"token": "foo"
}
401
Headers
Content-Type: application/json
Body
{
"message": "Podane dane dostępowe są nieprawidłowe.",
"error_code": "AuthenticationFailed",
"status_code": 401
}
400
Headers
Content-Type: application/json
Body
{
"errors": {
"email": [
"Opis błędu",
],
"password": [
"Opis błędu.",
]
},
"error_code": "InvalidInput",
"status_code": 400
}
UsuńDELETE/token
Usuń token i zakończ sesje z parametrem token
.
- Przyjmowane parametry
- token (string, wymagany) - Token.
URI
Headers
Content-Type: application/json
Body
{
"token": "foo"
}
201
Headers
Content-Type: application/json
401
Headers
Content-Type: application/json
Body
{
"message": "Token wygasł.",
"error_code": "TokenExpired",
"status_code": 401
}
400
Headers
Content-Type: application/json
Body
{
"message": "Opis błędu.",
"error_code": "Kod Błędu",
"status_code": 400
}
OdświeżPUT/token
Odśwież token przesyłając parametr token
.
- Przyjmowane parametry
- token (string, wymagany) - Wygasły token.
URI
Headers
Content-Type: application/json
Body
{
"token": "foo"
}
200
Headers
Content-Type: application/json
Body
{
"token": "foo"
}
400
Headers
Content-Type: application/json
Body
{
"message": "Token jest nieprawidłowy.",
"error_code": "TokenInvalid",
"status_code": 400
}
User ¶
Reprezentacja zasobu User.
StwórzPOST/user
Stwórz nowego użytkownika.
- Przyjmowane parametry
name
(string, wymagany, max: 60) - Imię.surname
(string, wymagany, max: 60) - Nazwisko.email
(string, wymagany, email, max: 255) - Adres e-mail.password
(string, wymagany, min: 8, max: 255) - Hasło.street
(string, wymagany, max: 100) - Ulica.house_number
(string, wymagany, max: 10) - Numer domu.door_number
(string, max: 10) - Numer mieszkania.post_code
(string, wymagany, max: 10) - Kod pocztowy.city
(string, wymagany, max: 50) - Miastocountry_id
(integer, wymagany, występuje w zasobie GET /order/resources/countries) - ID kraju.phone
(string, wymagany) - Telefon.company
(string, max: 200) - Nazwa firmy.tax_number
(string, max: 16) - Numer NIP.bank_account_number
(digits, iban format, min: 26, max: 26) - Numer konta bankowego.regulations_approval
(bool, wymagany, accepted) - Akceptacja regulaminu. Regulamin znajduję się na stronie: https://tanieprzesylkikurierskie.pl/regulaminmarketing_approval
(bool, wymagany, accepted) - Zgoda na umieszczenie danych teleadresowych w bazie serwisu i wykorzystanie ich zgodnie z ustawą z dnia 29.09.1997 o ochronie danych osobowych - Dz. U. nr 133 poz. 883.marketing_approval_2
(bool) - Zgoda na otrzymywanie na podany adres e-mail informacji handlowej.
URI
Headers
Content-Type: application/json
Body
{
"name": "Jan",
"surname": "Kurier",
"email": "[email protected]",
"password": "password",
"street": "Testowa",
"house_number": "12",
"door_number": "1",
"post_code": "82-300",
"city": "Elbląg",
"country_id": 1,
"phone": "500111222",
"company": "ABC Sp. z o.o.",
"tax_number": "123-333-333-33",
"bank_account_number": "85389228519243536419972688",
"regulations_approval": true,
"marketing_approval": true
}
200
Headers
Content-Type: application/json
Body
{
"user_id": 34344
}
400
Headers
Content-Type: application/json
Body
{
"errors": {
"email": [
"Opis błędu",
],
"password": [
"Opis błędu.",
]
},
"error_code": "InvalidInput",
"status_code": 400
}
PobierzGET/user/data
Pobierz dane użytkownika.
- Zwracane dane
user_id
(integer) - Unikalny identyfikator użytkownika.partner_id
(integer) - Unikalny identyfikator partnera (jeśli użytkownik jest partnerem Tanieprzesylkikurierskie.pl).email
(string) - Zarejestrowany adres e-mail użytkownika.balance
(numeric) - Slado konta.status
(integer) - Status konta (informuje o tym czy konto jest aktywne).tax_number
(string) - Numer NIP użytkownika.bank_account_number
(string, 26 znaków, iban) - Numer konta bankowego użytkownika w formacie IBAN (bez kodu kraju).messages
(array[message
], opcjonalny) - Tablica z wiadomościami do wyświetlenia.default_address
(object) - Domyślny adres użytkownika, wykorzystywany np. do FV.name
(string) - Imię.surname
(string) - Nazwisko.company
(string) - Nazwa firmy.street
(string) - Ulica.house_number
(string) - Numer domu.door_number
(string) - Numer mieszkania.post_code
(string) - Kod pocztowy.city
(string) - Miasto.country_id
(integer) - Kod kraju.phone
(string) - Telefon.
shipping_address
(object) - Domyślny adres użytkownika do wysyłki.name
(string) - Imię.surname
(string) - Nazwisko.company
(string) - Nazwa firmy.street
(string) - Ulica.house_number
(string) - Numer domu.door_number
(string) - Numer mieszkania.post_code
(string) - Kod pocztowy.city
(string) - Miasto.country_id
(integer) - Kod kraju.phone
(string) - Telefon.pop
(objectpop
) - Paczkomat.pp
(objectpp
) - Placówka Poczty.ruch
(objectruch
) - Punkt RUCHu.email
(string, email) - E-mail.
settings
(object) - Ustawienia użytkownikamonthly_invoice
(bool) - Zbiorcza faktura miesięczna.new_order_notification
(bool) - Informacja mailowa o nowym zamówieniu.new_payment_notification
(bool) - Informacja mailowa o nowej płatności.receiver_notification
(bool) - Informacja mailowa do odbiorcy.two_factor_authentication
(bool) - Dwuskładnikowe uwierzytelnienie.
package_templates
(array) - Szablony paczek.courier_id
(integer, opcjonalny, akceptowane wartości: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12) - Numer ID kuriera.1
- Geis (K-ex)2
- GLS3
- DPD4
- InPost5
- DHL7
- Geis (ETL)8
- InPost Zagranica9
- InPost Paczkomaty11
- Patron Service12
- Fedex13
- GEODIS14
- UPS16
- Poczta Polska palety17
- Pocztex18
- Rohlig SUUS19
- ORLEN Paczka20
- Ambro Express22
- Rhenus Logistics23
- InPost Szybkie Zwroty24
- InPost Paczkomat → Kurier25
- InPost Paczkomaty Ekonomiczne
product_id
(integer, opcjonalny, akceptowane wartości: 1, 2, 3) - Typ przesyłki.- 1 - Koperta.
- 2 - Paczka.
- 3 - Paleta.
package_id
(integer, opcjonalny, zwracane wartości: 1, 2) - Rodzaj opakowania.- 1 - Standardowe.
- 2 - Niestandardowe.
weight
(numeric, opcjonalny) - Waga przesyłki.length
(numeric, opcjonalny) - Długość przesyłki.width
(numeric, opcjonalny) - Szerokość przesyłki.height
(numeric, opcjonalny) - Wysokość przesyłki.cod_value
(numeric, opcjonalny) - Wartość pobrania.insurance_value
(numeric, opcjonalny) - Wartość ubezpieczenia.description
(string, opcjonalny) - Opis zawartości.use_for_allegro
(bool, domyslnie: true) - Używaj dla przesyłek wprowadzonych przez Allegro.use_for_form
(bool, domyslnie: true) - Używaj dla przesyłek wprowadzonych ręcznie.allegro_description_from_auction
(bool, domyslnie: true) - Dla przesyłek z Allegro pobierz zawartość paczki z nazwy aukcji.
- Zwracany obiekt
message
title
(string, zawsze zwracany) - Tytuł.message
(string, zawsze zwracany) - Wiadomość.
- Zwracany obiekt
pop
code
(string, zawsze zwracany) - Kod.country_code
(string, zawsze zwracany) - Kod kraju.city
(string, zawsze zwracany) - Miasto.street
(string, zawsze zwracany) - Ulica.house_number
(string, opcjonalny) - Numer domu.province
(string, zawsze zwracany) - Województwo.post_code
(string, zawsze zwracany) - Kod pocztowy.description
(string, opcjonalny) - Dodatkowy opis.
- Zwracany obiekt
pp
display_name
(string, zawsze zwracany) - Nazwa wyświetlana, np. “Elbląg - Plac Dworcowy 2 (UP238538)”.code
(string, zawsze zwracany) - kod Placówki, np. “238538”.name_prefix
(string, zawsze zwracany) - prefiks nazwy, np. “UP”.name
(string, zawsze zwracany) - nazwa placówki, np. “Elbląg 2”.province
(string, zawsze zwracany) - województwo, np. “warmińsko-mazurskie”.district
(string, zawsze zwracany) - gmina, np. “Elbląg”.place
(string, zawsze zwracany) - miejsce, np. “Elbląg”.post_code
(string, zawsze zwracany) - kod pocztowy, np. “82310”.city
(string, zawsze zwracany) - miasto, np. “Elbląg”.street
(string, zawsze zwracany) - ulica, np. “Plac Dworcowy”.house_number
(string, zawsze zwracany) - numer domu, np. “2”.print_name
(string, zawsze zwracany) - nazwa do wydruku, np. “UP Elbląg 2”.branch_network
(string, zawsze zwracany) - sieć placówek, np. “POCZTAPOLSKA”.support_sms_notification
(boolean, zawsze zwracany) - czy obsługuje usługę “Powiadomienie SMS”, np. “true”.support_eprzesylka
(boolean, zawsze zwracany) - czy obsługuje usługę ePrzesylka, np. “true”.support_przesylkabiznesowaplus
(boolean, zawsze zwracany) - czy obsługuje usługę “przesylkabiznesowaplus”, np. “true”.support_przesylkabiznesowa
(boolean, zawsze zwracany) - czy obsługuje usługę przesylkabiznesowa, np. “true”.
- Zwracany obiekt
ruch
display_name
(string, zawsze zwracany) - Nazwa wyświetlana, np. “Warszawa, Borowej Góry 2”.code
(string, zawsze zwracany) - kod Punktu RUCHu, np. “WS-492393-25-18”.street_name
(string, zawsze zwracany) - prefiks nazwy, np. “BOROWEJ GÓRY 2”.city
(string, zawsze zwracany) - miejscowość Punktu, np. “Warszawa”.district
(string, zawsze zwracany) - gmina Punktu, np. “Warszawa”.longitude
(numeric, zawsze zwracany) - długość geograficzna, np. “20.92”.latitude
(numeric, zawsze zwracany) - szerokość geograficzna, np. “52.23”.province
(string, zawsze zwracany) - województwo, np. “Mazowieckie”.cash_on_delivery
(boolean, zawsze zwracany) - miasto, np. “Elbląg”.opening_hours
(string, zawsze zwracany) - godziny otwarcia, np. “Pn-Pt:06:00-20:00, So:06:00-18:00, Nd: nieczynne”.location
(string, zawsze zwracany) - opis lokalizacji punktu, np. “Kiosk z wejściem, znajdujący się na ul. Powstańców Wielkopolskich, przy skrzyżowaniu ulic Powstańców Wielkopolskich z Wyszyńskiego. Obok znajduje się kwiaciarnia.”.psd
(string, zawsze zwracany) - nr PDS (brak przykładu).available
(boolean, zawsze zwracany) - czy placówka jest dostępna, np. “true”.point_type
(string, zawsze zwracany) - Rodzaj Punktu/Kiosku (własny - PSD, partnerski – PSP)
URI
Headers
Content-Type: application/json
200
Headers
Content-Type: application/json
Body
{
"user_id": 99,
"partner_id": 1,
"email": "[email protected]",
"balance": 100.1,
"status": 12,
"tax_number": "123-123-123-11",
"bank_account_number": "52175000120000000032413366",
"messages": [
{
"title": "Tytuł",
"content": "Widomość"
}
],
"default_address": {
"name": "Jan",
"surname": "Kowalski",
"company": "Kowalski S.A.",
"street": "Testowa",
"house_number": "11",
"door_number": "2",
"post_code": "01-300",
"city": "Warszawa",
"country_id": 1,
"phone": "123456789"
},
"shipping_address": {
"name": "Jan",
"surname": "Kowalski",
"company": "Kowalski S. A.",
"street": "Kowalska",
"house_number": "1",
"door_number": "999",
"post_code": "01-111",
"city": "Warszawa",
"country_id": 1,
"phone": "123456789",
"pop": null,
"pp": null,
"ruch": null,
"email": "[email protected]"
},
"settings": {
"monthly_invoice": false,
"new_order_notification": true,
"new_payment_notification": true,
"receiver_notification": true,
"two_factor_authentication": false
},
"package_templates": [
{
"courier_id": 2,
"product_id": 2,
"package_id": 2,
"weight": 10,
"length": 10,
"width": 11,
"height": 12,
"cod_value": 1000,
"description": "Testowa paczka",
"use_for_allegro": true,
"use_for_form": true,
"allegro_description_from_auction": true
}
]
}
EdytujPUT/user/data
Edytuj dane użytkownika.
- Przyjmowane parametry
email
(string, email, wymagany) - Zarejestrowany adres e-mail użytkownika.tax_number
(string, opcjonalny, max: 16) - Numer NIP użytkownika.bank_account_number
(string, opcjonalny, 26 znaków, iban) - Numer konta bankowego użytkownika w formacie IBAN (bez kodu kraju).default_address
(object) - Domyślny adres użytkownika, wykorzystywany np. do FV.name
(string, wymagany, max: 60) - Imię.surname
(string, wymagany, max: 60) - Nazwisko.company
(string, opcjonany, max: 200) - Nazwa firmy.street
(string, wymagany, max: 100) - Ulica.house_number
(string, wymagany, max: 10) - Numer domu.door_number
(string, opcjonalny, max: 10) - Numer mieszkania.post_code
(string, wymagany, max: 10) - Kod pocztowy.city
(string, wymagany, max: 50) - Miasto.country_id
(integer, wymagany, zgodny zGET /order/resources/countries
) - Kod kraju.phone
(string, wymagany, min: 5, max: 13 - jeślicountry_id
= 1, min: 5, max: 20 - jeślicountry_id
!= 1) - Telefon.
settings
(object) - Ustawienia użytkownikamonthly_invoice
(bool, opcjonalny) - Zbiorcza faktura miesięczna.new_order_notification
(bool, opcjonalny) - Informacja mailowa o nowym zamówieniu.new_payment_notification
(bool, opcjonalny) - Informacja mailowa o nowej płatności.receiver_notification
(bool, opcjonalny) - Informacja mailowa do odbiorcy.
package_templates
(array) - Szablony paczek.courier_id
(integer, opcjonalny, akceptowane wartości: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12) - Numer ID kuriera.1
- Geis (K-ex)2
- GLS3
- DPD4
- InPost5
- DHL7
- Geis (ETL)8
- InPost Zagranica9
- InPost Paczkomaty11
- Patron Service12
- Fedex13
- GEODIS14
- UPS16
- Poczta Polska palety17
- Pocztex18
- Rohlig SUUS19
- ORLEN Paczka20
- Ambro Express22
- Rhenus Logistics23
- InPost Szybkie Zwroty24
- InPost Paczkomat → Kurier25
- InPost Paczkomaty Ekonomiczne26
- Hellmann
product_id
(integer, opcjonalny, akceptowane wartości: 1, 2, 3) - Typ przesyłki.- 1 - Koperta.
- 2 - Paczka.
- 3 - Paleta.
package_id
(integer, opcjonalny, zwracane wartości: 1, 2, tylko jeśliproduct_id
= 2) - Rodzaj opakowania.- 1 - Standardowe.
- 2 - Niestandardowe.
weight
(numeric, opcjonalny) - Waga przesyłki.length
(numeric, opcjonalny) - Długość przesyłki.width
(numeric, opcjonalny) - Szerokość przesyłki.height
(numeric, opcjonalny) - Wysokość przesyłki.cod_value
(numeric, opcjonalny) - Wartość pobrania.insurance_value
(numeric, opcjonalny) - Wartość ubezpieczenia.description
(string, opcjonalny) - Opis zawartości.use_for_allegro
(bool, domyslnie: true) - Używaj dla przesyłek wprowadzonych przez Allegro.use_for_form
(bool, domyslnie: true) - Używaj dla przesyłek wprowadzonych ręcznie.allegro_description_from_auction
(bool, domyslnie: true) - Dla przesyłek z Allegro pobierz zawartość paczki z nazwy aukcji.
URI
Headers
Content-Type: application/json
Body
{
"email": "[email protected]",
"tax_number": "123-456-789",
"bank_account_number": "49175000120000000036292547",
"default_address": {
"name": "Jan",
"surname": "Kowalski",
"company": "Kowalski SA",
"street": "Testowa",
"house_number": "100",
"door_number": "10",
"post_code": "66-666",
"city": "Warszawa",
"country_id": 1,
"phone": "123456789"
},
"settings": {
"monthly_invoice": true,
"new_order_notification": true,
"new_payment_notification": true,
"receiver_notification": true
},
"default_package": {
"courier_id": 12,
"product_id": 2,
"package_id": 2,
"weight": 123.49,
"length": 12,
"width": 13,
"height": 14,
"cod_value": 124.12,
"description": "Paczka",
"use_for_allegro": true,
"use_for_form": true,
"allegro_description_from_auction": true
}
}
200
Headers
Content-Type: application/json
400
Headers
Content-Type: application/json
Body
{
"errors": {
"nazwa_pola": [
"Opis błędu."
]
},
"error_code": "InvalidInput",
"status_code": 400
}
402
Headers
Content-Type: application/json
Body
{
"message": "Płatność wymagana lub brak wystarczających środków.",
"error_code": "PaymentRequired",
"status_code": 402
}
Activate ¶
Reprezentacja zasobu Activate - Aktywacja.
WyślijPOST/user/activate
Stwórz i prześlij link aktywacyjny.
URI
Headers
Content-Type: application/json
200
Headers
Content-Type: application/json
400
Headers
Content-Type: application/json
AktywujGET/user/activate/:token
Aktywuj konto użytkownika.
- Przyjmowane parametry
token
(string, wymagany) - Token.
URI
Headers
Content-Type: application/json
200
Headers
Content-Type: application/json
400
Headers
Content-Type: application/json
Password ¶
Reprezentacja zasobu Password - Hasło.
ZapomnianePOST/user/password/forgotten
Wyślij e-mail z linkiem do resetu hasła. Token jest ważny 60 minut.
- Przyjmowane parametry
email
(string, wymagany) - Adres e-mail.
URI
201
Headers
Content-Type: application/json
400
Headers
Content-Type: application/json
Body
{
"errors": {
"nazwa_pola": [
"Opis błędu."
]
},
"error_code": "InvalidInput",
"status_code": 400
}
404
Headers
Content-Type: application/json
Body
{
"message": "Nie znaleziono.",
"error_code": "NotFound",
"status_code": 404
}
ZresetujPOST/user/password/reset
Zresetuj hasło.
- Przyjmowane parametry
password
(string, wymagany, min: 8, max: 255) - Hasło.password_confirmation
(string, wymagany, min: 8, max: 255, identyczne zpassword
) - Powtórzone hasło.token
(string, wymagany) - Token otrzymany z[POST /user/password/forgotten]
URI
Headers
Content-Type: application/json
Body
{
"password": "haslo",
"password_confirmation": "haslo",
"token": "abc1234",
}
200
Headers
Content-Type: application/json
400
Headers
Content-Type: application/json
Body
{
"errors": {
"nazwa_pola": [
"Opis błędu."
]
},
"error_code": "InvalidInput",
"status_code": 400
}
404
Headers
Content-Type: application/json
Body
{
"message": "Nie znaleziono.",
"error_code": "NotFound",
"status_code": 404
}
ZmieńPOST/user/password/change
Zmień hasło.
- Przyjmowane parametry
password
(string, wymagany) - Aktualne hasło.new_password
(string, wymagany, min: 8, max: 255) - Nowe hasło.new_password_confirmation
(string, wymagany, min: 8, max: 255, identyczne znew_password
) - Powtórzone nowe hasło.
URI
Headers
Content-Type: application/json
Body
{
"password": "mojeTrudneHaslo!@#",
"new_password": "mojeTrudniejszeHaslo!#$%@",
"new_password_confirmation": "mojeTrudniejszeHaslo!#$%@"
}
200
Headers
Content-Type: application/json
400
Headers
Content-Type: application/json
Body
{
"errors": {
"nazwa_pola": [
"Opis błędu."
]
},
"error_code": "InvalidInput",
"status_code": 400
}
{
"message": "Podany dane dostępowe są nieprawidłowe.",
"error_code": "AuthenticationFailed",
"status_code": 400
}
Cods ¶
Reprezentacja zasobu Cods - Pobrania.
SzukajPOST/user/cods/search
Wyszukaj pobrania użytkownika.
- Przyjmowane parametry
page
(integer, opcjonalny, min: 1) - Numer strony, domyślnie 1.per_page
(integer, opcjonalny, min: 1) - Ilość zwracanych wyników na stronę, domyślnie 50.filters
(object, opcjonalny) - Tablica filtrów.order_id
(integer, opcjonalny) - Numer zamówienia.waybill_number
(string, opcjonalny) - Numer listu przewozowego.courier_id
(integer, opcjonalny, akceptowane wartości: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12) - Numer ID kuriera.1
- Geis (K-ex)2
- GLS3
- DPD4
- InPost5
- DHL7
- Geis (ETL)8
- InPost Zagranica9
- InPost Paczkomaty11
- Patron Service12
- Fedex13
- GEODIS14
- UPS16
- Poczta Polska palety17
- Pocztex18
- Rohlig SUUS19
- ORLEN Paczka20
- Ambro Express22
- Rhenus Logistics23
- InPost Szybkie Zwroty24
- InPost Paczkomat → Kurier25
- InPost Paczkomaty Ekonomiczne
cod_status
(integer, opcjonalny, akceptowane wartości: 21,23,24,25,26,27) - Status pobrania. Statusy opisane są poniżej:21
- Oczekuje23
- Przelano24
- Anulowano25
- Realizacja Geis (K-ex)26
- Realizacja Tba27
- Realizacja Geis (ETL)
pickup_date_since
(date, opcjonalny) - Data odbioru od.pickup_date_till
(date, opcjonalny) - Data odbioru do.
URI
Headers
Content-Type: application/json
Body
{
"page": 1,
"per_page": 50,
"filters": {
"order_id": 123,
"waybill_number": 123,
"courier_id": 1,
"cod_status": 23,
"created_since": "2016-01-01",
"created_till": "2017-01-30",
"user_data": "Janusz Kowalski"
}
}
200
Headers
Content-Type: application/json
Body
{
"total": 2,
"current_page": 1,
"last_page": 1,
"per_page": 50,
"cods": [
{
"order_id": 777,
"courier_id": 4,
"waybill_number": "ABC123,
"pickup_date": "2016-10-19",
"type": 1,
"value": 50,
"bank_account_number": "12345678901234567890123456",
"status": 23,
"description": "Zwrot pobrania za zamówienie 777",
"transferred_at": "2016-10-20 16:09:10",
"package_receiver": {
"name": "Janusz",
"surname": "Kowalski ",
"company": null
}
},
{
"order_id": 778,
"courier_id": 4,
"waybill_number": "ABC333",
"pickup_date": "2016-10-20",
"type": 1,
"value": 30,
"bank_account_number": "12345678901234567890123456",
"status": 23,
"description": "Zwrot pobrania za zamówienie 778",
"transferred_at": "2016-10-21 09:19:12",
"package_receiver": {
"name": "Janusz",
"surname": "Kowalski",
"company": null
}
}
],
"sum": 80
}
Payments ¶
Reprezentacja zasobu Payments - Płatności.
SzukajPOST/user/payments/search
Wyszukaj płatności użytkownika.
- Przyjmowane parametry
page
(integer, opcjonalny, min: 1) - Numer strony, domyślnie 1.per_page
(integer, opcjonalny, min: 1) - Ilość zwracanych wyników na stronę, domyślnie 50.filters
(object, opcjonalny) - Tablica filtrów.order_id
(integer, opcjonalny) - Numer zamówienia.waybill_number
(string, opcjonalny) - Numer listu przewozowego.transaction_number
(string, opcjonalny) - Numer transakcji.invoice_number
(string, opcjonalny) - Numer faktury VAT.created_since
(date, opcjonalny) - Data transakcji od.created_till
(date, opcjonalny) - Data transakcji do.
- Zwracane parametry
total
(integer, zawsze zwracany) - Całkowita liczba wyników.current_page
(integer, zawsze zwracany) - Aktualna strona z wynikami.last_page
(integer, zawsze zwracany) - Ostatnia strona z wynikami.per_page
(integer, zawsze zwracany) - Liczba wyników na stronę.payments
(array[payment
]) - Tablica z wynikami.
- Zwracany obiekt
payment
type
(integer, zawsze zwracany, zwracane wartości: 21, 22, 24, 25) - Typ płatności.21
- Doładowanie salda22
- Płatność za zamówienie24
- Odjęcie z salda25
- Zwrot za zamówienie
method
(string, zawsze zwracany, zwracane wartości:przelewy24
,balance
,transfer
) - Metoda płatności.przelewy24
- Przelewy24balance
- Saldotransfer
- Przelew
number
(string, zawsze zwracany) - Unikalny numer transakcji.created_at
(date, zawsze zwracany) - Data wykonania transakcji.description
(string, zawsze zwracany) - Opis transakcji.amount
(numeric, zawsze zwracany) - Kwota transakcji.balance
(numeric, zawsze zwracany) - Saldo użytkownika po transkacji.invoice_number
(string, opcjonalny) - Numer faktury VAT przypisanej do transakcji.invoice_id
(integer, opcjonalny) - Numer ID faktury VAT przypisanej do transakcji.order_id
(integer, opcjonalny) - Numer zamówienia, zwracany jeślitype
wynosi22
.
URI
Headers
Content-Type: application/json
Body
{
"page": 1,
"per_page": 50,
"filters": {
"order_id": 123
}
}
200
Headers
Content-Type: application/json
Body
{
"total": 1,
"current_page": 1,
"last_page": 1,
"per_page": 50,
"payments": [
{
"type": 22,
"number": "OTH-777-701",
"created_at": "2017-02-04 19:07:38",
"description": "Zamówienie nr: 777",
"amount": 22.99,
"balance": 14,
"invoice_number": "3333/Test/2017",
"order_id" : "777
}
]
}
Opłać saldemPOST/user/payments
Opłać zamówienia użytkownika, wykorzystując środki na saldzie.
- Przyjmowane parametry
order_ids
(array[integer
], wymagany, min: 1) - Tablica zamówień.
- Zwracane parametry
total
(numeric, zawsze zwracany) - Całkowita kwota opłaconych zamówień.paid
(array[integer
], zawsze zwracany) - Tablica z opłaconymi zamówieniami.not_waiting
(array[integer
], opcjonalny) - Tablica z zamówieniami, które zostały wysłane do opłacenia, a nie oczekują na płatność.
URI
Headers
Content-Type: application/json
Body
{
"order_ids": [
123,
234
]
}
200
Headers
Content-Type: application/json
Body
{
"paid": [
123
],
"not_waiting": [
234
],
"total": "40,90"
}
400
Headers
Content-Type: application/json
Body
{
"errors": {
"nazwa_pola": [
"Opis błędu."
]
},
"error_code ": "InvalidInput",
"status_code": 400
}
402
Headers
Content-Type: application/json
Body
{
"message": "Płatność wymagana lub brak wystarczających środków.",
"error_code": "PaymentRequired",
"status_code": 402
}
404
Headers
Content-Type: application/json
Body
{
"message": "Nie znaleziono.",
"error_code": "NotFound",
"status_code": 404
}
Stwórz doładowaniePOST/user/payments/balance
Stwórz doładowanie salda. Metoda tworzy obiekt balance
, który później można wykorzystać do np. wygenerowania linku PayU.
- Przyjmowane parametry
amount
(number, wymagany, min: 1, max: 10000) - Kwota doładowania.
- Zwracane parametry
balance_id
(integer, zawsze zwracany) - Numer ID doładowania.
URI
Headers
Content-Type: application/json
Body
{
"amount": "100"
}
201
Headers
Content-Type: application/json
Body
{
"balance_id": 86808
}
400
Headers
Content-Type: application/json
Body
{
"errors": {
"nazwa_pola": [
"Opis błędu."
]
},
"error_code": "InvalidInput",
"status_code": 400
}
401
Headers
Content-Type: application/json
Body
{
"message": "Brak dostępu.",
"error_code": "AccessDenied",
"status_code": 401
}
Doładuj saldoGET/user/payments/balance/:balanceID
Pobierz dane potrzebne do wykonania doładowania salda z wykorzystaniem zewnętrznych serwisów.
- Przyjmowane parametry
balanceID
(number, wymagany) - Numer ID doładowania salda.
- Zwracane parametry
payu
(objectoperator
, opcjonalny) - Dane potrzebne do wykonania płatności przez system payu.przelewy24
(objectoperator
, opcjonalny) - Dane potrzebne do wykonania płatności przez system payu.
- Zwracany obiekt
operator
url
(string, opcjonalny) - Adres URL na który należy przekirować użytkownika w celu dokonania płatności.
URI
Headers
Content-Type: application/json
201
Headers
Content-Type: application/json
Body
{
"payu": {
"url": "https://payu.pl/"
}
}
404
Headers
Content-Type: application/json
Body
{
"message": "Nie znaleziono.",
"error_code": "NotFound",
"status_code": 404
}
403
Headers
Content-Type: application/json
Body
{
"message": "Niedostępne.",
"error_code": "NotAvailable",
"status_code": 403
}
Opłać zewnętrznieGET/user/payments/order/:orderID
Pobierz dane potrzebne do wykonania płatności za zamówienie z wykorzystaniem zewnętrznych serwisów.
- Przyjmowane parametry
orderID
(number, wymagany) - Numer ID zamówienia oczekującego na płatność.
- Zwracane parametry
payu
(objectoperator
, opcjonalny) - Dane potrzebne do wykonania płatności przez system payu.przelewy24
(objectoperator
, opcjonalny) - Dane potrzebne do wykonania płatności przez system payu.
- Zwracany obiekt
operator
url
(string, opcjonalny) - Adres URL na który należy przekirować użytkownika w celu dokonania płatności.
URI
Headers
Content-Type: application/json
201
Headers
Content-Type: application/json
Body
{
"payu": {
"url": "https://payu.pl/"
}
}
404
Headers
Content-Type: application/json
Body
{
"message": "Nie znaleziono.",
"error_code": "NotFound",
"status_code": 404
}
403
Headers
Content-Type: application/json
Body
{
"message": "Niedostępne.",
"error_code": "NotAvailable",
"status_code": 403
}
Invoices ¶
Reprezentacja zasobu Invoices - Faktury.
SzukajPOST/user/invoices/search
Wyszukaj faktury użytkownika.
- Przyjmowane parametry
page
(integer, opcjonalny, min: 1) - Numer strony, domyślnie 1.per_page
(integer, opcjonalny, min: 1) - Ilość zwracanych wyników na stronę, domyślnie 50.filters
(object, opcjonalny) - Tablica filtrów.order_id
(integer, opcjonalny) - Numer zamówienia.invoice_number
(string, opcjonalny) - Numer faktury VAT.issued_since
(date, opcjonalny) - Data wystawienia faktury VAT od.issued_till
(date, opcjonalny) - Data wystawienia faktury VAT do.
- Zwracane parametry
total
(integer, zawsze zwracany) - Całkowita liczba wyników.current_page
(integer, zawsze zwracany) - Aktualna strona z wynikami.last_page
(integer, zawsze zwracany) - Ostatnia strona z wynikami.per_page
(integer, zawsze zwracany) - Liczba wyników na stronę.invoices
(array[invoice
]) - Tablica z wynikami.
- Zwracany obiekt
invoice
id
(integer, zawsze zwracany) - Numer ID faktury VAT.number
(string, zawsze zwracany) - Numer faktury VAT.date_of_issue
(date, zawsze zwracany) - Data wystawienia faktury VAT.sale_date
(date, zawsze zwracany) - Data sprzedaży.payment_method
(integer, zawsze zwracany, zwracane wartości:1
,2
,3
) - Metoda płatności widoczna na fakturze VAT.sum
(numeric, zawsze zwracany) - Całkowita kwota brutto na fakturze VAT.1
- Przelew2
- Przelewy243
- Płatność elektroniczna
issuer
(objectissuer
, zawsze zwracany) - Wystawca faktury VAT - sprzedawca.billed_to
(objectissuer
, zawsze zwracany) - Nabywca.positions
(array[position
], zawsze zwracany) - Zbiór pozycji na fakturze VAT.
- Zwracany obiekt
issuer
name
(string, zawsze zwracany) - Nazwa wystawcy.
- Zwracany obiekt
billed_to
name
(string, zawsze zwracany) - Nazwa nabywcy.tax_number
(string, opcjonalny) - Numer NIP nabywcy.street_with_number
(string, zawsze zwracany) - Ulica wraz z numerem nabywcy.city
(string, zawsze zwracany) - Miasto nabywcy.post_code
(string, zawsze zwracany) - Kod pocztowym nabywcy.country
(string, zawsze zwracany) - Kraj nabywcy.
- Zwracany obiekt
position
amount_gross
(numeric, zawsze zwracany) - Kwota brutto.quantity
(integer, opcjonalny) - Ilość.unit
(string, zawsze zwracany) - Jednostka miary.tax_percent
(numeric, zawsze zwracany) - Stawka VAT.description
(string, zawsze zwracany) - Opis.
URI
Headers
Content-Type: application/json
Body
{
"page": 1,
"per_page": 50,
"filters": {
"order_id": 777
}
}
200
Headers
Content-Type: application/json
Body
{
"total": 1,
"current_page": 1,
"last_page": 1,
"per_page": 50,
"invoices": [
{
"id": 123,
"number": "1111/20/2017",
"date_of_issue": "2017-02-28",
"sale_date": "2017-02-28",
"payment_method": 2,
"sum": 26.4
"issuer": {
"name": "Spółka z ograniczoną odpowiedzialnością"
},
"bill_to": {
"name": "Jan Kowalski",
"tax_number": "123-444-223-22",
"street_with_number": "Testowa 11/1",
"city": "Testowo",
"post_code": "00-001",
"country": "Polska"
},
"positions": [
{
"amount_gross": 10,
"quantity": 1,
"unit": "szt.",
"tax_percent": 23,
"description": "Usługi kurierskie zgodnie z zamówieniem nr: 777"
},
{
"amount_gross": 16.4,
"quantity": 1,
"unit": "szt.",
"tax_percent": 23,
"description": "Usługi kurierskie zgodnie z zamówieniem nr: 778"
}
]
}
]
}
Pobierz FVGET/user/invoices/final/:invoiceID/download
Pobierz fakturę VAT.
- Parametry w URL
invoiceID
(integer, wymagany) - Numer ID faktury VAT.
- Zwracane parametry
url
lubfile
(string, zawsze zwracany) - Adres URL do faktury VAT.
URI
Headers
Content-Type: application/json
200
Headers
Content-Type: application/json
Body
{
"url": "https://tanieprzesylkikurierskie.pl/file/invoice/final/abc"
}
404
Headers
Content-Type: application/json
Body
{
"message": "Nie znaleziono.",
"error_code": "NotFound",
"status_code": 404
}
Pobierz ProFormaGET/user/invoices/pro-forma/:ownerType/:ownerID/download
Pobierz fakturę pro forma.
- Parametry w URL
ownerType
(string, wymagany) - Typ obiektu dla którego pobieramy fakturę pro forma.order
- zamówieniebalance
- doładowanie salda
ownerID
(integer, wymagany) - Numer ID zamówienia albo doładowania salda.
- Zwracane parametry
url
lubfile
(string, zawsze zwracany) - Adres URL do faktury pro forma.
URI
Headers
Content-Type: application/json
200
Headers
Content-Type: application/json
Body
{
"url": "https://tanieprzesylkikurierskie.pl/file/invoice/pro-forma/abc"
}
404
Headers
Content-Type: application/json
Body
{
"message": "Nie znaleziono.",
"error_code": "NotFound",
"status_code": 404
}
Address Book ¶
Reprezentacja zasobu Address Book - Książka adresowa.
SzukajPOST/user/address-book/search
Wyszukaj adresy użytkownika.
- Przyjmowane parametry
page
(integer, opcjonalny, min: 1) - Numer strony, domyślnie 1.per_page
(integer, opcjonalny, min: 1) - Ilość zwracanych wyników na stronę, domyślnie 50.filters
(object, opcjonalny) - Tablica filtrów.name
(string, opcjonalny) - Imię.surname
(string, opcjonalny) - Nazwisko.email
(string, opcjonalny) - Adres e-mail.company
(string, opcjonalny) - Nazwa firmy.street
(string, opcjonalny) - Ulica.house_number
(string, opcjonalny) - Numer domu.door_number
(string, opcjonalny) - Numer mieszkania.post_code
(string, opcjonalny) - Kod pocztowy.city
(string, opcjonalny) - Miasto.country_id
(integer, opcjonalny, zgodny zGET /order/resources/countries
) - Kod kraju.phone
(string, opcjonalny) - Telefon.pop_code
(string, opcjonalny) - Kod paczkomatu.pp_code
(string, opcjonalny) - Kod placówki Poczty Polskiej.ruch_code
(string, opcjonalny) - Kod Punktu RUCHu.
- Zwracane parametry
total
(integer, zawsze zwracany) - Całkowita liczba wyników.current_page
(integer, zawsze zwracany) - Aktualna strona z wynikami.last_page
(integer, zawsze zwracany) - Ostatnia strona z wynikami.per_page
(integer, zawsze zwracany) - Liczba wyników na stronę.addresses
(array[address
], zawsze zwracany) - Tablica z wynikami.
- Zwracany obiekt
address
id
(integer, zawsze zwracany) - Numer ID.is_default
(bool, zawsze zwracany) - Adres domyślny.name
(string, opcjonalny) - Imię.surname
(string, opcjonalny) - Nazwisko.company
(string, opcjonalny) - Nazwa firmy.email
(string, opcjonalny) - Adres e-mail.street
(string, opcjonalny) - Ulica.house_number
(string, opcjonalny) - Numer domu.door_number
(string, opcjonalny) - Numer mieszkania.post_code
(string, opcjonalny) - Kod pocztowy.city
(string, opcjonalny) - Miasto.country_id
(integer, opcjonalny, zgodny zGET /order/resources/countries
) - Kod kraju.phone
(string, opcjonalny) - Telefon.pop
(objectpop
, opcjonalny) - Paczkomat.
- Zwracany obiekt
pop
code
(string, zawsze zwracany) - Kod.country_code
(string, zawsze zwracany) - Kod kraju.city
(string, zawsze zwracany) - Miasto.street
(string, zawsze zwracany) - Ulica.house_number
(string, opcjonalny) - Numer domu.province
(string, zawsze zwracany) - Województwo.post_code
(string, zawsze zwracany) - Kod pocztowy.description
(string, opcjonalny) - Dodatkowy opis.
URI
Headers
Content-Type: application/json
Body
{
"page": 1,
"per_page": 50,
"filters": {
"name": "Kowalski"
}
}
200
Headers
Content-Type: application/json
Body
{
"total": 12,
"current_page": 1,
"last_page": 1,
"per_page": 50,
"addresses": [
{
"id": 111,
"is_default": false,
"name": "Jan",
"surname": "Kowalski",
"company": null,
"email": "[email protected]",
"street": "Kowalska",
"house_number": "1",
"door_number": "6",
"post_code": "82-300",
"city": "Elbląg",
"country_id": 1,
"phone": "+48123456789"
},
{
"id": 1113,
"is_default": false,
"name": "Jerzy",
"surname": "Kowalski",
"company": null,
"email": "[email protected]",
"street": "Kowalska",
"house_number": "1",
"door_number": null,
"post_code": "00-001",
"city": "Warszawa",
"country_id": 1,
"phone": "+481111111111"
},
{
"id": 1114,
"is_default": true,
"name": "Anna",
"surname": "Kowalski",
"company": null,
"email": "[email protected]",
"street": "Testowa",
"house_number": "1",
"door_number": "6",
"post_code": "01-112",
"city": "Warszawa",
"country_id": 1,
"phone": "123456789",
"pop": {
"code": "ELB01A",
"street": "płk. Stanisława Dąbka",
"house_number": "74",
"city": "Elbląg",
"post_code": "82-300"
}
}
]
}
DodajPOST/user/address-book
Dodaj adres użytkownika.
- Przyjmowane parametry
name
(string, wymagany jeślicompany
jest puste) - Imię.surname
(string, wymagany jeślicompany
jest puste) - Nazwisko.email
(string, opcjonalny) - Adres e-mail.company
(string, opcjonalny) - Nazwa firmy.street
(string, opcjonalny) - Ulica.house_number
(string, opcjonalny) - Numer domu.door_number
(string, opcjonalny) - Numer mieszkania.post_code
(string, opcjonalny) - Kod pocztowy.city
(string, opcjonalny) - Miasto.country_id
(integer, opcjonalny, zgodny zGET /order/resources/countries
) - Kod kraju. Domyślnie 1.phone
(string, opcjonalny) - Telefon.pop_code
(string, opcjonalny) - Kod paczkomatu.pp_code
(string, opcjonalny) - Kod placówki Poczty Polskiej.ruch_code
(string, opcjonalny) - Kod Punktu RUCHu.default
(bool, opcjonalny) - Ustawia adres jako domyślny.
URI
Headers
Content-Type: application/json
Body
{
"name" : "Jan",
"surname": "Kowalski",
"email" : "[email protected]",
"company": "Kowalski S.A.",
"street": "Kowalska",
"house_number": "1",
"door_number": "1a",
"post_code": "82-300",
"city": "Elbląg",
"country_id": 1,
"phone": "+48123456789",
"pop_code": "BEL01A",
"pp_code": "123456",
"ruch_code": "WS-492393-25-18",
}
201
Headers
Content-Type: application/json
ImportujPOST/import/addresses
Importuj adresy użytkownika z pliku CSV. Przed importem należy przesłać plik CSV na serwer (patrz: zasób File).
- Przyjmowane parametry
token
(string, wymagany) - Token.file_id
(string, wymagany) - Identyfikator przesłanego pliku CSV.
URI
Headers
Content-Type: application/json
Body
{
"file_id": "8e8215a8161c01f4e297c1c41e195528bt5ozTxWOsGTq2Se4wQCCcrznu1225GJ"
}
200
Headers
Content-Type: application/json
EdytujPUT/user/address-book/:addressID
Edytuj adres użytkownika.
- Przyjmowane parametry
name
(string, wymagany jeślicompany
jest puste) - Imię.surname
(string, wymagany jeślicompany
jest puste) - Nazwisko.email
(string, opcjonalny) - Adres e-mail.company
(string, opcjonalny) - Nazwa firmy.street
(string, opcjonalny) - Ulica.house_number
(string, opcjonalny) - Numer domu.door_number
(string, opcjonalny) - Numer mieszkania.post_code
(string, opcjonalny) - Kod pocztowy.city
(string, opcjonalny) - Miasto.country_id
(integer, opcjonalny, zgodny zGET /order/resources/countries
) - Kod kraju. Domyślnie 1.phone
(string, opcjonalny) - Telefon.pop_code
(string, opcjonalny) - Kod paczkomatu.pp_code
(string, opcjonalny) - Kod placówki Poczty Polskiej.ruch_code
(string, opcjonalny) - Kod Punktu RUCHu.default
(bool, opcjonalny) - Ustawia adres jako domyślny.
URI
Headers
Content-Type: application/json
Body
{
"name" : "Jan",
"surname": "Kowalski",
"email" : "[email protected]",
"company": "Kowalski S.A.",
"street": "Kowalska",
"house_number": "1",
"door_number": "1a",
"post_code": "82-300",
"city": "Elbląg",
"country_id": 1,
"phone": "+48123456789",
"pop_code": "BEL01A"
"pp_code": "123456"
"ruch_code": "WS-492393-25-18"
}
200
Headers
Content-Type: application/json
UsuńDELETE/user/address-book/:addressID
Usuń adres użytkownika.
URI
Headers
Content-Type: application/json
200
Headers
Content-Type: application/json
Partner ¶
Reprezentacja zasobu Partner.
PobierzGET/user/partner
Pobierz dane partnera.
- Przyjmowane parametry
- token (string, wymagany) - Token.
- Zwracane parametry
partner_since
(date, zawsze zwracany) - Data startu partnerstwa.user_assignment_period
(integer, opcjonalny) - Okres przypisania użytkownika.action_id
(integer, opcjonalny) - Numer partnera.percent
(objectpercent
) - Stawki procentowe.
- Zwracany obiekt
percent
envelope
(numeric, zawsze zwracany) - Koperta.parcel
(numeric, zawsze zwracany) - Koperta.pallet
(numeric, zawsze zwracany) - Koperta.
URI
Headers
Content-Type: application/json
200
Headers
Content-Type: application/json
Body
{
"partner_since": "2015-08-07",
"user_assignment_period": 90,
"action_id": 100,
"percent": {
"envelope": 3,
"parcel": 3,
"pallet": 3
}
}
SzukajPOST/user/partner/orders/search
Wyszukaj zamówienia użytkowników przypisanych do partnera.
- Przyjmowane parametry
page
(integer, opcjonalny, min: 1) - Numer strony, domyślnie 1.per_page
(integer, opcjonalny, min: 1) - Ilość zwracanych wyników na stronę, domyślnie 50.filters
(object, opcjonalny) - Tablica filtrów.order_id
(integer, opcjonalny) - Numer ID zamówienia.user_id
(integer, opcjonalny) - Numer ID użytkownika.product_id
(integer, opcjonalny, akceptowane wartości: 1, 2, 3) - Typ przesyłki.- 1 - Koperta.
- 2 - Paczka.
- 3 - Paleta.
courier_id
(integer, opcjonalny, akceptowane wartości: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12) - Numer ID kuriera.1
- Geis (K-ex)2
- GLS3
- DPD4
- InPost5
- DHL7
- Geis (ETL)8
- InPost Zagranica9
- InPost Paczkomaty11
- Patron Service12
- Fedex13
- GEODIS14
- UPS16
- Poczta Polska palety17
- Pocztex18
- Rohlig SUUS19
- ORLEN Paczka20
- Ambro Express22
- Rhenus Logistics23
- InPost Szybkie Zwroty24
- InPost Paczkomat → Kurier25
- InPost Paczkomaty Ekonomiczne
order_status
(integer, opcjonalny) - Status zamówienia.11
- Oczekuje12
- Zapłacone13
- Błąd (wystąpił prawdopodobnie problem z płatnością, wymagany kontakt z BOK)14
- Anulowane
created_since
(date, opcjonalny) - Data stworzenia zamówienia od.created_till
(date, opcjonalny) - Data stworzenia zamówienia do.
- Zwracane parametry
total
(integer, zawsze zwracany) - Całkowita liczba wyników.current_page
(integer, zawsze zwracany) - Aktualna strona z wynikami.last_page
(integer, zawsze zwracany) - Ostatnia strona z wynikami.per_page
(integer, zawsze zwracany) - Liczba wyników na stronę.orders
(array[order
], zawsze zwracany) - Tablica z wynikami.number_of_users
(integer, zawsze zwracany) - Liczba aktywnych użytkowników przypisanych do partnera.number_of_orders
(integer, zawsze zwracany) - Liczba zamówień przypisanych do partnera.number_of_packages
(integer, zawsze zwracany) - Liczba paczek przypisanych do partnera.total_commission
(numeric, zawsze zwracany) - Całkowita kwota prowizji.
- Zwracany obiekt
order
id
(integer, zawsze zwracany) - Numer ID.created_at
(date, zawsze zwracany) - Data stworzenia zamówienia.pickup_date
(date, zawsze zwracany) - Data odbioru.courier_id
(integer, zawsze zwracany, akceptowane wartości: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12) - Numer ID kuriera.1
- Geis (K-ex)2
- GLS3
- DPD4
- InPost5
- DHL7
- Geis (ETL)8
- InPost Zagranica9
- InPost Paczkomaty11
- Patron Service12
- Fedex13
- GEODIS14
- UPS16
- Poczta Polska palety17
- Pocztex18
- Rohlig SUUS19
- ORLEN Paczka20
- Ambro Express22
- Rhenus Logistics23
- InPost Szybkie Zwroty24
- InPost Paczkomat → Kurier25
- InPost Paczkomaty Ekonomiczne
product_id
(integer, zawsze zwracany, akceptowane wartości: 1, 2, 3) - Typ przesyłki.- 1 - Koperta.
- 2 - Paczka.
- 3 - Paleta.
weight
(numeric, zawsze zwracany) - Waga przesyłki.length
(numeric, zawsze zwracany) - Długość przesyłki.width
(numeric, zawsze zwracany) - Szerokość przesyłki.height
(numeric, zawsze zwracany) - Wysokość przesyłki.status
(integer, zawsze zwracany) - Status zamówienia.11
- Oczekuje12
- Zapłacone13
- Błąd (wystąpił prawdopodobnie problem z płatnością, wymagany kontakt z BOK)14
- Anulowane
price
(numeric, zawsze zwracany) - Kwota zamówienia.user
(objectuser
) - Użytkownik przypisany do zamówienia.commission
(numeric, zawsze zwracany) - Kwota prowizji.
- Zwracany obiekt
user
id
(integer, zawsze zwracany) - Numer ID użytkownika.created_at
(date, opcjonalny) - Data stworzenia użytkownika.
URI
Headers
Content-Type: application/json
Body
{
"page": 1,
"per_page": 50,
"filters": {
"courier_id": 4
}
}
200
Headers
Content-Type: application/json
Body
{
"total": 2,
"current_page": 1,
"last_page": 1,
"per_page": 50,
"orders": [
{
"id": 12345,
"created_at": "2017-02-21 21:42:32",
"pickup_date": "2017-02-22",
"courier_id": 4,
"product_id": 2,
"weight": 3.6,
"length": 30,
"width": 25,
"height": 15,
"status": 12,
"price": 75,
"user": {
"id": 11,
"created_at": "2017-02-21 21:42:32"
},
"commission": 7.5
},
{
"id": 12346,
"created_at": "2017-02-21 21:33:03",
"pickup_date": "2017-02-22",
"courier_id": 4,
"product_id": 2,
"weight": 11,
"length": 30,
"width": 30,
"height": 30,
"status": 12,
"price": 17.5,
"user": {
"id": 11,
"created_at": "2017-02-21 21:33:03"
},
"commission": 2.5
}
],
"number_of_users": 25,
"number_of_orders": 2,
"number_of_packages": 2,
"total_commission": 10
}
Allegro Accounts ¶
Reprezentacja zasobu Allegro Accounts - konta allegro.
PobierzGET/user/allegro/accounts
Pobierz konta allegro przypisane do użytkownika.
- Przyjmowane parametry
- token (string, wymagany) - Token.
- Zwracane parametry
id
(integer, zawsze zwracany) - Numer ID.is_in_sync
(bool, zawsze zwracany) - Informacja o tym czy aktualnie trwa synchronizacja.last_sync_at
(date, zawsze zwracany) - Data ostatniej synchronizacji.username
(string, zawsze zwracany) - Nazwa.working_control
(string, opcjonalny) - ID trwającej synchronizacji.
URI
Headers
Content-Type: application/json
200
Headers
Content-Type: application/json
Body
{
"accounts": [
{
"id": 5,
"username": "Jan_Kowalski_888"
},
{
"id": 1,
"username": "Jan_Kowalski_999"
}
]
}
DodajPOST/user/allegro/accounts
Dodaj konto allegro.
- Przyjmowane parametry
username
(string, wymagany) - Login do konta Allegro.pl.password
(string, wymagany) - Hasło do konta Allegro.pl.
URI
Headers
Content-Type: application/json
Body
{
"username": "test",
"password": "test"
}
201
Headers
Content-Type: application/json
400
Headers
Content-Type: application/json
Body
{
"errors": {
"nazwa_pola": [
"Opis błędu."
]
},
"error_code": "InvalidInput",
"status_code": 400
}
401
Headers
Content-Type: application/json
Body
{
"message": "Podany dane dostępowe są nieprawidłowe.",
"error_code": "AuthenticationFailed",
"status_code": 401
}
UsuńDELETE/user/allegro/accounts/:accountID
Usuń konto allegro przypisane do użytkownika.
- Przyjmowane parametry
- token (string, wymagany) - Token.
URI
Headers
Content-Type: application/json
200
Headers
Content-Type: application/json
EdytujPUT/user/allegro/accounts/:accountID
Edytuj konto allegro przypisane do użytkownika.
- Przyjmowane parametry
username
(string, wymagany) - Login do konta Allegro.pl.password
(string, wymagany) - Hasło do konta Allegro.pl.
URI
Headers
Content-Type: application/json
Body
{
"username": "test",
"password": "test"
}
200
Headers
Content-Type: application/json
400
Headers
Content-Type: application/json
Body
{
"errors": {
"nazwa_pola": [
"Opis błędu."
]
},
"error_code": "InvalidInput",
"status_code": 400
}
401
Headers
Content-Type: application/json
Body
{
"message": "Podany dane dostępowe są nieprawidłowe.",
"error_code": "AuthenticationFailed",
"status_code": 401
}
Allegro Syncs ¶
Reprezentacja zasobu Allegro Syncs - synchronizacje kont allegro.
PobierzGET/user/allegro/syncs/:syncID
Pobierz szczegółowe dane na temat synchronizacji użytkownika.
- Przyjmowane parametry
- token (string, wymagany) - Token.
- Zwracane parametry
is_in_sync
(bool, zawsze zwracany) - Informacja o tym czy aktualnie trwa synchronizacja.status
(integer, zawsze zwracany) - Status synchronizacji.100
- Synchronizacja oczekuje.101
- Synchronizacja w trakcie.102
- Synchronizacja zakończona powodzeniem, pobrano nowe zamówienia.103
- Synchronizacja zakończona powodzeniem, ale brak nowych zamówień.104
- Synchronizacja zakończona błędem, prawdopodobnie hasło do konta Allegro.pl zostało zmienione, lub wystąpił inny problem.
progress
(integer, zawsze zwracany) - Aktualny postęp w procentach (0 - 100).
URI
Headers
Content-Type: application/json
200
Headers
Content-Type: application/json
Body
{
"is_in_sync": true,
"status": 101,
"progress": 82
}
StwórzPOST/user/allegro/syncs/:accountID
Rozpocznij synchronizacje użytkownika.
- Przyjmowane parametry
- token (string, wymagany) - Token.
- Zwracane parametry
working_control
(string, zawsze zwracany) - ID synchronizacji.
URI
Headers
Content-Type: application/json
200
Headers
Content-Type: application/json
Body
{
"working_control": "abc123"
}
Allegro Items ¶
Reprezentacja zasobu Allegro Items - transakcje użytkownika.
SzukajPOST/user/allegro/accounts/:accountID/items/search
Pobierz rekordy allegro.
- Przyjmowane parametry
page
(integer, opcjonalny, min: 1) - Numer strony, domyślnie 1.per_page
(integer, opcjonalny, min: 1) - Ilość zwracanych wyników na stronę, domyślnie 50.filters
(object, opcjonalny) - Tablica filtrów.buyer_data
(string, opcjonalny) - Dane kupującego (login, e-mail, id).auction_id
(integer, opcjonalny) - Numer ID aukcji.payment_status
(string, opcjonalny) - Status płatności. Wartości filtra powinny zostać pobrane dynamicznie.payment_type
(string, opcjonalny) - Typ płatności.wire_transfer
- Przelew tradycyjnycollect_on_delivery
- Płacę przy odbiorzepayu
- PayU
shipment_type
(integer, opcjonalny) - Typ wysyłki. Wartości filtra powinny zostać pobrane dynamicznie.with_invoice
(bool, opcjonalny) - Faktura.sold_since
(date, opcjonalny) - Data sprzedaży od.sold_till
(date, opcjonalny) - Data sprzedaży do.data
(string, opcjonalny) - Szukaj wszędzie.
- Zwracane parametry
total
(integer, zawsze zwracany) - Całkowita liczba wyników.current_page
(integer, zawsze zwracany) - Aktualna strona z wynikami.last_page
(integer, zawsze zwracany) - Ostatnia strona z wynikami.per_page
(integer, zawsze zwracany) - Liczba wyników na stronę.items
(array[item
], zawsze zwracany) - Tablica z wynikami.
- Zwracany obiekt
item
id
(integer, zawsze zwracany) - Numer ID.allegro_user_id
(integer, zawsze zwracany) - Numer ID konta Allegro.pl.form_id
(integer, zawsze zwracany) - Numer ID wypełnionego formularza Allegro.pl.form_id
(integer, zawsze zwracany) - Numer ID wypełnionego formularza Allegro.pl.form_created_at
(date, zawsze zwracany) - Data sprzedaży / stworzenia formularza.buyer_id
(integer, zawsze zwracany) - Numer ID kupującego w Allegro.pl.buyer_login
(string, zawsze zwracany) - Login kupującego w Allegro.pl.buyer_email
(string, zawsze zwracany) - Adres e-mail kupującego w Allegro.pl.wants_invoice
(bool, zawsze zwracany) - Informacja o tym, czy klient chce fakture VAT.to_pay_amount
(numeric, zawsze zwracany) - Całkowita kwota do zapłaty.postage_amount
(numeric, zawsze zwracany) - Kwota wysyłki.payment_type
(string, zawsze zwracany) - Typ płatności.payment_status
(string, zawsze zwracany) - Status płatności.shipment_type
(integer, zawsze zwracany) - Typ wysyłki.message
(string, opcjonalny) - Widomość od kupujacego.order
(objectorder
, opcjonalny) - Przypisane zamówienie w Tanieprzesylkikurierskie.pl.receiver_address
(objectaddress
, zawsze zwracany) - Adres doręczenia.invoice_address
(objectaddress
, opcjonalny) - Adres do faktury VAT.positions
(array[position
], zawsze zwracany) - Tablica z zakupionymi produktami.
- Zwracany obiekt
order
id
(integer, zawsze zwracany) - Numer ID zamówienia.courier_id
(integer, opcjonalny, akceptowane wartości: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12) - Numer ID kuriera.1
- Geis (K-ex)2
- GLS3
- DPD4
- InPost5
- DHL7
- Geis (ETL)8
- InPost Zagranica9
- InPost Paczkomaty11
- Patron Service12
- Fedex13
- GEODIS14
- UPS16
- Poczta Polska palety17
- Pocztex18
- Rohlig SUUS19
- ORLEN Paczka20
- Ambro Express22
- Rhenus Logistics23
- InPost Szybkie Zwroty24
- InPost Paczkomat → Kurier25
- InPost Paczkomaty Ekonomiczne
waybill_number
(string, opcjonalny) - Numer listu przewozowego.courier_status
(integer, opcjonalny) - Status przesyłki u kuriera.1
- Nieznany4
- Wprowadzona6
- Anulowana7
- Nieodebrana8
- W doręczeniu9
- Doręczona10
- Zwrot do nadawcy13
- Zakończona15
- List ręczny
status
(integer, opcjonalny) - Status zamówienia.11
- Oczekuje12
- Zapłacone13
- Błąd (wystąpił prawdopodobnie problem z płatnością, wymagany kontakt z BOK)14
- Anulowane
insurance_value
(numeric, opcjonalny) - Wartość ubezpieczenia.cod_value
(numeric, opcjonalny) - Wartość pobrania.product_id
(integer, wymagany, akceptowane wartości: 1, 2, 3) - Typ przesyłki.- 1 - Koperta.
- 2 - Paczka.
- 3 - Paleta.
weight
(numeric, zawsze zwracany) - Waga przesyłki.length
(numeric, zawsze zwracany) - Długość przesyłki.width
(numeric, zawsze zwracany) - Szerokość przesyłki.height
(numeric, zawsze zwracany) - Wysokość przesyłki.number_of_packages
(integer, zawsze zwracany) - Liczba przesyłek.price
(numeric, zawsze zwracany) - Cena zamówienia.description
(string, zawsze zwracany) - Zawartość.
- Zwracany obiekt
address
name
(string) - Imię.surname
(string) - Nazwisko.company
(string) - Nazwa firmy.street
(string) - Ulica.house_number
(string) - Numer domu.door_number
(string) - Numer mieszkania.post_code
(string) - Kod pocztowy.city
(string) - Miasto.country_id
(integer) - Kod kraju.phone
(string) - Telefon.pop
(objectpop
, opcjonalny) - Paczkomat.pp
(objectpp
, opcjonalny) - placówka Poczty Polskiej.ruch
(objectruch
, opcjonalny) - Punkt RUCHu.tax_number
(string, opcjonalny) - Numer NIP.
-
Zwracany obiekt
pop
code
(string, zawsze zwracany) - Kod paczkomatu.
-
Zwracany obiekt
pp
code
(string, zawsze zwracany) - Kod placówki Poczty Polskiej.
-
Zwracany obiekt
ruch
code
(string, zawsze zwracany) - Kod Punktu RUCHu.
- Zwracany obiekt
position
auction_id
(string, zawsze zwracany) - Numer aukcji Allegro.pl.auction_title
(string, zawsze zwracany) - Tytuł aukcji Allegro.pl.quantity
(integer, zawsze zwracany) - Ilość.
URI
Headers
Content-Type: application/json
Body
{
"page": 1,
"per_page": 50,
"filters": {
"buyer_data": "Kowalski"
}
}
200
Headers
Content-Type: application/json
Body
{
"total": 1,
"current_page": 1,
"last_page": 1,
"per_page": 50,
"items": [
{
"id": 1,
"allegro_user_id": 1,
"form_id": 111111,
"form_created_at": "2015-10-24 09:44:48",
"buyer_id": 111112,
"buyer_login": "niezarejestrowany",
"buyer_email": "[email protected]",
"wants_invoice": false,
"to_pay_amount": 46,
"postage_amount": 44,
"payment_type": "collect_on_delivery",
"payment_status": "",
"shipment_type": 11,
"message": "dsdsds",
"order": {
"id": 1111,
"courier_id": 4,
"waybill_number": null,
"courier_status": null,
"courier_pickup_number": null,
"status": 11,
"insurance_value": 46,
"cod_value": 0,
"product_id": 1,
"weight": 0,
"length": 0,
"width": 0,
"height": 0,
"number_of_packages": 1,
"price": "17.00",
"description": "test"
},
"receiver_address": {
"name": "Jan",
"surname": "Kowalski",
"company": "ABC S. A.",
"street": "Testowa",
"house_number": "30/3",
"post_code": "01-111",
"city": "Warszawa",
"country_id": 1,
"phone": "123456789",
"tax_number": ""
},
"invoice_address": null,
"positions": [
{
"auction_id": "111111",
"auction_title": "testowa aukcja",
"quantity": 2
}
]
}
]
}
Szukaj w archiwumPOST/user/allegro/accounts/:accountID/items/trash/search
Pobierz zarchiwizowane rekordy allegro.
- Przyjmowane parametry
page
(integer, opcjonalny, min: 1) - Numer strony, domyślnie 1.per_page
(integer, opcjonalny, min: 1) - Ilość zwracanych wyników na stronę, domyślnie 50.filters
(object, opcjonalny) - Tablica filtrów.buyer_data
(string, opcjonalny) - Dane kupującego (login, e-mail, id).auction_id
(integer, opcjonalny) - Numer ID aukcji.payment_status
(string, opcjonalny) - Status płatności. Wartości filtra powinny zostać pobrane dynamicznie.payment_type
(string, opcjonalny) - Typ płatności.wire_transfer
- Przelew tradycyjnycollect_on_delivery
- Płacę przy odbiorzepayu
- PayU
shipment_type
(integer, opcjonalny) - Typ wysyłki. Wartości filtra powinny zostać pobrane dynamicznie.with_invoice
(bool, opcjonalny) - Faktura.sold_since
(date, opcjonalny) - Data sprzedaży od.sold_till
(date, opcjonalny) - Data sprzedaży do.data
(string, opcjonalny) - Szukaj wszędzie.
- Zwracane parametry
total
(integer, zawsze zwracany) - Całkowita liczba wyników.current_page
(integer, zawsze zwracany) - Aktualna strona z wynikami.last_page
(integer, zawsze zwracany) - Ostatnia strona z wynikami.per_page
(integer, zawsze zwracany) - Liczba wyników na stronę.items
(array[item
], zawsze zwracany) - Tablica z wynikami.
- Zwracany obiekt
item
id
(integer, zawsze zwracany) - Numer ID.allegro_user_id
(integer, zawsze zwracany) - Numer ID konta Allegro.pl.form_id
(integer, zawsze zwracany) - Numer ID wypełnionego formularza Allegro.pl.form_id
(integer, zawsze zwracany) - Numer ID wypełnionego formularza Allegro.pl.form_created_at
(date, zawsze zwracany) - Data sprzedaży / stworzenia formularza.buyer_id
(integer, zawsze zwracany) - Numer ID kupującego w Allegro.pl.buyer_login
(string, zawsze zwracany) - Login kupującego w Allegro.pl.buyer_email
(string, zawsze zwracany) - Adres e-mail kupującego w Allegro.pl.wants_invoice
(bool, zawsze zwracany) - Informacja o tym, czy klient chce fakture VAT.to_pay_amount
(numeric, zawsze zwracany) - Całkowita kwota do zapłaty.postage_amount
(numeric, zawsze zwracany) - Kwota wysyłki.payment_type
(string, zawsze zwracany) - Typ płatności.payment_status
(string, zawsze zwracany) - Status płatności.shipment_type
(integer, zawsze zwracany) - Typ wysyłki.message
(string, opcjonalny) - Widomość od kupujacego.order
(objectorder
, opcjonalny) - Przypisane zamówienie w Tanieprzesylkikurierskie.pl.receiver_address
(objectaddress
, zawsze zwracany) - Adres doręczenia.invoice_address
(objectaddress
, opcjonalny) - Adres do faktury VAT.positions
(array[position
], zawsze zwracany) - Tablica z zakupionymi produktami.
- Zwracany obiekt
order
id
(integer, zawsze zwracany) - Numer ID zamówienia.courier_id
(integer, opcjonalny, akceptowane wartości: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12) - Numer ID kuriera.1
- Geis (K-ex)2
- GLS3
- DPD4
- InPost5
- DHL7
- Geis (ETL)8
- InPost Zagranica9
- InPost Paczkomaty11
- Patron Service12
- Fedex13
- GEODIS14
- UPS16
- Poczta Polska palety17
- Pocztex18
- Rohlig SUUS19
- ORLEN Paczka20
- Ambro Express22
- Rhenus Logistics23
- InPost Szybkie Zwroty24
- InPost Paczkomat → Kurier25
- InPost Paczkomaty Ekonomiczne
waybill_number
(string, opcjonalny) - Numer listu przewozowego.courier_status
(integer, opcjonalny) - Status przesyłki u kuriera.1
- Nieznany4
- Wprowadzona6
- Anulowana7
- Nieodebrana8
- W doręczeniu9
- Doręczona10
- Zwrot do nadawcy13
- Zakończona15
- List ręczny
status
(integer, opcjonalny) - Status zamówienia.11
- Oczekuje12
- Zapłacone13
- Błąd (wystąpił prawdopodobnie problem z płatnością, wymagany kontakt z BOK)14
- Anulowane
insurance_value
(numeric, opcjonalny) - Wartość ubezpieczenia.cod_value
(numeric, opcjonalny) - Wartość pobrania.product_id
(integer, wymagany, akceptowane wartości: 1, 2, 3) - Typ przesyłki.- 1 - Koperta.
- 2 - Paczka.
- 3 - Paleta.
weight
(numeric, zawsze zwracany) - Waga przesyłki.length
(numeric, zawsze zwracany) - Długość przesyłki.width
(numeric, zawsze zwracany) - Szerokość przesyłki.height
(numeric, zawsze zwracany) - Wysokość przesyłki.number_of_packages
(integer, zawsze zwracany) - Liczba przesyłek.price
(numeric, zawsze zwracany) - Cena zamówienia.description
(string, zawsze zwracany) - Zawartość.
- Zwracany obiekt
address
name
(string) - Imię.surname
(string) - Nazwisko.company
(string) - Nazwa firmy.street
(string) - Ulica.house_number
(string) - Numer domu.door_number
(string) - Numer mieszkania.post_code
(string) - Kod pocztowy.city
(string) - Miasto.country_id
(integer) - Kod kraju.phone
(string) - Telefon.pop
(objectpop
, opcjonalny) - Paczkomat.pp
(objectpp
, opcjonalny) - Placówka Poczty Polskiej.ruch
(objectruch
, opcjonalny) - Punkt RUCHu.tax_number
(string, opcjonalny) - Numer NIP.
-
Zwracany obiekt
pop
code
(string, zawsze zwracany) - Kod paczkomatu.
-
Zwracany obiekt
pp
code
(string, zawsze zwracany) - Kod placówki Poczty Polskiej.
-
Zwracany obiekt
ruch
code
(string, zawsze zwracany) - Kod Punktu RUCHu.
- Zwracany obiekt
position
auction_id
(string, zawsze zwracany) - Numer aukcji Allegro.pl.auction_title
(string, zawsze zwracany) - Tytuł aukcji Allegro.pl.quantity
(integer, zawsze zwracany) - Ilość.
URI
Headers
Content-Type: application/json
Body
{
"page": 1,
"per_page": 50,
"filters": {
"buyer_data": "Kowalski"
}
}
200
Headers
Content-Type: application/json
Body
{
"total": 1,
"current_page": 1,
"last_page": 1,
"per_page": 50,
"items": [
{
"id": 1,
"allegro_user_id": 1,
"form_id": 111111,
"form_created_at": "2015-10-24 09:44:48",
"buyer_id": 111112,
"buyer_login": "niezarejestrowany",
"buyer_email": "[email protected]",
"wants_invoice": false,
"to_pay_amount": 46,
"postage_amount": 44,
"payment_type": "collect_on_delivery",
"payment_status": "",
"shipment_type": 11,
"message": "dsdsds",
"order": {
"id": 1111,
"courier_id": 4,
"waybill_number": null,
"courier_status": null,
"courier_pickup_number": null,
"status": 11,
"insurance_value": 46,
"cod_value": 0,
"product_id": 1,
"weight": 0,
"length": 0,
"width": 0,
"height": 0,
"number_of_packages": 1,
"price": "17.00",
"description": "test"
},
"receiver_address": {
"name": "Jan",
"surname": "Kowalski",
"company": "ABC S. A.",
"street": "Testowa",
"house_number": "30/3",
"post_code": "01-111",
"city": "Warszawa",
"country_id": 1,
"phone": "123456789",
"tax_number": ""
},
"invoice_address": null,
"positions": [
{
"auction_id": "111111",
"auction_title": "testowa aukcja",
"quantity": 2
}
]
}
]
}
UsuńDELETE/user/allegro/accounts/:accountID/items
Przenieś wybrane rekordy Allegro do archiwum.
- Przyjmowane parametry
item_ids
(array[integer
], wymagany, min: 1) - Tablica rekordów Allegro.
URI
Headers
Content-Type: application/json
Body
{
"item_ids": [
123,
234
]
}
200
Headers
Content-Type: application/json
400
Headers
Content-Type: application/json
Body
{
"errors": {
"nazwa_pola": [
"Opis błędu."
]
},
"error_code": "InvalidInput",
"status_code": 400
}
404
Headers
Content-Type: application/json
Body
{
"message": "Nie znaleziono.",
"error_code": "NotFound",
"status_code": 404
}
PrzywróćPOST/user/allegro/accounts/:accountID/items/trash/restore
Przywróć wybrane rekordy Allegro.
- Przyjmowane parametry
item_ids
(array[integer
], wymagany, min: 1) - Tablica rekordów Allegro.
URI
Headers
Content-Type: application/json
Body
{
"item_ids": [
123,
234
]
}
200
Headers
Content-Type: application/json
400
Headers
Content-Type: application/json
Body
{
"errors": {
"nazwa_pola": [
"Opis błędu."
]
},
"error_code": "InvalidInput",
"status_code": 400
}
404
Headers
Content-Type: application/json
Body
{
"message": "Nie znaleziono.",
"error_code": "NotFound",
"status_code": 404
}
Allegro Filters ¶
Reprezentacja zasobu Allegro Items - transakcje użytkownika.
PobierzGET/user/allegro/accounts/:accountID/items/filters
Pobierz filtry użytkownika.
- Zwracane parametry
payment_statuses
(objectfilter
, zawsze zwracany) - Statusy płatności.shipment_types
(objectfilter
, zawsze zwracany) - Typy wysyłki.
- Zwracany obiekt
filter
id
(string, zawsze zwracany) - ID.description
(string, zawsze zwracany) - Opis.
URI
Headers
Content-Type: application/json
200
Headers
Content-Type: application/json
Body
{
"payment_statuses": [
{
"id": "Rozpoczęta",
"description": "Rozpoczęta"
},
{
"id": "Zakończona",
"description": "Zakończona"
}
],
"shipment_types": [
{
"id": 6,
"description": "List polecony ekonomiczny"
},
{
"id": 11,
"description": "Przesyłka kurierska pobraniowa"
},
{
"id": 16,
"description": "Allegro MiniPaczka InPost"
},
{
"id": 30,
"description": "Paczka24"
}
]
}
Orders ¶
Reprezentacja zasobu Orders - Zamówienia.
SzukajPOST/user/orders/search
Wyszukaj zamówienia użytkownika.
- Przyjmowane parametry
page
(integer, opcjonalny, min: 1) - Numer strony, domyślnie 1.per_page
(integer, opcjonalny, min: 1) - Ilość zwracanych wyników na stronę, domyślnie 50.filters
(object, opcjonalny) - Tablica filtrów.order_id
(integer, opcjonalny) - Numer zamówienia.waybill_number
(string, opcjonalny) - Numer listu przewozowego.order_status
(integer, opcjonalny) - Status zamówienia.11
- Oczekuje12
- Zapłacone13
- Błąd (wystąpił prawdopodobnie problem z płatnością, wymagany kontakt z BOK)14
- Anulowane
courier_status
(integer, opcjonalny) - Status przesyłki u kuriera.1
- Nieznany4
- Wprowadzona6
- Anulowana7
- Nieodebrana8
- W doręczeniu9
- Doręczona10
- Zwrot do nadawcy13
- Zakończona15
- List ręczny
created_since
(date, opcjonalny) - Data stworzenia zamówienia od.created_till
(date, opcjonalny) - Data stworzenia zamówienia do.courier_id
(integer, opcjonalny, akceptowane wartości: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12) - Numer ID kuriera.1
- Geis (K-ex)2
- GLS3
- DPD4
- InPost5
- DHL7
- Geis (ETL)8
- InPost Zagranica9
- InPost Paczkomaty11
- Patron Service12
- Fedex13
- GEODIS14
- UPS16
- Poczta Polska palety17
- Pocztex18
- Rohlig SUUS19
- ORLEN Paczka20
- Ambro Express22
- Rhenus Logistics23
- InPost Szybkie Zwroty24
- InPost Paczkomat → Kurier25
- InPost Paczkomaty Ekonomiczne
user_data
(string, opcjonalny) - Dane zamówienia (np. imię, nazwisko, numer telefonu, e-mail etc.).
URI
Headers
Content-Type: application/json
Body
{
"page": 1,
"per_page": 20,
"filters": {
"order_id": 123,
"waybill_number": 123,
"order_status": 12,
"courier_status": 1,
"created_since": "2017-01-01",
"created_till": "2017-01-30",
"user_data": "Jan Kowalski"
}
}
200
Headers
Content-Type: application/json
Body
{
"total": 1,
"current_page": 1,
"last_page": 1,
"per_page": 50,
"orders": [
{
"order_id": 123,
"pickup_at": "2017-01-26",
"pickup_hour_since": "10:00",
"pickup_hour_till": "13:00",
"status": 12,
"created_at": "2017-01-25 16:13:06",
"courier_id": 1,
"waybill_number": "123ABC1",
"courier_status": 6,
"courier_pickup_number": null,
"price": 20.1,
"product_id": 2,
"number_of_packages": 1,
"weight": 10.1,
"length": 1.1,
"width": 20,
"height": 20,
"cod_type": 0,
"cod_value": null,
"cod_bank_account_number": null,
"insurance_value": null,
"non_standard": true,
"description": "Buty",
"options": [
"without_waybill",
"direct_delivery_only"
],
"payment": [
"method" : "balance",
"invoice_id" : null,
"invoice_number" : null
],
"sender": {
"name": "Jan",
"surname": "Testowy",
"company": "Test SA",
"street": "Testowa",
"house_number": 11,
"door_number": 6,
"post_code": "82-300",
"city": "Elbląg",
"country_id": 1,
"phone": 123456789,
"email": "[email protected]",
"pop": null,
"pp": null,
"ruch": null
},
"receiver": {
"name": "Jan",
"surname": "Odbiorca",
"company": null,
"street": "Testowa",
"house_number": 11,
"door_number": null,
"post_code": "00-123",
"city": "Warszawa",
"country_id": 1,
"phone": 12345678,
"email": "[email protected]",
"pop": null,
"pp": null,
"ruch": null
},
"invoice": {
"name": "Jan",
"surname": "Faktura",
"company": "Faktura SA",
"tax_number": null,
"street": "Fakturowa",
"house_number": 11,
"door_number": 2,
"post_code": "82-300",
"city": "Elbląg",
"country_id": 1,
"phone": 123456789,
"email": "[email protected]"
}
},
{
"order_id": 124,
"pickup_at": "2017-01-26",
"pickup_hour_since": "10:00",
"pickup_hour_till": "13:00",
"status": 12,
"created_at": "2017-01-25 16:18:06",
"courier_id": 1,
"waybill_number": "123ABC1",
"courier_status": 6,
"courier_pickup_number": 12312423,
"price": 22.1,
"product_id": 2,
"number_of_packages": 1,
"weight": 10.1,
"length": 1.1,
"width": 20,
"height": 20,
"cod_type": 0,
"cod_value": null,
"cod_bank_account_number": null,
"insurance_value": null,
"non_standard": false,
"description": "Test",
"options": [
"without_waybill",
"direct_delivery_only"
],
"sender": {
"name": "Jan",
"surname": "Testowy",
"company": "Test SA",
"street": "Testowa",
"house_number": 11,
"door_number": 6,
"post_code": "82-300",
"city": "Elbląg",
"country_id": 1,
"phone": 123456789,
"email": "[email protected]",
"pop": null,
"pp": null,
"ruch": null
},
"receiver": {
"name": "Jan",
"surname": "Odbiorca",
"company": null,
"street": "Testowa",
"house_number": 11,
"door_number": null,
"post_code": "00-123",
"city": "Warszawa",
"country_id": 1,
"phone": 12345678,
"email": "[email protected]",
"pop": null,
"pp": null,
"ruch": null
},
"invoice": {
"name": "Jan",
"surname": "Faktura",
"company": "Faktura SA",
"tax_number": null,
"street": "Fakturowa",
"house_number": 11,
"door_number": 2,
"post_code": "82-300",
"city": "Elbląg",
"country_id": 1,
"phone": 123456789,
"email": "[email protected]"
}
}
]
}
StwórzPOST/user/orders
Stwórz zamówienie.
W sytuacji, gdy żądanie nie zawiera parametru token
,
system utworzy konto dla podanego adresu e-mail (nadawca lub dane zlecającego).
Konto zostanie utworzone na dane pobrane z pierwszego poprawnie stworzonego zamówienia.
Hasło do logowania zostanie przesłane na podany adres e-mail.
- Przyjmowane parametry
regulations_approval
(bool, wymagany bez:token
) - Akceptacja regulaminu. Parametr wymagany do rejestracji konta, opcjonalny, jeśli przesyłany jesttoken
. Regulamin znajduję się na stronie: https://tanieprzesylkikurierskie.pl/regulaminmarketing_approval
(bool, wymagany bez:token
) - Parametr wymagany do rejestracji konta, opcjonalny, jeśli przesyłany jesttoken
. Zgoda na umieszczenie danych teleadresowych w bazie serwisu i wykorzystanie ich.marketing_approval_2
(bool) - Parametr wymagany do rejestracji konta, opcjonalny, jeśli przesyłany jesttoken
. Zgoda na otrzymywanie na podany adres e-mail informacji handlowej.packages
(array, wymagany, min: 1, max: 50) - Tablica obiektówpackage
.package
(object, wymagany) - Objekt określający przesyłkę.product_id
(integer, wymagany, akceptowane wartości: 1, 2, 3) - Typ przesyłki.- 1 - Koperta.
- 2 - Paczka.
- 3 - Paleta.
weight
(numeric, wymagany jeśli:product_id
= 2, 3) - Waga przesyłki.length
(numeric, wymagany jeśli:product_id
= 2, 3) - Długość przesyłki.width
(numeric, wymagany jeśli:product_id
= 2, 3) - Szerokość przesyłki.height
(numeric, wymagany jeśli:product_id
= 2, 3) - Wysokość przesyłki.number_of_packages
(integer, opcjonalny, domyślnie: 1) - Liczba przesyłek.non_standard
(bool, wymagany jeśli:product_id
= 2) - Rodzaj opakowania. Opcja dostępna tylko dla paczki.insurance_value
(numeric, wymagany z:cod_type_id
, min: 0.01 lubcod_value
, max: 50000.0, niedostępny dla:courier_id
= 2) - Ubezpieczenie przesyłki. Wartość minimalna to (jeśli podano) wartość pobrania. Opcja niedostępna dla kuriera GLS.cod_type_id
(integer, opcjonalny, akceptowane wartości: 1, 2) - Typ pobrania.- 1 - Standard (dostępne dla:
courier_id
= 1, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12). - 2 - Express (dostępne dla:
courier_id
= 1).
- 1 - Standard (dostępne dla:
cod_value
(numeric, wymagany z:cod_type_id
, min: 0.01, max: 20000.0) - Wartość pobrania.cod_bank_account_number
(numeric, max: 26 znaków, walidacja na numer IBAN PL, wymagany z:cod_type_id
) - Numer konta do zwrotu pobrania.description
(string, wymagany, max: 30 znaków) - Opis zawartości.courier_id
(integer, wymagany, akceptowane wartości: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12) - Numer ID kuriera. Kurier może być niedostępny. Zawsze należy sprawdzić dostępność przez/order/resources/couriers
.1
- Geis (K-ex)2
- GLS3
- DPD4
- InPost5
- DHL7
- Geis (ETL)8
- InPost Zagranica9
- InPost Paczkomaty11
- Patron Service12
- Fedex13
- GEODIS14
- UPS16
- Poczta Polska palety17
- Pocztex18
- Rohlig SUUS19
- ORLEN Paczka20
- Ambro Express22
- Rhenus Logistics23
- InPost Szybkie Zwroty24
- InPost Paczkomat → Kurier25
- InPost Paczkomaty Ekonomiczne
pickup_date
(date, wymagany, format:Y-m-d
) - Data nadania przesyłki.hours
(array[hours
], opcjonalny) - Godziny odbioru przesyłki.from
(string, zawsze zwracany) - Godzina odbioru od.to
(string, zawsze zwracany) - Godzina odbioru do.
options
(array, opcjonalny) - Opcje dodatkowe. Akceptowane wartości poniżej. Tablice należy przesłać jako zbiór nazw opcji, które powinny zostać dodane do zamówienia.direct_delivery_only
delivery_phone_advice_note
delivery_sms_advice_note
delivery_email_advice_note
email_confirmation_of_delivery
sms_confirmation_of_delivery
pre_delivery_information
check_contents_before_accepting
without_waybill
no_pickup
with_pickup
delivery_until_9_00
delivery_until_12_00
delivery_between_18_00_and_22_00
delivery_on_saturday
express_delivery
handle_with_care
sender
(object, wymagany) - Dane nadawcy.name
(string, wymaganie, tylko znaki alfabetu, max: 30 znaków zsurname
) - Imię.surname
(string, wymaganie, tylko znaki alfabetu, max: 30 znaków zname
) - Nazwisko.company
(string, opcjonalny, max: 60 znaków, jeślicourier_id
= 8 to max: 50 znaków) - Nazwa firmy.tax_number
(string, opcjonalny, dostępny tylko dla niezalogowanych, max: 16 znaków) - Numer NIP.street
(string, wymagany, max: 100 znaków, jeślicourier_id
= 8 to max: 90 znaków, jeślicourier_id
= 5 to max: 60 znaków) - Ulica.house_number
(string, wymagany, max: 10 znaków) - Numer domu.door_number
(string, opcjonalny, max: 10 znaków) - Numer mieszkania.post_code
(string, wymagany, max: 10 znaków) - Kod pocztowy.city
(string, wymagany, max: 50 znaków) - Miasto.country_id
(integer, wymagany, zgodny zGET /order/resources/countries
) - Kod kraju.phone
(string, wymagany, jeślicountry_id
= 1: min: 5 znaków, max: 13 znaków, jeślicountry_id
!= 1 to max: 20 znaków) - Telefon.pop_code
(string, wymagany jeślicourier_id
= 9, zgodny zGET /pop/search
) - Kod paczkomatu.pp_code
(string, wymagany jeślicourier_id
= 17, zgodny zGET /pp/search
) - Kod placówki Poczty Polskiej.ruch_code
(string, wymagany jeślicourier_id
= 19, zgodny zGET /ruch/search
) - Kod Punktu RUCHu.email
(string, wymagany, opcjonalny, jeśli niezalogowany i wypełnionoinvoice
, email, max: 255 znaków) - E-mail.add_to_address_book
(bool, opcjonalny) - Informacja czy dodać adres do książki adresowej.
receiver
(object, wymagany) - Dane odbiorcy.name
(string, wymaganie, tylko znaki alfabetu, max: 30 znaków zsurname
) - Imię.surname
(string, wymaganie, tylko znaki alfabetu, max: 30 znaków zname
) - Nazwisko.company
(string, opcjonalny, max: 60 znaków, jeślicourier_id
= 8 to max: 50 znaków) - Nazwa firmy.street
(string, wymagany, max: 100 znaków, jeślicourier_id
= 8 to max: 90 znaków, jeślicourier_id
= 5 to max: 60 znaków) - Ulica.house_number
(string, wymagany, max: 10 znaków) - Numer domu.door_number
(string, opcjonalny, max: 10 znaków) - Numer mieszkania.post_code
(string, wymagany, max: 10 znaków) - Kod pocztowy.city
(string, wymagany, max: 50 znaków) - Miasto.country_id
(integer, wymagany, zgodny zGET /order/resources/countries
) - Kod kraju.phone
(string, wymagany, jeślicountry_id
= 1: min: 5 znaków, max: 13 znaków, jeślicountry_id
!= 1 to max: 20 znaków) - Telefon.pop_code
(string, wymagany jeślicourier_id
= 9, zgodny zGET /pop/search
) - Kod paczkomatu.pp_code
(string, wymagany jeślicourier_id
= 17, zgodny zGET /pp/search
) - Kod placówki Poczty Polskiej.ruch_code
(string, wymagany jeślicourier_id
= 19, zgodny zGET /ruch/search
) - Kod Punktu RUCHu.email
(string, opcjonalny, email, max: 255 znaków) - E-mail.add_to_address_book
(bool, opcjonalny) - Informacja czy dodać adres do książki adresowej.
invoice
(object, opcjonalny) - Dane do faktury VAT lub dla niezalogowanych - dane do właściciela konta oraz dane do faktury VAT.name
(string, wymaganie, tylko znaki alfabetu, max: 30 znaków zsurname
) - Imię.surname
(string, wymaganie, tylko znaki alfabetu, max: 30 znaków zname
) - Nazwisko.company
(string, opcjonalny, jeśli podanoname
orazsurname
, max: 60 znaków, jeślicourier_id
= 8 to max: 50 znaków) - Nazwa firmy.tax_number
(string, opcjonalny, max: 16 znaków) - Numer NIP. Tylko dla niezalogowanych.street
(string, wymagany, max: 100 znaków, jeślicourier_id
= 8 to max: 90 znaków, jeślicourier_id
= 5 to max: 60 znaków) - Ulica.house_number
(string, wymagany, max: 10 znaków) - Numer domu.door_number
(string, opcjonalny, max: 10 znaków) - Numer mieszkania.post_code
(string, wymagany, max: 10 znaków) - Kod pocztowy.city
(string, wymagany, max: 50 znaków) - Miasto.country_id
(integer, wymagany, zgodny zGET /order/resources/countries
) - Kod kraju.phone
(string, wymagany, jeślicountry_id
= 1: min: 5 znaków, max: 13 znaków, jeślicountry_id
!= 1 to max: 20 znaków) - Telefon.email
(string, wymagany dla niezalogowanych, email, max: 255 znaków) - E-mail.add_to_address_book
(bool, opcjonalny) - Informacja czy dodać adres do książki adresowej.
URI
Headers
Content-Type: application/json
Body
{
"regulations_approval": true,
"marketing_approval": true,
"marketing_approval_2": true,
"packages": [
{
"product_id": 2,
"weight": 50,
"length": 200,
"width": 200,
"height": 200,
"number_of_packages": 1,
"non_standard": true,
"insurance_value": 1000,
"cod_type_id": 1,
"cod_value": 1000,
"cod_bank_account_number": "52175000120000000032413366",
"description": "123",
"pickup_date": "2017-04-10",
"pickup_hours": {
"from": "11:00",
"to": "13:00"
},
"courier_id": 4,
"sender": {
"name": "Jan",
"surname": "Kowalski",
"street": "Kowalska",
"house_number": "12",
"post_code": "01-111",
"city": "Warszawa",
"country_id": 1,
"phone": "123456789"
},
"receiver": {
"name": "Anna",
"surname": "Kowalski",
"street": "Testowa",
"house_number": "11",
"door_number": "2",
"post_code": "82-300",
"city": "Elbląg",
"country_id": 1,
"phone": "123456789"
},
"invoice": {
"name": "Jan",
"surname": "Kowalski",
"company": "Kowalski Sp. z o.o.",
"street": "Testowa",
"house_number": "12",
"post_code": "82-300",
"city": "Elbląg",
"country_id": 1,
"phone": "123456789",
"email": "[email protected]"
}
}
]
}
201
Headers
Content-Type: application/json
Body
[
{
"order_id": 777,
"price": 3931.5,
"courier_id": 4
}
]
ImportujPOST/import/orders
Import zamówień z pliku CSV. Obsługiwane formaty i przykładowe pliki CSV są dostępne w zakładce Import zamówień. Przed importem należy przesłać plik CSV na serwer (patrz: zasób File).
-
Przyjmowane parametry
token
(string, wymagany) - Token.file_id
(string, wymagany) - Identyfikator przesłanego pliku CSV.import_order_type_id
(int, wymagany, akceptowane wartości: 1, 2) - Rodzaj przesłanego pliku CSV.- 1 - CSV.
- 2 - Shoper.
-
Zwracane parametry
working_control
(string, zawsze zwracany) - Hash kontrolny.status
(int, zawsze zwracany) - Kod statusu.progress
(int, zawsze zwracany) - Postęp importu zamówień wyrażony w procentach.
URI
Headers
Content-Type: application/json
Body
{
"file_id": "8e8215a8161c01f4e297c1c41e195528bt5ozTxWOsGTq2Se4wQCCcrznu1225GJ"
}
201
Headers
Content-Type: application/json
Body
{
"working_control": "84faf9c06eee5f14123755c955ce054bYQmVv9mJtFjalVGnH9g3yStHW9D3Qmnq",
"status": 100,
"progress": 0
}
EdytujPUT/user/orders/:orderID
Edytuj zamówienie.
- Przyjmowane parametry
packages
(array, wymagany, min: 1, max: 50) - Tablica obiektówpackage
.package
(object, wymagany) - Objekt określający przesyłkę.product_id
(integer, wymagany, akceptowane wartości: 1, 2, 3) - Typ przesyłki.- 1 - Koperta.
- 2 - Paczka.
- 3 - Paleta.
weight
(numeric, wymagany jeśli:product_id
= 2, 3) - Waga przesyłki.length
(numeric, wymagany jeśli:product_id
= 2, 3) - Długość przesyłki.width
(numeric, wymagany jeśli:product_id
= 2, 3) - Szerokość przesyłki.height
(numeric, wymagany jeśli:product_id
= 2, 3) - Wysokość przesyłki.number_of_packages
(integer, opcjonalny, domyślnie: 1) - Liczba przesyłek.non_standard
(bool, wymagany jeśli:product_id
= 2) - Rodzaj opakowania. Opcja dostępna tylko dla paczki.insurance_value
(numeric, wymagany z:cod_type_id
, min: 0.01 lubcod_value
, max: 50000.0, niedostępny dla:courier_id
= 2) - Ubezpieczenie przesyłki. Wartość minimalna to (jeśli podano) wartość pobrania. Opcja niedostępna dla kuriera GLS.cod_type_id
(integer, opcjonalny, akceptowane wartości: 1, 2) - Typ pobrania.- 1 - Standard (dostępne dla:
courier_id
= 1, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12). - 2 - Express (dostępne dla:
courier_id
= 1).
- 1 - Standard (dostępne dla:
cod_value
(numeric, wymagany z:cod_type_id
, min: 0.01, max: 20000.0) - Wartość pobrania.cod_bank_account_number
(numeric, max: 26 znaków, walidacja na numer IBAN PL, wymagany z:cod_type_id
) - Numer konta do zwrotu pobrania.description
(string, wymagany, max: 30 znaków) - Opis zawartości.courier_id
(integer, wymagany, akceptowane wartości: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12) - Numer ID kuriera. Kurier może być niedostępny. Zawsze należy sprawdzić dostępność przez/order/resources/couriers
.1
- Geis (K-ex)2
- GLS3
- DPD4
- InPost5
- DHL7
- Geis (ETL)8
- InPost Zagranica9
- InPost Paczkomaty11
- Patron Service12
- Fedex13
- GEODIS14
- UPS16
- Poczta Polska palety17
- Pocztex18
- Rohlig SUUS19
- ORLEN Paczka20
- Ambro Express22
- Rhenus Logistics23
- InPost Szybkie Zwroty24
- InPost Paczkomat → Kurier25
- InPost Paczkomaty Ekonomiczne
pickup_date
(date, wymagany, format:Y-m-d
) - Data nadania przesyłki.hours
(array[hours
], opcjonalny) - Godziny odbioru przesyłki.from
(string, zawsze zwracany) - Godzina odbioru od.to
(string, zawsze zwracany) - Godzina odbioru do.
options
(array, opcjonalny) - Opcje dodatkowe. Akceptowane wartości poniżej. Tablice należy przesłać jako zbiór nazw opcji, które powinny zostać dodane do zamówienia.direct_delivery_only
delivery_phone_advice_note
delivery_sms_advice_note
delivery_email_advice_note
email_confirmation_of_delivery
sms_confirmation_of_delivery
pre_delivery_information
check_contents_before_accepting
without_waybill
no_pickup
with_pickup
delivery_until_9_00
delivery_until_12_00
delivery_between_18_00_and_22_00
delivery_on_saturday
express_delivery
return_documents
handle_with_care
sender
(object, wymagany) - Dane nadawcy.name
(string, wymaganie, tylko znaki alfabetu, max: 30 znaków zsurname
) - Imię.surname
(string, wymaganie, tylko znaki alfabetu, max: 30 znaków zname
) - Nazwisko.company
(string, opcjonalny, max: 60 znaków, jeślicourier_id
= 8 to max: 50 znaków) - Nazwa firmy.tax_number
(string, opcjonalny, dostępny tylko dla niezalogowanych, max: 16 znaków) - Numer NIP.street
(string, wymagany, max: 100 znaków, jeślicourier_id
= 8 to max: 90 znaków, jeślicourier_id
= 5 to max: 60 znaków) - Ulica.house_number
(string, wymagany, max: 10 znaków) - Numer domu.door_number
(string, opcjonalny, max: 10 znaków) - Numer mieszkania.post_code
(string, wymagany, max: 10 znaków) - Kod pocztowy.city
(string, wymagany, max: 50 znaków) - Miasto.country_id
(integer, wymagany, zgodny zGET /order/resources/countries
) - Kod kraju.phone
(string, wymagany, jeślicountry_id
= 1: min: 5 znaków, max: 13 znaków, jeślicountry_id
!= 1 to max: 20 znaków) - Telefon.pop
(objectpop
, wymagany jeślicourier_id
= 9, zgodny zGET /pop/search
) - Paczkomat.pp_code
(string, wymagany jeślicourier_id
= 17, zgodny zGET /pp/search
) - Kod placówki Poczty Polskiej.ruch_code
(string, wymagany jeślicourier_id
= 19, zgodny zGET /ruch/search
) - Kod Punktu RUCHu.email
(string, wymagany, opcjonalny, jeśli niezalogowany i wypełnionoinvoice
, email, max: 255 znaków) - E-mail.add_to_address_book
(bool, opcjonalny) - Informacja czy dodać adres do książki adresowej.
receiver
(object, wymagany) - Dane odbiorcy.name
(string, wymaganie, tylko znaki alfabetu, max: 30 znaków zsurname
) - Imię.surname
(string, wymaganie, tylko znaki alfabetu, max: 30 znaków zname
) - Nazwisko.company
(string, opcjonalny, max: 60 znaków, jeślicourier_id
= 8 to max: 50 znaków) - Nazwa firmy.street
(string, wymagany, max: 100 znaków, jeślicourier_id
= 8 to max: 90 znaków, jeślicourier_id
= 5 to max: 60 znaków) - Ulica.house_number
(string, wymagany, max: 10 znaków) - Numer domu.door_number
(string, opcjonalny, max: 10 znaków) - Numer mieszkania.post_code
(string, wymagany, max: 10 znaków) - Kod pocztowy.city
(string, wymagany, max: 50 znaków) - Miasto.country_id
(integer, wymagany, zgodny zGET /order/resources/countries
) - Kod kraju.phone
(string, wymagany, jeślicountry_id
= 1: min: 5 znaków, max: 13 znaków, jeślicountry_id
!= 1 to max: 20 znaków) - Telefon.pop
(objectpop
, wymagany jeślicourier_id
= 9, zgodny zGET /pop/search
) - Paczkomat.pp_code
(string, wymagany jeślicourier_id
= 17, zgodny zGET /pp/search
) - Kod placówki Poczty Polskiej.ruch_code
(string, wymagany jeślicourier_id
= 19, zgodny zGET /ruch/search
) - Kod Punktu RUCHu.email
(string, opcjonalny, email, max: 255 znaków) - E-mail.add_to_address_book
(bool, opcjonalny) - Informacja czy dodać adres do książki adresowej.
invoice
(object, opcjonalny) - Dane do faktury VAT lub dla niezalogowanych - dane do właściciela konta oraz dane do faktury VAT.name
(string, wymaganie, tylko znaki alfabetu, max: 30 znaków zsurname
) - Imię.surname
(string, wymaganie, tylko znaki alfabetu, max: 30 znaków zname
) - Nazwisko.company
(string, opcjonalny, jeśli podanoname
orazsurname
, max: 60 znaków, jeślicourier_id
= 8 to max: 50 znaków) - Nazwa firmy.tax_number
(string, opcjonalny, max: 16 znaków) - Numer NIP. Tylko dla niezalogowanych.street
(string, wymagany, max: 100 znaków, jeślicourier_id
= 8 to max: 90 znaków, jeślicourier_id
= 5 to max: 60 znaków) - Ulica.house_number
(string, wymagany, max: 10 znaków) - Numer domu.door_number
(string, opcjonalny, max: 10 znaków) - Numer mieszkania.post_code
(string, wymagany, max: 10 znaków) - Kod pocztowy.city
(string, wymagany, max: 50 znaków) - Miasto.country_id
(integer, wymagany, zgodny zGET /order/resources/countries
) - Kod kraju.phone
(string, wymagany, jeślicountry_id
= 1: min: 5 znaków, max: 13 znaków, jeślicountry_id
!= 1 to max: 20 znaków) - Telefon.email
(string, wymagany dla niezalogowanych, email, max: 255 znaków) - E-mail.add_to_address_book
(bool, opcjonalny) - Informacja czy dodać adres do książki adresowej.
-
Zwracany obiekt
pop
code
(string, zawsze zwracany) - Kod.country_code
(string, zawsze zwracany) - Kod kraju.city
(string, zawsze zwracany) - Miasto.street
(string, zawsze zwracany) - Ulica.house_number
(string, opcjonalny) - Numer domu.province
(string, zawsze zwracany) - Województwo.post_code
(string, zawsze zwracany) - Kod pocztowy.description
(string, opcjonalny) - Dodatkowy opis.
-
Zwracany obiekt
pp
display_name
(string, zawsze zwracany) - Nazwa wyświetlana, np. “Elbląg - Plac Dworcowy 2 (UP238538)”.code
(string, zawsze zwracany) - kod Placówki, np. “238538”.name_prefix
(string, zawsze zwracany) - prefiks nazwy, np. “UP”.name
(string, zawsze zwracany) - nazwa placówki, np. “Elbląg 2”.province
(string, zawsze zwracany) - województwo, np. “warmińsko-mazurskie”.district
(string, zawsze zwracany) - gmina, np. “Elbląg”.place
(string, zawsze zwracany) - miejsce, np. “Elbląg”.post_code
(string, zawsze zwracany) - kod pocztowy, np. “82310”.city
(string, zawsze zwracany) - miasto, np. “Elbląg”.street
(string, zawsze zwracany) - ulica, np. “Plac Dworcowy”.house_number
(string, zawsze zwracany) - numer domu, np. “2”.print_name
(string, zawsze zwracany) - nazwa do wydruku, np. “UP Elbląg 2”.branch_network
(string, zawsze zwracany) - sieć placówek, np. “POCZTAPOLSKA”.support_sms_notification
(boolean, zawsze zwracany) - czy obsługuje usługę “Powiadomienie SMS”, np. “true”.support_eprzesylka
(boolean, zawsze zwracany) - czy obsługuje usługę ePrzesylka, np. “true”.support_przesylkabiznesowaplus
(boolean, zawsze zwracany) - czy obsługuje usługę “przesylkabiznesowaplus”, np. “true”.support_przesylkabiznesowa
(boolean, zawsze zwracany) - czy obsługuje usługę przesylkabiznesowa, np. “true”.
- Zwracany obiekt
ruch
display_name
(string, zawsze zwracany) - Nazwa wyświetlana, np. “Warszawa, Borowej Góry 2”.code
(string, zawsze zwracany) - kod Punktu RUCHu, np. “WS-492393-25-18”.street_name
(string, zawsze zwracany) - prefiks nazwy, np. “BOROWEJ GÓRY 2”.city
(string, zawsze zwracany) - miejscowość Punktu, np. “Warszawa”.district
(string, zawsze zwracany) - gmina Punktu, np. “Warszawa”.longitude
(numeric, zawsze zwracany) - długość geograficzna, np. “20.92”.latitude
(numeric, zawsze zwracany) - szerokość geograficzna, np. “52.23”.province
(string, zawsze zwracany) - województwo, np. “Mazowieckie”.cash_on_delivery
(boolean, zawsze zwracany) - miasto, np. “Elbląg”.opening_hours
(string, zawsze zwracany) - godziny otwarcia, np. “Pn-Pt:06:00-20:00, So:06:00-18:00, Nd: nieczynne”.location
(string, zawsze zwracany) - opis lokalizacji punktu, np. “Kiosk z wejściem, znajdujący się na ul. Powstańców Wielkopolskich, przy skrzyżowaniu ulic Powstańców Wielkopolskich z Wyszyńskiego. Obok znajduje się kwiaciarnia.”.psd
(string, zawsze zwracany) - nr PDS (brak przykładu).available
(boolean, zawsze zwracany) - czy placówka jest dostępna, np. “true”.point_type
(string, zawsze zwracany) - Rodzaj Punktu/Kiosku (własny - PSD, partnerski – PSP)
URI
Headers
Content-Type: application/json
Body
{
"packages": [
{
"product_id": 2,
"weight": 50,
"length": 200,
"width": 200,
"height": 200,
"number_of_packages": 1,
"non_standard": true,
"insurance_value": 1000,
"cod_type_id": 1,
"cod_value": 1000,
"cod_bank_account_number": "52175000120000000032413366",
"description": "123",
"pickup_date": "2017-04-10",
"pickup_hours": {
"from": "11:00",
"to": "13:00"
},
"courier_id": 4,
"sender": {
"name": "Jan",
"surname": "Kowalski",
"street": "Kowalska",
"house_number": "12",
"post_code": "01-111",
"city": "Warszawa",
"country_id": 1,
"phone": "123456789"
},
"receiver": {
"name": "Anna",
"surname": "Kowalski",
"street": "Testowa",
"house_number": "11",
"door_number": "2",
"post_code": "82-300",
"city": "Elbląg",
"country_id": 1,
"phone": "123456789"
},
"invoice": {
"name": "Jan",
"surname": "Kowalski",
"company": "Kowalski Sp. z o.o.",
"street": "Testowa",
"house_number": "12",
"post_code": "82-300",
"city": "Elbląg",
"country_id": 1,
"phone": "123456789",
"email": "[email protected]"
}
}
]
}
200
Headers
Content-Type: application/json
Body
[
{
"order_id": 777,
"price": 3931.5,
"courier_id": 4
}
]
400
Headers
Content-Type: application/json
Body
{
"errors": {
"email": [
"Opis błędu",
],
"password": [
"Opis błędu.",
]
},
"error_code": "InvalidInput",
"status_code": 400
}
404
Headers
Content-Type: application/json
Body
{
"message": "Nie znaleziono.",
"error_code": "NotFound",
"status_code": 404
}
PobierzGET/user/orders/:orderID
Pobierz dane zamówienia.
URI
Headers
Content-Type: application/json
200
Headers
Content-Type: application/json
Body
{
"order_id": 123,
"pickup_at": "2017-01-18",
"pickup_hour_since": "09:00",
"pickup_hour_till": "16:00",
"status": 12,
"created_at": "2017-01-17 16:15:41",
"courier_id": 4,
"waybill_number": "ABC123",
"courier_status": 9,
"courier_pickup_number": 32452464398323862354,
"price": 12.6,
"product_id": 2,
"number_of_packages": 1,
"weight": 10,
"length": 10,
"width": 10,
"height": 10,
"cod_type": 0,
"cod_value": null,
"cod_bank_account_number": null,
"insurance_value": null,
"description": "test",
"options": [
"without_waybill",
"direct_delivery_only"
],
"payment": [
"method" : "balance",
"invoice_id" : null,
"invoice_number" : null
],
"sender": {
"name": "Jan",
"surname": "Kowalski",
"company": "Kowalski S. A.",
"street": "Kowalska",
"house_number": 1,
"door_number": 999,
"post_code": "01-111",
"city": "Warszawa",
"country_id": 1,
"phone": 123456789,
"email": "[email protected]",
"pop": null,
"pp": null,
"ruch": null
},
"receiver": {
"name": "Robert",
"surname": "Firmowy",
"company": null,
"street": "Firmowa",
"house_number": 2,
"door_number": null,
"post_code": "82-300",
"city": "Elbląg",
"country_id": 1,
"phone": 123456789,
"email": "[email protected]",
"pop": null,
"pp": null,
"ruch": null
},
"invoice": {
"name": "Jan",
"surname": "Faktura",
"company": null,
"tax_number": null,
"street": "Testowa",
"house_number": 1,
"door_number": 6,
"post_code": "82-300",
"city": "Warszawa",
"country_id": 1,
"phone": 123456789,
"email": "[email protected]"
}
}
AnulujPATCH/user/orders/:orderID/cancel
Anuluj zamówienie.
URI
Headers
Content-Type: application/json
200
Headers
Content-Type: application/json
417
Headers
Content-Type: application/json
Waybill ¶
Reprezentacja zasobu Waybill - List przewozowy.
PobierzPOST/waybill/download
Pobierz listy przewozowe.
- Przyjmowane parametry
- Przyjmowane parametry
order_ids
(array[integer
], wymagany, min: 1) - Tablica zamówień.wants_url
(bool, opcjonalny) - Pozwala zdecydować czy odpowiedź ma wrócić jako URL do pliku czy jako zakodowany PDF w base64.
- Przyjmowane parametry
- Zwracane parametry
url
lubfile
(string, zawsze zwracany) - Adres URL do listów przewozowych lub zakodowany plik PDF w base64.
URI
Headers
Content-Type: application/json
Body
{
"order_ids": [
123
],
"url": false
}
200
Headers
Content-Type: application/json
Body
{
"url": "https://tanieprzesylkikurierskie.pl/file/waybill/abc"
}
201
Headers
Content-Type: application/json
Body
{
"file": "base64"
}
400
Headers
Content-Type: application/json
Body
{
"errors": {
"email": [
"Opis błędu",
],
"password": [
"Opis błędu.",
]
},
"error_code": "InvalidInput",
"status_code": 400
}
404
Headers
Content-Type: application/json
Body
{
"message": "Nie znaleziono.",
"error_code": "NotFound",
"status_code": 404
}
Pickup Date ¶
Reprezentacja zasobu Date of posting - data nadania.
SzukajPOST/user/orders/pickup-date/search
Wyszukaj dostępne daty nadania. Im więcej szczegółów tym zakres jest dokładniejszy.
- Przyjmowane parametry
courier_id
(integer, opcjonalny, akceptowane wartości: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12) - Numer ID kuriera.1
- Geis (K-ex)2
- GLS3
- DPD4
- InPost5
- DHL7
- Geis (ETL)8
- InPost Zagranica9
- InPost Paczkomaty11
- Patron Service12
- Fedex13
- GEODIS14
- UPS16
- Poczta Polska palety17
- Pocztex18
- Rohlig SUUS19
- ORLEN Paczka20
- Ambro Express22
- Rhenus Logistics23
- InPost Szybkie Zwroty24
- InPost Paczkomat → Kurier25
- InPost Paczkomaty Ekonomiczne
product_id
(integer, opcjonalny, akceptowane wartości: 1, 2, 3) - Typ przesyłki.- 1 - Koperta.
- 2 - Paczka.
- 3 - Paleta.
pickup_date
(date, opcjonalny) - Data odbioru.sender
(objectaddress
, opcjonalny) - Dane nadawcy.receiver
(objectaddress
, opcjonalny) - Dane odbiorcy.weight
(numeric, opcjonalny) - Waga przesyłki.length
(numeric, opcjonalny) - Długość przesyłki.width
(numeric, opcjonalny) - Szerokość przesyłki.height
(numeric, opcjonalny) - Wysokość przesyłki.with_pickup
(bool, opcjonalny, tylko jeślicourier_id
= 9) - Opcja dodatkowa pozwalająca zamówić kuriera. Dostępna tylko dla InPost Paczkomaty.
- Przyjmowany obiekt
address
country_id
(integer, opcjonalny, występuje w zasobie GET /order/resources/countries) - ID kraju.post_code
(string, opcjonalny) - Kod pocztowy.use_pop
(bool, opcjonalny) - Nadanie w paczkomacie.
- Zwracane parametry
pickup_date
(date, zawsze zwracany) - Dozwolona data odbioru.hours
(array[hour
], opcjonalny) - Tablica z dostępnymi godzinami.available_dates
(array[date
], opcjonalny) - Tablica z dostępnymi datami dobioru.
- Zwracany obiekt
hour
from
(string, zawsze zwracany) - Godzina odbioru od.to
(string, zawsze zwracany) - Godzina odbioru do.
URI
Headers
Content-Type: application/json
Body
{
"courier_id": 3,
"product_id": 2,
"pickup_date": "2017-04-05",
"sender": {
"country_id": 1,
"post_code": "82-300"
},
"receiver": {
"country_id": 1
},
"weight": 10,
"length": 11,
"width": 12,
"height": 13
}
200
Headers
Content-Type: application/json
Body
{
"pickup_date": "2017-04-05",
"hours": [
{
"from": "14:00",
"to": "17:00"
},
{
"from": "15:00",
"to": "18:00"
}
],
"available_dates": [
"2017-04-05",
"2017-04-06",
"2017-04-07",
"2017-04-08",
"2017-04-09",
"2017-04-10",
"2017-04-11",
"2017-04-12",
"2017-04-13",
"2017-04-14",
"2017-04-15",
"2017-04-16",
"2017-04-18",
"2017-04-19",
"2017-04-20",
"2017-04-21",
"2017-04-22",
"2017-04-23",
"2017-04-24",
"2017-04-25",
"2017-04-26",
"2017-04-27",
"2017-04-28",
"2017-04-29",
"2017-04-30",
"2017-05-02",
"2017-05-04",
"2017-05-05"
]
}
400
Headers
Content-Type: application/json
Body
{
"errors": {
"email": [
"Opis błędu",
],
"password": [
"Opis błędu.",
]
},
"error_code": "InvalidInput",
"status_code": 400
}
Offers ¶
Reprezentacja zasobu Offers - Oferty.
StwórzPOST/user/orders/offers
Zasób pozwala na stworzenie ofert dla podanych parametrów zamówienia. Pozwala na określenie, który z dostępnych kurierów zwraca najkorzystniejsze warunki. Im więcej danych zostanie podanych, tym oferta jest bardziej szczegółowa.
- Przyjmowane parametry
packages
(array, wymagany, min: 1, max: 50) - Tablica obiektówpackage
.package
(object, wymagany) - Objekt określający przesyłkę.product_id
(integer, wymagany, akceptowane wartości: 1, 2, 3) - Typ przesyłki.- 1 - Koperta.
- 2 - Paczka.
- 3 - Paleta.
weight
(numeric, wymagany jeśli:product_id
= 2, 3) - Waga przesyłki.length
(numeric, wymagany jeśli:product_id
= 2, 3) - Długość przesyłki.width
(numeric, wymagany jeśli:product_id
= 2, 3) - Szerokość przesyłki.height
(numeric, wymagany jeśli:product_id
= 2, 3) - Wysokość przesyłki.number_of_packages
(integer, opcjonalny, domyślnie: 1) - Liczba przesyłek.non_standard
(bool, wymagany jeśli:product_id
= 2) - Rodzaj opakowania. Opcja dostępna tylko dla paczki.insurance_value
(numeric, wymagany z:cod_type_id
, min: 0.01 lubcod_value
, max: 50000.0, niedostępny dla:courier_id
= 2) - Ubezpieczenie przesyłki. Wartość minimalna to (jeśli podano) wartość pobrania. Opcja niedostępna dla kuriera GLS.cod_type_id
(integer, opcjonalny, akceptowane wartości: 1, 2) - Typ pobrania.- 1 - Standard (dostępne dla:
courier_id
= 1, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12). - 2 - Express (dostępne dla:
courier_id
= 1).
- 1 - Standard (dostępne dla:
cod_value
(numeric, wymagany z:cod_type_id
, min: 0.01, max: 20000.0) - Wartość pobrania.cod_bank_account_number
(numeric, max: 26 znaków, walidacja na numer IBAN PL, wymagany z:cod_type_id
) - Numer konta do zwrotu pobrania.description
(string, wymagany, max: 30 znaków) - Opis zawartości.
- Zwracane parametry
offers
(array[offer
], opcjonalny) - Tablica z ofertami zgodnie z przesłanym zapytaniem.best_offer
(objectoffer
, opcjonalny) - Promowana oferta (ze względu na cenę lub inne).options
(objectoption
, opcjonalny) - Tablica z opcjami i ich cenami.notice
(array[notice
], opcjonalny) - Tablica z dodatkowymi uwagami.
- Zwracany obiekt
offer
courier_id
(integer, zawsze zwracany, akceptowane wartości: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12) - Numer ID kuriera.1
- Geis (K-ex)2
- GLS3
- DPD4
- InPost5
- DHL7
- Geis (ETL)8
- InPost Zagranica9
- InPost Paczkomaty11
- Patron Service12
- Fedex13
- GEODIS14
- UPS16
- Poczta Polska palety17
- Pocztex18
- Rohlig SUUS19
- ORLEN Paczka20
- Ambro Express22
- Rhenus Logistics23
- InPost Szybkie Zwroty24
- InPost Paczkomat → Kurier25
- InPost Paczkomaty Ekonomiczne
price
(numeric, zawsze zwracany) - Kwota oferty na zamówienie.currency
(string, zawsze zwracany) - Waluta.options
(array, zawsze zwracany) - Tablica z opcjami dodatkowymi wraz z cenami.name
(string, zawsze zwracany) - Nazwa opcji. Zwracane wartości poniżej.direct_delivery_only
delivery_phone_advice_note
delivery_sms_advice_note
delivery_email_advice_note
email_confirmation_of_delivery
sms_confirmation_of_delivery
pre_delivery_information
check_contents_before_accepting
without_waybill
no_pickup
with_pickup
delivery_until_9_00
delivery_until_12_00
delivery_between_18_00_and_22_00
delivery_on_saturday
express_delivery
return_documents
handle_with_care
price
(numeric, zawsze zwracany) - Kwota opcji (kwota jest juz wliczona w całkowitą kwotę, tutaj wystepuje tylko poglądowo).
- Zwracany obiekt
option
available
(bool, zawsze zwracany) - Informacja o dostępności.couriers
(array[courier
], zawsze zwracany) - Informacja o kurierach, którzy akceptują daną opcje.
- Zwracany obiekt
courier
courier_id
(integer, zawsze zwracany, akceptowane wartości: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12) - Numer ID kuriera.1
- Geis (K-ex)2
- GLS3
- DPD4
- InPost5
- DHL7
- Geis (ETL)8
- InPost Zagranica9
- InPost Paczkomaty11
- Patron Service12
- Fedex13
- GEODIS14
- UPS16
- Poczta Polska palety17
- Pocztex18
- Rohlig SUUS19
- ORLEN Paczka20
- Ambro Express22
- Rhenus Logistics23
- InPost Szybkie Zwroty24
- InPost Paczkomat → Kurier25
- InPost Paczkomaty Ekonomiczne
price
(numeric, zawsze zwracany) - Cena za opcje.
- Zwracany obiekt
notice
code
(string, zawsze zwracany) - Kod uwagi.messages
(array[string
], zawsze zwracany) - Informacje dodatkowe umieszczone w tablicy.
URI
Headers
Content-Type: application/json
Body
{
"packages": [
{
"product_id": 1,
"weight": 11,
"length": 111.1,
"width": 111,
"height": 200,
"number_of_packages": 1,
"non_standard": true,
"insurance_value": 1000,
"cod_type_id": 1,
"cod_value": 1000,
"cod_bank_account_number": "52175000120000000032413366",
"description": "123",
"sender": {
"name": "Jan",
"surname": "Kto",
"street": "Kowalska",
"house_number": "12",
"post_code": "82-300",
"city": "Elbląg",
"country_id": 1
},
"receiver": {
"name": "Jan",
"surname": "Kto",
"street": "Kowalska",
"house_number": "12",
"post_code": "82-300",
"city": "Elbląg",
"country_id": 1
}
}
]
}
200
Headers
Content-Type: application/json
Body
{
"offers": [
{
"courier_id": 3,
"price": 31,
"currency": "PLN",
"options": [
{
"name": "direct_delivery_only",
"price": 30
},
{
"name": "delivery_until_12_00",
"price": 30
},
{
"name": "delivery_on_saturday",
"price": 30
},
{
"name": "without_waybill",
"price": 4
},
{
"name": null,
"price": 0
},
{
"name": "delivery_sms_advice_note",
"price": 2
},
{
"name": "delivery_email_advice_note",
"price": 2
}
]
},
{
"courier_id": 4,
"price": 34.3,
"currency": "PLN",
"options": [
{
"name": "delivery_sms_advice_note",
"price": 0.5
},
{
"name": "delivery_until_12_00",
"price": 10
},
{
"name": "delivery_on_saturday",
"price": 25
},
{
"name": "express_delivery",
"price": 2
}
]
},
{
"courier_id": 5,
"price": 71,
"currency": "PLN",
"options": [
{
"name": "delivery_sms_advice_note",
"price": 0.5
},
{
"name": "pre_delivery_information",
"price": 10
},
{
"name": "delivery_between_18_00_and_22_00",
"price": 20
},
{
"name": "delivery_until_9_00",
"price": 170
},
{
"name": "delivery_until_12_00",
"price": 95
},
{
"name": "delivery_on_saturday",
"price": 30
}
]
},
{
"courier_id": 7,
"price": 170,
"currency": "PLN",
"options": [
{
"name": "delivery_phone_advice_note",
"price": 10
},
{
"name": "delivery_sms_advice_note",
"price": 2
},
{
"name": "without_waybill",
"price": 4
}
]
},
{
"courier_id": 10,
"price": 23.4,
"currency": "PLN",
"options": [
{
"name": "without_waybill",
"price": 4
}
]
},
{
"courier_id": 11,
"price": 33.3,
"currency": "PLN",
"options": [
{
"name": "delivery_phone_advice_note",
"price": 3
},
{
"name": "email_confirmation_of_delivery",
"price": 2
}
]
},
{
"courier_id": 12,
"price": 37.5,
"currency": "PLN",
"options": [
{
"name": "delivery_phone_advice_note",
"price": 2
},
{
"name": "delivery_sms_advice_note",
"price": 2
},
{
"name": "delivery_until_12_00",
"price": 40
}
]
}
],
"best_offer": [
{
"courier_id": 10,
"price": 23.4,
"currency": "PLN",
"options": [
{
"name": "without_waybill",
"price": 4
}
]
}
]
}
401
Headers
Content-Type: application/json
Body
{
"message": "Podany dane dostępowe są nieprawidłowe.",
"error_code": "AuthenticationFailed",
"status_code": 401
}
400
Headers
Content-Type: application/json
Body
{
"errors": {
"nazwa_pola": [
"Opis błędu."
]
},
"error_code": "InvalidInput",
"status_code": 400
}
City ¶
Reprezentacja zasobu City - miasto.
SzukajPOST/city/search
Wyszukaj miasto dla podanego ID kraju oraz kodu pocztowego.
- Przyjmowane parametry
country_id
(integer, wymagany, występuje w zasobie GET /order/resources/countries) - ID kraju.post_code
(string, wymagany) - Kod pocztowy.
- Zwracane parametry
city
(string, opcjonalny) - Miasto.
URI
Headers
Content-Type: application/json
Body
{
"country_id": 13,
"post_code": "14055"
}
200
Headers
Content-Type: application/json
Body
{
"city": "Berlin"
}
400
Headers
Content-Type: application/json
Body
{
"errors": {
"email": [
"Opis błędu",
],
"password": [
"Opis błędu.",
]
},
"error_code": "InvalidInput",
"status_code": 400
}
404
Headers
Content-Type: application/json
Body
{
"message": "Nie znaleziono.",
"error_code": "NotFound",
"status_code": 404
}
Pop ¶
Reprezentacja zasobu Pop - paczkomat.
SzukajPOST/pop/search
Wyszukaj paczkomat.
- Przyjmowane parametry
city
(integer, opcjonalny) - Fraza miasta do szukania.code
(string, opcjonalny) - Kod paczkomatu.
- Zwracane parametry
chosen
(array[pop
], zawsze zwracany) - Tablica z wybranymi paczkomatami użytkownika.found
(array[pop
], zawsze zwracany) - Tablica ze znalezionymi paczkomatami.other
(array[pop
], zawsze zwracany) - Tablica z pozostałymi paczkomatami.
- Zwracany obiekt
pop
code
(string, zawsze zwracany) - Kod.country_code
(string, zawsze zwracany) - Kod kraju.city
(string, zawsze zwracany) - Miasto.street
(string, zawsze zwracany) - Ulica.house_number
(string, opcjonalny) - Numer domu.province
(string, zawsze zwracany) - Województwo.post_code
(string, zawsze zwracany) - Kod pocztowy.description
(string, opcjonalny) - Dodatkowy opis.
URI
Headers
Content-Type: application/json
Body
{
"code": "XYZ"
}
200
Headers
Content-Type: application/json
Body
{
"chosen": {
"code": "ELB01A",
"country_code": "PL",
"city": "Elbląg",
"province": "warmińsko-mazurskie",
"street": "płk. Stanisława Dąbka",
"house_number": "74",
"post_code": "82-300",
"description": "Stacja paliw BP"
},
"found": [
{
"code": "ELB01A",
"country_code": "PL",
"city": "Elbląg",
"province": "warmińsko-mazurskie",
"street": "płk. Stanisława Dąbka",
"house_number": "74",
"post_code": "82-300",
"description": "Stacja paliw BP"
},
{
"code": "ELB161",
"country_code": "PL",
"city": "Elbląg",
"province": "warmińsko-mazurskie",
"street": "Odzieżowa",
"house_number": "12",
"post_code": "82-310",
"description": "Przy markecie Biedronka"
}
],
"other": [
{
"code": "ALL992",
"country_code": "PL",
"city": "Aleksandrów Łódzki",
"province": "łódzkie",
"street": "Piłsudskiego",
"house_number": "2/4",
"post_code": "95-070",
"description": "Przy markecie POLOmarket"
}
]
}
400
Headers
Content-Type: application/json
Body
{
"errors": {
"email": [
"Opis błędu",
],
"password": [
"Opis błędu.",
]
},
"error_code": "InvalidInput",
"status_code": 400
}
PP ¶
Reprezentacja zasobu PP - placówka Poczty Polskiej.
SzukajPOST/pp/search
Wyszukaj placówkę poczty.
- Przyjmowane parametry
city
(string, opcjonalny) - Fraza miasta do szukania.code
(integer, opcjonalny) - Kod placówki.
-
Zwracane parametry
chosen
(array[pp
], zawsze zwracany) - Tablica z wybranymi placówkami użytkownika.found
(array[pp
], zawsze zwracany) - Tablica ze znalezionymi placówkami.other
(array[pp
], zawsze zwracany) - Tablica z pozostałymi placówkami.
-
Zwracany obiekt
pp
display_name
(string, zawsze zwracany) - Nazwa wyświetlana, np. “Elbląg - Plac Dworcowy 2 (UP238538)”.code
(string, zawsze zwracany) - kod Placówki, np. “238538”.name_prefix
(string, zawsze zwracany) - prefiks nazwy, np. “UP”.name
(string, zawsze zwracany) - nazwa placówki, np. “Elbląg 2”.province
(string, zawsze zwracany) - województwo, np. “warmińsko-mazurskie”.district
(string, zawsze zwracany) - gmina, np. “Elbląg”.place
(string, zawsze zwracany) - miejsce, np. “Elbląg”.post_code
(string, zawsze zwracany) - kod pocztowy, np. “82310”.city
(string, zawsze zwracany) - miasto, np. “Elbląg”.street
(string, zawsze zwracany) - ulica, np. “Plac Dworcowy”.house_number
(string, zawsze zwracany) - numer domu, np. “2”.print_name
(string, zawsze zwracany) - nazwa do wydruku, np. “UP Elbląg 2”.branch_network
(string, zawsze zwracany) - sieć placówek, np. “POCZTAPOLSKA”.support_sms_notification
(boolean, zawsze zwracany) - czy obsługuje usługę “Powiadomienie SMS”, np. “true”.support_eprzesylka
(boolean, zawsze zwracany) - czy obsługuje usługę ePrzesylka, np. “true”.support_przesylkabiznesowaplus
(boolean, zawsze zwracany) - czy obsługuje usługę “przesylkabiznesowaplus”, np. “true”.support_przesylkabiznesowa
(boolean, zawsze zwracany) - czy obsługuje usługę przesylkabiznesowa, np. “true”.
URI
Headers
Content-Type: application/json
Body
{
"code": "238538"
}
200
Headers
Content-Type: application/json
Body
{
"chosen": {
"id": 6976,
"display_name": "Elbląg - Plac Dworcowy 2 (UP238538)",
"code": "238538",
"name_prefix": "UP",
"name": "Elbląg 2",
"province": "warmińsko-mazurskie",
"district": "Elbląg",
"place": "Elbląg",
"post_code": "82310",
"city": "Elbląg",
"street": "Plac Dworcowy",
"house_number": "2",
"print_name": "UP Elbląg 2",
"branch_network": "POCZTAPOLSKA",
"support_sms_notification": 0,
"support_eprzesylka": 1,
"support_przesylkabiznesowaplus": 1,
"support_przesylkabiznesowa": 1
},
"found": [
{
"id": 7158,
"display_name": "Elbląg - 1 Maja 40/10 (Sklep Żabka, ZPO916661)",
"code": "916661",
"name_prefix": "ZPO",
"name": "Sklep Żabka",
"province": "warmińsko-mazurskie",
"district": "Elbląg",
"place": "Elbląg",
"post_code": "82300",
"city": "Elbląg",
"street": "1 Maja",
"house_number": "40",
"print_name": "Sklep Żabka",
"branch_network": null,
"support_sms_notification": 1,
"support_eprzesylka": 0,
"support_przesylkabiznesowaplus": 1,
"support_przesylkabiznesowa": 1
},
{
"id": 6908,
"display_name": "Elbląg - 1 Maja 44 (Kiosk/Salonik RUCH, ZPO957943)",
"code": "957943",
"name_prefix": "ZPO",
"name": "Kiosk/Salonik RUCH",
"province": "warmińsko-mazurskie",
"district": "Elbląg",
"place": "Elbląg",
"post_code": "82300",
"city": "Elbląg",
"street": "1 Maja",
"house_number": "44",
"print_name": "Kiosk/Salonik RUCH",
"branch_network": null,
"support_sms_notification": 1,
"support_eprzesylka": 0,
"support_przesylkabiznesowaplus": 1,
"support_przesylkabiznesowa": 1
}
],
"other": [
{
"id": 7122,
"display_name": "Elbląg - 12 Lutego 25 (Sklep Żabka, ZPO916528)",
"code": "916528",
"name_prefix": "ZPO",
"name": "Sklep Żabka",
"province": "warmińsko-mazurskie",
"district": "Elbląg",
"place": "Elbląg",
"post_code": "82300",
"city": "Elbląg",
"street": "12 Lutego",
"house_number": "25",
"print_name": "Sklep Żabka",
"branch_network": null,
"support_sms_notification": 1,
"support_eprzesylka": 0,
"support_przesylkabiznesowaplus": 1,
"support_przesylkabiznesowa": 1
}
]
}
Ruch ¶
Reprezentacja zasobu Ruch - Punkty RUCHu (kurier: Paczka w Ruchu).
SzukajPOST/ruch/search
Wyszukaj Punkt RUCHu.
- Przyjmowane parametry
city
(string, opcjonalny) - Fraza miasta do szukania.code
(string, opcjonalny) - Kod Punktu RUCHu.
-
Zwracane parametry
chosen
(array[ruch
], zawsze zwracany) - Tablica z wybranymi Punktami RUCHu użytkownika.found
(array[ruch
], zawsze zwracany) - Tablica ze znalezionymi Punktami RUCHu na podstawie wpisanej frazy.other
(array[ruch
], zawsze zwracany) - Tablica z pozostałymi Punktami RUCHu.
-
Zwracany obiekt
ruch
display_name
(string, zawsze zwracany) - Nazwa wyświetlana, np. “Warszawa, Borowej Góry 2”.code
(string, zawsze zwracany) - kod Punktu RUCHu, np. “WS-492393-25-18”.street_name
(string, zawsze zwracany) - prefiks nazwy, np. “BOROWEJ GÓRY 2”.city
(string, zawsze zwracany) - miejscowość Punktu, np. “Warszawa”.district
(string, zawsze zwracany) - gmina Punktu, np. “Warszawa”.longitude
(numeric, zawsze zwracany) - długość geograficzna, np. “20.92”.latitude
(numeric, zawsze zwracany) - szerokość geograficzna, np. “52.23”.province
(string, zawsze zwracany) - województwo, np. “Mazowieckie”.cash_on_delivery
(boolean, zawsze zwracany) - miasto, np. “Elbląg”.opening_hours
(string, zawsze zwracany) - godziny otwarcia, np. “Pn-Pt:06:00-20:00, So:06:00-18:00, Nd: nieczynne”.location
(string, zawsze zwracany) - opis lokalizacji punktu, np. “Kiosk z wejściem, znajdujący się na ul. Powstańców Wielkopolskich, przy skrzyżowaniu ulic Powstańców Wielkopolskich z Wyszyńskiego. Obok znajduje się kwiaciarnia.”.psd
(string, zawsze zwracany) - nr PDS (brak przykładu).available
(boolean, zawsze zwracany) - czy placówka jest dostępna, np. “true”.point_type
(string, zawsze zwracany) - Rodzaj Punktu/Kiosku (własny - PSD, partnerski – PSP)
URI
Headers
Content-Type: application/json
Body
{
"code": "WS-492393-25-18"
}
200
Headers
Content-Type: application/json
Body
{
"chosen": {
"display_name": "Bełżec, Czarnieckiego 24",
"code": "LB-439171-28-31",
"street_name": "CZARNIECKIEGO 24",
"city": "Bełżec",
"district": "Bełżec",
"longitude": 23.25,
"latitude": 50.23,
"province": "Lubelskie",
"cash_on_delivery": 0,
"opening_hours": "Pn-Pt:07:00-20:00, So:07:00-20:00, Nd:14:00-20:00",
"location": "Sklep spożywczo-przemysłowy "Nasz sklep" znajdujący się przy drodze w kierunku Narola ",
"psd": null,
"available": 1,
"point_type": "PSP"
},
"found": [
{
"display_name": "Warszawa, Borowej Góry 2",
"code": "WS-492393-25-18",
"street_name": "BOROWEJ GÓRY 2",
"city": "Warszawa",
"district": "Warszawa",
"longitude": 20.92,
"latitude": 52.23,
"province": "Mazowieckie",
"cash_on_delivery": 1,
"opening_hours": "Pn-Pt:06:00-20:00, So:06:00-18:00, Nd: nieczynne",
"location": null,
"psd": null,
"available": 1,
"point_type": "PSD"
}
],
"other": [
{
"display_name": "Bydgoszcz, Powstańców Wielkopolskich 53",
"code": "BD-106088-31-09",
"street_name": "POWSTAŃCÓW WIELKOPOLSKICH 53",
"city": "Bydgoszcz",
"district": "Bydgoszcz",
"longitude": 18.04,
"latitude": 53.13,
"province": "Kujawsko-Pomorskie",
"cash_on_delivery": 1,
"opening_hours": "Pn-Pt:05:30-20:00, So:06:30-14:00, Nd:08:00-14:00",
"location": "Kiosk z wejściem, znajdujący się na ul. Powstańców Wielkopolskich, przy skrzyżowaniu ulic Powstańców Wielkopolskich z Wyszyńskiego. Obok znajduje się kwiaciarnia.",
"psd": null,
"available": 1,
"point_type": "PSD"
}
]
}
400
Headers
Content-Type: application/json
Body
{
"errors": {
"email": [
"Opis błędu",
],
"password": [
"Opis błędu.",
]
},
"error_code": "InvalidInput",
"status_code": 400
}
File ¶
Reprezentacja zasobu File - plik.
PrześlijPOST/upload
Prześlij plik na serwer Tanieprzesylkikurierskie.pl.
- Przyjmowane parametry
token
(string, wymagany) - Token.file
(file, wymagany) - Plik do przesłania na serwer Tanieprzesylkikurierskie.pl.
- Zwracane parametry
file_id
(string, zawsze zwracany) - Identyfikator przesłanego pliku.
URI
Headers
Content-Type: application/json
Body
{
"file" : (binary)
}
200
Headers
Content-Type: application/json
Body
{
"file_id": "8e8215a8161c01f4e297c1c41e195528bt5ozTxWOsGTq2Se4wQCCcrznu1225GJ"
}
Configuration ¶
Reprezentacja zasobu Configuration - Konfiguracja.
PobierzGET/configuration
Pobierz konfiguracje.
URI
200
Headers
Content-Type: application/json
Body
{
"messages": {
"title": "Test wiadomości",
"content": "To jest test wiadomości wyświetlanej na stronie."
}
}
Zasoby ¶
Reprezentacja zasobu Resources - Zasoby.
PobierzGET/user/orders/resources
Pobierz listę dostępnych produktów, kurierów, krajów oraz opcji. Metoda ta łączy odpowiedź z GET /order/resources/products
, GET /order/resources/couriers
,
GET /order/resources/countries
oraz GET /order/resources/options
.
URI
Headers
Content-Type: application/json
200
Headers
Content-Type: application/json
Body
{
"products": {
"1": "envelope",
"2": "parcel",
"3": "pallet"
},
"couriers": {
"1": "kex",
"2": "gls",
"3": "dpd",
"4": "inpost",
"5": "dhl",
"6": "tba",
"7": "etl"
},
"countries": {
"1": "pl",
"2": "at",
"3": "be",
"4": "bg",
"5": "cz",
"6": "dk",
"7": "ee",
"8": "fi",
"9": "fr",
"10": "es",
"11": "nl",
"12": "ie",
"13": "lu",
"14": "lt",
"15": "lv",
"16": "de",
"17": "pt",
"18": "ro",
"19": "sk",
"20": "si",
"21": "se",
"22": "hu",
"23": "gb",
"24": "it",
"25": "hr",
"26": "gr"
},
"options": {
"direct_delivery_only": [
1,
3
],
"delivery_phone_advice_note": [
1
],
"delivery_sms_advice_note": [
1,
4,
5
],
"delivery_email_advice_note": [
1
],
"email_confirmation_of_delivery": [
1,
6
],
"sms_confirmation_of_delivery": [
1,
6
],
"pre_delivery_information": [
5
],
"check_contents_before_accepting": [
1
],
"without_waybill": [
1,
3,
6
],
"delivery_until_9_00": [
5
],
"delivery_until_12_00": [
3,
4,
5
],
"delivery_between_18_00_and_22_00": [
5
],
"delivery_on_saturday": [
3,
4,
5
],
"express_delivery": [
1,
4
],
"return_documents": [
3,
4,
5
]
}
}
ProduktyGET/user/orders/resources/products
Pobierz listę obsługiwanych produktów.
URI
Headers
Content-Type: application/json
200
Headers
Content-Type: application/json
Body
{
"1": "envelope",
"2": "parcel",
"3": "pallet"
}
KurierzyGET/user/orders/resources/couriers
Pobierz listę obsługiwanych kurierów.
URI
Headers
Content-Type: application/json
200
Headers
Content-Type: application/json
Body
{
"1": "kex",
"2": "gls",
"3": "dpd",
"4": "inpost",
"5": "dhl",
"6": "tba",
"7": "etl",
"8": "inpost_cb",
"9": "inpost_pop",
"10": "delta",
"11": "patron",
"12": "fedex",
"12": "geodis",
"14": "ups",
"16": "poczta24",
"17": "poczta48",
"18": "rohlig_suus",
"19": "paczka_w_ruchu",
"20": "ambro_express",
}
KrajeGET/user/orders/resources/countries
Pobierz listę obsługiwanych krajów.
URI
Headers
Content-Type: application/json
200
Headers
Content-Type: application/json
Body
{
"1": "pl",
"2": "at",
"3": "be",
"4": "bg",
"5": "cz",
"6": "dk",
"7": "ee",
"8": "fi",
"9": "fr",
"10": "es",
"11": "nl",
"12": "ie",
"13": "lu",
"14": "lt",
"15": "lv",
"16": "de",
"17": "pt",
"18": "ro",
"19": "sk",
"20": "si",
"21": "se",
"22": "hu",
"23": "gb",
"24": "it"
}
OpcjeGET/user/orders/resources/options
Pobierz listę obsługiwanych usług dodatkowych (opcji). Lista zawiera zbiór identyfikatorów usług dodatkowych. Każdy identyfikator usługi jest kluczem dla tablicy identyfikatorów kurierów, gdzie opcja jest dostępna.
- Dostępne opcje
direct_delivery_only
- Dostawa do rąk własnychdelivery_phone_advice_note
- Awizacja telefoniczna dostawydelivery_sms_advice_note
- Awizacja dostawy SMSdelivery_email_advice_note
- Awizacja dostawy e-mailemail_confirmation_of_delivery
- Potwierdzenie dostarczenia e-mailsms_confirmation_of_delivery
- Potwierdzenie dostarczenia SMSpre_delivery_information
- Informacja przed doręczeniem (PDI)check_contents_before_accepting
- Sprawdzenie zawartości przesyłki przed odbioremwithout_waybill
- Nie mam możliwości wydrukowania dokumentu przewozowegono_pickup
- Nadanie w oddzialewith_pickup
- Odbiór przez kurieradelivery_until_9_00
- Doręczenie do godz 9:00delivery_until_12_00
- Doręczenie do godz 12:00delivery_between_18_00_and_22_00
- Doręczenie w godzinach 18:00 - 22:00delivery_on_saturday
- Doręczenie przesyłki w sobotęexpress_delivery
- Gwarantowany termin dostawy na następny dzień roboczyhandle_with_care
- Uwaga - ostrożnie
URI
Headers
Content-Type: application/json
200
Headers
Content-Type: application/json
Body
{
"direct_delivery_only": [
1,
3
],
"delivery_phone_advice_note": [
1
],
"delivery_sms_advice_note": [
1,
4,
5
],
"delivery_email_advice_note": [
1
],
"email_confirmation_of_delivery": [
1,
6
],
"sms_confirmation_of_delivery": [
1,
6
],
"pre_delivery_information": [
5
],
"check_contents_before_accepting": [
1
],
"without_waybill": [
1,
3,
6
],
"no_pickup": [
3
],
"delivery_until_9_00": [
5
],
"delivery_until_12_00": [
3,
4,
5
],
"delivery_between_18_00_and_22_00": [
5
],
"delivery_on_saturday": [
3,
4,
5
],
"express_delivery": [
1,
4
],
"return_documents": [
3,
4,
5
]
}