Skip to content

Commit 4abb1aa

Browse files
authored
Merge pull request #3588 from Shopify/am/api-version-note
Remove unstable reference from customer api doc
2 parents f9ab867 + 628e07b commit 4abb1aa

File tree

2 files changed

+7
-2
lines changed

2 files changed

+7
-2
lines changed

packages/ui-extensions/docs/surfaces/customer-account/reference/apis/customer-account-api.doc.ts

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,10 @@ const data: ReferenceEntityTemplateSchema = {
44
name: 'Customer Account API',
55
description: `Create unique customer experiences with the Customer Account API. The API offers a full range of options making it possible for customers to view their orders, manage their profile and much more.
66
7-
You can access the [Customer Account GraphQL API](/docs/api/customer) using the global \`fetch()\`.`,
7+
You can access the [Customer Account GraphQL API](/docs/api/customer) using the global \`fetch()\`.
8+
9+
The \`API_VERSION\` specified in the URL determines which version of the Customer Account API is used.
10+
`,
811
isVisualComponent: false,
912
category: 'APIs',
1013
type: 'API',

packages/ui-extensions/docs/surfaces/customer-account/reference/examples/apis/customer-account-api-fetch.example.jsx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ export default async () => {
66
render(<Extension />, document.body);
77
};
88

9+
const API_VERSION = '2025-10';
10+
911
function Extension() {
1012
const [customerName, setCustomerName] =
1113
useState('');
@@ -20,7 +22,7 @@ function Extension() {
2022

2123
useEffect(() => {
2224
fetch(
23-
'shopify://customer-account/api/unstable/graphql.json',
25+
`shopify://customer-account/api/${API_VERSION}/graphql.json`,
2426
{
2527
method: 'POST',
2628
headers: {

0 commit comments

Comments
 (0)