Jak przypisać ofertę do kampanii

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
     }
   },
…
   ]
}

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
 }}

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
         }
       ]
     }
   ]
 }
}

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 (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.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"
         }
       ]
     }
   ]
 }
}
]
}

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 (przyjmuje wartości od 0 do nieskończoności, 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": []
       }
     }
   ]
 }

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.

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