Jak przypisać ofertę do kampanii

Obsługa zgłoszeń ofert do kampanii, programów specjalnych i oznaczeń Allegro

Aby wziąć udział w programie kampanii, musisz spełniać warunki , i zaakceptować regulamin. Korzystanie z zasobów API jest równoznaczne z akceptacją regulaminu.

Do kampanii możesz zgłaszać swoje oferty, dzięki temu wyświetlimy w nich specjalne oznaczenia. Przykładowo, jeśli dodasz ofertę do kampanii:

“Hit” to zyskasz oznaczenie HIT na liście ofert oraz na widoku oferty.
“Strefa Okazji” to zyskasz oznaczenie “Okazja” na liście ofert oraz przekreśloną cenę.
“Prowizja 0.5%” to cena oferty zostanie zmieniona na tę, którą podałeś w zgłoszeniu. Dodatkowo otrzymasz bonusy, które wynikają z regulaminu konkretnej kampanii, np. niższą prowizję od sprzedaży danego produktu.

Więcej na temat kampanii dowiesz się w artykule Strefa okazji i Prowizja nawet 0,5%.

Udostępniliśmy zasoby do obsługi zgłoszeń ofert do kampanii, programów specjalnych i oznaczeń Allegro:

GET /sale/badge-campaigns - pobierz listę dostępnych kampanii
POST /sale/badges - zgłoś ofertę do danego oznaczenia
GET /sale/badge-applications/{applicationId} - pobierz konkretne zgłoszenie
GET /sale/badge-applications - pobierz swoje zgłoszenia
GET /sale/badges - pobierz kampanie i oznaczenia przypisane do ofert.

pamiętaj, że wszystkie żądania musisz wykonywać jako zautoryzowany sprzedawca, który chce dodać oznaczenia do swoich ofert.

Jak zgłosić ofertę do kampanii, programów specjalnych i oznaczeń Allegro

GET /sale/badge-campaigns

Tym zasobem pobierzesz listę dostępnych kampanii, które możesz przypisać do ofert.

Przykładowy request:

curl -X GET \
‘https://api.allegro.pl/sale/badge-campaigns’ \
  -H 'Authorization: Bearer {token}' \
  -H 'Content-Type: application/vnd.allegro.beta.v1+json '

Przykładowy response:

{
 "badgeCampaigns": [
   {
     "id": "BARGAIN",               -- identyfikator kampanii
     "name": "Strefa okazji",       -- nazwa kampanii
     "type": "DISCOUNT",            -- typ kampanii, obecnie są dostępne trzy typy 
                                    STANDARD - dodamy do oferty oznaczenie na 
                                    liście ofert - np Hit, Nowość
                                    DISCOUNT - zmienimy cenę w ofercie, 
                                    a na liście ofert oprócz aktualnej ceny oferty 
                                    zaprezentujemy przekreśloną cenę rynkową, 
                                    którą podałeś w zgłoszeniu 
                                    SOURCING - zmienimy cenę w ofercie, 
                                    nie dodamy oznaczenia widocznego na platformie, 
                                    ale otrzymasz bonusy wynikające z regulaminu 
                                    konkretnej kampanii, np. niższe prowizje 
                                    od sprzedaży produktu.
     "eligibility": {               -- czy kampania jest dostępna dla zautoryzowanego 
                                    użytkownika
       "eligible": true,
       "refusalReasons": []         -- dlaczego użytkownik  nie kwalifikuje się do 
                                    udziału w danej kampanii
     },
     "application": {               -- okres przyjmowania zgłoszeń ofert do kampanii
       "type": "ALWAYS",            -- czas trwania, dostępne jest 5 wartości 
                                    ALWAYS (zawsze), SINCE (od danego dnia), 
                                    UNTIL (przedział czasowy), WITHIN (do danego dnia), 
                                    NEVER (nigdy)
       "from": null,
       "to": null
     },
     "publication": {               -- okres trwania oznaczenia 
       "type": "ALWAYS",            -- czas trwania dostępne jest 5 wartości 
                                    ALWAYS (zawsze), SINCE (od danego dnia), 
                                    UNTIL (przedział czasowy), WITHIN (do danego dnia), 
                                    NEVER (nigdy)
       "from": null,
       "to": null
     },
     "visibility": {                -- okres, w którym kampania jest widoczna w narzędziach 
                                    do zarządzania kampaniami (nie jest równy widoczności 
                                    oznaczenia kampanii na portalu). Zakres tych 
                                    dat pozwala stwierdzić, jak długo informacje 
                                    o kampanii będą dostępne na platformie
       "type": "ALWAYS",            -- czas trwania dostępne jest 5 wartości 
                                    ALWAYS (zawsze), SINCE (od danego dnia), 
                                    UNTIL (przedział czasowy), WITHIN (do danego dnia), 
                                    NEVER (nigdy)
       "from": null,
       "to": null
     }
   },
…
   ]
}

POST /sale/badges

Tym zasobem zgłosisz ofertę do wybranej kampanii.

Zgłoszenia, które nie spełniają wymagań danej kampanii zostaną przez nas odrzucone.

Przykładowy request:

curl -X POST \
‘https://api.allegro.pl/sale/badges’ \
-H 'Authorization: Bearer {token}' \
-H 'Content-Type: application/vnd.allegro.beta.v1+json' \
-d '{
    "campaign": {
        "id": "BARGAIN"             -- wymagane, identyfikator kampanii, jaką 
                                    chcesz dodać do oferty - zgodnie z 
                                    badgeCampaigns.id otrzymanym przez GET /sale/badge-campaigns
    },
    "offer": {
        "id": "6206378062"          -- wymagane, identyfikator oferty, do jakiej 
                                    chcesz dodać kampanię
    },
    "prices": {                     -- wymagane dla kampanii typu DISCOUNT
                                    i SOURCING, informacje o cenie, jaka 
                                    ma być widoczna na ofercie i o cenie rynkowej   
        "market": {                 -- wymagane dla kampanii typu DISCOUNT, 
                                    cena rynkowa za oferowany przedmiot, 
                                    wyświetlimy ją jako przekreśloną na liście ofert    
            "amount": "200.00",
            "currency": "PLN"
        },
        "bargain": {                -- wymagane dla kampanii typu DISCOUNT 
                                    i SOURCING, cena promocyjna oferty
            "amount": "180.00",
            "currency": "PLN"
        }
    },
    "purchaseConstraints": {        -- opcjonalne - ograniczenia zakupowe 
                                    na czas udziału w kampanii
        "limit": {
            "perUser": {
                "maxItems": "1"     -- ograniczenie liczby sztuk dostępnych 
                                    dla pojedynczego użytkownika
          }
        }
    }       
}'

Przykładowy response:

{
 "id": "8a457b8f-627d-43cf-8806-f06f8d13c306",  -- identyfikator zgłoszenia oferty do 
                                                kampanii
 "createdAt": "2019-06-26T10:22:35.225Z",       -- data utworzenia zgłoszenia
 "updatedAt": "2019-06-26T10:22:35.225Z",       -- data ostatniej zmiany w zgłoszeniu
 "campaign": {
   "id": "BARGAIN"                              -- identyfikator kampanii
 },
 "offer": {
   "id": "6206378062"                           --  identyfikator oferty, którą chcesz dodać 
                                                do kampanii
 },
 "prices": {                                    -- informacje o cenie, jaka ma być widoczna 
                                                na ofercie i o cenie rynkowej
   "bargain": {                                 -- cena promocyjna oferty   
     "amount": "180.00",
     "currency": "PLN"
   },
   "market": {                                  -- cena rynkowa za oferowany przedmiot, 
                                                wyświetlimy ją jako przekreśloną na liście ofert
     "amount": "200.00",
     "currency": "PLN"
   }
 },
 "purchaseConstraints": {                       -- opcjonalne - ograniczenia zakupowe 
                                                na czas udziału w kampanii
   "limit": {
     "perUser": {
       "maxItems": "1"                          -- ograniczenie liczby sztuk dostępnych 
                                                dla pojedynczego użytkownika
     }
   }
 },  
 "process": {
   "status": "REQUESTED",                       -- status zgłoszenia, dostępne są 3 
                                                wartości: REQUESTED (wniosek czeka na przetworzenie),  
                                                PROCESSED (wniosek został przetworzony 
                                                i dodaliśmy oznaczenie, które może 
                                                nie być jeszcze widoczne. Od tego momentu 
                                                możesz sprawdzić, czy oznaczenie jest już przypisane 
                                                do oferty zasobem GET sale/badges), 
                                                DECLINED (odrzuciliśmy wniosek)
   "rejectionReasons": []                           -- powód odrzucenia zgłoszenia
 }}

GET /sale/badge-applications/{applicationId}

Tym zasobem pobierzesz konkretne zgłoszenie oferty do kampanii i sprawdzisz jego status.

Przykładowy request:

curl -X GET \
‘https://api.allegro.pl/sale/badge-applications/8a457b8f-627d-43cf-8806-f06f8d13c306’ \
  -H 'Authorization: Bearer {token}' \
  -H 'Content-Type: application/vnd.allegro.beta.v1+json'

Przykładowy response:

{
 "id": "8a457b8f-627d-43cf-8806-f06f8d13c306",  -- identyfikator zgłoszenia oferty do 
                                                kampanii
 "createdAt": "2019-06-26T10:22:35.225Z",       -- data utworzenia zgłoszenia
 "updatedAt": "2019-06-26T10:22:35.225Z",       -- data ostatniej zmiany w zgłoszeniu
 "campaign": {
   "id": "BARGAIN"                              -- identyfikator kampanii
 },
 "offer": {
   "id": "6206378062"                           --  identyfikator oferty, którą chcesz dodać 
                                                do kampanii
 },
 "prices": {                                    -- informacje o cenie, jaka ma być widoczna 
                                                na ofercie i o cenie rynkowej
   "bargain": {                                 -- cena promocyjna oferty
     "amount": "180.00",
     "currency": "PLN"
   },
   "market": {                                  -- cena rynkowa za oferowany przedmiot, 
                                                wyświetlimy ją jako przekreśloną na liście ofert
     "amount": "200.00",
     "currency": "USD"
   }
 "process": {
   "status": "DECLINED",                        -- status zgłoszenia, dostępne są 3 
                                                wartości: REQUESTED (wniosek czeka na przetworzenie),  
                                                PROCESSED (wniosek został przetworzony 
                                                i dodaliśmy oznaczenie, które może 
                                                nie być jeszcze widoczne. Od tego momentu 
                                                możesz sprawdzić, czy oznaczenie jest już przypisane 
                                                do oferty zasobem GET sale/badges), 
                                                DECLINED (odrzuciliśmy wniosek)
   "rejectionReasons": [                            -- informacja na temat powodów odrzucenia 
                                                zgłoszenia
     {
       "code": "BB5",                           -- powód odrzucenia zgłoszenia
       "messages": [
         {
           "text": "Currency is not equal to ‘PLN’"
           "link": null
         }
       ]
     }
   ]
 }
}

GET /sale/badge-applications

Tym zasobem pobierzesz wszystkie zgłoszenia ofert do kampanii.

Przy wywołaniu musisz podać jeden z parametrów:

campaign.id - identyfikator kampanii
offer.id - identyfikator oferty.

Aby dostosować listę wyszukiwania do swoich potrzeb, możesz skorzystać z parametrów:

limit by określić liczbę zgłoszeń na liście (przyjmuje wartości od 1 do 1000, domyślnie 50)
offset by wskazać miejsce, od którego chcesz pobrać kolejną porcję danych (domyślnie 0).

Przykładowy request:

curl -X GET \
‘https://api.allegro.pl/sale/badge-applications?campaign.id=BARGAIN’ \
  -H 'Authorization: Bearer {token}' \
  -H 'Content-Type: application/vnd.allegro.beta.v1+json'

Przykładowy response:

{
 "badgeApplications": [                         -- lista zgłoszeń ofert do danego typu kampanii
{
 "id": "8a457b8f-627d-43cf-8806-f06f8d13c306",
 "createdAt": "2019-06-26T10:22:35.225Z",
 "updatedAt": "2019-06-26T10:22:35.225Z",
 "campaign": {
   "id": "BARGAIN"
 },
 "offer": {
   "id": "6206378062"
 },
 "prices": {
   "bargain": {
     "amount": "180.00",
     "currency": "PLN"
   },
   "market": {
     "amount": "200.00",
     "currency": "PLN"
   }
 },
 "process": {
   "status": "DECLINED",
   "rejectionReasons": [
     {
       "code": "BA1",
       "messages": [
         {
           "text": "Badge already exists"
         },
         {
           "text": "check terms & conditions",
           "link": "http://allegro.pl/xyz"
         }
       ]
     }
   ]
 }
}
]
}

GET /sale/badges

Tym zasobem sprawdzisz przypisane oznaczenia do swoich ofert.

Aby dostosować listę wyszukiwania do swoich potrzeb, możesz skorzystać z parametrów:

limit by określić liczbę zgłoszeń na liście (przyjmuje wartości od 1 do 1000, domyślnie 50)
offset by wskazać miejsce, od którego chcesz pobrać kolejną porcję danych (domyślnie 0).

Tym zasobem możesz sprawdzić przypisane oznaczenia do danej oferty, wystarczy, że wywołasz GET /sale/badges?offer.id={offerId}

Przykładowy request:

curl -X GET \
‘https://api.allegro.pl/sale/badges’ \
  -H 'Authorization: Bearer {token}' \
  -H 'Content-Type: application/vnd.allegro.beta.v1+json'

Przykładowy response:

 {
   "badges": [
     {
       "offer": {
         "id": "6206378062"
       },
       "campaign": {
         "id": "BARGAIN",
         "name": "Strefa okazji"
       },
       "publication": {
         "type": "ALWAYS"
       },
       "prices": {
         "market": {
           "amount": "19.99",
           "currency": "PLN"
         }
       },
       "process": {
         "status": "ACTIVE",                    -- status oznaczenia, dostępne wartości: 
                                                IN_VERIFICATION (wniosek jest w trakcie weryfikacji), 
                                                WAITING_FOR_PUBLICATION (oznaczenie jest w trakcie 
                                                publikacji w serwisie), ACTIVE (oznaczenie jest aktywne 
                                                i widoczne w serwisie), FINISHED (minął czas trwania 
                                                oferty w kampanii, administrator zakończył udział 
                                                oferty w kampanii), DECLINED (oznaczenie zostało 
                                                odrzucone i nie pojawi się w serwisie
         "rejectionReasons": []
       }
     }
   ]
 }

Jak testować kampanie w środowisku testowym

W środowisku testowym przygotowaliśmy dwie specjalne kampanie, dzięki którym możesz przetestować proces:

‘ZNIZKA_AUTOAKCEPTOWALNA’, ‘OZN_TEKST_AUTOAKCEPTOWALNE’ - oznaczenie automatycznie otrzyma status WAITING_FOR_PUBLICATION - jest w trakcie publikacji w serwisie.
‘ZNIZKA_AUTOODRZUCALNA’, ‘OZN_TEKST_AUTOODRZUCALNE’ - oznaczenie automatycznie otrzyma status DECLINED - zostało odrzucone i nie pojawi się w serwisie.

Oznaczenia ofert, które zgłosisz do pozostałych kampanii w środowisku testowym pozostaną w stanie IN_VERIFICATION (wniosek jest w trakcie weryfikacji).

Błędy i powody odrzucenia

Poniżej zamieściliśmy listę powodów dlaczego dane zgłoszenie może zostać przez nas odrzucone.

Kod błędu	Polski	Angielski
BB1	Konto nie spełnia kryteriów jakościowych	Account does not meet the criteria
BB2	Konto nie jest Kontem Firma	Account is not a Company account type
BB3	Brak campaign.id	Empty campaign.id
BB4	Brak offer.id	Empty offer.id
BB5	Waluta nie jest równa PLN	Currency is not equal to ‘PLN’
BB6	Wartość nie jest liczbą	Amount is not a valid number
BB7	Wartość jest mniejsza od 1	Amount is less than 1
BB8	Zgłoszenie nie istnieje	Application not found
BB9	Nieprawidłowa wartość parametru limit	Invalid limit parameter value
BB10	Nieprawidłowa wartość parametru offset	Invalid offset parameter value
BB11	Identyfikator oferty ma nieprawidłową wartość	Offer id is not valid
BB12	Zgłoszenie już istnieje	Application already exists
BA1	Oznaczenie już istnieje	Badge already exists
BA2	Cena zniżkowa lub sugerowana cena rynkowa nie są zdefiniowane	Bargain price or suggested market price not defined
BA3	Cena zniżkowa i cena rynkowa nie powinny być zdefiniowane	Bargain price and suggested market price should not be defined
BA4	Oferta nie istnieje	Offer not found
BA5	Cena oferty jest wyższa od sugerowanej ceny rynkowej	Current offer price is higher than suggested market price
BA6	Oferta została zakończona	Offer has ended
BA7	Konto nie istnieje	Account not found
BA8	W trakcie przetwarzania konto przestało być Kontem Firma	Account is no longer a Company account type
BA9	Konto nie jest właścicielem oferty	This account is not owner of the offer
BA10	Kampania nie istnieje	Campaign not found
BA11	Kampania zakończona	Campaign finished
BA12	Cena zniżkowa jest wyższa od ceny oferty	Bargain price is higher than current offer price
BA13	Cena zniżkowa jest równa sugerowanej cenie rynkowej	Bargain price is the same as market price
BA14	Cena zniżkowa jest taka sama lub wyższa od sugerowanej ceny rynkowej	Bargain price is the same or higher than suggested market price
BA15	Oznaczenie zostało już zaakceptowane	Badge was already accepted
BA16	Zniżka musi wynosić co najmniej 1%	Discount must be greater or equal to 1%
BA17	Oferta ma za mało sztuk	Offer has not enough items
BA18	Oferta mało atrakcyjna	Offer is not attractive enough
BA19	Opis lub tytuł nie spełnia wymagań	Offer’s title or description does not meet requirements
BA20	Miniaturka nie spełnia wymagań	Offer thumbnail does not meet requirements
BA21	Produkt w tej lub niższej cenie jest na innym Twoim koncie	Product with equal or lower price exists in your another account
BA22	Konto nie spełnia kryteriów jakości sprzedawcy	Account does not meet the seller quality criteria
BA24	Oferta posiada już inne oznaczenie obniżające cenę	A discount badge for this offer already exists
BA25	Wymagany kontakt z zespołem Strefy okazji pod adresem strefaokazji@allegro.pl	Contact required with Strefa okazji team at strefaokazji@allegro.pl
BA26	Oferta nie spełnia kryteriów danego oznaczenia	Offer does not meet requirements for this badge
BA27	Brak odpowiedniej metody dostawy	No suitable delivery method
BA28	Oferta nie spełnia kryteriów udziału w programie	Offer does not meet requirements for this program
BA29	Proponowana cena oferty jest niepoprawna. Właściwa cena maksymalna znajduje się liście produktów dla tej kampanii	The proposed offer price is incorrect. The maximum price is on the list of products for this campaign
BA30	Oferta posiada niepoprawny kod EAN. Właściwy EAN znajdziesz na liście produktów dla tej kampanii	The offer has an incorrect EAN code. You can find the correct EAN code on the list of products for this campaign
BA31	Oferta nie ma uzupełnionego kodu EAN. Właściwy kod EAN znajdziesz na liście produktów dla tej kampanii	The offer does not have EAN code. You can find the correct EAN code on the list of products for this campaign
BA32	Oferta jest wystawiona w złej kategorii	Offer was published in wrong category
BA33	Proponowana cena oferty jest niepoprawna. Właściwa cena maksymalna znajduje się liście produktów dla tej kampanii	The proposed offer price is incorrect. The maximum price is on the list of products for this campaign
BA34	Zgłoszenie nie zawiera informacji na temat proponowanej ceny oferty	The application does not contain information about the proposed reduced offer price
BA35	Oferta tego produktu nie posiada wystarczającej liczby sztuk, która jest określona na liście produktów dla tej kampanii	The offer of this product does not have required quantity of items which is specified on the list of product for this campaign
BA36	Sugerowana cena rynkowa nie może być zdefiniowana dla kampanii tego typu	Suggested market price must not be defined in this campaign type
BA37	Nie możemy obliczyć średniej ceny sprzedaży dla tej oferty. Brak wystarczającej liczby zakupów w ofercie	Average selling price can't be calculated for this offer. There is insufficient number of purchases
BA38	W tej kampani wymagamy odpowiedniej obniżki w stosunku do średniej ceny sprzedaży oferty. Podana cena oferty w kampanii jest za wysoka	Given bargain price is too high. Campaign requires corresponding price reduction from offer's average selling price
BA39	W tej kampani wymagamy odpowiedniej obniżki w stosunku do ceny oferty. Podana cena oferty w kampanii jest za wysoka	Given bargain price is too high. Campaign requires corresponding price reduction from offer's base price
BA40	Wprowadzona cena przed obniżką jest zawyżona. Podana cena nie może być wyższa, niż średnia cena sprzedaży oferty	Given market price is too high. Campaign requires corresponding price reduction from offer's average selling price
BA41	Wprowadzona cena przed obniżką jest zawyżona. Podana cena nie może być wyższa, niż cena sprzedaży oferty	Given market price is too high. Campaign requires corresponding price reduction from offer's base price
BA42	Oferta nie ma oznaczenia Smart!. W kampanii mogą brać udział tylko oferty oznaczone Smart!	Offer does not meet requirements of Smart! service. Only offers meeting Smart! criteria can participate in the campaign
BA43	Wartość parametru "Stan" w ofercie jest inna niż "Nowy"	Offer parameter "Condition" is different than "New"
BA44	Konto nie spełnia wymaganych kryteriów jakościowych	Account does not meet the required quality criteria
BA45	Limit zgłoszeń dla tej oferty został przekroczony. Ponowne zgłoszenie do tej kampanii będzie możliwe za 24 godziny.	The limit of applications for this offer has been exceeded. You can re-apply to this campaign after 24 hours.
BB0	Błąd podczas przetwarzania zgłoszenia	Error during processing, please try again later

Changelog

Jak przypisać ofertę do kampanii

Wersja

2019-07-31 Zasoby do obsługi zgłoszeń ofert do kampanii, programów specjalnych i oznaczeń Allegro w wersji beta

Jak przypisać ofertę do kampanii

Obsługa zgłoszeń ofert do kampanii, programów specjalnych i oznaczeń Allegro

Jak zgłosić ofertę do kampanii, programów specjalnych i oznaczeń Allegro

GET /sale/badge-campaigns

POST /sale/badges

GET /sale/badge-applications/{applicationId}

GET /sale/badge-applications

GET /sale/badges

Jak testować kampanie w środowisku testowym

Błędy i powody odrzucenia

ChangelogJak przypisać ofertę do kampanii

Changelog

Jak przypisać ofertę do kampanii