批量查询礼品卡

需要 read_gift_card 权限点。

更多权限点使用信息，请参考：

GET https://{handle}.myshopline.com/admin/openapi/v20260301/gift_cards.json

handle ：店铺的唯一标识符，值为店铺域名的前缀。例如，域名为 open001.myshopline.com 的店铺，其 handle 是 open001 。

批量查询礼品卡信息。

查询参数

code string

礼品卡编码。

例子: dbe95e7f02606fc4
created_at_max string

指定要查询礼品卡的最晚创建时间。此日期之前创建的数据会被返回。格式：ISO 8601。

例子: 2021-09-02T14:11:54+00:00
created_at_min string

指定要查询礼品卡的最早创建时间。在此日期和此日期之后创建的数据会被返回。格式：ISO 8601。

例子: 2021-09-02T14:11:54+00:00
page_info string

分页查询的唯一标识，用于定位特定页面。

该字段值需要在你已经查询完分页信息后，在该接口响应头中的 link 字段值中获取。例如，你获取到的 link 的值为 <https://{handle}.myshopline.com/admin/openapi/{version}/gift_cards.json?limit=1&page_info=eyJzaW5jZUlkIjoiMTYwNTc1OTAxNTM4OTA4Mjk1MjExMTI3ODgiLCJkaXJlY3Rpb24iOiJuZXh0IiwibGltaXQiOjF9>; rel="next" ，那么 page_info 的值为 eyJzaW5jZUlkIjoiMTYwNTc1OTAxNTM4OTA4Mjk1MjExMTI3ODgiLCJkaXJlY3Rpb24iOiJuZXh0IiwibGltaXQiOjF9 。

关于更多如何使用分页信息，请参考分页机制。
since_id string

礼品卡的 ID。传入该值后，会从指定的礼品卡 ID 开始查询礼品卡。

例子: 30171274557691301804060045
status string
礼品卡的状态。有效枚举值包含：
- enabled：启用中
- disabled：未启用
expires_on_max string

指定要查询礼品卡的最晚到期时间。在此日期之前到期的数据会被返回。格式：ISO 8601。

例子: 2021-09-02T14:11:54+00:00
expires_on_min string

指定要查询礼品卡的最早到期时间。在此日期和此日期之后到期的数据会被返回。格式：ISO 8601。

例子: 2021-09-02T14:11:54+00:00
fields string

指明需要返回的字段，多个字段用逗号分隔。可指定的字段范围参考响应体中 gift_cards 对象下的一级子字段。

例子: id,last_characters
limit string

要查询的礼品卡的数量限制。
取值范围：1-250
默认值：50

请求头

Content-Type string required

字段值固定为 application/json; charset=utf-8。
Authorization string required

资源的访问令牌。参考应用授权获取访问令牌，然后将获取到的访问令牌以 Bearer 格式传入。
例子:

Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw

状态码

更多状态码信息，参考 HTTP 状态码。

响应头

link

提供分页数据的 URL 链接。你可以获取该字段值中的 page_info 信息用于下一次分页请求中。

当你请求的页面存在上一页或下一页的时候，该字段会被返回。关于更多如何使用分页信息，请参考分页机制。
traceId

请求的全局唯一标识符。用于追踪请求在系统中的流转，以便于问题发生时进行定位和调试。

响应体

gift_cardsobject[]

礼品卡信息。
api_client_id string

调用方 ID。
例子: 36d2bc4e97af056677b61c529d9e3a3f7396040d
balance string

礼品卡的余额。
例子: 200
created_at string

礼品卡的创建时间。格式：ISO 8601。
例子: 2023-08-16T23:59:59+08:00
currency string

三位币种码，遵循 ISO 4217 国际标准。
例子: USD
customer_id string

礼品卡的客户 ID。
例子: 4200113946
disabled_at string

礼品卡的禁用时间。格式：ISO 8601。
例子: 2023-08-16T23:59:59+08:00
expires_on string

当前礼品卡的到期时间，null 表示永不过期。格式：ISO 8601。
例子: 2023-08-16T23:59:59+08:00
id string

礼品卡的唯一标识 ID。
例子: 30171274557691301804060045
initial_value string

礼品卡的初始金额。
例子: 200
last_characters string

礼品卡编码的最后四位字符。
例子: d246
line_item_id string

关联的订单行 ID。
例子: 18060183094426803997483534
note string

礼品卡的备注信息。
例子: This is a note
order_id string

关联的订单 ID。
例子: 24060486231247568944830202
updated_at string

礼品卡最近一次更新的时间。格式：ISO 8601。
例子: 2021-09-02T14:11:54+00:00
user_id string

创建礼品卡的管理员账户 ID。
例子: 4214250478

API Explorer

调试台

示例代码

Base URL

https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301

ParamOptions

Authorization — header required

code — query

created_at_max — query

created_at_min — query

page_info — query

since_id — query

status — query

expires_on_max — query

expires_on_min — query

fields — query

limit — query

Language

curl --request GET \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301/gift_cards.json \
     --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw' \
     --header 'Content-Type: application/json; charset=utf-8' \
     --header 'accept: application/json'

这篇文章对你有帮助吗？

SHOPLINE

条款协议