Nowe zasoby - Zarządzaj tagami i załącznikami w ofertach - Allegro Developer Portal

25 września 2018

Nowe zasoby - Zarządzaj tagami i załącznikami w ofertach

Udostępniliśmy zestaw zasobów do zarządzania tagami w ofertach oraz do dodawania załączników. Uzupełniliśmy także o tagi i załączniki nasz poradnik “Jak wystawić ofertę w Allegro REST API”.

Załączniki

Uzupełniliśmy nasz poradnik “Jak wystawić ofertę w Allegro REST API” o informacje jak dodać załączniki do oferty. Dodatkowo w zasobach:

POST /sale/offers
GET /sale/offers/{offerId}
PUT /sale/offers/{offerId}

dodaliśmy strukturę attachments dla załączników.

"attachments": [
            {
                "id": "attachmentId"
            }
        ]

Tagi

Przygotowaliśmy także zestaw zasobów, za pomocą których możesz zarządzać tagami w serwisie Allegro:

GET /sale/offer-tags?user.id={user_ID} - chcę pobrać wszystkie tagi, które są dodane na moim koncie.
POST /sale/offer-tags - chcę dodać tagi do mojego konta.
DELETE /sale/offer-tags/{tag_ID} - chcę usunąć tag z mojego konta.
PUT /sale/offer-tags/{tag_ID} - chcę zmienić nazwę taga na moim koncie.
GET /sale/offers/{offer_ID}/tags - chcę pobrać tagi, które są przypisane do mojej oferty.
POST /sale/offers/{offer_ID}/tags - chcę przypisać tagi do mojej oferty.

Sprawdź w jaki sposób możesz z nich korzystać:

GET /sale/offer-tags?user.id={userId}

Ten zasób pozwoli Ci, jako zalogowanemu sprzedawcy, pobrać wszystkie tagi, które są dostępne na twoim koncie.

Przykładowy request

curl -X GET \
  http://api.allegro.pl/sale/offer-tags?user.id={userId} \
  -H 'accept: application/vnd.allegro.public.v1+json' \
  -H 'authorization: Bearer {token}

Przykładowy response 200 - OK - poprawnie zwrócona informacja o tagach na koncie

{
    "tags": [
        {
            "id": "500fedd3-2140-4225-87d4-a22484222776",   -- identyfikator taga,
            "name": "Komiksy",                              -- nazwa taga,
            "hidden": false                                 -- informacja czy tag jest ukryty,
                                                               przyjmuje wartości false (tag
                                                               jest widoczny) oraz true (tag
                                                               jest ukryty),
        },
        {
            "id": "d2d2d475-7049-493d-bb95-f4ea59983ecb",
            "name": "Filmy",
            "hidden": false
        },
        {
            "id": "4b876428-d827-492b-a30e-aee3f5be791a",
            "name": "Muzyka",
            "hidden": false
        }
    ]
}

POST /sale/offer-tags

Ten zasób pozwoli Ci, jako zalogowanemu sprzedawcy, dodać tagi do twojego konta.

Przykładowy request

curl -X POST \
  https://api.allegro.pl/sale/offer-tags \
  -H 'accept: application/vnd.allegro.public.v1+json' \
  -H 'content-type: application/vnd.allegro.public.v1+json' \
  -H 'authorization: Bearer {token}' 
  -d '{
    "name": "testowy"                                       -- wymagane, nazwa taga 
                                                               (długość max 25 znaków)
}'

Przykładowy response 200 - OK - poprawnie stworzony tag

{
    "id": "72e3a879-b22a-4dfb-a2e0-89ff2b3f4b48"            -- identyfikator taga,
}

DELETE /sale/offer-tags/{tagId}

Ten zasób pozwoli Ci, jako zalogowanemu sprzedawcy, usunąć tag z twojego konta.

Przykładowy request

curl -X DELETE \
  https://api.allegro.pl/sale/offer-tags/{tagId} \
  -H 'accept: application/vnd.allegro.public.v1+json' \
  -H 'authorization: Bearer {token}'

Przykładowy response 204 - no content - tag usunięty prawidłowo

PUT /sale/offer-tags/{tagId}

Ten zasób pozwoli Ci, jako zalogowanemu sprzedawcy, zmienić nazwę taga na twoim koncie.

Przykładowy request

curl -X PUT \
  https://api.allegro.pl/sale/offer-tags/{tagId} \
  -H 'content-type: application/vnd.allegro.public.v1+json' \
  -H 'accept: application/vnd.allegro.public.v1+json' \
  -H 'authorization: Bearer {token}' 
  -d '{
    "name": "testowy2"                                       -- wymagany, nowa nazwa taga
}'

Przykładowy response 200 - OK - poprawnie przypisane tagi

GET /sale/offers/{offerId}/tags

Ten zasób pozwoli Ci, jako zalogowanemu sprzedawcy, pobrać tagi, które są przypisane do twojej oferty.

Przykładowy request

curl -X GET \
  https://api.allegro.pl/sale/offers/{offerId}/tags \
  -H 'accept: application/vnd.allegro.public.v1+json' \
  -H 'authorization: Bearer {token}'

Przykładowy response 200 - OK - poprawnie przypisane tagi

{
    "tags": [
        {
            "id": "500fedd3-2140-4225-87d4-a22484222776",    -- identyfikator taga,
            "name": "Komiksy",                               -- nazwa taga, 
            "hidden": false                                  -- informacja czy tag jest ukryty,
                                                                przyjmuje wartości false (tag
                                                                jest widoczny) oraz true (tag
                                                                jest ukryty),
        }
        {
            "id": "d2d2d475-7049-493d-bb95-f4ea59983ecb",      
            "name": "Filmy",                                                     
            "hidden": false                                                             
        }
    ]
}

POST /sale/offers/{offerId}/tags

Ten zasób pozwoli Ci, jako zalogowanemu sprzedawcy, przypisać wybrane tagi do twojej oferty.

Przykładowy request

curl -X POST \
  http://api.allegro.pl/sale/offers/{offerId}/tags \
  -H 'accept: application/vnd.allegro.public.v1+json' \
  -H 'content-type: application/vnd.allegro.public.v1+json' \
  -H 'authorization: Bearer {token} 

  -d '{
    "tags": [
        {
            "id": "500fedd3-2140-4225-87d4-a22484222776"      -- wymagany, identyfikator taga,
        }
    ]
}'

Przykładowy response 200 - OK - poprawnie przypisane tagi

25 września 2018