创建礼品卡

需要 write_gift_card 权限点。

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

POST https://{handle}.myshopline.com/admin/openapi/v20270301/gift_cards.json

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

创建一个礼品卡。

请求头

Content-Type string required

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

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

Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhcHBJZCI6MCwiYXBwS2V5IjoiNzU2ZjI1NWE2NjdlZTcwNTk1MzM0ZjVjYzk4NzU5MzBmN2E3NGZjMSIsImV4cCI6MTg3OTQ4MjA3NiwiaXNzIjoieXNvdWwiLCJzZWxsZXJJZCI6IjIwMDAyMzQ4ODAiLCJzdG9yZUlkIjoiMTY3MjM2OTcyOTYwNiIsInRpbWVzdGFtcCI6MTc4NDc4NzY3NjY2MSwidmVyc2lvbiI6IlYyIn0.3ZzbGAH4cLU1QR2VPEvMOQInUDvus-C4amkINSQIPuNVlXsFKj0sAt1c0KnUy9MWUOFV9cHlkf7J90r2y1FzpA

请求体

code string

礼品卡代码。代码长度必须为 8-20 个字符，并且仅包含小写字母 (a-z) 和数字 (0-9)。
例子: dbe95e7f02606fc4
customer_id string

礼品卡的客户 ID。
最大长度限制：64
例子: 4200113946
expires_on string

创建的礼品卡的到期日期和时间。格式：ISO 8601。传入null或不传该参数或传入空字符串""则设置为永不过期。
例子: 2023-08-16T23:59:59+08:00
initial_value string required

礼品卡的初始金额，数值保留到小数点后两位。金额单位为当前店铺结算币种的基本货币单位。
例子: 299.99
note string

礼品卡的备注信息。
最大长度限制：500
例子: This is a note
recipient_attributesobject

礼品卡接收人信息。
email string

礼品卡的接收人邮箱。
最大长度限制：50
例子: demo@demo.com
message string

礼品卡的赠送留言。
最大长度限制：255
例子: This is a message
nickname string

礼品卡的接收人昵称。
最大长度限制：255
例子: nickname
send_around string

礼品卡计划发放日期和时间。最大可选日期不可超过当前时间后 90 天。格式：ISO 8601。
例子: 2025-06-28T23:59:59+08:00

状态码

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

响应头

traceId

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

响应体

gift_cardobject

礼品卡信息。
order_id string

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

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

礼品卡的备注信息。
例子: This is a note
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
currency string

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

礼品卡当前的到期日期和时间。若永不过期则返回为null。格式：ISO 8601。
例子: 2023-08-16T23:59:59+08:00
id string

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

礼品卡的初始金额，数值保留到小数点后两位。金额单位为当前店铺结算币种的基本货币单位。
例子: 299.99
line_item_id string

关联的订单商品行 ID。
例子: 18060183094426803997483534
balance string

礼品卡当前的最新余额。数值保留到小数点后两位。金额单位为当前店铺结算币种的基本货币单位。
例子: 299.99
code string

礼品卡代码。
例子: dbe95e7f02606fc4
api_client_id string

调用方应用客户端的唯一标识 ID。
例子: 36d2bc4e97af056677b61c529d9e3a3f7396040d
created_at string

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

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

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

API Explorer

调试台

示例代码

Base URL

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

ParamOptions

Authorization — header required

Body

Body required

{
  "expires_on": "2023-08-16T23:59:59+08:00",
  "initial_value": "299.99",
  "note": "This is a note",
  "recipient_attributes": {
    "nickname": "nickname",
    "send_around": "2025-06-28T23:59:59+08:00",
    "email": "demo@demo.com",
    "message": "This is a message"
  },
  "code": "dbe95e7f02606fc4",
  "customer_id": "4200113946"
}

Language

curl --request POST \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20270301/gift_cards.json \
     --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhcHBJZCI6MCwiYXBwS2V5IjoiNzU2ZjI1NWE2NjdlZTcwNTk1MzM0ZjVjYzk4NzU5MzBmN2E3NGZjMSIsImV4cCI6MTg3OTQ4MjA3NiwiaXNzIjoieXNvdWwiLCJzZWxsZXJJZCI6IjIwMDAyMzQ4ODAiLCJzdG9yZUlkIjoiMTY3MjM2OTcyOTYwNiIsInRpbWVzdGFtcCI6MTc4NDc4NzY3NjY2MSwidmVyc2lvbiI6IlYyIn0.3ZzbGAH4cLU1QR2VPEvMOQInUDvus-C4amkINSQIPuNVlXsFKj0sAt1c0KnUy9MWUOFV9cHlkf7J90r2y1FzpA' \
     --header 'Content-Type: application/json; charset=utf-8' \
     --header 'accept: application/json'

这篇文章对你有帮助吗？

SHOPLINE

条款协议