Aktywacja nieaktywnego kodu

Funkcja https://api.paczkomaty.pl/?do=revlogactivatecode służy do aktywacji wygenerowanego, nieaktywnego kodu za pomocą funkcji Generowanie zestawu nieaktywnych kodów.

 

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 paczkomat

Nazwa Parametru

Opis

Przykład

Walidacja

code

Kod zwrotu do aktywacji

<code>2991513940</code>

Wymagany

rma

Unikalny kod np. zamówienia

<rma>123</rma>

Niewymagany

packType

Gabaryt paczki

<packType>A</packType>

Wymagany

expirationDate

Data ważności kodu

<expirationDate>2022-10-10T11:00:00</expirationDate>

Wymagany
yyyy-mm-ddThh:mm:ss

senderPhone

Numer telefonu nadawcy zwrotu

 <senderPhone>333222111</senderPhone>

Wymagany
Tylko 9 cyfr

senderEmail

Adres email nadawcy zwrotu

<senderEmail>szybkie.zwroty@inpost.pl</senderEmail>

Wymagany

returnDescription1

 

Informacja dodatkowa widoczna na etykiecie w formie:

  • Tekst - standardowo

  • QRcode - usługa dodatkowa

    • Maksymalnie 20 znaków (litery, cyfry, znaki specjalne)

  • Barcode - usługa dodatkowa

    • Maksymalnie 20 znaków (litery, cyfry, znaki specjalne)

    • Kodowanie EAN-128

Więcej informacji poniżej

<returnDescription1>Zamówienie:312</returnDescription1>

Niewymagany

Umożliwiamy konwersję tekstu wpisanego w polu returnDescription1 na QRkod lub Barkod. Skorzystanie z usługi wydruku QRkodu lub Barkodu na etykiecie wymaga nadania odpowiednich uprawnień. W celu uruchomienia usługi wymagany jest kontakt z przedstawicielem handlowym.

 

Dostępne gabaryty paczki dla parametru packType:

Gabaryt paczki

Wymiary

Waga

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

 

Parametry w sekcji address - dane adresowe miejsca doręczenia paczki.

Wymagalność parametrów następuje w przypadku przekazania sekcji address w zapytaniu.

Jeśli sekcja address niezostanie przekazana to do kodu zwrotu zostanie przypisany adres z systemu https://manager.paczkomaty.pl/.

Nazwa Parametru

Opis

Przykład

Walidacja

companyName

Nazwa firmy

<companyName>InPost</companyName>

Niewymagany

name

Imię lub Nazwa firmy

<name>InPost</name>

Wymagany

surName

Nazwisko lub nazwa firmy

<surName>Paczkomat</surName>

Wymagany

email

adres email odbiorcy

<email>test@inpost.pl</email>

Niewymagany

phoneNum

Numer telefonu odbiorcy

<phoneNum>321321321</phoneNum>

Niewymagany

street

Ulica

<street>Cybernetyki</street>

Wymagany

buldingNo

Numer Budynku

<buldingNo>10</buldingNo>

Wymagany

flatNo

Numer lokalu

<flatNo>4</flatNo>

Wymagany

zipCode

Kod pocztowy

<zipCode>02-677</zipCode>

Wymagany
00-000

town

Miasto

<town>Warszawa</town>

Wymagany

province

Województwo

<province>Mazowieckie</province> 

Niewymagany

 

Parametry w sekcji return - odpowiedź z API:

Nazwa Parametru

Opis

Przykład

code

Kod nadania 

<code>6397348744</code>

expirationDate

Data ważności kodu

<expirationDate>2022-10-10T11:00:00+02:00</expirationDate>

packType

Gabaryt przesyłki

<packType>A</packType>

active

Status kodu zwrotu (W Paczkomat do nadania paczki można użyć tylko aktywnego kodu zwrotu)

<active>true</active>

rma

Unikalny kod np. zamówienia

<rma>123</rma>

returnDescription1

Informacja dodatkowa widoczna na etykiecie

<returnDescription1>Zamówienie:312</returnDescription1>

targetAddress

Dane adresowe miejsca doręczenia paczki

        <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=revlogactivatecode HTTP/1.1 Host: api.paczkomaty.pl Content-Type: application/x-www-form-urlencoded   email=test@inpost.pl&password=Password123!@&content= <paczkomaty> <code>7300684238</code> <rma>54321</rma> <packType>A</packType> <expirationDate>2022-11-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>7300684238</code> <expirationDate>2022-11-10T11:00:00+01:00</expirationDate> <packType>A</packType> <active>true</active> <rma>54321</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>bd09362a-46d6-48c0-b463-76316d3cbaf1</uuid> <labelAttached>false</labelAttached> </return> </paczkomaty>