Report

The https://api.paczkomaty.pl/?do=revloggetreportfunction allows you to generate a report that will return active codes and used codes along with the shipment status.

The data in the report is returned based on the creation date of the return code.

Parameters

Parameters to the function should be passed via the POST method:

Parameter	Description	Example	Validation
`email`	Login to your InPost account(manager.paczkomaty.pl)	`email=test@inpost.pl`	Required
`password`	Login to your InPost account (manager.paczkomaty.pl)	`password=Password123!@`	Required
`content`	Structured xml code	`content=`	Required

Parameters in the paczkomat section:

Parameter	Description	Example
`used`	Has the return code been used?	`<used>true</used>`
`active`	The status of the return code (Only an active return code can be used at Parcel Locker to send a parcel)	`<active>true</active>`
`packCode`	24 character shipment number	`<packCode>670781097283000026014876</packCode>`
`code`	Return code	`<code>6397348744</code>`
`rma`	Unique code for example order.	`<rma>123</rma>`

Parameters in the dateRange section:

Parameter	Description	Example
`startDate`	Initial Range Date	`<startDate>2022-01-10</startDate>`
`endDate`	End Range Date	`<endDate>2022-07-20</endDate>`

Parameters in the paging section:

Parameter	Description	Example
`limit`	Specifies the number of results displayed on the page. Maximum of 1000.	`<limit>1000</limit>`
`offset`	Used for paging, if a client has 2000 return codes in a given time interval and intends to download them all, he must first set `offset=0` (for `limit=1000`) to download the first 1000 return codes. Then, to download the next ones it sets `offset=1000` to skip the first thousand codes.	`<offset>1</offset>`

Parameters in the section return- Response from the API:

Parameter	Description	Example
`operatorEmail`	Email address of the account on which the return code was generated	`<operatorEmail>test@inpost.pl</operatorEmail>`
`reverseReturnPackCode`	Tracking number of the shipment	`<reverseReturnPackCode>600000627283000026230130</reverseReturnPackCode>`
`code`	Sending code	`<code>9142375578</code>`
`rma`	Unique code e.g. order	`<rma>321</rma>`
`active`	Return code status (Only an active return code can be used at Parcel Locker to send a package)	`<active>true</active>`
`usedDate`	Date the return code was used	`<usedDate>2022-10-01T07:30:40.865+02:00</usedDate>`
`creationDate`	Date the return code was created	`<creationDate>2022-09-30T14:07:45.468+02:00</creationDate>`
`senderPhone`	Phone number of the sender of the return	`<senderPhone>333222111</senderPhone>`
`senderEmail`	Email address of the sender of the return	`<senderEmail>szybkie.zwroty@inpost.pl</senderEmail>`
`reverseReturnPackStatus`	Current status of the package	`<reverseReturnPackStatus>Sent</reverseReturnPackStatus>`
`reverseReturnPackStatusDate`	Date of sending the current status of the package	`<reverseReturnPackStatusDate>2022-10-01T17:51:17.232+02:00</reverseReturnPackStatusDate>`
`labelAttached`	-	`<labelAttached>false</labelAttached>`
`returnDescription1`	Additional information visible on the label	`<returnDescription1>Zamówienie:312</returnDescription1>`
`targetAddress`	Address data of the parcel delivery location	`<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`	Expiration date of the code	`<expirationDate>2022-10-10T11:00:00+02:00</expirationDate>`
`packSize`	Package size	`<packSize>A</packSize>`
`packType`	Parcel size	`<packType>A</packType>`
`valid`	Code status	`<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>