API dla Wholesale Pricing

W tym dokumencie opisano, jak za pomocą publicznego interfejsu API pobrać listę rekordów Wholesale Pricing z aplikacji Samita Wholesale.

---

1. Punkt końcowy

Aby pobrać listę Wholesale Pricing, użyj następującego punktu końcowego API:

GET - https://wholesale.samita.io/api/v1/wholesale-pricings

---

2. Nagłówki żądania

Wszystkie żądania API muszą zawierać następujące wymagane nagłówki:

Nagłówek	Opis	Wymagane
X-SAMITA-API-KEY	Klucz API dostępny w aplikacji Wholesale	Tak
X-SAMITA-SHOP-URL	Domena sklepu Shopify w formacie xxx.myshopify.com	Tak
CONTENT-TYPE	Musi mieć wartość application/json	Tak

Jeśli którykolwiek z tych nagłówków jest nieobecny, żądanie zostanie odrzucone.

---

3. Parametry żądania (zapytanie / treść)

Aby dostosować żądanie API, można dodać następujące parametry:

Parametr	Opis	Wymagane
limit	Określa maksymalną liczbę rekordów zwracanych w jednym żądaniu	Nie
query	Służy do wyszukiwania rekordów według tytułu lub ID	Nie
status	Służy do filtrowania rekordów według statusu	Nie
sort	Służy do sortowania rekordów według czasu utworzenia	Nie

a. limit

• Określa maksymalną liczbę rekordów zwracanych w jednym żądaniu
• Musi być wartością liczbową
• Wartość minimalna: 1
• Wartość maksymalna: 20
• Parametr opcjonalny
• Jeśli pole pozostanie puste, wartość domyślna to 20

Przykład:

limit=10

---

b. query

• Służy do wyszukiwania rekordów według tytułu lub ID
• Musi być wartością tekstową
• Maksymalna długość: 255 znaków
• Parametr opcjonalny

Przykład:

query=pricing rule

---

c. status

• Służy do filtrowania rekordów według statusu
• Parametr opcjonalny
• Jeśli pole pozostanie puste, API zwróci wszystkie rekordy
• Jeśli zostanie podany, akceptowane są tylko następujące wartości:

Wartość	Opis
active	Tylko aktywne rekordy
draft	Tylko rekordy robocze

Każda inna wartość zostanie odrzucona.

Przykład:

status=active

---

d. sort

• Służy do sortowania rekordów według czasu utworzenia
• Parametr opcjonalny
• Jeśli pole pozostanie puste, rekordy będą posortowane od najnowszych
• Akceptowane są tylko dwie wartości:

Wartość	Opis
descrease	Sortowanie od najnowszych do najstarszych
ascrease	Sortowanie od najstarszych do najnowszych

Przykład:

sort=descrease

---

Przykładowe żądanie:

GET /wholesale-pricing?page=1&limit=20&status=active&sort=descrease

4. Odpowiedź API

API zwróci jeden z następujących kodów statusu HTTP:

a. Odpowiedzi z błędem

401 – Brak autoryzacji

Ten błąd występuje, gdy żądanie nie zostało prawidłowo uwierzytelnione.

Możliwe przyczyny:

• Brak adresu URL sklepu
• Brak klucza API
• Nieprawidłowy adres URL sklepu
• Nieprawidłowy klucz API
• Klucz API nie pasuje do podanego sklepu

---

403 – Ta akcja jest nieautoryzowana

Ten błąd występuje, gdy klucz API nie ma wystarczających uprawnień.

Każdemu kluczowi API można przypisać następujące uprawnienia:

• View
• Create
• Update
• Delete

Interfejs Wholesale Pricing List API wymaga uprawnienia View.
Jeśli klucz API nie ma uprawnienia View, zostanie zwrócony ten błąd.

---

429 – Zbyt wiele żądań

Ten błąd występuje, gdy żądanie przekracza dozwolony limit.

Aktualne limity żądań:

• Maksymalnie 1 żądanie na 5 minut
• Maksymalnie 50 żądań dziennie

Po przekroczeniu tych limitów system zwróci ten błąd.

---

b. Odpowiedź pozytywna

200 – Sukces API

• Żądanie jest prawidłowe
• Uwierzytelnienie powiodło się
• Dane zostały zwrócone poprawnie
• Lista Wholesale Pricing jest zwracana w formacie JSON

---

Przykład pomyślnej odpowiedzi API:

[
  {
    "id": 1,
    "title": "New Wholesale Pricing",
    "status": true,
    "apply_customer": {
      "type": "all",
      "tags": []
    },
    "exclude_customer": {
      "type": "none",
      "tags": []
    },
    "apply_product": {
      "type": "all",
      "product_ids": [],
      "product_tags": [],
      "collection_ids": [],
      "apply_for_variants": false
    },
    "exclude_product": {
      "type": "none",
      "product_ids": [],
      "collection_ids": []
    },
    "discount_for_variants": [
      {
        "id": 8516448190631,
        "variant_pricing": true,
        "variants": [
          {
            "id": 46747346763943,
            "discount_groups": [
              {
                "name": "all",
                "type": "percent",
                "value": "10"
              }
            ]
          }
        ]
      }
    ],
    "apply_market": {
      "type": "all",
      "handle": []
    },
    "discount_group": {
      "type": "percent",
      "value": "10"
    },
    "active_date": {
      "types": [],
      "start_at": "",
      "end_at": ""
    },
    "created_at": "2026-01-15T10:00:00",
    "updated_at": "2026-01-15T10:00:00"
  }
]