Przejdź do treści
Premium Supply Developer

Referencja · Premium Supply Seller API 1.0.0

Dokumentacja zasobów

Ta strona jest renderowana z jednego pliku — seller-api-v1.yaml (OpenAPI 3.1). Z tego samego pliku powstają klienty i testy kontraktowe, więc to, co tu widzisz, jest tym, co odpowiada serwer. Wspólne zasady (nagłówki, idempotencja, paginacja, wybór pól, kształt błędu) są opisane na górze referencji interaktywnej i skrótem w Jak zacząć.

Produkcja
https://api.premiumsupply.pl/v1
Sandbox
https://api.sandbox.premiumsupply.pl/v1 (planowany)

Indeks zasobów

13 operacji w 6 grupach. Kolumna „Zakres” pochodzi z opisu operacji w kontrakcie; „—” oznacza brak wymaganego zakresu (wystarczy ważny token), „publiczny” — brak tokenu.

Uwierzytelnianie

OAuth 2.0 — client_credentials dla własnych skryptów, authorization_code + PKCE dla integratorów.

  • POST
    /oauth/token

    Wydanie tokenu

    publiczny
  • GET
    /oauth/authorize

    Początek zgody sprzedawcy

    publiczny

Konto

  • GET
    /me

    Kim jestem

    —

Oferty

Produkty sprzedawcy wystawione w marketplace.

  • GET
    /offers

    Lista ofert sprzedawcy

    offers:read
  • GET
    /offers/{id}

    Szczegóły oferty

    offers:read
  • PATCH
    /offers/{id}

    Zmiana ceny, stanu lub statusu

    offers:writeIdempotency-Key

Zamówienia

  • GET
    /orders

    Zamówienia zawierające towar sprzedawcy

    orders:read
  • GET
    /orders/{id}

    Szczegóły zamówienia

    orders:read

Przesyłki

  • POST
    /orders/{id}/shipments

    Zgłoszenie wysyłki

    shipments:writeIdempotency-Key

Webhooki

Powiadomienia push o zdarzeniach. Zarządzanie subskrypcjami wymaga zakresów settings:read (odczyt) i settings:write (tworzenie, usuwanie) — subskrypcja to konfiguracja integracji, nie dane domenowe. Podpis HMAC-SHA256 w nagłówku X-Signature.

  • GET
    /webhooks

    Lista subskrypcji

    settings:read
  • POST
    /webhooks

    Utworzenie subskrypcji

    settings:writeIdempotency-Key
  • DELETE
    /webhooks/{id}

    Usunięcie subskrypcji

    settings:write
  • GET
    /webhooks/{id}/deliveries

    Historia dostarczeń

    settings:read

Referencja interaktywna

Schematy, przykłady i generator wywołań w kilkunastu językach. Renderer: Scalar.

Ładowanie interaktywnej referencji…