commerce/customer/credits

Use the Customer Credits resource to manage the store credit associated with a customer account. Store credit can represent a static amount the customer can redeem at any of the tenant's sites, or a gift card registered for a customer account. At this time, gift card functionality is reserved for future use.

JSON Example

Credit Properties

Property Description
activationDate

type: DateTime

The date and time the store credit or gift card was activated by the shopper. Credits cannot be used until activated. After the credit is activated, this property value is read-only.

code

type: string

The unique identifier of the object.

creditType

type: string

Properties for available credit types.

currencyCode

type: string

The localized currency code for the monetary amount.

currentBalance

type: decimal

The current remaining balance of the credit applied to the customer account.

customCreditType

type: string

Indicates a custom reward type.

customerId

type: int

Unique identifier of the customer in Kibo eCommerce, used to associate customers with data, orders, returns, and in-store credit.

expirationDate

type: DateTime

Date and time in UTC format when a discount, credit, wish list, or cart expires. An expired discount no longer can be redeemed. An expired wish list is no longer available. An expired credit can no longer be redeemed for a purchase. Acart becomes inactive and expired based on a system-calculated interval. For example, if an anonymous shopper has 14 days of inactivity, the cart is considered abandoned after that period of inactivity. System-supplied and read-only.

initialBalance

type: decimal

The initial balance of the credit applied to the customer account. This value cannot be changed after it is set.

Operations

Operation Name Request URI Description
AddCredit POST %3fresponseFields%3d%7bresponseFields%7d

Creates a new store credit for the customer account specified in the request.

AssociateCreditToShopper PUT %7bcode%7d%2fassociate-to-shopper%3fresponseFields%3d%7bresponseFields%7d

Associates an unclaimed customer credit with the shopper user authenticated in the request header.

DeleteCredit DELETE %7bcode%7d

Deletes a store credit previously applied to a customer account.

GetCredit GET %7bcode%7d%3fresponseFields%3d%7bresponseFields%7d

Retrieves the details of a store credit applied to a customer account.

GetCredits GET %3fstartIndex%3d%7bstartIndex%7d%26pageSize%3d%7bpageSize%7d%26sortBy%3d%7bsortBy%7d%26filter%3d%7bfilter%7d%26responseFields%3d%7bresponseFields%7d

Retrieves a list of store credits applied to customer accounts, according any filter and sort criteria specified in the request.

ResendCreditCreatedEmail PUT %7bcode%7d%2fResend-Email

Resend the notification email that informs a shopper that a credit has been created.

UpdateCredit PUT %7bcode%7d%3fresponseFields%3d%7bresponseFields%7d

Updates one or more properties of a defined store credit applied to a customer account.