Przejdź do głównej treści
Odczyt pocztówek jest darmowy. Widzisz tylko pocztówki ze swojego konta i z trybu klucza API.

​
Pobierz jedną pocztówkę

Odpowiedź ma ten sam kształt co odpowiedź przy tworzeniu. Z czasem zmieniają się pola:
​
string
Etap realizacji pocztówki. Zobacz Statusy pocztówek.
​
string | null
Moment złożenia zamówienia, w formacie ISO 8601. null, dopóki pocztówka jest szkicem.
​
string | null
Moment nadania w formacie ISO 8601. null, dopóki status nie zmieni się na sent.
​
string
Ostatnia zmiana statusu.

​
Lista pocztówek

Zwraca pocztówki z trybu klucza, od najnowszych, po jednej stronie naraz. Tablica data zawiera pocztówki z tej strony.
​
integer
domyślnie:"1"
Numer strony, od 1. Strona za końcem listy zwraca pustą tablicę data.
​
integer
domyślnie:"50"
Liczba pocztówek na stronie, od 1 do 100. Większa wartość zwraca 422 Unprocessable Content.
​
string
Zwraca tylko pocztówki o tym statusie, np. draft, aby wyświetlić szkice. Nieznana wartość zwraca 422.
Obok data odpowiedź zawiera links z adresami stron first, last, prev i next oraz meta z polami current_page, last_page, per_page i total. Aby odczytać całą listę, pobieraj links.next, dopóki nie będzie null.

​
Kiedy kartka została nadana

Paperjoy nie wysyła webhooków. Aby śledzić wysyłkę, sprawdzaj otwarte pocztówki według harmonogramu:
  1. Zapisuj id każdej utworzonej pocztówki.
  2. Co kilka godzin pobieraj pocztówki, które nie mają jeszcze statusu sent ani rejected.
  3. Gdy status zmieni się na sent, zapisz sent_at i przestań sprawdzać tę pocztówkę.
Pocztówka zmienia status tylko kilka razy, więc sprawdzanie kilka razy dziennie w zupełności wystarczy.
Zamiast pobierać całą listę, pobieraj pojedyncze pocztówki po ID. To rozwiązanie pozostaje szybkie, nawet gdy historia rośnie.

​
W panelu

Strona Panel pokazuje te same pocztówki z ich statusem i pozwala filtrować je według statusu. Kliknij wiersz, aby zobaczyć podgląd kartki, identyfikator pocztówki i adres dostawy.
Panel Paperjoy z wykresem zamówionych i wysłanych pocztówek oraz tabelą pocztówek z odbiorcami i statusami.