APIs für das Quick Order Form

Diese Seite behandelt die Public API für die Funktionsfamilie des Quick Order Form. Ein einziger Endpunkt verarbeitet alle drei zugehörigen Datensatztypen, die über das Feld type unterschieden werden:

• quick_order_page – eine eigenständige Seite mit Quick Order Form.
• quick_buy_collection – die Quick-Buy-Funktion auf Kollektions- und Produktkartenseiten.
• quick_buy_variant – die Variantentabelle auf einer Produktseite.

Alle 4 Operationen verwenden dieselbe Basis-URL, dieselben Header und dieselbe Authentifizierung wie unter Öffentliche APIs beschrieben.

Datensatz erstellen

Endpunkt

POST https://wholesale.samita.io/api/v1/quick-order-forms

Request-Header

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

Diese API erfordert die Berechtigung Create für den API-Schlüssel, und zwar für den jeweiligen type, den Sie erstellen.

Allgemeine Felder (alle Typen)

Feld	Typ	Erforderlich	Beschreibung
title	string, max. 255	Ja	Der Name des Datensatzes in der App.
status	boolean	Ja	Ob er aktiv ist.
type	string	Ja	quick_order_page, quick_buy_collection oder quick_buy_variant.

Die übrigen Pflichtfelder hängen von type ab:

Feld	Typ	Hinweise
apply_product	object (erforderlich)	type: products oder collections.
apply_product.product_ids	array	Erforderlich, wenn type den Wert products hat.
apply_product.collection_ids	array	Erforderlich, wenn type den Wert collections hat.
display_on_page	string (erforderlich)	Der Handle der Shopify-Seite, auf der dieses Formular angezeigt wird.
pagination	object (erforderlich)	type: pagination oder load_more_button; per_page: Zahl von 1–50.
columns	object (erforderlich)	product_stock: boolean – Lagerbestandsspalte ein- oder ausblenden.

Beispiel:

{
  "title": "Wholesale Order Form",
  "status": true,
  "type": "quick_order_page",
  "apply_product": {
    "type": "collections",
    "collection_ids": [123456789]
  },
  "display_on_page": "wholesale-order-form",
  "pagination": {
    "type": "pagination",
    "per_page": 20
  },
  "columns": {
    "product_stock": true
  }
}

Feld	Typ	Hinweise
apply_product	object (erforderlich)	type: all, products, collections oder product-tags, mit passenden product_ids / collection_ids / product_tags.
exclude_product	object (erforderlich)	type: none, products oder collections, mit passenden IDs.
apply_customer	object (erforderlich)	type: all, logged, non-logged oder customer-tags, gegebenenfalls mit tags.
exclude_customer	object (erforderlich)	type: none oder customer-tags, gegebenenfalls mit tags.
display_on_pages	array (erforderlich)	Beliebige Werte aus index, collection, search, another_page.
columns	object (erforderlich)	Booleans: stock_status, quantity, variant, volume_discount, add_to_cart.

Beispiel:

{
  "title": "Quick Buy on Collections",
  "status": true,
  "type": "quick_buy_collection",
  "apply_product": { "type": "all", "product_ids": [], "product_tags": [], "collection_ids": [] },
  "exclude_product": { "type": "none", "product_ids": [], "collection_ids": [] },
  "apply_customer": { "type": "customer-tags", "tags": ["wholesale"] },
  "exclude_customer": { "type": "none", "tags": [] },
  "display_on_pages": ["collection", "index"],
  "columns": {
    "stock_status": true,
    "quantity": true,
    "variant": true,
    "volume_discount": true,
    "add_to_cart": true
  }
}

Feld	Typ	Hinweise
apply_product	object (erforderlich)	Gleiche Struktur wie bei quick_buy_collection.
exclude_product	object (erforderlich)	Gleiche Struktur wie bei quick_buy_collection.
apply_customer	object (erforderlich)	Gleiche Struktur wie bei quick_buy_collection.
exclude_customer	object (erforderlich)	Gleiche Struktur wie bei quick_buy_collection.
template	string (erforderlich)	default oder matrix-column.
columns	object (erforderlich)	stock: boolean – Lagerbestandsspalte ein- oder ausblenden.

Beispiel:

{
  "title": "Variant Table",
  "status": true,
  "type": "quick_buy_variant",
  "apply_product": { "type": "all", "product_ids": [], "product_tags": [], "collection_ids": [] },
  "exclude_product": { "type": "none", "product_ids": [], "collection_ids": [] },
  "apply_customer": { "type": "logged", "tags": [] },
  "exclude_customer": { "type": "none", "tags": [] },
  "template": "default",
  "columns": {
    "stock": true
  }
}

Hinweis

Die Objekte apply_product/exclude_product/apply_customer/exclude_customer steuern dieselben Targeting-Regeln, die Sie auch in der App-Oberfläche festlegen. Stil, Spaltenreihenfolge und andere Anzeigeeinstellungen verwenden beim Erstellen sinnvolle Standardwerte – um sie zu ändern, aktualisieren Sie den Datensatz anschließend oder bearbeiten Sie ihn in der App.

Antwort

200 – Success liefert den erstellten Datensatz zurück. Ein Beispiel finden Sie weiter unten unter Datensatz abrufen.

Datensatz aktualisieren

PUT https://wholesale.samita.io/api/v1/quick-order-forms/{id}

Dieselben Header wie beim Erstellen. Senden Sie nur die Felder, die Sie ändern möchten – title, status, configs und product_configs sind alle optional; nicht angegebene Felder behalten ihren aktuellen Wert. Diese API erfordert die Berechtigung Update.

Datensatz abrufen

GET https://wholesale.samita.io/api/v1/quick-order-forms/{id}

Dieselben Header wie beim Erstellen, kein Request-Body. Diese API erfordert die Berechtigung View.

200 – Success, Beispiel (type: quick_order_page):

{
  "id": 1,
  "title": "Wholesale Order Form",
  "status": true,
  "type": "quick_order_page",
  "apply_product": {
    "type": "collections",
    "product_ids": [],
    "collection_ids": [123456789]
  },
  "display_on_page": "wholesale-order-form",
  "pagination": {
    "type": "pagination",
    "per_page": 20
  },
  "columns": {
    "product": true,
    "product_stock": true,
    "quantity": true,
    "action": true
  },
  "created_at": "2026-01-15T10:00:00",
  "updated_at": "2026-01-15T10:00:00"
}

Datensatz löschen

DELETE https://wholesale.samita.io/api/v1/quick-order-forms/{id}

Dieselben Header wie beim Erstellen. Übergeben Sie den Parameter ids – eine kommagetrennte Liste der zu löschenden Datensatz-IDs (als Query-String-Parameter oder als Feld im JSON-Body), z. B. ids=1,2,3. Diese API erfordert die Berechtigung Delete.

200 – Success:

{
  "success": true
}

Fehlerantworten

Alle 4 Endpunkte verwenden dieselben Fehlerantworten wie die übrige Public API – unter Öffentliche APIs finden Sie 401 Unauthorized, 403 Forbidden und 429 Too Many Requests.