获取礼品卡操作记录

需要 read_gift_card 权限点。

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

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

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

用于获取特定礼品卡的操作记录列表。

路径参数

gift_card_id string required

礼品卡编号

例子: 30157043359245339231360282

查询参数

createtime_at_max string

创建时间在 XXX 前（格式见ISO8601），最大可查询近 180 天数据

例子: 2021-09-04T14:11:54+00:00
createtime_at_min string

创建时间在 XXX 起（格式见ISO8601），最大可查询近 180 天数据

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

查询数量限制，默认 50 个，最大不能超过 250 个

例子: 100
operation_type string

礼品卡操作类型：使用逗号“,”分隔多个值；如果未填写，则返回所有类型

类型值描述
OPERATE_ACTION_DEDUCT 礼品卡支付扣减
OPERATE_ACTION_REFUND 礼品卡退款归还
OPERATE_ACTION_ADJUST_BALANCE 第三方应用调整余额

例子: OPERATE_ACTION_DEDUCT,OPERATE_ACTION_REFUND
page_info string

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

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

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

例子: eyJzaW5jZUlkIjoiMzAxNTcwNDMzNTkyNDUzMzkyMzEzNjAyODIiLCJkaXJlY3Rpb24iOiJwcmV2Iiwic3RhdHVzIjoiZW5hYmxl
sort_order string

按照使用时间排序

排序值描述
asc 按使用时间升序
desc 按使用时间降序，默认值

例子: desc

类型值	描述
OPERATE_ACTION_DEDUCT	礼品卡支付扣减
OPERATE_ACTION_REFUND	礼品卡退款归还
OPERATE_ACTION_ADJUST_BALANCE	第三方应用调整余额

排序值	描述
asc	按使用时间升序
desc	按使用时间降序，默认值

请求头

Content-Type string required

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

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

Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw

状态码

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

响应头

traceId

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

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

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

响应体

created_at string

礼品卡创建时间
例子: 2023-08-16T23:59:59+08:00
customer_id string

当前礼品卡分配给的客户的客户ID
例子: 4200113946
gift_card_id string

礼品卡编号
例子: 30157043359245339231360282
gift_card_recordsobject[]

礼品卡操作记录列表
operation_type string

礼品卡操作类型

类型值描述
OPERATE_ACTION_DEDUCT 礼品卡支付扣减
OPERATE_ACTION_REFUND 礼品卡退款归还
OPERATE_ACTION_ADJUST_BALANCE 第三方应用调整余额
例子: OPERATE_ACTION_DEDUCT
order_id string

使用礼品卡支付的订单号
例子: 21055050822459866501338306
pay_seq string

使用礼品卡支付的支付单号
例子: 23062186831987862878904657
refund_id string

使用礼品卡支付的退款单号
例子: 2605514230128707114121
created_at string

礼品卡记录创建时间
例子: 2023-08-16T23:59:59+08:00
cur_balance integer

变更后余额
例子: 100
id string

礼品卡操作记录编号
例子: 5504120995916023830
last_balance integer

变更前余额
例子: 50
status string

礼品卡状态，enabled：启用中，disabled：未启用
例子: enabled
count integer

总记录数
例子: 10

类型值	描述
OPERATE_ACTION_DEDUCT	礼品卡支付扣减
OPERATE_ACTION_REFUND	礼品卡退款归还
OPERATE_ACTION_ADJUST_BALANCE	第三方应用调整余额

API Explorer

调试台

Base URL

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

ParamOptions

gift_card_id — path required

Authorization — header required

createtime_at_max — query

createtime_at_min — query

limit — query

operation_type — query

page_info — query

sort_order — query

Language

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

这篇文章对你有帮助吗？

SHOPLINE

条款协议