API's voor Quick Order Form

Deze pagina behandelt de Public API voor de Quick Order Form-functiefamilie. Eén endpoint verwerkt alle drie de gerelateerde recordtypen, die worden onderscheiden door een veld type:

• quick_order_page: een zelfstandige pagina met een Quick Order Form.
• quick_buy_collection: de Quick Buy-functie op collectiepagina’s en productkaarten.
• quick_buy_variant: de variantentabel op een productpagina.

Alle 4 bewerkingen gebruiken dezelfde basis-URL, headers en authenticatie als beschreven in Public APIs.

Een record maken

Endpoint

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

Request headers

Header	Beschrijving	Vereist
X-SAMITA-API-KEY	API-sleutel uit de Wholesale-app	Ja
X-SAMITA-SHOP-URL	Shopify-shopdomein in het formaat xxx.myshopify.com	Ja
CONTENT-TYPE	Moet application/json zijn	Ja

Voor deze API is de machtiging Create op de API-sleutel nodig, voor het specifieke type dat je maakt.

Algemene velden (alle typen)

Veld	Type	Vereist	Beschrijving
title	string, max. 255	Ja	De naam van het record in de app.
status	boolean	Ja	Of het record actief is.
type	string	Ja	quick_order_page, quick_buy_collection of quick_buy_variant.

De overige vereiste velden hangen af van type:

Veld	Type	Opmerkingen
apply_product	object (vereist)	type: products of collections.
apply_product.product_ids	array	Vereist als type gelijk is aan products.
apply_product.collection_ids	array	Vereist als type gelijk is aan collections.
display_on_page	string (vereist)	De handle van de Shopify-pagina waarop dit formulier wordt getoond.
pagination	object (vereist)	type: pagination of load_more_button; per_page: getal van 1–50.
columns	object (vereist)	product_stock: boolean, toont of verbergt de voorraadkolom.

Voorbeeld:

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

Veld	Type	Opmerkingen
apply_product	object (vereist)	type: all, products, collections of product-tags, met bijpassende product_ids / collection_ids / product_tags.
exclude_product	object (vereist)	type: none, products of collections, met bijpassende ID’s.
apply_customer	object (vereist)	type: all, logged, non-logged of customer-tags, met tags indien van toepassing.
exclude_customer	object (vereist)	type: none of customer-tags, met tags indien van toepassing.
display_on_pages	array (vereist)	Een of meer van index, collection, search, another_page.
columns	object (vereist)	Booleans: stock_status, quantity, variant, volume_discount, add_to_cart.

Voorbeeld:

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

Veld	Type	Opmerkingen
apply_product	object (vereist)	Zelfde structuur als bij quick_buy_collection.
exclude_product	object (vereist)	Zelfde structuur als bij quick_buy_collection.
apply_customer	object (vereist)	Zelfde structuur als bij quick_buy_collection.
exclude_customer	object (vereist)	Zelfde structuur als bij quick_buy_collection.
template	string (vereist)	default of matrix-column.
columns	object (vereist)	stock: boolean, toont of verbergt de voorraadkolom.

Voorbeeld:

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

Opmerking

De objecten apply_product/exclude_product/apply_customer/exclude_customer bepalen dezelfde targetingregels die je in de interface van de app instelt. Stijl, kolomvolgorde en andere weergave-instellingen gebruiken bij het aanmaken verstandige standaardwaarden. Om ze te wijzigen, werk je het record daarna bij of bewerk je het in de app.

Response

200 – Success geeft het aangemaakte record terug. Zie het voorbeeld onder Een record ophalen hieronder.

Een record bijwerken

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

Dezelfde headers als bij Create. Stuur alleen de velden mee die je wilt wijzigen: title, status, configs en product_configs zijn allemaal optioneel en niet-opgegeven velden behouden hun huidige waarde. Voor deze API is de machtiging Update nodig.

Een record ophalen

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

Dezelfde headers als bij Create, geen request body. Voor deze API is de machtiging View nodig.

Voorbeeld van 200 – Success (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"
}

Een record verwijderen

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

Dezelfde headers als bij Create. Geef een parameter ids mee: een door komma’s gescheiden lijst met ID’s van te verwijderen records (als queryparameter of als veld in de JSON-body), bijvoorbeeld ids=1,2,3. Voor deze API is de machtiging Delete nodig.

200 – Success:

{
  "success": true
}

Foutmeldingen

Alle 4 endpoints gebruiken dezelfde foutmeldingen als de rest van de Public API. Zie Public APIs voor 401 Unauthorized, 403 Forbidden en 429 Too Many Requests.