APIs für Wholesale Pricing

Rufen Sie über die Public API eine Liste der Wholesale-Pricing-Regeln Ihres Shops ab.

Dieses Dokument beschreibt, wie Sie mit der Public API die Liste der Wholesale Pricing-Datensätze aus der Samita-Wholesale-App abrufen.

1. Endpunkt

Um die Wholesale Pricing-Liste abzurufen, verwenden Sie den folgenden API-Endpunkt:

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

2. Request-Header

Alle API-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 einer dieser Header, wird die Anfrage abgelehnt.

3. Request-Parameter (Query / Body)

Mit den folgenden Parametern können Sie die API-Anfrage anpassen:

Parameter	Beschreibung	Erforderlich
`limit`	Legt die maximale Anzahl der pro Anfrage zurückgegebenen Datensätze fest	Nein
`query`	Dient zur Suche nach Datensätzen anhand von title oder ID	Nein
`status`	Dient zum Filtern der Datensätze nach Status	Nein
`sort`	Dient zum Sortieren der Datensätze nach Erstellungszeitpunkt	Nein

a. limit

Legt die maximale Anzahl der Datensätze fest, die pro Anfrage zurückgegeben werden
Muss ein numerischer Wert sein
Mindestwert: 1
Höchstwert: 20
Optionaler Parameter
Bleibt der Wert leer, gilt der Standardwert 20

Beispiel:

limit=10

b. query

Dient zur Suche nach Datensätzen anhand von title oder ID
Muss ein String-Wert sein
Maximale Länge: 255 Zeichen
Optionaler Parameter

Beispiel:

query=pricing rule

c. status

Dient zum Filtern der Datensätze nach Status
Optionaler Parameter
Bleibt der Wert leer, gibt die API alle Datensätze zurück
Wenn angegeben, werden nur die folgenden Werte akzeptiert:

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

Jeder andere Wert wird abgelehnt.

Beispiel:

status=active

d. sort

Dient zum Sortieren der Datensätze nach Erstellungszeitpunkt
Optionaler Parameter
Bleibt der Wert leer, werden die zuletzt erstellten Datensätze zuerst angezeigt
Nur zwei Werte werden akzeptiert:

Wert	Beschreibung
`descrease`	Vom neuesten zum ältesten sortieren
`ascrease`	Vom ältesten zum neuesten sortieren

Beispiel:

sort=descrease

Beispielanfrage:

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

4. API-Antwort

Die API gibt einen der folgenden HTTP-Statuscodes zurück:

a. Fehlerantworten

401 – Unauthorized

Dieser Fehler tritt auf, wenn die Anfrage nicht ordnungsgemäß authentifiziert ist.

Mögliche Gründe:

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

403 – This action is unauthorized

Dieser Fehler tritt auf, 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

Die Wholesale Pricing List API erfordert die Berechtigung View.
Hat der API-Schlüssel keine Berechtigung View, wird dieser Fehler zurückgegeben.

429 – Too Many Requests

Dieser Fehler tritt auf, wenn die Anfrage das zulässige Ratenlimit überschreitet.

Aktuelle Ratenlimits:

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

Werden diese Limits überschritten, gibt das System diesen Fehler zurück.

b. Erfolgsantwort

200 – API Success

Die Anfrage ist gültig
Die Authentifizierung ist erfolgreich
Die Daten werden korrekt zurückgegeben
Die Wholesale Pricing-Liste wird im JSON-Format bereitgestellt

Beispiel für eine erfolgreiche API-Antwort:

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

War diese Seite hilfreich?