Wholesale Pricing 的 API

本文介绍如何使用公共 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"
  }
]