Raport

Funkcja https://api.paczkomaty.pl/?do=revloggetreport daje możliwość wygenerowania raportu który zwróci aktywne kody oraz wykorzystane kody wraz ze statusem przesyłki.

Dane w raporcie zwracane są na podstawie daty utworzenia kodu zwrotu.

Parametry

Parametry do funkcji powinny być przekazane metodą POST:

Nazwa parametru	Opis	Przykład	Walidacja
`email`	login do konta InPost (manager.paczkomaty.pl)	`email=test@inpost.pl`	Wymagany
`password`	hasło do konta InPost (manager.paczkomaty.pl)	`password=Password123!@`	Wymagany
`content`	Kod xml o określonej strukturze	`content=`	Wymagany

Parametry w sekcji paczkomaty:

Nazwa Parametru	Opis	Przykład
`used`	Czy kod zwrotu został użyty	`<used>true</used>`
`active`	Status kodu zwrotu (W Paczkomat do nadania paczki można użyć tylko aktywnego kodu zwrotu)	`<active>true</active>`
`packCode`	24 znakowy numer przesyłki	`<packCode>670781097283000026014876</packCode>`
`code`	Kod zwrotu	`<code>6397348744</code>`
`rma`	Unikalny kod np. zamówienia	`<rma>123</rma>`

Parametry w sekcji dateRange:

Nazwa Parametru	Opis	Przykład
`startDate`	Początkowa data zakresu.	`<startDate>2022-01-10</startDate>`
`endDate`	Końcowa data zakresu.	`<endDate>2022-07-20</endDate>`

Parametry w sekcji paging:

Nazwa Parametru	Opis	Przykład
`limit`	Określa liczbę wyników wyświetlanych na stronie. Maksymalnie 1000.	`<limit>1000</limit>`
`offset`	Służy do stronicowania, jeśli klient ma 2000 kodów zwrotu w danym przedziale czasowym i zamierza pobrać je wszystkie, musi najpierw ustawić `offset=0` (dla `limit=1000`), aby pobrać pierwsze 1000 kodów zwrotu. Następnie, aby pobrać kolejne ustawia `offset=1000`, aby pominąć pierwszy tysiąc kodów.	`<offset>1</offset>`

Parametry w sekcji return - odpowiedź z API:

Nazwa Parametru	Opis	Przykład
`operatorEmail`	Adres email konta na którym został wygenerowany kod zwrotu	`<operatorEmail>test@inpost.pl</operatorEmail>`
`reverseReturnPackCode`	Numer trackingowy przesyłki	`<reverseReturnPackCode>600000627283000026230130</reverseReturnPackCode>`
`code`	Kod nadania	`<code>9142375578</code>`
`rma`	Unikalny kod np. zamówienia	`<rma>321</rma>`
`active`	Status kodu zwrotu (W Paczkomat do nadania paczki można użyć tylko aktywnego kodu zwrotu)	`<active>true</active>`
`usedDate`	Data użyci kodu zwrotu	`<usedDate>2022-10-01T07:30:40.865+02:00</usedDate>`
`creationDate`	Data utworzenia kodu zwrotu	`<creationDate>2022-09-30T14:07:45.468+02:00</creationDate>`
`senderPhone`	Numer telefonu nadawcy zwrotu	`<senderPhone>333222111</senderPhone>`
`senderEmail`	Adres email nadawcy zwrotu	`<senderEmail>szybkie.zwroty@inpost.pl</senderEmail>`
`reverseReturnPackStatus`	Aktualny status paczki	`<reverseReturnPackStatus>Sent</reverseReturnPackStatus>`
`reverseReturnPackStatusDate`	Data nadania aktualnego statusu paczki	`<reverseReturnPackStatusDate>2022-10-01T17:51:17.232+02:00</reverseReturnPackStatusDate>`
`labelAttached`	-	`<labelAttached>false</labelAttached>`
`returnDescription1`	Informacja dodatkowa drukowana na etykiecie	`<returnDescription1>Zamówienie:312</returnDescription1>`
`targetAddress`	Dane adresowe miejsca doręczenia paczki	`<targetAddress>` `<buildingNo>10</buildingNo>` `<buldingNo>10</buldingNo>` `<email>test@inpost.pl</email>` `<flatNo>4</flatNo>` `<name>InPost</name>` `<phoneNum>321321321</phoneNum>` `<province>Mazowieckie</province>` `<street>Cybernetyki</street>` `<surName>Paczkomat</surName>` `<town>Warszawa</town>` `<zipCode>02-677</zipCode>` `</targetAddress>`
`expirationDate`	Data ważności kodu	`<expirationDate>2022-10-10T11:00:00+02:00</expirationDate>`
`packSize`	Rozmiar paczki	`<packSize>A</packSize>`
`packType`	Gabaryt paczki	`<packType>A</packType>`
`valid`	Status kodu	`<valid>true</valid>`

Request:

POST /?do=revloggetreport HTTP/1.1
Host: api.paczkomaty.pl
Content-Type: application/x-www-form-urlencoded

email=test@inpost.pl&password=Password123!@&content=
<paczkomaty>
<dateRange>
<startDate>2022-09-20</startDate>
<endDate>2022-10-20</endDate>
</dateRange>
<paging>
<limit>1</limit>
<offset>1</offset>
</paging>

Response:

<?xml version="1.0" encoding="UTF-8"?>
<paczkomaty>
    <return>
        <count>6</count>
        <result>
            <operatorEmail>test@inpost.pl</operatorEmail>
            <reverseReturnPackCode>600000627283000026230130</reverseReturnPackCode>
            <code>9142375578</code>
            <rma>321</rma>
            <active>true</active>
            <usedDate>2022-10-01T07:30:40.865+02:00</usedDate>
            <creationDate>2022-09-30T14:07:45.468+02:00</creationDate>
            <senderPhone>333222111</senderPhone>
            <senderEmail>szybkie.zwroty@inpost.pl</senderEmail>
            <reverseReturnPackStatus>Sent</reverseReturnPackStatus>
            <reverseReturnPackStatusDate>2022-10-01T17:51:17.232+02:00</reverseReturnPackStatusDate>
            <labelAttached>false</labelAttached>
            <returnDescription1>Zamówienie:312</returnDescription1>
            <targetAddress>
                <buildingNo>10</buildingNo>
                <buldingNo>10</buldingNo>
                <email>test@inpost.pl</email>
                <flatNo>4</flatNo>
                <name>InPost</name>
                <phoneNum>321321321</phoneNum>
                <province>Mazowieckie</province>
                <street>Cybernetyki</street>
                <surName>Paczkomat</surName>
                <town>Warszawa</town>
                <zipCode>02-677</zipCode>
            </targetAddress>
            <expirationDate>2022-10-10T11:00:00+02:00</expirationDate>
            <packSize>A</packSize>
            <packType>A</packType>
            <valid>true</valid>
        </result>
    </return>
</paczkomaty>