优惠码

优惠码

您可以使用PriceRule DiscountCode资源创建折扣代码，以兑换特定的折扣。商家可以使用各种方式（例如，电子邮件或URL）向他们的客户分配折扣代码，客户可以在结帐时应用这些代码。

每个折扣代码都属于一个价格规则，该规则包含折扣逻辑。有关更多信息，请参见PriceRule资源。

要创建使用相同价格规则逻辑的多个折扣代码，请使用批处理端点。例如，您可能允许商家创建一批折扣代码，这些折扣代码属于同一价格规则，但每个折扣代码针对的是不同的客户。

DiscountCode可以做什么

Shopify API允许您使用DiscountCode资源执行以下操作。这些常规操作的更详细的版本可能可用：

DiscountCode属性

代码必需的	`plain "code": "SUMMERSALE10OFF"` 客户在结帐时使用的不区分大小写的折扣代码。（最多255个字符）使用与关联的价格规则`code`的`title`属性相同的值。
created_at 只读	`plain "created_at": "2017-03-13T16:09:54-04:00"` 创建折扣代码的日期和时间（ISO 8601格式）。
Updated_at 只读	`plain "updated_at": "2017-03-13T16:09:54-04:00"` 折扣代码更新的日期和时间（ISO 8601格式）。
ID 只读	`plain "id": 9808080986` 折扣代码的ID。
price_rule_id 只读	`plain "price_rule_id": 423748927342` 此折扣代码所属的价格规则的ID。
usage_count 只读	`plain "usage_count": 3` 折扣代码已被兑换的次数。

终点

邮政/admin/api/2021-01/price_rules/{price_rule_id}/discount_codes.json 创建一个折扣代码

创建折扣码

POST /admin/api/2021-01/price_rules/507328175/discount_codes.json

{

“折扣代码” ： {

“代码” ：“ SUMMERSALE10OFF”

}

查看回应

放/admin/api/2021-01/price_rules/{price_rule_id}/discount_codes/{discount_code_id}.json 更新现有的折扣代码

更新优惠代码

PUT /admin/api/2021-01/price_rules/507328175/discount_codes/507328175.json

{

“折扣代码” ： {

“ id” ：507328175，
“代码” ：“ WINTERSALE20OFF”

}

查看回应

得到/admin/api/2021-01/price_rules/{price_rule_id}/discount_codes.json 检索折扣代码列表。注意：从2019-10版本开始，此端点通过使用响应标头中提供的链接来实现分页。发送<font style="background-color:#F4F6F8;">page</font>参数将返回错误。要了解更多信息，请参阅向分页的REST Admin API端点发出请求。

检索所有折扣代码的列表

GET /admin/api/2021-01/price_rules/507328175/discount_codes.json

查看回应

得到/admin/api/2021-01/price_rules/{price_rule_id}/discount_codes/{discount_code_id}.json 检索单个折扣代码

检索单个折扣码

GET /admin/api/2021-01/price_rules/507328175/discount_codes/507328175.json

查看回应

得到/admin/api/2021-01/discount_codes/lookup.json?code=SUMMERSALE10OFF

检索折扣代码的位置。

折扣代码的位置是在位置标头中返回的，而不是在DiscountCode对象本身中返回的。折扣代码的位置可能会自动跟随位置标题，具体取决于您的HTTP客户端。

搜索折扣代码

GET /admin/api/2021-01/discount_codes/lookup.json?code=SUMMERSALE10OFF

查看回应

删除/admin/api/2021-01/price_rules/{price_rule_id}/discount_codes/{discount_code_id}.json 删除折扣码

删除折扣码

删除/admin/api/2021-01/price_rules/507328175/discount_codes/507328175.json

查看回应

邮政/admin/api/2021-01/price_rules/{price_rule_id}/batch.json

创建折扣代码创建作业。

批处理端点可用于在单个请求中异步创建多达100个折扣代码。它排队并返回一个discount_code_creation可以监视完成情况的对象。

批处理端点专用的响应字段包括：

status：折扣代码创建作业的状态。可能的值为：
- queued：作业已确认，但尚未开始。
- running：作业正在进行中。
- completed：工作已完成。
codes_count：要创建的折扣代码的数量。
imported_count：成功创建的折扣代码数。
failed_count：未成功创建的折扣代码的数量。不成功的尝试将最多重试三遍。
logs：一种报告，用于指定由于提供的数据无效而未创建折扣代码的时间。响应示例：
- “价格规则目标选择不能为空”
- “价格规则分配方法不能为空”

创建折扣代码创建作业

POST /admin/api/2021-01/price_rules/507328175/batch.json

{

“折扣代码” ： [

{
  “代码” ：“ SUMMER1”
}，
{
  “代码” ：“ SUMMER2”
}，
{
  “代码” ：“ SUMMER3”
}

]

}

查看回应

得到/admin/api/2021-01/price_rules/{price_rule_id}/batch/{batch_id}.json

检索折扣代码创建作业

GET /admin/api/2021-01/price_rules/507328175/batch/173232803.json

查看回应

得到/admin/api/2021-01/price_rules/{price_rule_id}/batch/{batch_id}/discount_codes.json

检索折扣代码创建作业的折扣代码列表。

成功创建的折扣代码包括一个填充的id字段。在创建过程中遇到错误的折扣代码包括一个填充的errors字段。

检索折扣代码列表以创建折扣代码

GET /admin/api/2021-01/price_rules/507328175/batch/173232803/discount_codes.json

查看回应