Czego się dowiesz?
- Jak definiujemy produkt oraz ofertę produktu.
- Jak wystawić ofertę produktu na podstawie danych z Katalogu Produktów.
- Jak wystawić ofertę produktu, którego nie ma w Katalogu Produktów.
- Na co zwrócić uwagę podczas wystawiania oferty oraz jakie dane możesz uzupełnić oraz nadpisać.
- Jak odszukać produkt w Katalogu Produktów.
{
"productSet": [
{
"product": {
"name": "iPhone 5s",
"category": {
"id": "257931"
},
"id": "5902719471797",
"idType": "GTIN",
"parameters": [
{
"id": "string",
"name": "string",
"rangeValue": {
"from": "string",
"to": "string"
},
"values": [
"string"
],
"valuesIds": [
"string"
]
}
],
"images": [
"string"
]
},
"quantity": {
"value": 1
},
"responsiblePerson": {
"id": "string",
"name": "string"
}
}
],
"b2b": {
"buyableOnlyByBusiness": false
},
"attachments": [
{
"id": "string"
}
],
"fundraisingCampaign": {
"id": "string",
"name": "string"
},
"additionalServices": {
"id": "string",
"name": "string"
},
"stock": {
"available": 99,
"unit": "UNIT"
},
"delivery": {
"handlingTime": "PT24H",
"shippingRates": null,
"additionalInfo": "string",
"shipmentDate": "2019-08-24T14:15:22Z"
},
"publication": {
"duration": "PT24H",
"endingAt": "2031-01-04T11:01:59Z",
"startingAt": "2031-01-04T11:01:59Z",
"status": "INACTIVE",
"endedBy": "USER",
"republish": false,
"marketplaces": {}
},
"additionalMarketplaces": {
"allegro-cz": {
"sellingMode": {
"price": {
"amount": "233.01",
"currency": "CZK"
}
}
}
},
"compatibilityList": {
"items": [
{
"type": "TEXT",
"text": "CITROËN C6 (TD_) 2005/09-2011/12 2.7 HDi 204KM/150kW"
}
]
},
"language": "pl-PL",
"category": {
"id": "257931"
},
"parameters": [
{
"id": "string",
"name": "string",
"rangeValue": {
"from": "string",
"to": "string"
},
"values": [
"string"
],
"valuesIds": [
"string"
]
}
],
"afterSalesServices": {
"impliedWarranty": {
"id": "09f0b4cc-7880-11e9-8f9e-2a86e4085a59",
"name": "string"
},
"returnPolicy": {
"id": "09f0b4cc-7880-11e9-8f9e-2a86e4085a59",
"name": "string"
},
"warranty": {
"id": "09f0b4cc-7880-11e9-8f9e-2a86e4085a59",
"name": "string"
}
},
"sizeTable": {
"id": "string",
"name": "string"
},
"contact": {
"id": "string",
"name": "string"
},
"discounts": {
"wholesalePriceList": {
"id": "string",
"name": "string"
}
},
"name": "string",
"payments": {
"invoice": "VAT"
},
"sellingMode": {
"format": "BUY_NOW",
"price": {
"amount": "123.45",
"currency": "PLN"
},
"minimalPrice": {
"amount": "123.45",
"currency": "PLN"
},
"startingPrice": {
"amount": "123.45",
"currency": "PLN"
}
},
"location": {
"city": "string",
"countryCode": "PL",
"postCode": "00-999",
"province": "string"
},
"images": [
"string"
],
"description": {
"sections": [
{
"items": [
{
"type": "string"
}
]
}
]
},
"external": {
"id": "AH-129834"
},
"tax": {
"id": "ae727432-8b72-4bfe-b732-6f163a2bf32a",
"rate": "23.00",
"subject": "GOODS",
"exemption": "MONEY_EQUIVALENT",
"percentage": "23.00"
},
"taxSettings": {
"rates": [
{
"rate": "23.00",
"countryCode": "PL"
}
],
"subject": "GOODS",
"exemption": "MONEY_EQUIVALENT"
},
"messageToSellerSettings": {
"mode": "OPTIONAL",
"hint": "string"
}
}
W ramach Allegro sprzedający wystawia ofertę sprzedaży, która powiązana jest z produktem (lub zestawem produktów) z naszego Katalogu Produktów. W katalogu tym gromadzimy dane o produktach (takie jak parametry, zdjęcia i opisy). Sprzedający podczas wystawiania oferty może zarówno skorzystać z istniejącego w Katalogu produktu, jak i utworzyć zupełnie nowy produkt.
Dokumentacja
Do utworzenia oferty służy endpoint POST /sale/product-offers. W dokumentacji znajdziesz dokładne opis poszczególnych pól, przyjrzyjmy się natomiast ogólnej strukturze danych.
Produkt
Produkt to przedmiot, który sprzedający wystawia na sprzedaż w ofercie. Posiada on zbiór cech, które łącznie jednoznacznie go identyfikują, jak np. parametry. Zestaw tych cech definiujemy dla kategorii, w której dany produkt jest utworzony.
Produkt definiujemy w strukturze productSet[].product. Zwróć także uwagę, że może być to także zestaw produktów w jednej ofercie - stąd tablica productSet[].
Oferta
Oferta zawiera informacje zarówno o produkcie, który wystawia sprzedający, ale także uwzględnia indywidualne informacje, zależne od danego sprzedającego, takie jak:
- cena
- liczba dostępnych sztuk
- format sprzedaży (np. Kup Teraz)
- warunki zwrotów i reklamacji
- czas trwania
- czas wysyłki
- opcje faktury
- cennik dostawy.
Parametry oferty przechowywane są poza tablicą productSet[].
Oferta, a produkt
Tym właśnie oferta różni się od produktu. Podczas, gdy produkt posiada własny zbiór cech, na podstawie których odróżniamy go od innego produktu, oferta zawiera dodatkowe dane, które wpływają na ostateczną decyzję klienta o zakupie. Tym samym może istnieć wiele ofert tego samego produktu (wystawionych przez jednego lub różnych sprzedawców).
Kategorie oraz parametry
Dzięki kategoriom możemy pogrupować produkty tego samego rodzaju i odpowiednio zaprezentować je kupującym. Na podstawie kategorii rozpoznasz cechy (parametry), które uzupełnisz w danej kategorii.
Dostępne kategorie pobierzesz za pomocą:
Dodatkowo w zidentyfikowaniu odpowiedniej kategorii dla danej nazwy produktu pomoże Ci GET /sale/matching-categories.
- Jeżeli zidentyfikujesz już odpowiednią kategorię, możesz pobrać zestaw parametrów wspieranych dla danej kategorii: GET /sale/categories/{categoryId}/parameters.
Jak utworzyć ofertę powiązaną z produktem
Ofertę utworzysz za pomocą POST /sale/product-offers.
Rozróżniamy dwa główne warianty tworzenia oferty z przypisanym produktem:
Gdy masz pewność, że produkt istnieje już w Katalogu Produktów Allegro.
import requests
import json
def create_offer_from_product(url, access_token):
try:
payload = json.dumps({
"productSet": [
{
"product": {
"id": "5902719471797",
"idType": "GTIN"
}
}
],
"sellingMode": {
"price": {
"amount": "220.85",
"currency": "PLN"
}
},
"stock": {
"available": 10
}
})
headers = {
'Accept': 'application/vnd.allegro.public.v1+json',
'Content-Type': 'application/vnd.allegro.public.v1+json',
'Accept-Language': 'pl-PL',
'Authorization': 'Bearer ' + access_token
}
response = requests.request("POST", url, headers=headers, data=payload)
return response
except requests.exceptions.HTTPError as err:
raise SystemExit(err)
def main():
access_token = "" # Acces Token sprzedającego. Uzyskasz go w procesie autoryacji, który opisaliśmy w poradniku:
# https://developer.allegro.pl/tutorials/uwierzytelnianie-i-autoryzacja-zlq9e75GdIR
url = "https://api.allegro.pl.allegrosandbox.pl/sale/product-offers" # url endpointu. Korzystamy ze środowiska testowego, stąd dodatkowo domena "allegrosandbox.pl"
response = create_offer_from_product(url, access_token)
print(response.status_code)
print(response.text)
if __name__ == "__main__":
main()W strukturze żądania przekaż identyfikator produktu (lub GTIN) oraz cenę i liczbę sztuk. To, jak przeszukiwać Katalog Produktów za pomocą GET /sale/products, opisujemy w dalszej części poradnika.
curl -X POST
'https://api.allegro.pl/sale/product-offers'
-H 'Authorization: Bearer {token}'
-H 'Accept: application/vnd.allegro.public.v1+json'
-H 'Content-Type: application/vnd.allegro.public.v1+json'
-d '{
"productSet":
[{
"product":
{
"id": "5902719471797", // numer GTIN, MPN lub ID produktu
"idType": "GTIN" // typ wartości w polu "product.id".
// Dla GTIN wskaż "GTIN",dla numerów
// katalogowych nadanych przez producenta - "MPN".
// Jeśli wskazujesz UUID produktu, pozostaw pole puste.
}
}],
"sellingMode": {
"price": {
"amount": "220.85", // cena
"currency": "PLN"
}
},
"stock": {
"available": 10 // liczba sztuk
}
}'Dane produktów w niektórych przypadkach mogą być niekompletne, np. w sytuacji, gdy nie ma on uzupełnionych wszystkich wymaganych do wystawienia w tym momencie parametrów.
W takiej sytuacji odpowiemy kodem 422, z komunikatem błędu wskazującym brakujące dane:
{
"errors":[
{
"code":"ConstraintViolationException.MissingRequiredParameters",
"message":"Missing required parameters: 209298, 356",
"details":"ConstraintViolationException.MissingRequiredParameters",
"path":"parameters",
"userMessage":"Uzupełnij parametry obowiązkowe: Skład zestawu, Pojemność.",
"metadata":{
}
}
]
}Aby uzupełnić brakujące parametry obowiązkowe, przekaż je w tablicy productSet.product.parameters[]. ID parametru wraz z dostępnymi wartościami sprawdzisz za pomocą GET /sale/categories/{categoryID}/parameters.
Gdy chcesz utworzyć nowy produkt lub nie masz pewności, że produkt istnieje w Katalogu Produktów.
import requests
import json
def create_offer(url, access_token):
try:
payload = json.dumps({
"productSet": [
{
"product": {
"name": "Produkt testowy",
"category": {
"id": "165"
},
"parameters": [
{
"name": "EAN",
"values": [
"0744861045021"
]
},
{
"id": "224017",
"values": [
"test 1587459230"
]
},
{
"id": "202749",
"values": [
"5.9"
]
},
{
"id": "202869",
"values": [
"512 GB"
]
},
{
"id": "202829",
"valuesIds": [
"202829_1"
]
},
{
"id": "202685",
"valuesIds": [
"202685_212929"
]
},
{
"id": "127448",
"valuesIds": [
"127448_2"
]
},
{
"id": "202865",
"valuesIds": [
"202865_214109"
]
},
{
"id": "4388",
"valuesIds": [
"4388_1"
]
},
{
"id": "202717",
"values": [
100
]
},
{
"id": "219",
"values": [
"Bluetooth"
]
},
{
"id": "202821",
"values": [
"Dual SIM"
]
},
{
"name": "Marka telefonu",
"valuesIds": [
"246705_598617"
]
},
{
"name": "Model telefonu",
"values": [
"Armor 24"
]
},
{
"name": "Transmisja danych",
"values": [
"5G"
]
},
{
"name": "Średnica obiektywu",
"values": [
"8"
]
}
],
"images": [
"https://assets.allegrostatic.com/opbox/allegro.pl/homepage/Main%20Page/6lJEwSSohvBIIWNlJUU9sx-w1200-h1200.png"
]
}
}
],
"parameters": [
{
"id": "11323",
"valuesIds": [
"11323_2"
]
}
],
"images": [
"https://assets.allegrostatic.com/opbox/allegro.pl/homepage/Main%20Page/6lJEwSSohvBIIWNlJUU9sx-w1200-h1200.png"
],
"sellingMode": {
"price": {
"amount": "12.43",
"currency": "PLN"
}
},
"stock": {
"available": 10
}
})
headers = {
'Accept': 'application/vnd.allegro.public.v1+json',
'Content-Type': 'application/vnd.allegro.public.v1+json',
'Accept-Language': 'pl-PL',
'Authorization': 'Bearer ' + access_token
}
response = requests.request("POST", url, headers=headers, data=payload)
return response
except requests.exceptions.HTTPError as err:
raise SystemExit(err)
def main():
access_token = "" # Acces Token sprzedającego. Uzyskasz go w procesie autoryacji, który opisaliśmy w poradniku:
# https://developer.allegro.pl/tutorials/uwierzytelnianie-i-autoryzacja-zlq9e75GdIR
url = "https://api.allegro.pl.allegrosandbox.pl/sale/product-offers" # url endpointu. Korzystamy ze środowiska testowego, stąd dodatkowo domena "allegrosandbox.pl"
response = create_offer(url, access_token)
print(response.status_code)
print(response.text)
if __name__ == "__main__":
main()W strukturze żądania w obiekcie product przekaż komplet danych, które opisują sprzedawany produkt. Zestaw parametrów wspieranych dla danej kategorii pobierz za pomocą GET /sale/categories/{categoryId}/parameters. Równocześnie nie przekazuj żadnej wartości w polu product.id. Request uzupełnij o cenę produktu i liczbę sztuk.
curl -X POST
'https://api.allegro.pl/sale/product-offers'
-H 'Authorization: Bearer {token}'
-H 'Accept: application/vnd.allegro.public.v1+json'
-H 'Content-Type: application/vnd.allegro.public.v1+json'
-d '{
"productSet": [{
"product": {
"name": "Produkt testowy",
"category": {
"id": "89060"
},
"parameters": [{
"name": "EAN",
"values": [
"0744861045021"
]
},
{
"id": "237218",
"values": [
"Testowy tytuł"
]
}
],
"images": [
"https://...adres-pierwszego-obrazka.jpeg"
]
}
}],
"sellingMode": {
"price": {
"amount": "220.85",
"currency": "PLN"
}
},
"stock": {
"available": 10
}
}'Jeśli na podstawie przekazanych danych rozpoznamy, że produkt istnieje w naszym Katalogu, to uwzględnimy jego dane w wystawionej ofercie. Będą to:
- kategoria i parametry
- zdjęcia
- opis produktu (jeśli nie przekażesz własnego)
- numery GTIN
- sekcja pasuje do
- specyfikacja techniczna TecDoc.
Może zdarzyć się sytuacja, że rozpoznamy produkt, jednak kategoria lub część przekazanych wartości parametrów nie jest zgodna z zapisanymi w naszym Katalogu Produktów - zwrócimy wtedy odpowiedź z kodem 422.
{
"errors": [
{
"code": "PARAMETER_MISMATCH",
"message": "The provided parameter 'Wysokość produktu'(223329) value (202.00) does not match
the existing parameter value (22.00)",
"details": null,
"path": "productSet[0].product.parameters",
"userMessage": "The specified product exists. The specified parameter `Wysokość produktu` with
the value `202.00` does not match the product parameter `22.00`.",
"metadata": {
"productId": "8b6270a8-06c6-4ad7-a9c2-7443a79ea4ab"
}
}
]
}W takiej sytuacji skoryguj te wartości. W polu metadata wskazujemy id rozpoznanego produktu. Możesz go wykorzystać do utworzenia oferty z produktem zgodnie z procesem opisanym w punkcie nr 1.
Jeżeli masz pewność, że przekazane wartości są prawidłowe, możesz zasugerować zmianę w produkcie za pomocą POST /sale/products/{productId}/change-proposals.
Jaki rezultat oczekiwać?
Niezależnie od wybranej ścieżki - w serwisie pojawi się aktywna oferta sprzedaży wskazanego produktu, nie musisz wywoływać osobnej komendy publikacji. Pozostałych informacji wymaganych do wystawienia oferty nie musisz nam przesyłać - uzupełnimy je wtedy wartościami domyślnymi, które znajdziesz w poniższej tabeli. W dalszej części przedstawiamy także, jak konstruować żądanie, gdy chcesz przesłać inne dane niż wartości domyślne.
Wartości domyślne
| Pole | Wartość |
|---|---|
| Status publikacji | Wartość Oferta zostanie natychmiast aktywowana |
| Format sprzedaży | Wartość Kup teraz |
| Typ jednostek | Wartość Sztuki |
| Wysyłka z | Wartość Dane z ustawień konta Allegro (Twój adres) |
| Opcje faktury | Wartość Faktura VAT |
| Czas wysyłki | Wartość 24 godziny |
| Czas trwania | Wartość Do wyczerpania przedmiotów |
| Język oferty | Wartość Wartość ustawimy na podstawie domyślnego języka serwisu bazowego użytkownika. |
| Cennik dostawy | Wartość Jeżeli posiadasz jeden cennik dostawy, to przypiszemy go do oferty. W przypadku większej liczby, użyjemy cennika o nazwie default. Jeżeli nie posiadasz cennika o takiej nazwie, zwrócimy błąd 422. |
| Warunki reklamacji i Warunki zwrotów | Wartość Jeżeli posiadasz konto firma i po jednej opcji dla tych pól, to przypiszemy ją do oferty. W przypadku większej liczby, użyjemy wariantu o nazwie default. Jeżeli nie posiadasz wariantu o takiej nazwie, zwrócimy błąd 422. Dla kont zwykłych nie podstawimy żadnej wartości. |
Gdy masz pewność, że produkt istnieje już w Katalogu Produktów Allegro
W tym wariancie, posługując się środowiskiem Sandbox, spróbujemy utworzyć ofertę w najprostszy sposób - gdy mamy pewność, że dany produkt istnieje w Katalogu Produktów oraz nie nadpisując wartości domyślnych.
Upewnij się, że na koncie testowym zdefiniowano domyślny cennik dostawy oraz warunki reklamacji i zwrotów.
Przeszukanie Katalogu Produktów
curl -X GET \
'https://api.allegro.pl.allegrosandbox.pl/sale/products?phrase=888462600712&language=pl-PL&mode=GTIN \
-H 'Authorization: Bearer {token}' \
-H 'Accept: application/vnd.allegro.public.v1+json'W pierwszej kolejności, za pomocą GET /sale/products, wyszukaj w Katalogu interesujący Cię przedmiot.
Zwrócimy listę pasujących dla danej frazy produktów wraz z podstawowymi informacjami na ich temat.
{
"products": [
{
"id": "5272069b-0759-4283-8ba7-7f05b416f1d9", // identyfikator produktu - użyj go w ofercie,
by powiązać ją z produktem
"name": "Smartfon Apple iPhone 6S srebrny 128 GB", // nazwa produktu
"category": {
"id": "253002", // kategoria produktu
"path": [ // ścieżka kategorii głównej wskazanej
w “category.id”
{
"id": "954b95b6-43cf-4104-8354-dea4d9b10ddf",
"name": "Allegro"
},
{
"id": "42540aec-367a-4e5e-b411-17c09b08e41f",
"name": "Elektronika"
},
{
"id": "4",
"name": "Telefony i Akcesoria"
},
{
"id": "165",
"name": "Smartfony i telefony komórkowe"
},
{
"id": "48978",
"name": "Apple"
},
{
"id": "253002",
"name": "iPhone 6S"
}
],
"similar": [
{
"id": "316188",
"path": [ // ścieżka kategorii podobnej wskazanej
w “category.similar.id”
{
"id": "954b95b6-43cf-4104-8354-dea4d9b10ddf",
"name": "Allegro"
},
{
"id": "42540aec-367a-4e5e-b411-17c09b08e41f",
"name": "Elektronika"
},
{
"id": "4",
"name": "Telefony i Akcesoria"
},
{
"id": "165",
"name": "Smartfony i telefony komórkowe"
},
{
"id": "48978",
"name": "Apple"
},
{
"id": "316188",
"name": "iPhone 12"
}
]
},
"parameters": [ // parametry produktu
{
"id": "224017", // identyfikator parametru
"name": "Kod producenta", -- nazwa parametru
"valuesLabels": [ // etykieta wartości parametru
"MKQU2PM/A"
],
"values": [
"MKQU2PM/A" // wartość parametru - dla typu string
],
"unit": null, // jednostka wartości parametru. Jeśli
dany parametr nie ma jednostki,
zwracamy wartość null
"options": {
"identifiesProduct": true // czy parametr identyfikuje produkt.
// Wartości parametrów oznaczonych
//jako true nie nie możesz nadpisać
}
},
{
"id": "127448", // identyfikator parametru
"name": "Kolor", // nazwa parametru
"valuesLabels": [ // etykieta wartości parametru
"srebrny"
],
"valuesIds": [ // identyfikator wartości parametru,
"127448_8" dla typu słownikowego
],
"unit": null, // jednostka wartości parametru. Jeśli
dany parametr nie ma jednostki,
zwracamy wartość null
"options": {
"identifiesProduct": true
}
},
{
"id": "202733", // identyfikator parametru
"name": "Funkcje aparatu", // nazwa parametru
"valuesLabels": [ // etykiety wartości parametrów
"HDR",
"autofocus",
"lampa błyskowa",
"panorama",
"samowyzwalacz",
"wykrywanie twarzy",
"zdjęcia seryjne"
],
"valuesIds": [ // identyfikatory wartości parametru,
"202733_1024", dla typu słownikowego wielowartościowego
"202733_2",
"202733_1",
"202733_4",
"202733_128",
"202733_32",
"202733_64"
],
"unit": null, // jednostka wartości parametru. Jeśli
dany parametr nie ma jednostki,
zwracamy wartość null
"options": {
"identifiesProduct": false
}
},
{
"id": "225693", // identyfikator parametru
"name": "EAN", // nazwa parametru
"valuesLabels": [
"888462600712" // etykieta wartości parametru
],
"values": [
"888462600712" // wartość parametru
],
"unit": null,
"options": {
"identifiesProduct": true,
"isGTIN": true // czy parametr jest
GTIN-em. Jeśli parametr ma wiele
wartości, przekaż tylko jedną z nich.
},
...
],
"images": [ // zdjęcia produktu
{
"url": "https://a.allegroimg.com/original/00e0c9/1d7c95614fd6a7c713b075d0251a/
Smartfon-Apple-iPhone-6S-srebrny-128-GB"
}
],
"isDraft": false,
"publication": {
"status": "LISTED" // status produktu. "PROPOSED" zwracamy dla
nowych propozycji produktów i produktów z katalogu,
które nie zostały przez nas sprawdzone, "LISTED" dla
produktów z katalogu, które zostały przez nas sprawdzone,
np. zweryfikowaliśmy, że podany numer GTIN znajduje się w oficjalnej bazie GS1
},
"aiCoCreatedContent": { // informacja o tym, czy określona część produktu
(zwrócona w polu „paths”) została wygenerowana przez AI
"paths": []
}
}]}Katalog produktów
W dalszej części poradnika szczegółowo opisujemy, jakie udostępniamy możliwości przeszukiwania Katalogu Produktów.
Pobierz pełne dane produktu
curl -X GET \
'https://api.allegro.pl.allegrosandbox.pl/sale/products/b2b61e23-b580-4471-b653-6ed25fd179f7' \
-H 'Authorization: Bearer {token}' \
-H 'Accept: application/vnd.allegro.public.v1+json'Po wybraniu produktu możesz pobrać szczegółowe informacje na jego temat.
Zwrócimy jeszcze bogatszy zestaw danych na temat produktu.
{
"id": "634238b1-4385-4de7-9c00-dfa49fce16ab", // identyfikator produktu - użyj go w ofercie,
by powiązać ją z produktem
"name": "Harry Potter i Książę Półkrwi", // nazwa produktu
"category": {
"id": "91447", // kategoria produktu
"path": [ // ścieżka kategorii głównej wskazanej
w “category.id”
{
"id": "954b95b6-43cf-4104-8354-dea4d9b10ddf",
"name": "Allegro"
},
{
"id": "38d588fd-7e9c-4c42-a4ae-6831775eca45",
"name": "Kultura i rozrywka"
},
{
"id": "7",
"name": "Książki i Komiksy"
},
{
"id": "260379",
"name": "Książki dla młodzieży"
}
],
"similar": [
{
"id": "66794",
"path": [ // ścieżka kategorii podobnej wskazanej
w “category.similar.id”
{
"id": "954b95b6-43cf-4104-8354-dea4d9b10ddf",
"name": "Allegro"
},
{
"id": "38d588fd-7e9c-4c42-a4ae-6831775eca45",
"name": "Kultura i rozrywka"
},
{
"id": "7",
"name": "Książki i Komiksy"
},
{
"id": "66794",
"name": "Książki do nauki języka obcego"
}
]
}
]
},
"parameters": [ // parametry produktu
{
"id": "245669", // parametr GTIN
"name": "ISBN",
"valuesLabels": [
"9788380082434"
],
"values": [
"9788380082434"
],
"unit": null,
"options": {
"identifiesProduct": true,
"isGTIN": true
}
},
{
"id": "7773",
"name": "Okładka",
"valuesLabels": [
"twarda"
],
"valuesIds": [
"7773_3"
],
"unit": null, // jednostka wartości parametru. Jeśli
dany parametr nie ma jednostki,
zwracamy wartość null
"options": {
"identifiesProduct": true
}
},
...
],
"images": [ // zdjęcia produktu
{
"url": "https://e.allegroimg.com/original/05239b/a708a8864b2bb2c9b23e450bd98e/
Harry-Potter-i-Ksiaze-Polkrwi-J-K-Rowling-a708a8864b2bb2c9b23e450bd98e"
},
{
"url": "https://5.allegroimg.com/original/00cc55/670c94c04db19158b020d827c715/
Harry-Potter-i-Ksiaze-Polkrwi-J-K-Rowling"
}
],
"offerRequirements": { // jakie wymagania musi spełniać oferta,
"id": null by można ją było powiązać z danym produktem np. Stan = Nowy
"parameters": [
{
"id": "11323",
"name": "Stan",
"valuesLabels": [
"Nowy"
],
"valuesIds": [
"11323_1"
],
"options": {
"identifiesProduct": false
}
}
]
},
"compatibilityList": {
"id": "d04e8a0c-40a1-4c53-8902-ffee7261845e-cf5b236d0f72d0abc0418669fe6569d73432b49250032a21f044696eed7e7d70-2",
// identyfikator sekcji Pasuje do
"type": "PRODUCT_BASED", // typ sekcji Pasuje do
"items": [ // tekstowa reprezentacja sekcji Pasuje do
{
"text": "ALFA ROMEO 147 (937_) 1.6 16V T.SPARK (937.AXA1A, 937.AXB1A, 937.BXB1A) 2001/01-2010/03120KM/88kW"
},
...
{
"text": "SKODA RAPID Spaceback (NH1) 1.2 TSI 2012/07-105KM/77kW"
}
]
},
"tecdocSpecification": {
"id": "e3725f4b-1b4b-4e39-ad7f-331a2c858a7f", // identyfikator specyfikacji technicznej TecDoc
"items": [ // tekstowa reprezentacja specyfikacji technicznej TecDoc
{
"name": "Wysokość [mm]",
"values": [
"51"
]
},
...
{
"name": "Wersja TecDoc",
"values": [
"TecDoc 0619"
]
}
]
},
"isDraft": false, // czy produkt jest draftem
"publication": {
"status": "LISTED" // status produktu. "PROPOSED" zwracamy dla
nowych propozycji produktów i produktów z katalogu,
które nie zostały przez nas sprawdzone, "LISTED" dla
produktów z katalogu, które zostały przez nas sprawdzone,
np. zweryfikowaliśmy, że podany numer GTIN znajduje się w oficjalnej bazie GS1
},
"aiCoCreatedContent": { // informacja o tym, czy określona część produktu
(zwrócona w polu „paths”) została wygenerowana przez AI
"paths": []
}
}Utwórz ofertę z wybranym produktem
curl -X POST
'https://api.allegro.pl.allegrosandbox.pl/sale/product-offers'
-H 'Authorization: Bearer {token}'
-H 'Accept: application/vnd.allegro.public.v1+json'
-H 'Content-Type: application/vnd.allegro.public.v1+json'
-d '{
"productSet": [{
"product": {
"id": "5902719471797",
"idType": "GTIN"
}}],
"sellingMode": {
"price": {
"amount": "220.85",
"currency": "PLN"
}
},
"stock": {
"available": 10
}
}'Po wybraniu produktu i upewnieniu się, że jest prawidłowy, skorzystaj z niego, wykonując żądanie POST /sale/product-offers.
Fragment kodu - Python
import requests
import json
def create_offer_from_product(url, access_token):
try:
payload = json.dumps({
"productSet": [
{
"product": {
"id": "5902719471797",
"idType": "GTIN"
}
}
],
"sellingMode": {
"price": {
"amount": "220.85",
"currency": "PLN"
}
},
"stock": {
"available": 10
}
})
headers = {
'Accept': 'application/vnd.allegro.public.v1+json',
'Content-Type': 'application/vnd.allegro.public.v1+json',
'Accept-Language': 'pl-PL',
'Authorization': 'Bearer ' + access_token
}
response = requests.request("POST", url, headers=headers, data=payload)
return response
except requests.exceptions.HTTPError as err:
raise SystemExit(err)
def main():
access_token = "" # Acces Token sprzedającego. Uzyskasz go w procesie autoryacji, który opisaliśmy w poradniku:
# https://developer.allegro.pl/tutorials/uwierzytelnianie-i-autoryzacja-zlq9e75GdIR
url = "https://api.allegro.pl.allegrosandbox.pl/sale/product-offers" # url endpointu. Korzystamy ze środowiska testowego, stąd dodatkowo domena "allegrosandbox.pl"
response = create_offer_from_product(url, access_token)
print(response.status_code)
print(response.text)
if __name__ == "__main__":
main()Gdy chcesz utworzyć nowy produkt lub nie masz pewności, że produkt istnieje w Katalogu Produktów
W tym wariancie posługując się środowiskiem Sandbox spróbujemy utworzyć ofertę dla nieco bardziej skomplikowanego przypadku - gdy chcesz utworzyć nowy produkt lub nie masz pewności, że produkt istnieje w Katalogu Produktów.
Upewnij się, że na koncie testowym zdefiniowano domyślny cennik dostawy oraz warunki reklamacji i zwrotów.
W requeście musisz podać komplet informacji o produkcie. Przekazane dane posłużą do zgłoszenia propozycji produktu. Zweryfikujemy je, a zaakceptowane przez nas dane produktu będą dostępne na platformie. Część danych może być weryfikowana automatycznie, część po pewnym czasie.
Przygotuj następujące dane, by zaproponować produkt:
- sugerowaną nazwę produktu
- kategorię
- parametry i wartości parametrów
- zdjęcia
- opis produktu.
Uzupełnij kategorię i parametry
"productSet": [{
"product": {
"category":{
"id":"165"
},
"parameters": [
{
"name": "EAN",
"values": [
"0744861045021"
]
},
{
"id": "224017",
"values": [
"test 1587459230"
]
},
{
"id": "202749",
"values": [
"5.9"
]
},
{
"id": "202869",
"values": [
"512 GB"
]
},
{
"id": "202829",
"valuesIds": [
"202829_1"
]
},
{
"id": "202685",
"valuesIds": [
"202685_212929"
]
},
{
"id": "127448",
"valuesIds": [
"127448_2"
]
},
{
"id": "202865",
"valuesIds": [
"202865_214109"
]
},
{
"id": "4388",
"valuesIds": [
"4388_1"
]
},
{
"id": "202717",
"values": [
100
]
},
{
"id": "219",
"values": [
"Bluetooth"
]
},
{
"id": "202821",
"values": [
"Dual SIM"
]
},
{
"name": "Marka telefonu",
"valuesIds": [
"246705_598617"
]
},
{
"name": "Model telefonu",
"values": [
"Armor 24"
]
},
{
"name": "Transmisja danych",
"values": [
"5G"
]
},
{
"name": "Średnica obiektywu",
"values": [
"8"
]
}
...
]
}}]
...Dostępne kategorie pobierzesz za pomocą:
Wywołując GET /sale/categories, otrzymasz listę kategorii głównych. Gdy odpytasz GET /sale/categories?parent.id={categoryId}, wykorzystując ID jednej z kategorii głównych, zwrócimy listę podkategorii. Nawigując w ten sposób po drzewie kategorii, możesz znaleźć odpowiednią kategorię. Ofertę możesz utworzyć w tzw. liściu, czyli w kategorii najniższego rzędu - oznaczonej flagą "leaf": true.
Gdy już zmapujesz odpowiednią kategorię, skorzystaj z GET /sale/categories/{categoryId}/parameters aby pobrać dostępne w niej parametry. W polu requiredForProduct znajdziesz informację, czy dany parametr jest wymagany, gdy tworzysz nowy produkt.
Zamiast identyfikatorów parametrów możesz użyć ich nazw. Dla parametrów:
- słownikowych (typu dictionary) w polu values możesz także przekazać samą nazwę
- zakresowych (typu range) w polu values możesz przekazać dwie wartości, które będą odpowiadać “from” i “to”.
Przekaż GTIN jako parametr
"productSet": [{
"product": {
...
"parameters": [
{
"name": "EAN",
"values": [
"0744861045021"
]
},
...
]}}]
…Przekaż numer GTIN jako parametr w sekcji parameters.
Za pomocą GET /sale/categories/{categoryId}/parameters sprawdź, czy w danej kategorii musisz przekazać numer EAN, ISBN lub ISSN, gdy chcesz dodać produkt. Świadczy o tym wartość true w polu requiredForProduct parametru GTIN.
Dodaj zdjęcia produktu
"productSet": [{
"product": {
...
"images": [
"https://...zewnetrzny-adres-pierwszego-obrazka.jpeg",
"https://...zewnetrzny-adres-drugiego-obrazka.jpeg"
]
... W sekcji images dodaj obrazki, które prezentują produkt. Zdjęcia mogą pochodzić z zewnętrznych serwerów.
Każda oferta musi mieć minimum 1 zdjęcie, maksymalna ich liczba to 16. Więcej o obowiązujących zasadach dotyczących zdjęć przeczytasz w Pomocy dla sprzedających.
Uzupełnij pozostałe dane
curl -X POST
'https://api.allegro.pl.allegrosandbox.pl/sale/product-offers'
-H 'Authorization: Bearer {token}'
-H 'Accept: application/vnd.allegro.public.v1+json'
-H 'Content-Type: application/vnd.allegro.public.v1+json'
-d '{
"productSet": [
{
"product": {
"name": "Produkt testowy",
"category": {
"id": "165"
},
"parameters": [
{
"name": "EAN",
"values": [
"0744861045021"
]
},
{
"id": "224017",
"values": [
"test 1587459230"
]
},
{
"id": "202749",
"values": [
"5.9"
]
},
{
"id": "202869",
"values": [
"512 GB"
]
},
{
"id": "202829",
"valuesIds": [
"202829_1"
]
},
{
"id": "202685",
"valuesIds": [
"202685_212929"
]
},
{
"id": "127448",
"valuesIds": [
"127448_2"
]
},
{
"id": "202865",
"valuesIds": [
"202865_214109"
]
},
{
"id": "4388",
"valuesIds": [
"4388_1"
]
},
{
"id": "202717",
"values": [
100
]
},
{
"id": "219",
"values": [
"Bluetooth"
]
},
{
"id": "202821",
"values": [
"Dual SIM"
]
},
{
"name": "Marka telefonu",
"valuesIds": [
"246705_598617"
]
},
{
"name": "Model telefonu",
"values": [
"Armor 24"
]
},
{
"name": "Transmisja danych",
"values": [
"5G"
]
},
{
"name": "Średnica obiektywu",
"values": [
"8"
]
}
],
"images": [
"https://assets.allegrostatic.com/opbox/allegro.pl/homepage/Main%20Page/6lJEwSSohvBIIWNlJUU9sx-w1200-h1200.png"
]
}
}
],
"parameters": [
{
"id": "11323",
"valuesIds": [
"11323_2"
]
}
],
"images": [
"https://assets.allegrostatic.com/opbox/allegro.pl/homepage/Main%20Page/6lJEwSSohvBIIWNlJUU9sx-w1200-h1200.png"
],
"sellingMode": {
"price": {
"amount": "12.43",
"currency": "PLN"
}
},
"stock": {
"available": 10
}
}
'Aby wystawić ofertę, to oprócz podstawowych danych opisujących produkt, musisz również uzupełnić cenę, liczbę sztuk oraz parametry ofertowe (jeżeli są wymagane).
Fragment kodu - Python
import requests
import json
def create_offer(url, access_token):
try:
payload = json.dumps({
"productSet": [
{
"product": {
"name": "Produkt testowy",
"category": {
"id": "165"
},
"parameters": [
{
"name": "EAN",
"values": [
"0744861045021"
]
},
{
"id": "224017",
"values": [
"test 1587459230"
]
},
{
"id": "202749",
"values": [
"5.9"
]
},
{
"id": "202869",
"values": [
"512 GB"
]
},
{
"id": "202829",
"valuesIds": [
"202829_1"
]
},
{
"id": "202685",
"valuesIds": [
"202685_212929"
]
},
{
"id": "127448",
"valuesIds": [
"127448_2"
]
},
{
"id": "202865",
"valuesIds": [
"202865_214109"
]
},
{
"id": "4388",
"valuesIds": [
"4388_1"
]
},
{
"id": "202717",
"values": [
100
]
},
{
"id": "219",
"values": [
"Bluetooth"
]
},
{
"id": "202821",
"values": [
"Dual SIM"
]
},
{
"name": "Marka telefonu",
"valuesIds": [
"246705_598617"
]
},
{
"name": "Model telefonu",
"values": [
"Armor 24"
]
},
{
"name": "Transmisja danych",
"values": [
"5G"
]
},
{
"name": "Średnica obiektywu",
"values": [
"8"
]
}
],
"images": [
"https://assets.allegrostatic.com/opbox/allegro.pl/homepage/Main%20Page/6lJEwSSohvBIIWNlJUU9sx-w1200-h1200.png"
]
}
}
],
"parameters": [
{
"id": "11323",
"valuesIds": [
"11323_2"
]
}
],
"images": [
"https://assets.allegrostatic.com/opbox/allegro.pl/homepage/Main%20Page/6lJEwSSohvBIIWNlJUU9sx-w1200-h1200.png"
],
"sellingMode": {
"price": {
"amount": "12.43",
"currency": "PLN"
}
},
"stock": {
"available": 10
}
})
headers = {
'Accept': 'application/vnd.allegro.public.v1+json',
'Content-Type': 'application/vnd.allegro.public.v1+json',
'Accept-Language': 'pl-PL',
'Authorization': 'Bearer ' + access_token
}
response = requests.request("POST", url, headers=headers, data=payload)
return response
except requests.exceptions.HTTPError as err:
raise SystemExit(err)
def main():
access_token = "" # Acces Token sprzedającego. Uzyskasz go w procesie autoryacji, który opisaliśmy w poradniku:
# https://developer.allegro.pl/tutorials/uwierzytelnianie-i-autoryzacja-zlq9e75GdIR
url = "https://api.allegro.pl.allegrosandbox.pl/sale/product-offers" # url endpointu. Korzystamy ze środowiska testowego, stąd dodatkowo domena "allegrosandbox.pl"
response = create_offer(url, access_token)
print(response.status_code)
print(response.text)
if __name__ == "__main__":
main()HTTP/1.1 201 Created
{
"name": "Ulefone Power telefon",
"productSet": [
{
"product": {
"id": "2f771572-8302-4c09-b304-391f039e3195",
"publication": {
"status": "LISTED"
},
"parameters": [
{
"id": "246705",
"name": "Marka telefonu",
"values": [
"Ulefone"
],
"valuesIds": [
"246705_598617"
],
"rangeValue": null
},
{
"id": "225693",
"name": "EAN (GTIN)",
"values": [
"0744861045021",
"744861045021"
],
"valuesIds": null,
"rangeValue": null
},
{
"id": "202869",
"name": "Wbudowana pamięć",
"values": [
"512 GB"
],
"valuesIds": [
"202869_214181"
],
"rangeValue": null
},
{
"id": "202865",
"name": "Pamięć RAM",
"values": [
"16 GB"
],
"valuesIds": [
"202865_214109"
],
"rangeValue": null
},
{
"id": "236462",
"name": "Średnica obiektywu",
"values": [
"8.00"
],
"valuesIds": null,
"rangeValue": null
},
{
"id": "224017",
"name": "Kod producenta",
"values": [
"test 1587459230"
],
"valuesIds": null,
"rangeValue": null
},
{
"id": "202749",
"name": "Przekątna ekranu",
"values": [
"5.90"
],
"valuesIds": null,
"rangeValue": null
},
{
"id": "202829",
"name": "Funkcje w telefonach komórkowych",
"values": [
"kalkulator"
],
"valuesIds": [
"202829_1"
],
"rangeValue": null
},
{
"id": "202685",
"name": "Typ",
"values": [
"Smartfon"
],
"valuesIds": [
"202685_212929"
],
"rangeValue": null
},
{
"id": "127448",
"name": "Kolor",
"values": [
"biały"
],
"valuesIds": [
"127448_2"
],
"rangeValue": null
},
{
"id": "4388",
"name": "System operacyjny",
"values": [
"Android"
],
"valuesIds": [
"4388_1"
],
"rangeValue": null
},
{
"id": "202717",
"name": "Pojemność akumulatora",
"values": [
"100"
],
"valuesIds": null,
"rangeValue": null
},
{
"id": "219",
"name": "Komunikacja",
"values": [
"Bluetooth"
],
"valuesIds": [
"219_2"
],
"rangeValue": null
},
{
"id": "202821",
"name": "Opcje SIM",
"values": [
"Dual SIM"
],
"valuesIds": [
"202821_213909"
],
"rangeValue": null
},
{
"id": "246737",
"name": "Model telefonu",
"values": [
"Armor 24"
],
"valuesIds": [
"246737_1785892"
],
"rangeValue": null
},
{
"id": "217",
"name": "Transmisja danych",
"values": [
"5G"
],
"valuesIds": [
"217_2048"
],
"rangeValue": null
},
{
"id": "202741",
"name": "Materiał",
"values": [
"aluminium"
],
"valuesIds": [
"202741_1"
],
"rangeValue": null
},
{
"id": "227381",
"name": "Szerokość",
"values": [
"99.00"
],
"valuesIds": null,
"rangeValue": null
},
{
"id": "227357",
"name": "Wysokość",
"values": [
"11.00"
],
"valuesIds": null,
"rangeValue": null
},
{
"id": "245581",
"name": "Głębokość",
"values": [
"11.00"
],
"valuesIds": null,
"rangeValue": null
},
{
"id": "202705",
"name": "Waga",
"values": [
"11.00"
],
"valuesIds": null,
"rangeValue": null
},
{
"id": "17448",
"name": "Waga produktu z opakowaniem jednostkowym",
"values": [
"11.000"
],
"valuesIds": null,
"rangeValue": null
},
{
"id": "202745",
"name": "Rodzaj wyświetlacza",
"values": [
"LCD IPS"
],
"valuesIds": [
"202745_213201"
],
"rangeValue": null
},
{
"id": "202873",
"name": "Ekran dotykowy",
"values": [
"tak"
],
"valuesIds": [
"202873_214265"
],
"rangeValue": null
}
]
},
"quantity": {
"value": 1
},
"responsiblePerson": null
}
],
"parameters": [
{
"id": "11323",
"name": "Stan",
"values": [
"Używany"
],
"valuesIds": [
"11323_2"
],
"rangeValue": null
}
],
"images": [
"https://a.allegroimg.allegrosandbox.pl/original/11ecc5/3c986dc84419b206015a2e6f1c65"
],
"afterSalesServices": {
"impliedWarranty": {
"id": "f86078a6-9f42-4b76-9696-1e5c0646a60a"
},
"returnPolicy": {
"id": "f54ba3c2-9710-4108-b275-28ee9be2b7b7"
},
"warranty": null
},
"payments": {
"invoice": "VAT"
},
"sellingMode": {
"format": "BUY_NOW",
"price": {
"amount": "12.43",
"currency": "PLN"
},
"startingPrice": null,
"minimalPrice": null
},
"stock": {
"available": 10,
"unit": "UNIT"
},
"location": {
"countryCode": "PL",
"province": "WIELKOPOLSKIE",
"city": "Poznań",
"postCode": "66-166"
},
"delivery": {
"shippingRates": {
"id": "17221a3c-f4cf-4e47-953a-8e125013b014"
},
"handlingTime": "PT24H",
"additionalInfo": null,
"shipmentDate": null
},
"description": {
"sections": [
{
"items": [
{
"type": "TEXT",
"content": "<p>Produkt testowy</p><p>Cechy produktu:</p><ul><li> Typ:Smartfon</li> <li> Kolor: biały</li> <li> Przekątna ekranu: 5,9</li> <li> Rodzaj wyświetlacza: </li> <li> Wbudowana pamięć: 512 GB</li> <li> Pamięć RAM: 16 GB},{</li> </ul><p> </p>"
}
]
}
]
},
"external": null,
"category": {
"id": "165"
},
"tax": null,
"taxSettings": null,
"sizeTable": null,
"discounts": {
"wholesalePriceList": null
},
"contact": null,
"fundraisingCampaign": null,
"messageToSellerSettings": null,
"attachments": [],
"b2b": {
"buyableOnlyByBusiness": false
},
"additionalServices": null,
"compatibilityList": null,
"additionalMarketplaces": {
"allegro-cz": {
"sellingMode": null,
"publication": {
"state": "NOT_REQUESTED",
"refusalReasons": []
}
},
"allegro-sk": {
"sellingMode": null,
"publication": {
"state": "NOT_REQUESTED",
"refusalReasons": []
}
},
"allegro-business-cz": {
"sellingMode": null,
"publication": {
"state": "NOT_REQUESTED",
"refusalReasons": []
}
},
"allegro-hu": {
"sellingMode": null,
"publication": {
"state": "NOT_REQUESTED",
"refusalReasons": []
}
}
},
"id": "7770274320",
"language": "pl-PL",
"publication": {
"status": "INACTIVE",
"duration": null,
"endedBy": null,
"endingAt": null,
"startingAt": null,
"republish": false,
"marketplaces": {
"base": {
"id": "allegro-pl"
},
"additional": []
}
},
"validation": {
"errors": [],
"warnings": [],
"validatedAt": "2024-06-30T08:16:36.128Z"
},
"createdAt": "2024-06-30T08:16:36.000Z",
"updatedAt": "2024-06-30T08:16:36.142Z"
}HTTP/1.1 202 Accepted
location: https://api.allegro.pl/sale/product-offers/9531382307/operations/eadb2e97-9850-4c51-bd27-68888b6d7d5d
retry-after: 5
{
"name": "Ulefone Power telefon",
"productSet": [
{
"product": {
"id": "2f771572-8302-4c09-b304-391f039e3195",
"publication": {
"status": "LISTED"
},
"parameters": [
{
"id": "246705",
"name": "Marka telefonu",
"values": [
"Ulefone"
],
"valuesIds": [
"246705_598617"
],
"rangeValue": null
},
{
"id": "225693",
"name": "EAN (GTIN)",
"values": [
"0744861045021",
"744861045021"
],
"valuesIds": null,
"rangeValue": null
},
{
"id": "202869",
"name": "Wbudowana pamięć",
"values": [
"512 GB"
],
"valuesIds": [
"202869_214181"
],
"rangeValue": null
},
{
"id": "202865",
"name": "Pamięć RAM",
"values": [
"16 GB"
],
"valuesIds": [
"202865_214109"
],
"rangeValue": null
},
{
"id": "236462",
"name": "Średnica obiektywu",
"values": [
"8.00"
],
"valuesIds": null,
"rangeValue": null
},
{
"id": "224017",
"name": "Kod producenta",
"values": [
"test 1587459230"
],
"valuesIds": null,
"rangeValue": null
},
{
"id": "202749",
"name": "Przekątna ekranu",
"values": [
"5.90"
],
"valuesIds": null,
"rangeValue": null
},
{
"id": "202829",
"name": "Funkcje w telefonach komórkowych",
"values": [
"kalkulator"
],
"valuesIds": [
"202829_1"
],
"rangeValue": null
},
{
"id": "202685",
"name": "Typ",
"values": [
"Smartfon"
],
"valuesIds": [
"202685_212929"
],
"rangeValue": null
},
{
"id": "127448",
"name": "Kolor",
"values": [
"biały"
],
"valuesIds": [
"127448_2"
],
"rangeValue": null
},
{
"id": "4388",
"name": "System operacyjny",
"values": [
"Android"
],
"valuesIds": [
"4388_1"
],
"rangeValue": null
},
{
"id": "202717",
"name": "Pojemność akumulatora",
"values": [
"100"
],
"valuesIds": null,
"rangeValue": null
},
{
"id": "219",
"name": "Komunikacja",
"values": [
"Bluetooth"
],
"valuesIds": [
"219_2"
],
"rangeValue": null
},
{
"id": "202821",
"name": "Opcje SIM",
"values": [
"Dual SIM"
],
"valuesIds": [
"202821_213909"
],
"rangeValue": null
},
{
"id": "246737",
"name": "Model telefonu",
"values": [
"Armor 24"
],
"valuesIds": [
"246737_1785892"
],
"rangeValue": null
},
{
"id": "217",
"name": "Transmisja danych",
"values": [
"5G"
],
"valuesIds": [
"217_2048"
],
"rangeValue": null
},
{
"id": "202741",
"name": "Materiał",
"values": [
"aluminium"
],
"valuesIds": [
"202741_1"
],
"rangeValue": null
},
{
"id": "227381",
"name": "Szerokość",
"values": [
"99.00"
],
"valuesIds": null,
"rangeValue": null
},
{
"id": "227357",
"name": "Wysokość",
"values": [
"11.00"
],
"valuesIds": null,
"rangeValue": null
},
{
"id": "245581",
"name": "Głębokość",
"values": [
"11.00"
],
"valuesIds": null,
"rangeValue": null
},
{
"id": "202705",
"name": "Waga",
"values": [
"11.00"
],
"valuesIds": null,
"rangeValue": null
},
{
"id": "17448",
"name": "Waga produktu z opakowaniem jednostkowym",
"values": [
"11.000"
],
"valuesIds": null,
"rangeValue": null
},
{
"id": "202745",
"name": "Rodzaj wyświetlacza",
"values": [
"LCD IPS"
],
"valuesIds": [
"202745_213201"
],
"rangeValue": null
},
{
"id": "202873",
"name": "Ekran dotykowy",
"values": [
"tak"
],
"valuesIds": [
"202873_214265"
],
"rangeValue": null
}
]
},
"quantity": {
"value": 1
},
"responsiblePerson": null
}
],
"parameters": [
{
"id": "11323",
"name": "Stan",
"values": [
"Używany"
],
"valuesIds": [
"11323_2"
],
"rangeValue": null
}
],
"images": [
"https://a.allegroimg.allegrosandbox.pl/original/11ecc5/3c986dc84419b206015a2e6f1c65"
],
"afterSalesServices": {
"impliedWarranty": {
"id": "f86078a6-9f42-4b76-9696-1e5c0646a60a"
},
"returnPolicy": {
"id": "f54ba3c2-9710-4108-b275-28ee9be2b7b7"
},
"warranty": null
},
"payments": {
"invoice": "VAT"
},
"sellingMode": {
"format": "BUY_NOW",
"price": {
"amount": "12.43",
"currency": "PLN"
},
"startingPrice": null,
"minimalPrice": null
},
"stock": {
"available": 10,
"unit": "UNIT"
},
"location": {
"countryCode": "PL",
"province": "WIELKOPOLSKIE",
"city": "Poznań",
"postCode": "66-166"
},
"delivery": {
"shippingRates": {
"id": "17221a3c-f4cf-4e47-953a-8e125013b014"
},
"handlingTime": "PT24H",
"additionalInfo": null,
"shipmentDate": null
},
"description": {
"sections": [
{
"items": [
{
"type": "TEXT",
"content": "<p>Produkt testowy</p><p>Cechy produktu:</p><ul><li> Typ:Smartfon</li> <li> Kolor: biały</li> <li> Przekątna ekranu: 5,9</li> <li> Rodzaj wyświetlacza: </li> <li> Wbudowana pamięć: 512 GB</li> <li> Pamięć RAM: 16 GB},{</li> </ul><p> </p>"
}
]
}
]
},
"external": null,
"category": {
"id": "165"
},
"tax": null,
"taxSettings": null,
"sizeTable": null,
"discounts": {
"wholesalePriceList": null
},
"contact": null,
"fundraisingCampaign": null,
"messageToSellerSettings": null,
"attachments": [],
"b2b": {
"buyableOnlyByBusiness": false
},
"additionalServices": null,
"compatibilityList": null,
"additionalMarketplaces": {
"allegro-cz": {
"sellingMode": null,
"publication": {
"state": "NOT_REQUESTED",
"refusalReasons": []
}
},
"allegro-sk": {
"sellingMode": null,
"publication": {
"state": "NOT_REQUESTED",
"refusalReasons": []
}
},
"allegro-business-cz": {
"sellingMode": null,
"publication": {
"state": "NOT_REQUESTED",
"refusalReasons": []
}
},
"allegro-hu": {
"sellingMode": null,
"publication": {
"state": "NOT_REQUESTED",
"refusalReasons": []
}
}
},
"id": "7770273738",
"language": "pl-PL",
"publication": {
"status": "INACTIVE",
"duration": null,
"endedBy": null,
"endingAt": null,
"startingAt": null,
"republish": false,
"marketplaces": {
"base": {
"id": "allegro-pl"
},
"additional": []
}
},
"validation": {
"errors": [],
"warnings": [],
"validatedAt": "2024-06-30T08:11:36.862Z"
},
"createdAt": "2024-06-30T08:11:36.000Z",
"updatedAt": "2024-06-30T08:11:36.925Z"
}Żądanie jest przetwarzane asynchronicznie. W odpowiedzi otrzymasz dane oferty z aktualnym jej stanem - nieuwzględniającym zmian, które wciąż są procesowane.
Aby sprawdzić status publikacji, skorzystaj z adresu otrzymanego w nagłówku Location - jest to odnośnik do zasobu, który należy odpytywać, aby sprawdzić status wykonania żądania. Z kolei w nagłówku retry-after przekazujemy informację, po jakim czasie (w sekundach) możesz ponownie odpytać zasób.
Skorzystaj z metody GET oraz otrzymanego adresu w Location (GET /sale/product-offers/{offerId}/operations/{operationId}). Do czasu zakończenia operacji w odpowiedzi na to żądanie wyślemy status 202 Accepted.
Przykładowy request:
curl -X GET \ 'https://api.allegro.pl/sale/product-offers/9531382307/7770273738/eadb2e97-9850-4c51-bd27-68888b6d7d5d' -H 'Authorization: Bearer {token}' -H 'Accept: application/vnd.allegro.public.v1+json' -H 'Content-Type: application/vnd.allegro.public.v1+json'Przykładowy response:
{ HTTP/1.1 202 Accepted location: https://api.allegro.pl/sale/product-offers/7770273738/operations/eadb2e97-9850-4c51-bd27-68888b6d7d5d retry-after: 5 { "offer": { "id": "7770273738" }, "operation": { "id": "ef5dd966-d370-44f7-bb30-3631e3511536", "status": "IN_PROGRESS", "startedAt": "2024-06-30T08:11:36.000Z" } }Gdy zakończymy przetwarzać operację, w odpowiedzi na żądanie GET /sale/product-offers/{offerId}/operations/{operationId} wyślemy status HTTP 303 See Other, a w nagłówku Location przekażemy odnośnik kierujący do zasobu z danymi oferty.
Przykładowy request:
curl -X GET 'https://api.allegro.pl/sale/product-offers/7770273738/operations/eadb2e97-9850-4c51-bd27-68888b6d7d5d' -H 'Authorization: Bearer {token}' -H 'Accept: application/vnd.allegro.public.v1+json' -H 'Content-Type: application/vnd.allegro.public.v1+json'Przykładowy response:
HTTP/1.1: 303 See other location: https://api.allegro.pl/sale/product-offers/7770273738Możesz teraz skorzystać z metody GET oraz otrzymanego odnośnika w nagłówku Location, aby uzyskać aktualne dane oferty. Utworzysz dzięki temu żądanie w następującej formie: GET /sale/product-offers/{offerId}.
Przykładowy request:
curl -X GET 'https://api.allegro.pl/sale/product-offers/7770273738' -H 'Authorization: Bearer {token}' -H 'Accept: application/vnd.allegro.public.v1+json' -H 'Content-Type: application/vnd.allegro.public.v1+json'
{
"name": "Ulefone Power telefon",
"productSet": [
{
"product": {
"id": "2f771572-8302-4c09-b304-391f039e3195",
"publication": {
"status": "LISTED"
},
"parameters": [
{
"id": "246705",
"name": "Marka telefonu",
"values": [
"Ulefone"
],
"valuesIds": [
"246705_598617"
],
"rangeValue": null
},
{
"id": "202869",
"name": "Wbudowana pamięć",
"values": [
"512 GB"
],
"valuesIds": [
"202869_214181"
],
"rangeValue": null
},
{
"id": "202865",
"name": "Pamięć RAM",
"values": [
"16 GB"
],
"valuesIds": [
"202865_214109"
],
"rangeValue": null
},
{
"id": "236462",
"name": "Średnica obiektywu",
"values": [
"8"
],
"valuesIds": null,
"rangeValue": null
},
{
"id": "224017",
"name": "Kod producenta",
"values": [
"test 1587459230"
],
"valuesIds": null,
"rangeValue": null
},
{
"id": "202749",
"name": "Przekątna ekranu",
"values": [
"5.9"
],
"valuesIds": null,
"rangeValue": null
},
{
"id": "202829",
"name": "Funkcje w telefonach komórkowych",
"values": [
"kalkulator"
],
"valuesIds": [
"202829_1"
],
"rangeValue": null
},
{
"id": "202685",
"name": "Typ",
"values": [
"Smartfon"
],
"valuesIds": [
"202685_212929"
],
"rangeValue": null
},
{
"id": "127448",
"name": "Kolor",
"values": [
"biały"
],
"valuesIds": [
"127448_2"
],
"rangeValue": null
},
{
"id": "4388",
"name": "System operacyjny",
"values": [
"Android"
],
"valuesIds": [
"4388_1"
],
"rangeValue": null
},
{
"id": "202717",
"name": "Pojemność akumulatora",
"values": [
"100"
],
"valuesIds": null,
"rangeValue": null
},
{
"id": "219",
"name": "Komunikacja",
"values": [
"Bluetooth"
],
"valuesIds": [
"219_2"
],
"rangeValue": null
},
{
"id": "202821",
"name": "Opcje SIM",
"values": [
"Dual SIM"
],
"valuesIds": [
"202821_213909"
],
"rangeValue": null
},
{
"id": "246737",
"name": "Model telefonu",
"values": [
"Armor 24"
],
"valuesIds": [
"246737_1785892"
],
"rangeValue": null
},
{
"id": "217",
"name": "Transmisja danych",
"values": [
"5G"
],
"valuesIds": [
"217_2048"
],
"rangeValue": null
},
{
"id": "202741",
"name": "Materiał",
"values": [
"aluminium"
],
"valuesIds": [
"202741_1"
],
"rangeValue": null
},
{
"id": "227381",
"name": "Szerokość",
"values": [
"99"
],
"valuesIds": null,
"rangeValue": null
},
{
"id": "227357",
"name": "Wysokość",
"values": [
"11"
],
"valuesIds": null,
"rangeValue": null
},
{
"id": "245581",
"name": "Głębokość",
"values": [
"11"
],
"valuesIds": null,
"rangeValue": null
},
{
"id": "202705",
"name": "Waga",
"values": [
"11"
],
"valuesIds": null,
"rangeValue": null
},
{
"id": "17448",
"name": "Waga produktu z opakowaniem jednostkowym",
"values": [
"11"
],
"valuesIds": null,
"rangeValue": null
},
{
"id": "202745",
"name": "Rodzaj wyświetlacza",
"values": [
"LCD IPS"
],
"valuesIds": [
"202745_213201"
],
"rangeValue": null
},
{
"id": "202873",
"name": "Ekran dotykowy",
"values": [
"tak"
],
"valuesIds": [
"202873_214265"
],
"rangeValue": null
},
{
"id": "225693",
"name": "EAN (GTIN)",
"values": [
"0744861045021"
],
"valuesIds": null,
"rangeValue": null
}
]
},
"quantity": {
"value": 1
},
"responsiblePerson": null
}
],
"parameters": [
{
"id": "11323",
"name": "Stan",
"values": [
"Używany"
],
"valuesIds": [
"11323_2"
],
"rangeValue": null
}
],
"images": [
"https://a.allegroimg.allegrosandbox.pl/original/11ecc5/3c986dc84419b206015a2e6f1c65"
],
"afterSalesServices": {
"impliedWarranty": {
"id": "f86078a6-9f42-4b76-9696-1e5c0646a60a"
},
"returnPolicy": {
"id": "f54ba3c2-9710-4108-b275-28ee9be2b7b7"
},
"warranty": null
},
"payments": {
"invoice": "VAT"
},
"sellingMode": {
"format": "BUY_NOW",
"price": {
"amount": "12.43",
"currency": "PLN"
},
"startingPrice": null,
"minimalPrice": null
},
"stock": {
"available": 10,
"unit": "UNIT"
},
"location": {
"countryCode": "PL",
"province": "WIELKOPOLSKIE",
"city": "Poznań",
"postCode": "66-166"
},
"delivery": {
"shippingRates": {
"id": "17221a3c-f4cf-4e47-953a-8e125013b014"
},
"handlingTime": "PT24H",
"additionalInfo": null,
"shipmentDate": null
},
"description": {
"sections": [
{
"items": [
{
"type": "TEXT",
"content": "<p>Produkt testowy</p><p>Cechy produktu:</p><ul><li> Typ:Smartfon</li> <li> Kolor: biały</li> <li> Przekątna ekranu: 5,9</li> <li> Rodzaj wyświetlacza: </li> <li> Wbudowana pamięć: 512 GB</li> <li> Pamięć RAM: 16 GB},{</li> </ul><p> </p>"
}
]
}
]
},
"external": null,
"category": {
"id": "165"
},
"tax": null,
"taxSettings": null,
"sizeTable": null,
"discounts": {
"wholesalePriceList": null
},
"contact": null,
"fundraisingCampaign": null,
"messageToSellerSettings": null,
"attachments": [],
"b2b": null,
"additionalServices": null,
"compatibilityList": null,
"additionalMarketplaces": {
"allegro-cz": {
"sellingMode": null,
"publication": {
"state": "NOT_REQUESTED",
"refusalReasons": []
}
},
"allegro-sk": {
"sellingMode": null,
"publication": {
"state": "NOT_REQUESTED",
"refusalReasons": []
}
},
"allegro-business-cz": {
"sellingMode": null,
"publication": {
"state": "NOT_REQUESTED",
"refusalReasons": []
}
},
"allegro-hu": {
"sellingMode": null,
"publication": {
"state": "NOT_REQUESTED",
"refusalReasons": []
}
}
},
"id": "7770273738",
"language": "pl-PL",
"publication": {
"status": "ACTIVE",
"duration": null,
"endedBy": null,
"endingAt": null,
"startingAt": null,
"republish": false,
"marketplaces": {
"base": {
"id": "allegro-pl"
},
"additional": []
}
},
"validation": {
"errors": [],
"warnings": [],
"validatedAt": "2024-06-30T08:11:36.862Z"
},
"createdAt": "2024-06-30T08:11:36.000Z",
"updatedAt": "2024-06-30T08:11:41.714Z"
}Warianty testowe produktów
Lista wariantów produktów na Sandbox, które ułatwią Ci przeprowadzić różne testy dla różnych sytuacji, które możesz napotkać podczas wystawiania oferty z produktem:
- Produkt bez uzupełnionego EAN: 8ff859fc-09fa-44f9-bada-0366126cb556.
- 2 produkty z takimi samym numerem EAN: d7187e51-36cc-4999-861e-a4336aa165f0, 17ef2e7a-a759-42e9-84c2-93bf1a578ba6.
- Produkt bez wypełnionego parametru wymaganego: df7e4db9-0dc6-4708-af86-84360469a152.
- Produkt, którego podpięcie powoduje błąd parametrów własnych, jeżeli ich nie przekażesz (kod błędu OfferCustomParametersException): 5222c367-c86d-44d7-8840-c1adec7d4178.
Jak przekazać własne wartości w żądaniu
Możesz rozszerzyć swój request, nadpisując wartości domyślne lub przekazując dodatkowe, niewymagane dane.
Przypomnijmy, że struktura żądania dzieli się na dwie części:
produktową - w której przekazujesz:
numer GTIN lub id produktu, jeżeli chcesz powiązać ofertę z produktem, który znajduje się w naszym Katalogu
komplet informacji o produkcie, jeżeli chcesz powiązać ofertę z produktem, którego nie ma w naszym Katalogu. Są to dane, które identyfikują określony produkt.
ofertową - dane, które określają warunki w konkretnej ofercie, np. cena, liczba sztuk, lokalizacja, informacje o fakturze, etc. Wartości związane z ofertą możesz nadpisać, a także dodać nowe. W dalszej części poradnika znajdziesz opis, jak to wykonać.
Tytuł oferty
curl -X POST
'https://api.allegro.pl/sale/product-offers'
-H 'Authorization: Bearer {token}'
-H 'Accept: application/vnd.allegro.public.v1+json'
-H 'Content-Type: application/vnd.allegro.public.v1+json'
-d '{
"productSet": [{
"product": {
"id": "5902719471797",
"idType": "GTIN"
}}],
"name": "Mój własny tytuł",
"sellingMode": {
"price": {
"amount": "220.85",
"currency": "PLN"
}
},
"stock": {
"available": 1
}
}'Do oferty automatycznie przypiszemy tytuł powiązany z nazwą produktu. Jeśli chcesz nadać swój własny, rozszerz request o pole name:
...
"name": "Mój własny tytuł"
... Dla tytułu dopuszczamy maksymalnie 75 znaków. Listę liter, cyfr i znaków specjalnych jakie pozwalamy wprowadzić w tytule oferty znajdziecie poniżej.
Litery: 'a','b','c','d','e','f','g','h','i','j','k','l','m','n','o','p','q','r','s','t','u','w','v','x','y','z',
'ä','ö','ü','ø','ò','ß','0','á','č','ě','í','ř','š','ů','ú','ý','ž','œ','æ','à','â','ç','é','è','ê','ë','î',
'ï','ô','û','ù','ü','ÿ','€','×','ą','ć','ę','ł','ń','ó','ś','ź','ż','µ','⌀',
Cyfry: '0','1','2','3','4','5','6','7','8','9',
Znaki specjalne:'!','@','[',']','#','$','%','^','&','*','{','}','(',')','.',',','/','\\','|','?',' ',';','~','²','³',
'`','\'','’','´','\"','”','"','„','“','″','<','>','_','\t',':','-','=','+','0','…','–','°','°'Niektóre litery jak i znaki specjalne są zamieniane na encje, dlatego zajmują więcej niż jeden znak. Przykładowo znak & jest encjonowany jako & dlatego zajmuje 5 miejsc w tytule.
{
"parameters": [ // lista dostępnych parametrów dla
wskazanej kategorii
{
"id": "11323", // unikalny identyfikator danego parametru
"name": "Stan", // nazwa parametru
"type": “dictionary”, // typ parametru, obecnie mamy dostępne wartości:
dictionary (słownik wyboru, może być jednokrotnego,
bądź wielokrotnego wyboru, w zależności od wartości
w polu multipleChoices), integer (liczba całkowita),
float (liczby zmiennoprzecinkowe), string (możesz dodać
jedną lub wiele wartości)
"required":true, // informacja, czy dany parametr jest obowiązkowy,
dostępne są dwie wartości: true (tak) i false (nie)
"unit": null,
"requiredForProduct": true // czy musisz przekazać wartość dla tego
parametru , gdy tworzysz nowy produkt,
"requiredIf": null, // informacje o zależnej wymagalności parametru
"displayedIf": null, // informacje o zależnym wyświetlaniu parametru
"options": {
"variantsAllowed": false,
"variantsEqual": false
"ambiguousValueId": "216917_41" // id wartości niejednoznacznej, np.
"inna", "pozostałe", etc.
"dependsOnParameterId": null // id parametru, od którego zależne są
dostępne wartości tego parametru
"describesProduct": true, // czy parametr opisuje produkt
"customValuesEnabled": false // czy w danym parametrze możesz dodać własną wartość
dla parametru z wartością niejednoznaczną
},
"dictionary": [
{
"id": "11323_1",
"value": "Nowy",
"dependsOnValueIds": []
},
{
"id": "11323_2",
"value": "Używany",
"dependsOnValueIds": []
}
],
"restrictions": {
"multipleChoices": false // parametr z możliwym wyborem jednej lub
wielu wartości, dostępne są dwie wartości:
true (tak) i false (nie)
}
},
{
"id": "211966",
"name": "Zakres regulacji wysokości koszenia (cm)",
"type": "float",
"required": false,
"unit": null,
"requiredForProduct": true,
"restrictions": {
"min": 0,
"max": 1000,
"range": true, // parametr zakresowy, należy podać
minimalną i maksymalną wartość.
"precision": 2
}
},
{
"id": "17448",
"name": "waga (z opakowaniem)",
"type": "float",
"required":false,
"restrictions": {
"min": 5,
"max": 10,
"range": true, // parametr zakresowy. Sekcje range
min i max oznaczają minalną i maksymalna
wartość danego parametru.
"precision": 3 // określa z jaką dokładnością możemy podać
wartość danego parametru. W tym przypadku
możemy podać wartość z dokładnością do
3 miejsc po przecinku
}
},
{
"id": "216917",
"name": "Załączone wyposażenie",
"type": "string",
"required": false,
"unit": null,
"requiredForProduct": false,
"options": {
"variantsAllowed": false,
"variantsEqual": false
"ambiguousValueId": "216917_41" -- id wartości niejednoznacznej, np.
"inna", "pozostałe", etc.
"dependsOnParameterId": null,
"describesProduct": true,
"customValuesEnabled": false
},
"restrictions": {
"minLength": 1,
"maxLength": 40,
"allowedNumberOfValues": 10 // informacja o tym, ile wartości możesz
podać w danym parametrze
}
}
]
}Za pomocą GET /sale/categories/{categoryId}/parameters pobierzesz parametry dostępne w danej kategorii. W odpowiedzi zwrócimy parametry, które możesz ustawić dla kategorii wskazanej jako categoryId.
curl -X POST
'https://api.allegro.pl/sale/product-offers'
-H 'Authorization: Bearer {token}'
-H 'Accept: application/vnd.allegro.public.v1+json'
-H 'Content-Type: application/vnd.allegro.public.v1+json'
-d '{
"productSet": [{
"product": {
"id": "5902719471797",
"idType": "GTIN"
}}],
"name": "Mój własny tytuł",
"parameters": [
{
"id": "11323",
"valuesIds": [
"11323_2"
]
}
],
"sellingMode": {
"price": {
"amount": "220.85",
"currency": "PLN"
}
},
"stock": {
"available": 1
}
}'Parametry ofertowe są związane z indywidualną ofertą, np. stan, data ważności, etc., a nie z cechą konkretnego produktu. Informację o tym, które parametry są ofertowe, a które produktowe, znajdziesz w polu options.describesProduct:
- true - parametr produktowy
- false - parametr ofertowy.
Poniżej znajdziesz przykłady prawidłowo uzupełnionych struktur przykładowych parametrów, w zależności od ich typu:
- dla parametrów słownikowych (wybór jednego lub wielu wartości z wielu):
{ "id": "209878", "valuesIds": [ "209878_2", "209878_1" ], "values": [], "rangeValue": null } - dla parametrów zakresowych:
{ "id": "212570", "valuesIds": [], "values": [], "rangeValue": { "from": "80", "to": "100" } } - dla parametrów, w których samodzielnie uzupełniasz ich wartość:
{ "id": "216325", "valuesIds": [], "values": [ "zielony", "żółty", "czerwony" ], "rangeValue": null }
Jeżeli chcesz zdefiniować np. stan produktu w ofercie jako używany, rozszerz swój request o poniższą strukturę:
...
"parameters": [
{
"id": "11323",
"valuesIds": [
"11323_2"
]
}
]
... Zamiast identyfikatorów możesz skorzystać z nazw parametrów i ich wartości:
...
"parameters": [
"name": "Stan",
{
"values": [
"Używany"
]
}
]
... Własna wartość parametru
Jeżeli nie znajdziesz odpowiedniej wartości parametru, dla wybranych parametrów z wartością niejednoznaczną możesz zdefiniować własną wartość. Wartości niejednoznaczne parametru to wartości typu: “inne”, “pozostałe”, etc. np. “inna” w parametrze “Marka”. Identyfikator takiej wartości zwracamy w polu ambiguousValueId w sekcji options w odpowiedzi dla GET /sale/categories/{categoryId}/parameters.
Aby dodać własną wartość:
- za pomocą GET /sale/categories/{categoryId}/parameters sprawdź:
- w polu customValuesEnabled, czy w danym parametrze wybranej kategorii możesz dodać własną wartość;
- w polu ambiguousValueId identyfikator wartości niejednoznacznej;
{ "parameters": [ { "id": "129033", "name": "Marka", "type": “dictionary”, "required":true, "unit": null, "requiredForProduct": true "options": { "variantsAllowed": false, "variantsEqual": false, "ambiguousValueId": "129033_13" // id wartości niejednoznacznej, w tym przypadku jest to wartość “inna” "dependsOnParameterId": null, "describesProduct": true, "customValuesEnabled": true // czy w danym prarametrze możesz dodać własną wartość }, ... } - gdy tworzysz draft lub edytujesz ofertę, w sekcji parameters przekaż poniższą strukturę:
{ "id": "129033", // id parametru "valuesIds": [ "129033_13" // id wartości niejednoznacznej ], "values": [ "Nazwa brakującej marki" ], // wartość, którą chcesz przekazać, uzupełnij to pole. "rangeValue": null }
Czas trwania i wznowienie oferty
curl -X POST
'https://api.allegro.pl/sale/product-offers'
-H 'Authorization: Bearer {token}'
-H 'Accept: application/vnd.allegro.public.v1+json'
-H 'Content-Type: application/vnd.allegro.public.v1+json'
-d '{
"productSet": [{
"product": {
"id": "5902719471797",
"idType": "GTIN"
}}],
"name": "Mój własny tytuł",
"parameters": [
{
"id": "11323",
"valuesIds": [
"11323_2"
]
}
],
"sellingMode": {
"price": {
"amount": "220.85",
"currency": "PLN"
}
},
"stock": {
"available": 1
},
"publication": {
"duration": "P30D",
"republish": true
}
}'Jeżeli chcesz ustawić czas trwania oferty inny niż do wyczerpania zapasów, rozszerz swój request o pole publication.duration i wskaż jedną z dostępnych wartości czasu trwania oferty:
...
"publication": {
"duration": "P30D"
...
},
... Dostępne wartości to:
- null (do wyczerpania zapasów),
- P3D (3 dni)
- P5D (5 dni)
- P7D (7 dni)
- P10D (10 dni)
- P20D (20 dni)
- P30D (30 dni).
Czas trwania możesz podać też w godzinach, np.: P72H (3 dni).
Aby oferta została automatycznie wznowiona po zakończeniu, przekaż wartość true w polu publication.republish. Pamiętaj, że możesz automatycznie wznowić ofertę i licytację:
ofertę wznowimy ze stałą początkową liczbą przedmiotów niezależnie od tego, ile przedmiotów sprzedasz
licytację wznowimy tylko, gdy nie zakończyła się sprzedażą.
Wystawienie oferty w przyszłości
curl -X POST
'https://api.allegro.pl/sale/product-offers'
-H 'Authorization: Bearer {token}'
-H 'Accept: application/vnd.allegro.public.v1+json'
-H 'Content-Type: application/vnd.allegro.public.v1+json'
-d '{
"productSet": [{
"product": {
"id": "5902719471797",
"idType": "GTIN"
}}],
"name": "Mój własny tytuł",
"parameters": [
{
"id": "11323",
"valuesIds": [
"11323_2"
]
}
],
"sellingMode": {
"price": {
"amount": "220.85",
"currency": "PLN"
}
},
"stock": {
"available": 1
},
"publication": {
"duration": "P30D",
"startingAt ": "2021-01-20T08:56:00Z"
}
}'curl -X POST
'https://api.allegro.pl/sale/product-offers'
-H 'Authorization: Bearer {token}'
-H 'Accept: application/vnd.allegro.public.v1+json'
-H 'Content-Type: application/vnd.allegro.public.v1+json'
-d '{
"productSet": [{
"product": {
"id": "5902719471797",
"idType": "GTIN"
}}],
"name": "Mój własny tytuł",
"parameters": [
{
"id": "11323",
"valuesIds": [
"11323_2"
]
}
],
"location": {
"countryCode": "PL",
"province": "LUBUSKIE",
"city": "Gorzów Wielkopolski",
"postCode": "66-400"
},
"sellingMode": {
"price": {
"amount": "220.85",
"currency": "PLN"
}
},
"stock": {
"available": 1
}
}'Jeżeli wysyłasz przedmioty z innego adresu, niż przypisany do twojego konta - przekaż odpowiednie wartości w poniższy sposób:
...
"location": {
"countryCode": "PL",
"province": "LUBUSKIE",
"city": "Gorzów Wielkopolski",
"postCode": "66-400"
}
... Listę dozwolonych wartości w polu location.province znajdziesz w naszej dokumentacji.
Jeśli chcesz zmienić adres przypisany do konta, skorzystaj z naszej strony internetowej.
Jak przypisać do oferty wybrany cennik dostawy
curl -X POST
'https://api.allegro.pl/sale/product-offers'
-H 'Authorization: Bearer {token}'
-H 'Accept: application/vnd.allegro.public.v1+json'
-H 'Content-Type: application/vnd.allegro.public.v1+json'
-d '{
"productSet": [{
"product": {
"id": "5902719471797",
"idType": "GTIN"
}}],
"name": "Mój własny tytuł",
"parameters": [
{
"id": "11323",
"valuesIds": [
"11323_2"
]
}
],
"delivery": {
"shippingRates": {
"id": "c446793c-33f0-407f-b0ed-1aeec6090a7a"
}
},
"location": {
"countryCode": "PL",
"province": "LUBUSKIE",
"city": "Gorzów Wielkopolski",
"postCode": "66-400"
},
"sellingMode": {
"price": {
"amount": "220.85",
"currency": "PLN"
}
},
"stock": {
"available": 1
}
}'Możesz ustawić dowolny cennik dostawy. Przykładowo - jeżeli posiadasz cennik o nazwie małe gabaryty i chcesz go użyć w ofercie, wystarczy, że rozszerzysz request o dodatkowe pole z:
nazwą cennika:
... "delivery": { "shippingRates": { "name": "małe gabaryty" } }, ...lub identyfikatorem cennika:
... "delivery": { "shippingRates": { "id": "c446793c-33f0-407f-b0ed-1aeec6090a7a" } } ...
Nazwę i ID swoich cenników sprawdzisz za pomocą GET /sale/shipping-rates.
Jak przypisać do oferty wybrany cennik hurtowy
curl -X POST
'https://api.allegro.pl/sale/product-offers'
-H 'Authorization: Bearer {token}'
-H 'Accept: application/vnd.allegro.public.v1+json'
-H 'Content-Type: application/vnd.allegro.public.v1+json'
-d '{
"productSet": [
{
"product": {
"id": "5902719471797",
"idType": "GTIN"
}
}
],
"name": "Mój własny tytuł",
"parameters": [
{
"id": "11323",
"valuesIds": [
"11323_2"
]
}
],
"location": {
"countryCode": "PL",
"province": "LUBUSKIE",
"city": "Gorzów Wielkopolski",
"postCode": "66-400"
},
"sellingMode": {
"price": {
"amount": "220.85",
"currency": "PLN"
}
},
"stock": {
"available": 1
},
"publication": {
"duration": "P30D",
"startingAt ": "2021-01-20T08:56:00Z"
},
"discounts": {
"wholesalePriceList": {
"id": "5637592a-0a24-4771-b527-d89b2767d821"
}
}
}'Jeśli chcesz zaoferować rabat dla transakcji B2B (firma - firma), rozszerz swój request o pole discounts.wholesalePriceList.id, w którym podaj wcześniej utworzony cennik hurtowy jako:
ID:
... “discounts”: { “wholesalePriceList”: { “id”: “5637592a-0a24-4771-b527-d89b2767d821” } }, ...lub nazwę:
... “discounts”: { “wholesalePriceList”: { “name”: “testowy cennik hurtowy” } }, ...
Czas wysyłki
curl -X POST
'https://api.allegro.pl/sale/product-offers'
-H 'Authorization: Bearer {token}'
-H 'Accept: application/vnd.allegro.public.v1+json'
-H 'Content-Type: application/vnd.allegro.public.v1+json'
-d '{
"productSet": [{
"product": {
"id": "5902719471797",
"idType": "GTIN"
}}],
"name": "Mój własny tytuł",
"parameters": [
{
"id": "11323",
"valuesIds": [
"11323_2"
]
}
],
"delivery": {
"shippingRates": {
"id": "862347c4-b2b0-42d4-b84a-1db01509a69d"
},
"handlingTime": "PT48H"
},
"location": {
"countryCode": "PL",
"province": "LUBUSKIE",
"city": "Gorzów Wielkopolski",
"postCode": "66-400"
},
"sellingMode": {
"price": {
"amount": "220.85",
"currency": "PLN"
}
},
"stock": {
"available": 1
}
}'Aby wystawić przedmiot z czasem wysyłki innym niż 24H, ustaw w polu handlingTime w sekcji delivery wartość w formacie ISO 8601. Dostępne wartości to: PT0S (natychmiast), PT24H (24 godziny), P2D (2 dni), P3D (3 dni), P4D (4 dni), P5D (5 dni), P7D (7 dni), P10D (10 dni), P14D (14 dni), P21D (21 dni), P30D (30 dni), P60D (60 dni). Można również podać te wartości w godzinach, np. PT72H (3 dni).
Przykładowo, jeżeli chcesz ustawić czas wysyłki na 2 dni, prześlij w polu handlingTime wartość PT48H lub P2D:
...
"delivery": {
"handlingTime": "PT48H"
}
... Dodatkowe informacje o dostawie
Rozszerz swój request o sekcję delivery z polem additionalInfo, aby uwzględnić w ofercie dodatkowe informacje o dostawie:
...
"delivery": {
"additionalInfo": "Dodatkowe informacje o dostawie"
}
...
Warunki reklamacji i zwrotów
Jak ustawić wybrane warunki reklamacji
curl -X POST
'https://api.allegro.pl/sale/product-offers'
-H 'Authorization: Bearer {token}'
-H 'Accept: application/vnd.allegro.public.v1+json'
-H 'Content-Type: application/vnd.allegro.public.v1+json'
-d '{
"productSet": [{
"product": {
"id": "5902719471797",
"idType": "GTIN"
}}],
"name": "Mój własny tytuł",
"parameters": [
{
"id": "11323",
"valuesIds": [
"11323_2"
]
}
],
"delivery": {
"shippingRates": {
"id": "862347c4-b2b0-42d4-b84a-1db01509a69d"
},
"handlingTime": "PT48H",
"additionalInfo": "Dodatkowe informacje o dostawie"
},
"location": {
"countryCode": "PL",
"province": "LUBUSKIE",
"city": "Gorzów Wielkopolski",
"postCode": "66-400"
},
"sellingMode": {
"price": {
"amount": "220.85",
"currency": "PLN"
}
},
"afterSalesServices": {
"impliedWarranty": {
"name": "zabawki"
}
},
"stock": {
"available": 1
}
}'Jeśli chcesz ustawić inne warunki reklamacji niż domyślne, użyj ich nazwy lub ID . Przykładowo, jeżeli posiadasz warunki reklamacji o nazwie zabawki, których ID to 913174eb-35ed-48df-b3b9-b9eb66b1b7a4 i chcesz użyć ich w ofercie, wystarczy, że rozszerzysz request o dodatkowe pole, w którym przekażesz:
nazwę warunków reklamacji:
... "impliedWarranty": { "name": "zabawki" } ...lub identyfikator warunków reklamacji:
... "impliedWarranty": { "id": "913174eb-35ed-48df-b3b9-b9eb66b1b7a4" } ...
Nazwę oraz ID warunków reklamacji otrzymasz za pomocą GET /after-sales-service-conditions/implied-warranties.
Jak ustawić wybrane warunki zwrotów
curl -X POST
'https://api.allegro.pl/sale/product-offers'
-H 'Authorization: Bearer {token}'
-H 'Accept: application/vnd.allegro.public.v1+json'
-H 'Content-Type: application/vnd.allegro.public.v1+json'
-d '{
"productSet": [{
"product": {
"id": "5902719471797",
"idType": "GTIN"
}}],
"name": "Mój własny tytuł",
"parameters": [
{
"id": "11323",
"valuesIds": [
"11323_2"
]
}
],
"delivery": {
"shippingRates": {
"id": "862347c4-b2b0-42d4-b84a-1db01509a69d"
},
"handlingTime": "PT48H",
"additionalInfo": "Dodatkowe informacje o dostawie"
},
"location": {
"countryCode": "PL",
"province": "LUBUSKIE",
"city": "Gorzów Wielkopolski",
"postCode": "66-400"
},
"sellingMode": {
"price": {
"amount": "220.85",
"currency": "PLN"
}
},
"afterSalesServices": {
"impliedWarranty": {
"name": "zabawki"
},
"returnPolicy": {
"name": "30 dni"
}
},
"stock": {
"available": 1
}
}'Jeśli chcesz ustawić inne warunki zwrotów niż domyślne, użyj ich nazwy lub ID. Przykładowo - jeśli posiadasz warunki zwrotów o nazwie 30 dni o ID a375a08e-86ee-48a4-baf7-fabe01fe2631, to przekaż:
nazwę warunków zwrotu:
... "returnPolicy": { "name": "30 dni" } ...lub identyfikator warunków zwrotów:
... "returnPolicy": { "id": "a375a08e-86ee-48a4-baf7-fabe01fe2631" } ...
Nazwę oraz ID warunków zwrotów otrzymasz za pomocą GET /after-sales-service-conditions/return-policies.
Warunkami reklamacji i zwrotów możesz zarządzać za pomocą dedykowanych zasobów. Więcej infromacji znajdziesz w naszych poradnikach:
Tabela rozmiarów
curl -X POST
'https://api.allegro.pl/sale/product-offers'
-H 'Authorization: Bearer {token}'
-H 'Accept: application/vnd.allegro.public.v1+json'
-H 'Content-Type: application/vnd.allegro.public.v1+json'
-d '{
"productSet": [{
"product": {
"id": "5902719471797",
"idType": "GTIN"
}}],
"name": "Mój własny tytuł",
"parameters": [
{
"id": "11323",
"valuesIds": [
"11323_2"
]
}
],
"delivery": {
"shippingRates": {
"id": "862347c4-b2b0-42d4-b84a-1db01509a69d"
},
"handlingTime": "PT48H",
"additionalInfo": "Dodatkowe informacje o dostawie"
},
"location": {
"countryCode": "PL",
"province": "LUBUSKIE",
"city": "Gorzów Wielkopolski",
"postCode": "66-400"
},
"sellingMode": {
"price": {
"amount": "220.85",
"currency": "PLN"
}
},
"afterSalesServices": {
"impliedWarranty": {
"name": "zabawki"
},
"returnPolicy": {
"name": "30 dni"
}
},
"stock": {
"available": 1
},
"sizeTable": {
"name": “Przykładowa tabela rozmiarów”
}
}'Rozszerz swój request o sekcję sizeTable, aby dodać do oferty tabelę rozmiarów. Wystarczy, że w żądaniu przekażesz:
nazwę tabeli rozmiarów:
... "sizeTable": { "name": “Przykładowa tabela rozmiarów” } ...lub identyfikator tabeli rozmiarów:
... "sizeTable": { "id": “5727b598-6608-4bd3-b198-f165b011bb69” } ...
Nazwy i identyfikatory swoich tabel rozmiarów sprawdzisz za pomocą GET /sale/size-tables.
Tabelami rozmiarów możesz zarządzać za pomocą dedykowanych zasobów.
Opcje faktury i stawki VAT
Jak zmienić opcje faktury
curl -X POST
'https://api.allegro.pl/sale/product-offers'
-H 'Authorization: Bearer {token}'
-H 'Accept: application/vnd.allegro.public.v1+json'
-H 'Content-Type: application/vnd.allegro.public.v1+json'
-d '{
"productSet": [{
"product": {
"id": "5902719471797",
"idType": "GTIN"
}}],
"name": "Mój własny tytuł",
"parameters": [{
"id": "11323",
"valuesIds": [
"11323_2"
]
}],
"delivery": {
"shippingRates": {
"id": "862347c4-b2b0-42d4-b84a-1db01509a69d"
},
"handlingTime": "PT48H",
"additionalInfo": "Dodatkowe informacje o dostawie"
},
"sellingMode": {
"price": {
"amount": "220.85",
"currency": "PLN"
}
},
"afterSalesServices": {
"impliedWarranty": {
"name": "zabawki"
},
"returnPolicy": {
"name": "30 dni"
}
},
"location": {
"countryCode": "PL",
"province": "LUBUSKIE",
"city": "Gorzów Wielkopolski",
"postCode": "66-400"
},
"payments": {
"invoice": "NO_INVOICE"
},
"stock": {
"available": 1
}
}'Jeżeli nie wystawiasz faktury VAT, lub wystawiasz inną jej formę, możesz ustawić ją za pomocą pola payments.invoice:
...
"payments": {
"invoice": "NO_INVOICE"
}
... Obecnie dostępne są 4 wartości:
- VAT (faktura VAT)
- VAT_MARGIN (faktura VAT marża)
- WITHOUT_VAT (faktura bez VAT)
- NO_INVOICE (nie wystawiam faktury).
Jak ustawić stawkę VAT na fakturze
curl -X POST
'https://api.allegro.pl/sale/product-offers'
-H 'Authorization: Bearer {token}' \
-H 'Accept: application/vnd.allegro.public.v1+json' \
-H 'Content-Type: application/vnd.allegro.public.v1+json' \
-d '{
"productSet": [
{
"product": {
"id": "5902719471797",
"idType": "GTIN"
}
}
],
"name": "Mój własny tytuł",
"parameters": [
{
"id": "11323",
"valuesIds": [
"11323_2"
]
}
],
"delivery": {
"shippingRates": {
"id": "862347c4-b2b0-42d4-b84a-1db01509a69d"
},
"handlingTime": "PT48H",
"additionalInfo": "Dodatkowe informacje o dostawie"
},
"sellingMode": {
"price": {
"amount": "220.85",
"currency": "PLN"
}
},
"afterSalesServices": {
"impliedWarranty": {
"name": "zabawki"
},
"returnPolicy": {
"name": "30 dni"
}
},
"location": {
"countryCode": "PL",
"province": "LUBUSKIE",
"city": "Gorzów Wielkopolski",
"postCode": "66-400"
},
"taxSettings": {
"subject": "GOODS",
"exemption": "MONEY_EQUIVALENT",
"rates": [
{
"rate": "23.00",
"countryCode": "PL"
}
]
},
"publication": {
"status": "ACTIVE"
},
"stock": {
"available": 1
}
}'W ofercie możesz wskazać konkretną stawkę VAT, niezależnie od ustawionej opcji faktury.
Dostępne ustawienia i identyfikatory stawek VAT w danej kategorii sprawdzisz za pomocą GET /sale/tax-settings?category.id={categoryId}. W odpowiedzi zwrócimy stawki VAT dla wszystkich dostępnych krajów dostawy. Jeśli chcesz wyfiltrować wyniki, skorzystaj z opcjonalnego parametru “countryCode”, np. GET /sale/tax-settings?category.id=315261&countryCode=CZ
curl -X POST
'https://api.allegro.pl/sale/product-offers'
-H 'Authorization: Bearer {token}'
-H 'Accept: application/vnd.allegro.public.v1+json'
-H 'Content-Type: application/vnd.allegro.public.v1+json'
-d '{
"productSet": [{
"product": {
"id": "5902719471797"
}}],
"name": "Mój własny tytuł",
"parameters": [{
"id": "11323",
"valuesIds": [
"11323_2"
]
}],
"delivery": {
"shippingRates": {
"id": "862347c4-b2b0-42d4-b84a-1db01509a69d"
},
"handlingTime": "PT48H",
"additionalInfo": "Dodatkowe informacje o dostawie"
},
"sellingMode": {
"price": {
"amount": "220.85",
"currency": "PLN"
}
},
"afterSalesServices": {
"impliedWarranty": {
"name": "zabawki"
},
"returnPolicy": {
"name": "30 dni"
}
},
"location": {
"countryCode": "PL",
"province": "LUBUSKIE",
"city": "Gorzów Wielkopolski",
"postCode": "66-400"
},
"payments": {
"invoice": "NO_INVOICE"
},
"publication": {
"status": "INACTIVE"
},
"stock": {
"available": 1
}
}'Maksymalnie możesz utworzyć 20 000 draftów. Po przekroczeniu limitu nie będziesz mógł utworzyć nowego draftu. Otrzymasz komunikat - “You cannot create new drafts - your account has exceeded the maximum number 20 000 of drafts.” Usuń niepotrzebne za pomocą DELETE /sale/offers/{offerId}.
Draft oferty przechowujemy do 120 dni. Po tym okresie usuniemy taki draft. Jeśli go edytujesz, wydłużymy jego ważność o kolejne 120 dni.
curl -X POST
'https://api.allegro.pl/sale/product-offers'
-H 'Authorization: Bearer {token}'
-H 'Accept: application/vnd.allegro.public.v1+json'
-H 'Content-Type: application/vnd.allegro.public.v1+json'
-d '{
"productSet": [{
"product": {
"id": "5902719471797"
}}],
"name": "Mój własny tytuł",
"parameters": [{
"id": "11323",
"valuesIds": [
"11323_2"
]
}],
"delivery": {
"shippingRates": {
"id": "862347c4-b2b0-42d4-b84a-1db01509a69d"
},
"handlingTime": "PT48H",
"additionalInfo": "Dodatkowe informacje o dostawie"
},
"sellingMode": {
"price": {
"amount": "220.85",
"currency": "PLN"
}
},
"afterSalesServices": {
"impliedWarranty": {
"name": "zabawki"
},
"returnPolicy": {
"name": "30 dni"
}
},
"location": {
"countryCode": "PL",
"province": "LUBUSKIE",
"city": "Gorzów Wielkopolski",
"postCode": "66-400"
},
"payments": {
"invoice": "NO_INVOICE"
},
"publication": {
"status": "INACTIVE"
},
"images": [
"https://...zewnetrzny-adres-pierwszego-obrazka.jpeg",
"https://...zewnetrzny-adres-drugiego-obrazka.jpeg"
],
"stock": {
"available": 1
}
}'Do oferty automatycznie dołączymy zdjęcia produktu. Możesz także dodać swoje własne, które przedstawiają konkretny egzemplarz produktu. Aby załączyć do oferty własne zdjęcia, rozszerz swój request o sekcję images:
...
"images": [
"https://...zewnetrzny-adres-pierwszego-obrazka.jpeg",
"https://...zewnetrzny-adres-drugiego-obrazka.jpeg"
]
... Jeśli chcesz w ofercie zaprezentować wyłącznie własne zdjęcia, bez obrazków, które pochodzą z naszego Katalogu, przekaż w polu product.images pustą tablicę:
{
"productSet": [
{
"product": {
"id": "990de42f-8a68-4f0c-aedb-060141ffd8e3",
"images": []
}
}],
...
"images": [
"https://...zewnetrzny-adres-pierwszego-obrazka.jpeg",
"https://...zewnetrzny-adres-drugiego-obrazka.jpeg"
]
...
} Jeśli nie przekażesz swojego własnego opisu dla oferty, a produkt:
- wskazany przez product.id lub
- rozpoznany przez nas na podstawie przekazanych danych (gdy nie podasz product.id)
w naszym Katalogu go posiada i zawarte są w nim zdjęcia, to wraz z opisem do oferty przypiszemy zdjęcia produktu - nawet jeśli w sekcji product.images przekażesz pustą tablicę. Jeśli zatem chcesz, aby w ofercie były wyłącznie twoje zdjęcia, dodaj swój własny opis.
Zdjęcia są cache’owane przez 7 dni - gdy wyślesz kolejne żądanie z tym samym, zewnętrznym adresem URL, zdjęcia możemy pobrać z wewnętrznego cache Allegro, zamiast bezpośrednio z zewnętrznego serwera.
Jeżeli chcesz, aby czas cache’owania był krótszy, serwer powinien wysłać nagłówek Cache-Control z odpowiednią wartością parametru max-age.
Jeżeli nie chcesz, abyśmy cache’owali zdjęcia, serwer powinien wysłać nagłówek Cache-Control z parametrem Private, No-Cache lub No-Store.
curl -X POST
'https://api.allegro.pl/sale/product-offers'
-H 'Authorization: Bearer {token}'
-H 'Accept: application/vnd.allegro.public.v1+json'
-H 'Content-Type: application/vnd.allegro.public.v1+json'
-d '{
"productSet": [{
"product": {
"id": "5902719471797"
}}],
"name": "Mój własny tytuł",
"parameters": [{
"id": "11323",
"valuesIds": [
"11323_2"
]
}],
"delivery": {
"shippingRates": {
"id": "862347c4-b2b0-42d4-b84a-1db01509a69d"
},
"handlingTime": "PT48H",
"additionalInfo": "Dodatkowe informacje o dostawie"
},
"sellingMode": {
"price": {
"amount": "220.85",
"currency": "PLN"
}
},
"afterSalesServices": {
"impliedWarranty": {
"name": "zabawki"
},
"returnPolicy": {
"name": "30 dni"
}
},
"location": {
"countryCode": "PL",
"province": "LUBUSKIE",
"city": "Gorzów Wielkopolski",
"postCode": "66-400"
},
"payments": {
"invoice": "NO_INVOICE"
},
"publication": {
"status": "INACTIVE"
},
"images": [
"https://...zewnetrzny-adres-pierwszego-obrazka.jpeg",
"https://...zewnetrzny-adres-drugiego-obrazka.jpeg"
],
"description": {
"sections": [{
"items": [{
"type": "TEXT",
"content": "<p>Przykładowy opis oferty</p>"
}]
}]
},
"stock": {
"available": 1
}
}'Do oferty możesz dodać swój własny opis. Przy jego braku do oferty automatycznie przypiszemy opis z produktu, który wskazałeś w żądaniu.
Aby dodać opis dodatkowy, rozszerz request o sekcję description:
...
"description": {
"sections": [
{
"items": [
{
"type": "TEXT",
"content": "<p>Przykładowy opis oferty</p>"
}
]
}
]
}
... Szczegółowe informacje o zasadach dla ofert znajdziesz na stronie dla sprzedających.
Najważniejsze informacje
- maksymalna wielkość całego opisu jaki możesz przesłać to 40000 bajtów
- możesz korzystać tylko z określonych znaczników HTML:
- h1 - tytuł
- h2 - podtytuł
- p - akapit
- ul - wypunktowanie
- ol - wylistowanie
- li - element listy
- b - pogrubienie.
- w opisie możesz wykorzystać tylko zdjęcia, które przesyłasz w tablicy images.
Jeśli chcesz ułatwić sobie pracę nad opisami ofert i produktów, skorzystaj z naszej publicznej biblioteki JavaScript - convert-description, która konwertuje opis produktu i oferty w HTML do formatu wspieranego przez Allegro REST API.
Sugerujemy, by pierwszy opis przygotować przez formularz wystawiania. Skorzystaj z wszystkich rodzajów sekcji i opcji formatowania i pobierz ofertę za pomocą GET /sale/product-offers/{offerId}. W ten sposób najłatwiej dowiesz się jak poprawnie przygotować opis.
Jak wygląda struktura opisu
Sekcje (sections)
Opis oferty składa się z przynajmniej jednej sekcji, które umieszczasz w tablicy sections. Opis może mieć max. 100 sekcji.
{
"sections": [
{ section1 },
{ section2 },
...
]
}Elementy opisu (item)
Sekcje grupują elementy opisu (item) w widok kolumnowy:
jedna kolumna, która zajmuje całą szerokość ekranu
{ "items" : [ { item1 } ] }dwie kolumny, z których każda zajmuje połowę ekranu
{ "items" : [ { item1 } { item2 } ] }- nie możesz utworzyć sekcji z większą liczbą kolumn.
Typy treści w opisie
Tekst
{
"type": "TEXT",
"content": "<p>opis tekstowy</p>"
}Możesz tu użyć określonych znaczników HTML:
- h1 - tytuł
- h2 - podtytuł
- p - akapit
- ul - wypunktowanie
- ol - wylistowanie
- li - element listy
- b - pogrubienie.
Najważniejsze zasady
Treści musisz umieścić w znacznikach HTML. W znacznikach HTML używaj tylko małych liter.
Poprawnie
{ "type": "TEXT", "content": "<p>opis tekstowy</p>" }Niepoprawnie
{ "type": "TEXT", "content": "opis tekstowy" }Nie możesz dodatkowo formatować tagów h1 i h2.
Poprawnie
{ "type": "TEXT", "content": "<h1>Tytuł sekcji</h1>" }Niepoprawnie
{ "type": "TEXT", "content": "<h1><b>Tytuł sekcji<b></h1>" }Możesz użyć pogrubienia < b > < /b > w znacznikach:
- < p > < /p > - akapit
- < ul > < /ul > - lista wypunktowana
- < ol > < /ol > - lista numerowana
Możesz użyć znacznika akapitu < p > < /p > w znacznikach:
- < ul > < /ul > - lista wypunktowana
- < ol > < /ol > - lista numerowana
Przykład, jak poprawnie łączyć znaczniki HTML:
<h1>Lorem ipsum dolor sit amet, consectetur adipiscing elit</h1>
<p><b>Aliquam vitae nisi ac lectus gravida rhoncus</b>. Vivamus egestas, orci quis
fermentum sollicitudin, leo urna pellentesque quam, ut mattis risus nisl sed dolor.</p>
<ul>
<li><b>Nulla eu justo ut velit pellentesque porta.</b></li>
<li>Pellentesque eget arcu id ligula consequat fermentum at nec velit. Maecenas vitae nunc
non ante aliquet facilisis nec id leo.</li>
<li>Sed vitae metus vel lorem iaculis rhoncus.</li> <li>Nullam nec felis felis.</li>
</ul>
<ol>
<li><p><b>In eget vulputate purus</b></p></li>
<li><p>Integer a pharetra odio.</p></li>
<li><p>Vestibulum ut vestibulum diam.</p></li>
<li><p>Phasellus quis tempor ipsum, at tincidunt nibh.</p></li>
<li><p>Nulla sollicitudin, libero sit amet fermentum iaculis.</p></li>
</ol>Zdjęcie
{
"type": "IMAGE",
"url": "https://...zewnetrzny-adres--obrazka.jpeg"
}Przykładowa struktura opisu
{
"sections": [{
"items": [{
"type": "TEXT",
"content": "<p>tekstowy opis przedmiotu</p>"
}]
}, {
"items": [{
"type": "IMAGE",
"url": "https://...zewnetrzny-adres-obrazka.jpeg"
}]
}, {
"items": [{
"type": "TEXT",
"content": "<p>tekstowy opis przedmiotu</p>"
}, {
"type": "IMAGE",
"url": "https://...zewnetrzny-adres-obrazka.jpeg"
}]
}, {
"items": [{
"type": "IMAGE",
"url": "https://...zewnetrzny-adres-obrazka.jpeg"
}, {
"type": "IMAGE",
"url": "https://...zewnetrzny-adres-obrazka.jpeg"
}]
}]
}Sygnatura
curl -X POST
'https://api.allegro.pl/sale/product-offers'
-H 'Authorization: Bearer {token}'
-H 'Accept: application/vnd.allegro.public.v1+json'
-H 'Content-Type: application/vnd.allegro.public.v1+json'
-d '{
"productSet": [
{
"product": {
"id": "5902719471797"
}
}
],
"name": "Mój własny tytuł",
"parameters": [
{
"id": "11323",
"valuesIds": [
"11323_2"
]
}
],
"delivery": {
"shippingRates": {
"id": "862347c4-b2b0-42d4-b84a-1db01509a69d"
},
"handlingTime": "PT48H",
"additionalInfo": "Dodatkowe informacje o dostawie"
},
"sellingMode": {
"price": {
"amount": "220.85",
"currency": "PLN"
}
},
"afterSalesServices": {
"impliedWarranty": {
"name": "zabawki"
},
"returnPolicy": {
"name": "30 dni"
}
},
"location": {
"countryCode": "PL",
"province": "LUBUSKIE",
"city": "Gorzów Wielkopolski",
"postCode": "66-400"
},
"payments": {
"invoice": "NO_INVOICE"
},
"publication": {
"status": "INACTIVE"
},
"images": [
"https://...zewnetrzny-adres-pierwszego-obrazka.jpeg",
"https://...zewnetrzny-adres-drugiego-obrazka.jpeg"
],
"description": {
"sections": [
{
"items": [
{
"type": "TEXT",
"content": "<p>Przykładowy opis oferty</p>"
}
]
}
]
},
"stock": {
"available": 1
},
"external": {
"id": "5AA43-2020"
}
}'Sygnatura to zewnętrzny identyfikator, który nadaje sprzedający, np. aby powiązać ofertę z produktem w swoim magazynie. Możesz wprowadzić tutaj dowolny ciąg znaków. Jeśli chcesz dodać do oferty własną sygnaturę przedmiotu, rozszerz swój request o dodatkowe pole external.id:
...
"external": {
"id": “5AA43-2020”
}
... Ważne informacje dla sprzedającego
W ofercie, w obiekcie "messageToSellerSettings" możesz określić, czy kupujący ma wprowadzić “Ważną wiadomości dla sprzedającego” w zamówieniu w formularzu dostawy i płatności. Wyświetlimy ją w polu "messageToSeller" po pobraniu zamówienia poprzez:
W obiekcie "messageToSellerSettings", w polu "mode" możesz przekazać jedną z wartości:
- OPTIONAL - wyświetlimy kupującemu pole “Ważne informacje dla sprzedającego” w formularzu dostawy i płatności, ale nie będzie musiał go uzupełniać.
- HIDDEN - ukryjemy pole “Ważne informacje dla sprzedającego” w formularzu dostawy i płatności - kupujący nie będzie mógł wprowadzić żadnej wiadomości.
- REQUIRED - wyświetlimy kupującemu pole “Ważne informacje dla sprzedającego” w formularzu dostawy i płatności - jego wypełnienie będzie dla kupującego obowiązkowe.
Dla wartości REQUIRED musisz także uzupełnić podpowiedź dla kupującego w polu "hint".
{
"id": "7276261934",
"name": "iPhone",
…
"messageToSellerSettings": {
"mode": "REQUIRED" // określ, czy “Ważna wiadomość do
sprzedającego“ ma być wymagana
(REQUIRED), opcjonalna (OPTIONAL), czy
ukryta (HIDDEN),
"hint": "Wybierz wzór" // podpowiedź dla kupującego - dostępna i
wymagana tylko dla wartości REQUIRED w
polu “mode“.
}
…
}
Z wartości REQUIRED skorzystasz tylko w niektórych kategoriach. Aby sprawdzić, czy jest to możliwe w wybranej kategorii, użyj GET /sale/categories/{categoryId}. W polu "options" we fladze "sellerCanRequirePurchaseComments" dla takiej kategorii zwrócimy wartość true.
Jeżeli nie przekażesz żadnej wartości w obiekcie "messageToSellerSettings" (lub przekażesz null) - domyślnie, wypełnienie “Ważnych informacji dla sprzedającego” przez Kupującego będzie opcjonalne.
Załączniki
Do ofert możesz dodawać załączniki w formatach: PDF, JPG, JPEG i PNG. Wyświetlimy je pod opisem oferty w sekcji Dodatkowe informacje. Załączników może być maksymalnie 9 - po jednym załączniku z listy:
- Poradnik (MANUAL) - PDF
- Regulamin promocji (SPECIAL_OFFER_RULES) - PDF
- Regulamin konkursu (COMPETITION_RULES) - PDF
- Fragment książki (BOOK_EXCERPT) - PDF
- Instrukcję obsługi (USER_MANUAL) - PDF
- Instrukcję montażu (INSTALLATION_INSTRUCTIONS) - PDF
- Instrukcję gry (GAME_INSTRUCTIONS) - PDF
- Etykietę energetyczną (ENERGY_LABEL) - JPEG, JPG, PNG
- Kartę produktu (PRODUCT_INFORMATION_SHEET) - PDF
- Etykietę opony (TIRE_LABEL) - JPEG, JPG, PNG
- Instrukcja dotycząca bezpieczeństwa (SAFETY_INFORMATION_MANUAL) - PDF.
Jeśli chcesz dodać załącznik do oferty:
- Stwórz obiekt załącznika, dzięki czemu otrzymasz identyfikator załącznika oraz adres URL, na który wyślesz załącznik,
- Na ten URL prześlij plik, który chcesz dodać do oferty,
- Przesłany załącznik podłącz do oferty.
Stwórz obiekt załącznika
Aby dodać załącznik, najpierw musisz stworzyć na swoim koncie obiekt załącznika. Zrobisz to za pomocą POST /sale/offer-attachments. Gdy utworzysz obiekt, będziesz miał:
- identyfikator załącznika,
- adres URL, za pomocą którego prześlesz plik na nasz serwer.
Przykładowy request:
curl -X POST \
'https://api.allegro.pl/sale/offer-attachments' \
-H 'Accept: application/vnd.allegro.public.v1+json' \
-H 'Content-Type: application/vnd.allegro.public.v1+json' \
-H 'Authorization: Bearer {token}'
-d '{
"type": "SPECIAL_OFFER_RULES", // wymagany, rodzaj załącznika,
dostępne wartości MANUAL,
SPECIAL_OFFER_RULES,
COMPETITION_RULES,
BOOK_EXCERPT, USER_MANUAL,
INSTALLATION_INSTRUCTIONS,
GAME_INSTRUCTIONS,
ENERGY_LABEL,
PRODUCT_INFORMATION_SHEET,
SAFETY_INFORMATION_MANUAL
TIRE_LABEL.
"file": {
"name": "abcde.pdf" // wymagany, nazwa pliku, który dodasz,
}
}'Przykładowy response
201 - created - obiekt załącznika utworzony prawidłowo
Nagłówek response'a:
Location: http://upload.allegro.pl/sale/offer-attachments/e9d1bf7c-804e-4faf-9e24-b2d3aa3eda05Body response'a:
{
"id": "e9d1bf7c-804e-4faf-9e24-b2d3aa3eda05", // identyfikator draftu załącznika,
"type": "SPECIAL_OFFER_RULES", // rodzaj załącznika,
"file": {
"name": "abcde.pdf" // nazwa pliku, który dodasz,
}
}Prześlij plik
Teraz możesz przesłać załącznik na nasz serwer. Do tego celu użyj adresu, który otrzymałeś w nagłówku odpowiedzi (w polu Location) na poprzednie wywołanie.
Przykładowy request:
curl -X PUT \
'http://upload.allegro.pl/sale/offer-attachments/{attachmentId}' \
-H 'Accept: application/vnd.allegro.public.v1+json' \
-H 'Content-Type: application/pdf' \
-H 'Authorization: Bearer {token}'
--data-binary "@abcde.pdf" // wymagany, zawartość pliku z
załącznikiem w postaci binarnejPrzykładowy response:
{
"id": "07ee5e36-afc7-41eb-af49-3df5354ef858", // identyfikator draftu załącznika,
"type": "SPECIAL_OFFER_RULES", // rodzaj załącznika,
"file":
"name": "abcde.pdf", // nazwa pliku, który dodasz,
"url": {adres_pliku} // adres, pod którym jest dostępny
załącznik.
}
}Podłącz załącznik do oferty
Uwzględnij załącznik w ofercie, rozszerz swój request o pole attachments, w którym podaj wcześniej otrzymany identyfikator.
…
"attachments": [
{
"id": "07ee5e36-afc7-41eb-af49-3df5354ef858"
}
]
…Szczegółowe informacje o załączniku możesz zawsze pobrać korzystając z GET /sale/offer-attachments/{attachmentId}.
Usługi dodatkowe
Aby uatrakcyjnić Twoje oferty, możesz skorzystać z usług dodatkowych, np. zapakowanie na prezent, wniesienie, montaż, itd. Więcej informacji znajdziesz w Pomocy Allegro.
Aby uwzględnić informację o usługach dodatkowych w ofercie, rozszerz swój request o pole additionalServices, w którym przekaż ID lub nazwę wybranej grupy usług dodatkowych:
…
"additionalServices": {
"id": "02ee5e36-afc7-41eb-afs9-3df5354ef818"
}
…Więcej informacji o tym, jak zarządzać usługami dodatkowymi, znajdziesz w naszym poradniku.
Dane teleadresowe producenta
Aby dodać informację o danych teleadresowych producenta produktu, rozszerz request o pole "productSet.[].responsibleProducer", w którym wskaż:
“type” - typ identyfikatora, obecnie dostępne wartości: “ID”, "NAME";
dla typu "ID" podaj w polu "id" identyfikator danych producenta.
... "responsibleProducer": { "type": "ID", // typ identyfikatora "id": "12345678-9abc-def1-2345-6789abcdef12" // identyfikator danych producenta } ...dla typu "NAME" podaj w polu "name" nazwę własną danych producenta.
... "responsibleProducer": { "type": "NAME", // typ identyfikatora "name": "Producent ABC" // nazwa własna danych producenta } ...
Identyfikatory i nazwy utworzonych na koncie danych teleadresowych producentów pobierzesz za pomocą GET /sale/responsible-producers. Więcej informacji znajdziesz w naszym poradniku.
Gdy tworzysz draft oferty:
- i nie podasz nam danych producenta, wstawimy automatycznie sugerowane dane tylko pod warunkiem, jeśli dla danej marki posiadamy dokładnie jedne dane producenta,
- możesz użyć globalnych, sugerowanych przez nas, danych producenta za pomocą GET /sale/products - wyszukaj odpowiedni produkt i pobierz dane z pola products[].productSafety.
Osoba odpowiedzialna za zgodność produktu z przepisami unijnymi
Aby dodać informację o podmiocie odpowiedzialnym za zgodność produktu z przepisami unijnymi, rozszerz request o pole productSet.[].responsiblePerson, w których wskaż:
- ID podmiotu odpowiedzialnego:
… "responsiblePerson": { "id": "34c8ebb6-04d0-47be-bb20-426b7f69b9ab", } … - lub nazwę:
… "responsiblePerson": { "name": "responsible person", } …
Identyfikatory i nazwy utworzonych na koncie osób odpowiedzialnych za zgodność produktu z przepisami unijnymi pobierzesz za pomocą GET /sale/responsible-persons. Więcej informacji znajdziesz w naszym poradniku.
Informacje o bezpieczeństwie produktu
Aby dodać informację o bezpieczeństwie produktu, rozszerz request o pole "productSet.[].safetyInformation", w którym wskaż, czy dla danego produktu posiadasz informacje o bezpieczeństwie produktu. Dla każdego produktu musisz przekazać osobne dane.
Możesz zdefiniować jeden z trzech typów informacji:
- "ATTACHMENTS" - jeżeli dodajesz załączniki jako informacje o bezpieczeństwie produktu. Do każdego produktu możesz dodać maksymalnie 20 załączników.
{
"productSet": [
{
"safetyInformation": {
"type": "ATTACHMENTS",
"attachments": [
{
"id": "184e6fcc-db46-4727-b80c-2bb652d9b58b" // identyfikator załącznika (“SAFETY_INFORMATION_MANUAL”)
}
]
},
...
}
],
...
}Załączniki z informacją o bezpieczeństwie produktu (“SAFETY_INFORMATION_MANUAL”) dodasz w oparciu o zasób POST /sale/offer-attachments.
“TEXT” - jeśli informacje o bezpieczeństwie produktu przekazujesz w postaci opisu tekstowego.
Opis tekstowy musi spełniać wymagania:
- dopuszczalna liczba znaków od 1 do 5000;
- nie obsługuje tagów HTML;
- dozwolone jest dodanie znaku nowej lini “\n”;
- zawiera informacje we wszystkich wymaganych językach w zależności od tego, w których serwisach oferta jest widoczna.
{
"productSet": [
{
"safetyInformation": {
"type": "TEXT",
"description": "To jest informacja o bezpieczeństwie produktu.\n
Jedná se o bezpečnostní informace o výrobku."
},
...
}
],
...
}- “NO_SAFETY_INFORMATION” - jeśli deklarujesz, że produkt nie posiada informacji o bezpieczeństwie.
{
"productSet": [
{
"safetyInformation": {
"type": "NO_SAFETY_INFORMATION"
},
...
}
],
...
}Gdy tworzysz draft oferty:
- i wybierzesz produkt z naszego katalogu, automatycznie uzupełnimy w ofercie informacje o bezpieczeństwie, jeśli są uwzględnione po naszej stronie we wskazanym produkcie,
- możesz użyć globalnych, sugerowanych przez nas, załączników o bezpieczeństwie za pomocą GET /sale/products - wyszukaj odpowiedni produkt i pobierz dane z pola products[].productSafety.
Kategorie podobne
curl -X POST \
'https://api.allegro.pl/sale/product-offers' \
-H 'Authorization: Bearer {token}' \
-H 'Accept: application/vnd.allegro.public.v1+json' \
-H 'Content-Type: application/vnd.allegro.public.v1+json'
-d '{
"productSet": [{
"product": {
"id": "5902719471797"
}}],
"category": {
"id": "305121" // id kategorii podobnej, czyli jedna z
wartości, którą zwróciliśmy w
produkcie w liście category.similar
},
"sellingMode": {
"price": {
"amount": "29.01",
"currency": "PLN"
}
},
"stock": {
"available": 199
},
"afterSalesServices": {
"impliedWarranty": null,
"returnPolicy": null,
"warranty": null
},
"location": {
"countryCode": "PL",
"province": "KUJAWSKO_POMORSKIE",
"city": "Żnin",
"postCode": "88-400"
},
"parameters":[
{
"id":"11323",
"valuesIds":[
"11323_1"
]
}
],
"description": {
"sections": [
{
"items": [
{
"type": "TEXT",
"content": "<p>Przykładowy opis</p>"
}
]
}
]
}
}'Niektóre produkty pasują do wielu kategorii, dlatego możesz je wykorzystać, aby wystawić ofertę w jednej z kategorii podobnych.
Aby uzyskać zbiór kategorii podobnych - skorzystaj z GET /sale/products/{productId}. W odpowiedzi zwrócimy listę category.similar, w której wskazujemy id kategorii podobnych.
Listy kategorii podobnych są definiowane przez nas - są one zwracane w odpowiedzi na GET /sale/products/{productId} i nie możesz tworzyć ich samodzielnie.
Przykładowy request:
curl -X GET \
'https://api.allegro.pl/sale/products/b2b61e23-b580-4471-b653-6ed25fd179f7' \
-H 'Authorization: Bearer {token}' \
-H 'accept: application/vnd.allegro.public.v1+json'Przykładowy response:
{
"id": "b2b61e23-b580-4471-b653-6ed25fd179f7",
"name": "BIO Pochodnia",
"category": {
"id": "261573",
"similar": [
{
"id": "110914"
},
{
"id": "305121"
}
]
}
…
}Kategorie mogą różnić się dostępnymi w nich parametrami, dlatego część uzupełnionych w produkcie parametrów może nie być zgodna z tymi możliwymi do użycia w kategorii podobnej.
Użyj GET /sale/products/{productId}?category.id={similarCategoryId}, a w parametrze category.id podaj jeden identyfikator ze zwróconego przez nas zbioru kategorii podobnych.
Dzięki temu wyfiltrujesz uzupełnione w produkcie parametry dla wybranej kategorii podobnej.
Aby wystawić ofertę z produktu w kategorii podobnej, rozszerz swoje żądanie w części ofertowej o pole category.id, w którym podasz identyfikator kategorii podobnej.
Jeżeli w żądaniu nie wskażesz konkretnego produkt w polu productSet[].product.id, możesz także przekazać id kategorii w części produktowej żądania. W przypadku, gdy dopasujemy na podstawie przesłanych parametrów istniejący produkt z naszego Katalogu Produktów - oferta zostanie wystawiona we wskazanej kategorii ze zbioru kategorii podobnych.
Jeżeli w odpowiedzi otrzymasz informację, aby uzupełnić brakujące parametry obowiązkowe, przekaż je w obiekcie product. Identyfikator parametru wraz z wartością sprawdzisz za pomocą GET /sale/{categoryID}/parameters.
Jak utworzyć zestaw produktowy
Jak wspomnieliśmy na początku, endpoint POST /sale/product-offers pozwala na utworzenie zestawu produktowego.
Zestaw produktowy to oferta sprzedaży, która składa się z:
- Kilku różnych produktów (maksymalnie 10), np. konsola z dodatkową grą oraz dwoma padami.
- Wielu sztuk jednego produktu (tzw. wielopak).
Zestawy produktowe utworzysz wyłącznie za pomocą zasobów /sale/product-offers w wersji public.v1.
Zestawy zdefiniujesz na podstawie:
- produktów, które istnieją w naszym Katalogu. Wystarczy, że w strukturze żądania wskażesz ID produktów lub numery GTIN;
- danych, które są potrzebne do utworzenia produktu (jeśli nie znajdziesz produktu w naszym Katalogu). W oparciu o nie przypiszemy do oferty:
- ID utworzonych produktów
- ID produktów z naszego Katalogu, które rozpoznaliśmy na podstawie przekazanych danych.
Jak utworzyć zestaw na podstawie produktów z naszego Katalogu
curl -X POST
'https://api.allegro.pl/sale/product-offers' \
-H 'Authorization: Bearer {token}' \
-H 'Accept: application/vnd.allegro.public.v1+json' \
-H 'Content-Type: application/vnd.allegro.public.v1+json' \
-d '{
"name": "Zestaw PlayStation 5 + Ratchet & Clank + 2pady",
"productSet": [
{
"product": {"id": "7b167551-0c7d-42fd-ba39-102ac5e4efc7"},
"quantity": {"value": 1} // liczba sztuk wskazanego produktu, która
wejdzie w skład pojedynczego zestawu
},
{
"product": {"id": "2903dd7e-4958-436c-8be0-491ea1ea0d85"},
"quantity": {"value": 1}
},
{
"product": {"id": "8487577e-e831-452c-83d7-d8b23b7fc1d3"},
"quantity": {"value": 2}
}
],
"sellingMode": {
"price": {
"amount": "4000.00",
"currency": "PLN"
}
},
"stock": {
"available": 99
}
}' {
"id": "7680796491",
"name": "Zestaw PlayStation 5 + Ratchet & Clank + 2pady",
"productSet": [
{
"product": {
"id": "7b167551-0c7d-42fd-ba39-102ac5e4efc7",
"publication": {
"status": "LISTED"
},
"parameters": [
{
"id": "234925",
"name": "Testowy tytuł",
"values": [
"Test LP9"
],
"valuesIds": null,
"rangeValue": null
}, ...
]
},
"quantity": {
"value": 1
}
},
{
"product": {
"id": "2903dd7e-4958-436c-8be0-491ea1ea0d85",
"publication": {
"status": "LISTED"
}
},
"quantity": {
"value": 1
}
},
{
"product": {
"id": "8487577e-e831-452c-83d7-d8b23b7fc1d3",
"publication": {
"status": "LISTED"
}
},
"quantity": {
"value": 2
}
}
],
"parameters": [
{
"id": "11323",
"name": "State",
"values": [
"New"
],
"valuesIds": [
"11323_1"
],
"rangeValue": null
}
],
"afterSalesServices": {
"impliedWarranty": {
"id": "1377b0a6-b397-4e1e-b57c-4234bd84d036"
},
"returnPolicy": {
"id": "e261d4ed-ced7-4c10-82cd-13aa26192895"
},
"warranty": null
},
"payments": {
"invoice": "VAT"
},
"sellingMode": {
"format": "BUY_NOW",
"price": {
"amount": 4000,
"currency": "PLN"
},
"startingPrice": null,
"minimalPrice": null
},
"stock": {
"available": 99,
"unit": "UNIT"
},
"location": {
"countryCode": "PL",
"province": “WIELKOPOLSKIE”,
"city": "Poznań",
"postCode": "60-166"
},
"delivery": {
"shippingRates": {
"id": "0ef455de-fc6e-4d6e-a7c8-c22aecf0b914"
},
"handlingTime": "PT24H",
"additionalInfo": null,
"shipmentDate": null
},
"publication": {
"duration": null,
"status": "ACTIVE",
"endedBy": null,
"endingAt": null,
"startingAt": null,
"republish": false,
"marketplaces": {
"base": {
"id": "allegro-pl"
},
"additional": []
}
},
"additionalMarketplaces": {
"allegro-cz": {
"sellingMode": null,
"publication": {
"state": "NOT_REQUESTED",
"refusalReasons": []
}
}
},
"description": {
"sections": [
{
"items": [
{
"type": "TEXT",
"content": "<p>Opis oferty</p>"
}
]
}
]
},
"validation": {
"errors": [],
"warnings": [],
"validatedAt": "2021-09-20T08:52:23.390Z"
},
"createdAt": "2021-09-20T08:52:23.000Z",
"updatedAt": "2021-09-20T08:52:23.390Z",
"images": [],
"external": null,
"category": {
"id": "315569"
},
"taxSettings": null,
"sizeTable": null,
"discounts": {
"wholesalePriceList": null
},
"b2b": {
"buyableOnlyByBusiness": false
}
}
Powyżej przedstawiliśmy przykład, jak utworzyć zestaw na podstawie produktów z naszego Katalogu, w którego skład wejdą:
- Konsola Sony PlayStation 5 Digital Edition - 1 sztuka
- Gra Ratchet & Clank: Rift Apart - 1 sztuka
- Kontroler Sony PS5 DualSense PAD Bezprzewodowy - 2 sztuki.
Aby to zrobić, skorzystaj z POST /sale/product-offers i przekaż w polach:
- productSet.product.id - identyfikator lub GTIN produktu z naszego Katalogu.
- productSet.quantity.value - liczba sztuk wskazanego produktu, która wejdzie w skład pojedynczego zestawu.
Request uzupełnij o dane na temat ceny i liczby sztuk.
Jak utworzyć zestaw na podstawie własnych danych produktowych
curl -X POST
'https://api.allegro.pl/sale/product-offers' \
-H 'Authorization: Bearer {token}' \
-H 'Accept: application/vnd.allegro.public.v1+json' \
-H 'Content-Type: application/vnd.allegro.public.v1+json' \
-d '
{
"sellingMode": {
"format": "BUY_NOW",
"price": {
"amount": "85",
"currency": "PLN"
}
},
"name": "Testowy produkt",
"productSet": [{
"product": {
"name": "test 12333",
"category": {
"id": "79155"
},
"images": [ "adres obrazka"
],
"parameters": [{
"id": "223545",
"values": [
"Świat Lodu i Ognia"
]
},
{
"id": "223489",
"values": [
"Elio M. García. Jr.",
"George R. R. Martin",
"Linda Antonsson"
]
},
{
"id": "75",
"valuesIds": [
"75_2"
]
},
{
"id": "74",
"values": [
"2014"
]
},
{
"id": "24648",
"valuesIds": [
"24648_1",
"24648_2"
]
},
{
"id": "223333",
"values": [
"20.5"
]
},
{
"id": "245669",
"values": [
"7860275839780"
]
},
{
"id": "223541",
"valuesIds": [
"223541_303061"
]
}
]
},
"quantity": {
"value": 1
}
},
{
"product": {
"name": "Testowy produkt",
"category": {
"id": "79155"
},
"images": [ “adres obrazka”
],
"parameters": [{
"id": "223545",
"values": [
"Ogień i krew"
]
},
{
"id": "223489",
"values": [
"George R. R. Martin"
]
},
{
"id": "75",
"valuesIds": [
"75_2"
]
},
{
"id": "74",
"values": [
"2018"
]
},
{
"id": "24648",
"valuesIds": [
"24648_1",
"24648_2"
]
},
{
"id": "223333",
"values": [
"20.5"
]
},
{
"id": "245669",
"values": [
"9788381164931"
]
},
{
"id": "223541",
"valuesIds": [
"223541_303061"
]
}
]
},
"quantity": {
"value": 1
}
}],
"stock": {
"available": "10",
"unit": "UNIT"
}
}' {
"id": "7680799058",
"name": "Testowa oferta",
"productSet": [
{
"product": {
"id": "4f60d825-e031-49e8-a84e-1db17e0f6afd",
"publication": {
"status": "PROPOSED"
},
"parameters": [
{
"id": "234925",
"name": "Testowy tytuł",
"values": [
"Test LP9"
],
"valuesIds": null,
"rangeValue": null
}, ...
]
},
"quantity": {
"value": 1
}
},
{
"product": {
"id": "65d661be-c27d-4826-88ad-8ea1d8da5325",
"publication": {
"status": "PROPOSED"
}
},
"quantity": {
"value": 1
}
}
],
"parameters": [
{
"id": "11323",
"name": "State",
"values": [
"New"
],
"valuesIds": [
"11323_1"
],
"rangeValue": null
}
],
"afterSalesServices": {
"impliedWarranty": {
"id": "1377b0a6-b397-4e1e-b57c-4234bd84d036"
},
"returnPolicy": {
"id": "e261d4ed-ced7-4c10-82cd-13aa26192895"
},
"warranty": null
},
"payments": {
"invoice": "VAT"
},
"sellingMode": {
"format": "BUY_NOW",
"price": {
"amount": 85,
"currency": "PLN"
},
"startingPrice": null,
"minimalPrice": null
},
"stock": {
"available": 10,
"unit": "UNIT"
},
"location": {
"countryCode": "PL",
"province": “WIELKOPOLSKIE”,
"city": "Poznań",
"postCode": "60-166"
},
"delivery": {
"shippingRates": {
"id": "0ef455de-fc6e-4d6e-a7c8-c22aecf0b914"
},
"handlingTime": "PT24H",
"additionalInfo": null,
"shipmentDate": null
},
"publication": {
"duration": null,
"status": "ACTIVE",
"endedBy": null,
"endingAt": null,
"startingAt": null,
"republish": false,
"marketplaces": {
"base": {
"id": "allegro-pl"
},
"additional": []
}
},
"additionalMarketplaces": {
"allegro-cz": {
"sellingMode": null,
"publication": {
"state": "NOT_REQUESTED",
"refusalReasons": []
}
}
},
"description": {
"sections": [
{
"items": [
{
"type": "TEXT",
"content": "<p>Przykładowy opis</p>"
}
]
}
]
},
"validation": {
"errors": [],
"warnings": [],
"validatedAt": "2021-09-21T12:19:24.585Z"
},
"createdAt": "2021-09-21T12:19:24.000Z",
"updatedAt": "2021-09-21T12:19:24.598Z",
"images": [
"adres obrazka"
],
"external": null,
"category": {
"id": "79155"
},
"taxSettings": null,
"sizeTable": null,
"discounts": {
"wholesalePriceList": null
},
"contact": null,
"b2b": {
"buyableOnlyByBusiness": false
}
}Aby to zrobić, skorzystaj z POST /sale/product-offers i w sekcji productSet.product, przekaż komplet danych, które opisują sprzedawane produkty. Więcej informacji, jak utworzyć nowy produkt, znajdziesz we wcześniejszej części poradnika. Request uzupełnij o dane na temat ceny i liczby sztuk.
Jak utworzyć zestaw, który składa się z wielu sztuk jednego przedmiotu
curl -X POST
'https://api.allegro.pl/sale/product-offers' \
-H 'Authorization: Bearer {token}' \
-H 'Accept: application/vnd.allegro.public.v1+json' \
-H 'Content-Type: application/vnd.allegro.public.v1+json' \
-d '
{
"name": "Tytuł oferty",
"productSet": [
{
"product": {"id": "7b167551-0c7d-42fd-ba39-102ac5e4efc7"},
"quantity": {"value": 5}
}
],
"sellingMode": {
"price": {
"amount": "50.00",
"currency": "PLN"
}
},
"stock": {
"available": 20
}
}'{
"id": "7680796491",
"name": "Tytuł oferty",
"productSet": [
{
"product": {
"id": "7b167551-0c7d-42fd-ba39-102ac5e4efc7",
"publication": {
"status": "LISTED"
},
"parameters": [
{
"id": "234925",
"name": "Testowy tytuł",
"values": [
"Test LP9"
],
"valuesIds": null,
"rangeValue": null
}, ...
]
},
"quantity": {
"value": 1
}
}
],
"parameters": [
{
"id": "11323",
"name": "State",
"values": [
"New"
],
"valuesIds": [
"11323_1"
],
"rangeValue": null
}
],
"afterSalesServices": {
"impliedWarranty": {
"id": "1377b0a6-b397-4e1e-b57c-4234bd84d036"
},
"returnPolicy": {
"id": "e261d4ed-ced7-4c10-82cd-13aa26192895"
},
"warranty": null
},
"payments": {
"invoice": "VAT"
},
"sellingMode": {
"format": "BUY_NOW",
"price": {
"amount": 4000,
"currency": "PLN"
},
"startingPrice": null,
"minimalPrice": null
},
"stock": {
"available": 99,
"unit": "UNIT"
},
"location": {
"countryCode": "PL",
"province": "WIELKOPOLSKIE",
"city": "Poznań",
"postCode": "60-166"
},
"delivery": {
"shippingRates": {
"id": "0ef455de-fc6e-4d6e-a7c8-c22aecf0b914"
},
"handlingTime": "PT24H",
"additionalInfo": null,
"shipmentDate": null
},
"publication": {
"duration": null,
"status": "ACTIVE",
"endedBy": null,
"endingAt": null,
"startingAt": null,
"republish": false,
"marketplaces": {
"base": {
"id": "allegro-pl"
},
"additional": []
}
},
"additionalMarketplaces": {
"allegro-cz": {
"sellingMode": null,
"publication": {
"state": "NOT_REQUESTED",
"refusalReasons": []
}
}
},
"description": {
"sections": [
{
"items": [
{
"type": "TEXT",
"content": "<p>Opis oferty</p>"
}
]
}
]
},
"validation": {
"errors": [],
"warnings": [],
"validatedAt": "2021-09-20T08:52:23.390Z"
},
"createdAt": "2021-09-20T08:52:23.000Z",
"updatedAt": "2021-09-20T08:52:23.390Z",
"images": [],
"external": null,
"category": {
"id": "315569"
},
"taxSettings": null,
"sizeTable": null,
"discounts": {
"wholesalePriceList": null
},
"b2b": {
"buyableOnlyByBusiness": false
}
}Aby to zrobić, skorzystaj z POST /sale/product-offers. Prócz danych produktu w sekcji productSet.product, przekaż także informację o liczbie sztuk danego przedmiotu - zrobisz to w polu productSet.quantity.value.
Katalog Produktów
Jak znaleźć produkt
Skorzystaj w tym celu z GET /sale/products. Jest to zasób, dzięki któremu wyszukasz produkty w Katalogu Allegro. W odpowiedzi otrzymasz listę dopasowanych produktów wraz z informacjami o:
- identyfikatorze produktu
- nazwie produktu
- kategorii produktu oraz kategoriach podobnych, w których także możesz wystawić dany produkt
- podstawowych parametrach produktu
- zdjęciach produktu
- opisie produktu (jeśli jest załączony w produkcie).
Cały czas pracujemy nad rozbudową naszego Katalogu produktów - aktualizujemy dane o produktach i rozszerzamy ją o kolejne kategorie.
Aby odnaleźć poszukiwany przez Ciebie produkt, skorzystaj z udostępnionych przez nas parametrów:
- fraza i tryb wyszukiwania
- język danych
- kategoria
- kategorie podobne (dodatkowy filtr, jeśli wyszukujesz po kategorii)
- filtry w danej kategorii.
W wynikach odpowiedzi możesz uwzględnić także drafty produktów. Są to produkty, które tworzymy po tym, gdy użytkownik strony Allegro przekaże nam sugestię zmiany parametrów, które identyfikują produkt. Draft produktu może od razu zostać wykorzystany przez sprzedającego, aby połączyć z nim ofertę - dzięki temu nie musi czekać na weryfikację poprawności danych, aby móc wystawić ofertę. Aktualnie drafty tworzymy wyłącznie na podstawie zgłoszeń z naszej strony internetowej. Przykładowe zapytanie, które zwróci drafty ofert to GET /sale/products?phrase=888462600712&mode=GTIN&includeDrafts=true. Z draftu określonego produktu może korzystać wyłącznie sprzedający, który go utworzył.
Fraza i tryb wyszukiwania
Przykładowy request:
curl -X GET \
'https://api.allegro.pl/sale/products?phrase=888462600712&language=pl-PL&mode=GTIN \
-H 'Authorization: Bearer {token}' \
-H 'Accept: application/vnd.allegro.public.v1+json' {
"products": [
{
"id": "5272069b-0759-4283-8ba7-7f05b416f1d9", // identyfikator produktu - użyj go w ofercie,
// by powiązać ją z produktem
"name": "Smartfon Apple iPhone 6S srebrny 128 GB", // nazwa produktu
"category": {
"id": "253002", // kategoria produktu
"path": [ // ścieżka kategorii głównej wskazanej
// w “category.id”
{
"id": "954b95b6-43cf-4104-8354-dea4d9b10ddf",
"name": "Allegro"
},
{
"id": "42540aec-367a-4e5e-b411-17c09b08e41f",
"name": "Elektronika"
},
{
"id": "4",
"name": "Telefony i Akcesoria"
},
{
"id": "165",
"name": "Smartfony i telefony komórkowe"
},
{
"id": "48978",
"name": "Apple"
},
{
"id": "253002",
"name": "iPhone 6S"
}
],
"similar": [
{
"id": "316188",
"path": [ -- ścieżka kategorii podobnej wskazanej
// w “category.similar.id”
{
"id": "954b95b6-43cf-4104-8354-dea4d9b10ddf",
"name": "Allegro"
},
{
"id": "42540aec-367a-4e5e-b411-17c09b08e41f",
"name": "Elektronika"
},
{
"id": "4",
"name": "Telefony i Akcesoria"
},
{
"id": "165",
"name": "Smartfony i telefony komórkowe"
},
{
"id": "48978",
"name": "Apple"
},
{
"id": "316188",
"name": "iPhone 12"
}
]
},
"parameters": [ // parametry produktu
{
"id": "224017", // identyfikator parametru
"name": "Kod producenta", // nazwa parametru
"valuesLabels": [ // etykieta wartości parametru
"MKQU2PM/A"
],
"values": [
"MKQU2PM/A" // wartość parametru - dla typu string
],
"unit": null, // jednostka wartości parametru. Jeśli
// dany parametr nie ma jednostki,
// zwracamy wartość null
"options": {
"identifiesProduct": true // czy parametr identyfikuje produkt
}
},
{
"id": "127448", // identyfikator parametru
"name": "Kolor", // nazwa parametru
"valuesLabels": [ // etykieta wartości parametru
"srebrny"
],
"valuesIds": [ // identyfikator wartości parametru,
"127448_8" // dla typu słownikowego
],
"unit": null, // jednostka wartości parametru. Jeśli
// dany parametr nie ma jednostki,
// zwracamy wartość null
"options": {
"identifiesProduct": true
}
},
{
"id": "202733", // identyfikator parametru
"name": "Funkcje aparatu", // nazwa parametru
"valuesLabels": [ // etykiety wartości parametrów
"HDR",
"autofocus",
"lampa błyskowa",
"panorama",
"samowyzwalacz",
"wykrywanie twarzy",
"zdjęcia seryjne"
],
"valuesIds": [ // identyfikatory wartości parametru,
"202733_1024", dla typu słownikowego wielowartościowego
"202733_2",
"202733_1",
"202733_4",
"202733_128",
"202733_32",
"202733_64"
],
"unit": null, // jednostka wartości parametru. Jeśli
dany parametr nie ma jednostki,
zwracamy wartość null
"options": {
"identifiesProduct": false
}
},
{
"id": "225693", // identyfikator parametru
"name": "EAN", // nazwa parametru
"valuesLabels": [
"888462600712" // etykieta wartości parametru
],
"values": [
"888462600712" // wartość parametru
],
"unit": null,
"options": {
"identifiesProduct": true,
"isGTIN": true // pole ma znaczenie przy sugerowaniu nowego
} produktu, jeśli parametr ma wiele wartości,
możesz przekazać tylko jedną z nich
},
...
],
"images": [ // zdjęcia produktu
{
"url": "https://a.allegroimg.com/original/00e0c9/1d7c95614fd6a7c713b075d0251a/
Smartfon-Apple-iPhone-6S-srebrny-128-GB"
}
],
"isDraft": false,
"publication": {
"status": "LISTED" // status produktu. "PROPOSED" zwracamy dla
nowych propozycji produktów i produktów z katalogu,
które nie zostały przez nas sprawdzone, "LISTED" dla
produktów z katalogu, które zostały przez nas sprawdzone,
np. zweryfikowaliśmy, że podany numer GTIN znajduje się w oficjalnej bazie GS1
},
"aiCoCreatedContent": { // informacja o tym, czy określona część produktu
(zwrócona w polu „paths”) została wygenerowana przez AI
"paths": []
}
}]}Skorzystaj z GET /sale/products i podaj jako parametry:
- Frazę, która dotyczy szukanego produktu.
- Język w jakim chcesz pobrać dane produktu.
Tryb wyszukiwania, dzięki któremu doprecyzujesz, czy podana przez Ciebie fraza to GTIN lub MPN. Pozwoli nam to lepiej dopasować wynik wyszukiwania. Parametr przyjmuje jedną z poniższych wartości:
- GTIN - wyszukamy produkty, biorąc pod uwagę tylko przypisane do nich numery GTIN.
- MPN - wyszukamy produkty, biorąc pod uwagę tylko przypisane do nich numery katalogowe producenta, np. w parametrze “Numer katalogowy części”.
Jeśli w parametrze phrase wskazujesz nazwę produktu, pozostaw mode puste.
Kategoria - w odpowiedzi, w sekcji "categories" znajdziesz informacje, ile wyników wyszukiwania znajduje się w danej kategorii. Możesz wykorzystać identyfikator danej kategorii, aby zawęzić wyniki wyszukiwania.
GET https://api.allegro.pl/sale/products?phrase=Harry Potter i Książę Półkrwi&category.id=66781Kategorie podobne - część kategorii posiada zbiór kategorii podobnych. Aby rozszerzyć wyszukiwanie produktów o zbiór kategorii podobnych, w parametrze searchFeatures przekaż wartość SIMILAR_CATEGORIES. Parametr możesz użyć tylko wtedy, gdy w tym samym requeście przekazujesz także parametr category.id.
GET https://api.allegro.pl/sale/products?phrase=karta pamięci&category.id=16242&searchFeatures=SIMILAR_CATEGORIESLiczbę wyników ze wszystkich kategorii zsumujemy dla kategorii podanej w parametrze category.id w polu categories.subcategories.count.
Jeżeli rozszerzysz swoje wyszukiwania o zbiór kategorii podobnych, nie otrzymasz w odpowiedzi filtrów. W związku z tym - nie skorzystasz z opcji filtrowania wyników.
Filtry - gdy szukasz produktu w danej kategorii, na końcu odpowiedzi - w sekcji “filters” - otrzymasz listę dostępnych filtrów. Dzięki nim możesz odpowiednio zawęzić wyniki wyszukiwania do swoich preferencji.
Lista filtrów:
Nie jest tożsama z wartościami, które otrzymasz dla GET /sale/categories/{categoryId}/parameters. Filtr tworzysz, podając identyfikator filtra i identyfikator szukanej wartości, na zasadzie {filter.id}={filter.value}.
Im niższy poziom drzewa, tym więcej filtrów możesz użyć.
Filtry działają tylko w tych kategoriach, dla których zostały zwrócone. Nie skorzystasz z filtrów bez podania kategorii.
W zapytaniu możesz podać wiele filtrów, traktujemy je jako połączone operatorem AND. W odpowiedzi zwrócimy produkty, które zawierają wszystkie wartości wskazane dla podanych filtrów.
Ignorujemy niepoprawnie użyte filtry - otrzymasz wyniki wyszukiwania, tak jakby błędny filtr nie został użyty.
Dla wartości filtrów słownikowych podajemy “count” - czyli liczbę produktów z daną wartością parametru:
Dla filtrów wykorzystanych w zapytaniu - “count” pozostaje bez zmian, czyli otrzymujesz liczbę przedmiotów dla każdej wartości filtra tak, jakby dany filtr nie był użyty.
Dla filtrów niewykorzystanych w zapytaniu - “count” przeliczymy, czyli otrzymasz liczbę produktów dla każdej wartości, która jest sumą spełniających aktualne warunki wyszukiwania i spełniających warunki wyszukiwania z użyciem konkretnej wartości.
Typy filtrów i stronicowanie
Dla GET /sale/products wyróżniamy następujące typy filtrów:
- SINGLE - filtr dla parametrów pojedynczego wyboru
- MULTI - filtr dla parametrów wielokrotnego wyboru
Filtr tworzysz podając identyfikator filtra i identyfikator szukanej wartości, na zasadzie {filter.id}={filter.value}.
Np. wyniki dla frazy iphone 6s chcesz zawęzić wg wbudowanej pamięci (filter.id=202869) o wartości 128 GB (filter.value=214189):
GET https://api.allegro.pl/sale/products?phrase=iphone%206s&category.id=253002&202869=214189Możesz podać wiele wartości dla wybranego filter.id, traktujemy je wtedy jako połączone operatorem OR - czyli zwracamy wszystkie produkty, które mają choć jedną ze wskazanych wartości.
- NUMERIC - filtr dla parametrów liczbowych Filtr tworzysz podając identyfikator filtra i zakres wartości w przyrostkach from i to, dla których chcesz otrzymać wyniki wyszukiwania, na zasadzie {filter.id}.from={value}&{filter.id}.to={value}.
Np. wyniki dla frazy Harry Potter chcesz zawęzić wg roku wydania (filter.id=74) od 2017 do 2019 roku:
GET https://api.allegro.pl/sale/products?phrase=Harry%20Potter&category.id=66781&
74.from=2017&74.to=2019- NUMERIC_SINGLE - filtr dla parametrów zakresowych Filtr tworzysz podając identyfikator filtra i szukaną wartość, na zasadzie {filter.id}={value}.
Np. wyniki dla frazy “Kosiarka spalinowa” chcesz zawęzić do modeli z wysokością koszenia (filter.id=1117823) równą 5 cm:
GET https://api.allegro.pl/sale/products?phrase=Kosiarka%20spalinowa&category.id=85213&1117823=5Jeśli warunki wyszukiwania spełnia więcej niż 30 produktów, odpowiedź podzielimy na strony.
W pierwszej odpowiedzi otrzymasz identyfikator kolejnej strony, którą możesz otrzymać tworząc odpowiedni request:
GET https://api.allegro.pl/sale/products?phrase=iphone%206s&category.id=253002&202869=214189Jak pobrać pełne dane o produkcie
Przykładowy request:
curl -X GET \
'https://api.allegro.pl/sale/products/634238b1-4385-4de7-9c00-dfa49fce16ab?language=pl-PL' \
-H 'Authorization: Bearer {token}' \
-H 'Accept: application/vnd.allegro.public.v1+json'Skorzystaj w tym celu z GET /sale/products/{productId}. Jako productId przekaż identyfikator wyszukanego wcześniej produktu. Dane produktu możesz otrzymać w różnych językach, dlatego korzystaj z parametru "language".
W odpowiedzi otrzymasz:
- identyfikator produktu
- nazwę produktu
- kategorię produktu oraz listę kategorii podobnych, w których także możesz wystawić dany produkt
- parametry produktu
- zdjęcia produktu
- opcjonalnie:
- opis produktu (jeśli jest do niego załączony)
- sekcję ‘Pasuje do'
- informację o specyfikacji TecDoc.
Jak utworzyć nowy produkt
Sprawdź, czy w danej kategorii możesz dodać produkt
Wywołaj GET /sale/categories/{categoryId}, jeśli w odpowiedz otrzymasz "productCreationEnabled"=true, w danej kategorii możesz dodać produkt.
Pamiętaj, że ofertę możesz utworzyć w tzw. liściu, czyli w kategorii najniższego rzędu, którą oznaczamy "leaf": true.
Pobierz parametry, które możesz podać w produkcie
Przykładowy request:
curl -X GET \
'https://api.allegro.pl/sale/categories/165/parameters' \
-H 'Authorization: Bearer {token}' \
-H 'Accept: application/vnd.allegro.public.v1+json' {
…
{
"id": "224017",
"name": "Kod producenta",
"type": "string",
"required": false,
"unit": null,
"requiredForProduct": true
"options": {
"variantsAllowed": false,
"variantsEqual": false,
"ambiguousValueId": null,
"dependsOnParameterId": null,
"describesProduct": true
},
"restrictions": {
"minLength": 2,
"maxLength": 35,
"allowedNumberOfValues": 1
}
},
{
"id": "202685",
"name": "Typ",
"type": "dictionary",
"required": true,
"unit": null,
"requiredForProduct": true
"options": {
"variantsAllowed": true,
"variantsEqual": false,
"ambiguousValueId": "202685_385861",
"dependsOnParameterId": null,
"describesProduct": true
},
"dictionary": [
{
"id": "202685_212929",
"value": "Smartfon",
"dependsOnValueIds": []
},
{
"id": "202685_212933",
"value": "Telefon komórkowy",
"dependsOnValueIds": []
},
{
"id": "202685_385861",
"value": "inny",
"dependsOnValueIds": []
}
],
"restrictions": {
"multipleChoices": false
}
},
...
}Gdy wiesz już, w jakiej kategorii chcesz dodać produkt, wykorzystaj GET /sale/categories/{categoryId}/parameters, by pobrać parametry dla tworzonego produktu. Wartość true w polu:
options.describesProduct - oznacza, że dany parametr jest produktowy i możesz go użyć.
requiredForProduct - oznacza, że musisz przekazać wartość dla danego parametru.
Przykładowy request dla kategorii 79153 - Fantasy:
curl -X GET \
'https://api.allegro.pl/sale/categories/79153/product-parameters' \
-H 'Authorization: Bearer {token}' \
-H 'Accept: application/vnd.allegro.public.v1+json' {
"parameters": [ // parametry dostępne dla produktu
{
"id": "223545", // identyfikator parametru
"name": "Tytuł", // nazwa parametru
"type": "string", // typ parametru - przykład dla typu string
"required": true, // czy parametr jest wymagany, by utworzyć produkt
"unit": null, // jednostka dla wartości parametru
"restrictions": { // ograniczenia dla parametru typu string
"minLength": 1, // minimalna liczba znaków
"maxLength": 200, // maksymalna liczba znaków
"allowedNumberOfValues": 1 // ile wartości można podać dla danego parametru
}
},
...
{
"id": "75", // identyfikator parametru
"name": "Okładka", // nazwa parametru
"type": "dictionary", // typ parametru - przykład dla typu słownikowego
"required": true, // czy parametr jest wymagany, by utworzyć produkt
"unit": null, // jednostka dla wartości parametru
"dictionary": [ // wartości parametru słownikowego
{
"id": "75_1", // identyfikator wartości
"value": "miękka" // wartość
},
{
"id": "75_314838",
"value": "inna"
}
],
"restrictions": { // ograniczenia dla parametru typu słownikowego
"multipleChoices": false // czy dla danego parametru można przekazać wiele wartości
}
},
{
"id": "74", // identyfikator parametru
"name": "Rok wydania", // nazwa parametru
"type": "integer", // typ parametru - przykład dla typu integer
"required": true, // czy parametr jest wymagany, by utworzyć produkt
"unit": null, // jednostka dla wartości parametru
"restrictions": { // ograniczenia dla parametru typu integer
"min": 1400, // minimalna wartość
"max": 2099, // maksymalna wartość
"range": false // czy dla danego parametru można przekazać zakres wartości
}
},
...
{
"id": "223333", // identyfikator parametru
"name": "Szerokość produktu", // nazwa parametru
"type": "float", // typ parametru - przykład dla typu float
"required": false, // czy parametr jest wymagany, by utworzyć produkt
"unit": "cm", // jednostka dla wartości parametru
"restrictions": { // ograniczenia dla parametru typu float
"min": 1.0, // minimalna wartość
"max": 250.0, // maksymalna wartość
"range": false, // czy dla danego parametru można przekazać zakres wartości
"precision": 2 // określa dopuszczalną liczbę miejsc po przecinku,
które można przekazać w wartości dla tego parametru
}}]}Aby pobrać parametry potrzebne do utworzenia produktu, możesz także skorzystać z GET /sale/categories/{categoryId}/product-parameters.
Dodaj zdjęcia produktu
Przy pomocy POST /sale/images prześlesz zdjęcie na nasze serwery protokołem HTTP lub HTTPS.
Zdjęcia możesz przesłać na dwa sposoby:
w postaci linku
w postaci binarnej.
W odpowiedzi otrzymasz adres zdjęcia. Do produktu musisz dodać co najmniej jedno zdjęcie, natomiast maksymalnie możesz dodać 16 zdjęć. Obowiązują te same zasady, jak dla zdjęć w ofercie. Więcej informacji na ten temat znajdziesz w poradniku Jak wystawić ofertę.
Opisz produkt
Podobnie jak dla oferty, dla produktu możesz przesłać również opis. Dla opisu obowiązują te same zasady, jak dla oferty. Tworzysz go też w identyczny sposób. Szczegółowe informacje o tym, jaka jest struktura opisu, z jakich elementów utworzyć opis oraz jakich znaków możesz użyć w opisie, znajdziesz w poradniku Jak wystawić ofertę.
Dodaj propozycję produktu
curl -X POST \
'https://api.allegro.pl/sale/product-proposals' \
-H 'Authorization: Bearer {token}' \
-H 'Content-Type: application/vnd.allegro.public.v1+json' \
-H 'Accept: application/vnd.allegro.public.v1+json' \
-d '{
"name": "Świat Lodu i Ognia George R. R. Martin i inni", // wymagane, sugerowana nazwa produktu
// (max. 50 znaków)
"category": {
"id": "79157" // wymagane, identyfikator kategorii
},
"language": "pl-PL", // wymagane, język, w którym przesyłasz dane produktu
"parameters": [ // wymagane, tablica parametrów produktu
{
"id": "223545", // wymagane, identyfikator parametru
"values": [
"Świat Lodu i Ognia" // wartość parametru typu string (na przykładzie tytułu)
]
},
{
"id": "223489",
"values": [ // wartości parametru typu string
"Elio M. García. Jr.", // z wieloma wartościami (na przykładzie autora)
"George R. R. Martin",
"Linda Antonsson"
]
},
{
"id": "75",
"valuesIds": [
"75_2" // wartość parametru typu słownikowego (na przykładzie okładki)
]
},
{
"id": "74",
"values": [
"2014" // wartość parametru typu integer (na przykładzie roku wydania)
]
},
{
"id": "24648",
"valuesIds": [ // wartość parametru typu słownikowego
"24648_1", // wielowartościowego (na przykładzie wydania)
"24648_2"
]
},
{
"id": "223333",
"values": [ // wartość parametru typu float
"20.5" // (na przykładzie szerokości produktu)
]
},
{
"id": "245669", // parametr GTIN
"name": "ISBN",
"valuesLabels": [
"9788380082434"
],
"values": [
"9788380082434" // wartość parametru GTIN (za pomocą
// GET /sale/categories/{categoryId}/parameters sprawdź
// w polu requiredForProduct w parametrze GTIN,
// czy musisz podać przynajmniej jeden numer GTIN)
],
"unit": null,
"options": {
"identifiesProduct": true,
"isGTIN": true
}
}
],
"images": [ // wymagane conajmniej 1, zdjęcia produktu
{
"url": "https://a.allegroimg.com/original/03d68a/6092f8024506a01087c820e58f0c"
}
],
"description": { // opis produktu
"sections": [
{
"items": [
{
"type": "TEXT",
"content": "<p>Opis produktu</p>"
}
]
}
]
}
}}'Za pomocą zasobu POST /sale/product-proposals prześlesz propozycję produktu. Przesłane dane weryfikujemy, a zaakceptowane przez nas dane produktu są dostępne na platformie. Część danych może być weryfikowana automatycznie, część po pewnym czasie.
Gdy chcesz powiązać produkt z ofertą, skorzystaj z GET /sale/products/{product.id} i sprawdź, które dane produktu zaakceptowaliśmy i dzięki temu możesz je wykorzystać w ofercie.
Przygotuj następujące dane, by zaproponować produkt:
- język, w którym prześlesz dane produktu
- sugerowaną nazwę produktu
- kategorię
- parametry i wartości parametrów
- zdjęcia
- (opcjonalnie) opis produktu
i prześlij je za pomocą POST /sale/product-proposals. W odpowiedzi otrzymasz identyfikator produktu.
Pole "name" to sugerowana nazwa produktu. W zależności od kategorii i podanych wartości parametrów nazwę produktu:
albo stworzymy automatycznie, na podstawie wartości przekazanych parametrów,
albo stworzymy na podstawie wartości podanej w polu name.
Nazwę utworzonego produktu otrzymasz w response.
Jak identyfikujemy duplikaty
Gdy tworzysz produkt sprawdzamy jego parametry i kod EAN. Jeśli zidentyfikujemy duplikat, w odpowiedzi otrzymasz status HTTP 409 - Conflict.
Warunki i zasady dodawania produktu
Każde wywołanie zasobu POST /sale/product-proposals oznacza zgodę warunki i zasady dodawania produktu, które opisaliśmy w Załączniku nr 10 Regulaminu Allegro.
Jak zgłosić błąd w produkcie
curl -X POST 'https://api.allegro.pl/sale/products/73b31ae5-18b0-4d25-8154-47f48a628365/change-proposals' \
- H 'Authorization: Bearer {token}' \
- H 'Accept: application/vnd.allegro.public.v1+json' \
- H 'Content-type: application/vnd.allegro.public.v1+json'
- d '{
"name": "Harry Potter i kamień filozoficzny ilustrowana J.K. Rowling", // wymagane, nazwa produktu
"category": {
"id": "260395"
},
"parameters": [ // wymagane parametry oznaczone dla danej kategorii jako
// "requiredForProduct": true
{
"id": "1", // przykład dla wartości tekstowej
"values": [
"Harry Potter i kamień filozoficzny"
]
},
{
"id": "2", // przykład dla wartości słownikowej
"valuesIds": [
"2_3"
]
},
{
"id": "4", // przykład dla wartości zakresowej
"rangeValue": {
"from": "5",
"to": "6"
}
},
{
"id": "7", // przykład dla wartości własnej spoza słownika
"valuesIds": [
"7_8"
],
"values": [
"Wartość własna spoza słownika"
]
}
],
"images": [ // wymagane co najmniej 1 zdjęcia produktu
{
"url": "https://a.allegroimg.com/original/003006/187e52b840ceac70c0782d2bceba"
}
],
"note": "Nazwa produktu jest niepoprawna, proszę o zmianę", // informacje dodatkowe dla osób weryfikujących zgłoszenia
"notifyViaEmailAfterVerification": true, // czy chcesz otrzymać powiadomienie email po rozpatrzeniu sugestii
"language": "pl-PL" // język dostarczanych danych w sugestii zmian w produkcie (obowiązkowy)
}'{
"id": "96224dbf-64b5-46a3-9218-7376299a4051", // identyfikator zgłoszenia
"name": {
"current": "Harry Potter i kamień filozoficzny", // aktualna nazwa produktu
"proposal": "Harry Potter i kamień filozoficzny ilustrowana J.K. Rowling",
// proponowana nazwa produktu
"reason": "Oczekuje na weryfikację", // komunikat o statusie zgłoszenia
"resolutionType": "UNRESOLVED" // status zgłoszenia
},
"images": [ // zdjęcia produktu
{
"current": null,
"proposal": "https://a.allegroimg.com/original/003006/187e52b840ceac70c0782d2bceba",
"reason": "Oczekuje na weryfikację",
"resolutionType": "UNRESOLVED"
},
{
"current": "https://a.allegroimg.com/original/116185/c482db7840d8bd3e3f0fc411b5e2",
"proposal": null,
"reason": "Oczekuje na weryfikację",
"resolutionType": "UNRESOLVED"
}
],
"parameters": [], // parametry
"category": null,
"note": "Aktualne zdjęcie nie należy do tego produktu", // informacje dodatkowe od
zgłaszającego
"notifyViaEmailAfterVerification": true, // czy chcesz otrzymać powiadomienie
email po rozpatrzeniu sugestii
"language": "pl-PL" -- język dostarczanych danych w sugestii zmian w produkcie
}Za pomocą POST /sale/products/{productId}/change-proposals prześlesz sugestię zmiany w produkcie. Podaj swój docelowy wygląd produktu.
Dane, które musisz podać:
- nazwa produktu
- kategoria - zmiana kategorii wymaga podania wszystkich parametrów wymaganych w ramach tej nowej kategorii
- parametry - wszystkie wymagane w ramach kategorii, w której znajduje się produkt
- zdjęcie - przynajmniej jedno.
Aby wysłać sugestię zmiany w produkcie w innych językach niż polski, przekaż w obowiązkowym polu "language" preferowaną wartość, np. cs-CZ, en-US, pl-PL.
"id": "96224dbf-64b5-46a3-9218-7376299a4051", // identyfikator zgłoszenia
"name": {
"current": "Harry Potter i kamień filozoficzny", // aktualna nazwa produktu
"proposal": "Harry Potter i kamień filozoficzny ilustrowana J.K. Rowling", // proponowana nazwa produktu
"reason": "Propozycja zaakceptowana", // komunikat o statusie zgłoszenia
"resolutionType": "ACCEPTED" // status zgłoszenia,
dostępne wartości: UNRESOLVED,
ACCEPTED, REJECTED
},
"images": [ // zdjęcia produktu
{
"current": null,
"proposal": "https://a.allegroimg.com/original/003006/187e52b840ceac70c0782d2bceba",
"reason": "Sugerowane zdjęcie jest zdjęciem ofertowym, nie produktowym",
"resolutionType": "REJECTED"
},
{
"current": "https://a.allegroimg.com/original/116185/c482db7840d8bd3e3f0fc411b5e2",
"proposal": null,
"reason": "Zdjęcie identyfikuje produkt, więc nie możemy go usunąć",
"resolutionType": "REJECTED"
}
],
"parameters": [], // parametry
"category": null, // kategoria
"note": "Aktualne zdjęcie nie należy do tego produktu", // informacje dodatkowe od
zgłaszającego
"notifyViaEmailAfterVerification": true, // czy chcesz otrzymać powiadomienie
email po rozpatrzeniu sugestii
"language": "pl-PL" -- język dostarczanych danych w sugestii zmian w produkcie
}Aby sprawdzić status zgłoszenia, skorzystaj z GET /sale/products/change-proposals/{id}.
Najczęstsze błędy
| error code | opis błędu / rozwiązanie |
|---|---|
| "ConstraintViolationException.ProductizationMinLimitReached" | opis błędu / rozwiązanie Nie możesz wystawić oferty bez powiązanego produktu w tej kategorii. Wybierz z katalogu lub utwórz nowy produkt i połącz go ze swoją ofertą. |
| "ProductNotFoundException" | opis błędu / rozwiązanie Nie odnaleźliśmy produktu dla wskazanego identyfikatora w polu product.id. Wyszukaj prawidłowy produkt za pomocą GET /sale/products i uwzględnij go w ofercie. |
| "MultipleProductsFoundException" | opis błędu / rozwiązanie Wskazujesz GTIN, dla którego posiadamy więcej niż jeden produkt. Za pomocą GET /sale/products wyszukaj produkty, jakie kryją się pod danym GTIN i pobierz ID wybranego produktu. ID wstaw w polu product.id, a pole "idType" usuń lub przekaż w nim null. |
| "DuplicateDetectionMissingParametersException" | opis błędu / rozwiązanie Nie udało nam się wyszukać konkretnego produktu i uwzględnić go w ofercie na podstawie wskazanego numeru GTIN oraz parametrów. Uzupełnij brakujące parametry wskazane w "message". |
| "MatchingProductForDataNotFoundException" | opis błędu / rozwiązanie Nie udało się utworzyć produktu na podstawie wskazanego numeru GTIN. Usuń pole "product.id" i "product.idType" i spróbuj utworzyć nowy produkt. |
| "brandBlock" | opis błędu / rozwiązanie Nie możesz wystawić oferty produktu wskazanej marki, jest ona przez nas zablokowana. Jeśli chcesz dowiedzieć się więcej szczegółów, skorzystaj z formularza kontaktowego. |
| "ConstraintViolationException.NoSellBlockades" | opis błędu / rozwiązanie Na konto użytkownika, które próbuje wystawić ofertę, została nałożona blokada. Aby uzyskać więcej szczegółów, skontaktuj się z obsługą za pomocą formularza. |
| "SellerAccountWithSellBlockadeException" | opis błędu / rozwiązanie Na konto użytkownika, które próbuje utworzyć nowy produkt, została nałożona blokada. Aby uzyskać więcej szczegółów, skontaktuj się z obsługą za pomocą formularza. |
| "offerCounter" | opis błędu / rozwiązanie Posiadasz już 5 ofert danego produktu, nie możesz utworzyć kolejnej lub edytować aktualnej. Więcej informacji na ten temat znajdziesz w newsie. |
| "ConstraintViolationException.MaxInactiveOffers" | opis błędu / rozwiązanie Konto osiągnęło już maksymalny limit draftów ofert (20 000). Usuń część z nich za pomocą DELETE /sale/offers/{offerID}, aby móc utworzyć nowe. |
| "B2B_OFFER_LIMIT_EXCEEDED" | opis błędu / rozwiązanie Nie możesz mieć więcej niż 30 000 aktywnych ofert B2B. Zakończ istniejącą ofertę dla biznesu przed wystawieniem nowej. |
| "ConstraintViolationException.CategorySellingRestrictions" | opis błędu / rozwiązanie Nie możesz wystawiać ofert w tej kategorii. Aby otrzymać więcej szczegółów, skontaktuj się przez formularz kontaktowy. |
| "UnknownJSONProperty" | opis błędu / rozwiązanie Wysyłasz w zapytaniu nadmiarowe pola, które nie są opisane w dokumentacji. Szczegółowe informacje znajdziesz w polu "metadata". Usuń niepotrzebne pola. |
| "RequiredProductName" | opis błędu / rozwiązanie Próbujesz utworzyć nowy produkt, jednak nie przekazujesz nam nazwy. Uzupełnij ją w polu productSet.product.name. |
| "MissingRequiredParameters" | opis błędu / rozwiązanie W przesyłanym żądaniu brakuje wymaganych parametrów. Upewnij się, że w sekcjach product.parameters i parameters przesyłasz wszystkie parametry oznaczone jako required w odpowiedzi GET /sale/categories/{categoryId}/parameters. |
| "PARAMETER_MISMATCH" | opis błędu / rozwiązanie Na podstawie przekazanych danych wykryliśmy istniejący produkt w naszym Katalogu i próbujemy uwzględnić go ofercie. Jest to jednak niemożliwe ze względu na rozbieżność między wartością parametru wskazaną przez sprzedawcę, a wartością w katalogu. W takiej sytuacji możesz poprawić wartość parametru w swoim żądaniu lub - jeśli jesteś pewien, że Twoja wartość jest prawidłowa - zgłosić sugestię zmiany danych w produkcie. ID odnalezionego produktu znajdziesz w polu "metadata". |
| "ParameterIdNotFoundException" | opis błędu / rozwiązanie W żądaniu uwzględniono parametr, który nie występuje w danej kategorii, usuń go. Listę dostępnych parametrów pobierzesz za pomocą GET /sale/categories/{categoryId}/parameters. |
| "DictionaryParameterIdNotFound" | opis błędu / rozwiązanie Podano nieistniejący identyfikator wartości słownikowej dla parametru wskazanego w "message". Sprawdź dostępne wartości za pomocą GET /sale/categories/{categoryId}/parameters. |
| "ConstraintViolationException.DependencyValidator" | opis błędu / rozwiązanie Błąd walidacji parametrów zależnych. Wystąpi , gdy np. dla parametru zależnego od innego parametru wybrałeś niedozwoloną wartość, np. dla parametru "Stan" wybrano "Nowy", ale w parametrze "Stan opakowania" wybrano "Brak opakowania". Więcej na temat parametrów zależnych przeczytasz w naszym artykule. |
| "InvalidDictionaryParameterValueId" | opis błędu / rozwiązanie W parametrze słownikowym przekazano identyfikator wartości, która nie znajduje się w zbiorze dostępnych wartości. Sprawdź dostępne wartości za pomocą GET /sale/categories/{categoryId}/parameters. |
| "NonExistingValueInDictionaryParameter" | opis błędu / rozwiązanie W parametrze słownikowym przekazano identyfikator wartości, która nie znajduje się w zbiorze dostępnych wartości. Sprawdź dostępne wartości za pomocą GET /sale/categories/{categoryId}/parameters. |
| "DuplicatedValuesInDictionaryParameter" | opis błędu / rozwiązanie W parametrze słownikowym przekazano dwa razy tą samą wartość, usuń jedną z nich. |
| "NonNumericValueInNumberParameter" | opis błędu / rozwiązanie Wartość, którą przesyłasz w danym parametrze nie jest liczbą. Upewnij się, że wysyłasz ją w prawidłowym formacie. |
| "InvalidPrefixRestrictedCirculationNumbersInGtinParameter" | opis błędu / rozwiązanie Prefiks przekazanego EAN (GTIN) wskazuje, że jest to Numer Ograniczonej Dystrybucji - RCN i nie może być wykorzystany na Allegro. Skontaktuj się z dystrybutorem, wydawcą lub producentem i uzyskaj poprawny numer EAN (GTIN). Więcej na ten temat przeczytasz w artykule dla sprzedających. |
| "ConstraintViolationException.PrefixNotExistsInGtinParameter" | opis błędu / rozwiązanie W parametrze GTIN użyto nieprawidłowego prefiksu. GS1 nie nadaje numerów EAN (GTIN), które zaczynają się od wskazanej wartości. Skontaktuj się z dystrybutorem, wydawcą lub producentem i uzyskaj poprawny numer EAN (GTIN). Więcej szczegółów znajdziesz na stronie dla sprzedających. |
| "ConstraintViolationException.WrongChecksumInGtinParameter" | opis błędu / rozwiązanie W parametrze GTIN przekazano nieprawidłową wartość. Upewnij się, że jest ona zgodna z wymogami, które opisaliśmy na stronie dla sprzedających. |
| "ConstraintViolationException.InvalidCharacterInGtinParameter" | opis błędu / rozwiązanie W parametrze GTIN przekazano niedopuszalny znak. Upewnij się, że wartość jest zgodna z wymogami, które opisaliśmy na stronie dla sprzedających. |
| "NotStandardLengthInGtinParameter" | opis błędu / rozwiązanie Przekazano zbyt długą wartość parametru GTIN. Dopuszczalna długość to 8, 10, 12, 13 lub 14 znaków. |
| "InvalidDictionaryParameter" | opis błędu / rozwiązanie Podany identyfikator wartości słownikowej w polu "valuesIds" nie jest spójny z wartością w "values". Upewnij się za pomocą GET /sale/categories/{categoryId}/parameters, jakie są prawidłowe wartości dla danego parametru. |
| "ConstraintViolationException.NoValueInDictionaryParameter" | opis błędu / rozwiązanie W strukturze wskazano ID parametru słownikowego, jednak nie przekazano dla niego żadnej wartości - uzupełnij ją w polu "valuesIds" lub "values". Przykłady znajdziesz w naszym poradniku. |
| "ImproperlyAssignedDictionaryParameter" | opis błędu / rozwiązanie W strukturze wskazano ID parametru słownikowego, jednak nie przekazano dla niego żadnej wartości lub wskazano ja błędnie - uzupełnij ją w polu "valuesIds" lub "values". Przykłady znajdziesz w naszym poradniku. |
| "DictionaryParameterValueNotFound" | opis błędu / rozwiązanie Przekazano nieistniejącą wartość słownikową dla parametru wskazanego w "message". Sprawdź dostępne wartości za pomocą GET /sale/categories/{categoryId}/parameters. |
| "TooHighRangeToValueInRangeParameter" | opis błędu / rozwiązanie Przekazano zbyt wysoką wartość w parametrze zakresowym, w polu "rangeValue.to". Zakres wartości, jaki możesz wprowadzisz, sprawdzisz za pomocą GET /sale/categories/{categoryID}/parameters, w polu "restrictions". |
| "ConstraintViolationException.TooLongValueInStringParameter" | opis błędu / rozwiązanie Przekazano zbyt długo wartość w parametrze typu string, w polu "values". Maksymalne długości, jakie możesz wprowadzisz, sprawdzisz za pomocą GET /sale/categories/{categoryID}/parameters, w polu "restrictions". |
| "IllegalCharactersInStringParameter" | opis błędu / rozwiązanie Przekazano niedozwolony znak w parametrze typu string, np. niedozwolony znak unicode. |
| "ParameterCategoryException" | opis błędu / rozwiązanie Parametr opisujący produkt przekazujesz w sekcji ofertowej ("parameters") zamiast w produktowej ("productSet.product.parameters") lub odwrotnie. Za pomocą GET /sale/categories/{categoryId}/parameters i pola "options.describesProducts" sprawdź, czy parameter jest produktowy (true ) lub ofertowy (false). |
| "ConstraintViolationException.NoDuplicateIds" | opis błędu / rozwiązanie Jeden z parametrów przekazałeś więcej niż raz, usuń nadmiarowy parametr. |
| "ConstraintViolationException.NoValuesInRangeParameter" | opis błędu / rozwiązanie Dla parametru zakresowego nie podano dwóch wymaganych wartości. Zapoznaj się z przykładową strukturą w naszym poradniku. |
| "ConstraintViolationException.NonNumericValueInRangeParameter" | opis błędu / rozwiązanie W parametrze zakresowym, w polu "rangeValue", przekazano wartość, która nie jest liczbą. |
| "ConstraintViolationException.AtLeastOneBoundry" | opis błędu / rozwiązanie Błędnie przekazano wartość dla parametru zakresowego. Nie podano dolnej lub górnej granicy. Przykłady prawidłowo uzupełnionej sekcji znajdziesz w naszym poradniku. |
| "ConstraintViolationException.InvalidValueTypeInNumberParameter" | opis błędu / rozwiązanie W parametrze z wartością liczbową przekazano wartość, która nie jest całkowita. |
| "OfferCustomParametersException" | opis błędu / rozwiązanie Przekazano własną wartość w polu "values" (taką, która nie istnieje w zbiorze dostępnych wartości), mimo że dany parametr nie umożliwia takiej możliwości. Wybierz jedną z dostępnych wartości. |
| "CATEGORY_MISMATCH" | opis błędu / rozwiązanie Na podstawie przekazanych danych wykryliśmy istniejący produkt w naszym Katalogu i próbujemy uwzględnić go ofercie. Jest to jednak niemożliwe ze względu na rozbieżność między kategorią wskazaną przez sprzedawcę, a kategorią w katalogu. W takiej sytuacji możesz poprawić kategorię w swoim żądaniu lub - jeśli jesteś pewien, że Twoja wartość jest prawidłowa - zgłosić sugestię zmiany danych w produkcie. |
| "CATEGORY_NOT_EXISTS" | opis błędu / rozwiązanie Kategoria, w której próbujesz utworzyć produkt, nie istnieje. Zaktulizuj drzewo kategorii po swojej stronie za pomocą GET /sale/categories. |
| "MissedCategoryIdException" | opis błędu / rozwiązanie Nie przekazano ID kategorii, w której chcesz wystawić ofertę produktu. Listę dostępnych kategorii pobierzesz za pomocą GET /sale/categories, możesz również z zasobu, w którym podpowiadamy kategorię na podstawie wskazanej frazy - GET /sale/matching-categories. |
| "ProductConstraintViolationException.DataIntegrity" | opis błędu / rozwiązanie Na podstawie przekazanych danych wykryliśmy istniejący produkt w naszym Katalogu i próbujemy uwzględnić go ofercie. Jest to jednak niemożliwe ze względu na rozbieżność między danymi wskazanymi przez sprzedawcę, a danymi w katalogu. W takiej sytuacji możesz poprawić dane w swoim żądaniu lub - jeśli jesteś pewien, że Twoje wartości są prawidłowe - zgłosić sugestię zmiany danych w produkcie. |
| "ConstraintViolationException.GtinNotExistsInGtinParameter" | opis błędu / rozwiązanie Przekazano błędny numer GTIN. Wskaż prawidłowy numer, który istnieje w bazie GS1. |
| "ProductValidationException" | opis błędu / rozwiązanie Błąd walidacji danych produktu, zwróć uwagę na dokładną treść zwróconą w "message". |
| "ProductLanguageVersionUnavailableException" | opis błędu / rozwiązanie Aktualnie nie posiadamy produktu w wersji językowej wskazanej w polu "language" w ofercie. |
| "ConstraintViolationException.ValidTecdocSpecification" | opis błędu / rozwiązanie Wskazany produkt posiada specyfikacje techniczną TecDoc, przypisz ją do oferty. Możesz to zrobić za pomocą PATCH /sale/product-offers/{offerId}, przekazując w body requesty pole productSet.product.id wraz z identyfikatorem produktu. Automatycznie uwzględnimy dane z produktu w ofercie. |
| "ConstraintViolationException.ValidCompatibilityTable" | opis błędu / rozwiązanie Wskazana sekcja "Pasuje do" jest nieprawidłowa dla danego produktu, użyj produktowej sekcji "Pasuje do". Zaktualizuj dane produktowe w ofercie. Możesz to zrobić za pomocą PATCH /sale/product-offers/{offerId}, przekazując w body requestu pole productSet.product.id wraz z identyfikatorem produktu. Automatycznie uwzględnimy dane z produktu w ofercie. |
| "ConstraintViolationException.ValidTemporaryProduct" | opis błędu / rozwiązanie Próbujesz w ofercie użyć produktu tymczasowego, który jest przypisany do innej oferty. Skorzystaj z innego produktu z katalogu lub utwórz nowy. |
| "ConstraintViolationException.StringLength" | opis błędu / rozwiązanie Przekroczono maksymalny dopuszczalny rozmiar tytułu oferty (75 znaków, przy założeniu, że niektóre litery i symbole liczone są jako więcej niż 1 znak). |
| "ConstraintViolationException.MaxWordLength" | opis błędu / rozwiązanie Przekroczono maksymalny dopuszczalny rozmiar pojedynczego słowa w tytule oferty (30 znaków) |
| "ConstraintViolationException.CharacterNotAllowed" | opis błędu / rozwiązanie W tytule produktu lub oferty przekazujesz niedozwolony znak, usuń go. |
| "ConstraintViolationException.OfferValidation" | opis błędu / rozwiązanie Błąd powiązany z naruszeniem zasad np. dla tytułu lub treści zawartych w opisie. Zwróć uwagę na dokładną treść zwróconą w "messages". |
| "ReturnPolicyNotFoundException" | opis błędu / rozwiązanie Nie znaleźliśmy warunków zwrotów, które moglibyśmy automatycznie dodać do oferty lub wskazujesz nam ID lub nazwę warunków, które nie istnieją. Dodaj warunki zwrotów o nazwie "default" lub rozszerz swój request o pole returnPolicy.id lub returnPolicy.name i wskaż ID lub nazwę warunków zwrotów. Więcej szczegółów znajdziesz w tym fragmencie poradnika. |
| "ImpliedWarrantyNotFoundException" | opis błędu / rozwiązanie Nie znaleźliśmy warunków reklamacji, które moglibyśmy automatycznie dodać do oferty lub wskazujesz nam ID lub nazwę warunków, które nie istnieją. Dodaj warunki reklamacji o nazwie "default" lub rozszerz swój request o pole impliedWarranty.id lub impliedWarranty.name i wskaż ID lub nazwę warunków reklamacji. Więcej szczegółów znajdziesz w tym fragmencie poradnika. |
| "AfterSalesServiceConditionsOwnedBySeller" | opis błędu / rozwiązanie W polu "afterSalesServices" próbujesz użyć warunków (np. reklamacji lub zwrotów) innego sprzedawcy. Dostępne warunki reklamacji pobierzesz za pomocą GET /after-sales-service-conditions/implied-warranties , a zwrotów - przez GET /after-sales-service-conditions/return-policies. |
| "AfterSalesServiceConditionsRequiredByCompany" | opis błędu / rozwiązanie Nie znaleźliśmy warunków (zwrotów i reklamacji), które moglibyśmy automatycznie dodać do oferty. Dodaj warunki o nazwie "default" lub rozszerz swój request o pola returnPolicy.id /returnPolicy.name oraz impliedWarranty.id / impliedWarranty.name . Więcej szczegółów znajdziesz w tym fragmencie poradnika. |
| "ShippingRatesNotFoundException" | opis błędu / rozwiązanie Nie znaleźliśmy cennika dostaw, który moglibyśmy automatycznie dodać do oferty lub wskazujesz nam ID lub nazwę cennika, który nie istnieje. Dodaj cennik dostawy o nazwie "default" lub rozszerz swój request o pole deivery.shippingRates.id.id lub "delivery.shippingRates.name" i wskaż ID lub nazwę cennika dostawy. Więcej szczegółów znajdziesz w tym fragmencie poradnika. |
| "SHIPPING_RATES_ACCESS_DENIED" | opis błędu / rozwiązanie W polu "delivery.shippingRates" przekazano id lub nazwę cennika dostawy, który nalezy do innego sprzedawcy. Dostępne cenniki dostawy pobierzesz za pomocą GET /sale/shipping-rates. |
| "OfferImagesNotAvailableException" | opis błędu / rozwiązanie Nie udało się pobrać zdjęć z danych oferty. Upewnij się, że linki przekazane w sekcji "images" są poprawne i spróbuj ponownie. |
| "GallerySizeException" | opis błędu / rozwiązanie Przekroczono limit zdjęć w galerii, maksymalnie w ofercie możesz uwzględnić 16 zdjęć (wliczając w to zdjęcia z produktu). Więcej o zasadach dla zdjęc przeczytasz w naszym poradniku. |
| "ConstraintViolationException.GallerySize" | opis błędu / rozwiązanie Produkt nie posiada zdjęć, musisz uwzględnić przynajmniej jedno. |
| "DownloadError.BadRequest" | opis błędu / rozwiązanie Wystąpił problem z pobraniem zdjęć - adres URL lub format pliku jest nieprawidłowy. |
| "UploadImageRequestTimeoutException" | opis błędu / rozwiązanie Upłynął limit czasu na pobranie obrazka. |
| "DownloadError.InternalServerError" | opis błędu / rozwiązanie Wystąpił problem z pobraniem obrazka z serwera. Spróbuj powtórzyć request. Jeśli problem nadal będzie występować, załóż wątek na naszym forum w celu weryfikacji problemu. |
| "DownloadError.TooManyRequests" | opis błędu / rozwiązanie Wystąpił problem z pobraniem obrazka z serwera. Spróbuj powtórzyć request. Jeśli problem nadal będzie występować, załóż wątek na naszym forum w celu weryfikacji problemu. |
| "DownloadError.BadGateway" | opis błędu / rozwiązanie Wystąpił problem z pobraniem obrazka z serwera. Spróbuj powtórzyć request. Jeśli problem nadal będzie występować, załóż wątek na naszym forum w celu weryfikacji problemu. |
| "DownloadError.NotFound" | opis błędu / rozwiązanie Obrazek z żądania nie istnieje pod wskazaną ścieżką. Upewnij się, że adres jest prawidłowy. |
| "OfferImagesNotFoundException" | opis błędu / rozwiązanie Obrazek z żądania nie istnieje pod wskazaną ścieżką. Upewnij się, że adres jest prawidłowy. |
| "SETTING_NOT_SUPPORTED_IN_CATEGORY" | opis błędu / rozwiązanie Ustawienia dla stawki VAT, które wprowadzono w polu "taxSettings", nie są wspierane w danej kategorii. Dostępne opcje pobierzesz za pomocą GET /sale/tax-settings. |
| "ConstraintViolationException.Price" | opis błędu / rozwiązanie Podaj poprawną cenę w polu "sellingMode.price.amount". Upewnij się, że cena jest liczbą z zakresu od 1 do 1000000000. Zalecany format ceny: 0.00. |
| "VALIDATION_FAILED" | opis błędu / rozwiązanie Błąd walidacji danych w ofercie, najczęściej dotyczy braku lub błędnej ceny w ofercie. Upewnij się, że tę wartość przesyłasz poprawnie. |
| "AvailableStockMustEqualToZeroOrBeGreaterThanZero" | opis błędu / rozwiązanie Przekazano ujemną liczby sztuk. Musi ona być równa 0 lub większa - popraw wartość w polu "stock.available". |
FAQ
W polu scheduledFor przekazujesz datę z przeszłości. Aby wyeliminować ten błąd, podaj datę z przyszłości lub pozostaw to pole puste. Więcej - w naszym poradniku.
Otrzymałeś taki komunikat, ponieważ przekroczyłeś dostępny limit szkiców ofert (draftów), dotyczy to ofert z statusem INACTIVE - obecny limit to 20 000. Aby rozwiązać ten problem:
- sprawdź aktualną liczbę draftów za pomocą GET /sale/offers?publication.status=INACTIVE,
- usuń niepotrzebne za pomocą DELETE /sale/offers/{offerId}. Więcej - w naszym poradniku.
Posługujesz się tokenem uzyskanym w wyniku autoryzacji client_credentials, który nie posiada kontekstu użytkownika. Aby utworzyć draft oferty, musisz posiadać token wygenerowany przez code lub device flow.
Tak, wszystkie zasoby do edycji wielu ofert jednocześnie działają asynchronicznie, dlatego aby sprawdzić szczegóły status operacji, użyj GET /sale/offer-price-change-commands/{commandId}/tasks.
Tak, dzieje się tak ponieważ ten zasób działa asynchronicznie. Aby sprawdzić szczegółowy status realizacji zadania, użyj GET /sale/offer-publication-commands/{commandId}/tasks.
Nie, w takim przypadku skorzystaj z PATCH /sale/product-offers i w strukturze requestu przekaż tylko to pole, które chcesz zmodyfikować. Więcej na temat tego procesu znajdziesz w naszym poradniku.
Tak, może wystąpić taki przypadek, gdyż:
- np. przy niektórych laptopach może być jeden numer EAN, a laptopy będą się różniły specyfikacją techniczną np. wielkością dysku,
- np. w modzie może być jeden EAN na wiele rodzajów kolorystycznych danej odzieży.
Dlatego identyfikujemy produkty nie tylko po EAN-ie, ale też po jego parametrach. Więcej - w naszym poradniku.
Produkty tymczasowe tworzymy automatycznie w wybranych kategoriach wyłącznie na podstawie ofert, w których sprzedawca dla parametru “Stan” wybrał wartość inną niż “Nowy” oraz nie przekazał wszystkich parametrów, które identyfikują produkt (lub dla przynajmniej jednego z nich wskazał wartość niejednoznaczną), czyli np. numeru katalogowego części.
Więcej szczegółów znajdziesz w naszym newsie.
Drafty produktów to produkty, które tworzymy po tym, gdy użytkownik strony WWW Allegro przekaże nam sugestię zmiany parametrów, które identyfikują produkt. Draft produktu może od razu zostać wykorzystany przez sprzedającego, aby połączyć z nim ofertę - dzięki temu nie musi czekać na weryfikację poprawności danych, aby móc wystawić ofertę. Aktualnie drafty utworzymy wyłącznie na podstawie zgłoszeń z naszej strony internetowej.
Więcej szczegółów znajdziesz w naszym newsie.
Dzięki temu, że ceny wysyłki są niezależne od oferty i dzięki osobnemu zasobowi do cenników dostawy, będziesz mógł szybciej przeprowadzić hurtową edycję cen dostawy. Wystarczy, że wprowadzisz zmianę w cenniku dostawy, a koszt przesyłki zmieni się we wszystkich ofertach, do których przypiąłeś dany cennik. Takie rozwiązanie pozwoli dynamicznie reagować na zmiany cen u przewoźników.
Otrzymałeś taki komunikat, ponieważ przekroczyłeś dostępny limit szkiców ofert (draftów), dotyczy to ofert ze statusem “INACTIVE” - obecny limit to 20 000. Aby rozwiązać ten problem:
- sprawdź aktualną liczbę draftów za pomocą GET /sale/offers?publication.status=INACTIVE
- usuń niepotrzebne za pomocą DELETE /sale/offers/{offerId}}.
Posługujesz się tokenem uzyskanym w wyniku autoryzacji client_credentials, który nie posiada kontekstu użytkownika. Aby utworzyć draft oferty, musisz posiadać token wygenerowany przez code lub device flow.
Tak, dzieje się tak ponieważ ten zasób działa asynchronicznie. Aby sprawdzić szczegółowy status realizacji zadania, użyj GET /sale/offer-publication-commands/{commandId}/tasks.
Upewnij się, że podałeś odpowiednie i poprawne dane wejściowe w wywołaniu GET /sale/products.
Katalog produktów cały czas rozbudowujemy - powtórz wyszukiwanie za jakiś czas i sprawdź, czy produkt jest już dostępny.
Dodaj produkt przez POST /sale/product-proposals lub przy tworzeniu oferty za pomocą POST /sale/product-offers.
Zmiany w danych produktu możesz zgłosić przez formularz kontaktowy, lub za pomocą POST /sale/products/{productId}/change-proposals. Takie zgłoszenia są przez nas weryfikowane i - jeśli uznamy je za zasadne - odpowiednie zmiany wprowadzamy w danych produktu.
Możesz nadpisać tylko te parametry, które nie identyfikują produktu, czyli te, dla których zwracamy wartość false w polu "options.identifiesProduct" w odpowiedzi dla GET /sale/products/{productId}. Parametry, które identyfikują produkt muszą być zgodne z tymi zapisanymi w naszym Katalogu. Jeżeli uważasz, że dane produktu zapisane w naszym Katalogu Produktów nie są zgodne z rzeczywistością - możesz zaproponować zmianę w produkcie za pomocą GET /sale/products/{productId}/change-proposals.
Tak, jest to możliwe. Działa to tak samo, jak w przypadku /sale/offers:
- utwórz najpierw draft ogłoszenia (oferta w statusie "INACTIVE"), zrobimy to od razu, jeżeli przekażesz w "sellingMode.format" wartość "ADVERTISEMENT", uzupełnij także wszystkie niezbędne parametry
- przypisz pakiet ogłoszeniowy za pomocą PUT /sale/offer-classifieds-packages/{offer-id}
- aktywuj ofertę, zmieniając jej status na "ACTIVE".
Lista zasobów
Pełną dokumentację zasobów w postaci pliku swagger.yaml znajdziesz tu.
Lista zasobów podstawowych opisanych w poradniku:
- POST /sale/product-offers - utwórz ofertę powiązaną z produktem
- GET /sale/products - wyszukaj produkt
- GET /sale/product-offers/{offerId}/operations/{operationId} - sprawdź status publikacji / edycji oferty
- GET /sale/product-offers/{offerId} - pobierz szczegóły oferty
- PATCH /sale/product-offers/{offerId} - edytuj ofertę
- GET /sale/categories - pobierz listę kategorii
- GET /sale/categories/{categoryId} - pobierz informacje o wskazanej kategorii
- GET /sale/categories/{categoryId}/parameters - pobierz listę parametrów dla kategorii
- POST /sale/images - dodaj zdjęcia
- GET /sale/products/{productId} - pobierz szczegółowe informacje o produkcie
- GET /sale/categories/{categoryId}/product-parameters - pobierz parametry dla tworzonego produktu
- POST /sale/product-proposals - dodaj propozycję produktu
Lista zasobów wspierających opisanych w poradniku:
- GET /sale/shipping-rates - pobierz cenniki dostawy
- GET /after-sales-service-conditions/return-policies - pobierz warunki zwrotów
- GET /after-sales-service-conditions/implied-warranties - pobierz warunki reklamacji
- GET /after-sales-service-conditions/warranties - pobierz informacje o gwarancjach
- GET /sale/size-tables - pobierz tabele rozmiarów
- POST /sale/offer-attachments - dodaj obiekt załącznika do oferty
- PUT /sale/offer-attachments/{attachmentId} - prześlij załącznik do oferty
- POST /sale/products/{productId}/change-proposals - zgłoś sugestię zmiany w produkcie
- GET /sale/products/change-proposals/{id} - pobierz status zgłoszenia zmiany w produkcie
