Claim Store Credit Account

POST/store/:storeCode/store-credit-accounts/claim

publishable keyJWT

Claim a store credit account by code for the logged-in customer.

Path Parameters

storeCoderequiredstring

Store slug in the URL (first argument to every SDK store method).

Query Parameters

fieldsstring

Comma-separated fields to include. Prefix with `*` to expand a relation (e.g. `id,*variants`).

Request Body

Schema

Copy

HttpTypes.StoreClaimStoreCreditAccountParams

Properties

coderequiredstring

Store credit account claim code.

Response

Status

200OK

Schema

Copy

HttpTypes.StoreClaimStoreCreditAccountResponse

Properties

store_credit_accountrequiredStoreStoreCreditAccount

The claimed store credit account.