1. Informacje o użytkowniku

Za pomocą GET /me pobierzesz podstawowe informacje o użytkowniku, którego token przesyłasz w requeście.


Przykładowy request:

 curl -X GET \
 ‘https://api.allegro.pl/me’ \
 -H ‘Accept: application/vnd.allegro.public.v1+json’\
 -H ‘Content-Type: application/vnd.allegro.public.v1+json’ 


Przykładowy response:

 {
    "id": "12345678",				     -- ID użytkownika
    "login": "test_account",			 -- login użytkownika
    "email": "test_account@allegro.pl",	 -- mail użytkownika
    "company": {
        "name": "Allegro.pl Sp. z o.o.", -- nazwa firmy
        "taxId": "123-123-12-12"		 -- numer NIP
    },
    "features": [                        -- cechy konta sprzedawcy
        "SUPER_SELLER"                   -- konto ma status Super Sprzedawcy
    ]
 }

2. Ocena sprzedaży

Jak pobrać informacje o ocenie sprzedaży

Skorzystaj w tym celu z GET /sale/user-ratings. W odpowiedzi otrzymasz oceny sprzedaży użytkownika, którego token przesyłasz w requeście. W żądaniu możesz użyć parametrów:

  • recommended - który przyjmuje wartość true lub false (oceny pozytywne lub negatywne). Jeżeli nie określisz tego parametru, domyślnie zwrócimy listę wszystkich ocen;
  • limit - w którym podajesz liczbę ocen, które mamy zwrócić. Domyślnie zwracamy 20 najnowszych ocen, a maksymalna wartość to 100;
  • offset - w którym określasz, od której oceny mamy zwrócić dane. Maksymalna wartość to 20000.


Przykładowy request:

 curl -X GET \
 ‘https://api.allegro.pl/sale/user-ratings’ \
 -H ‘Accept: application/vnd.allegro.public.v1+json’ \
 -H ‘Content-Type: application/vnd.allegro.public.v1+json’ 


Przykładowy response:

 {
    "ratings": [							            -- lista ocen
        {
            "id": "5f245afca39ce1004cb8fc37",			-- ID oceny
            "createdAt": "2021-07-30T19:55:08.555",		-- data utworzenia oceny
            "recommended": true,					    -- czy ocena jest pozytywna
            "buyer": {						            -- informacje o kupującym
                "id": "33811291",					    -- ID kupującego
                "login": "test_login"				    -- login kupującego
            },
            "comment": "Świetny kontakt, ekspresowa realizacja",    -- komentarz kupującego
            "rates": {						            -- oceny poszczególnych punktów
                "description": 5,					    -- zgodność z opisem
                "service": 5,						    -- obsługa kupującego
                "deliveryCost": 5					    -- koszty wysyłki
            },
            "order": {						            -- informacje o zamówieniu
                "id": "8b1664b2-c3bc-11ea-820a-db7a264e2a97",  -- ID zamówienia
                "offers": [						        -- oferty, które wchodzą w skład 
								                        zamówienia
                    {
                        "id": "8481327606",				-- ID oferty
                        "title": "oferta testowa",		-- tytuł oferty
                        "snapshot": 			 		-- ID zrzutu oferty w momencie 
								                        zakupu
"MjAyMC0wNy0xMVQyMToyMjozMS4yMjhaO2J1eWVyOzgxNDc5MTU2OTBhMjhmNmEzMGM5ZThjMDUzNmE2YTBhNTY1ZTAwMTY3YWI4NWQ3ODMzNWQ0NGM3ZDU4NjJmZjI%3D"
                    }
                ]
            },
            "removal": {						        -- informacje o prośbach o 
								                        usunięcie oceny
                "possibleTo": "2021-08-13T19:55:08.555"	-- data, do kiedy sprzedawca
								                        może wysłać prośbę o usunięcie
								                        oceny
            },
            "excludedFromAverageRates": false			-- czy dana ocena jest wyłączona
								                        z ogólnej średniej ocen
        }
    ]
 }

Jak dodać odpowiedź na ocenę

Skorzystaj w tym celu z PUT /sale/user-ratings/{ratingId}/answer. Jako ratingID przekaż ID konkretnej oceny sprzedaży - wartość pobierzesz za pomocą GET /sale/user-ratings.


Przykładowy request:

 curl -X PUT \ 
 'https://api.allegro.pl/sale/user-ratings/5f245afca39ce1004cb8fc37/answer' \
 -H 'Accept: application/vnd.allegro.public.v1+json' \
 -H 'Content-Type: application/vnd.allegro.public.v1+json' \
 -H 'Accept-Language: pl-PL'
 - d’{
  "message": "W tym przypadku jest to wina po stronie producenta - prosimy o 
   kontakt telefoniczny."  	           -- odpowiedź na ocenę (maksymalnie 500 znaków)
 }’


Przykładowy response:

 {
    "createdAt": "2021-08-02T08:46:35.790",
    "message": "W tym przypadku jest to wina po stronie producenta - prosimy kontakt telefoniczny."
 }

Jak wysłać prośbę o usunięcie oceny

Skorzystaj w tym celu z PUT /sale/user-ratings/{ratingId}/removal. Jako ratingID przekaż ID konkretnej oceny sprzedaży - zarówno tą wartość, jak i datę, do kiedy możesz wysłać prośbę o usunięcie oceny (pole possibleTo), otrzymasz w odpowiedzi dla GET /sale/user-ratings.


Przykładowy request:

 curl -X PUT \ 
 'https://api.allegro.pl/sale/user-ratings/5f245afca39ce1004cb8fc37/removal' \
 -H 'Accept: application/vnd.allegro.public.v1+json' \
 -H 'Content-Type: application/vnd.allegro.public.v1+json' \
 -H 'Accept-Language: pl-PL'
 - d’{
    "request": {
        "message": "Proszę o usunięcie oceny zgodnie z ustaleniami telefonicznymi."     
                                                      			-- prośba o usunięcie oceny     
                                                                (maksymalnie 500 znaków)
    }
 }’


Przykładowy response:

 {
    "request": {
        "createdAt": "2021-07-31T19:55:08.555",    -- data, od której kupujący ma 14 dni
                                                   na usunięcie oceny.
        "message": "Proszę o usunięcie oceny zgodnie z ustaleniami telefonicznymi."
    }
    "possibleTo": "2021-08-13T19:55:08.555"		   -- data, do kiedy sprzedawca może wysłać
                    							   prośbę o usunięcie oceny
 }

3. Warunki ofert

Warunki zwrotów

Jak dodać informacje o warunkach zwrotów

Skorzystaj z POST /after-sales-service-conditions/return-policies, aby dodać nowe warunki zwrotów. W strukturze żądania przekaż pola:

  • name - wymagane, nazwa warunków zwrotu,
  • availability.range - wymagane, możliwość odstąpienia od umowy przez kupującego:
    • FULL - jest taka możliwość,
    • RESTRICTED - brak lub ograniczona możliwość,
  • availability.restrictionCause.name - wymagane, jeśli w polu availability.range wybrałeś wartość RESTRICTED. Poniżej znajdziesz listę dostępnych wartości wraz z opisem. Możesz wybrać tylko jedną wartość:
Wartość Prawo odstąpienia od umowy bez podania przyczyny nie przysługuje konsumentowi w przypadku gdy:
SEALED_MEDIA Nagranie dźwiękowe, wizualne, program komputerowy w zapieczętowanym opakowaniu. Np.: kiedy kupujący zdejmie folię ochronną z fabrycznie nowej gry, lub płyty z muzyką czy filmem.
SEALED_ITEM_NO_RETURN_DUE_HEALTH_OR_HYGIENE Rzecz, której po otwarciu nie możesz zwrócić ze względu na ochronę zdrowia lub higienę – na przykład: bielizna osobista, test ciążowy, końcówki do szczoteczki elektrycznej, soczewki kontaktowe, maseczki.
CUSTOM_ITEM Rzecz wyprodukowaną na indywidualne zamówienie kupującego, według jego wytycznych.Np.: koszulka z zaprojektowanym przez kupującego nadrukiem.
SHORT_SHELF_LIFE Produkt z krótkim terminem przydatności do użycia lub taki, który szybko się psuje. Np.: twaróg, świeże warzywa, rośliny doniczkowe
INSEPARABLY_LINKED Rzecz, którą po dostarczeniu trwale połączysz z innymi rzeczami. Np.: olej samochodowy, który wlejesz do auta.
PRESS Dziennik, periodyk lub czasopismo – z wyjątkiem umów o prenumeratę.
MEDICINAL_PRODUCT Produkt leczniczy, środki spożywcze specjalnego przeznaczenia żywieniowego i wyroby medyczne wydane z apteki.
NOT_RECORDED_DIGITAL_CONTENT Treść cyfrową, nie zapisaną na nośniku materialnym, z której kupujący zgodził się skorzystać. Np.: pobranie ebooka, kodu do gry.
VALUE_DEPENDENT_ON_FINANCIAL_MARKET Usługę lub przedmiot, których ceny zależą od wahań na rynku finansowym, nad którymi sprzedający nie ma kontroli, a które mogą wystąpić przed upływem terminu na odstąpienie od umowy. Np. produkty inwestycyjne: sztabki złota, monety kolekcjonerskie, srebro, platyna.
  • withdrawalPeriod - wymagane, jeśli w polu availability.range wybrałeś wartość FULL. Czas na odstąpienie umowy w formacie ISO 8601. Jako wartość możesz przekazać tylko dni, np. “P14D”,
  • returnCost.coveredBy - wymagane, jeśli w polu availability.range wybrałeś wartość FULL. Informacja o tym, kto pokrywa koszt przesyłki zwrotnej. Dostępne wartości to SELLER lub BUYER,
  • address - wymagane, adres do zwrotów,
  • contact - niewymagane, informacje kontaktowe - numer telefonu i adres email,
  • options - wymagana pełna struktura, dodatkowe informacje. Poniżej znajdziesz listę dostępnych wartości wraz z opisem:
Wartość Zaznaczone informacje zobaczy kupujący na Twojej ofercie
cashOnDeliveryNotAllowed Nie przyjmuję zwrotów nadanych za pobraniem.
freeAccessoriesReturnRequired Otrzymałeś gratis? - w przypadku zwrotu towaru odeślij go również do nas.
refundLoweredByReceivedDiscount Otrzymałeś rabat na kolejną sztukę? - w przypadku zwrotu towaru pomniejszymy zwrot wpłaty o wartość udzielonego rabatu.
refundOfCheapestItemInCombinedDiscount Podczas zakupu zestawu otrzymałeś rabat na kolejny produkt? - w przypadku zwrotu jednego produktu z zestawu, otrzymasz zwrot pieniędzy za tańszy produkt.
businessReturnAllowed Przyjmuję zwroty od firm (nie dotyczy jednoosobowych działalności gospodarczych).
collectBySellerOnly Osobiście odbieram zwrot od kupującego.


Kliknij, żeby zobaczyć przykładowy request:
  curl -X POST 
'https://api.allegro.pl/after-sales-service-conditions/return-policies '
-H 'Authorization: Bearer {token}'
-H 'Accept: application/vnd.allegro.public.v1+json'
-H 'Content-Type: application/vnd.allegro.public.v1+json' -d ‘{ "name": "warunki zwrotu z ograniczeniami", – wymagane, nazwa warunków zwrotu "availability": { – wymagane, informacje o możliwości odstąpienia od umowy przez kupującego "range": "RESTRICTED", "restrictionCause": { – wymagane, jeśli wybrałeś RESTRICTED "name": "PRESS" } }, "withdrawalPeriod": "P30D", – wymagane, czas na odstąpienie umowy "returnCost": { "coveredBy": "BUYER" – wymagane, informacja o tym, kto pokrywa koszty przesyłki zwrotnej }, "address": { – wymagane, adres do zwrotów "name": "Allegro.pl Sp. z o.o.", "street": "Grunwaldzka 182", "postCode": "60-166", "city": "Poznań", "countryCode": "PL" }, "contact": { – niewymagane, dane kontaktowe "phoneNumber": "123123123", "email": "email@domain.com" }, "options": { – wymagane przesłanie pełnej struktury "cashOnDeliveryNotAllowed": true, "freeAccessoriesReturnRequired": false, "refundLoweredByReceivedDiscount": false, "refundOfCheapestItemInCombinedDiscount": false, "businessReturnAllowed": false, "collectBySellerOnly": false } }'

Kliknij, żeby zobaczyć przykładowy response:
 {
    "id": "bc99b3fe-6953-46c6-80b7-40e6ad82d588",
    "seller": {
        "id": "44173117"
    },
    "name": "warunki zwrotu z ograniczeniami",
    "availability": {
        "range": "RESTRICTED",
        "restrictionCause": {
            "name": "PRESS",
            "description": "Dziennik, periodyk lub czasopismo – z wyjątkiem umów o prenumeratę."
        }
    },
    "withdrawalPeriod": "P30D",
    "returnCost": {
        "coveredBy": "BUYER"
    },
    "attachment": {                             – ustawowy wzór odstąpienia od umowy,
                                                dodajemy automatycznie do każdego
                                                requestu
        "id": "eba2908b-2403-44b1-bd1f-9893ecbacbe5",
        "name": "Przykładowy formularz odstąpienia od umów.pdf",
        "url": "https://after-sales.allegrosandbox.pl/after-sales-service-33/eba2908b-2403-44b1-bd1f-9893ecbacbe5"
    },
    "address": {
        "name": "Allegro.pl Sp. z o.o.",
        "street": "Grunwaldzka 182",
        "postCode": "60-166",
        "city": "Poznań",
        "countryCode": "PL"
    },
    "contact": {
"phoneNumber": "123123123", "email": "email@domain.com" }, "options": {
"cashOnDeliveryNotAllowed": true, "freeAccessoriesReturnRequired": false, "refundLoweredByReceivedDiscount": false, "refundOfCheapestItemInCombinedDiscount": false, "businessReturnAllowed": false, "collectBySellerOnly": false } }

Jak pobrać warunki zwrotów przypisane do konta

Za pomocą GET /after-sales-service-conditions/return-policies pobierzesz warunki zwrotów przypisane do zautoryzowanego konta. W odpowiedzi otrzymasz listę 60 warunków, która zawiera informacje o identyfikatorze oraz nazwie warunku. Możesz ją dostosować do własnych potrzeb za pomocą filtrów:

  • limit - liczba wyników w odpowiedzi. Domyślna i maksymalna wartość to 60,
  • offset - miejsce, od którego chcesz pobrać następną porcję danych.

Jeżeli chcesz pobrać szczegóły warunków zwrotu, przekaż ich identyfikator za pomocą GET /after-sales-service-conditions/return-policies/{returnPolicyId}.

Przykladowy request:

  curl -X GET \
  'https://api.allegro.pl/after-sales-service-conditions/return-policies/bc99b3fe-6953-46c6-80b7-40e6ad82d588' \
  -H 'Authorization: Bearer {token}' \
  -H 'Accept: application/vnd.allegro.public.v1+json' \
  -H 'Content-Type: application/vnd.allegro.public.v1+json' \

Kliknij, żeby zobaczyć przykładowy response:
 {
    "id": "bc99b3fe-6953-46c6-80b7-40e6ad82d588",
    "seller": {
        "id": "44173117"
    },
    "name": "ograniczone",
    "availability": {
        "range": "RESTRICTED",
        "restrictionCause": {
            "name": "PRESS",
            "description": "Dziennik, periodyk lub czasopismo – z wyjątkiem umów o prenumeratę."
        }
    },
    "withdrawalPeriod": "P14D",
    "returnCost": {
        "coveredBy": "BUYER"
    },
    "attachment": {
        "id": "eba2908b-2403-44b1-bd1f-9893ecbacbe5",
        "name": "Przykładowy formularz odstąpienia od umów.pdf",
        "url": "https://after-sales.allegrosandbox.pl/after-sales-service-33/eba2908b-2403-44b1-bd1f-9893ecbacbe5"
    },
    "address": {
        "name": "Allegro.pl Sp. z o.o.",
        "street": "Grunwaldzka 182",
        "postCode": "60-166",
        "city": "Poznań",
        "countryCode": "PL"
    },
    "contact": {
        "phoneNumber": "123123123",
        "email": "email@domain.com"
    },
    "options": {
        "cashOnDeliveryNotAllowed": true,
        "freeAccessoriesReturnRequired": false,
        "refundLoweredByReceivedDiscount": false,
        "refundOfCheapestItemInCombinedDiscount": false,
        "businessReturnAllowed": false,
        "collectBySellerOnly": false
    }
}

Jak edytować informacje o warunkach zwrotu

Aby edytować informacje o warunkach zwrotu:

Kliknij, żeby zobaczyć przykładowy request:
 curl -X PUT \
'https://api.allegro.pl/after-sales-service-conditions/return-policies/bc99b3fe-6953-46c6-80b7-40e6ad82d588' \
  -H 'Authorization: Bearer {token}' \
  -H 'Accept: application/vnd.allegro.public.v1+json' \
  -H 'Content-Type: application/vnd.allegro.public.v1+json' \
  -d ‘{
    "id": "bc99b3fe-6953-46c6-80b7-40e6ad82d588",
    "seller": {
        "id": "44173117"
    },
    "name": "ograniczone",
    "availability": {
        "range": "RESTRICTED",
        "restrictionCause": {
            "name": "PRESS",
            "description": "Dziennik, periodyk lub czasopismo – z wyjątkiem umów o prenumeratę."
        }
    },
    "withdrawalPeriod": "P30D",
    "returnCost": {
        "coveredBy": "BUYER"
    },
    "attachment": {                                     -- ustawowy wzór odstąpienia od
                                                        umowy, dodajemy automatycznie do
                                                        każdego requestu. Nie możesz
                                                        zmienić tego pola.
        "id": "eba2908b-2403-44b1-bd1f-9893ecbacbe5",
        "name": "Przykładowy formularz odstąpienia od umów.pdf",
        "url": "https://after-sales.allegrosandbox.pl/after-sales-service-33/eba2908b-2403-44b1-bd1f-9893ecbacbe5"
    },
    "address": {
        "name": "Allegro.pl Sp. z o.o.",
        "street": "Grunwaldzka 182",
        "postCode": "60-166",
        "city": "Poznań",
        "countryCode": "PL"
    },
    "contact": {
        "phoneNumber": "123123123",
        "email": "email@domain.com"
    },
    "options": {
        "cashOnDeliveryNotAllowed": true,
        "freeAccessoriesReturnRequired": false,
        "refundLoweredByReceivedDiscount": false,
        "refundOfCheapestItemInCombinedDiscount": false,
        "businessReturnAllowed": false,
        "collectBySellerOnly": false
    }
}'

Warunki reklamacji

Jak dodać informacje o warunkach reklamacji

Skorzystaj z POST /after-sales-service-conditions/implied-warranties, aby dodać nowe warunki zwrotów. W strukturze żądania przekaż pola:

  • name - wymagane, nazwa dla warunków reklamacji,
  • individual.period - wymagane, czas na reklamację w formacie ISO 8601 z tytułu rękojmi. Jako wartość możesz wskazać tylko lata, np. “P3Y” oznacza 3 lata,
  • corporate.period - niewymagane, czas na reklamację w formacie ISO 8601 z tytułu rękojmi dla przedsiębiorców. Jeżeli chcesz ją wyłączyć, nie przekazuj tego pola lub przekaż wartość null,
  • address - wymagane, adres do reklamacji,
  • description - niewymagane, opis reklamacji. Możesz także skorzystać z tagów HTML: <p>, <b>, <ul>, <ol>, <li>. Inne znaczniki zostaną zignorowane.
Kliknij, żeby zobaczyć przykładowy request:
  curl -X POST \
  'https://api.allegro.pl/after-sales-service-conditions/implied-warranties' \
  -H 'Authorization: Bearer {token}' \
  -H 'Accept: application/vnd.allegro.public.v1+json' \
  -H 'Content-Type: application/vnd.allegro.public.v1+json' \
  -d’{
    "name": "Główne warunki reklamacji",    -- wymagane, nazwa warunków
                                            reklamacji
    "individual": {
        "period": "P1Y"                     -- wymagane, czas na reklamację z
                                            tytułu rękojmi
    },
    "corporate": {                          -- niewymagane, czas na reklamację
                                            z tytułu rękojmi dla przedsiębiorców.
                                            Jeżeli chcesz ją wyłączyć, przekaż
                                            wartość null.
        "period": "P1Y"
    },
    "address": {                            -- wymagane, adres do reklamacji
        "name": "test",
        "street": "ul. Testowa 7",
        "postCode": "61-135",
        "city": "Poznań",
        "countryCode": "PL"
    },
    "description":                          -- niewymagane, opis procedury
                                            reklamacji
“<p>Co musi zawierać reklamacja? Reklamacja powinna zawierać:</p>
<ul><li>Twoje imię i nazwisko oraz adres</li>
<li>numer oferty na Allegro</li><li>numer zamówienia</li>
<li>przedmiot reklamacji</li>
<li>Twoje oczekiwania: wymiana towaru na nowy, naprawa,
obniżenie ceny lub odstąpienie od umowy (zwrot pieniędzy)</li></ul>”
}’

Kliknij, żeby zobaczyć przykładowy response:
 {
    "id": "1556c6f7-c6a9-469e-9b3f-8f01eafaedc4",
    "seller": {
        "id": "62799754"
    },
    "name": "Główne warunki reklamacji",
    "individual": {
        "period": "P1Y"
    },
    "corporate": {
        "period": "P1Y"
    },
    "address": {
        "name": "test",
        "street": "ul. Testowa 7",
        "postCode": "61-135",
        "city": "Poznań",
        "countryCode": "PL"
    },
    "description": “<p>Co musi zawierać reklamacja? Reklamacja powinna zawierać:</p>
 <ul><li>Twoje imię i nazwisko oraz adres</li>
 <li>numer oferty na Allegro</li><li>numer zamówienia SO</li>
 <li>przedmiot reklamacji</li><li>Twoje oczekiwania: wymiana towaru na nowy,
 naprawa, obniżenie ceny lub odstąpienie od umowy (zwrot pieniędzy)</li></ul>”
 }

Jak pobrać warunki reklamacji przypisane do konta

Za pomocą GET /after-sales-service-conditions/implied-warranties pobierzesz warunki reklamacji przypisane do zautoryzowanego konta. W odpowiedzi otrzymasz listę 60 warunków, która zawiera informacje o identyfikatorze oraz nazwie warunku. Możesz ją dostosować do własnych potrzeb za pomocą filtrów:

  • limit - liczba wyników w odpowiedzi. Domyślna i maksymalna wartość to 60,
  • offset - miejsce, od którego chcesz pobrać następną porcję danych.

Jeżeli chcesz pobrać szczegóły warunków reklamacji, przekaż ich identyfikator za pomocą GET /after-sales-service-conditions/implied-warranties/{impliedWarrantyId}.

Przykladowy request:

  curl -X GET \
  'https://api.allegro.pl/after-sales-service-conditions/implied-warranties/bbb2458-54f1-4dff-a9d4-c9067554390d' \
  -H 'Authorization: Bearer {token}' \
  -H 'Accept: application/vnd.allegro.public.v1+json' \
  -H 'Content-Type: application/vnd.allegro.public.v1+json' \
Kliknij, żeby zobaczyć przykładowy response:
 {
    "id": bbb2458-54f1-4dff-a9d4-c9067554390d",
    "seller": {
        "id": "627909754"
    },
    "name": "Główne warunki reklamacji",
    "individual": {
        "period": "P6Y"
    },
    "corporate": {
        "period": "P6Y"
    },
    "address": {
        "name": "test",
        "street": "ul. Testowa 7",
        "postCode": "61-135",
        "city": "Poznań",
        "countryCode": "PL"
    },
    "description": “<p>Co musi zawierać reklamacja? Reklamacja powinna zawierać:</p>
  <ul><li>Twoje imię i nazwisko oraz adres</li>
  <li>numer oferty na Allegro</li>
  <li>numer zamówienia SO</li><li>przedmiot reklamacji</li>
  <li>Twoje oczekiwania: wymiana towaru na nowy, naprawa,
  obniżenie ceny lub odstąpienie od umowy (zwrot pieniędzy)</li></ul>””
 }

Jak edytować informacje o warunkach reklamacji

Aby edytować informacje o warunkach zwrotu:

Kliknij, żeby zobaczyć przykładowy request:
 curl -X PUT \
'https://api.allegro.pl/after-sales-service-conditions/implied-warranties/bbbc9778-54f1-4dff-a9d4-c9067554390d' \
  -H 'Authorization: Bearer {token}' \
  -H 'Accept: application/vnd.allegro.public.v1+json' \
  -H 'Content-Type: application/vnd.allegro.public.v1+json' \
  -d ‘{
    "id": "1556c6f7-c6a9-469e-9b3f-8f01eafaedc4",
    "seller": {
        "id": "279934754"
    },
    "name": "Główne warunki reklamacji",
    "individual": {
        "period": "P1Y"
    },
    "corporate": null,
    "address": {
        "name": "test",
        "street": "ul. Testowa 7",
        "postCode": "61-135",
        "city": "Poznań",
        "countryCode": "PL"
    },
    "description": “<p>Co musi zawierać reklamacja? Reklamacja powinna zawierać:</p>
  <ul><li>Twoje imię i nazwisko oraz adres</li>
  <li>numer oferty na Allegro</li><li>numer zamówienia SO</li>
  <li>przedmiot reklamacji</li><li>Twoje oczekiwania: wymiana towaru na nowy,
  naprawa, obniżenie ceny lub odstąpienie od umowy (zwrot pieniędzy)</li></ul>””
 }’

Informacje o gwarancjach

Jak dodać załącznik do informacji o gwarancjach

Utwórz obiekt załącznika za pomocą POST /after-sales-service-conditions/attachments. W strukturze przekaż nazwę pliku w formacie .pdf.

Przykładowy request:

  curl -X POST \
  'https://api.allegro.pl/after-sales-service-conditions/attachments' \
  -H 'Authorization: Bearer {token}' \
  -H 'Accept: application/vnd.allegro.public.v1+json' \
  -H 'Content-Type: application/vnd.allegro.public.v1+json' \
  -d’
  {
	“name”: “warranty.pdf” 				-- nazwa pliku, który chcesz
										załączyć
  }’
Przykładowy response:
  {
    "id": "7c8f40bc-3e50-408b-a66b-48122e05d84e",
    "name": "warranty.pdf",
    "url": null
  }

Teraz użyj PUT /after-sales-service-conditions/attachments/{attachmentId} - jako attachmentId przekaż wartość id, którą otrzymałeś krok wcześniej. Pamiętaj, aby użyć adresu, który zwróciliśmy w nagłówku location.

Przykładowy request:

  curl -X PUT \
  'https://upload.allegro.pl/after-sales-service-conditions/attachments/7c8f40bc-3e50-408b-a66b-48122e05d84e' \
  -H 'Authorization: Bearer {token}' \
  -H 'Accept: application/vnd.allegro.public.v1+json'
  -H ‘Content-Type: application/pdf’
  --data-binary "@warranty.pdf"                                -- wymagany, zawartość pliku z
                                                               załącznikiem w postaci binarnej
Przykładowy response:
  {
    "id": "7c8f40bc-3e50-408b-a66b-48122e05d84e",
    "name": "warranty.pdf",
    "url": "https://after-sales.allegrostatic.com/after-sales-service-5c/7c8f40bc-3e50-408b-a66b-48122e05d84e"
 }

Obiekt, który otrzymałeś, możesz dodać do informacji o gwarancjach w polu attachment. W dalszej części poradnika opisujemy ten proces.

Jak dodać informacje o gwarancjach

Skorzystaj z POST /after-sales-service-conditions/warranties, aby dodać nowe informacje o gwarancjach. W strukturze żądania przekaż pola:

  • name - wymagane, nazwa dla informacji o gwarancji,
  • type - wymagane, rodzaj gwarancji, dostępne wartości to MANUFACTURER (od producenta/dystrybutora) lub SELLER (od sprzedawcy),
  • individual.period - wymagane, okres gwarancji w formacie ISO 8601. Jako wartość możesz wskazać tylko miesiące, np. “P12M”, co oznacza 12 miesięcy. Jeżeli chcesz wskazać dożywotnią gwarancję, pozostaw to miejsce puste, a w polu individual.lifetime przekaż wartość true,
  • corporate.period - niewymagane, okres gwarancji w formacie ISO 8601 dla przedsiębiorców. Jako wartość możesz wskazać tylko miesiące, np. “P12M” oznacza 12 miesięcy. Jeżeli chcesz wskazać dożywotnią gwarancję, pozostaw to miejsce puste, a w polu individual.lifetime przekaż wartość true,
  • attachment - niewymagane, załącznik do gwarancji,
  • description - niewymagane, informacje dodatkowe np. gdzie szukać informacji, z kim i jak ma się kontaktować, jakie dokumenty będą potrzebne itp.
Kliknij, żeby zobaczyć przykładowy request:
  curl -X POST \
  'https://api.allegro.pl/after-sales-service-conditions/warranties' \
  -H 'Authorization: Bearer {token}' \
  -H 'Accept: application/vnd.allegro.public.v1+json' \
  -H 'Content-Type: application/vnd.allegro.public.v1+json' \
  -d ‘{
  "name": "12 miesięcy",                    -- wymagane, nazwa informacji o
                                            gwarancjach
  "type": "MANUFACTURER",                   -- wymagane, rodzaj gwarancji
  "individual": {
    "period": "P12M",                       -- wymagane, okres gwarancji
    "lifetime": false                       -- niewymagane, czy gwarancja jest
                                            dożywotnia,
  },
  "corporate": {                            -- niewymagane, okres gwarancji dla
                                            przedsiębiorców
    "period": "P12M",
    "lifetime": false
  },
  "attachment": {                           -- niewymagane, informacje o
                                            załączniku
    "id": "54702c96-4ccd-4c0e-b4c7-382a71e810b5",
    "name": "warranty.pdf",
    "url": "https://after-sales.allegrostatic.com/after-sales-service-5c/7c8f40bc-3e50-408x-a66b-48122e05d84e"
}
  },
  "description":                            -- niewymagane, informacje
                                            dodatkowe
  "<p>Gwarancja producenta na 12 miesięcy</p>"
}’

Kliknij, żeby zobaczyć przykładowy response:
  {
    "id": "bce9e4ad-4e06-4478-8038-04f3cbed73f4",
    "seller": {
        "id": "6279923754"
    },
    "name": "12 miesięcy",
    "type": "MANUFACTURER",
    "individual": {
        "period": "P12M",
        "lifetime": false
    },
    "corporate": {
        "period": "P12M",
        "lifetime": false
    },
    "attachment": {
        "id": "54702c96-4ccd-4c0e-b4c7-382a71e810b5",
        "name": "warranty.pdf",
        "url": "https://after-sales.allegrostatic.com/after-sales-service-00/54702c96-4ccd-4c0e-b4c7-382a71e810b5"
    },
    "description": "<p>Gwarancja producenta na 12 miesięcy</p>"
  }

Jak pobrać informacje o gwarancjach przypisanych do konta

Za pomocą GET /after-sales-service-conditions/warranties pobierzesz informacje o gwarancjach przypisanych do zautoryzowanego konta. W odpowiedzi otrzymasz listę 60 gwarancji, która zawiera informacje o identyfikatorze oraz nazwie warunków. Możesz ją dostosować do własnych potrzeb za pomocą filtrów:

  • limit - liczba wyników w odpowiedzi. Domyślna i maksymalna wartość to 60,
  • offset - miejsce, od którego chcesz pobrać następną porcję danych.

Jeżeli chcesz pobrać szczegóły informacji o gwarancji, przekaż ich identyfikator za pomocą GET /after-sales-service-conditions/warranties/{warrantyId}.

Przykładowy request:

  curl -X GET \
  'https://api.allegro.pl/after-sales-service-conditions/warranties/bbb2458-54f1-4dff-a9d4-c9067554390d' \
  -H 'Authorization: Bearer {token}' \
  -H 'Accept: application/vnd.allegro.public.v1+json' \
  -H 'Content-Type: application/vnd.allegro.public.v1+json' \
Kliknij, żeby zobaczyć przykładowy response:
  {
    "id": "bbb2458-54f1-4dff-a9d4-c9067554390d",
    "seller": {
        "id": "627120754"
    },
    "name": "default",
    "type": "MANUFACTURER",
    "individual": {
        "period": null,
        "lifetime": true
    },
    "corporate": {
        "period": null,
        "lifetime": true
    },
    "attachment": {
        "id": "564c8680-505c-4d34-a6d3-bd8e4d20b49d",
        "name": "uploaded_file.pdf",
        "url": "https://after-sales.allegrostatic.com/after-sales-service-b5/564c8680-505c-4d34-a6d3-bd8e4d20b49d&#34;
    },
    "description": null,
}

Jak edytować informacje o gwarancjach

Aby edytować informacje o gwarancjach:

Kliknij, żeby zobaczyć przykładowy request:
  curl -X PUT \
  'https://api.allegro.pl/after-sales-service-conditions/warranties/bbbc9712-54f1-4dff-a9d4-c9067554390d' \
  -H 'Authorization: Bearer {token}' \
  -H 'Accept: application/vnd.allegro.public.v1+json' \
  -H 'Content-Type: application/vnd.allegro.public.v1+json' \
  -d ‘{
    "id": "62c9bede-82be-4d17-831d-af66270d1ade",
    "seller": {
        "id": "62799754"
    },
    "name": "default",
    "type": "MANUFACTURER",
    "individual": {
        "period": null,
        "lifetime": true
    },
    "corporate": {
        "period": null,
        "lifetime": true
    },
    "attachment": {
        "id": "564c8680-505c-4d34-a6d3-bd8e4d20b49d",
        "name": "uploaded_file.pdf",
        "url": "https://after-sales.allegrostatic.com/after-sales-service-b5/564c8680-505c-4d34-a6d3-bd8e4d20b49d"
    },
    "description": null,
}’

4. Moi nieaktywni kupujący

Jak dodać kupującego do listy nieaktywnych kupujących

Zrobisz to za pomocą POST /sale/blacklisted-users. Użytkownik, którego dodasz do listy, nie będzie mógł kupować w twoich ofertach. W każdej chwili możesz go z niej usunąć.


Przykładowy request:

 curl -X POST \
 ‘https://api.allegro.pl/sale/blacklisted-users’ \
 -H ‘Authorization: Bearer {token}’ \
 -H ‘Accept: application/vnd.allegro.public.v1+json’ \
 -H ‘Content-Type: application/vnd.allegro.public.v1+json’
 -d ‘{
    “user”: {
        “id”: 123456,                       	-- wymagane (jeśli nie przekazujesz loginu),
                                                id kupującego
        “login”: “bad_buyer”                	-- wymagane (jeśli nie przekazujesz id),
                                                login kupującego
    },
    “note”: “Rude person”                       -- powód dodania do listy
 }’


Przykładowy response:

 {
    “user”: {
        “id”: 123456,
        “login”: “bad_buyer”
    },
    “note”: “Rude person”,
    “createdAt”: “2019-05-08T09:45:818Z”        -- data dodania do listy
 }

Jak usunąć użytkownika z listy nieaktywnych kupujących

Zrobisz to za pomocą DELETE /sale/blacklisted-users/{excludedUserId}. Jako userID przekaż ID użytkownika, którego chcesz usunąć z listy.


Przykładowy request:

  curl -X DELETE \
  'https://api.allegro.pl/sale/blacklisted-users/12345678' \
  -H 'Accept: application/vnd.allegro.public.v1+json' \
  -H 'Authorization: Bearer {token}'


Przykładowy response:

  Status 204 OK

5. Dane kontaktowe

Dane kontaktowe, które zdefiniujesz, wykorzystasz, gdy wystawisz ogłoszenie.


Pamiętaj!

  • nie możesz mieć więcej niż 50 kontaktów,
  • w jednym kontakcie możesz podać maksymalnie:
    • 1 adres e-mail,
    • 2 numery telefonu.

Jak utworzyć nowy kontakt

Zrobisz to za pomocą POST /sale/offer-contacts.


Przykładowy request:

 curl -X POST \
 'https://api.allegro.pl/sale/offer-contacts' \
 -H 'Content-Type: application/vnd.allegro.public.v1+json' \
 -H 'Accept: application/vnd.allegro.public.v1+json’ \
 -H 'Authorization: Bearer {token}' \
 -d '{
   "name": "Auta terenowe",      -- nazwa kontaktu; wymagane, maksymalna liczba znaków - 250
   "emails": [                   -- adresy e-mail; możesz podać 1
     {
       "address": "test@test.pl"
     }
   ],
   "phones": [                   -- nr telefonów; możesz podać maksymalnie 2
     {
       "number": "555-555-666"
     },
     {
       "number": "555555667"
     }
   ]
  }’


Przykładowy response:

  {
    "id": "0c046252-9559-4ecb-8ea3-879f60e46947",   -- identyfikator kontaktu
    "name": "Auta terenowe",                        -- nazwa kontaktu
    "emails": [
        {
            "address": "test@test.pl"
        }
    ],
    "phones": [
     {
       "number": "555-555-666"
     },
     {
       "number": "555555667"
     }
    ]
  }

Jak pobrać listę kontaktów

Zrobisz to za pomocą GET /sale/offer-contacts.


Przykładowy request:

 curl -X GET \
 'https://api.allegro.pl/sale/offer-contacts' \
 -H 'Accept: application/vnd.allegro.public.v1+json’ \
 -H 'Authorization: Bearer {token}’


Przykładowy response:

 {
    "contacts": [
        {
            "id": "0c046252-9559-4ecb-8ea3-879f60e46947",   -- identyfikator kontaktu
            "name": "Auta terenowe",                     	-- nazwa kontaktu
            "emails": [
                {
                    "address": "test@test.pl"			    -- adres mailowy
                }
            ],
            "phones": [
                {
                    "number": "+48 788 788 788"			    -- numer telefonu
                },
                {
                    "number": "+48 75 575 57 55"
                }
            ]
        },
        {
            "id": "af1ccfd7-2753-4ed3-bdda-c78eb14442ab",
            "name": "Auta osobowe",
            "emails": [
                {
                    "address": "test@test.pl"
                }
            ],
            "phones": [
                {
                    "number": "+48 55 555 57 77"
                }
            ]
        },
        {
            "id": "27869b31-048e-43a0-bdc0-52b922f278a5",
            "name": "Ciężarówki",
            "emails": [
                {
                    "address": "test@test.pl"
                }
            ],
            "phones": []
        }
    ]
   }

Jak pobrać szczegóły danego kontaktu

Zrobisz to za pomocą GET /sale/offer-contacts/{id}. Jako id przekaż identyfikator danego kontaktu - pobierzesz go za pomocą GET /sale/offer-contacts.


Przykładowy request:

 curl -X GET \
 ‘https://api.allegro.pl/sale/offer-contacts/0c046252-9559-4ecb-8ea3-879f60e46947' \
 -H 'Accept: application/vnd.allegro.public.v1+json’ \
 -H 'Authorization: Bearer {token}’


Przykładowy response:

  {
    "id": "0c046252-9559-4ecb-8ea3-879f60e46947",       -- identyfikator kontaktu
    "name": "Auta terenowe",                            -- nazwa kontaktu
    "emails": [
        {
            "address": "test@test.pl"
        }
    ],
    "phones": [
        {
            "number": "+48 55 555 57 77"
        }
    ]
  }

Jak zmienić dane kontaktu

Zrobisz to za pomocą PUT /sale/offer-contacts/{id}. Jako id przekaż identyfikator danego kontaktu - pobierzesz go za pomocą GET /sale/offer-contacts.


Przykładowy request:

 curl -X PUT \
 'https://api.allegro.pl/sale/offer-contacts/0c046252-9559-4ecb-8ea3-879f60e46947' \
 -H 'Content-Type: application/vnd.allegro.public.v1+json' \
 -H 'Accept: application/vnd.allegro.public.v1+json’ \
 -H 'Authorization: Bearer {token}' \
 -d '{
  "name": "Auta terenowe",        -- nazwa kontaktu; wymagane, maksymalna liczba znaków - 250
  "emails": [                     -- adresy e-mail; możesz podać 1
    {
      "address": "test@test.pl"
    }
  ],
  "phones": [                     -- nr telefonów; możesz podać maksymalnie 2
    {
      "number": "555-555-666"
    }
  ]
 }’


Przykładowy response:

  {
    "id": "0c046252-9559-4ecb-8ea3-879f60e46947",
    "name": "Auta terenowe",
    "emails": [
        {
            "address": "test@test.pl"
        }
    ],
    "phones": [
        {
            "number": "555-555-666”
        }
    ]
  }

6. Adresy mailowe

Od 26 marca 2019 adres e-mail kupującego zwracamy jako ciąg znaków w domenie @allegromail.pl, np:

  • 8awgqyk6a5@allegromail.pl - zakodowana wersja adresu mailowego,
  • 8awgqyk6a5+cub31c122@allegromail.pl - zakodowana wersja adresu mailowego wraz z informacją o transakcji.

Zmianę wdrożyliśmy ze względów bezpieczeństwa i ochrony danych osobowych. Adresy mailowe maskujemy w całym Allegro. Maskowany adres e-mail składa się z zakodowanej pary sprzedawca-kupujący i informacji o transakcji. Więcej informacji na temat maskowania maili znajdziesz w pomocy Allegro.

W związku z tą zmianą, użytkownik może wysłać do klienta e-mail tylko z takich adresów jakie przypisał do swojego konta. Dlatego przygotowaliśmy zasoby, które pozwolą ci zarządzać dodatkowymi adresami e-mail:

Jak dodać adres e-mail

Użyj POST /account/additional-emails, aby dodać do swojego konta dodatkowy adres e-mail. Musisz być zalogowany jako właściciel danego konta.


Przykładowy request:

 curl -X POST \
 'https://api.allegro.pl/account/additional-emails' \
 -H 'content-type: application/vnd.allegro.public.v1+json' \
 -H 'Accept: application/vnd.allegro.public.v1+json’ \
 -H 'authorization: Bearer {token}' \
 -d '{
  “email”: adresemail@gmail.com                   -- wymagane, adres e-mail możesz podać 1.
                                                  Maksymalna długość maila to 64 znaki
                                                  przed adresem domeny.
 }'


Przykładowy response:

 {
    "id": "5c40a8fa7fae6f7613c2b560",
    “email”:  “adresemail@gmail.com”,
    “createdAt”: "2019-04-02T17:03:00Z"
 }

Możliwe kody HTTP w odpowiedzi:

  • 201 Created - Odpowiedź prawidłowa,
  • 400 Bad request,
  • 401 Unauthorized,
  • 422 Unprocessable Entity.

Jak pobrać adresy e-mail

Użyj GET /account/additional-emails, aby pobrać adresy e-mail utworzone na Twoim koncie. Musisz być zalogowany jako właściciel danego konta.


Przykładowy request:

  curl -X GET \
  'https://api.allegro.pl/account/additional-emails' \
  -H 'Accept: application/vnd.allegro.public.v1+json’ \
  -H 'authorization: Bearer {token}'


Przykładowy response:

  {
    “additional-emails”: [
        {
            "id": "5c40a8fa7fae6f7613c2b560",
            “email”:  “adresemail@gmail.com”,
            “createdAt”: "2019-04-02T17:03:00Z"
        },
        {
            "id": "6c30a8ga9fsc6f8651c2b523",
            “email”:  “adresemail2@gmail.com”,
            “createdAt”: "2019-04-03T13:12:33Z"
        },
    ]
 }

Możliwe kody HTTP w odpowiedzi:

  • 200 Odpowiedź prawidłowa,
  • 401 Unauthorized.

Jak pobrać szczegółowe informacje o adresie e-mail

Użyj GET /account/additional-emails/{emailID}, aby pobrać szczegółowe informacje o danym adresie e-mail. Musisz być zalogowany jako właściciel danego konta.


Przykładowy request:

  curl -X GET \
  'https://api.allegro.pl/account/additional-emails/5c40a8fa7fae6f7613c2b560' \
  -H 'Accept: application/vnd.allegro.public.v1+json’ \
  -H 'authorization: Bearer {token}'


Przykładowy response:

  {
    "id": "5c40a8fa7fae6f7613c2b560",
    “email”:  “adresemail@gmail.com”,
    “createdAt”: "2019-04-02T17:03:00Z"
  }

Możliwe kody HTTP w odpowiedzi:

  • 200 Odpowiedź prawidłowa,
  • 401 Unauthorized,
  • 404 Not Found.

Jak usunąć adres e-mail

Użyj DELETE /account/additional-emails/{emailID}, aby usunąć podany adres e-mail. Musisz być zalogowany jako właściciel danego konta.


Przykładowy request:

  curl -X DELETE \
  'https://api.allegro.pl/account/additional-emails/5c40a8fa7fae6f7613c2b560' \
  -H 'Accept: application/vnd.allegro.public.v1+json’ \
  -H 'authorization: Bearer {token}'


Przykładowy response:

  status 204 No Content

Możliwe kody HTTP w odpowiedzi:

  • 204 - Email usunięty prawidłowo,
  • 401 Unauthorized,
  • 404 Not Found.

7. Lista zasobów

Pełną dokumentację zasobów w postaci pliku swagger.yaml znajdziesz tu.