Skip to content

Revise API names to align with new nav experience (2026-01) #4068

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rennyG merged 2 commits into from
Mar 11, 2026
Merged

Revise API names to align with new nav experience (2026-01) #4068

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
95a0e9a
Revise API names to align with new nav experience
rennyG Mar 9, 2026
75c1bbd
Add category/subCategory fields to checkout API doc.ts files
rennyG Mar 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions packages/ui-extensions/docs/surfaces/checkout/reference/apis/address.doc.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,12 @@ import {
} from '../helper.docs';

const data: ReferenceEntityTemplateSchema = {
name: 'Addresses',
name: 'Addresses API',
description: 'The API for interacting with addresses.',
isVisualComponent: false,
requires: REQUIRES_PROTECTED_CUSTOMER_DATA_LEVEL_2,
category: 'APIs',
category: 'Target APIs',
subCategory: 'Checkout APIs',
type: 'API',
definitions: [
{
Expand Down
5 changes: 3 additions & 2 deletions packages/ui-extensions/docs/surfaces/checkout/reference/apis/analytics.doc.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,11 @@ import {
} from '../helper.docs';

const data: ReferenceEntityTemplateSchema = {
name: 'Analytics',
name: 'Analytics API',
description: 'The API for interacting with web pixels.',
isVisualComponent: false,
category: 'APIs',
category: 'Target APIs',
subCategory: 'Platform APIs',
type: 'API',
definitions: [
{
Expand Down
5 changes: 3 additions & 2 deletions packages/ui-extensions/docs/surfaces/checkout/reference/apis/attributes.doc.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,11 @@ import {
} from '../helper.docs';

const data: ReferenceEntityTemplateSchema = {
name: 'Attributes',
name: 'Attributes API',
description: 'The API for interacting with cart and checkout attributes.',
isVisualComponent: false,
category: 'APIs',
category: 'Target APIs',
subCategory: 'Checkout APIs',
type: 'API',
definitions: [
{
Expand Down
5 changes: 3 additions & 2 deletions packages/ui-extensions/docs/surfaces/checkout/reference/apis/buyer-identity.doc.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,12 @@ import {
} from '../helper.docs';

const data: ReferenceEntityTemplateSchema = {
name: 'Buyer Identity',
name: 'Buyer Identity API',
description: 'The API for interacting with the buyer identity.',
requires: REQUIRES_PROTECTED_CUSTOMER_DATA_LEVEL_2,
isVisualComponent: false,
category: 'APIs',
category: 'Target APIs',
subCategory: 'Checkout APIs',
type: 'API',
definitions: [
{
Expand Down
5 changes: 3 additions & 2 deletions packages/ui-extensions/docs/surfaces/checkout/reference/apis/buyer-journey.doc.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,11 @@ import {
} from '../helper.docs';

const data: ReferenceEntityTemplateSchema = {
name: 'Buyer Journey',
name: 'Buyer Journey API',
description: 'The API for interacting with the buyer journey.',
isVisualComponent: false,
category: 'APIs',
category: 'Target APIs',
subCategory: 'Checkout APIs',
type: 'API',
definitions: [
{
Expand Down
5 changes: 3 additions & 2 deletions packages/ui-extensions/docs/surfaces/checkout/reference/apis/cart-instructions.doc.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,11 @@ import {
} from '../helper.docs';

const data: ReferenceEntityTemplateSchema = {
name: 'Cart Instructions',
name: 'Cart Instructions API',
description: 'Instructions used to create the checkout.',
isVisualComponent: false,
category: 'APIs',
category: 'Target APIs',
subCategory: 'Checkout APIs',
type: 'API',
definitions: [
{
Expand Down
5 changes: 3 additions & 2 deletions packages/ui-extensions/docs/surfaces/checkout/reference/apis/cart-lines.doc.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,11 @@ import {
} from '../helper.docs';

const data: ReferenceEntityTemplateSchema = {
name: 'Cart Lines',
name: 'Cart Lines API',
description: 'The API for interacting with the cart lines.',
isVisualComponent: false,
category: 'APIs',
category: 'Target APIs',
subCategory: 'Checkout APIs',
type: 'API',
definitions: [
{
Expand Down
5 changes: 3 additions & 2 deletions packages/ui-extensions/docs/surfaces/checkout/reference/apis/checkout-token.doc.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,11 @@ import {
} from '../helper.docs';

const data: ReferenceEntityTemplateSchema = {
name: 'Checkout Token',
name: 'Checkout Token API',
description: 'The API for interacting with the token of a checkout.',
isVisualComponent: false,
category: 'APIs',
category: 'Target APIs',
subCategory: 'Checkout APIs',
type: 'API',
definitions: [
{
Expand Down
5 changes: 3 additions & 2 deletions packages/ui-extensions/docs/surfaces/checkout/reference/apis/cost.doc.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,11 @@ import {
} from '../helper.docs';

const data: ReferenceEntityTemplateSchema = {
name: 'Cost',
name: 'Cost API',
description: 'The API for interacting with the cost of a checkout.',
isVisualComponent: false,
category: 'APIs',
category: 'Target APIs',
subCategory: 'Checkout APIs',
type: 'API',
definitions: [
{
Expand Down
5 changes: 3 additions & 2 deletions packages/ui-extensions/docs/surfaces/checkout/reference/apis/customer-privacy.doc.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,13 @@ import {
} from '../helper.docs';

const data: ReferenceEntityTemplateSchema = {
name: 'Customer Privacy',
name: 'Customer Privacy API',
description:
"The API for interacting with a customer's privacy consent. It is similar to the [Customer Privacy API in storefront](/docs/api/customer-privacy).",
isVisualComponent: false,
requires: REQUIRES_PROTECTED_CUSTOMER_DATA,
category: 'APIs',
category: 'Target APIs',
subCategory: 'Checkout APIs',
type: 'API',
definitions: [
{
Expand Down
5 changes: 3 additions & 2 deletions packages/ui-extensions/docs/surfaces/checkout/reference/apis/delivery.doc.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import {
} from '../helper.docs';

const data: ReferenceEntityTemplateSchema = {
name: 'Delivery',
name: 'Delivery API',
description: `
The APIs for interacting with delivery and shipping options.
Expand All @@ -17,7 +17,8 @@ const data: ReferenceEntityTemplateSchema = {
overviewPreviewDescription:
'The APIs for interacting with delivery and shipping options.',
isVisualComponent: false,
category: 'APIs',
category: 'Target APIs',
subCategory: 'Checkout APIs',
type: 'API',
definitions: [
{
Expand Down
5 changes: 3 additions & 2 deletions packages/ui-extensions/docs/surfaces/checkout/reference/apis/discounts.doc.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,11 @@ import {
} from '../helper.docs';

const data: ReferenceEntityTemplateSchema = {
name: 'Discounts',
name: 'Discounts API',
description: 'The API for interacting with discounts.',
isVisualComponent: false,
category: 'APIs',
category: 'Target APIs',
subCategory: 'Checkout APIs',
type: 'API',
definitions: [
{
Expand Down
5 changes: 3 additions & 2 deletions packages/ui-extensions/docs/surfaces/checkout/reference/apis/extension-meta.doc.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,11 @@ import {
} from '../helper.docs';

const data: ReferenceEntityTemplateSchema = {
name: 'Extension',
name: 'Extension API',
description: 'The API for interacting with the metadata of an extension.',
isVisualComponent: false,
category: 'APIs',
category: 'Target APIs',
subCategory: 'Platform APIs',
type: 'API',
definitions: [
{
Expand Down
5 changes: 3 additions & 2 deletions packages/ui-extensions/docs/surfaces/checkout/reference/apis/gift-cards.doc.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,11 @@ import {
} from '../helper.docs';

const data: ReferenceEntityTemplateSchema = {
name: 'Gift Cards',
name: 'Gift Cards API',
description: 'The API for interacting with gift cards.',
isVisualComponent: false,
category: 'APIs',
category: 'Target APIs',
subCategory: 'Checkout APIs',
type: 'API',
definitions: [
{
Expand Down
5 changes: 3 additions & 2 deletions packages/ui-extensions/docs/surfaces/checkout/reference/apis/localization.doc.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,11 @@ import {
} from '../helper.docs';

const data: ReferenceEntityTemplateSchema = {
name: 'Localization',
name: 'Localization API',
description: 'The APIs for localizing your extension.',
isVisualComponent: false,
category: 'APIs',
category: 'Target APIs',
subCategory: 'Platform APIs',
type: 'API',
definitions: [
{
Expand Down
5 changes: 3 additions & 2 deletions packages/ui-extensions/docs/surfaces/checkout/reference/apis/localized-fields.doc.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,12 @@ import {
} from '../helper.docs';

const data: ReferenceEntityTemplateSchema = {
name: 'Localized Fields',
name: 'Localized Fields API',
description: 'The API for interacting with localized fields.',
isVisualComponent: false,
requires: REQUIRES_PROTECTED_CUSTOMER_DATA,
category: 'APIs',
category: 'Target APIs',
subCategory: 'Checkout APIs',
type: 'API',
definitions: [
{
Expand Down
5 changes: 3 additions & 2 deletions packages/ui-extensions/docs/surfaces/checkout/reference/apis/metafields.doc.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,12 @@ import {
} from '../helper.docs';

const data: ReferenceEntityTemplateSchema = {
name: 'Metafields',
name: 'Metafields API',
description: 'The API for interacting with metafields.',
isVisualComponent: false,
requires: REQUIRES_PROTECTED_CUSTOMER_DATA,
category: 'APIs',
category: 'Target APIs',
subCategory: 'Platform APIs',
type: 'API',
definitions: [
{
Expand Down
5 changes: 3 additions & 2 deletions packages/ui-extensions/docs/surfaces/checkout/reference/apis/note.doc.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,11 @@ import {
} from '../helper.docs';

const data: ReferenceEntityTemplateSchema = {
name: 'Note',
name: 'Note API',
description: 'The API for interacting with the note applied to checkout.',
isVisualComponent: false,
category: 'APIs',
category: 'Target APIs',
subCategory: 'Checkout APIs',
type: 'API',
definitions: [
{
Expand Down
5 changes: 3 additions & 2 deletions packages/ui-extensions/docs/surfaces/checkout/reference/apis/order.doc.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,12 @@ import {
interface OrderStatusApiEmpty {}

const data: ReferenceEntityTemplateSchema = {
name: 'Order',
name: 'Order API',
description:
'The API for interacting with the order confirmation, available on the **Thank You** page.',
isVisualComponent: false,
category: 'APIs',
category: 'Target APIs',
subCategory: 'Checkout APIs',
type: 'API',
defaultExample: getExample('order-confirmation/default', ['jsx']),
definitions: [
Expand Down
5 changes: 3 additions & 2 deletions packages/ui-extensions/docs/surfaces/checkout/reference/apis/payment-options.doc.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,11 @@ import {
} from '../helper.docs';

const data: ReferenceEntityTemplateSchema = {
name: 'Payments',
name: 'Payments API',
description: 'The API for interacting with the payment options.',
isVisualComponent: false,
category: 'APIs',
category: 'Target APIs',
subCategory: 'Checkout APIs',
type: 'API',
definitions: [
{
Expand Down
3 changes: 2 additions & 1 deletion packages/ui-extensions/docs/surfaces/checkout/reference/apis/query.doc.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,8 @@ const data: ReferenceEntityTemplateSchema = {
name: 'Storefront API',
description: 'Querying the Storefront API.',
isVisualComponent: false,
category: 'APIs',
category: 'Target APIs',
subCategory: 'Platform APIs',
type: 'API',
definitions: [
{
Expand Down
5 changes: 3 additions & 2 deletions packages/ui-extensions/docs/surfaces/checkout/reference/apis/session-token.doc.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,11 @@ import {
} from '../helper.docs';

const data: ReferenceEntityTemplateSchema = {
name: 'Session Token',
name: 'Session Token API',
description: 'The API for interacting with session tokens.',
isVisualComponent: false,
category: 'APIs',
category: 'Target APIs',
subCategory: 'Platform APIs',
type: 'API',
definitions: [
{
Expand Down
5 changes: 3 additions & 2 deletions packages/ui-extensions/docs/surfaces/checkout/reference/apis/settings.doc.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,11 @@ import {
} from '../helper.docs';

const data: ReferenceEntityTemplateSchema = {
name: 'Settings',
name: 'Settings API',
description: 'The API for interacting with merchant settings.',
isVisualComponent: false,
category: 'APIs',
category: 'Target APIs',
subCategory: 'Platform APIs',
type: 'API',
definitions: [
{
Expand Down
5 changes: 3 additions & 2 deletions packages/ui-extensions/docs/surfaces/checkout/reference/apis/shop.doc.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,11 @@ import {
} from '../helper.docs';

const data: ReferenceEntityTemplateSchema = {
name: 'Shop',
name: 'Shop API',
description: 'The API for interacting with shop.',
isVisualComponent: false,
category: 'APIs',
category: 'Target APIs',
subCategory: 'Platform APIs',
type: 'API',
definitions: [
{
Expand Down
5 changes: 3 additions & 2 deletions packages/ui-extensions/docs/surfaces/checkout/reference/apis/storage.doc.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,11 @@ import {
} from '../helper.docs';

const data: ReferenceEntityTemplateSchema = {
name: 'Storage',
name: 'Storage API',
description: 'The API for interacting with local storage.',
isVisualComponent: false,
category: 'APIs',
category: 'Target APIs',
subCategory: 'Platform APIs',
type: 'API',
definitions: [
{
Expand Down
Loading