礼品卡

Shopify Plus

礼品卡资源可用于Shopify Plus商店中安装的私人应用程序。应用程序开发合作伙伴还可以从合作伙伴仪表板的支持页面中请求访问礼品卡资源。

礼品卡是另一种付款方式。每张礼品卡都有一个在结帐时输入的唯一代码。它的余额可以通过多次结帐进行兑换。可以选择将礼品卡分配给特定客户。礼品卡代码创建后无法检索，只能检索最后四个字符。

您可以使用GiftCard资源创建，检索和更新商店的礼品卡。创建礼品卡后，仅可以更新到期日期，备注和模板后缀。

笔记

您无法删除礼品卡，但可以将其禁用。您无法启用以前被禁用的礼品卡。

礼品卡可以做什么

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

礼品卡属性

api_client_id	`plain "api_client_id": 431223487` 发行礼品卡的应用程序的ID（如果它是由应用程序发行的）。
平衡	`plain "balance": 80.17` 礼品卡的余额。
代码	`plain "code": "1234 4567 8901 2ABC"` 礼品卡代码，是一串字母数字字符。出于安全原因，仅在创建礼品卡后才可用。（最少8个字符，最多20个字符）
created_at	`plain "created_at": "2008-12-31T19:00:00-05:00"` 创建礼品卡的日期和时间（ISO 8601格式）。
货币	`plain "currency": "CAD"` 礼品卡的货币。
顾客ID	`plain "customer_id": 368407052327` 与此礼品卡相关联的客户的ID。
Disabled_at	`plain "disabled_at": "2009-01-31T19:00:00-05:00"` 礼品卡被禁用的日期和时间（ISO 8601格式）。
到期	`plain "expires_on": "2020-01-31"` `YYYY-MM-DD`礼品卡到期的日期（格式）。`null`如果礼品卡没有有效期限，则返回。
ID	`plain "id": 989034056` 礼品卡的ID。
初始值	`plain "initial_value": 100.0` 礼品卡创建时的初始值。
last_characters	`plain "last_characters": "2ABC"` 礼品卡代码的最后四个字符。由于礼品卡是替代的付款方式，因此无法检索完整代码。
line_item_id	`plain "line_item_id": 241253183` 导致创建此礼品卡的订单项的ID（如果是由订单创建的）。
笔记	`plain "note": "A note"` 商家可以附加到礼品卡上的可选注释的文本。对客户不可见。
order_id	`plain "order_id": 241253183` 导致创建此礼品卡的订单的ID（如果它是由订单创建的）。
template_suffix	`plain "template_suffix": "birthday"` Liquid模板的后缀，用于在线呈现礼品卡。例如，如果值为`birthday`，则使用template渲染礼品卡`gift_card.birthday.liquid`。值为时`null`，使用默认`gift_card.liquid`模板。
用户身份	`plain "user_id": 241253183` 发行礼品卡的用户的ID（如果该ID由用户发行）。
Updated_at	`plain "updated_at": "2009-01-31T19:00:00-05:00"` 上次修改礼品卡的日期和时间（ISO 8601格式）。

终点

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

状态	检索具有给定状态的礼品卡。有效值： + 已启用：将结果限制为仅启用的礼品卡 + 禁用：将结果限制为仅禁用的礼品卡
限制	要显示的最大结果数。（默认值：`50` 最大：`250` ）
since_id	将结果限制为指定的ID之后。
领域	仅显示某些字段，这些字段由逗号分隔的字段名称列表指定。

检索所有礼品卡的列表

GET /admin/api/2021-01/gift_cards.json

查看回应

检索所有已启用礼品卡的列表

GET /admin/api/2021-01/gift_cards.json?status=enabled

查看回应

得到/admin/api/2021-01/gift_cards/{gift_card_id}.json 通过ID检索单个礼品卡

取回一张礼品卡

GET /admin/api/2021-01/gift_cards/48394658.json

查看回应

得到/admin/api/2021-01/gift_cards/count.json 检索礼品卡数量

状态	计数具有给定状态的礼品卡。有效值： + 已启用：仅计数已启用的礼品卡 + 禁用：仅计数禁用的礼品卡

检索所有礼品卡的数量

GET /admin/api/2021-01/gift_cards/count.json

查看回应

检索启用的礼品卡数量

GET /admin/api/2021-01/gift_cards/count.json?status=enabled

查看回应

邮政/admin/api/2021-01/gift_cards.json 创建礼品卡

使用自定义代码创建礼品卡

POST /admin/api/2021-01/gift_cards.json

{

“ gift_card” ： {

“ note” ：“这是一个音符”，
“初始值” ：100.0，
“代码” ：“ ABCD EFGH IJKL MNOP”，
“ template_suffix” ：“ gift_cards.birthday.liquid”

}

查看回应

Create a gift card with an automatically generated code

POST /admin/api/2021-01/gift_cards.json

{

“gift_card”: {

"initial_value": 25.0

}

View Response

PUT/admin/api/2021-01/gift_cards/{gift_card_id}.json

Updates an existing gift card.

The gift card’s balance can’t be changed via the API. You can change only the expiry date, note, and template suffix.

更新礼品卡的笔记

PUT /admin/api/2021-01/gift_cards/48394658.json

{

“ gift_card” ： {

“ id” ：48394658，
“ note” ：“使用新笔记更新”

}

查看回应

更新礼品卡的到期日期

PUT /admin/api/2021-01/gift_cards/48394658.json

{

“ gift_card” ： {

“ id” ：48394658，
“ expires_on” ：“ 2020-01-01”

}

查看回应

邮政/admin/api/2021-01/gift_cards/{gift_card_id}/disable.json 禁用礼品卡。禁用礼品卡无法撤消。

禁用礼品卡

POST /admin/api/2021-01/gift_cards/48394658/disable.json

{

“ gift_card” ： {

“ id” ：48394658

}

查看回应

得到/admin/api/2021-01/gift_cards/search.json?query=last_characters:mnop

搜索与提供的查询匹配的礼品卡。以下字段通过搜索索引：

created_at
updated_at
disabled_at
balance
initial_value
amount_spent
email
last_characters

注意：从2019-10版本开始，此端点通过使用响应标头中提供的链接来实现分页。发送page参数将返回错误。要了解更多信息，请参阅向分页的REST Admin API端点发出请求。

命令	订购的领域和方向。（默认值：`disabled_at DESC` ）
询问	要搜索的文本。
限制	要检索的最大结果数。（默认值：`50` 最大：`250` ）
领域	仅显示某些字段，这些字段由逗号分隔的字段名称列表指定。

检索所有带有最后一个字符“ mnop”的礼品卡

GET /admin/api/2021-01/gift_cards/search.json?query=last_characters:mnop

查看回应