# AppDirect | Developer Portal > AppDirect powers millions of cloud subscriptions worldwide with marketplace, billing, reseller, and distribution solutions. - [AppDirect | Developer Portal](/index.md) ## ai-rest Open API Reference Docs for the API - [Devs.ai API (1.0)](/ai-rest.md): Open API Reference Docs for the API ## markdown-page You don't need React to write simple standalone pages. - [Markdown page example](/markdown-page.md): You don't need React to write simple standalone pages. ## rest The Companies API allows developers to manage marketplace companies and their user memberships. - [AppDirect API Reference](/rest.md): The Companies API allows developers to manage marketplace companies and their user memberships. ## search - [Search the documentation](/search.md) ## tools ### demo-graphql Description will go into a meta tag in - [Demo GraphQL Explorer](/tools/demo-graphql.md): Description will go into a meta tag in ### hosted-graphql Description will go into a meta tag in - [Hosted GraphQL Explorer](/tools/hosted-graphql.md): Description will go into a meta tag in ### introspection Description will go into a meta tag in - [Introspection App](/tools/introspection.md): Description will go into a meta tag in ## docs ### empty - [empty](/docs/empty.md) ## references-api API and References - [APIs and References](/references-api.md): API and References ### llms Use AppDirect’s LLMs-friendly docs with Cursor, Windsurf, ChatGPT/Claude, and Copilot. - [LLMs-ready documentation](/references-api/llms.md): Use AppDirect’s LLMs-friendly docs with Cursor, Windsurf, ChatGPT/Claude, and Copilot. ## storefront Custom Storefront Overview - [Customize your storefront](/storefront.md): Custom Storefront Overview ### category #### how-to-guides - [How-to Guides](/storefront/category/how-to-guides.md) ### developer-tools #### storefront-components Storefront Components Library - [Storefront Components Library](/storefront/developer-tools/storefront-components.md): Storefront Components Library #### storefront-plaza Storefront Plaza Theme - [Storefront Plaza Theme](/storefront/developer-tools/storefront-plaza.md): Storefront Plaza Theme #### storefront-toolbar Toolkit Toolbar Overview - [Using the developer toolbar](/storefront/developer-tools/storefront-toolbar.md): Toolkit Toolbar Overview #### toolkit Toolkits Overview - [Storefront Toolkit](/storefront/developer-tools/toolkit.md): Toolkits Overview ##### storefront-toolkit-changlog Storefront Toolkit Changelog - [Storefront Toolkit Changelog](/storefront/developer-tools/toolkit/storefront-toolkit-changlog.md): Storefront Toolkit Changelog ##### storefront-toolkit-upgrade Toolkits Overview - [Upgrading to 4.0 and later](/storefront/developer-tools/toolkit/storefront-toolkit-upgrade.md): Toolkits Overview ### getting-started Getting Started - [Getting Started](/storefront/getting-started.md): Getting Started ### how-tos #### components ##### storefront-custom-components Creating custom react components in your storefront theme - [Custom components](/storefront/how-tos/components/storefront-custom-components.md): Creating custom react components in your storefront theme ##### storefront-custom-components-add Add custom react components to your storefront theme - [Add components to your storefront theme](/storefront/how-tos/components/storefront-custom-components-add.md): Add custom react components to your storefront theme ##### storefront-custom-components-customize-ui-library Customize UI library components - [Customize UI library components](/storefront/how-tos/components/storefront-custom-components-customize-ui-library.md): Customize UI library components ##### storefront-custom-components-data Using Marketplace Data in your storefront components - [Using Marketplace Data](/storefront/how-tos/components/storefront-custom-components-data.md): Using Marketplace Data in your storefront components ##### storefront-custom-components-delete-ui-library Delete UI library components - [Delete UI library components](/storefront/how-tos/components/storefront-custom-components-delete-ui-library.md): Delete UI library components ##### storefront-custom-components-layout Storefront Components Layout Management - [Layout Management](/storefront/how-tos/components/storefront-custom-components-layout.md): Storefront Components Layout Management ##### storefront-custom-components-settings Default Component Theme Settings - [Default Component Theme Settings](/storefront/how-tos/components/storefront-custom-components-settings.md): Default Component Theme Settings ##### storefront-custom-components-styling Styling components in your storefront theme - [Styling components](/storefront/how-tos/components/storefront-custom-components-styling.md): Styling components in your storefront theme ##### storefront-custom-components-uninstall Uninstall Custom Components - [Uninstall Custom Components](/storefront/how-tos/components/storefront-custom-components-uninstall.md): Uninstall Custom Components ##### storefront-custom-components-update-ui-library Update UI library - [Update UI library](/storefront/how-tos/components/storefront-custom-components-update-ui-library.md): Update UI library #### data Using Marketplace Data in your Storefront Theme - [Using the Marketplace Data](/storefront/how-tos/data.md): Using Marketplace Data in your Storefront Theme ##### storefront-data-customized Customizing Marketplace Data in your Storefront Theme - [Customize Marketplace Data](/storefront/how-tos/data/storefront-data-customized.md): Customizing Marketplace Data in your Storefront Theme ##### storefront-data-customized-multiple Managing Data with Multiple Marketplaces - [Managing Data with Multiple Marketplaces](/storefront/how-tos/data/storefront-data-customized-multiple.md): Managing Data with Multiple Marketplaces #### import-theme Import a theme - [Import a theme](/storefront/how-tos/import-theme.md): Import a theme #### localization Localization, internationalization, and i18n for customizing theme storefronts - [Themes and Localization](/storefront/how-tos/localization.md): Localization, internationalization, and i18n for customizing theme storefronts ##### storefront-labels Customize Storefront Themes Labels - [Customize Storefront Themes Labels](/storefront/how-tos/localization/storefront-labels.md): Customize Storefront Themes Labels #### static-assets Adding Static Assets to Your Storefront Theme - [Themes and Static Assets](/storefront/how-tos/static-assets.md): Adding Static Assets to Your Storefront Theme ##### storefront-custom-ressources Using Custom Ressources in Your Storefront Theme - [Themes and Custom Ressources](/storefront/how-tos/static-assets/storefront-custom-ressources.md): Using Custom Ressources in Your Storefront Theme ##### storefront-grid Theme CSS Grid - [Theme CSS grid](/storefront/how-tos/static-assets/storefront-grid.md): Theme CSS Grid ##### storefront-platform-css Global Plaform CSS - [Global platform CSS](/storefront/how-tos/static-assets/storefront-platform-css.md): Global Plaform CSS #### storefront-checkout Integrate Checkout in your Storefront Theme - [Integrate Checkout in your Storefront Theme](/storefront/how-tos/storefront-checkout.md): Integrate Checkout in your Storefront Theme #### storefront-header Customize the admin header and footer - [Customize the admin header and footer](/storefront/how-tos/storefront-header.md): Customize the admin header and footer #### storefront-metatags Storefront Theme Metatags - [Themes and Metatags](/storefront/how-tos/storefront-metatags.md): Storefront Theme Metatags #### storefront-pages Create Pages in your Storefront Theme - [Create Custom Pages in your theme](/storefront/how-tos/storefront-pages.md): Create Pages in your Storefront Theme #### storefront-upload-theme Upload a theme in Theme Manager - [Upload a theme in Theme Manager](/storefront/how-tos/storefront-upload-theme.md): Upload a theme in Theme Manager ### reference #### custom-components Storefront Home Page Objects - [Custom Components](/storefront/reference/custom-components.md): Storefront Home Page Objects ##### custom-components-risks Risks of using Custom Components - [Introduction](/storefront/reference/custom-components/custom-components-risks.md): Risks of using Custom Components ##### legacy Legacy - [Custom Components (Legacy)](/storefront/reference/custom-components/legacy.md): Legacy - [Add components to your storefront theme](/storefront/reference/custom-components/legacy/legacy-custom-components-add.md): Add custom react components to your storefront theme - [Custom components](/storefront/reference/custom-components/legacy/legacy-custom-components-getting-started.md): Creating custom react components in your storefront theme - [Introduction](/storefront/reference/custom-components/legacy/legacy-custom-components-risks.md): Risks of using Custom Components - [Storefront Toolkit](/storefront/reference/custom-components/legacy/legacy-storefront-toolkit.md): Toolkits Overview - [Build components](/storefront/reference/custom-components/legacy/storefront-custom-components-build.md): Build components in your storefront theme ##### manage-accessibility Managing Accessibility using Custom Components - [Accessibility Management with Custom Components in Storefront Builder](/storefront/reference/custom-components/manage-accessibility.md): Managing Accessibility using Custom Components ##### schema Theme Editor Custom Components Schema - [Components Schema](/storefront/reference/custom-components/schema.md): Theme Editor Custom Components Schema ##### schema-types Storefront Component Schema Types - [Schema Component Types](/storefront/reference/custom-components/schema-types.md): Storefront Component Schema Types #### page-objects Storefront Page Objects - [General page objects](/storefront/reference/page-objects.md): Storefront Page Objects ##### storefront-page-bundle Storefront Bundle Page Objects - [Storefront Bundle Page Objects](/storefront/reference/page-objects/storefront-page-bundle.md): Storefront Bundle Page Objects ##### storefront-page-comparison Storefront Product Comparison Page Objects - [Product comparison page objects](/storefront/reference/page-objects/storefront-page-comparison.md): Storefront Product Comparison Page Objects ##### storefront-page-help Storefront Help Page Objects - [Help page objects](/storefront/reference/page-objects/storefront-page-help.md): Storefront Help Page Objects ##### storefront-page-home Storefront Home Page Objects - [Home page objects](/storefront/reference/page-objects/storefront-page-home.md): Storefront Home Page Objects ##### storefront-page-listing Storefront Listing Page Objects - [Listing page objects](/storefront/reference/page-objects/storefront-page-listing.md): Storefront Listing Page Objects ##### storefront-page-product Storefront Product Page Objects - [Product profile page objects](/storefront/reference/page-objects/storefront-page-product.md): Storefront Product Page Objects #### storefront-engine Storefront Theme Templating Language Features - [Templating Language Features](/storefront/reference/storefront-engine.md): Storefront Theme Templating Language Features #### storefront-page-structure Storefront Theme page Structure - [Theme Page Structure](/storefront/reference/storefront-page-structure.md): Storefront Theme page Structure #### storefront-structure Storefront Theme Structure - [Structure and contents of a storefront theme](/storefront/reference/storefront-structure.md): Storefront Theme Structure #### toolkit-commands Toolkit Commands - [Toolkit Commands](/storefront/reference/toolkit-commands.md): Toolkit Commands ### storefront-installation Installation - [Install the UI Toolkit](/storefront/storefront-installation.md): Installation ## user-guides API User Guides Overview - [User Guides](/user-guides.md): API User Guides Overview ### addon-store Add-On Store Overview - [Add-On Store](/user-guides/addon-store.md): Add-On Store Overview ### api-usage #### api-auth API authentication Overview - [API authentication](/user-guides/api-usage/api-auth.md): API authentication Overview ##### grant-type Grant types Overview - [Grant types](/user-guides/api-usage/api-auth/grant-type.md): Grant types Overview - [Authorization code for native applications](/user-guides/api-usage/api-auth/grant-type/authorize-native-app.md): Authorization code for native applications - [Authorization code for web applications](/user-guides/api-usage/api-auth/grant-type/authorize-web-app.md): Authorization code for web applications - [Client credentials](/user-guides/api-usage/api-auth/grant-type/credentials.md): Client credentials - [Implicit](/user-guides/api-usage/api-auth/grant-type/implicit.md): Implicit - [Password](/user-guides/api-usage/api-auth/grant-type/password.md): Password - [Refresh token](/user-guides/api-usage/api-auth/grant-type/refresh-token.md): Refresh token ##### role-mapping API and user interface role mapping - [API and user interface role mapping](/user-guides/api-usage/api-auth/role-mapping.md): API and user interface role mapping ##### scopes Scopes - [Scopes](/user-guides/api-usage/api-auth/scopes.md): Scopes ##### token-timeout Token timeouts - [Token timeouts](/user-guides/api-usage/api-auth/token-timeout.md): Token timeouts #### graphql ##### changelog API usage - GraphQL Changelog - [Changelog](/user-guides/api-usage/graphql/changelog.md): API usage - GraphQL Changelog ##### graqhql-explorer API usage - GraphQL Explorer and schema documentation - [GraphQL Explorer and schema documentation](/user-guides/api-usage/graphql/graqhql-explorer.md): API usage - GraphQL Explorer and schema documentation ##### graqhql-policy API usage - GraphQL API policy - [GraphQL API policy](/user-guides/api-usage/graphql/graqhql-policy.md): API usage - GraphQL API policy ##### mutations API usage - GraphQL Mutations - [Mutations](/user-guides/api-usage/graphql/mutations.md): API usage - GraphQL Mutations ##### overview API usage - GraphQL Overview - [Overview](/user-guides/api-usage/graphql/overview.md): API usage - GraphQL Overview ##### queries API usage - GraphQL Queries - [Queries](/user-guides/api-usage/graphql/queries.md): API usage - GraphQL Queries ##### ressource-limitations API usage - GraphQL Resource limitations - [Resource limitations](/user-guides/api-usage/graphql/ressource-limitations.md): API usage - GraphQL Resource limitations ##### terminology API usage - GraphQL terminology - [GraphQL terminology](/user-guides/api-usage/graphql/terminology.md): API usage - GraphQL terminology ##### variables API usage - GraphQL Variables - [Variables](/user-guides/api-usage/graphql/variables.md): API usage - GraphQL Variables #### rest ##### custom-attributes Use custom attributes with REST API - [Use custom attributes with API](/user-guides/api-usage/rest/custom-attributes.md): Use custom attributes with REST API ##### rate-limits REST - Rate limits - [Rate limits](/user-guides/api-usage/rest/rate-limits.md): REST - Rate limits ##### versioning REST API versioning policy - [REST API versioning policy](/user-guides/api-usage/rest/versioning.md): REST API versioning policy ### appdirect-status-definitions The following table describes the outage status definitions for various services. - [AppDirect status page service definitions](/user-guides/appdirect-status-definitions.md): The following table describes the outage status definitions for various services. ### billing-and-subscription Billing and subscription - [Billing and subscription](/user-guides/billing-and-subscription.md): Billing and subscription #### rest-api Billing and subscription - REST API - [Billing and subscription](/user-guides/billing-and-subscription/rest-api.md): Billing and subscription - REST API ##### assign-users Assign users - [Assign users](/user-guides/billing-and-subscription/rest-api/assign-users.md): Assign users - [Additional user assignment and unassignment examples](/user-guides/billing-and-subscription/rest-api/assign-users/additional-examples.md): Additional user assignment and unassignment examples - [Assign and unassign subscriptions](/user-guides/billing-and-subscription/rest-api/assign-users/assign-unassign-sub.md): Assign and unassign subscriptions - [Other subscription assignment-related API methods](/user-guides/billing-and-subscription/rest-api/assign-users/other-methods.md): Other subscription assignment-related API methods - [Use cases](/user-guides/billing-and-subscription/rest-api/assign-users/use-cases.md): Use cases ##### cancel-subscriptions Cancel subscriptions - [Cancel subscriptions](/user-guides/billing-and-subscription/rest-api/cancel-subscriptions.md): Cancel subscriptions - [Additional subscription cancel examples](/user-guides/billing-and-subscription/rest-api/cancel-subscriptions/additional-examples.md): Additional subscription cancel examples - [Canceling a subscription](/user-guides/billing-and-subscription/rest-api/cancel-subscriptions/canceling-a-subscription.md): Canceling a subscription - [Other subscription-related API methods](/user-guides/billing-and-subscription/rest-api/cancel-subscriptions/other-methods.md): Other subscription-related API methods - [Supported request attributes](/user-guides/billing-and-subscription/rest-api/cancel-subscriptions/supported-request-attributes.md): Supported request attributes - [Supported response attributes](/user-guides/billing-and-subscription/rest-api/cancel-subscriptions/supported-response-attributes.md): Supported response attributes - [Use cases](/user-guides/billing-and-subscription/rest-api/cancel-subscriptions/use-cases.md): Use cases ##### change-subscriptions Change subscriptions - [Change subscriptions](/user-guides/billing-and-subscription/rest-api/change-subscriptions.md): Change subscriptions - [Additional subscription change examples](/user-guides/billing-and-subscription/rest-api/change-subscriptions/additional-examples.md): Additional subscription change examples - [Changing a subscription](/user-guides/billing-and-subscription/rest-api/change-subscriptions/changing-a-subscription.md): Changing a subscription - [Other subscription-related API methods](/user-guides/billing-and-subscription/rest-api/change-subscriptions/other-methods.md): Other subscription-related API methods - [Products, payment plans and discounts](/user-guides/billing-and-subscription/rest-api/change-subscriptions/product-payment-plans-discounts.md): Products, payment plans and discounts - [Supported request attributes](/user-guides/billing-and-subscription/rest-api/change-subscriptions/supported-request-attributes.md): Supported request attributes - [Supported response attributes](/user-guides/billing-and-subscription/rest-api/change-subscriptions/supported-response-attributes.md): Supported response attributes - [Use cases](/user-guides/billing-and-subscription/rest-api/change-subscriptions/use-cases.md): Use cases ##### create-payment-instruments Create payment instruments - [Create payment instruments](/user-guides/billing-and-subscription/rest-api/create-payment-instruments.md): Create payment instruments - [Additional payment instrument creation examples](/user-guides/billing-and-subscription/rest-api/create-payment-instruments/additional-examples.md): Additional payment instrument creation examples - [Creating a payment instrument](/user-guides/billing-and-subscription/rest-api/create-payment-instruments/creating-payment-instrument.md): Creating a payment instrument - [Other payment instrument-related API methods](/user-guides/billing-and-subscription/rest-api/create-payment-instruments/other-methods.md): Other payment instrument-related API methods - [Supported request attributes](/user-guides/billing-and-subscription/rest-api/create-payment-instruments/supported-request-attributes.md): Supported request attributes - [Supported response attributes](/user-guides/billing-and-subscription/rest-api/create-payment-instruments/supported-response-attributes.md): Supported response attributes - [Use cases](/user-guides/billing-and-subscription/rest-api/create-payment-instruments/use-cases.md): Use cases ##### create-subscriptions Create subscriptions - [Create subscriptions](/user-guides/billing-and-subscription/rest-api/create-subscriptions.md): Create subscriptions - [Additional subscription creation examples](/user-guides/billing-and-subscription/rest-api/create-subscriptions/additional-examples.md): Additional subscription creation examples - [Creating a subscription](/user-guides/billing-and-subscription/rest-api/create-subscriptions/creating-a-subscription.md): Creating a subscription - [Other subscription-related API methods](/user-guides/billing-and-subscription/rest-api/create-subscriptions/other-methods.md): Other subscription-related API methods - [Products, payment plans and discounts](/user-guides/billing-and-subscription/rest-api/create-subscriptions/product-payment-plans-discounts.md): Products, payment plans and discounts - [Supported request attributes](/user-guides/billing-and-subscription/rest-api/create-subscriptions/supported-request-attributes.md): Supported request attributes - [Supported response attributes](/user-guides/billing-and-subscription/rest-api/create-subscriptions/supported-response-attributes.md): Supported response attributes - [Use cases](/user-guides/billing-and-subscription/rest-api/create-subscriptions/use-cases.md): Use cases ##### manage-discounts Manage discounts - [Manage discounts](/user-guides/billing-and-subscription/rest-api/manage-discounts.md): Manage discounts - [Configure retainable discounts](/user-guides/billing-and-subscription/rest-api/manage-discounts/configure-retainable-discounts.md): Configure retainable discounts - [Create discounts](/user-guides/billing-and-subscription/rest-api/manage-discounts/create-discounts.md): Create discounts - [Delete discounts](/user-guides/billing-and-subscription/rest-api/manage-discounts/delete-discounts.md): Delete discounts - [List discounts](/user-guides/billing-and-subscription/rest-api/manage-discounts/list-discounts.md): List discounts - [Retrieve discounts](/user-guides/billing-and-subscription/rest-api/manage-discounts/retrieve-discounts.md): Retrieve discounts - [Update discounts](/user-guides/billing-and-subscription/rest-api/manage-discounts/update-discounts.md): Update discounts ##### metered-usage-v1 Metered usage V1 - [Metered usage V1](/user-guides/billing-and-subscription/rest-api/metered-usage-v1.md): Metered usage V1 - [Metered usage prerequisites](/user-guides/billing-and-subscription/rest-api/metered-usage-v1/metered-usage-prereqs.md): Metered usage prerequisites - [Send custom metered usage](/user-guides/billing-and-subscription/rest-api/metered-usage-v1/send-custom.md): Send custom metered usage - [Send preconfigured metered usage](/user-guides/billing-and-subscription/rest-api/metered-usage-v1/send-preconfigured.md): Send preconfigured metered usage - [Supported metered usage units](/user-guides/billing-and-subscription/rest-api/metered-usage-v1/supported-metered-usage-units.md): Supported metered usage units ##### payment-js-library Payment.js library - [Payment.js library](/user-guides/billing-and-subscription/rest-api/payment-js-library.md): Payment.js library - [Payment.js authorization](/user-guides/billing-and-subscription/rest-api/payment-js-library/authorization.md): Payment.js authorization - [Choose your authorization method](/user-guides/billing-and-subscription/rest-api/payment-js-library/choose-authorization-method.md.md): Choose your authorization method - [Method 1: Create payment methods with a public developer key](/user-guides/billing-and-subscription/rest-api/payment-js-library/choose-authorization-method.md/method-1.md): Method 1: Create payment methods with a public developer key - [Create payment methods with tokens](/user-guides/billing-and-subscription/rest-api/payment-js-library/choose-authorization-method.md/method-1/create-payment-methods-tokens.md): Create payment methods with tokens - [Create tokens](/user-guides/billing-and-subscription/rest-api/payment-js-library/choose-authorization-method.md/method-1/create-tokens.md): Create tokens - [Initialize adPayment](/user-guides/billing-and-subscription/rest-api/payment-js-library/choose-authorization-method.md/method-1/initialize-adpayment.md): Initialize adPayment - [Method 2: Create payment methods with client-based tokens](/user-guides/billing-and-subscription/rest-api/payment-js-library/choose-authorization-method.md/method-2.md): Method 2: Create payment methods with client-based tokens - [Create payment methods directly](/user-guides/billing-and-subscription/rest-api/payment-js-library/choose-authorization-method.md/method-2/create-payment-methods-directly.md): Create payment methods directly - [Initialize adPayment](/user-guides/billing-and-subscription/rest-api/payment-js-library/choose-authorization-method.md/method-2/initialize-adpayment.md): Initialize adPayment - [List payment methods](/user-guides/billing-and-subscription/rest-api/payment-js-library/choose-authorization-method.md/method-2/list-payment-methods.md): List payment methods - [Collect payment method information](/user-guides/billing-and-subscription/rest-api/payment-js-library/collect-information.md): Collect payment method information - [Create the paymentMethod object](/user-guides/billing-and-subscription/rest-api/payment-js-library/create-payment-method-object.md): Create the paymentMethod object - [Payment.js GitHub repository](/user-guides/billing-and-subscription/rest-api/payment-js-library/github-repo.md): Payment.js GitHub repository - [Include payment.js](/user-guides/billing-and-subscription/rest-api/payment-js-library/include-payment-js.md): Include payment.js - [Retrieve supported payment method types](/user-guides/billing-and-subscription/rest-api/payment-js-library/retrieve-supported.md): Retrieve supported payment method types - [Retrieve user and company IDs](/user-guides/billing-and-subscription/rest-api/payment-js-library/retrieve-user-company-ids.md): Retrieve user and company IDs - [Test the library](/user-guides/billing-and-subscription/rest-api/payment-js-library/test-library.md): Test the library ### checkout Checkout - [Checkout](/user-guides/checkout.md): Checkout #### errorhandling Error handling - [Error handling](/user-guides/checkout/errorhandling.md): Error handling #### gettingstarted Getting started with Checkout APIs - [Getting started](/user-guides/checkout/gettingstarted.md): Getting started with Checkout APIs #### graphql Use cases - [Checkout APIs](/user-guides/checkout/graphql.md): Use cases ##### addeditpaymentdetails Add/edit payment details - [Add/edit payment details](/user-guides/checkout/graphql/addeditpaymentdetails.md): Add/edit payment details ##### additemstocart Add items to a cart - [Add items to a cart](/user-guides/checkout/graphql/additemstocart.md): Add items to a cart ##### applyremovediscount Apply/remove discount code - [Apply/remove discount codes](/user-guides/checkout/graphql/applyremovediscount.md): Apply/remove discount code ##### fetchaddmodifyshipping Fetch, add, and modify shipping details for a cart - [Fetch, add, and modify shipping details for a cart](/user-guides/checkout/graphql/fetchaddmodifyshipping.md): Fetch, add, and modify shipping details for a cart ##### fetchcheckoutsettings Fetch checkout settings - [Fetch checkout settings](/user-guides/checkout/graphql/fetchcheckoutsettings.md): Fetch checkout settings ##### fetchdetailsactive Fetch the details of an active cart - [Fetch the details of an active cart](/user-guides/checkout/graphql/fetchdetailsactive.md): Fetch the details of an active cart ##### finalizeacart Finalize a cart - [Finalize a cart](/user-guides/checkout/graphql/finalizeacart.md): Finalize a cart ##### getcartfields Get cart fields - [Get cart fields](/user-guides/checkout/graphql/getcartfields.md): Get cart fields ##### removeitemsfromacart Remove items from a cart - [Remove items from a cart](/user-guides/checkout/graphql/removeitemsfromacart.md): Remove items from a cart ##### updatecartdetails Update cart details - [Update cart details](/user-guides/checkout/graphql/updatecartdetails.md): Update cart details ##### validatecartdetails Validate cart details - [Validate cart details](/user-guides/checkout/graphql/validatecartdetails.md): Validate cart details ### custom-pricing Custom pricing - [Custom pricing](/user-guides/custom-pricing.md): Custom pricing #### graphql-api Custom pricing - GraphQL API - [Custom pricing guide](/user-guides/custom-pricing/graphql-api.md): Custom pricing - GraphQL API ##### create-price-books Create price books - [Create price books](/user-guides/custom-pricing/graphql-api/create-price-books.md): Create price books ##### create-price-books-conditions Create price book conditions - [Create price book conditions](/user-guides/custom-pricing/graphql-api/create-price-books-conditions.md): Create price book conditions ##### create-price-books-entries Create price book entries - [Create price book entries](/user-guides/custom-pricing/graphql-api/create-price-books-entries.md): Create price book entries ##### marketplace-prices Set Marketplace Prices - [Set Marketplace Prices](/user-guides/custom-pricing/graphql-api/marketplace-prices.md): Set Marketplace Prices ##### reseller-wholesale-prices Set Reseller Wholesale Prices - [Set Reseller Wholesale Prices](/user-guides/custom-pricing/graphql-api/reseller-wholesale-prices.md): Set Reseller Wholesale Prices ### DevCenter2.0 Dev Center 2.0 - [Overview](/user-guides/DevCenter2.0.md): Dev Center 2.0 #### CustomizePartnerOnboarding Customize partner onboarding - [Customize partner onboarding](/user-guides/DevCenter2.0/CustomizePartnerOnboarding.md): Customize partner onboarding ##### Action-menu-options Action menu options - [Action menu option](/user-guides/DevCenter2.0/CustomizePartnerOnboarding/Action-menu-options.md): Action menu options ##### Customize-theme-for-form Customize theme for the form - [Customize theme for the form](/user-guides/DevCenter2.0/CustomizePartnerOnboarding/Customize-theme-for-form.md): Customize theme for the form ##### Onboarding-using-Visual-form-builder Customize partner onboarding form using visual editor - [Customize partner onboarding form using visual editor](/user-guides/DevCenter2.0/CustomizePartnerOnboarding/Onboarding-using-Visual-form-builder.md): Customize partner onboarding form using visual editor #### ManageDeveloperApplicants Manage developer applicants - [Manage developer applicants](/user-guides/DevCenter2.0/ManageDeveloperApplicants.md): Manage developer applicants ##### Add-lead Add leads - [Add leads](/user-guides/DevCenter2.0/ManageDeveloperApplicants/Add-lead.md): Add leads ##### Download-applicant-list Download applicant list - [Download applicant list](/user-guides/DevCenter2.0/ManageDeveloperApplicants/Download-applicant-list.md): Download applicant list ##### Search-filter-applicants Search and filter applicants - [Search and filter data](/user-guides/DevCenter2.0/ManageDeveloperApplicants/Search-filter-applicants.md): Search and filter applicants ### extensions Platform Extensions Overview - [Elevating Your Marketplace](/user-guides/extensions.md): Platform Extensions Overview #### getting-started The platform extensions system is a powerful feature that allows 3rd party developers to build custom UI applications and embed them inside the marketplace. This documentation provides a comprehensive guide to building and uploading platform extensions to the platform. It includes step-by-step instructions, best practices, troubleshooting guidance, and examples. - [Getting Started](/user-guides/extensions/getting-started.md): The platform extensions system is a powerful feature that allows 3rd party developers to build custom UI applications and embed them inside the marketplace. This documentation provides a comprehensive guide to building and uploading platform extensions to the platform. It includes step-by-step instructions, best practices, troubleshooting guidance, and examples. #### how-tos ##### add-static-assets Add Static assets - [Add Static Assets](/user-guides/extensions/how-tos/add-static-assets.md): Add Static assets ##### create-extension Create a new extension - [Create a new extension](/user-guides/extensions/how-tos/create-extension.md): Create a new extension ##### installation Installation - [Install the UI Toolkit](/user-guides/extensions/how-tos/installation.md): Installation ##### local-development Developing and testing your extension locally is an essential step before publishing it to the Marketplace. In this guide, we will take you through the necessary steps to get your extension up and running on your local machine. - [Local Extension Development](/user-guides/extensions/how-tos/local-development.md): Developing and testing your extension locally is an essential step before publishing it to the Marketplace. In this guide, we will take you through the necessary steps to get your extension up and running on your local machine. ##### localization At AppDirect, we recognize the significance of localization for customers operating across various markets. Our platform extensions boilerplate app integrates react-intl, a widely-used localization library for React applications. This integration enables seamless localization of your front-end pages to cater to your audience's requirements. The comprehensive react-intl API is accessible, granting you complete access to its features and capabilities. - [Localization](/user-guides/extensions/how-tos/localization.md): At AppDirect, we recognize the significance of localization for customers operating across various markets. Our platform extensions boilerplate app integrates react-intl, a widely-used localization library for React applications. This integration enables seamless localization of your front-end pages to cater to your audience's requirements. The comprehensive react-intl API is accessible, granting you complete access to its features and capabilities. ##### marketplace-context This guide concentrates on Bootstrap Data, a hook that grants access to various marketplace configurations and user details. Utilizing this data enables you to tailor a more personalized experience for your users. Let's get started! - [Accessing Company, User, and Settings Data](/user-guides/extensions/how-tos/marketplace-context.md): This guide concentrates on Bootstrap Data, a hook that grants access to various marketplace configurations and user details. Utilizing this data enables you to tailor a more personalized experience for your users. Let's get started! ##### marketplace-data Overview - [Using the Marketplace APIs](/user-guides/extensions/how-tos/marketplace-data.md): Overview ##### preview-publish Developers utilizing our extension system create custom UI applications to augment the platform's capabilities. This document serves as a comprehensive guide to previewing, publishing, and enabling platform extensions, ensuring they are ready for users. Each action is a crucial component of the extension deployment process: - [Extension Preview, Publication, and Enabling](/user-guides/extensions/how-tos/preview-publish.md): Developers utilizing our extension system create custom UI applications to augment the platform's capabilities. This document serves as a comprehensive guide to previewing, publishing, and enabling platform extensions, ensuring they are ready for users. Each action is a crucial component of the extension deployment process: ##### secure-token-for-api-integration Introduction - [Integrate External APIs with Secure Tokens](/user-guides/extensions/how-tos/secure-token-for-api-integration.md): Introduction - [Fetch Token](/user-guides/extensions/how-tos/secure-token-for-api-integration/fetch-token.md): Overview - [Validate Token](/user-guides/extensions/how-tos/secure-token-for-api-integration/validate-token.md): After fetching the authentication token in your extension app, the token can now be included with the requests to your API. ##### upload-extension Uploading an Extension - [Uploading an Extension](/user-guides/extensions/how-tos/upload-extension.md): Uploading an Extension #### reference ##### architecture Overview - [Extensions Architecture](/user-guides/extensions/reference/architecture.md): Overview ##### components-library Introduction - [Components Library Integration](/user-guides/extensions/reference/components-library.md): Introduction ##### secure-token-system The secure token system allows authenticated access to your external APIs from within your extension frontend app, with the use of Cross-Origin Resource Sharing (CORS) headers and JSON Web Tokens (JWT). - [Secure token system](/user-guides/extensions/reference/secure-token-system.md): The secure token system allows authenticated access to your external APIs from within your extension frontend app, with the use of Cross-Origin Resource Sharing (CORS) headers and JSON Web Tokens (JWT). ### Functions #### functions-early-access Early Access - [Early Access Features for AppDirect Functions](/user-guides/Functions/functions-early-access.md): Early Access #### functions-getting-started Functions - [Getting Started with AppDirect Functions](/user-guides/Functions/functions-getting-started.md): Functions ### graphql-dev-tools Developer tools for GraphQL - [Developer tools](/user-guides/graphql-dev-tools.md): Developer tools for GraphQL #### enable-graphql-tools The GraphQL Explorer is a browser-based tool that lets Marketplace - [Enable GraphQL tools](/user-guides/graphql-dev-tools/enable-graphql-tools.md): The GraphQL Explorer is a browser-based tool that lets Marketplace #### graphql-demo To run production and preview queries and mutations, - [Demo GraphQL API Explorer](/user-guides/graphql-dev-tools/graphql-demo.md): To run production and preview queries and mutations, #### graphql-explorer The GraphQL Explorer uses your live data (including the Preview - [GraphQL Explorer](/user-guides/graphql-dev-tools/graphql-explorer.md): The GraphQL Explorer uses your live data (including the Preview #### graphql-schema-introspection Introspection must be enabled to execute - [GraphQL Schema Introspection](/user-guides/graphql-dev-tools/graphql-schema-introspection.md): Introspection must be enabled to execute ### inventory Inventory - [Inventory](/user-guides/inventory.md): Inventory #### glossary Glossary - [Glossary](/user-guides/inventory/glossary.md): Glossary #### graphql-api Inventory GraphQL API - [Inventory](/user-guides/inventory/graphql-api.md): Inventory GraphQL API ##### marketplace-ui Inventory in the marketplace UI - [Inventory in the marketplace UI](/user-guides/inventory/graphql-api/marketplace-ui.md): Inventory in the marketplace UI ##### mutations Inventory mutations - [Inventory mutations](/user-guides/inventory/graphql-api/mutations.md): Inventory mutations ##### queries Inventory queries - [Inventory queries](/user-guides/inventory/graphql-api/queries.md): Inventory queries ### ironclad-clickwrap-marktplc Ironclad is an embedded contract management tool. AppDirect uses Ironclad Clickwrap with the marketplace to manage the terms and conditions and policies that a user must accept to activate their accounts on the marketplace. - [Ironclad Clickwrap integration](/user-guides/ironclad-clickwrap-marktplc.md): Ironclad is an embedded contract management tool. AppDirect uses Ironclad Clickwrap with the marketplace to manage the terms and conditions and policies that a user must accept to activate their accounts on the marketplace. ### notifications Notifications - [Notifications](/user-guides/notifications.md): Notifications #### graphql-api Notifications GraphQL API - [Notifications](/user-guides/notifications/graphql-api.md): Notifications GraphQL API ### product-information Product - [Product](/user-guides/product-information.md): Product #### gettingstarted Getting started with product APIs - [Getting started](/user-guides/product-information/gettingstarted.md): Getting started with product APIs ##### api-difference API differences - [Understanding product API differences: Marketplace vs. Catalog](/user-guides/product-information/gettingstarted/api-difference.md): API differences ##### product-glossay Product glossary - [Product glossary](/user-guides/product-information/gettingstarted/product-glossay.md): Product glossary ##### product-model Product model - [Product model](/user-guides/product-information/gettingstarted/product-model.md): Product model ##### understanding-publication Understanding product publication - [Understanding product publication](/user-guides/product-information/gettingstarted/understanding-publication.md): Understanding product publication #### graphql-api GraphQL API guide - [Product API guide](/user-guides/product-information/graphql-api.md): GraphQL API guide ##### branding Add listing and profile information - [Add listing and profile information](/user-guides/product-information/graphql-api/branding.md): Add listing and profile information ##### create-editions Create editions - [Create editions](/user-guides/product-information/graphql-api/create-editions.md): Create editions ##### create-integration-config Create an integration configuration - [Create an integration configuration](/user-guides/product-information/graphql-api/create-integration-config.md): Create an integration configuration ##### create-pricing-plans Create pricing plans - [Create pricing plans](/user-guides/product-information/graphql-api/create-pricing-plans.md): Create pricing plans ##### create-product-shell Create the product shell - [Create the product shell](/user-guides/product-information/graphql-api/create-product-shell.md): Create the product shell ##### mapping Publish - [Mapping product fields](/user-guides/product-information/graphql-api/mapping.md): Publish ##### publish Publish - [Publish and add to marketplace](/user-guides/product-information/graphql-api/publish.md): Publish #### practical-guidelines Practical guidelines - [Practical guidelines](/user-guides/product-information/practical-guidelines.md): Practical guidelines #### profile Product management guide - [Product Management Guide](/user-guides/product-information/profile.md): Product management guide ##### profile-completion Profile completion - [Product Profile completion guidelines](/user-guides/product-information/profile/profile-completion.md): Profile completion ### product-integration Product integration - [Product integration](/user-guides/product-integration.md): Product integration #### rest-api Product vendors can use API requests to synchronize company or user information between their own systems and the AppDirect platform. See the following sections for more information: - [Product Integration](/user-guides/product-integration/rest-api.md): Product vendors can use API requests to synchronize company or user information between their own systems and the AppDirect platform. See the following sections for more information: ##### company-synchronization Company Synchronization (Company Sync) enables developers to send developer account information to the marketplace. A developer account is a customer that owns subscriptions for a single company or organization. - [Company synchronization](/user-guides/product-integration/rest-api/company-synchronization.md): Company Synchronization (Company Sync) enables developers to send developer account information to the marketplace. A developer account is a customer that owns subscriptions for a single company or organization. - [Company Sync HTTP status codes](/user-guides/product-integration/rest-api/company-synchronization/company-sync-http-status.md): Code - [Company Sync prerequisites](/user-guides/product-integration/rest-api/company-synchronization/company-sync-prereq.md): Complete the following before using the Company Sync endpoints. - [Create developer accounts](/user-guides/product-integration/rest-api/company-synchronization/create-dev-accounts.md): Description: Use this request to notify AppDirect that a new developer account was created on a developer system. It is only possible to create one developer account per request. - [Notify AppDirect of expired developer accounts](/user-guides/product-integration/rest-api/company-synchronization/notify-expired-dev-accounts.md): Description: Use this request to notify AppDirect that an existing developer account has expired on a developer system. It is also used if the relationship with the reseller was revoked. It is only possible to indicate a single expired developer account per request. ##### metered-usage-v1 Metered usage V1 - [Metered usage V1](/user-guides/product-integration/rest-api/metered-usage-v1.md): Metered usage V1 - [Metered usage API HTTP status codes](/user-guides/product-integration/rest-api/metered-usage-v1/metered-usage-api-status-codes.md): To view the HTTP status codes that are relevant to the metered usage V1 API, see Billing usage in the REST API reference documentation. - [Metered usage prerequisites](/user-guides/product-integration/rest-api/metered-usage-v1/metered-usage-prereq.md): You must complete the following prerequisites before you can send a user's metered usage to a marketplace. - [Preconfigured and custom metered usage](/user-guides/product-integration/rest-api/metered-usage-v1/pre-configured-and-custom.md): There are two types of metered usage: preconfigured and custom. Both types require product configuration before you submit usage with the API (see Metered usage prerequisites). - [Send custom metered usage](/user-guides/product-integration/rest-api/metered-usage-v1/send-custom-metered-usage.md): Description—Send usage data for custom metered usage to the AppDirect marketplace that hosts the user account. For a description of custom metered usage, see Preconfigured and custom metered usage. - [Send preconfigured metered usage](/user-guides/product-integration/rest-api/metered-usage-v1/send-preconfigured-usage.md): Description: Send usage data for preconfigured metered usage to the AppDirect marketplace that hosts the user account. For a description of preconfigured metered usage, see Preconfigured and custom metered usage. - [Supported metered usage units](/user-guides/product-integration/rest-api/metered-usage-v1/supported-metered-usage-units.md): The AppDirect platform supports many preconfigured usage units. See PricingUnit in the API reference documentation. If you require additional unit types, contact your AppDirect technical representative. ##### metered-usage-v2 Metered usage V2 - [Metered usage V2](/user-guides/product-integration/rest-api/metered-usage-v2.md): Metered usage V2 - [Delayed invoicing recommendation](/user-guides/product-integration/rest-api/metered-usage-v2/delayed-invoicing-rec.md): Metered usage V2 supports delayed invoicing. We recommend that you enable delayed invoicing for products configured for metered usage if you (the vendor) will be: - [Fetch usage processing status](/user-guides/product-integration/rest-api/metered-usage-v2/fetch-usage-processing-status.md): Description: Retrieve the status of metered usage events submitted with Billing Usage v2 requests (see Send preconfigured metered usage and Send preconfigured and custom metered usage). To do so, reference the response for the Billing Usage v2 request and either - [Historic usage and adjustments](/user-guides/product-integration/rest-api/metered-usage-v2/historic-usage-and-adjustments.md): Usage can be submitted retroactively to correct usage for billing periods that are already invoiced except for usage for products configured for volume pricing. Every usage event is submitted with an associated date, so adjustments are allocated to the correct historic billing period and invoiced accordingly. Missed usage can be submitted, and over-reported usage corrected, as illustrated with the following examples: - [Metered usage API HTTP status codes](/user-guides/product-integration/rest-api/metered-usage-v2/metered-usage-api-status-codes.md): To view the HTTP status codes that are relevant to the metered usage V2 API, see Billing usage V2 in the REST API reference documentation. - [Metered usage prerequisites](/user-guides/product-integration/rest-api/metered-usage-v2/metered-usage-prereq.md): We recommend that you assess whether delayed invoicing is appropriate for your products that are configured for metered usage. See Delayed invoicing recommendation. - [Preconfigured and custom metered usage](/user-guides/product-integration/rest-api/metered-usage-v2/pre-configured-and-custom.md): There are two types of metered usage: preconfigured and custom. Both types require product configuration before you submit usage with the API (see Metered usage prerequisites). With the V2 API, if needed, you can submit both preconfigured and custom metered usage events in the same call. - [Send custom metered usage](/user-guides/product-integration/rest-api/metered-usage-v2/send-custom-metered-usage.md): Description: Send up to 850 custom metered usage events or request a payload of size 262144 bytes to the AppDirect marketplace that hosts the user account. For a description of custom metered usage, see Preconfigured and custom metered usage. - [Send preconfigured and custom metered usage](/user-guides/product-integration/rest-api/metered-usage-v2/send-preconfig-custom-metered-usage.md): You cannot use this combined pricing model method for usage for products configured with volume pricing. Usage for products configured with volume pricing must not be sent in API requests with usage for other pricing models. - [Send preconfigured metered usage](/user-guides/product-integration/rest-api/metered-usage-v2/send-preconfigured-usage.md): Description: Send up to 250 preconfigured metered usage events to the AppDirect marketplace that hosts the user account. For a description of preconfigured metered usage, see Preconfigured and custom metered usage. - [Supported metered usage units](/user-guides/product-integration/rest-api/metered-usage-v2/supported-metered-usage-units.md): The AppDirect platform supports many preconfigured usage units. See PricingUnit in the API reference documentation. If you require additional unit types, contact your AppDirect technical representative. ##### user-synchronization When a new user is set up on the marketplace and assigned to a subscription, the Developer is notified and the user is automatically set up on the developer system. See User assignment for more information. - [User synchronization](/user-guides/product-integration/rest-api/user-synchronization.md): When a new user is set up on the marketplace and assigned to a subscription, the Developer is notified and the user is automatically set up on the developer system. See User assignment for more information. - [Assign users](/user-guides/product-integration/rest-api/user-synchronization/assign-users.md): Use this request to notify AppDirect that a new user has been assigned on the developer system. - [Unassign users](/user-guides/product-integration/rest-api/user-synchronization/unassign-users.md): Use this request to unassign users from the Developer's company after they are removed from the developer platform. - [User Sync HTTP status codes](/user-guides/product-integration/rest-api/user-synchronization/user-sync-http-status.md): Code - [User Sync prerequisites](/user-guides/product-integration/rest-api/user-synchronization/user-sync-prereq.md): Before you can use the User Sync endpoints, you must do the following things. ### product-variants Product variants - [Product variants](/user-guides/product-variants.md): Product variants #### graphql-api Product variants - GraphQL API - [Product Variants](/user-guides/product-variants/graphql-api.md): Product variants - GraphQL API ##### features Product variant features - [Product variants features](/user-guides/product-variants/graphql-api/features.md): Product variant features - [Disable variant](/user-guides/product-variants/graphql-api/features/disable-variant.md): Disable variant - [Enable variant](/user-guides/product-variants/graphql-api/features/enable-variant.md): Enable variant - [Query variant creation](/user-guides/product-variants/graphql-api/features/query-variant-creation.md): Query variant creation - [Trigger variant creation](/user-guides/product-variants/graphql-api/features/trigger-variant-creation.md): Trigger variant creation - [Update variant](/user-guides/product-variants/graphql-api/features/update-variant.md): Update variant ##### options Product variant options - [Product variant options](/user-guides/product-variants/graphql-api/options.md): Product variant options - [Create variant option](/user-guides/product-variants/graphql-api/options/create-variant-option.md): Use the Create variant options - [Disable variant option](/user-guides/product-variants/graphql-api/options/disable-variant-option.md): Use the Remove variant - [Order variant option](/user-guides/product-variants/graphql-api/options/order-variant-options.md): Use the Order variant options - [Update variant option](/user-guides/product-variants/graphql-api/options/update-variant-options.md): Use the Update variant options ##### query-marketplace-products Query marketplace products - [Query marketplace products](/user-guides/product-variants/graphql-api/query-marketplace-products.md): Query marketplace products ##### values Product variant values - [Product variant values](/user-guides/product-variants/graphql-api/values.md): Product variant values - [Create variant values](/user-guides/product-variants/graphql-api/values/create-variant-values.md): Create variant values - [Delete variant values](/user-guides/product-variants/graphql-api/values/delete-variant-values.md): Delete variant values - [Order variant values](/user-guides/product-variants/graphql-api/values/order-variant-values.md): Order variant values - [Update variant values](/user-guides/product-variants/graphql-api/values/update-variant-values.md): Update variant values ### reseller Overview - [Reseller](/user-guides/reseller.md): Overview #### graphql The Reseller GraphQL API provides tools for querying and managing existing Reseller type accounts. - [Reseller GraphQL API](/user-guides/reseller/graphql.md): The Reseller GraphQL API provides tools for querying and managing existing Reseller type accounts. ##### mutations A Marketplace Manager or Reseller Manager can use the Reseller GraphQL mutations to assign an account to a Reseller as a client, or to remove such an assignment. - [Reseller GraphQL Mutations](/user-guides/reseller/graphql/mutations.md): A Marketplace Manager or Reseller Manager can use the Reseller GraphQL mutations to assign an account to a Reseller as a client, or to remove such an assignment. ##### queries The Reseller GraphQL queries allow you to search for accounts and account memberships based on the Reseller-client links between accounts. - [Reseller GraphQL Queries](/user-guides/reseller/graphql/queries.md): The Reseller GraphQL queries allow you to search for accounts and account memberships based on the Reseller-client links between accounts. ### search Overview - [Search](/user-guides/search.md): Overview #### graphql With AppDirect Search, marketplace - [Search](/user-guides/search/graphql.md): With AppDirect Search, marketplace ##### query Use the feedResources - [Query feed resources](/user-guides/search/graphql/query.md): Use the feedResources #### rest With AppDirect Search, marketplace - [Search](/user-guides/search/rest.md): With AppDirect Search, marketplace ##### configure To aggregate data related to a product with the AppDirect Search - [Configure products for Search](/user-guides/search/rest/configure.md): To aggregate data related to a product with the AppDirect Search ##### connect-users Description: Create a new user connection to share and retrieve data - [Connect users and applications to Search](/user-guides/search/rest/connect-users.md): Description: Create a new user connection to share and retrieve data ##### disconnect Description: Disconnect a user connection from AppDirect Search. - [Disconnect users and applications from Search](/user-guides/search/rest/disconnect.md): Description: Disconnect a user connection from AppDirect Search. ##### getting-started For a description of the AppDirect Search feature, see - [Getting started with Search](/user-guides/search/rest/getting-started.md): For a description of the AppDirect Search feature, see ##### publish-data Description: Use the Publish content events endpoint to send and - [Publish data to Search](/user-guides/search/rest/publish-data.md): Description: Use the Publish content events endpoint to send and ##### query-content Merchants use a GraphQL API to query Appdirect Search for feeds. See - [Query content for feeds](/user-guides/search/rest/query-content.md): Merchants use a GraphQL API to query Appdirect Search for feeds. See ##### search-content Description: Search for keywords in the AppDirect Search repository. - [Search content](/user-guides/search/rest/search-content.md): Description: Search for keywords in the AppDirect Search repository. ### serialized-fulfillment Overview - [Serialized Fulfillment](/user-guides/serialized-fulfillment.md): Overview #### graphql The Serialized Fulfillment GraphQL API supports a Serialized Fulfillment system that can track individually identified items within a shipment of physical products. - [Serialized Fulfillment GraphQL API](/user-guides/serialized-fulfillment/graphql.md): The Serialized Fulfillment GraphQL API supports a Serialized Fulfillment system that can track individually identified items within a shipment of physical products. ##### mutations The Serialized Fulfillment mutations allow you to create a list of serialized units in a specific shipment for a specific shipping item, or to remove an existing list. - [Serialized Fulfillment Mutations](/user-guides/serialized-fulfillment/graphql/mutations.md): The Serialized Fulfillment mutations allow you to create a list of serialized units in a specific shipment for a specific shipping item, or to remove an existing list. ##### queries The Serialized Fulfillment GraphQL API includes the following query: - [Serialized Fulfillment Queries](/user-guides/serialized-fulfillment/graphql/queries.md): The Serialized Fulfillment GraphQL API includes the following query: ### shipping-integration Shipping integration - [Shipping integration](/user-guides/shipping-integration.md): Shipping integration #### rest-api Shipping integration - REST API - [Shipping integration](/user-guides/shipping-integration/rest-api.md): Shipping integration - REST API ##### custom-shipping-connector-tech-design Custom shipping connector technical design - [Custom shipping connector technical design](/user-guides/shipping-integration/rest-api/custom-shipping-connector-tech-design.md): Custom shipping connector technical design - [Calls expected by the purchase fulfillment manager](/user-guides/shipping-integration/rest-api/custom-shipping-connector-tech-design/calls-expected.md): Calls expected by the purchase fulfillment manager - [Data objects](/user-guides/shipping-integration/rest-api/custom-shipping-connector-tech-design/data-objects.md): Data objects - [Limitations](/user-guides/shipping-integration/rest-api/custom-shipping-connector-tech-design/limitations.md): Limitations - [Marketplace-specific configurations](/user-guides/shipping-integration/rest-api/custom-shipping-connector-tech-design/marketplace-specific-configurations.md): Marketplace-specific configurations - [Shipment authentication](/user-guides/shipping-integration/rest-api/custom-shipping-connector-tech-design/shipment-authentication.md): Shipment authentication - [Shipping fulfillment flow](/user-guides/shipping-integration/rest-api/custom-shipping-connector-tech-design/shipping-fulfillment-flow.md): Shipping fulfillment flow ##### manage-shipping-zones Manage shipping zones - [Manage shipping zones](/user-guides/shipping-integration/rest-api/manage-shipping-zones.md): Manage shipping zones ##### shipping-connector-requirements Shipping connector requirements - [Shipping connector requirements](/user-guides/shipping-integration/rest-api/shipping-connector-requirements.md): Shipping connector requirements ##### shipping-fulfillment-types Shipping fulfillment types - [Shipping fulfillment types](/user-guides/shipping-integration/rest-api/shipping-fulfillment-types.md): Shipping fulfillment types ### subscription-price-change Subscription price change - [Subscription price change](/user-guides/subscription-price-change.md): Subscription price change #### graphql-api Subscription price change guide - [Subscription price change guide](/user-guides/subscription-price-change/graphql-api.md): Subscription price change guide ##### business-use-cases Business use cases - [Business use cases](/user-guides/subscription-price-change/graphql-api/business-use-cases.md): Business use cases ##### instructions-price-change Instructions to change a price - [Instructions to change a price](/user-guides/subscription-price-change/graphql-api/instructions-price-change.md): Instructions to change a price ##### supported-use-cases Supported use cases - [Supported use cases](/user-guides/subscription-price-change/graphql-api/supported-use-cases.md): Supported use cases ##### using-graphql-api Using the GraphQL APIs - [Using the GraphQL APIs](/user-guides/subscription-price-change/graphql-api/using-graphql-api.md): Using the GraphQL APIs ### user-companies Users and companies - [User and account management](/user-guides/user-companies.md): Users and companies #### apireferences API Reference - [API Reference](/user-guides/user-companies/apireferences.md): API Reference #### gettingstarted Getting started with user and account management APIs - [Getting started](/user-guides/user-companies/gettingstarted.md): Getting started with user and account management APIs #### graphql Use cases - [Use cases](/user-guides/user-companies/graphql.md): Use cases ##### convertingmanageduserscompanies Converting managed users/companies - [Convert managed users or companies](/user-guides/user-companies/graphql/convertingmanageduserscompanies.md): Converting managed users/companies ##### creatingmanageduserscompanies Creating managed users/companies - [Create managed users or companies](/user-guides/user-companies/graphql/creatingmanageduserscompanies.md): Creating managed users/companies ##### creatingnewcompaniesforexistingusers Create new companies for existing users - [Create new companies for existing users](/user-guides/user-companies/graphql/creatingnewcompaniesforexistingusers.md): Create new companies for existing users #### rest Managing user and account APIs - [Working with user and account management APIs](/user-guides/user-companies/rest.md): Managing user and account APIs ##### createcompanies User and Companies - Create companies - [Create companies/accounts](/user-guides/user-companies/rest/createcompanies.md): User and Companies - Create companies ##### createcompanyaccountmemberships Create company/account memberships - [Create company/account memberships](/user-guides/user-companies/rest/createcompanyaccountmemberships.md): Create company/account memberships ##### createusers Create users - [Create users](/user-guides/user-companies/rest/createusers.md): Create users ##### deletecompanyaccountmemberships Delete company/account memberships - [Delete company/account memberships](/user-guides/user-companies/rest/deletecompanyaccountmemberships.md): Delete company/account memberships ##### deleteusers Delete users - [Delete users](/user-guides/user-companies/rest/deleteusers.md): Delete users ##### managecompanyinvitations Manage company invitations - [Manage company invitations](/user-guides/user-companies/rest/managecompanyinvitations.md): Manage company invitations ##### readcompaniesaccounts Read companies/accounts - [Read companies/accounts](/user-guides/user-companies/rest/readcompaniesaccounts.md): Read companies/accounts ##### readuserdetails Read user details - [Read user details](/user-guides/user-companies/rest/readuserdetails.md): Read user details ##### updatecompanies Update companies/accounts - [Update companies/accounts](/user-guides/user-companies/rest/updatecompanies.md): Update companies/accounts ##### updatecompanyaccountmemberships Update company/account memberships - [Update company/account memberships](/user-guides/user-companies/rest/updatecompanyaccountmemberships.md): Update company/account memberships ##### updateusers Update users - [Update users](/user-guides/user-companies/rest/updateusers.md): Update users #### troubleshooting Troubleshooting - [Troubleshooting](/user-guides/user-companies/troubleshooting.md): Troubleshooting ## webhooks ### examples Webhook Examples - [Examples](/webhooks/examples.md): Webhook Examples ### troubleshooting Troubleshooting - [Troubleshooting webhooks](/webhooks/troubleshooting.md): Troubleshooting ### webhookFAQ FAQs - [FAQs](/webhooks/webhookFAQ.md): FAQs ### webhookintro Webhooks are a way for web applications to provide real-time notifications or data updates to other applications or services. It is a method of communication between two systems over the Internet. With webhooks, the AppDirect platform can send notifications to specific URLs when certain events occur in the system. Marketplace Managers can use the UI or API to configure webhooks. For example, you can configure to receive notifications when users are created, products are modified, or subscriptions are canceled. - [Webhooks](/webhooks/webhookintro.md): Webhooks are a way for web applications to provide real-time notifications or data updates to other applications or services. It is a method of communication between two systems over the Internet. With webhooks, the AppDirect platform can send notifications to specific URLs when certain events occur in the system. Marketplace Managers can use the UI or API to configure webhooks. For example, you can configure to receive notifications when users are created, products are modified, or subscriptions are canceled. #### webhookimportant Webhooks importance - [Why are webhooks important?](/webhooks/webhookintro/webhookimportant.md): Webhooks importance ### webookconfig Configure and manage webhooks - [Configure and manage webhooks](/webhooks/webookconfig.md): Configure and manage webhooks #### managewebhooks Manage webhooks - [Manage webhooks](/webhooks/webookconfig/managewebhooks.md): Manage webhooks #### pattern Webhook patterns - [Webhook patterns](/webhooks/webookconfig/pattern.md): Webhook patterns #### webhook-auth Webhook authentication - [Webhook authentication](/webhooks/webookconfig/webhook-auth.md): Webhook authentication ### working-with-webhooks Webhook reference - [Webhook reference](/webhooks/working-with-webhooks.md): Webhook reference #### actions Webhook list with UI actions - [Webhook list with UI actions](/webhooks/working-with-webhooks/actions.md): Webhook list with UI actions #### auditlogs You can use audit logs to track all interactions, such as creation, updates, and deletions, along with key details such as who made the change, when it occurred, and what was modified. - [Audit logs for webhooks](/webhooks/working-with-webhooks/auditlogs.md): You can use audit logs to track all interactions, such as creation, updates, and deletions, along with key details such as who made the change, when it occurred, and what was modified. #### payload Webhook notification payloads - [Webhook notification payloads](/webhooks/working-with-webhooks/payload.md): Webhook notification payloads ##### app-assignment The resource:url for an App Assignment webhook payload uses this basic - [App Assignment webhook payload](/webhooks/working-with-webhooks/payload/app-assignment.md): The resource:url for an App Assignment webhook payload uses this basic ##### catalog-product The resource:url for a Catalog Product webhook payload uses this basic - [Catalog Product webhook payload](/webhooks/working-with-webhooks/payload/catalog-product.md): The resource:url for a Catalog Product webhook payload uses this basic ##### company The resource - [Company webhook payload](/webhooks/working-with-webhooks/payload/company.md): The resource ##### invoice The resource - [Invoice webhook payload](/webhooks/working-with-webhooks/payload/invoice.md): The resource ##### membership The resource:url for a Membership webhook payload uses this basic - [Membership webhook payload](/webhooks/working-with-webhooks/payload/membership.md): The resource:url for a Membership webhook payload uses this basic ##### order The resource - [Order webhook payload](/webhooks/working-with-webhooks/payload/order.md): The resource ##### staging-product The resource:url for a Staging Product webhook payload uses this basic - [Staging Product webhook payload](/webhooks/working-with-webhooks/payload/staging-product.md): The resource:url for a Staging Product webhook payload uses this basic ##### subscription The resource:url for a Subscription webhook payload uses this basic - [Subscription webhook payload](/webhooks/working-with-webhooks/payload/subscription.md): The resource:url for a Subscription webhook payload uses this basic ##### user User webhook payload - [User webhook payload](/webhooks/working-with-webhooks/payload/user.md): User webhook payload #### resources-list Webhooks send notifications when AppDirect system events occur. Events - [Webhook resources, actions, and events](/webhooks/working-with-webhooks/resources-list.md): Webhooks send notifications when AppDirect system events occur. Events