需要 read_gift_card 权限点。
更多权限点使用信息,请参考:
GET https://{handle}.myshopline.com/admin/openapi/v20261201/gift_cards/:gift_card_id.json
handle :店铺的唯一标识符,值为店铺域名的前缀。例如,域名为 open001.myshopline.com 的店铺,其 handleopen001
查询单个礼品卡的信息。
路径参数
  • gift_card_id string required
    礼品卡的唯一标识 ID。
    最大长度限制:64
    例子: 30171274557691301804060045
请求头
  • Content-Type string required
    字段值固定为 application/json; charset=utf-8
  • Authorization string required
    资源的访问令牌。参考 应用授权 获取访问令牌,然后将获取到的访问令牌以 Bearer 格式传入。
    例子:
    Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw
状态码
更多状态码信息,参考 HTTP 状态码

响应头
  • traceId
    请求的全局唯一标识符。用于追踪请求在系统中的流转,以便于问题发生时进行定位和调试。
响应体
  • gift_cardobject
    礼品卡信息。
  • api_client_id string
    调用方应用客户端的唯一标识 ID。
    例子: 36d2bc4e97af056677b61c529d9e3a3f7396040d
  • balance string
    礼品卡当前的最新余额。数值保留到小数点后两位。金额单位为当前店铺结算币种的基本货币单位。
    例子: 299.99
  • 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。
    例子: 30157043359245339231360282
  • initial_value string
    礼品卡的初始金额,数值保留到小数点后两位。金额单位为当前店铺结算币种的基本货币单位。
    例子: 299.99
  • last_characters string
    礼品卡编码的最后四位字符。
    例子: d246
  • line_item_id string
    关联的订单商品行 ID。
    例子: 18060183094426803997483534
  • note string
    礼品卡的备注信息。
    例子: This is a note
  • order_id string
    关联的订单 ID。
    例子: 24060486231247568944830202
  • recipient_attributesobject
    礼品卡接收人信息。
  • email string
    礼品卡的接收人邮箱。
    例子: demo@demo.com
  • message string
    礼品卡的赠送留言。
    例子: This is a message
  • nickname string
    礼品卡的接收人昵称。
    例子: nickname
  • send_around string
    礼品卡计划发放日期和时间。格式:ISO 8601
    例子: 2025-06-28T23:59:59+08:00
  • updated_at string
    礼品卡最近一次更新的日期和时间。格式:ISO 8601
    例子: 2023-08-16T23:59:59+08:00
  • user_id string
    最近一次对该礼品卡执行操作的商家后台用户 ID。
    例子: 4214250478
API Explorer
https://openapiceshidianpu.myshopline.com/admin/openapi/v20261201

ParamOptions

path required
header required

Language

curl --request GET \
--url https://openapiceshidianpu.myshopline.com/admin/openapi/v20261201/gift_cards/gift_card_id.json \
--header 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw' \
--header 'Content-Type: application/json; charset=utf-8' \
--header 'accept: application/json'
Examples
查询单个礼品卡
Response
{
"gift_card": {
"api_client_id": "1133d7c99428f83aa3c8d155e0efbb6f71e198c9",
"balance": "200.00",
"created_at": "2026-06-14T03:32:28-11:00",
"currency": "USD",
"customer_id": "2605118091",
"disabled_at": null,
"expires_on": "2026-08-16T23:59:59-11:00",
"id": "30175685282753764489900045",
"initial_value": "200.00",
"last_characters": "0611",
"line_item_id": null,
"note": "This is a note",
"order_id": null,
"recipient_attributes": {
"email": "giftcarttest@shopline.com",
"message": "This is a message",
"nickname": "giftcarttest",
"send_around": "2026-06-28T04:59:59-11:00"
},
"updated_at": "2026-06-14T03:32:28-11:00",
"user_id": null
}
}
这篇文章对你有帮助吗?