Allegro REST API

gdzie?

Polska | polski | PLN
  • Informacje podstawowe
  • Główne procesy
  • Uwierzytelnianie i autoryzacja
  • Wzorzec Command
  • Glosariusz
  • Lista metod
  • Pierwsze kroki
  • Wystawianie oferty z produktem
  • Serwisy zagraniczne Allegro
  • Zarządzanie ofertami
  • Oferty wielowariantowe
  • Pasuje do
  • Zarządzanie zgłoszeniami ofert do kampanii
  • Rabaty i promocje
  • Zamówienia
  • Wysyłam z Allegro
  • One Fulfillment by Allegro
  • Dyskusje
  • Konto i dane użytkownika
  • Centrum wiadomości
  • Sprawdzanie opłat
  • Wystawianie ogłoszeń
  • Publiczne oferty
FAQ
  • Aktualności
  • Changelog
Dokumentacja
Regulamin
Kontakt
  • Moje aplikacje
  • Moje aplikacje (sandbox)
  • Newsletter
  1. Allegro REST API
  2. Oferty wielowariantowe
Sprawdź kategorie
Sprawdź parametry
Utwórz ofertę wielowariantową
Edytuj ofertę wielowariantową
Pobierz listę ofert wielowariantowych
Usuń ofertę wielowariantową
FAQ
Lista zasobów

Jak utworzyć ofertę wielowariantową

Za pomocą wielowariantowości połączysz oferty tego samego produktu, ale w różnych wariantach, w ofertę wielowariantową, np. buty w różnym kolorze i rozmiarze. Więcej szczegółów na ten temat znajdziesz w naszym artykule.

Dla wielowariantowości w REST API przygotowaliśmy poniższe zasoby:

  • POST /sale/offer-variants - chcę utworzyć nową ofertę wielowariantową,

  • PUT /sale/offer-variants/{setId} - chcę edytować istniejącą ofertę wielowariantową,

  • GET /sale/offer-variants/{setId} - chcę pobrać ofertę wielowariantową,

  • GET /sale/offer-variants - chcę pobrać utworzone oferty wielowariantowe,

  • DELETE /sale/offer-variants/{setId} - chcę rozłączyć ofertę wielowariantową.

Dodatkowo, zaktualizowaliśmy poniższe zasoby o informacje o wielowariantowości:

  • GET /sale/categories/{categoryId} - chcę pobrać informacje o wybranej kategorii.

W zasobie sale/categories/{categoryId}/parameters dodaliśmy pole ‘variantsAllowed’ w tablicy ‘options’. Informujemy w nim, czy dany parametr możesz wykorzystać w wielowariantowości:

  • GET /sale/categories/{categoryId}/parameters - chcę pobrać informacje o parametrach w wybranej kategorii.

Zanim połączysz oferty przy pomocy wielowariantowości poprzez REST API, zapoznaj się z poradnikami o wielowariantowości - jak połączyć oferty i dobre praktyki. Pamiętaj, że możesz łączyć tylko aktywne oferty.

Sprawdź kategorie

Sprawdź najpierw, czy w danej kategorii możesz korzystać z wielowariantowości.

Pobierz informacje o wybranej kategorii przy pomocy GET /sale/categories/{categoryId}.

Informacje o tym, czy w danej kategorii możesz utworzyć ofertę wielowariantową z wykorzystaniem parametru kolor/wzór znajdziesz w polu ‘variantsByColorPatternAllowed’ w obiekcie ‘options’.

Jeśli wywołasz GET /sale/categories i nie podasz kategorii, otrzymasz identyfikatory głównych kategorii na Allegro. Takie identyfikatory możesz następnie użyć w wywołaniu zasobu, aby dotrzeć do kategorii najniższego rzędu. Pamiętaj, że ofertę wystawisz tylko w kategorii najniższego rzędu, która jest oznaczona "leaf": true.

Przykładowy request:

curl -X GET \
    'https://api.allegro.pl/sale/categories/{categoryId}'
    -H 'Accept: application/vnd.allegro.public.v1+json’ \
    -H ‘Accept-Language: pl' \                                            
    -H 'Authorization: Bearer {token}'
Kliknij, aby zobaczyć response
toggle visibility
{
    "id": "87913",                                -- identyfikator kategorii
    "name": "T-shirty",                           -- nazwa kategorii
    "parent": {                                   -- identyfikator kategorii nadrzędnej;
                                                  dla kategorii głównych parent, ma wartość null
      "id": "1455"
    },
    "leaf": true,                                 -- informacja, czy dana kategoria jest  kategorią
                                                  najniższego rzędu; dostępne są dwie wartości:
                                                  false (nie jest) i true (jest)
    "options": {
        "variantsByColorPatternAllowed": true,    -- informacja, czy w tej kategorii można łączyć
                                                  po kolor/wzór w wielowariantowości
        "advertisement": false,                
        "advertisementPriceOptional": false    
    }
   }

Sprawdź parametry

Następnie sprawdź, jakich parametrów możesz użyć, by łączyć oferty. Pobierzesz je za pomocą GET /sale/categories/{categoryId}/parameters.

Tym zasobem pobierzesz listę parametrów, które są dostępne w kategorii, którą wskazałeś. Informacje o tym, czy z danym parametrem możesz utworzyć ofertę wielowariantową, znajdziesz w polu ‘variantsAllowed’ w obiekcie ‘options’. Dodatkowo w polu ‘variantsEqual’ sprawdzisz, czy dany parametr we wszystkich wariantach ofert musi mieć tę samą wartość.

Przykładowy request:

curl -X GET \
    'https://api.allegro.pl/sale/categories/{categoryId}/parameters'
    -H 'Accept: application/vnd.allegro.public.v1+json' \                                           
    -H 'Authorization: Bearer {token}'
Kliknij, aby zobaczyć response
toggle visibility
{
"parameters": [                             -- lista dostępnych parametrów dla
                                            wskazanej kategorii
    {
        "id": "11323",                      -- unikalny identyfikator parametru
        "name": "Stan",                     -- nazwa parametru
        "type": "dictionary",
        "required": true,
        "unit": null,
        "options": {
            "variantsAllowed": false,       -- informacja, czy parametr można  
                                            wykorzystać w wielowariantowości.
                                            dostępne są dwie wartości:
                                            true (tak) i false (nie).
            "variantsEqual": true           -- informacja, czy parametr we wszystkich
                                            wariantach ofert musi mieć tę samą wartość
                                            dostępne są dwie wartości:
                                            true (tak) i false (nie). Jeśli otrzymamy
                                            wartość true (tak) to wszystkie warianty
                                            oferty muszą mieć tą samą wartość w tym parametrze
        },
        "dictionary": [
            {
                "id": "11323_1",
                "value": "Nowy"             -- wartość parametru
            },
            {
                "id": "11323_2",
                "value": "Używany"
            },
            {
                "id": "11323_246510",
                "value": "Nowy bez metki"
            },
            {
                "id": "11323_246514",
                "value": "Nowy z defektem"
            }
        ]
}

Jeżeli będziesz próbował tworzyć/modyfikować ofertę wielowariantową z ofertami, które posiadają różne wartości w parametrach, które przyjmują wartość "variantsEqual": true, to wyświetlimy ci błąd:

{
    "errors": [
        {
            "code": "VALIDATION_ERROR",
            "message": "Wszystkie aktywne oferty muszą posiadać identyczne
                        wartości w ramach parametrów: 127995, 128010.",
            "details": null,
            "path": null,
            "userMessage": "Wszystkie aktywne oferty muszą posiadać identyczne
                            wartości w ramach parametrów: 127995, 128010."
        }
    ]
}

Jeżeli wszystkie oferty nie mają ustawionej wartości parametru weryfikującego, możesz połączyć takie oferty. Jeżeli część ofert ma ustawioną wartość takiego parametru, a część nie, to nie możesz połączyć takich ofert.

Utwórz ofertę wielowariantową

Użyj POST /sale/offer-variants, aby utworzyć nową ofertę wielowariantową.

Parametr kolor/wzór w wielowariantowości

Parametru kolor/wzór możesz używać w wielowariantowości w polu colorPattern. Za pomocą tego parametru połączysz wybrane oferty w ofertę wielowariantową - np. taki sam model telefonu w różnych kolorach.

Jeżeli podasz taką samą wartość w polu colorPattern dla wybranych ofert, wskazujesz, że chcesz połączyć te oferty po parametrze kolor/wzór. Poniżej znajdziesz wyjaśnienie, w jaki sposób łączymy oferty według tego parametru.

  1. Posiadasz cztery oferty w tej samej kategorii:

    • Czarny Samsung Galaxy S8 z 1GB RAM
    • Czarny Samsung Galaxy S8 z 2GB RAM
    • Niebieski Samsung Galaxy S8 z 1GB RAM
    • Niebieski Samsung Galaxy S8 z 2GB RAM
  2. Każdy wariant kolorystyczny różni się zdjęciem głównym (miniaturką) - czarne telefony posiadają identyczne zdjęcie główne, analogicznie niebieskie. Dlatego aby połączyć oferty z takim samym zdjęciem, według parametru kolor/wzór, dla czarnych telefonów w polu colorPattern przekaż wartość “black”, dla niebieskich “blue”.

  3. Identyczna wartość dla wszystkich ofert , np. “black”, zwróci w odpowiedzi błąd o treści "Offers must have unique values of parameters.".

Jak połączyć oferty po parametrach 'kolor/wzór' i 'pamięć RAM':

Kliknij, aby zobaczyć request
toggle visibility
curl -X POST \
  'https://api.allegro.pl/sale/offer-variants'
  -H 'Accept: application/vnd.allegro.public.v1+json’ \
  -H 'Content-type: application/vnd.allegro.public.v1+json' \
  -H ‘Accept-Language: pl' \
  -H 'Authorization: Bearer {token}' \
    -d  '{
  "offers": [                                       -- obiekt z ofertami, które
                                                    chcesz połączyć wielowariantowością
    {
      "id": "7436547561",                           -- identyfikator oferty
      "colorPattern": "blue"                        -- pole string. maks. 50 znaków.
                                                    Sam nadajesz tę wartość. Na tej
                                                    podstawie łączymy oferty po
                                                    parametrze kolor/wzór.
    },
   {
      "id": "7436547581",                                         
      "colorPattern": "blue"                                       
    },
    {
      "id": "7436347561",
      "colorPattern": "black"
    },
    {
       "id": "7436347561",
       "colorPattern": "black"
   }
  ],
  "name": "Telefony",                               -- wymagane, nazwa oferty
                                                    wielowariantowej, nadajesz ją we własnym
                                                    zakresie, maks. 50 znaków.
                                                    Możesz jej później użyć jako wartość
                                                    parametru query, aby znaleźć odpowiednią
                                                    ofertę wielowariantową za pomocą zasobu
                                                    GET /sale/offer-variants.
  "parameters": [                                   -- tablica z parametrami, którymi
                                                    łączysz oferty. Możesz podać
                                                    maksymalnie 2 parametry. Identyfikator
                                                    parametru dla wybranej  kategorii możesz
                                                    pobrać przy pomocy GET
                                                    /sale/categories/{categoryId}/parameters -
                                                    wartość true w polu options.variantsAllowed
                                                    wskazuje, że możesz użyć w tym miejscu
                                                    wybranego parametru.        
    {
         "id": "202865"                             -- identyfikator parametru,   
                                                    którym chcesz połączyć oferty
    },
    {
        "id": "color/pattern"                       -- wartość, którą łączysz oferty -
                                                    kolor/wzór
    }
   ]
}'
Kliknij, aby zobaczyć response
toggle visibility
curl -X POST \
  'https://api.allegro.pl/sale/offer-variants'
  -H 'Accept: application/vnd.allegro.public.v1+json' \
  -H 'Content-type: application/vnd.allegro.public.v1+json' \
  -H 'Accept-Language: pl' \
  -H 'Authorization: Bearer {token}' \
    -d  '{
  "offers": [                                       -- obiekt z ofertami, które
                                                    chcesz połączyć wielowariantowością
    {
      "id": "7436547561",                           -- identyfikator oferty
      "colorPattern": "blue"                        -- pole string. maks. 50 znaków.
                                                    Sam nadajesz tę wartość. Na tej
                                                    podstawie łączymy oferty po
                                                    parametrze kolor/wzór.
    },
   {
      "id": "7436547581",                                         
      "colorPattern": "blue"                                       
    },
    {
      "id": "7436347561",
      "colorPattern": "black"
    },
    {
       "id": "7436347561",
       "colorPattern": "black"
   }
  ],
  "name": "Telefony",                               -- wymagane, nazwa oferty
                                                    wielowariantowej, nadajesz ją we własnym
                                                    zakresie, maks. 50 znaków.
                                                    Możesz jej później użyć jako wartość
                                                    parametru query, aby znaleźć odpowiednią
                                                    ofertę wielowariantową za pomocą zasobu
                                                    GET /sale/offer-variants.
  "parameters": [                                   -- tablica z parametrami, którymi
                                                    łączysz oferty. Możesz podać
                                                    maksymalnie 2 parametry. Identyfikator
                                                    parametru dla wybranej  kategorii możesz
                                                    pobrać przy pomocy GET
                                                    /sale/categories/{categoryId}/parameters -
                                                    wartość true w polu options.variantsAllowed
                                                    wskazuje, że możesz użyć w tym miejscu
                                                    wybranego parametru.        
    {
         "id": "202865"                             -- identyfikator parametru,   
                                                    którym chcesz połączyć oferty
    },
    {
        "id": "color/pattern"                       -- wartość, którą łączysz oferty -
                                                    kolor/wzór
    }
   ]
}'

Dzięki takiemu requestowi uzyskasz poniższy efekt:

w w 1 new

Przykład - jak połączyć oferty po parametrach ‘Wielkość pamięci RAM’ i ‘Liczba rdzeni procesora’:

Kliknij, aby zobaczyć request
toggle visibility
curl -X POST \
  'https://api.allegro.pl/sale/offer-variants' \
  -H 'Accept: application/vnd.allegro.public.v1+json' \
  -H 'Content-Type: application/vnd.allegro.public.v1+json' \
  -H ‘Accept-Language: pl' \
  -H 'Authorization: Bearer {token}' \
  -d '{
    "offers": [                                 
        {
            "id": "7440434493"                 
        },
        {
            "id": "7440434632"
        },
        {
            "id": "7440434772"
        },
        {
            "id": "7440434909"
        }
    ],
    "name": "Laptops",                          
    "parameters": [                             
        {
            "id": "200941"                    
        },
        {
            "id": "4329"                       
        }
    ]
}'

Dzięki takiemu requestowi uzyskasz poniższy efekt:

w w 3

W kategoriach, w których oferty połączyliśmy automatycznie

Automatycznie łączymy oferty w dziale Moda, w kategoriach odzieżowych i obuwniczych spoza działu Moda, a także w kategorii Biżuteria i zegarki. Pełną listę znajdziesz w naszym regulaminie. Tworzymy je z ofert, które posiadają identyczne zdjęcia i różne wartości parametru rozmiar (lub innego parametru określającego rozmiar).

Jeżeli wystawiłeś pojedyncze oferty np. t-shirt w rozmiarach S, M i L w kolorach niebieskim i czerwonym (pkt 1), na ich podstawie automatycznie utworzymy dwie oferty wielowariantowe, które powiążemy według parametru kolor/wzór (pkt 2). Automatycznie połączone oferty wielowariantowe rozpoznasz po nazwie - w tym przypadku nie nadajesz jej we własnym zakresie, będzie to odziedziczony tytuł jednej z ofert, która wchodzi w skład oferty wielowariantowej. Nazwa może się zmienić, jeśli automatycznie utworzoną ofertę wielowariantową połączymy z kolejnymi ofertami.

Automatycznie połączoną ofertę możesz edytować oraz rozłączać. Jeśli ją rozłączysz, nie połączymy ofert ponownie.

w wa 1

Przykładowe struktury ofert wielowariantowych, które utworzyliśmy automatycznie:

Kliknij, aby zobaczyć request
toggle visibility
{
        "id" : "97f4696e-937d-4f73-aafa-6266f85c41e5",      -- identyfikator oferty
                                                            wielowariantowej
        "offers" : [                                        -- oferty, które wchodzą
                                                            w skład oferty wielowariantowej
            {
                "id": "1",                  
            },
            {
                "id": "2",
            },
            {
                "id": "3",
            },
        ],
        "name" : "t-shirt S niebieski",                     -- nazwa oferty wielowariantowej. W
                                                            przypadku automatycznie
                                                            połączonych ofert będzie to
                                                            tytuł jednej z ofert, która wchodzi
                                                            w skład oferty wielowariantowej.
        "parameters": [
            {
                "id": "54"                                  -- parametr, który określa różne
                                                            warianty w ofercie wielowariantowej,
                                                            w tym przypadku jest to rozmiar
            }
        ]
    }
{
        "id" : "495b4825-7f45-4ea8-826f-f71e795f6daf",
        "offers" : [
            {
                "id": "4",
            },
            {
                "id": "5",
            },
            {
                "id": "6",
            },
        ],
        "name" : "t-shirt S czerwony",
        "parameters": [
            {
                "id": "54"
            }
        ]
    }

Jeżeli chcesz na podstawie ofert połączonych automatycznie utworzyć nową ofertę wielowariantową - przekaż w strukturze kilka lub wszystkie identyfikatory ofert z ofert połączonych automatycznie (pkt 3). Nowa oferta wielowymiarowa będzie zawierać wszystkie oferty, z których składa się automatycznie utworzony zestaw.

w wa 2

Ważne! Pamiętaj, jeżeli tworzysz ofertę wielowariantową, która składa się z więcej niż jednej automatycznie połączonej oferty wielowariantowej - przekaż dwa parametry, które będą decydować o różnych wariantach produktu. Jedną z wartości pola id musi być color/pattern (kolor/wzór).

Kliknij, aby zobaczyć request
toggle visibility
curl -X POST \
  'https://api.allegro.pl/sale/offer-variants' /
  -H 'Accept: application/vnd.allegro.public.v1+json' \
  -H 'Accept-Language: pl' \
  -H 'Authorization: Bearer {token}' \
-d '{
      "name": "Koszulki",                   -- wymagane, nazwa oferty
                                            wielowariantowej
      "offers": [
        {
          "id": "1",
          "colorPattern": "blue"            -- wartość, którą łączymy
                                            oferty według parametru
                                            kolor/wzór. Oferty z tym
                                            samym zdjęciem
                                            muszą mieć identyczną wartość.
        },
        {
          "id": "4",
          "colorPattern": "red"
        }
      ],
      "parameters": [                       -- w przypadku gdy tworzysz
                                            ofertę wielowariantową na podstawie
                                            ofert połączonych automatycznie,
                                            przekaż dwa parametry, z czego jednym
                                            z nich musi być color/pattern.
                                            Na podstawie tych parametrów utworzymy
                                            różne warianty produktu w ofercie
                                            wielowariantowej.
        {
            "id": "color/pattern"           -- kolor/wzór
        },
        {
            "id": "54"                      -- rozmiar
        }
      ]
}'

W odpowiedzi otrzymasz nową ofertę wielowariantową, w skład której wejdą wszystkie oferty z wcześniej utworzonych automatycznie ofert wielowariantowych, które są powiązane z identyfikatorami, przesłanymi w żądaniu (pkt 4). Oferty wielowariantowe, które utworzyliśmy automatycznie, usuniemy podczas tworzenia nowej oferty wielowariantowej.

w wa 3

Kliknij, aby zobaczyć request
toggle visibility
curl -X POST \
  'https://api.allegro.pl/sale/offer-variants' /
  -H 'Accept: application/vnd.allegro.public.v1+json' \
  -H ‘Accept-Language: pl' \
  -H 'Authorization: Bearer {token}' \
-d '{
    "id": "ae9818d7-f747-4900-9d16-adee2664f183",
    "offers": [
        {
            "id": "1",
            "colorPattern": "blue"
        },
        {
            "id": "2",
            "colorPattern": "blue"
        },
        {
            "id": "3",
            "colorPattern": "blue"
        },
        {
            "id": "4",
            "colorPattern": "red"
        },
        {
            "id": "5",
            "colorPattern": "red"
        },
        {
            "id": "6",
            "colorPattern": "red"
        }
    ],
    "name": "Koszulki",
    "parameters": [
        {
            "id": "54"
        },
        {
            "id": "color/pattern"
        }
    ]
}'

Jeżeli wystawisz nową ofertę, którą da się połączyć według parametru kolor/wzór, ale która posiada inny rozmiar, automatycznie dołączymy ją do oferty wielowariantowej, którą utworzyłeś w pkt 4.

Obsługa duplikatów

Duplikatem określamy ofertę, dla której istnieje inna oferta, którą utworzył ten sam sprzedający, z identycznym:

  • pierwszym zdjęciem,
  • parametrami,
  • kategorią.

Jeżeli wystawisz poniższe oferty, które są koszulkami:

  • ID 1, niebieska S,
  • ID 2, niebieska L,
  • ID 3, niebieska S (duplikat),
  • ID 4, czerwona S,
  • ID 5, czerwona M.

Oferty o ID 1 i 2 oraz 4 i 5 automatycznie połączymy w oferty wielowariantowe. W przypadku, gdy spróbujesz utworzyć ofertę wielowariantową, która ma się składać z ofert o ID: 1, 3 (duplikat) i 4, zakończy się to błędem 422.

Edytuj ofertę wielowariantową

Za pomocą GET /sale/offer-variants/{setId} pobierz dane oferty wielowariantowej, do której chcesz dodać nową ofertę. Jeżeli nie znasz setId, możesz go otrzymać za pomocą GET /sale/offer-variants?query={query}. Jako query wskaż nazwę oferty wielowariantowej lub identyfikator jednej z ofert, która wchodzi w jej skład.

Przykładowy request:

curl -X GET \
    'https://api.allegro.pl/sale/offer-variants/351e65c3-74c0-4644-91c8-eeb4da291d3b'
    -H 'Accept: application/vnd.allegro.public.v1+json’ \                                           
    -H 'Authorization: Bearer {token}'

Przykładowy response:

{
    "id": "351e65c3-74c0-4644-91c8-eeb4da291d3b",
    "offers": [
        {
            "id": "8569901198",
            "colorPattern": null
        },
        {
            "id": "8569899104",
            "colorPattern": null
        }
    ],
    "name": "Koszulki",
    "parameters": [
        {
            "id": "54"
        }
    ]
}

Strukturę, którą otrzymałeś, wraz z danymi nowej oferty, przekaż za pomocą PUT /sale/offer-variants/{setId}. Pamiętaj, aby jako setId przekazać identyfikator oferty wielowariantowej, którą chcesz zaktualizować.

Kliknij, aby zobaczyć request
toggle visibility
curl -X PUT \
  'https://api.allegro.pl/sale/offer-variants/351e65c3-74c0-4644-91c8-eeb4da291d3b'
  -H 'Accept: application/vnd.allegro.public.v1+json’ \
  -H 'Authorization: Bearer {token}'
  -d '{
    "id": "351e65c3-74c0-4644-91c8-eeb4da291d3b",
    "offers": [
        {
            "id": "8569901198",
            "colorPattern": null
        },
        {
            "id": "8569899104",
            "colorPattern": null
        },
        {
            "id": "8569909931",
            "colorPattern": null
        }
    ],
    "name": "Koszulki",
    "parameters": [
        {
            "id": "54"
        }
    ]
}'

W odpowiedzi otrzymasz zaktualizowaną ofertę wielowariantową.

Pamiętaj! Jeżeli do oferty wielowariantowej dodasz pojedynczą ofertę, która wchodzi w skład innej - automatycznie połączonej - oferty wielowariantowej, do edytowanej oferty dodamy wszystkie oferty połączone automatycznie. Poniżej znajdziesz przykładowy opis takiej sytuacji.

  1. Za pomocą GET /sale/offer-variants/{setID} pobieram ofertę wielowariantową, którą chcę edytować. W odpowiedzi otrzymuję:
Kliknij, aby zobaczyć response
toggle visibility
      curl -X PUT \
        'https://api.allegro.pl/sale/offer-variants/351e65c3-74c0-4644-91c8-eeb4da291d3b'
        -H 'Accept: application/vnd.allegro.public.v1+json' \
        -H 'Authorization: Bearer {token}'
        -d '{
          "id": "351e65c3-74c0-4644-91c8-eeb4da291d3b",
          "offers": [
              {
                  "id": "8569901198",
                  "colorPattern": null
              },
              {
                  "id": "8569899104",
                  "colorPattern": null
              },
              {
                  "id": "8569909931",
                  "colorPattern": null
              }
          ],
          "name": "Koszulki",
          "parameters": [
              {
                  "id": "54"
              }
          ]
      }'
  1. Odpowiedź, którą otrzymałem w poprzednim punkcie, przekazuję w strukturze za pomocą PUT /sale/offer-variants/{setId}, dodatkowo dodaję nową ofertę (lub oferty):
Kliknij, aby zobaczyć response
toggle visibility
      {
          "id": "bcf32fe3-5c7a-4b4e-95b0-290287d6f36f",   
          "offers": [                       
               {
                  "id": "8947219936",
                  "colorPattern": "blue"
              },
              {
                  "id": "8947219485",
                  "colorPattern": "blue"
              },
             {
                  "id": "8947220125",
                  "colorPattern": "green"
              },
             {
                  "id": "8947220126",
                  "colorPattern": "green"
              }
              {
                  "id": "8947220127",                 
                  "colorPattern": "yellow"
              }
          ],
          "name": "oferta_testowa",                
          "parameters": [
              {
                  "id": "54"
              },
              {
                  "id": "color/pattern"
              }
          ]
      }
  1. W odpowiedzi otrzymuję zaktualizowaną ofertę wielowariantową. Zwróć uwagę, że dodaliśmy wszystkie oferty z automatycznie utworzonej oferty wielowariantowej, z której pochodziła oferta 8947220127:
Kliknij, aby zobaczyć response
toggle visibility

      {
          "id": "bcf32fe3-5c7a-4b4e-95b0-290287d6f36f",   
          "offers": [                       
               {
                  "id": "8947219936",
                  "colorPattern": "blue"
              },
              {
                  "id": "8947219485",
                  "colorPattern": "blue"
              },
             {
                  "id": "8947220125",
                  "colorPattern": "green"
              },
             {
                  "id": "8947220126",
                  "colorPattern": "green"
              }
              {
                  "id": "8947220127",                 
                  "colorPattern": "yellow"
              },
              {
                  "id": "8947220157",                 
                  "colorPattern": "yellow"
              },
              {
                  "id": "8947220128",                 
                  "colorPattern": "yellow"
              }
          ],
          "name": "oferta_testowa",                
          "parameters": [
              {
                  "id": "54"
              },
              {
                  "id": "color/pattern"
              }
          ]
      }

Pobierz listę ofert wielowariantowych

Przy pomocy GET /sale/offer-variants pobierzesz wcześniej utworzone połączenia ofert, dla konta na którym jesteś zautoryzowany.

Możesz również pobrać listę ofert wielowariantowych dostosowaną do twoich potrzeb, używając parametrów:

  • limit - określ liczbę ofert wielowariantowych, jaką mamy zwrócić w odpowiedzi (przyjmuje wartości od 10 - 50),
  • offset - wskaż miejsce, od którego chcesz pobrać kolejną porcję danych,
  • query - przekaż nazwę oferty wielowariantowej lub identyfikator jednej z ofert, która wchodzi w jej skład.

np. GET /sale/offer-variants?limit=50&offset=50 - zwróci listę 50 ofert wielowariantowych od podanego punktu.

Przykładowy request:

curl -X GET \
    'https://api.allegro.pl/sale/offer-variants'
    -H 'Accept: application/vnd.allegro.public.v1+json' \                                           
    -H 'Authorization: Bearer {token}'

Przykładowy response:

{
    "count": 2,                                                         -- liczba ofert wielowariantowych
                                                                        utworzonych na koncie.
    "offerVariants": [
        {
            "id": "ac3ed08b-966a-47ce-9886-f5dc790b59f8",               -- UUID oferty wielowariantowej
            "name": "Bicycles"                                          -- nazwa, którą nadałeś ofercie
                                                                        wielowariantowej
        },
        {
            "id": "b6d83e16-b9d2-45a7-a20e-4b6971cbb0e2",
            "name": "Red shirts"
        }
    ]
}

Usuń ofertę wielowariantową

Ofertę wielowariantową rozłączysz za pomocą DELETE /sale/offer-variants/{setId}. Po rozłączeniu automatycznie utworzonej oferty wielowariantowej, nie połączymy ofert ponownie.

FAQ

1. Czy do oferty wielowariantowej mogę dodać oferty, które składają się na inną, utworzoną przeze mnie wcześniej, ofertę wielowariantową?

Nie, w takim przypadku otrzymasz błąd, który informuje o tym, że oferty znajdują się już w innej ofercie wielowariantowej. Możesz dodać pojedyncze oferty lub oferty, które wchodzą w skład automatycznie utworzonej oferty wielowariantowej.

2. Jak dodać oferty z utworzonej przeze mnie oferty wielowariantowej do innej, również utworzonej przeze mnie?

W tym przypadku rozłącz jedną z ofert wielowariantowych za pomocą DELETE /sale/offer-variants/{setId}. Następnie użyj PUT sale/offer-variants/{setId} i dodaj do oferty wielowariantowej oferty, które przed chwilą rozłączyłeś.

3. Czy mogę utworzyć ofertę wielowariantową zanim oferty zostaną połączone automatycznie?

Tak, pod warunkiem, że przed wysłaniem żądania zdążyliśmy przetworzyć informacje o nowych ofertach, decydujące o tym, że mogą zostać połączone według wskazanych parametrów. W przeciwnym wypadku otrzymasz błąd wraz z informacją, że trwa jeszcze przetwarzanie ofert, z których chciałeś utworzyć ofertę wielowariantową.

4. Czy mogę utworzyć ofertę wielowariantową przed aktywacją ofert?

Nie, otrzymasz wtedy odpowiedź z błędem i informacją, że nie znaleziono ofert, które przekazałeś w strukturze. Oferty muszą być w statusie ACTIVE.

5. Nie zapisałem identyfikatora oferty wielowariantowej, którą utworzyłem. Czy i w jaki sposób mogę poznać jej identyfikator?

Tak, możesz pobrać identyfikator takiej oferty. Skorzystaj w tym celu z parametru query dla zasobu GET /sale/offer-variants?query={query}. Jako wartość przekaż nazwę oferty wielowariantowej lub identyfikator jednej z ofert, która wchodzi w jej skład.

6. Co się stanie, jeśli zakończę ofertę, która wchodziła w skład oferty wielowariantowej, a następnie znów ją aktywuję?

Oferta ponownie wejdzie w skład oferty wielowariantowej.

7. Dlaczego w odpowiedzi na GET /sale/offer-variants/{id} w niektórych przypadkach uwzględnione są zakończone oferty, a w innych nie?

Nie zwracamy ofert zakończonych dla ofert wielowariantowych w kategoriach zarządzanych automatycznie - ich pełną listę można znaleźć w regulaminie. W pozostałych kategoriach oferty wielowariantowe są zarządzane ręcznie i dla nich zwracamy oferty zakończone.

Lista zasobów

Pełną dokumentację zasobów w postaci pliku swagger.yaml znajdziesz tu.

Lista zasobów podstawowych opisanych w poradniku:

  • POST /sale/offer-variants - utwórz ofertę wielowariantową
  • PUT /sale/offer-variants/{setId} - edytuj ofertę wielowariantową
  • GET /sale/offer-variants/{setId} - pobierz szczegóły oferty wielowariantowej
  • GET /sale/offer-variants - pobierz listę ofert wielowariantowych
  • DELETE /sale/offer-variants/{setId} - usuń ofertę wielowariantową

Lista zasobów wspierających opisanych w poradniku:

  • GET /sale/categories/{categoryId} - pobierz informacje o wybranej kategorii
  • GET /sale/categories/{categoryId}/parameters - pobierz listę parametrów dla kategorii

Zgłoś błąd lub zasugeruj zmianę

Czy ten artykuł był dla Ciebie przydatny?