08 maja 2023
Serwisy zagraniczne Allegro - zmiany na zasobach do zarządzania opcjami promowania
W związku z dostosowywaniem API Allegro do nadchodzących zmian, rozszerzyliśmy zasoby umożliwiające zarządzanie opcjami promowania ofert na Allegro.pl. Zależy nam na tym, aby nasi sprzedający mogli promować swoje oferty na rynku polskim, niezależnie od serwisu bazowego oferty. Chcemy, by oferty wystawione na rynku czeskim, mogły być udostępnione i promowane na rynku polskim.
Jakich zasobów dotyczy zmiana?
- GET /sale/offers/{offerId}/promo-options - pobierz opcje promowania przypisane dla pojedynczej oferty,
- POST /sale/offers/{offerId}/promo-options-modification - zmodyfikuj opcje promowania dla pojedynczej oferty,
- PUT /sale/offers/promo-options-commands/{commandId} - zmodyfikuj opcje promowania dla wielu ofert,
- GET /sale/offers/promo-options-commands/{commandId}/tasks - pobierz szczegółowy raport zadania dla grupowej operacji,
- GET /sale/offers/promo-options - pobierz opcje promowania dla wszystkich ofert zalogowanego sprzedawcy,
- GET /sale/offer-promotion-packages - pobierz listę dostępnych opcji promowania.
Co zmieniliśmy?
1. Zarządzanie promowaniem pojedynczej oferty.
Gdy edytujesz opcje promowania pojedynczej oferty, w sekcji:
- “modifications” - ustawisz promowanie dla oferty w serwisie bazowym - obecnie tylko w “allegro-pl”,
- “additionalMarketplaces” - przekażesz informacje o opcjach promowania dla serwisu dodatkowego, gdzie obecnie jedyna możliwa wartość to “allegro-pl”; to pole przeznaczone będzie dla użytkowników, których serwis bazowy jest inny niż “allegro-pl” np. “allegro-cz”.
Przykładowy request
curl -X POST \
'https://api.allegro.pl/sale/offers/9531382307/promo-options-modification \
-H 'Authorization: Bearer {token}' \
-H 'Accept: application/vnd.allegro.public.v1+json' \
-H 'Content-Type: application/vnd.allegro.public.v1+json'
{
"modifications": [], - tu zmienisz opcje promowania
w serwisie bazowym
"additionalMarketplaces": [ - tu zmienisz opcje promowania
w serwisie dodatkowym
{
"marketplaceId": "allegro-pl",
"modifications": [
{
"modificationType": "CHANGE",
"packageType": "BASE",
"packageId": "emphasized10d"
}
]
}
]
}Gdy skorzystasz z GET /sale/offers/{offerId}/promo-options, w odpowiedzi uzyskasz informacje o opcjach promowania oferty dla serwisu:
- bazowego - w polu “marketplaceId”,
- dodatkowego - w sekcji “additionalMarketplaces”, w polu “marketplaceId”.Przykładowy response
{
"offerId": "9531382307",
"marketplaceId": "allegro-cz", - serwis bazowy oferty
"basePackage": null,
"extraPackages": [],
"pendingChanges": null,
"additionalMarketplaces": [ - serwis dodatkowy oferty
{
"marketplaceId": "allegro-pl",
"basePackage": {
"id": "emphasized10d",
"validFrom": "2020-01-01T00:00:00Z",
"validTo": "2020-01-01T00:00:00Z",
"nextCycleDate": "2020-01-01T00:00:00Z"
},
"extraPackages": [],
"pendingChanges": null
}
]
}2. Grupowe zarządzanie promowaniem ofert.
Gdy edytujesz opcje promowania wielu ofert, w sekcji:
- “modification”- dla wybranych ofert ustawisz opcje promowania w serwisie bazowym - obecnie tylko w “allegro-pl”,
- “additionalMarketplaces” - dla wybranych ofert przekażesz informacje o opcjach promowania na Allegro.pl dla serwisu dodatkowego, gdzie jedyna możliwa wartość to “allegro-pl”; to pole przeznaczone będzie dla użytkowników, których serwis bazowy jest inny niż “allegro-pl” np. “allegro-cz”.
Przykładowy request
curl -X PUT \
'https://api.allegro.pl/sale/offers/promo-options-commands/{commandId} \
-H 'Authorization: Bearer {token}' \
-H 'Accept: application/vnd.allegro.public.v1+json' \
-H 'Content-Type: application/vnd.allegro.public.v1+json'
{
"offerCriteria": [
{
"offers": [
{
"id": "9531382307"
},
{
"id": "9531382308"
}
],
"type": "CONTAINS_OFFERS"
}
],
"modification": {}, - ta sekcja dotyczy serwisu bazowego
"additionalMarketplaces": [ - ta sekcja dotyczy rynku dodatkowego
{
"marketplaceId": "allegro-pl",
"modification": {
"basePackage": {
"id": "emphasized10d"
},
"extraPackages": [],
"modificationTime": "NOW"
}
}
]
}3. Sprawdzanie aktualnych opcji promowania przypisanych do ofert.
Za pomocą GET /sale/offers/promo-options pobierzesz aktualne opcje promowania na Allegro.pl przypisane do ofert sprzedającego.
Przykładowy response
{
"promoOptions": [
{
"offerId": "9531382307",
"marketplaceId": "allegro-cz",
"basePackage": null,
"extraPackages": [],
"pendingChanges": null,
"additionalMarketplaces": [
{
"marketplaceId": "allegro-pl",
"basePackage": {
"id": "promoPackage",
"validFrom": "2020-01-01T00:00:00Z",
"validTo": "2020-01-01T00:00:00Z",
"nextCycleDate": "2020-01-01T00:00:00Z"
},
"extraPackages": [],
"pendingChanges": null
}
]
}
],
"count": 1,
"totalCount": 1
}Na ten moment opcje promowania dostępne są tylko dla serwisu “allegro-pl”. Próba promowania ofert na innym rynku zakończy się błędem o statusie 422, informującym o tym, że dana opcja nie jest dostępna na wybranym rynku.
Po uruchomieniu serwisu w Czechach ustawisz opcje promowania w serwisie “allegro-pl” dla ofert utworzonych w serwisie bazowym “allegro-cz”.
Więcej o zmianach w ramach nowych serwisów zagranicznych przeczytasz na dedykowanej stronie, natomiast informacje na temat zarządzania opcjami promowania znajdziesz w naszym poradniku.
