Wholesale Pricing用API

公開APIを使って、ストアの卸売価格ルールの一覧を取得します。

このドキュメントでは、公開APIを使って、Samita Wholesaleアプリから卸売価格レコードの一覧を取得する方法を説明します。

1. エンドポイント

卸売価格の一覧を取得するには、次のAPIエンドポイントを使用します。

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

2. リクエストヘッダー

すべてのAPIリクエストに、次の必須ヘッダーを含める必要があります。

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

これらのヘッダーが1つでも欠けている場合、リクエストは拒否されます。

3. リクエストパラメーター（クエリ / ボディ）

APIリクエストをカスタマイズするために、次のパラメーターを指定できます。

パラメーター	説明	必須
`limit`	1回のリクエストで返されるレコードの最大数を指定します	いいえ
`query`	タイトルまたはIDでレコードを検索します	いいえ
`status`	ステータスでレコードを絞り込みます	いいえ
`sort`	作成日時でレコードを並べ替えます	いいえ

a. limit

1回のリクエストで返されるレコードの最大数を指定します
数値である必要があります
最小値：1
最大値：20
任意のパラメーターです
空欄の場合、デフォルト値は20です

例：

limit=10

b. query

タイトルまたはIDでレコードを検索します
文字列である必要があります
最大長：255文字
任意のパラメーターです

例：

query=pricing rule

c. status

ステータスでレコードを絞り込みます
任意のパラメーターです
空欄の場合、APIはすべてのレコードを返します
指定する場合、次の値のみ使用できます。

値	説明
`active`	有効なレコードのみ
`draft`	下書きのレコードのみ

それ以外の値は拒否されます。

例：

status=active

d. sort

作成日時でレコードを並べ替えます
任意のパラメーターです
空欄の場合、作成日時の新しいレコードから順に並べ替えられます
使用できる値は次の2つのみです。

値	説明
`descrease`	新しい順に並べ替えます
`ascrease`	古い順に並べ替えます

例：

sort=descrease

リクエストの例：

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

4. APIレスポンス

APIは、次のいずれかのHTTPステータスコードを返します。

a. エラーレスポンス

401 – Unauthorized（認証エラー）

このエラーは、リクエストが正しく認証されていない場合に発生します。

考えられる原因：

ストアURLが指定されていない
APIキーが指定されていない
ストアURLが正しくない
APIキーが正しくない
APIキーが指定されたストアと一致しない

403 – This action is unauthorized（この操作は許可されていません）

このエラーは、APIキーに十分な権限がない場合に発生します。

各APIキーには、次の権限を割り当てられます。

View（表示）
Create（作成）
Update（更新）
Delete（削除）

卸売価格一覧APIにはView権限が必要です。
APIキーにView権限がない場合、このエラーが返されます。

429 – Too Many Requests（リクエストが多すぎます）

このエラーは、リクエストが許可されたレート制限を超えた場合に発生します。

現在のレート制限：

最大5分あたり1リクエスト
最大1日あたり50リクエスト

これらの上限を超えると、システムはこのエラーを返します。

b. 成功レスポンス

200 – API Success（成功）

リクエストが有効である
認証に成功する
データが正しく返される
卸売価格の一覧がJSON形式で返される

成功レスポンスの例：

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

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