Aby wziąć udział w programie kampanii, musisz spełniać warunki kampanii, do której się zgłaszasz i zaakceptować regulamin dostępny w zasobie badge-campaign. Korzystanie z zasobów API jest równoznaczne z akceptacją regulaminu.
Obsługa zgłoszeń ofert do kampanii, programów specjalnych i oznaczeń Allegro
Możesz dodać ofertę do kampanii:
- “Okazja”, dzięki której zyskasz oznaczenie “Okazja” na liście ofert oraz przekreśloną cenę
lub skorzystać z kampanii sezonowych i cyklicznych:
- Smart! Week,
- Allegro Days,
których nazwy zawierają zakres dat trwania kampanii, np. "Allegro Days 08.04.2024-14.04.2024".
Więcej na temat kampanii dowiesz się w artykule o Strefie okazji.
Jak zgłosić ofertę do kampanii, programów specjalnych i oznaczeń Allegro
Lista dostępnych kampanii
Za pomocą GET /sale/badge-campaigns 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.public.v1+json'
Przykładowy response:
{
“badgeCampaigns”: [
{
“id”: “BARGAIN”, – identyfikator kampanii
“name”: “Strefa okazji”, – nazwa kampanii
"marketplace": {
"id": "allegro-pl" – identyfikator serwisu (np. allegro-pl, allegro-cz, allegro-sk)
},
“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
kanałem API. Może różnić się od okresu przyjmowania
zgłoszeń z poziomu Mojego Allegro
“type”: “ALWAYS”, – czas trwania, dostępne jest 5 wartości
ALWAYS (zawsze), SINCE (od danego dnia),
UNTIL (do danego dnia), WITHIN (przedział czasowy),
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 (do danego dnia), WITHIN (przedział czasowy),
NEVER (nigdy)
“from”: null,
“to”: null
},
“visibility”: { – okres, w którym kampania jest widoczna w narzędziach
do zarządzania kampaniami na API (nie jest równy widoczności
oznaczenia kampanii na portalu). Może różnić się od
okresu widoczności w Moim Allegro. 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 (do danego dnia), WITHIN (przedział czasowy),
NEVER (nigdy)
“from”: null,
“to”: null
},
“regulationsLink”: “https://na.allegro.pl/regulamin-kampania-BARGAIN" – link do regulaminu kampanii
},
…
]
}
Zgłoś ofertę do kampanii
Za pomocą POST /sale/badges zgłosisz ofertę do wybranej kampanii.
Przykładowy request:
curl -X POST \
'https://api.allegro.pl/sale/badges' \
-H 'Authorization: Bearer {token}' \
-H 'Content-Type: application/vnd.allegro.public.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
“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; tylko
dla kampanii typu DISCOUNT i SOURCING
}
}
}
}'
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; w tym polu
zwrócimy wyliczoną przez nas najniższą cenę sprzedaży
w ofercie z ostatnich 30 dni. 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 - od tego
momentu możesz sprawdzić status przypisana
oznaczenia do oferty zasobem GET sale/badges),
DECLINED (wniosek został odrzucony)
“rejectionReasons”: [] – powód odrzucenia zgłoszenia
}}
Pobierz dane zgłoszenie
Za pomocą GET /sale/badge-applications/{applicationId} 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.public.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 - od tego
momentu możesz sprawdzić status przypisana
oznaczenia do oferty zasobem GET sale/badges),
DECLINED (wniosek został odrzucony)
“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
}
]
}
]
}
}
Pobierz swoje zgłoszenia
Za pomocą GET /sale/badge-applications pobierzesz wszystkie zgłoszenia ofert do kampanii.
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 (przyjmuje wartości od 0 do nieskończoności, 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.public.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"
}
]
}
]
}
}
]
}
Kampanie przypisane do ofert
Za pomocą GET /sale/badges 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 (przyjmuje wartości od 0 do nieskończoności, domyślnie 0).
Przykładowy request:
curl -X GET \
'https://api.allegro.pl/sale/badges' \
-H 'Authorization: Bearer {token}' \
-H 'Content-Type: application/vnd.allegro.public.v1+json'
Przykładowy response:
{
“badges”: [
{
“offer”: {
“id”: “6206378062”
},
“campaign”: {
“id”: “BARGAIN”,
“name”: “Strefa okazji”
},
“publication”: {
“type”: “ALWAYS”
},
“prices”: { – informacja cenowa dotycząca oferowanego przedmiotu,
zwracana tylko dla kampanii wymagających podania
ceny rynkowej na etapie zgłoszenia
“market”: {
“amount”: “19.99”,
“currency”: “PLN”
},
"subsidy": {
"targetPrice": { - cena widoczna dla klienta na platformie
"amount": "9.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 lub administrator zakończył udział
oferty w kampanii), DECLINED (oznaczenie zostało
odrzucone i nie pojawi się w serwisie
“rejectionReasons”: []
}
}
]
}
Zmiana ceny i zakończenie oznaczenia
Zmiana ceny oferty w kampanii
Za pomocą PATCH /sale/badges/offers/{offerId}/campaigns/{campaignId} zlecisz operację zmiany ceny oferty w kampanii.
Przykładowy request:
curl -X PATCH \
'https://api.allegro.pl/sale/badges/offers/12345678/campaigns/BARGAIN' \
-H 'Authorization: Bearer {token}' \
-H 'Content-Type: application/vnd.allegro.public.v1+json' \
-d '{
"prices": {
"bargain": {
"value": {
"amount": "9.99",
"currency": "PLN"
}
}
}
}'
Przykładowy response:
{
"id": "154179f0-ed4c-4b84-9260-302d2dec3801" - identyfikator operacji zmiany ceny oferty
w kampanii
}
Zakończenie oznaczenia oferty w kampanii
Za pomocą PATCH /sale/badges/offers/{offerId}/campaigns/{campaignId} zlecisz też operację zakończenia oznaczenia oferty w kampanii.
Przykładowy request:
curl -X PATCH \
'https://api.allegro.pl/sale/badges/offers/12345678/campaigns/BARGAIN' \
-H 'Authorization: Bearer {token}' \
-H 'Content-Type: application/vnd.allegro.public.v1+json' \
-d '{
"process": {
"status": "FINISHED"
}
}'
Przykładowy response:
{
"id": "154179f0-ed4c-4b84-9260-302d2dec3801" - identyfikator operacji zakończenia
oznaczenia oferty w kampanii
}
Sprawdzenie statusu operacji
Za pomocą GET /sale/badge-operations/{operationId} sprawdzisz status wykonania operacji zmiany ceny lub zakończenia oznaczenia.
Przykładowy request:
curl -X GET \
'https://api.allegro.pl/sale/badge-operations/154179f0-ed4c-4b84-9260-302d2dec3801' \
-H 'Authorization: Bearer {token}' \
-H 'Content-Type: application/vnd.allegro.public.v1+json'
Przykładowy response:
{
"id": "154179f0-ed4c-4b84-9260-302d2dec3801",
"createdAt": "2019-05-16T12:49:17.347Z",
"updatedAt": "2019-05-16T12:49:17.530Z",
"campaign": {
"id": "BARGAIN"
},
"offer": {
"id": "12345678"
},
"process": {
"status": "PROCESSED",
"rejectionReasons": []
}
}
Jak testować kampanie
W środowisku testowym skonfigurowaliśmy kampanię ’SANDBOX_TEST_CAMPAIGN’, aby można było samodzielnie sprawdzić proces.
Zgłoszenie z obniżką większą bądź równą 40% oraz mniejszą bądź równą 60% w stosunku do ceny przekreślonej, zostanie automatycznie zaakceptowane.
Zgłoszenie z obniżką mniejszą niż 40% lub większą niż 60% w stosunku do ceny przekreślonej, zostanie automatycznie odrzucone.
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 | Polski Konto nie spełnia kryteriów jakościowych. |
Angielski The account does not meet the quality criteria. |
BB2 | Polski Konto nie jest Kontem Firma. |
Angielski The account is not a Business Account. |
BB3 | Polski Brak pola campaign.id. |
Angielski Empty campaign.id field. |
BB4 | Polski Brak pola offer.id. |
Angielski Empty offer.id field. |
BB5 | Polski Waluta nie jest równa [PLN]. |
Angielski Currency is not supported. |
BB6 | Polski Jedna z wartości liczbowych nie jest liczbą. |
Angielski One of the numerical values is not a number. |
BB7 | Polski Jedna z wartości liczbowych jest liczbą mniejszą od 1. |
Angielski One of the numeric values is less than 1. |
BB8 | Polski Zgłoszenie nie istnieje. |
Angielski Submission does not exist. |
BB9 | Polski Nieprawidłowa wartość parametru [limit]. |
Angielski Invalid [limit] parameter value. |
BB10 | Polski Nieprawidłowa wartość parametru [offset]. |
Angielski Invalid [offset] parameter value. |
BB11 | Polski Identyfikator oferty ma nieprawidłową wartość. |
Angielski Offer id is not valid. |
BB12 | Polski Zgłoszenie już istnieje. |
Angielski The operation already exists and has a REQUESTED status. Please wait until the status changes to PROCESSED or DECLINED. |
BB13 | Polski Zbyt dużo żądań dla tego konta. |
Angielski Too many requests from this account. |
BB14 | Polski Operacja nie istnieje. |
Angielski Operation not found. |
BB15 | Polski Pole process jest dozwolone jedynie dla operacji zakończenia oznaczenia. Pole prices jest dozwolone jedynie dla operacji zmiany ceny. |
Angielski The process field is only allowed for the finish badge operation. The prices field is only allowed for the price change operation. |
BB16 | Polski Pole process jest wymagane jedynie dla operacji zakończenia oznaczenia. Pole prices jest wymagane jedynie dla operacji zmiany ceny. |
Angielski The process field is required for the finish badge operation. The prices field is required for the price change operation. |
BB17 | Polski Wartość pola process.status musi być równa FINISHED. |
Angielski The process.status field must be equal to FINISHED. |
BA1 | Polski Oznaczenie już istnieje. |
Angielski Badge already exists. |
BA2 | Polski Cena zniżkowa lub sugerowana cena rynkowa nie są zdefiniowane. |
Angielski The discount price or suggested market price is not defined |
BA3 | Polski Cena zniżkowa i cena rynkowa nie powinny być zdefiniowane. |
Angielski Bargain price and suggested market price should not be defined. |
BA4 | Polski Oferta nie istnieje. |
Angielski This offer does not exist. |
BA5 | Polski Aktualna cena oferty jest wyższa od sugerowanej ceny rynkowej. |
Angielski Current offer price is higher than suggested market price. |
BA6 | Polski Oferta została zakończona. |
Angielski Offer has ended. |
BA7 | Polski Konto nie istnieje. |
Angielski Account not found. |
BA8 | Polski W trakcie przetwarzania konto przestało być Kontem Firma. |
Angielski Account is no longer a Company account type. |
BA9 | Polski Konto nie jest właścicielem oferty. |
Angielski This account is not the owner of the offer. |
BA10 | Polski Kampania nie istnieje. |
Angielski This campaign does not exist. |
BA11 | Polski Kampania została zakończona. |
Angielski Campaign has ended. |
BA12 | Polski Cena zniżkowa jest wyższa od aktualnej ceny oferty. |
Angielski Bargain price is higher than current offer price. |
BA13 | Polski Cena zniżkowa jest równa sugerowanej cenie rynkowej. |
Angielski Bargain price is the same as suggested market price. |
BA14 | Polski Cena zniżkowa jest taka sama lub wyższa od sugerowanej ceny rynkowej. |
Angielski Bargain price is the same or higher than suggested market price. |
BA15 | Polski Oznaczenie zostało już zaakceptowane. |
Angielski Badge has already been accepted. |
BA16 | Polski Zniżka musi wynosić co najmniej 1% w stosunku do sugerowanej ceny rynkowej. |
Angielski Discount must be greater or equal to 1% to the suggested market price. |
BA17 | Polski Oferta ma za mało sztuk. |
Angielski Offer has not enough items. |
BA18 | Polski Oferta jest mało atrakcyjna. |
Angielski Offer is not attractive enough. |
BA19 | Polski Opis lub tytuł nie spełnia wymagań. |
Angielski Offer’s title or description does not meet requirements. |
BA20 | Polski Miniaturka nie spełnia wymagań. |
Angielski Offer’s thumbnail does not meet requirements. |
BA21 | Polski Produkt w tej lub niższej cenie jest na innym Twoim koncie. |
Angielski Product with equal or lower price exists in your another account. |
BA22 | Polski Konto nie spełnia kryteriów - minimum 98% pozytywnych ocen z 3 ostatnich miesięcy. |
Angielski Account does not meet the criteria - minimum 98% positive rates from last 3 months. |
BA24 | Polski Oferta posiada już inne oznaczenie obniżające cenę. |
Angielski A discount badge for this offer already exists. |
BA25 | Polski Wymagany kontakt z zespołem Strefy okazji pod adresem [strefaokazji@allegro.pl]. |
Angielski Contact required with Strefa okazji team at [strefaokazji@allegro.pl]. |
BA26 | Polski Oferta nie spełnia kryteriów danego oznaczenia. |
Angielski This offer does not meet the badge criteria. |
BA27 | Polski Brak odpowiedniej metody dostawy. |
Angielski No suitable delivery method. |
BA28 | Polski Oferta nie spełnia kryteriów udziału w programie. |
Angielski Offer does not meet requirements for this program. |
BA29 | Polski Proponowana cena zniżkowa oferty jest niepoprawna. Właściwa cena maksymalna znajduje się liście produktów dla tej kampanii. |
Angielski The proposed bargain price is incorrect. The maximum price is on the list of products for this campaign. |
BA30 | Polski Oferta posiada niepoprawny kod EAN. Właściwy kod EAN znajdziesz na liście produktów dla tej kampanii. |
Angielski The offer has an incorrect EAN code. You can find the correct EAN code on the list of products for this campaign. |
BA31 | Polski Oferta nie ma uzupełnionego kodu EAN. Właściwy kod EAN znajdziesz na liście produktów dla tej kampanii. |
Angielski The offer does not have EAN code. You can find the correct EAN code on the list of products for this campaign. |
BA32 | Polski Oferta jest wystawiona w złej kategorii. |
Angielski Offer was published in wrong category. |
BA33 | Polski Proponowana cena zniżkowa oferty jest niepoprawna. Właściwa cena maksymalna znajduje się liście produktów dla tej kampanii. |
Angielski The proposed bargain price is incorrect. The maximum price is on the list of products for this campaign. |
BA34 | Polski Zgłoszenie nie zawiera informacji na temat ceny zniżkowej. |
Angielski The application does not contain information about bargain price. |
BA35 | Polski Oferta tego produktu nie posiada wystarczającej liczby sztuk, która jest określona na liście produktów dla tej kampanii. |
Angielski The offer of this product does not have required quantity of items which is specified on the list of product for this campaign. |
BA36 | Polski Sugerowana cena rynkowa nie może być zdefiniowana dla kampanii tego typu. |
Angielski Suggested market price must not be defined in this campaign type. |
BA37 | Polski Nie możemy obliczyć średniej ceny sprzedaży dla tej oferty. Brak wystarczającej liczby zakupów w ofercie. |
Angielski Average selling price cannot be calculated for this offer. There is insufficient number of purchases. |
BA38 | Polski W tej kampanii wymagamy odpowiedniej obniżki w stosunku do średniej ceny sprzedaży oferty. Podana cena zniżkowa w kampanii jest za wysoka. |
Angielski Given bargain price is too high. Campaign requires corresponding price reduction from offer’s average selling price. |
BA39 | Polski W tej kampanii wymagamy odpowiedniej obniżki w stosunku do ceny oferty. Podana cena zniżkowa w kampanii jest za wysoka. |
Angielski Given bargain price is too high. Campaign requires corresponding price reduction from offer’s base price. |
BA40 | Polski Wprowadzona sugerowana cena rynkowa jest zawyżona. Podana cena nie może być wyższa niż średnia cena sprzedaży oferty. |
Angielski Given market price is too high. Campaign requires corresponding price reduction from offer’s average selling price. |
BA41 | Polski Wprowadzona sugerowana cena rynkowa jest zawyżona. Podana cena nie może być wyższa niż cena sprzedaży oferty. |
Angielski Given market price is too high. Campaign requires corresponding price reduction from offer’s base price. |
BA42 | Polski Oferta nie ma oznaczenia [Smart!]. W kampanii mogą brać udział tylko oferty z tym oznaczeniem. |
Angielski Offer does not meet requirements of [Smart!] program. Only offers meeting [Smart!] criteria can participate in this campaign. |
BA43 | Polski Wartość parametru [Stan] w ofercie jest inna niż [Nowy]. |
Angielski Offer’s parameter [Condition] is different than [New]. |
BA44 | Polski Konto nie spełnia wymaganych kryteriów jakościowych. |
Angielski Account does not meet the required quality criteria. |
BA45 | Polski Limit zgłoszeń dla tej oferty został przekroczony. Ponowne zgłoszenie do tej kampanii będzie możliwe za 24 godziny. |
Angielski The limit of applications for this offer has been exceeded. You can re-apply to this campaign after 24 hours. |
BA46 | Polski Oferta jest wystawiona w kategorii, która nie spełnia kryteriów kampanii. |
Angielski The offer is listed in a category that does not meet the criteria of the campaign. |
BA47 | Polski Oferta nie spełnia kryteriów kampanii. Została wystawiona więcej niż 6 miesięcy temu. |
Angielski The offer does not meet the criteria of the campaign. It was listed more than 6 months ago. |
BA48 | Polski Oferta nie spełnia kryteriów kampanii. Oferta nie jest opublikowana. |
Angielski The offer does not meet the criteria of the campaign. It has not been published. |
BA49 | Polski W tej kampanii wymagamy odpowiedniej obniżki w stosunku do sugerowanej ceny rynkowej oferty. Proponowana obniżka ceny jest za niska. |
Angielski Given bargain discount is too low. Campaign requires corresponding price reduction from offer’s suggested market price. |
BA50 | Polski W tej kampanii wymagamy odpowiedniej obniżki w stosunku do sugerowanej ceny rynkowej oferty. Proponowana obniżka ceny jest zbyt wysoka. |
Angielski Given bargain discount is too high. Campaign requires corresponding price reduction from offer’s suggested market price. |
BA51 | Polski Oferta jest zarchiwizowana. |
Angielski Offer is archived. |
BA52 | Polski Oferta jest nieaktywna. |
Angielski Offer is inactive. |
BA53 | Polski Liczba sprzedanych sztuk przedmiotów na ofercie przez ostatnie 30 dni jest niewystarczająca. |
Angielski The number of offer items sold over the last 30 days is insufficient. |
BA54 | Polski Twój produkt znajduje się na liście produktów objętych akcją promocyjną innej aktywnej kampanii. |
Angielski Your product is included in the promotional campaign list of another active campaign. |
BA57 | Polski Oferta przestała być atrakcyjna cenowo względem cen rynkowych i cen w serwisie Allegro.pl. |
Angielski The offer price is not attractive enough compared to the market and Allegro Prices. |
BA58 | Polski Wymagane jest powiązanie oferty z produktem. |
Angielski It is required to link the offer with a product. |
BA59 | Polski Oferta odrzucona na wniosek sprzedającego. |
Angielski The offer rejected at the request of the seller. |
BA60 | Polski Operacja niedozwolona na oznaczeniu w kampanii standardowej. |
Angielski Operation on standard badge not allowed. |
BA61 | Polski Status oznaczenia nie pozwala na edycję. |
Angielski Operation not allowed because of badge status. |
BA62 | Polski Nie odnaleziono oznaczenia. |
Angielski Badge not found. |
BA63 | Polski Nie można zmodyfikować ceny zniżkowej. |
Angielski Bargain price is not editable. |
BA64 | Polski Dotychczasowa kampania została zakończona, zgłoś ofertę na nowych zasadach. |
Angielski The current campaign has been ended, submit your offer on the new terms. |
BA65 | Polski Oferta jest dostępna w sprzedaży z niższą ceną lub nie spełnia warunku odpowiedniej obniżki. |
Angielski The offer is available at a lower price or does not meet the condition of appropriate price reduction. |
BA66 | Polski Podana cena promocyjna spełnia wymagania. |
Angielski Given promotional price meets campaign requirements. |
BA67 | Polski Oferta musi być skierowana wyłącznie do klientów biznesowych. |
Angielski The offer must be directed to business customers only. |
BA68 | Polski Oferta jest skierowana wyłącznie do klientów biznesowych. |
Angielski The offer is directed to business customers only. |
BA69 | Polski Niedozwolona operacja na etykiecie niestandardowego oznaczenia. |
Angielski Operation on custom label badge not allowed |
BA70 | Polski Próba zmiany ceny oferty, która nie jest w odpowiednim formacie. |
Angielski Trying to change price for offer that is NOT in BUY_NOW format. |
BA71 | Polski Cena oferty jest wyższa niż maksymalna cena dotowana. |
Angielski Offer price is higher than max subsidy price. |
BA72 | Polski Cena oferty jest niższa bądź równa docelowej cenie dotowanej. |
Angielski Offer price is lower or equal to subsidy target price. |
BA73 | Polski Kategoria nie istnieje. |
Angielski Category not found. |
BA74 | Polski Osiągnięto datę końca. Oznaczenie zostało zakończone. |
Angielski The end date has been reached. The badge has ended. |
BA75 | Polski Oznaczenie nie znajduje się w kampanii. |
Angielski Badge is not in the campaign. |
BA76 | Polski Modyfikacja oznaczania dla tej kampanii jest niedozwolone. |
Angielski Modifying badge from this campaign is not allowed. |
BA77 | Polski Oznaczenie jest już w stanie końcowym. |
Angielski Badge is already in terminable state. |
BA78 | Polski Data początku oznaczenia jest później niż data zakończenia. |
Angielski Badge start date is after its end date. |
BA79 | Polski Nie można zmodyfikować kampanii. |
Angielski Campaign is not editable. |
BA80 | Polski Oferta nie jest zniżką. |
Angielski Offer is not a bargain. |
BA81 | Polski Oferta nie jest aktywna. |
Angielski Offer is inactive. |
BA82 | Polski Oferta nie jest wielosztuką. |
Angielski Offer is not a multipack |
BA83 | Polski Oferta jest już w panelu administracyjnym. |
Angielski Offer is already in admin. |
BA84 | Polski W niestandardowym oznaczeniu musi zostać zdefiniowana etykieta. |
Angielski Custom label field must be defined in custom label badge type. |
BA85 | Polski Etykieta niestandardowego oznaczenia nie może zawierać ceny. |
Angielski Custom label must not have prices defined. |
BA86 | Polski Żądane pochodzenie nie jest wspierane przez niestandardowe oznaczenie. |
Angielski Requested origin is not supported in custom label badge. |
BA87 | Polski Limit zakupów na użytkownika w tej ofercie jest mniejszy niż 1. |
Angielski The purchase limit per user is less than 1 in this offer. |
BA88 | Polski Niepoprawny stan oznaczenia. |
Angielski Wrong badge status. |
BB0 | Polski Wystąpił błąd podczas przetwarzania zgłoszenia. Prosimy spróbować ponownie później. |
Angielski Error occurred during application processing. Please try again later. |
Allegro Ceny - jak zarządzać zgodami na uczestnictwo w programie
Jak pobrać aktualne zgody dla oferty
Użyj GET /sale/allegro-prices-offer-consents/{offerId}, gdzie jako offerId wskaż numer konkretnej oferty.
Przykładowy request:
curl -X GET \
'https://api.allegro.pl/sale/allegro-prices-offer-consents/993723618' \
-H 'Accept: application/vnd.allegro.public.v1+json' \
-H 'Content-Type: application/vnd.allegro.public.v1+json'
Przykładowy response:
{
"status": "ALLOWED", - status zgody dla serwisu bazowego oferty
"additionalMarketplaces": { - status zgody dla serwisów dodatkowych
"allegro-cz": {
"status": "ALLOWED"
},
"allegro-xy": {
"status": "DENIED"
}
}
}
Jak zaktualizować zgodę dla oferty
Zrobisz to za pomocą PUT /sale/allegro-prices-offer-consents/{offerId}. Jako offerId wskaż konkretny numer oferty.
Zgodę na uczestnictwo w programie Allegro Ceny możesz wyrazić dla serwisu bazowego oferty lub/i serwisów dodatkowych.
Pamiętaj:
- w polu “status” przekażesz status zgody tylko dla serwisu bazowego oferty;
- pole “status” jest opcjonalne;
- w polu “additionalMarketplaces” określisz status zgody dla serwisów dodatkowych;
- jeżeli przekażesz pole “additionalMarketplaces” to musisz określić w nim status zgody dla minimum jednego serwisu dodatkowego;
- jedno z pól - “status” lub “additionalMarketplaces” musisz zawsze przekazać w wywołaniu.
Przykładowy request:
curl -X PUT \
'https://api.allegro.pl/sale/allegro-prices-offer-consents/993723618'
-H 'Accept: application/vnd.allegro.public.v1+json' \
-H 'Content-Type: application/vnd.allegro.public.v1+json' \
- d'{
"status": "ALLOWED", - status zgody dla serwisu bazowego oferty
"additionalMarketplaces": { - status zgody dla serwisów dodatkowych
"allegro-cz": {
"status": "ALLOWED"
},
"allegro-xy": {
"status": "DENIED"
}
}
}'
Przykładowy response:
{
"status": "ALLOWED", - status zgody dla serwisu bazowego oferty
"additionalMarketplaces": { - status zgody dla serwisów dodatkowych
"allegro-cz": {
"status": "ALLOWED"
},
"allegro-xy": {
"status": "DENIED"
}
}
}
Jak pobrać aktualne uprawnienia dla konta
Skorzystaj w tym celu z GET /sale/allegro-prices-account-eligibility. W odpowiedzi otrzymasz:
- statusy zgód:
- w polu “consent” - dla serwisu bazowego,
- w polu “additionalMarketplaces.[].consent” - dla serwisów dodatkowych,
- informację, czy konto kwalifikuje się do uczestnictwa w programie:
- w polu “qualification.status” - dla serwisu bazowego,
- w polu “additionalMarketplaces.[].qualification.status” - dla serwisów dodatkowych.
Kryteria kwalifikacji znajdziesz na stronie dla sprzedających.
Przykładowy request:
curl -X GET \
'https://api.allegro.pl/sale/allegro-prices-account-eligibility' \
-H 'Accept: application/vnd.allegro.public.v1+json' \
-H 'Content-Type: application/vnd.allegro.public.v1+json'
Przykładowy response:
{
"consent": "ALLOWED", - status zgody dla serwisu bazowego
"qualification": {
"status": "QUALIFIED" - informacja, czy konto kwalifikuje się do programu
},
"additionalMarketplaces": { - status zgody dla serwisów dodatkowych
"allegro-cz": {
"consent": "ALLOWED",
"qualification": {
"status": "QUALIFIED"
}
},
"allegro-xy": {
"consent": "DENIED",
"qualification": {
"status": "DISQUALIFIED"
}
}
}
}
Jak zaktualizować zgodę dla konta
Zrobisz to za pomocą PUT /sale/allegro-prices-account-consent. Zgodę na uczestnictwo konta w programie Allegro Ceny możesz wyrazić dla serwisu bazowego lub/i serwisów dodatkowych.
Pamiętaj:
- w polu “status” przekażesz status zgody tylko dla serwisu bazowego;
- pole “status” jest opcjonalne;
- w polu “additionalMarketplaces” określisz status zgody dla serwisów dodatkowych;
- jeżeli przekażesz pole “additionalMarketplaces” to musisz określić w nim status zgody dla minimum jednego serwisu dodatkowego;
- jedno z pól - “status” lub “additionalMarketplaces” musisz zawsze przekazać w wywołaniu.
Przykładowy request:
curl -X PUT \
'https://api.allegro.pl/sale/allegro-prices-account-consent’ \
-H 'Authorization: Bearer {token}' \
-H 'Accept: application/vnd.allegro.public.v1+json' \
-H 'Content-Type: application/vnd.allegro.public.v1+json' \
-d '{
"status": "ALLOWED", - status zgody dla serwisu bazowego
"additionalMarketplaces": { - status zgody dla serwisów dodatkowych
"allegro-cz": {
"status": "ALLOWED"
},
"allegro-xy": {
"status": "DENIED"
}
}
}'
Przykładowy response:
{
"consent": "ALLOWED", - status zgody dla serwisu bazowego
"qualification": {
"status": "QUALIFIED" - informacja, czy konto kwalifikuje się do programu
},
"additionalMarketplaces": { - status zgody dla serwisów dodatkowych
"allegro-cz": {
"consent": "ALLOWED",
"qualification": {
"status": "QUALIFIED"
}
},
"allegro-xy": {
"consent": "DENIED",
"qualification": {
"status": "DISQUALIFIED"
}
}
}
}
AlleObniżka - jak zarządzać udziałem w programie
AlleObniżka to cykliczny program, dzięki któremu możesz zaoferować klientom wybrane produkty w atrakcyjnych cenach. Pozwala wypromować oferty i zwiększyć sprzedaż bez dodatkowych opłat. Każda edycja trwa jeden tydzień. Program AlleObniżka możemy też uruchomić w ramach okazjonalnych kampanii, takich jak Allegro Days, BlackWeek czy SmartWeek.
Lista dostępnych kampanii AlleObniżka
Za pomocą GET /sale/alle-discount/campaigns pobierzesz listę dostępnych kampanii w ramach programu AlleObniżka.
Przykładowy request:
curl -X GET \
'https://api.allegro.pl/sale/alle-discount/campaigns' \
-H 'Authorization: Bearer {token}' \
-H 'Accept: application/vnd.allegro.public.v1+json' \
-H 'Content-Type: application/vnd.allegro.public.v1+json'
Przykładowy response:
{
"alleDiscountCampaigns":[
{
"id": "ALLEOBNIZKA_20240827_PL", // identyfikator kampanii
"name": "AlleObniżka 27.08-10.09.2024", // nazwa kampanii
"type": "SOURCING", // typ kampanii, dostępne wartości: SOURCING - kampania bez dodatkowych wymogów, DISCOUNT - kampania z wymogiem ceny niższej niż cena z ostatnich 30 dni.
"visibility": { // okres widoczności kampanii w Moje Allegro
"type": "WITHIN", // typ widoczności, dostępna wartość: WITHIN - w okresie dostępności
"from": "2024-08-22T22:00:00Z", // data początkowa
"to": "2024-11-09T23:00:00Z" // data końcowa
},
"application": { // okres zgłaszania ofert do kampanii
"type": "WITHIN", // typ widoczności, dostępna wartość: WITHIN
"from": "2024-08-22T22:00:00Z", // data początkowa
"to": "2024-09-09T22:00:00Z" // data końcowa
},
"publication": { // okres widoczności obniżonej ceny w ofercie
"type": "WITHIN", // typ widoczności, dostępna wartość: WITHIN
"from": "2024-08-26T22:00:00Z", // data początkowa
"to": "2024-09-09T22:00:00Z" // data końcowa
},
"marketplace": {
"id": "allegro-pl" // identyfikator serwisu, dla którego kampania jest dostępna
}
},
{
"id": "ALLDEALS_ALLEOBNIZKA_202409_PL",
"name": "Allegro Days AlleObniżka 02-08.09.2024",
"type": "DISCOUNT",
"visibility": {
"type": "WITHIN",
"from": "2024-08-26T13:00:00Z",
"to": "2024-11-08T22:59:00Z"
},
"application": {
"type": "WITHIN",
"from": "2024-08-26T13:00:00Z",
"to": "2024-09-08T21:59:00Z"
},
"publication": {
"type": "WITHIN",
"from": "2024-09-01T22:00:00Z",
"to": "2024-09-08T21:59:00Z"
},
"marketplace": {
"id": "allegro-pl"
}
}
],
"count":2 // łączna liczba kampanii
}
Lista ofert kwalifikujących się do kampanii
Za pomocą GET /sale/alle-discount/{campaignId}/eligible-offers pobierzesz listę swoich ofert kwalifikujących się do wybranej kampanii AlleObniżka. Przy wywołaniu musisz podać parametr campaignId (identyfikator kampanii).
Aby dostosować listę do swoich potrzeb, możesz skorzystać z parametrów:
- limit - maksymalna liczba ofert na liście, max 200;
- offset - by wskazać miejsce, od którego chcesz pobrać kolejną porcję danych;
- meetsConditions - jeżeli “true” to zwrócimy listę tylko ofert spełniających kryteria danej kampanii;
- offerId - identyfikator wybranej oferty.
Ważne! Aktualną listę produktów, które kwalifikują się do programu AlleObniżka, znajdziesz na stronie Pomocy Allegro.
Przykładowy request:
curl -X GET \
'https://api.allegro.pl/sale/alle-discount/ALLEOBNIZKA_20240827_PL/eligible-offers' \
-H 'Authorization: Bearer {token}' \
-H 'Accept: application/vnd.allegro.public.v1+json' \
-H 'Content-Type: application/vnd.allegro.public.v1+json'
Przykładowy response:
{
"eligibleOffers": [
{
"id": "10394822344", // identyfikator oferty
"product": {
"id": "765a6e61-b16f-4cad-bde4-8ed5d57b70a0" // identyfikator produktu
},
"basePrice": {
"amount": "4000.00", // aktualna cena w ofercie
"currency": "PLN" // waluta
},
"alleDiscount": {
"campaignConditions": {
"meetsConditions": true, // informacja, czy oferta spełnia warunki kampanii
"violations": [] // powody wykluczenia z kampanii
},
"requiredMerchantPrice": { // maksymalna cena w ofercie, aby spełniła kryteria kampanii
"amount": "3600.00",
"currency": "PLN"
},
"minimumGuaranteedDiscount": { // minimalny poziom obniżki, który ustawimy od ceny zaproponowanej przez sprzedającego
"percentage": "7.50"
}
}
},
{
"id": "10394822345",
"product": {
"id": "a19c189d-4717-412c-af63-d3eab8699672"
},
"basePrice": null,
"alleDiscount":{
"campaignConditions": {
"meetsConditions": false,
"violations": [
{
"code": "OFFER_PRICE_VERIFICATION_IN_PROGRESS",
"message": "OFFER_PRICE_VERIFICATION_IN_PROGRESS"
},
{
"code": "NOT_ENOUGH_STOCK",
"message": "NOT_ENOUGH_STOCK"
}
]
},
"requiredMerchantPrice": {
"amount": "190.00",
"currency": "PLN"
},
"minimumGuaranteedDiscount": {
"percentage": "10.00"
}
}
}
],
"count": 2,
"totalCount": 2 // łączna liczba ofert
}
Jak zgłosić ofertę do kampanii
Za pomocą POST /sale/alle-discount/submit-offer-commands zgłosisz ofertę do wybranej kampanii AlleObniżka.
Przykładowy request:
curl -X POST \
'https://api.allegro.pl/sale/alle-discount/submit-offer-commands' \
-H 'Authorization: Bearer {token}' \
-H 'Accept: application/vnd.allegro.public.v1+json' \
-H 'Content-Type: application/vnd.allegro.public.v1+json' \
-d '{
{
"commandId": "c1b3f63d-d293-4333-911d-a0c1053e2c81", // niewymagane, unikalny identyfikator UUID; jeżeli go nie przekażesz, wygenerujemy go automatycznie
"input": {
"offer": {
"id": "10394822344" // identyfikator zgłaszanej oferty
},
"campaign": {
"id": "ALLEOBNIZKA_20240827_PL" // identyfikator kampanii
},
"proposedPrice": { // poziom ceny, do której zgadzasz się ją obniżyć. Musi być równa lub niższa niż maksymalna cena w ofercie,
"amount": "100.00", // która spełnia kryteria kampanii ("requiredMerchantPrice") zwracana w GET /sale/alle-discount/{campaignId}/eligible-offers.
"currency": "PLN" // waluta
}
}
}'
Przykładowy response:
{
"id": "c1b3f63d-d293-4333-911d-a0c1053e2c81",
"input": {
"offer": {
"id": "10394822344"
},
"campaign": {
"id": "ALLEOBNIZKA_20240827_PL"
},
"proposedPrice": {
"amount": "100.00",
"currency": "PLN"
}
},
"output": {
"status": "NEW", // status zgłoszenia
"createdAt": "2024-08-23T10:15:30.000Z", // data utworzenia zgłoszenia
"updatedAt": "2024-08-23T10:15:30.000Z" // data aktualizacji zgłoszenia
}
}
Dodatkowo, w odpowiedzi zwrócimy nagłówek Location, gdzie znajdziesz odnośnik do zasobu (GET /sale/alle-discount/submit-offer-commands/{commandId}), którym sprawdzisz status swojego zgłoszenia.
Jak sprawdzić status zgłoszenia oferty do kampanii
Skorzystaj z GET /sale/alle-discount/submit-offer-commands/{commandId}, aby pobrać status zgłoszenia oferty do wybranej kampanii AlleObniżka.
Przykładowy request:
curl -X GET \
'https://api.allegro.pl/sale/alle-discount/submit-offer-commands/c1b3f63d-d293-4333-911d-a0c1053e2c81' \
-H 'Authorization: Bearer {token}' \
-H 'Accept: application/vnd.allegro.public.v1+json' \
-H 'Content-Type: application/vnd.allegro.public.v1+json'
Przykładowy response:
{
"id": "c1b3f63d-d293-4333-911d-a0c1053e2c81", // identyfikator UUID
"input": {
"offer": {
"id": "10394822344" // identyfikator zgłaszanej oferty
},
"campaign": {
"id": "ALLEOBNIZKA_20240827_PL" // identyfikator kampanii
},
"proposedPrice": { // poziom ceny, do której zgadzasz się ją obniżyć. Musi być równa lub niższa niż maksymalna cena w ofercie,
"amount": "100.00", // która spełnia kryteria kampanii ("requiredMerchantPrice") zwracana w GET/ sale/alle-discount/{campaignId}/eligible-offers.
"currency": "PLN" // waluta
}
},
"output": {
"status": "SUCCESSFUL", // status zgłoszenia, dostępne wartości: NEW, IN_PROGRESS, FAILED, SUCCESSFUL
"createdAt": "2024-08-23T10:15:30.000Z", // data utworzenia zgłoszenia
"updatedAt": "2024-08-23T12:15:30.000Z", // data aktualizacji zgłoszenia
"newOfferParticipation": {
"participationId": "f9a4a70c-6db9-4473-976c-90f8df9f74e8" // identyfikator zgłoszenia oferty do kampanii
},
"errors": [] // lista błędów
}
}
Jak wycofać ofertę z kampanii
Aby wycofać ofertę z wybranej kampanii AlleObniżka skorzystaj z POST /sale/alle-discount/withdraw-offer-commands. W requeście musisz przekazać “participationId” (identyfikator zgłoszenia oferty do kampanii), który znajdziesz w GET /sale/alle-discount/submit-offer-commands/{commandId} lub GET /sale/alle-discount/{campaignId}/submitted-offers.
Przykładowy request:
curl -X POST \
'https://api.allegro.pl/sale/alle-discount/withdraw-offer-commands' \
-H 'Authorization: Bearer {token}' \
-H 'Accept: application/vnd.allegro.public.v1+json' \
-H 'Content-Type: application/vnd.allegro.public.v1+json' \
-d '{
{
"commandId": "c1b3f63d-d293-4333-911d-a0c1053e2c81", // niewymagane, unikalny identyfikator UUID; jeżeli go nie przekażesz, wygenerujemy go automatycznie
"input": {
"participationId": "f9a4a70c-6db9-4473-976c-90f8df9f74e8" // identyfikator zgłoszenia oferty do kampanii
}
}'
Przykładowy response:
{
"id": "c1b3f63d-d293-4333-911d-a0c1053e2c81", // identyfikator UUID
"input": {
"participationId": {
"id": "f9a4a70c-6db9-4473-976c-90f8df9f74e8"
}
},
"output":{
"status": "NEW", // status wycofania
"createdAt": "2024-08-23T10:15:30.000Z", // data utworzenia wycofania
"updatedAt": "2024-08-23T12:15:30.000Z" // data aktualizacji wycofania
}
}
Dodatkowo, w odpowiedzi zwrócimy nagłówek Location, gdzie znajdziesz odnośnik do zasobu (GET /sale/alle-discount/withdraw-offer-commands/{commandId}), którym sprawdzisz status swojego wycofania.
Jak sprawdzić status wycofania oferty z kampanii
Skorzystaj z GET /sale/alle-discount/withdraw-offer-commands/{commandId}, aby pobrać status wycofania oferty z kampanii AlleObniżka.
Przykładowy request:
curl -X GET \
'https://api.allegro.pl/sale/alle-discount/withdraw-offer-commands/c1b3f63d-d293-4333-911d-a0c1053e2c81' \
-H 'Authorization: Bearer {token}' \
-H 'Accept: application/vnd.allegro.public.v1+json' \
-H 'Content-Type: application/vnd.allegro.public.v1+json'
Przykładowy response:
{
"id": "c1b3f63d-d293-4333-911d-a0c1053e2c81", // identyfikator UUID
"input": {
"participationId": "f9a4a70c-6db9-4473-976c-90f8df9f74e8"
},
"output": {
"status": "SUCCESSFUL", // status wycofania, dostępne wartości: NEW, IN_PROGRESS, FAILED, SUCCESSFUL
"createdAt": "2024-08-23T10:15:30.000Z", // data utworzenia wycofania
"updatedAt": "2024-08-23T12:15:30.000Z", // data aktulizacji wycofania
"withdrawnOfferParticipation": {
"participationId": "f9a4a70c-6db9-4473-976c-90f8df9f74e8" // identyfikator wycofanego zgłoszenia oferty z kampanii
},
"errors": [] // lista błędów
}
}
Lista ofert zgłoszonych do wybranej kampanii
Za pomocą GET /sale/alle-discount/{campaignId}/submitted-offers pobierzesz listę swoich ofert zgłoszonych do wybranej kampanii AlleObniżka. Przy wywołaniu musisz podać parametr campaignId (identyfikator kampanii).
Aby dostosować listę do swoich potrzeb, możesz skorzystać z parametrów:
- limit - maksymalna liczba ofert na liście, max 200;
- offset - by wskazać miejsce, od którego chcesz pobrać kolejną porcję danych;
- offerId - identyfikator wybranej oferty;
- participationId - identyfikator zgłoszenia do kampanii.
Przykładowy request:
curl -X GET \
'https://api.allegro.pl/sale/alle-discount/ALLEOBNIZKA_20240827_PL/submitted-offers' \
-H 'Authorization: Bearer {token}' \
-H 'Accept: application/vnd.allegro.public.v1+json' \
-H 'Content-Type: application/vnd.allegro.public.v1+json'
Przykładowy response:
{
"submittedOffers": [
{
"participationId": "765a6e61-b16f-4cad-bde4-8ed5d57b70a0", // identyfikator zgłoszenia oferty do kampanii
"offer": {
"id": "10394822344" // identyfikator oferty
},
"campaign": {
"id": "ALLEOBNIZKA_DISCOUNT_TEST" // identyfikator kampanii
},
"prices": {
"proposedPrice": { // poziom ceny, do której zgadzasz się ją obniżyć
"amount": "3600.00",
"currency": "PLN"
},
"minimalPriceReduction": { // minimalna obniżka ceny
"amount": "270.00",
"currency": "PLN"
},
"maximumSellingPrice": { // maksymalna cena w ofercie po obniżce
"amount": "3330.00",
"currency": "PLN"
}
},
"process":{
"status": "ACCEPTED", // status udziału oferty w kampanii, dostępne wartości: VERIFICATION, ACCEPTED, ACTIVE, DECLINED, FINISHED.
"errors": [] // lista błędów
},
"purchaseLimit": 1 // limit zakupów w ofercie
}
],
"count": 1,
"totalCount": 1 // łączna liczba ofert
}
Lista zasobów
Pełną dokumentację zasobów w postaci pliku swagger.yaml znajdziesz tu.
Lista zasobów podstawowych opisanych w poradniku:
- GET /sale/badge-campaigns - pobierz listę dostępnych kampanii
- POST /sale/badges - zgłoś ofertę do danego oznaczenia
- GET /sale/badge-applications/{applicationId} - pobierz szczegóły danego zgłoszenia
- GET /sale/alle-discount/campaigns - pobierz listę dostępnych kampanii AlleObniżka
- POST /sale/alle-discount/submit-offer-commands - zgłoś ofertę do kampanii
- GET /sale/alle-discount/submit-offer-commands/{commandId} - pobierz status zgłoszenia
Lista zasobów wspierających opisanych w poradniku:
- GET /sale/badges - pobierz kampanie i oznaczenia przypisane do ofert
- GET /sale/badge-applications - pobierz listę swoich zgłoszeń
- GET /sale/allegro-prices-offer-consents/{offerId} - pobierz aktualną informację o zgodzie na udział oferty w programie wsparcia Allegro Ceny
- PUT /sale/allegro-prices-offer-consents/{offerId} - zaktualizuj zgodę na udział oferty w programie wsparcia Allegro Ceny
- GET /sale/allegro-prices-account-eligibility - pobierz aktualne uprawnienia dla konta na uczestnictwo w programie Allegro Ceny
- PUT /sale/allegro-prices-account-consent - zaktualizuj zgodę dla konta na uczestnictwo w programie Allegro Ceny
- POST /sale/alle-discount/withdraw-offer-commands - wycofaj ofertę z kampanii
- GET /sale/alle-discount/withdraw-offer-commands/{commandId} - pobierz status wycofania
- GET /sale/alle-discount/{campaignId}/eligible-offers - pobierz listę ofert kwalifikujących się do wybranej kampanii
- GET /sale/alle-discount/{campaignId}/submitted-offers - pobierz listę ofert biorących udział w wybranej kampanii