Customers > Customer Balance > customerBalanceApplyGiftCard
Commerce APICustomersCustomer BalancecustomerBalanceApplyGiftCard
customerBalanceApplyGiftCard
POST:customer_balance/apply_gift_card.json

Description

Transfer amount of money gift card represents to a customer balance. On customer auth "customer_id" is not required and forced to be the id of the customer.

Permission bit: "customer_balance.write"

Topic: Customer Balance

Arguments

customer_id: String!

Unique customer identifier. See also: Unique Identifiers

Example: "cu_EQzGqWoY"


data: ApplyGiftCard!

Main argument for mutations.


shop_id: String!

Unique shop identifier. See also: Unique Identifiers

Example: "sh_EQzGqWoY"


Data Argument Fields

gift_card_code: String!

Unique generated gift card code (shop owner/users only)

Example: "H35K-DJKS-75TK-TJR4"

Valid when: gift_card_code is not empty


Result

Boolean

Preview (typescript)

Loading module