获取礼品卡操作记录
GET https://{handle}.myshopline.com/admin/openapi/v20250601/gift_cards/:gift_card_id/operation_records.json
handle
:店铺的唯一标识符,值为店铺域名的前缀。例如,域名为 open001.myshopline.com
的店铺,其 handle
是 open001
。用于获取特定礼品卡的操作记录列表。
路径参数
- gift_card_id string required礼品卡编号Example:
30157043359245339231360282
查询参数
- createtime_at_max string创建时间在 XXX 前(格式见ISO8601),最大可查询近 180 天数据Example:
2021-09-04T14:11:54+00:00
- createtime_at_min string创建时间在 XXX 起(格式见ISO8601),最大可查询近 180 天数据Example:
2021-09-02T14:11:54+00:00
- limit string查询数量限制,默认 50 个,最大不能超过 250 个Example:
100
- operation_type string礼品卡操作类型:使用逗号“,”分隔多个值;如果未填写,则返回所有类型
类型值 描述 OPERATE_ACTION_DEDUCT 礼品卡支付扣减 OPERATE_ACTION_REFUND 礼品卡退款归还 OPERATE_ACTION_ADJUST_BALANCE 第三方应用调整余额 Example:OPERATE_ACTION_DEDUCT,OPERATE_ACTION_REFUND
- page_info string调用方不需要使用和关注此字段,由Shopline自动封装Example:
eyJzaW5jZUlkIjoiMzAxNTcwNDMzNTkyNDUzMzkyMzEzNjAyODIiLCJkaXJlY3Rpb24iOiJwcmV2Iiwic3RhdHVzIjoiZW5hYmxl
- sort_order string按照使用时间排序
排序值 描述 asc 按使用时间升序 desc 按使用时间降序,默认值 Example:desc
请求头
- Content-Type required字段值固定为
application/json; charset=utf-8
- Authorization string required资源的访问令牌。请参考 应用授权 获取访问令牌,然后将获取到的访问令牌以 Bearer 格式传入Example:
Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw
响应
- 200
- 401
- 429
更多状态码信息请参考 HTTP 状态码
响应头
link
查询跳转页traceId
traceId
响应体
- count integer总记录数Example:
10
- created_at string礼品卡创建时间Example:
2023-08-16T23:59:59+08:00
- customer_id string当前礼品卡分配给的客户的客户IDExample:
4200113946
- gift_card_id string礼品卡编号Example:
30157043359245339231360282
gift_card_recordsobject[]
礼品卡操作记录列表created_at string礼品卡记录创建时间Example:2023-08-16T23:59:59+08:00
cur_balance integer变更后余额Example:100
id string礼品卡操作记录编号Example:5504120995916023830
last_balance integer变更前余额Example:50
operation_type string礼品卡操作类型类型值 描述 OPERATE_ACTION_DEDUCT 礼品卡支付扣减 OPERATE_ACTION_REFUND 礼品卡退款归还 OPERATE_ACTION_ADJUST_BALANCE 第三方应用调整余额 Example:OPERATE_ACTION_DEDUCT
order_id string使用礼品卡支付的订单号Example:21055050822459866501338306
pay_seq string使用礼品卡支付的支付单号Example:23062186831987862878904657
refund_id string使用礼品卡支付的退款单号Example:2605514230128707114121
- status string礼品卡状态,enabled:启用中,disabled:未启用Example:
enabled
API Explorer
调试台
这篇文章对你有帮助吗?