Choose a version:

HasStoreCreditAccounts

interface

Requires read_store_credit_accounts access scope.

Represents information about the store credit accounts associated to the specified owner.

Anchor to FieldsFields

Anchor to storeCreditAccountsstoreCreditAccounts •StoreCreditAccountConnection! non-null: Returns a list of store credit accounts that belong to the owner resource. A store credit account owner can hold multiple accounts each with a different currency.

Was this section helpful?

Anchor to Types implemented inTypes implemented in

Anchor to CompanyLocation CompanyLocation

•OBJECT

A location or branch of a company that's a customer of the shop. Configuration of B2B relationship, for example prices lists and checkout settings, may be done for a location.

Anchor to billingAddressbillingAddress

•CompanyAddress

The address used as billing address for the location.

Anchor to buyerExperienceConfigurationbuyerExperienceConfiguration

•BuyerExperienceConfiguration

The configuration for the buyer's B2B checkout.

Anchor to catalogscatalogs

•CatalogConnection!

non-null

The list of catalogs associated with the company location.

Anchor to catalogsCountcatalogsCount

•Count

The number of catalogs associated with the company location. Limited to a maximum of 10000 by default.

Anchor to companycompany

•Company!

non-null

The company that the company location belongs to.

Anchor to createdAtcreatedAt

•DateTime!

non-null

The date and time (ISO 8601 format) at which the company location was created in Shopify.

Anchor to currencycurrency

•CurrencyCode!

non-null

The location's currency based on the shipping address. If the shipping address is empty, then the value is the shop's primary market.

Anchor to defaultCursordefaultCursor

•String!

non-null

A default cursor that returns the single next record, sorted ascending by ID.

Anchor to draftOrdersdraftOrders

•DraftOrderConnection!

non-null

The list of draft orders for the company location.

Anchor to eventsevents

•EventConnection!

non-null

The paginated list of events associated with the host subject.

Anchor to externalIdexternalId

•String

A unique externally-supplied ID for the company location.

Anchor to hasTimelineCommenthasTimelineComment

•Boolean!

non-null

Whether the merchant added a timeline comment to the company location.

Anchor to idid

•ID!

non-null

A globally-unique ID.

Anchor to inCataloginCatalog

•Boolean!

non-null

Whether the company location is assigned a specific catalog.

Anchor to catalogIdcatalogId •ID! required: The ID of the catalog.

Anchor to localelocale

•String

The preferred locale of the company location.

Anchor to metafieldmetafield

•Metafield

A custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.

Anchor to metafieldsmetafields

•MetafieldConnection!

non-null

A list of custom fields that a merchant associates with a Shopify resource.

Anchor to namename

•String!

non-null

The name of the company location.

Anchor to notenote

•String

A note about the company location.

Anchor to ordersorders

•OrderConnection!

non-null

The list of orders for the company location.

Anchor to ordersCountordersCount

•Count

The total number of orders placed for the location.

Anchor to phonephone

•String

The phone number of the company location.

Anchor to roleAssignmentsroleAssignments

•CompanyContactRoleAssignmentConnection!

non-null

The list of roles assigned to the company location.

Anchor to shippingAddressshippingAddress

•CompanyAddress

The address used as shipping address for the location.

Anchor to staffMemberAssignmentsstaffMemberAssignments

•CompanyLocationStaffMemberAssignmentConnection!

non-null

The list of staff members assigned to the company location.

Anchor to storeCreditAccountsstoreCreditAccounts

•StoreCreditAccountConnection!

non-null

Returns a list of store credit accounts that belong to the owner resource. A store credit account owner can hold multiple accounts each with a different currency.

Anchor to taxSettingstaxSettings

•CompanyLocationTaxSettings!

non-null

The tax settings for the company location.

Anchor to totalSpenttotalSpent

•MoneyV2!

non-null

The total amount spent by the location.

Anchor to updatedAtupdatedAt

•DateTime!

non-null

The date and time (ISO 8601 format) at which the company location was last modified.

Anchor to marketmarket

•Market!

non-nullDeprecated

Anchor to metafieldDefinitionsmetafieldDefinitions

•MetafieldDefinitionConnection!

non-nullDeprecated

Anchor to orderCountorderCount

•Int!

non-nullDeprecated

Anchor to taxExemptionstaxExemptions

•[TaxExemption!]!

non-nullDeprecated

Anchor to taxRegistrationIdtaxRegistrationId

•String

Deprecated

Anchor to Customer Customer

•OBJECT

Represents information about a customer of the shop, such as the customer's contact details, their order history, and whether they've agreed to receive marketing material by email.

Caution: Only use this data if it's required for your app's functionality. Shopify will restrict access to scopes for apps that don't have a legitimate use for the associated data.

Anchor to addressesaddresses •[MailingAddress!]! non-null: A list of addresses associated with the customer.
Anchor to addressesV2addressesV2 •MailingAddressConnection! non-null: The addresses associated with the customer.
Anchor to amountSpentamountSpent •MoneyV2! non-null: The total amount that the customer has spent on orders in their lifetime.
Anchor to canDeletecanDelete •Boolean! non-null: Whether the merchant can delete the customer from their store.

A customer can be deleted from a store only if they haven't yet made an order. After a customer makes an order, they can't be deleted from a store.
Anchor to companyContactProfilescompanyContactProfiles •[CompanyContact!]! non-null: A list of the customer's company contact profiles.
Anchor to createdAtcreatedAt •DateTime! non-null: The date and time when the customer was added to the store.
Anchor to dataSaleOptOutdataSaleOptOut •Boolean! non-null: Whether the customer has opted out of having their data sold.
Anchor to defaultAddressdefaultAddress •MailingAddress: The default address associated with the customer.
Anchor to defaultEmailAddressdefaultEmailAddress •CustomerEmailAddress: The customer's default email address.
Anchor to defaultPhoneNumberdefaultPhoneNumber •CustomerPhoneNumber: The customer's default phone number.
Anchor to displayNamedisplayName •String! non-null: The full name of the customer, based on the values for first_name and last_name. If the first_name and last_name are not available, then this falls back to the customer's email address, and if that is not available, the customer's phone number.
Anchor to eventsevents •EventConnection! non-null: A list of events associated with the customer.
Anchor to firstNamefirstName •String: The customer's first name.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to imageimage •Image! non-null: The image associated with the customer.
Anchor to lastNamelastName •String: The customer's last name.
Anchor to lastOrderlastOrder •Order: The customer's last order.
Anchor to legacyResourceIdlegacyResourceId •UnsignedInt64! non-null: The ID of the corresponding resource in the REST Admin API.
Anchor to lifetimeDurationlifetimeDuration •String! non-null: The amount of time since the customer was first added to the store.

Example: 'about 12 years'.
Anchor to localelocale •String! non-null: The customer's locale.
Anchor to mergeablemergeable •CustomerMergeable! non-null: Whether the customer can be merged with another customer.
Anchor to metafieldmetafield •Metafield: A custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.
Anchor to metafieldsmetafields •MetafieldConnection! non-null: A list of custom fields that a merchant associates with a Shopify resource.
Anchor to multipassIdentifiermultipassIdentifier •String: A unique identifier for the customer that's used with Multipass login.
Anchor to notenote •String: A note about the customer.
Anchor to numberOfOrdersnumberOfOrders •UnsignedInt64! non-null: The number of orders that the customer has made at the store in their lifetime.
Anchor to ordersorders •OrderConnection! non-null: A list of the customer's orders.
Anchor to paymentMethodspaymentMethods •CustomerPaymentMethodConnection! non-null: A list of the customer's payment methods.
Anchor to productSubscriberStatusproductSubscriberStatus •CustomerProductSubscriberStatus! non-null: Possible subscriber states of a customer defined by their subscription contracts.
Anchor to statestate •CustomerState! non-null: The state of the customer's account with the shop.

Please note that this only meaningful when Classic Customer Accounts is active.
Anchor to statisticsstatistics •CustomerStatistics! non-null: The statistics for a given customer.
Anchor to storeCreditAccountsstoreCreditAccounts •StoreCreditAccountConnection! non-null: Returns a list of store credit accounts that belong to the owner resource. A store credit account owner can hold multiple accounts each with a different currency.
Anchor to subscriptionContractssubscriptionContracts •SubscriptionContractConnection! non-null: A list of the customer's subscription contracts.
Anchor to tagstags •[String!]! non-null: A comma separated list of tags that have been added to the customer.
Anchor to taxExempttaxExempt •Boolean! non-null: Whether the customer is exempt from being charged taxes on their orders.
Anchor to taxExemptionstaxExemptions •[TaxExemption!]! non-null: The list of tax exemptions applied to the customer.
Anchor to updatedAtupdatedAt •DateTime! non-null: The date and time when the customer was last updated.
Anchor to verifiedEmailverifiedEmail •Boolean! non-null: Whether the customer has verified their email address. Defaults to true if the customer is created through the Shopify admin or API.
Anchor to emailemail •String Deprecated
Anchor to emailMarketingConsentemailMarketingConsent •CustomerEmailMarketingConsentState Deprecated
Anchor to hasTimelineCommenthasTimelineComment •Boolean! non-nullDeprecated
Anchor to marketmarket •Market Deprecated
Anchor to metafieldDefinitionsmetafieldDefinitions •MetafieldDefinitionConnection! non-nullDeprecated
Anchor to phonephone •String Deprecated
Anchor to smsMarketingConsentsmsMarketingConsent •CustomerSmsMarketingConsentState Deprecated
Anchor to unsubscribeUrlunsubscribeUrl •URL! non-nullDeprecated
Anchor to validEmailAddressvalidEmailAddress •Boolean! non-nullDeprecated

Was this section helpful?

Anchor to FieldsFields

Anchor to Types implemented inTypes implemented in

Arguments