Uwierzytelnianie i autoryzacja

Wszystkie żądania zasobów REST API wymagają przekazania tokena OAuth w nagłówku Authorization. Więcej o autoryzacji za pomocą OAuth przeczytasz w dedykowanym artykule.

Oferta i produktyzacja

Metody Informacje
Informacje o ofercie GET /sale/offers

GET /sale/offers/{offerId}
GET /sale/offer-events

- informacje o ofertach zalogowanego użytkownika.+
- pobierz dane szczegółowe oferty.+
- pobierz dziennik zdarzeń w ofertach sprzedawcy.+
Zarządzanie ofertą POST /sale/offers
PUT /sale/offers/{offerId}
DELETE /sale/offers/{offerId}
- dodaj szkic oferty.+
- uzupełnij szkic oferty.+
- usuń szkic oferty.+
Edycja ceny PUT /offers/{offerId}/change-price-commands/{commandId} - zmiana ceny Kup Teraz w ofercie.+
 
Edycja grupowa PUT /sale/offer-publication-commands/{commandId}
GET /sale/offer-publication-commands/{commandId}

GET /sale/offer-publication-commands/{commandId}/tasks
- zmień grupowo status publikacji oferty.+
- pobierz raport o statusie zadania publikacji ofert.+
- pobierz szczegółowy raport o statusie zadania.+

Opcje promowania GET /sale/offer-promotion-packages
POST /sale/offers/{offerId}/promo-options-modification
GET /sale/offers/{offerId}/promo-options

PUT /sale/offers/promo-options-commands/{commandId}
GET /sale/offers/promo-options-commands/{commandId}
GET /sale/offers/promo-options-commands/{commandId}/tasks
- pobierz listę dostępnych opcji promowania.+
- dodaj, zmień lub wyłącz opcje promowania w pojedynczej ofercie.+
- pobierz aktualnie przypisane do oferty pakiety opcji promowania.+
- dodaj lub zmień opcje promowania w wielu ofertach.+
- pobierz raport o statusie przypisania pakietu promowania.+
- pobierz szczegółowy raport o statusie przypisania pakietu promowania.+
Oferta z produktem POST /sale/product-offers

PATCH /sale/product-offers/{offerId}
GET /sale/product-offers/{offerId}
GET /sale/product-offers/{offerId}/operations/{operationId}
- wystawianie oferty z produktem w jednym requeście.+
- edytuj oferty z produktem.+
- pobierz ofertę z produktem.+
- pobierz status procesu POST, PATCH.+
 
Brakujące parametry GET /sale/offers/unfilled-parameters
- sprawdź nieuzupełnione parametry w ofertach.+
Kategorie i parametry GET /sale/categories
GET /sale/categories/{categoryId}
GET /sale/categories/{categoryId}/parameters
GET /sale/category-parameters-scheduled-changes
GET /sale/category-events
GET /sale/matching-categories
 
- pobierz ID kategorii Allegro.+
- pobierz szczegóły danej kategorii.+
- pobierz parametry dla danej kategorii.+
- pobierz planowane zmiany w parametrach .+
- pobierz informacje o zmianach w kategoriach.+
- sprawdź sugerowane kategorie dla podanej frazy.+
Zdjęcia POST /sale/images - prześlij zdjęcie.+
Załączniki POST /sale/offer-attachments
PUT /sale/offer-attachments/{attachmentId}
- dodaj załącznik.+
- dodaj załacznik do oferty.+
Produkty GET /sale/categories/{categoryId}/product-parameters
GET /sale/products
GET /sale/products/{productId}
POST /sale/product-proposals
- pobierz parametry, które możesz podać w produkcie.+
- wyszukaj produkt.+
- pobierz informacje o produkcie.+
- wyślij propozycję produktu.+
Edycja grupowa ofert PUT /sale/offer-modification-commands/{commandId}
GET /sale/offer-modification-commands/{commandId}
GET /sale/offer-modification-commands/{commandId}/tasks
PUT /sale/offer-price-change-commands/{commandId}
GET /sale/offer-price-change-commands/{commandId}
GET /sale/offer-price-change-commands/{commandId}/tasks
PUT /sale/offer-quantity-change-commands/{commandId}
GET /sale/offer-quantity-change-commands/{commandId}
GET /sale/offer-quantity-change-commands/{commandId}/tasks
- edytuj wiele ofert jednocześnie.+

- pobierz ogólne zestawienie zmian.+

- pobierz szczegółowe zestawienie zmian.+

- edytuj cenę w wielu ofertach jednocześnie.+

- pobierz ogólne zestawienie zmian dla ceny.+

- pobierz szczegółowe zestawienie zmian dla ceny.+
- edytuj liczbę przedmiotów w wielu ofertach jednocześnie.+
- pobierz ogólne zestawienie zmian dla liczby przedmiotów.+
- pobierz szczegółowe zestawienie zmian dla liczby przedmiotów.+
Wielowariantowość POST /sale/offer-variants
GET /sale/offer-variants
PUT /sale/offer-variants/{setId}
GET /sale/offer-variants/{setId}
DELETE /sale/offer-variants/{setId}
- dodaj ofertę wielowariantową.+
- pobierz ofertę wielowariantową.+
- edytuj ofertę wielowariantową.+
- pobierz dane oferty wielowariantowej.+
- usuń ofertę wielowariantową.+
Tagi POST /sale/offer-tags
GET /sale/offer-tags
DELETE /sale/offer-tags/{tagId}
PUT /sale/offer-tags/{tagId}
POST /sale/offers/{offerId}/tags
GET /sale/offers/{offerId}/tags
- dodaj tag.+
- pobierz tagi.+
- usuń tagi.+
- edytuj tag.+
- przypisz tagi do oferty.+
- pobierz tagi przypisane do oferty.+
Ustawienia VAT GET /sale/tax-settings
- pobierz ustawienia i identyfikatory stawek VAT.+
Lista “Pasuje do” GET /sale/compatibility-list/supported-categories
GET sale/compatibility-list-suggestions
GET /sale/compatible-products/groups
GET /sale/compatible-products
- pobierz listę kategorii dla listy “Pasuje do”.+
- pobierz sugerowaną sekcję compatibilityList.+
- pobierz listę produktów.+
- pobierz listę dostępnych produktów.+
Rabaty i promocje POST /sale/loyalty/promotions




GET /sale/loyalty/promotions
GET /sale/loyalty/promotions/{promotionId}




PUT /sale/loyalty/promotions/{promotionId}


DELETE /sale/loyalty/promotions/{promotionId}




Dodaj nową promocję:
- rabat na duże zamówienie.+
- cennik hurtowy.+
- rabat ilościowy.+
- promocyjny zestaw ofert.+
Pobierz listę promocji.+
Pobierz informacje o:
- rabacie na duże zamówienie. +
- cennikach hurtowych.+
- rabatach ilościowych.+
- promocyjnych zestawach ofert.+
Edytuj promocję:
- rabat na duże zamówienie.+
- cenniki hurtowe.+
Usuń promocję:
- rabat na duże zamówienie.+
- cenniki hurtowe.+
- rabaty ilościowe.+
- promocyjne zestawy ofert.+
Kampanie promocyjne
- rabaty ilościowe
POST sale/loyalty/promotion-campaigns

GET /sale/loyalty/promotion-campaigns
DEL /sale/loyalty/promotion-campaigns
GET /sale/loyalty/promotion-campaign-applications/{applicationId}
DELETE /sale/loyalty/promotion-campaign-applications/{applicationId}
- złóż wniosek o o włączenie płatnego oznaczenia rabatu ilościowego na jednej ofercie.+
- pobierz informacje o wszystkich kampaniach.+
- usuń wybraną kampanię promocyjną.+
- sprawdź status wniosku o włączenie płatnego oznaczenia rabatu ilościowego.+
- usuń wniosek o stworzenie kampanii promocyjnej.+
Programy specjalne
i oznaczenia Allegro
(“Hit”, “Strefa Okazji”,
Prowizja 0.5%“)
GET /sale/badge-campaigns

POST /sale/badges
GET /sale/badges
GET /sale/badge-applications/{applicationId}

GET /sale/badge-applications
- pobierz listę dostępnych kampanii, które możesz przypisać do ofert.+
- zgłoś ofertę do wybranej kampanii.+
- sprawdź przypisane oznaczenia do swoich ofert.+
- pobierz konkretne zgłoszenie oferty do kampanii i sprawdź jego status.+
- pobierz wszystkie zgłoszenia ofert do kampanii.+
Allegro Ceny GET /sale/allegro-prices-offer-consents/{offerId}

PUT /sale/allegro-prices-offer-consents/{offerId}
GET /sale/allegro-prices-account-eligibility
PUT /sale/allegro-prices-account-consent
- pobierz aktualną informację o zgodzie dla oferty.+
- zaktualizuj zgodę dla oferty.+
- pobierz aktualne uprawnienia dla konta.+
- zaktualizuj zgodę dla konta.+
Oceny produktu GET /sale/offers/{offerId}/rating
 
- pobierz oceny produktów przypisanych do swoich ofert.+
Ogłoszenia GET /sale/offer-classifieds-packages/{offerId}

PUT /sale/offer-classifieds-packages/{offerId}

GET /sale/classifieds-packages
GET /sale/classifieds-packages/{packageId}
 
- pobierz informacje na temat przypisanych pakietów i opcji dodatkowych do ogłoszenia.+
- przypisz do danego draftu ogłoszenia wybrany pakiet i opcje dodatkowe.+
- zarządzaj pakietami i opcjami dodatkowymi.+
- pobierz szczegóły danego pakietu / opcji dodatkowej.+
Kalkulator opłat POST /pricing/fee-preview

POST /pricing/offer-fee-preview

GET /pricing/offer-quotes
 
- sprawdź jakie opłaty pobieramy w ramach danej kategorii.+
- sprawdź jakie opłaty naliczymy w ramach konkretnej oferty.+
- sprawdź kiedy dany cykl się skończy i naliczymy kolejną opłatę.+

Zamówienia

Metody Informacje
Dziennik zdarzeń GET /order/events

GET /order/event-stats
- pobierz zdarzenia do monitorowania akcji w zamówieniach.+
- pobierz informacje o ostatnim zdarzeniu.+
Zamówienia GET /order/checkout-forms
GET /order/checkout-forms/{id}
- pobierz listę zamówień.+
- pobierz szczegóły zamówienia.+
Przesyłki GET /order/carriers

GET /order/checkout-forms/{id}/shipments

POST /order/checkout-forms/{id}/shipments
- pobierz identyfikatory dostępnych przewoźników .+
- pobierz numery przesyłek dodane do zamówienia.+
- dodaj numer przesyłki do zamówienia.+
Status zamówienia PUT /order/checkout-forms/{id}/fulfillment - zmień status realizacji zamówienia.+
Faktury GET /order/checkout-forms/{id}/invoices

POST /order/checkout-forms/{id}/invoices
PUT /order/checkout-forms/{id}/invoices/{invoiceId}/file
- pobierz informacje o fakturach dodanych do zamówienia.+
- utwórz obiekt faktury.+
- prześlij plik *.pdf z fakturą.+
 
Płatności GET /payments/payment-operations
POST /payments/refunds
GET /payments/refunds
- pobierz historię operacji na saldzie.+
- zrealizuj zwrot płatności.+
- pobierz listę wykonanych zwrotów płatności.+
Dyskusje GET /sale/disputes
GET /sale/disputes/{disputeId}
GET /sale/disputes/{disputeId}/messages
POST /sale/disputes/{disputeId}/messages
POST /sale/dispute-attachments
PUT /sale/dispute-attachments/{attachmentId}
GET /sale/dispute-attachments/{attachmentId}
- pobierz wszystkie dyskusje na danym koncie.+
- pobierz szczegółowe informacje o dyskusji.+
- pobierz wszystkie wiadomości z dyskusji.+
- dodaj wiadomość w dyskusji.+
- zadeklaruj rozmiar i nazwę załącznika.+
- prześlij załącznik na nasze serwery.+
- pobierz załącznik z dyskusji.+
Zarządzanie przesyłkami GET /parcel-management/delivery-services
PUT /parcel-management/parcel-create-commands/{commandId}
GET /parcel-management/parcel-create-commands/{commandId}
GET /parcel-management/parcels/{parcelId}
GET /parcel-management/pickup-date-proposals

PUT /parcel-management/parcel-pickup-request-commands/{commandId}
GET /parcel-management/parcel-pickup-request-commands/{commandId}
GET /parcel-management/parcels/label

GET /parcel-management/parcels/protocol
PUT /parcel-management/parcel-cancel-commands/{commandId}
GET /parcel-management/parcel-cancel-commands/{commandId}
- pobierz listę usług dostawy.+
- utwórz nową paczkę.+

- pobierz status tworzenia paczki.+

- pobierz szczegółowe informacje o paczce.+
- pobierz propozycje dat i godzin odbioru paczek przez kuriera.+
- zamów odbiór przesyłek przez kuriera.+

- sprawdź status zamówienia odbioru paczek.+

- utwórz etykietę, którą sprzedawca umieści na paczce.+
- pobierz protokoły nadania przesyłek.+
- anuluj paczkę.+

- sprawdź status anulowania paczki.+
 
Rabaty transakcyjne (zwroty prowizji) GET /order/refund-claims/{claimId}

DELETE /order/refund-claims/{claimId}
GET /order/refund-claims
POST /order/refund-claims
- pobierz identyfikator przedmiotu z zamówienia, za który chcesz otrzymać rabat transakcyjny.+
- anuluj wniosek o rabat transakcyjny .+
- pobierz listę utworzonych wniosków.+
- utwórz wniosek o rabat transakcyjny.+
Czarna lista GET /sale/blacklisted-users
POST /sale/blacklisted-users
DELETE /sale/blacklisted-users/{excludedUserId}
- pobierz czarną listę kupujących.+
- podaj kupującego do czarnej listy.+
- usuń kupującego z czarnej listy.+

Ustawienia sprzedaży

Metody Informacje
Warunki zwrotów GET /after-sales-service-conditions/return-policies
POST /after-sales-service-conditions/return-policies
GET /after-sales-service-conditions/return-policies/{returnPolicyId}
PUT /after-sales-service-conditions/return-policies/{returnPolicyId}
- pobierz listę warunków zwrotów.+
- dodaj nowe warunki zwrotów.+
- pobierz szczegóły warunków zwrotów.+

- zmień warunki zwrotów.+
 
Warunki reklamacji GET /after-sales-service-conditions/implied-warranties
POST /after-sales-service-conditions/implied-warranties
GET /after-sales-service-conditions/implied-warranties/{impliedWarrantyId}
PUT /after-sales-service-conditions/implied-warranties/{impliedWarrantyId}
- pobierz listę warunków reklamacji.+
- dodaj nowe warunki reklamacji.+
- pobierz szczegóły warunków reklamacji.+
- zmień warunki reklamacji.+
 
Gwarancje GET /after-sales-service-conditions/warranties
POST /after-sales-service-conditions/warranties
GET /after-sales-service-conditions/warranties/{warrantyId}

PUT /after-sales-service-conditions/warranties/{warrantyId}
POST /after-sales-service-conditions/attachments
PUT /after-sales-service-conditions/attachments/{attachmentId}
- pobierz listę informacji o gwarancjach.+
- dodaj nową informację o gwarancjach.+
- pobierz szczegóły informacji o gwarancjach.+
- zmień informację o gwarancjach.+
- utwórz obiekt załącznika.+
- dodaj załącznik do informacji o gwarancjach.+
Dostawa (ustawienia i cenniki) GET /sale/shipping-rates
POST /sale/shipping-rates
GET /sale/shipping-rates/{id}
PUT /sale/shipping-rates/{id}
GET /sale/delivery-settings
PUT /sale/delivery-settings
GET /sale/delivery-methods

GET /sale/offers/{offerId}/shipping-rates
 
- pobierz listę cenników dostawy.+
- dodaj nowy cennik dostawy.+
- pobierz szczegóły cennika dostawy.+
- edytuj cennik dostawy.+
- pobierz ustawienia dostawy.+
- edytuj ustawienia dostawy.+
- pobierz listę dostępnych metod dostawy.+
- pobierz cennik dostawy przypisany do oferty.+
Usługi dodatkowe POST /sale/offer-additional-services/groups
GET /sale/offer-additional-services/groups

GET /sale/offer-additional-services/definitions

GET /sale/offer-additional-services/groups/{groupId}
PUT /sale/offer-additional-services/groups/{groupId}
- dodaj nową grupę usług dodatkowych.+
- pobierz listę grup z usługami dodatkowymi.+
- pobierz listę dostępnych usług dodatkowych.+
- pobierz szczegóły usługi dodatkowej.+
- edytuj grupę usług dodatkowych.+
Tabele rozmiarów GET /sale/size-tables/{tableId}
GET /sale/size-tables
- pobierz szczegóły tabeli rozmiarów.+
- pobierz listę tabel rozmiarów.+
Punkty odbioru POST /points-of-service
GET /points-of-service

GET /points-of-service/{id}

PUT /points-of-service/{id}

DELETE /points-of-service/{id}
- dodaj punkt odbioru.+
- pobierz listę wszystkich punktów danego sprzedającego.+
- pobierz dane konkretnego punktu odbioru.+
- edytuj dane wybranego punktu odbioru.+
- usuń punkt odbioru.+
Kontakty POST /sale/offer-contacts
GET /sale/offer-contacts
GET /sale/offer-contacts/{id}
PUT /sale/offer-contacts/{id}
- dodaj nowy kontakt.+
- pobierz listę kontaktów.+
- pobierz szczegóły kontaktu.+
- edytuj kontakt.+

Inne

Metody Informacje
Ocena sprzedaży GET /sale/user-ratings
PUT /sale/user-ratings/{ratingId}/answer
PUT /sale/user-ratings/{ratingId}/removal
- pobierz informacje o ocenie sprzedaży.+
- dodaj odpowiedź na ocenę.+
- wyślij prośbę o usunięcie oceny.+
Informacje o użytkowniku GET /me - pobierz podstawowe informacje o użytkowniku.+
Adresy e-mail GET /account/additional-emails
POST /account/additional-emails
GET /account/additional-emails/{emailId}
DELETE /account/additional- emails/{emailId}
- pobierz adresy e-mail utworzone na koncie.+
- dodaj nowy adres e-mail do konta.+
- pobierz szczegóły o danym adresie e-mail.+
- usuń adres e-mail z konta.+
Historia operacji
billingowych
GET /billing/billing-entries

GET /billing/billing-types
 
- pobierz historię operacji billingowych oraz saldo zautoryzowanego użytkownika.+
- pobierz szczegółową listę dostępnych
operacji billingowych.+
Aukcje PUT /bidding/offers/{offerId}/bid
GET /bidding/offers/{offerId}/bid
- złóż ofertę w aukcji.+
- pobierz informacje o licytacji użytkownika.+
Charytatywne GET /charity/fundraising-campaigns - wystaw ofertę charytatywną.+
Informacje publiczne GET /users/{userId}/ratings-summary - pobierz informacje o ocenach.+
Publiczne informacje
o ofercie
GET /offers/listing - pobierz publiczne informacje o ofercie.+