API dla Volume Pricing

W tym dokumencie wyjaśniono, jak pobrać listę rekordów Volume Pricing za pomocą publicznego interfejsu API.

---

1. Punkt końcowy

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

Ten punkt końcowy pozwala pobrać listę rekordów Volume Pricing na podstawie parametrów filtrowania i sortowania.

---

2. Nagłówki żądania

Wszystkie żądania 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 wymagany nagłówek jest nieobecny lub nieprawidłowy, żądanie zostanie odrzucone.

---

3. Parametry żądania

Żądanie GET obsługuje następujące opcjonalne parametry zapytania:

---

a. limit

Określa maksymalną liczbę zwracanych rekordów.

• Musi być liczbą
• Wartość minimalna: 1
• Wartość maksymalna: 20
• Jeśli pole pozostanie puste, wartość domyślna to 20

Przykład:

?limit=10

---

b. query

Ciąg wyszukiwania używany do filtrowania rekordów według tytułu lub ID.

• Musi być ciągiem znaków
• Maksymalna długość: 255 znaków

Przykład:

?query=pricing rule

---

c. status

Filtruj rekordy według statusu.

• Może pozostać puste, aby pobrać wszystkie rekordy
• Jeśli zostanie podany, akceptowane są tylko następujące wartości:

| Wartość | Opis | | –––– | —————–– | | active | Tylko aktywne rekordy | | draft | Tylko rekordy robocze |

Przykład:

?status=active

---

d. sort

Sortuj rekordy według czasu utworzenia.

• Może pozostać puste (domyślnie: najnowsze rekordy jako pierwsze)
• Jeśli zostanie podany, akceptowana jest tylko jedna z następujących wartości:
  • descrease
  • ascrease

Przykład:

?sort=descrease

---

Przykład pełnego żądania

GET https://wholesale.samita.io/api/v1/volume-pricings?limit=10&status=active&sort=descrease

---

4. Odpowiedź API

---

4.1 Odpowiedzi z błędem

401 – Brak autoryzacji

Zwracany, gdy uwierzytelnianie się nie powiedzie.

Możliwe przyczyny:

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

---

403 – Ta akcja jest nieautoryzowana

Zwracany, gdy klucz API nie ma wystarczających uprawnień.

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

• View
• Create
• Update
• Delete

Interfejs List Volume Pricing API wymaga uprawnienia View.

---

429 – Zbyt wiele żądań

Zwracany po przekroczeniu limitu żądań.

Aktualne limity:

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

---

4.2 Odpowiedź pozytywna

200 – Sukces API

Zwracany, gdy żądanie jest prawidłowe i zostało przetworzone pomyślnie.

Odpowiedź zwraca listę rekordów Volume Pricing w formacie JSON.

---

Przykład pomyślnej odpowiedzi API:

[
  {
    "id": 1,
    "title": "New Volume Pricing",
    "status": true,
    "type": "quantity",
    "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,
        "duplicated": false,
        "variant_pricing": true,
        "from_qty": "0",
        "from_amount": "0",
        "to_qty": "10",
        "to_amount": "0",
        "discount_groups": [
          {
            "name": "all",
            "type": "percent",
            "value": "10"
          }
        ],
        "variants": [
          {
            "id": 46747346763943,
            "duplicated": false,
            "from_qty": "0",
            "from_amount": "0",
            "to_qty": "10",
            "to_amount": "0",
            "discount_groups": [
              {
                "name": "all",
                "type": "percent",
                "value": "10"
              }
            ]
          }
        ]
      }
    ],
    "apply_market": {
      "type": "all",
      "handle": []
    },
    "discount_method": "variant",
    "discount_groups": [
      {
        "from_qty": "0",
        "from_amount": "0",
        "to_qty": "10",
        "to_amount": "0",
        "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"
  }
]