Skip to main content
Anchor to StoreCreditAccountCreditPayload

StoreCreditAccountCreditPayload

payload

Return type for storeCreditAccountCredit mutation.

Anchor to storeCreditAccountTransactionstoreCreditAccountTransaction
•StoreCreditAccountCreditTransaction

The store credit account transaction that was created.

•[StoreCreditAccountCreditUserError!]!
non-null

The list of errors that occurred from executing the mutation.


Was this section helpful?

Anchor to Mutations with this payloadMutations with this payload

•mutation

Adds funds to a StoreCreditAccount by creating a StoreCreditAccountCreditTransaction. The mutation accepts either a store credit account ID, a Customer ID, or a CompanyLocation ID. When you provide a customer or company location ID, it automatically creates an account if one doesn't exist for the specified currency.

Store credit accounts are currency-specific. A single owner can have multiple accounts, each holding a different currency. Use the most appropriate currency for the given store credit account owner.

Credits can optionally include an expiration date.

Arguments

•ID!
required

The ID of the store credit account or the ID of the account owner.

•StoreCreditAccountCreditInput!
required

The input fields for a store credit account credit transaction.



Was this section helpful?