18 października 2017
Promocyjne zestawy ofert
Udostępniliśmy naszym sprzedającym promocyjne zestawy ofert. Dzięki temu sprzedawca może sprzedawać w obniżonej cenie zestaw kilku ofert.
Dla promocyjnych zestawów produktowych przygotowaliśmy nowe zasoby w REST API Allegro:
- POST /sale/loyalty/promotions - chcę utworzyć nowy promocyjny zestaw.
- GET /sale/loyalty/promotions?user.id={Seller_ID} - chcę pobrać listę promocji.
- GET /sale/loyalty/promotions/{promotionId} - chcę pobrać informacje o danej promocji.
- DELETE /sale/loyalty/promotions/{promotionId} - chcę usunąć daną promocję.
POST /sale/loyalty/promotions
To zasób, którym dodasz nowy promocyjny zestaw, jako zalogowany sprzedawca.
UWAGA!
- Zestaw możesz utworzyć z co najmniej 2 ofert.
- Zestaw możesz utworzyć z maksymalnie 9 ofert.
- Do jednej oferty dodasz do 7 zestawów.
Przykładowy request:
curl -X POST
'https://api.allegro.pl/sale/loyalty/promotions'
-H 'Accept: application/vnd.allegro.public.v1+json' \
-H 'Content-Type: application/vnd.allegro.public.v1+json' \
-H "Authorization: Bearer {token}" \
{
"benefits": [{ -- wymagane, określa jakie benefity otrzyma kupujący
"specification": {
"type": "ORDER_FIXED_DISCOUNT", -- wymagane, obecnie dostępna jest jedna wartość
ORDER_FIXED_DISCOUNT (określa kwotę, o jaką chcesz
obniżyć wartość zestawu. Na tej podstawie
wyliczymy jego cenę.)
"value": { -- wymagane, podaj o ile chcesz obniżyć wartość
zestawu. Na tej podstawie wyliczymy jego cenę.
"amount": "10",
"currency": "PLN"
}
}
}],
"offerCriteria": [{ -- wymagane, tablica ofert w zestawie
"type": "CONTAINS_OFFERS", -- wymagane, obecnie dostępna jest jedna wartość
CONTAINS_OFFERS (określa jakie oferty wchodzą
w skład zestawu)
"offers": [{ -- wymagane, oferty, które wchodzą w skład zestawu
"id": "6966354299", -- wymagane, identyfikator oferty
"quantity": 2, -- wymagane, iliczba sztuk danej oferty w zestawie
"promotionEntryPoint": true -- wymagane, określ, czy na stronie tej oferty mamy
wyświetlać zestawy promocyjne.
}, {
"id": "6966344380",
"quantity": 1,
"promotionEntryPoint": false
}]
}]
}
Przykładowy response:
{
"id": "02fe997e-9973-419a-b8ea-a409222e27a5", -- identyfikator utworzonego zestawu
promocyjnego. Użyj go w zasobach GET,
PUT i DELETE - jako {promotionId}
"benefits": [{
"specification": {
"type": "ORDER_FIXED_DISCOUNT",
"value": {
"amount": "10",
"currency": "PLN"
}
}
}],
"offerCriteria": [{
"type": "CONTAINS_OFFERS",
"offers": [{
"id": "6966354299",
"quantity": 2,
"promotionEntryPoint": true
}, {
"id": "6966344380",
"quantity": 1,
"promotionEntryPoint": false
}]
}]
}
GET /sale/loyalty/promotions?user.id={Seller_ID}
Używając tego zasobu, pobierzesz informacje o swoich promocjach. Jako {Seller_ID} użyj swojego identyfikatora użytkownika. Musisz być zalogowany jako użytkownik Allegro.
Przykładowy request:
curl -X GET
'https://api.allegro.pl/sale/loyalty/promotions?user.id={userId}'
-H 'Accept: application/vnd.allegro.public.v1+json' \
-H 'Content-Type: application/vnd.allegro.public.v1+json' \
-H 'Authorization: Bearer {token}'
Przykładowy response:
{
"id": "02fe997e-9973-419a-b8ea-a409222e27a5",
"benefits": [{
"specification": {
"type": "ORDER_FIXED_DISCOUNT",
"value": {
"amount": "10",
"currency": "PLN"
}
}
}],
"offerCriteria": [{
"type": "CONTAINS_OFFERS",
"offers": [{
"id": "6966354299",
"quantity": 2,
"promotionEntryPoint": true
}, {
"id": "6966344380",
"quantity": 1,
"promotionEntryPoint": false
}]
}]
}
GET /sale/loyalty/promotions/{promotionId}
Pod tym zasobem znajdziesz informacje o konkretnej promocji. Musisz być zalogowany jako użytkownik Allegro.
Przykładowy request:
curl -X GET
'https://api.allegro.pl/sale/loyalty/promotions/{promotionId}'
-H 'Accept: application/vnd.allegro.public.v1+json' \
-H 'Content-Type: application/vnd.allegro.public.v1+json' \
-H 'Authorization: Bearer {token}' \
Przykładowy response:
{
"id": "02fe997e-9973-419a-b8ea-a409222e27a5",
"benefits": [{
"specification": {
"type": "ORDER_FIXED_DISCOUNT",
"value": {
"amount": "10",
"currency": "PLN"
}
}
}],
"offerCriteria": [{
"type": "CONTAINS_OFFERS",
"offers": [{
"id": "6966354299",
"quantity": 2,
"promotionEntryPoint": true
}, {
"id": "6966344380",
"quantity": 1,
"promotionEntryPoint": false
}]
}]
}
DELETE /sale/loyalty/promotions/{promotionId}
Używając tego zasobu możesz usunąć daną promocję. Aby usunąć dane, musisz być uwierzytelniony jako sprzedawca.
Przykładowy request:
curl -X DELETE
'https://api.allegro.pl/sale/loyalty/promotions/{promotionId}'
-H 'Content-Type: application/vnd.allegro.public.v1+json' \
-H 'Authorization: Bearer {token}' \
Przykładowy response:
>
status 204 No Content