List Customer's Store Credit Accounts
Retrieve the logged-in customer's store credit accounts. The store credit accounts can be filtered by fields such as `id`. The store credit accounts can also be sorted or paginated.
In: cookie
Query Parameters
Filter by the store credit account's currency code.
Filter by a store credit account's creation date.
Filter by a store credit account's update date.
Limit the number of items returned in the list.
The number of items to skip when retrieving a list.
The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with -.
Comma-separated fields that should be included in the returned data. If a field is prefixed with + it will be added to the default fields, using - will remove it from the default fields. Without prefix it will replace the entire default fields.
Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
Header Parameters
Publishable API Key created in the Medusa Admin.
Response Body
application/json
application/json
text/plain
application/json
application/json
application/json
application/json
curl -X GET "https://{tenant}.api.myxclade.com/store/store-credit-accounts" \ -H "x-publishable-api-key: string"{
"limit": 0,
"offset": 0,
"count": 0,
"store_credit_accounts": [
{
"customer": {
"id": "string",
"email": "user@example.com",
"default_billing_address_id": "string",
"default_shipping_address_id": "string",
"company_name": "string",
"first_name": "string",
"last_name": "string",
"addresses": [
{
"id": "string",
"address_name": "string",
"is_default_shipping": true,
"is_default_billing": true,
"customer_id": "string",
"company": "string",
"first_name": "string",
"last_name": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_code": "usd",
"province": "us-ca",
"postal_code": "string",
"phone": "string",
"metadata": {},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"phone": "string",
"metadata": {},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z"
},
"id": "string",
"customer_id": "string",
"currency_code": "usd",
"credits": 0,
"debits": 0,
"balance": 0,
"transaction_groups": [
{
"id": "string",
"code": "string",
"credits": 0,
"debits": 0,
"balance": 0,
"account": {},
"metadata": {}
}
],
"metadata": {},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"estimate_count": 0
}{
"message": "Discount must be set to dynamic",
"type": "not_allowed"
}"Unauthorized"{
"message": "Entity with id 1 was not found",
"type": "not_found"
}{
"code": "unknown_error",
"message": "The request conflicted with another request. You may retry the request with the provided Idempotency-Key.",
"type": "QueryRunnerAlreadyReleasedError"
}{
"code": "invalid_request_error",
"message": "Discount with code TEST already exists.",
"type": "duplicate_error"
}{
"code": "api_error",
"message": "An error occured while hashing password",
"type": "database_error"
}Redeem a Gift Card
Redeem a gift card by its ID or code. The gift card will be added to the logged-in customer's store credit account.
Get Customer's Store Credit Account
Retrieve logged-in customer's store credit account by its ID. You can expand the store credit account's relations or select the fields that should be returned.