Quick Order Form用API

公開APIを使って、Quick Order Form、Quick Buy Collection、Quick Buy Variantテーブルを作成、更新、一覧表示、削除します。

このページでは、Quick Order Form機能群の公開APIについて説明します。1つのエンドポイントで、関連する3種類のレコードをすべて扱い、typeフィールドで区別します。

quick_order_page — 単独のQuick Order Formページです。
quick_buy_collection — コレクションページ/商品カードページのクイック購入機能です。
quick_buy_variant — 商品ページのバリエーション表です。

4つの操作はすべて、公開APIで説明している共通のベースURL、ヘッダー、認証を使用します。

レコードを作成する

エンドポイント

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

リクエストヘッダー

ヘッダー	説明	必須
`X-SAMITA-API-KEY`	Wholesaleアプリで発行されたAPIキー	はい
`X-SAMITA-SHOP-URL`	xxx.myshopify.com形式のShopifyストアドメイン	はい
`CONTENT-TYPE`	`application/json`を指定する必要があります	はい

このAPIには、作成するtypeに対する、APIキーのCreate権限が必要です。

共通フィールド（すべてのタイプ）

フィールド	型	必須	説明
`title`	string、最大255文字	はい	アプリ内でのレコード名です。
`status`	boolean	はい	有効かどうかです。
`type`	string	はい	`quick_order_page`、`quick_buy_collection`、`quick_buy_variant`のいずれかです。

その他の必須フィールドはtypeによって異なります。

フィールド	型	備考
`apply_product`	object（必須）	`type`：`products`または`collections`。
`apply_product.product_ids`	array	`type`が`products`の場合は必須です。
`apply_product.collection_ids`	array	`type`が`collections`の場合は必須です。
`display_on_page`	string（必須）	このフォームを表示するShopifyページのハンドルです。
`pagination`	object（必須）	`type`：`pagination`または`load_more_button`、`per_page`：1〜50の数値。
`columns`	object（必須）	`product_stock`：boolean — 在庫列の表示/非表示。

例：

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

フィールド	型	備考
`apply_product`	object（必須）	`type`：`all`、`products`、`collections`、`product-tags`のいずれかで、対応する`product_ids` / `collection_ids` / `product_tags`を指定します。
`exclude_product`	object（必須）	`type`：`none`、`products`、`collections`のいずれかで、対応するIDを指定します。
`apply_customer`	object（必須）	`type`：`all`、`logged`、`non-logged`、`customer-tags`のいずれかで、該当する場合は`tags`を指定します。
`exclude_customer`	object（必須）	`type`：`none`または`customer-tags`で、該当する場合は`tags`を指定します。
`display_on_pages`	array（必須）	`index`、`collection`、`search`、`another_page`のいずれかです。
`columns`	object（必須）	booleanの値：`stock_status`、`quantity`、`variant`、`volume_discount`、`add_to_cart`。

例：

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

フィールド	型	備考
`apply_product`	object（必須）	`quick_buy_collection`と同じ形式です。
`exclude_product`	object（必須）	`quick_buy_collection`と同じ形式です。
`apply_customer`	object（必須）	`quick_buy_collection`と同じ形式です。
`exclude_customer`	object（必須）	`quick_buy_collection`と同じ形式です。
`template`	string（必須）	`default`または`matrix-column`。
`columns`	object（必須）	`stock`：boolean — 在庫列の表示/非表示。

例：

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

レスポンス

200 – Successは、作成されたレコードを返します。下のレコードを取得するの例をご覧ください。

レコードを更新する

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

ヘッダーは作成時と同じです。変更したいフィールドのみを送信します。title、status、configs、product_configsはすべて任意で、指定しなかったフィールドは現在の値が維持されます。このAPIにはUpdate権限が必要です。

レコードを取得する

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

ヘッダーは作成時と同じで、リクエストボディはありません。このAPIにはView権限が必要です。

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

レコードを削除する

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

ヘッダーは作成時と同じです。idsパラメーターを渡します。削除するレコードIDをカンマ区切りで指定したリストで、クエリ文字列パラメーターまたはJSONボディのフィールドとして指定します（例：ids=1,2,3）。このAPIにはDelete権限が必要です。

200 – Success：

{
  "success": true
}

エラーレスポンス

4つのエンドポイントはすべて、公開APIのその他のエンドポイントと同じエラーレスポンスを返します。401 Unauthorized、403 Forbidden、429 Too Many Requestsについては、公開APIをご覧ください。

このページは役に立ちましたか？