Generating active code

The function https://api.paczkomaty.pl/?do=revloggenerateactivecode is used to generate one active return code, with which you can send a parcel at the Parcel Locker.

For proper function, use Content-Type:application/x-www-form-urlencoded

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	Validation
`rma`	Unique code for example order.	`<rma>123</rma>`	Required
`packType`	Parcel size	`<packType>A</packType>`	Required
`expirationDate`	Expiration date of the code	`<expirationDate>2022-10-10T11:00:00</expirationDate>`	Required `yyyy-mm-ddThh:mm:ss`
`senderPhone`	Phone number of the sender of the return	`<senderPhone>333222111</senderPhone>`	Required Only 9 digits
`senderEmail`	Email address of the sender of the return	`<senderEmail>zwracajacy@inpost.pl</senderEmail>`	Required
`returnDescription1`	Additional information shown on label	`<returnDescription1>Zamówienie:312</returnDescription1>`	Not required

Available parcel sizes for the parameter packType:

Template name	Dimensions	Weight
`A`	8 x 38 x 64 cm	do 25 kg
`B`	19 x 38 x 64 cm	do 25 kg
`C`	41 x 38 x 64 cm	do 25 kg

Parameters in the address section - address data of the parcel delivery location.

The parameters are required if the address section is passed in the query.

If the address section is not passed, the address from the https://manager.paczkomaty.pl/ system will be assigned to the return code.

Parameter	Description	Example	Validation
`companyName`	Company name	`<companyName>InPost</companyName>`	Not required
`name`	First name or Company name	`<name>InPost</name>`	Required
`surName`	Last name or Company name	`<surName>Paczkomat</surName>`	Required
`email`	Recipient's email address	`<email>test@inpost.pl</email>`	Not required
`phoneNum`	Recipient's phone number	`<phoneNum>321321321</phoneNum>`	Not required
`street`	Street	`<street>Cybernetyki</street>`	Required
`buldingNo`	Building number	`<buldingNo>10</buldingNo>`	Required
`flatNo`	Flat number	`<flatNo>4</flatNo>`	Required
`zipCode`	Zip code	`<zipCode>02-677</zipCode>`	Required `00-000`
`town`	Town	`<town>Warszawa</town>`	Required
`province`	Province	`<province>Mazowieckie</province>`	Not required

Parameters in the section return- Response from the API:

Parameter	Description	Example
`code`	Sending code	`<code>6397348744</code>`
`expirationDate`	Expiration date of the code	`<expirationDate>2022-10-10T11:00:00+02:00</expirationDate>`
`packType`	Package size	`<packType>A</packType>`
`active`	Return code status (Only an active return code can be used at Parcel Locker to send a package)	`<active>true</active>`
`rma`	Unique code e.g. order	`<rma>123</rma>`
`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>odbiorca@inpost.pl</email>` `<flatNo>4</flatNo>` `<name>InPost</name>` `<phoneNum>321321321</phoneNum>` `<province>Mazowieckie</province>` `<street>Cybernetyki</street>` `<surName>test</surName>` `<town>Warszawa</town>` `<zipCode>02-677</zipCode>` `</targetAddress>`
`uuid`	-	`<uuid>3863d4b3-eacf-43e4-a9aa-aa12fa3c2f7e</uuid>`
`labelAttached`	-	`<labelAttached>false</labelAttached>`

Request:

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

email=test@inpost.pl&password=Password123!@&content=
<paczkomaty>
<rma>4321</rma>
<packType>A</packType>
<expirationDate>2022-10-10T11:00:00</expirationDate>
<senderPhone>333222111</senderPhone>
<senderEmail>szybkie.zwroty@inpost.pl</senderEmail>
<returnDescription1>Zamówienie:312</returnDescription1>
<address>
<name>InPost</name>
<surName>Paczkomat</surName>
<email>test@inpost.pl</email>
<phoneNum>321321321</phoneNum>
<street>Cybernetyki</street>
<buldingNo>10</buldingNo>
<flatNo>4</flatNo>
<zipCode>02-677</zipCode>
<town>Warszawa</town>
<province>Mazowieckie</province> 
</address>
</paczkomaty>

Response:

<?xml version="1.0" encoding="UTF-8"?>
<paczkomaty>
    <return>
        <code>1240616893</code>
        <expirationDate>2022-10-10T11:00:00+02:00</expirationDate>
        <packType>A</packType>
        <active>true</active>
        <rma>4321</rma>
        <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>
        <uuid>ae1e2449-30b2-483c-84dd-884f3438f65b</uuid>
        <labelAttached>false</labelAttached>
    </return>
</paczkomaty>