API:er för Quick Order Form

Den här sidan beskriver det publika API:et för funktionsfamiljen Quick Order Form. En enda slutpunkt hanterar alla tre närliggande posttyper, som särskiljs med fältet type:

• quick_order_page – en fristående sida med Quick Order Form.
• quick_buy_collection – funktionen Quick Buy på kollektions- och produktkortssidor.
• quick_buy_variant – varianttabellen på en produktsida.

Alla fyra åtgärder delar samma bas-URL, rubriker och autentisering som beskrivs i Publika API:er.

Skapa en post

Slutpunkt

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

Begäranderubriker

Rubrik	Beskrivning	Obligatorisk
X-SAMITA-API-KEY	API-nyckel som tillhandahålls i appen Wholesale	Ja
X-SAMITA-SHOP-URL	Shopify-butikens domän i formatet xxx.myshopify.com	Ja
CONTENT-TYPE	Måste vara application/json	Ja

Det här API:et kräver behörigheten Create på API-nyckeln för den specifika type du skapar.

Gemensamma fält (alla typer)

Fält	Typ	Obligatorisk	Beskrivning
title	sträng, max 255	Ja	Postens namn i appen.
status	boolesk	Ja	Om den är aktiv.
type	sträng	Ja	quick_order_page, quick_buy_collection eller quick_buy_variant.

Övriga obligatoriska fält beror på type:

Fält	Typ	Anmärkningar
apply_product	objekt (obligatoriskt)	type: products eller collections.
apply_product.product_ids	array	Obligatoriskt när type är products.
apply_product.collection_ids	array	Obligatoriskt när type är collections.
display_on_page	sträng (obligatoriskt)	Handtaget för den Shopify-sida som formuläret visas på.
pagination	objekt (obligatoriskt)	type: pagination eller load_more_button; per_page: tal från 1–50.
columns	objekt (obligatoriskt)	product_stock: boolesk – visa/dölj lagerkolumnen.

Exempel:

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

Fält	Typ	Anmärkningar
apply_product	objekt (obligatoriskt)	type: all, products, collections eller product-tags, med motsvarande product_ids / collection_ids / product_tags.
exclude_product	objekt (obligatoriskt)	type: none, products eller collections, med motsvarande ID.
apply_customer	objekt (obligatoriskt)	type: all, logged, non-logged eller customer-tags, med tags när det är tillämpligt.
exclude_customer	objekt (obligatoriskt)	type: none eller customer-tags, med tags när det är tillämpligt.
display_on_pages	array (obligatoriskt)	Valfria av index, collection, search, another_page.
columns	objekt (obligatoriskt)	Booleska värden: stock_status, quantity, variant, volume_discount, add_to_cart.

Exempel:

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

Fält	Typ	Anmärkningar
apply_product	objekt (obligatoriskt)	Samma struktur som quick_buy_collection.
exclude_product	objekt (obligatoriskt)	Samma struktur som quick_buy_collection.
apply_customer	objekt (obligatoriskt)	Samma struktur som quick_buy_collection.
exclude_customer	objekt (obligatoriskt)	Samma struktur som quick_buy_collection.
template	sträng (obligatoriskt)	default eller matrix-column.
columns	objekt (obligatoriskt)	stock: boolesk – visa/dölj lagerkolumnen.

Exempel:

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

Note

Objekten apply_product/exclude_product/apply_customer/exclude_customer styr samma målgrupperingsregler som du ställer in i appens gränssnitt. Stil, kolumnordning och andra visningsinställningar får rimliga standardvärden vid skapandet – om du vill ändra dem uppdaterar du posten efteråt eller redigerar den i appen.

Svar

200 – Success returnerar den skapade posten. Se exemplet under Hämta en post nedan.

Uppdatera en post

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

Samma rubriker som vid Create. Skicka bara de fält du vill ändra – title, status, configs och product_configs är alla valfria. Fält som inte anges behåller sitt nuvarande värde. Det här API:et kräver behörigheten Update.

Hämta en post

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

Samma rubriker som vid Create, ingen begärandekropp. Det här API:et kräver behörigheten View.

Exempel på 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"
}

Ta bort en post

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

Samma rubriker som vid Create. Skicka en parameter ids – en kommaseparerad lista med ID för de poster som ska tas bort (som frågesträngsparameter eller JSON-kroppsfält), till exempel ids=1,2,3. Det här API:et kräver behörigheten Delete.

200 – Success:

{
  "success": true
}

Felsvar

Alla fyra slutpunkter delar samma felsvar som resten av det publika API:et – se Publika API:er för 401 Unauthorized, 403 Forbidden och 429 Too Many Requests.