diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/address.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/address.doc.ts index fc49bc9db2..213a5b3674 100644 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/address.doc.ts +++ b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/address.doc.ts @@ -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: [ { diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/analytics.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/analytics.doc.ts index 4439fdf4c7..b09edcd99f 100644 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/analytics.doc.ts +++ b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/analytics.doc.ts @@ -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: [ { diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/attributes.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/attributes.doc.ts index 0dfa4e2789..c782713338 100644 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/attributes.doc.ts +++ b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/attributes.doc.ts @@ -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: [ { diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/buyer-identity.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/buyer-identity.doc.ts index ac5a92e7d4..6bf23cc51b 100644 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/buyer-identity.doc.ts +++ b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/buyer-identity.doc.ts @@ -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: [ { diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/buyer-journey.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/buyer-journey.doc.ts index 8c4cd2bdc5..50e1524a35 100644 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/buyer-journey.doc.ts +++ b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/buyer-journey.doc.ts @@ -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: [ { diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/cart-instructions.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/cart-instructions.doc.ts index 2164708cc2..2e8f67f1c2 100644 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/cart-instructions.doc.ts +++ b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/cart-instructions.doc.ts @@ -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: [ { diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/cart-lines.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/cart-lines.doc.ts index c205cf10a3..8c4186036d 100644 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/cart-lines.doc.ts +++ b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/cart-lines.doc.ts @@ -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: [ { diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/checkout-token.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/checkout-token.doc.ts index 7e8bdcbdf9..b5d7d260b7 100644 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/checkout-token.doc.ts +++ b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/checkout-token.doc.ts @@ -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: [ { diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/cost.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/cost.doc.ts index 31f6d5e39f..19ec36bd62 100644 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/cost.doc.ts +++ b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/cost.doc.ts @@ -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: [ { diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/customer-privacy.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/customer-privacy.doc.ts index f784c52de9..265a9db438 100644 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/customer-privacy.doc.ts +++ b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/customer-privacy.doc.ts @@ -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: [ { diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/delivery.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/delivery.doc.ts index 975eb9af94..69d60717a1 100644 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/delivery.doc.ts +++ b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/delivery.doc.ts @@ -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. @@ -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: [ { diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/discounts.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/discounts.doc.ts index e7a61d82d4..aead1ea837 100644 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/discounts.doc.ts +++ b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/discounts.doc.ts @@ -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: [ { diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/extension-meta.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/extension-meta.doc.ts index a764fc0fa6..00187fff95 100644 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/extension-meta.doc.ts +++ b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/extension-meta.doc.ts @@ -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: [ { diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/gift-cards.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/gift-cards.doc.ts index daa8a766f9..778671d4e6 100644 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/gift-cards.doc.ts +++ b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/gift-cards.doc.ts @@ -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: [ { diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/localization.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/localization.doc.ts index af53ca9a2f..ad9b689254 100644 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/localization.doc.ts +++ b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/localization.doc.ts @@ -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: [ { diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/localized-fields.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/localized-fields.doc.ts index 29ede432a3..fb512922d0 100644 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/localized-fields.doc.ts +++ b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/localized-fields.doc.ts @@ -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: [ { diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/metafields.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/metafields.doc.ts index 224d7fcc39..0b7aad9f3a 100644 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/metafields.doc.ts +++ b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/metafields.doc.ts @@ -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: [ { diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/note.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/note.doc.ts index 1b791f3bfa..1f2af6f39f 100644 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/note.doc.ts +++ b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/note.doc.ts @@ -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: [ { diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/order.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/order.doc.ts index fccd57fdd6..03d95ba829 100644 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/order.doc.ts +++ b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/order.doc.ts @@ -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: [ diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/payment-options.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/payment-options.doc.ts index 147bc74e3b..76ea061338 100644 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/payment-options.doc.ts +++ b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/payment-options.doc.ts @@ -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: [ { diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/query.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/query.doc.ts index 4bd6446adc..a873ed768f 100644 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/query.doc.ts +++ b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/query.doc.ts @@ -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: [ { diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/session-token.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/session-token.doc.ts index 959677586f..68cdfed1d1 100644 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/session-token.doc.ts +++ b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/session-token.doc.ts @@ -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: [ { diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/settings.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/settings.doc.ts index 07add9ec5a..bd4fc6ec5d 100644 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/settings.doc.ts +++ b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/settings.doc.ts @@ -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: [ { diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/shop.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/shop.doc.ts index cf475536b8..987c926d69 100644 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/shop.doc.ts +++ b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/shop.doc.ts @@ -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: [ { diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/storage.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/storage.doc.ts index 931efadbfa..6197e0f716 100644 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/storage.doc.ts +++ b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/storage.doc.ts @@ -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: [ {