giftCardInfo

query

接口访问需要令牌，具体如何获取令牌参考：身份认证。

查询单个客户下的礼品卡，包括其礼品卡卡号、当前余额、到期时间和当前状态等。

Arguments

customerId ● String

客户ID

Return

cardStatus ● CardStatus

礼品卡当前状态

code ● String

礼品卡卡号

createdAt ● Date

礼品卡创建时间

currentBalance ● UnsignedInt64

礼品卡当前余额

expiryDate ● Date

礼品卡到期时间

originalValue ● UnsignedInt64

礼品卡面额

错误码

关于更多通用错误码说明，参考：状态码和错误码。

Example

查询礼品卡信息

Code

query {
  giftCardInfo(customerId: "gid://shopline/Customer/4602226680") {
    expiryDate
    code
    currentBalance
    originalValue
    createdAt
    cardStatus
  }
}

Response

{
	"data": {
		"giftCardInfo": [
			{
				"originalValue": "5000",
				"cardStatus": "ACTIVE",
				"code": "gid://shopline/GiftCard/c94dc01491670a26",
				"createdAt": "2024-07-25T05:25:12Z",
				"currentBalance": "5000",
				"expiryDate": null
			},
			{
				"currentBalance": "5000",
				"expiryDate": null,
				"originalValue": "5000",
				"cardStatus": "ACTIVE",
				"code": "gid://shopline/GiftCard/e47ec17f34f11dad",
				"createdAt": "2024-07-25T05:25:12Z"
			}
		]
	}
}

这篇文章对你有帮助吗？

SHOPLINE

条款协议