Service eligibility and regional restrictions
PuppyIP serves only compliant overseas businesses and their authorized personnel. Proxy services are not available in mainland China. The service may only be used for lawful business activities outside mainland China. Use of this service within mainland China is prohibited.
Hosting a proxy IP or server overseas does not change these restrictions. The service must not be provided to end users in mainland China through relaying, forwarding, sharing or resale. Before use, read the Terms of Service.
Key Takeaways
- The optional `note` field is available on credit and debit inputs; existing integrations can continue without changes.
- Notes are merchant-only, set when a transaction is created, and cannot be edited on an existing transaction.
- Notes are limited to 5,000 characters. A longer value returns NOTE_TOO_LONG and no transaction is created.
- Credit, debit and debit-revert transactions can return a note; unset notes and all expiration transaction notes are null.
Check whether the feature fits your API version
If you want to record merchant-only context on a Shopify store credit transaction, this change adds an optional `note` for credits and debits. Existing integrations do not need to send it or change how they process transactions.
The fields are available in GraphQL Admin API version 2027-01 and later. As of November 6, 2026, 2026-10 is the latest stable version and 2027-01 is still a release candidate. Candidate content can change, and Shopify does not recommend release candidates for production. There is no need to force a production version switch for notes.
What a transaction note does
`StoreCreditAccountCreditInput` and `StoreCreditAccountDebitInput` accept an optional `note` string. The note is stored with a newly created credit or debit transaction, and `StoreCreditAccountTransaction.note` can return the saved value. Notes are for merchants only and are not visible to customers.
You can set a note when creating a transaction, but you cannot edit one on an existing transaction. A merchant may choose to record internal context, such as an internal order reference or reconciliation reminder. Treat it as an annotation: it does not replace your own reconciliation records or prove a transaction's status by itself.
Check existing permissions before adoption
GraphQL Admin API versions 2026-10 and earlier do not expose these fields; they are available from 2027-01 onward. The existing `read_store_credit_account_transactions` and `write_store_credit_account_transactions` access scopes and permission requirements still apply. No new scope is required. The credit mutation reference requires `write_store_credit_account_transactions`.
An oversized note prevents transaction creation
A note can contain up to 5,000 characters. A longer value returns the `NOTE_TOO_LONG` user error, and Shopify does not create that transaction. Before recording success, inspect the request's user errors and returned transaction object instead of relying on the text you submitted.
Verify in a development store before planning rollout
To evaluate notes, first choose an API version that supports the field in a development store and prepare a recognizable test value. Pass note when creating a test credit or debit, then read note on the transaction and compare the saved value with your input.
Test an ordinary note and an oversized note separately: check saving and reading for the first, and verify NOTE_TOO_LONG with no created transaction for the second. Record the actual API version, transaction object and user errors for development and support review. Sending a request or retaining the submitted text does not establish success.
Passing a development test does not mean you should move production to a release candidate. Keep existing request behavior unless you need notes. After a stable version that includes the fields is available, assess it through your normal version-upgrade process and verify writing and reading in development first.
Sources
Frequently Asked Questions
Does a null note mean the transaction request failed?
Not by itself. A credit, debit or debit-revert transaction has a null note when none was set, and expiration transactions always return null. Check the transaction object and the request’s user errors as well.
Why might a response lack the new fields even when I specify an API version?
Check the X-Shopify-API-Version response header to see which version handled the request. Shopify serves requests for an inaccessible version using the oldest accessible stable version. Notes require 2027-01 or later; as of this article’s date, 2026-10 is the latest stable version. The version written in a request alone does not prove the fields are available.