storeCreditAccount

query

Returns a store credit account resource by ID.

Arguments

Anchor to idid • ID!required: The ID of the store credit account to return.

Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to StoreCreditAccountStoreCreditAccount • StoreCreditAccount: A store credit account contains a monetary balance that can be redeemed at checkout for purchases in the shop. The account is held in the specified currency and has an owner that cannot be transferred.

The account balance is redeemable at checkout only when the owner is authenticated via new customer accounts authentication.

Was this section helpful?

Get a store credit account by account ID
Get the first two expirable credit transactions of a store credit account
Get the four most recent transactions of a store credit account

Examples

1const { admin } = await authenticate.admin(request);
2
3const response = await admin.graphql(
4  `#graphql
5  query storeCreditAccount($accountId: ID!) {
6    storeCreditAccount(id: $accountId) {
7      id
8      balance {
9        amount
10        currencyCode
11      }
12    }
13  }`,
14  {
15    variables: {
16      "accountId": "gid://shopify/StoreCreditAccount/316863792"
17    },
18  },
19);
20
21const data = await response.json();
22

query storeCreditAccount($accountId: ID!) {
  storeCreditAccount(id: $accountId) {
    id
    balance {
      amount
      currencyCode
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query storeCreditAccount($accountId: ID!) { storeCreditAccount(id: $accountId) { id balance { amount currencyCode } } }",
 "variables": {
    "accountId": "gid://shopify/StoreCreditAccount/316863792"
  }
}'

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(
  `#graphql
  query storeCreditAccount($accountId: ID!) {
    storeCreditAccount(id: $accountId) {
      id
      balance {
        amount
        currencyCode
      }
    }
  }`,
  {
    variables: {
      "accountId": "gid://shopify/StoreCreditAccount/316863792"
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `query storeCreditAccount($accountId: ID!) {
      storeCreditAccount(id: $accountId) {
        id
        balance {
          amount
          currencyCode
        }
      }
    }`,
    "variables": {
      "accountId": "gid://shopify/StoreCreditAccount/316863792"
    },
  },
});

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  query storeCreditAccount($accountId: ID!) {
    storeCreditAccount(id: $accountId) {
      id
      balance {
        amount
        currencyCode
      }
    }
  }
QUERY

variables = {
  "accountId": "gid://shopify/StoreCreditAccount/316863792"
}

response = client.query(query: query, variables: variables)

Input variables

JSON

1{
2  "accountId": "gid://shopify/StoreCreditAccount/316863792"
3}

Response

JSON

1{
2  "storeCreditAccount": {
3    "id": "gid://shopify/StoreCreditAccount/316863792",
4    "balance": {
5      "amount": "11.11",
6      "currencyCode": "USD"
7    }
8  }
9}