APIs für Volume Pricing

Dieses Dokument erklärt, wie Sie mit der Public API eine Liste von Volume Pricing-Datensätzen abrufen.

---

1. Endpunkt

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

Mit diesem Endpunkt rufen Sie eine Liste von Volume Pricing-Datensätzen ab, gefiltert und sortiert nach den angegebenen Parametern.

---

2. Request-Header

Alle Anfragen müssen die folgenden Pflicht-Header enthalten:

Header	Beschreibung	Erforderlich
X-SAMITA-API-KEY	In der Wholesale-App bereitgestellter API-Schlüssel	Ja
X-SAMITA-SHOP-URL	Shopify-Shop-Domain im Format xxx.myshopify.com	Ja
CONTENT-TYPE	Muss application/json sein	Ja

Fehlt ein Pflicht-Header oder ist er ungültig, wird die Anfrage abgelehnt.

---

3. Request-Parameter

Die GET-Anfrage unterstützt die folgenden optionalen Abfrageparameter:

---

a. limit

Legt die maximale Anzahl der zurückgegebenen Datensätze fest.

• Muss eine Zahl sein
• Mindestwert: 1
• Höchstwert: 20
• Bleibt der Wert leer, gilt der Standardwert 20

Beispiel:

?limit=10

---

b. query

Suchbegriff zum Filtern der Datensätze nach title oder ID.

• Muss ein String sein
• Maximale Länge: 255 Zeichen

Beispiel:

?query=pricing rule

---

c. status

Filtert Datensätze nach Status.

• Kann leer bleiben, um alle Datensätze abzurufen

• Wenn angegeben, werden nur die folgenden Werte akzeptiert:

  Wert	Beschreibung
  active	Nur aktive Datensätze
  draft	Nur Entwurfsdatensätze

Beispiel:

?status=active

---

d. sort

Sortiert Datensätze nach Erstellungszeitpunkt.

• Kann leer bleiben (Standard: neueste Datensätze zuerst)
• Wenn angegeben, wird nur einer der folgenden Werte akzeptiert:
  • descrease
  • ascrease

Beispiel:

?sort=descrease

---

Vollständige Beispielanfrage

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

---

4. API-Antwort

---

4.1 Fehlerantworten

401 – Unauthorized

Wird zurückgegeben, wenn die Authentifizierung fehlschlägt.

Mögliche Gründe:

• Shop-URL fehlt
• API-Schlüssel fehlt
• Falsche Shop-URL
• Falscher API-Schlüssel
• API-Schlüssel passt nicht zum Shop

---

403 – This action is unauthorized

Wird zurückgegeben, wenn der API-Schlüssel nicht über ausreichende Berechtigungen verfügt.

Jedem API-Schlüssel können die folgenden Berechtigungen zugewiesen werden:

• View
• Create
• Update
• Delete

The List Volume Pricing API requires View permission.

---

429 – Too Many Requests

Wird zurückgegeben, wenn das Ratenlimit überschritten wird.

Aktuelle Limits:

• Höchstens 1 Anfrage pro 5 Minuten
• Höchstens 50 Anfragen pro Tag

---

4.2 Erfolgsantwort

200 – API Success

Wird zurückgegeben, wenn die Anfrage gültig ist und erfolgreich verarbeitet wurde.

Die Antwort enthält eine Liste von Volume Pricing-Datensätzen im JSON-Format.

---

Beispiel für eine erfolgreiche API-Antwort:

[
  {
    "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"
  }
]