Wholesale Pricing 的 API

本文件說明如何使用 Public API，從 Samita Wholesale 應用程式取得 Wholesale Pricing 記錄清單。

---

1. 端點

若要取得 Wholesale Pricing 清單，請使用下列 API 端點：

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

---

2. 請求標頭

所有 API 請求都必須包含下列必填標頭：

標頭	說明	是否必填
X-SAMITA-API-KEY	Wholesale 應用程式中提供的 API 金鑰	是
X-SAMITA-SHOP-URL	Shopify 商店網域，格式為 xxx.myshopify.com	是
CONTENT-TYPE	必須為 application/json	是

若缺少任何這些標頭，請求將被拒絕。

---

3. 請求參數（查詢／本文）

您可以加入下列參數來自訂 API 請求：

參數	說明	是否必填
limit	定義單次請求傳回的記錄數量上限	否
query	用來依標題或 ID 搜尋記錄	否
status	用來依狀態篩選記錄	否
sort	用來依建立時間排序記錄	否

a. limit

• 定義單次請求傳回的記錄數量上限
• 必須為數值
• 最小值：1
• 最大值：20
• 選填參數
• 若留空，預設值為 20

範例：

limit=10

---

b. query

• 用來依標題或 ID 搜尋記錄
• 必須為字串值
• 最大長度：255 個字元
• 選填參數

範例：

query=pricing rule

---

c. status

• 用來依狀態篩選記錄
• 選填參數
• 若留空，API 會傳回所有記錄
• 若有提供，僅接受下列值：

值	說明
active	僅限啟用中的記錄
draft	僅限草稿記錄

任何其他值都會被拒絕。

範例：

status=active

---

d. sort

• 用來依建立時間排序記錄
• 選填參數
• 若留空，記錄會依建立時間由新到舊排序
• 僅接受兩個值：

值	說明
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

Wholesale Pricing List API 需要 View 權限。
若 API 金鑰沒有 View 權限，就會傳回此錯誤。

---

429 – Too Many Requests

請求超過允許的速率限制時會發生此錯誤。

目前的速率限制：

• 最多每 5 分鐘 1 次請求
• 最多每天 50 次請求

若超過這些限制，系統就會傳回此錯誤。

---

b. 成功回應

200 – API Success

• 請求有效
• 驗證成功
• 資料已正確傳回
• Wholesale Pricing 清單以 JSON 格式提供

---

API 成功回應範例：

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