@vendure/docs 0.0.0-202601161541
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.ts +3 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +2 -0
- package/dist/index.js.map +1 -0
- package/dist/manifest.d.ts +3 -0
- package/dist/manifest.d.ts.map +1 -0
- package/dist/manifest.js +857 -0
- package/dist/manifest.js.map +1 -0
- package/docs/guides/core-concepts/auth/admin-role.webp +0 -0
- package/docs/guides/core-concepts/auth/admin.webp +0 -0
- package/docs/guides/core-concepts/auth/customer.webp +0 -0
- package/docs/guides/core-concepts/auth/index.md +557 -0
- package/docs/guides/core-concepts/auth/roles.webp +0 -0
- package/docs/guides/core-concepts/channels/channel-token.webp +0 -0
- package/docs/guides/core-concepts/channels/channels.webp +0 -0
- package/docs/guides/core-concepts/channels/channels_currencies_diagram.png +0 -0
- package/docs/guides/core-concepts/channels/channels_diagram.png +0 -0
- package/docs/guides/core-concepts/channels/channels_prices_diagram.png +0 -0
- package/docs/guides/core-concepts/channels/default-currency.webp +0 -0
- package/docs/guides/core-concepts/channels/index.md +154 -0
- package/docs/guides/core-concepts/channels/variant-prices.webp +0 -0
- package/docs/guides/core-concepts/collections/collection-filters.webp +0 -0
- package/docs/guides/core-concepts/collections/collections.webp +0 -0
- package/docs/guides/core-concepts/collections/filter-inheritance.webp +0 -0
- package/docs/guides/core-concepts/collections/index.mdx +125 -0
- package/docs/guides/core-concepts/customers/customer.webp +0 -0
- package/docs/guides/core-concepts/customers/index.mdx +21 -0
- package/docs/guides/core-concepts/email/email-plugin-flow.webp +0 -0
- package/docs/guides/core-concepts/email/index.mdx +155 -0
- package/docs/guides/core-concepts/images-assets/asset-flow.webp +0 -0
- package/docs/guides/core-concepts/images-assets/asset-tags.webp +0 -0
- package/docs/guides/core-concepts/images-assets/index.mdx +42 -0
- package/docs/guides/core-concepts/money/index.mdx +246 -0
- package/docs/guides/core-concepts/orders/custom-order-ui.webp +0 -0
- package/docs/guides/core-concepts/orders/index.md +366 -0
- package/docs/guides/core-concepts/orders/order-process.webp +0 -0
- package/docs/guides/core-concepts/orders/order.webp +0 -0
- package/docs/guides/core-concepts/payment/index.md +410 -0
- package/docs/guides/core-concepts/payment/payment-method.webp +0 -0
- package/docs/guides/core-concepts/payment/payment_sequence_one_step.png +0 -0
- package/docs/guides/core-concepts/payment/payment_sequence_two_step.png +0 -0
- package/docs/guides/core-concepts/products/facets.webp +0 -0
- package/docs/guides/core-concepts/products/index.mdx +59 -0
- package/docs/guides/core-concepts/products/product-relations.webp +0 -0
- package/docs/guides/core-concepts/products/products-variants.webp +0 -0
- package/docs/guides/core-concepts/promotions/index.md +324 -0
- package/docs/guides/core-concepts/shipping/index.md +225 -0
- package/docs/guides/core-concepts/shipping/shipping-method.webp +0 -0
- package/docs/guides/core-concepts/stock-control/global-stock-control.webp +0 -0
- package/docs/guides/core-concepts/stock-control/index.md +233 -0
- package/docs/guides/core-concepts/stock-control/stock-levels.webp +0 -0
- package/docs/guides/core-concepts/taxes/index.mdx +76 -0
- package/docs/guides/deployment/deploy-to-digital-ocean-app-platform/01-create-space.webp +0 -0
- package/docs/guides/deployment/deploy-to-digital-ocean-app-platform/02-space-access-keys.webp +0 -0
- package/docs/guides/deployment/deploy-to-digital-ocean-app-platform/03-create-app.webp +0 -0
- package/docs/guides/deployment/deploy-to-digital-ocean-app-platform/04-configure-server.webp +0 -0
- package/docs/guides/deployment/deploy-to-digital-ocean-app-platform/05-open-server-settings.webp +0 -0
- package/docs/guides/deployment/deploy-to-digital-ocean-app-platform/06-admin-app-route.webp +0 -0
- package/docs/guides/deployment/deploy-to-digital-ocean-app-platform/07-open-app.webp +0 -0
- package/docs/guides/deployment/deploy-to-digital-ocean-app-platform/deploy-to-do-app-platform.webp +0 -0
- package/docs/guides/deployment/deploy-to-digital-ocean-app-platform/index.md +246 -0
- package/docs/guides/deployment/deploy-to-google-cloud-run/deploy-to-gcr.webp +0 -0
- package/docs/guides/deployment/deploy-to-google-cloud-run/index.md +53 -0
- package/docs/guides/deployment/deploy-to-northflank/01-create-template-screen.webp +0 -0
- package/docs/guides/deployment/deploy-to-northflank/02-paste-config.webp +0 -0
- package/docs/guides/deployment/deploy-to-northflank/03-run-template.webp +0 -0
- package/docs/guides/deployment/deploy-to-northflank/04-find-project.webp +0 -0
- package/docs/guides/deployment/deploy-to-northflank/05-server-service.webp +0 -0
- package/docs/guides/deployment/deploy-to-northflank/06-find-url.webp +0 -0
- package/docs/guides/deployment/deploy-to-northflank/deploy-to-northflank.webp +0 -0
- package/docs/guides/deployment/deploy-to-northflank/index.md +606 -0
- package/docs/guides/deployment/deploy-to-railway/01-new-service.webp +0 -0
- package/docs/guides/deployment/deploy-to-railway/02-env-vars.webp +0 -0
- package/docs/guides/deployment/deploy-to-railway/03-test-server.webp +0 -0
- package/docs/guides/deployment/deploy-to-railway/deploy-to-railway.webp +0 -0
- package/docs/guides/deployment/deploy-to-railway/index.md +202 -0
- package/docs/guides/deployment/deploy-to-render/01-create-db.webp +0 -0
- package/docs/guides/deployment/deploy-to-render/02-env-group.webp +0 -0
- package/docs/guides/deployment/deploy-to-render/03-db-connection.webp +0 -0
- package/docs/guides/deployment/deploy-to-render/04-link-env-group.webp +0 -0
- package/docs/guides/deployment/deploy-to-render/05-server-url.webp +0 -0
- package/docs/guides/deployment/deploy-to-render/deploy-to-render.webp +0 -0
- package/docs/guides/deployment/deploy-to-render/index.md +221 -0
- package/docs/guides/deployment/deploying-admin-ui.md +130 -0
- package/docs/guides/deployment/getting-data-into-production.md +50 -0
- package/docs/guides/deployment/horizontal-scaling.md +75 -0
- package/docs/guides/deployment/production-configuration/env-var-ui.webp +0 -0
- package/docs/guides/deployment/production-configuration/index.md +140 -0
- package/docs/guides/deployment/server-resource-requirements.md +29 -0
- package/docs/guides/deployment/using-docker.md +193 -0
- package/docs/guides/developer-guide/cache/cache-service.webp +0 -0
- package/docs/guides/developer-guide/cache/index.mdx +327 -0
- package/docs/guides/developer-guide/channel-aware/index.md +117 -0
- package/docs/guides/developer-guide/cli/add-command.webp +0 -0
- package/docs/guides/developer-guide/cli/index.md +418 -0
- package/docs/guides/developer-guide/cli/migrate-command.webp +0 -0
- package/docs/guides/developer-guide/cli/schema-command.webp +0 -0
- package/docs/guides/developer-guide/configuration/index.md +226 -0
- package/docs/guides/developer-guide/custom-fields/custom-fields-data-table.webp +0 -0
- package/docs/guides/developer-guide/custom-fields/custom-fields-ui.webp +0 -0
- package/docs/guides/developer-guide/custom-fields/index.md +1423 -0
- package/docs/guides/developer-guide/custom-permissions/index.md +186 -0
- package/docs/guides/developer-guide/custom-strategies-in-plugins/index.mdx +467 -0
- package/docs/guides/developer-guide/database-entity/index.md +136 -0
- package/docs/guides/developer-guide/dataloaders/index.md +137 -0
- package/docs/guides/developer-guide/db-subscribers/index.md +115 -0
- package/docs/guides/developer-guide/error-handling/index.mdx +324 -0
- package/docs/guides/developer-guide/events/index.mdx +406 -0
- package/docs/guides/developer-guide/extend-graphql-api/index.md +501 -0
- package/docs/guides/developer-guide/has-custom-fields/index.md +174 -0
- package/docs/guides/developer-guide/importing-data/index.md +488 -0
- package/docs/guides/developer-guide/importing-data/reindex.webp +0 -0
- package/docs/guides/developer-guide/logging/index.md +77 -0
- package/docs/guides/developer-guide/migrating-from-v1/breaking-api-changes.md +213 -0
- package/docs/guides/developer-guide/migrating-from-v1/database-migration.md +39 -0
- package/docs/guides/developer-guide/migrating-from-v1/index.md +41 -0
- package/docs/guides/developer-guide/migrating-from-v1/storefront-migration.md +30 -0
- package/docs/guides/developer-guide/migrations/index.md +197 -0
- package/docs/guides/developer-guide/migrations/migration.webp +0 -0
- package/docs/guides/developer-guide/nest-devtools/index.md +74 -0
- package/docs/guides/developer-guide/nest-devtools/nest-devtools-bootstrap-perf.webp +0 -0
- package/docs/guides/developer-guide/nest-devtools/nest-devtools-graph.webp +0 -0
- package/docs/guides/developer-guide/overview/Vendure_docs-architecture.webp +0 -0
- package/docs/guides/developer-guide/overview/index.md +40 -0
- package/docs/guides/developer-guide/plugins/index.mdx +806 -0
- package/docs/guides/developer-guide/rest-endpoint/index.md +99 -0
- package/docs/guides/developer-guide/scheduled-tasks/index.md +298 -0
- package/docs/guides/developer-guide/security/index.md +264 -0
- package/docs/guides/developer-guide/settings-store/index.mdx +553 -0
- package/docs/guides/developer-guide/stand-alone-scripts/index.md +119 -0
- package/docs/guides/developer-guide/strategies-configurable-operations/collection-filters-args.webp +0 -0
- package/docs/guides/developer-guide/strategies-configurable-operations/collection-filters.webp +0 -0
- package/docs/guides/developer-guide/strategies-configurable-operations/index.mdx +373 -0
- package/docs/guides/developer-guide/testing/index.md +254 -0
- package/docs/guides/developer-guide/the-api-layer/Vendure_docs-api_request.webp +0 -0
- package/docs/guides/developer-guide/the-api-layer/index.mdx +474 -0
- package/docs/guides/developer-guide/the-service-layer/index.mdx +311 -0
- package/docs/guides/developer-guide/translatable/index.md +224 -0
- package/docs/guides/developer-guide/translations/index.md +165 -0
- package/docs/guides/developer-guide/updating/index.md +79 -0
- package/docs/guides/developer-guide/uploading-files/index.md +220 -0
- package/docs/guides/developer-guide/worker-job-queue/Vendure_docs-job-queue-2.webp +0 -0
- package/docs/guides/developer-guide/worker-job-queue/Vendure_docs-job-queue-3.webp +0 -0
- package/docs/guides/developer-guide/worker-job-queue/Vendure_docs-job-queue.webp +0 -0
- package/docs/guides/developer-guide/worker-job-queue/index.mdx +522 -0
- package/docs/guides/developer-guide/worker-job-queue/worker-job-queue.webp +0 -0
- package/docs/guides/extending-the-admin-ui/add-actions-to-pages/index.md +233 -0
- package/docs/guides/extending-the-admin-ui/add-actions-to-pages/ui-extensions-actionbar-dropdown.webp +0 -0
- package/docs/guides/extending-the-admin-ui/add-actions-to-pages/ui-extensions-actionbar.webp +0 -0
- package/docs/guides/extending-the-admin-ui/adding-ui-translations/index.md +113 -0
- package/docs/guides/extending-the-admin-ui/adding-ui-translations/ui-translations-01.webp +0 -0
- package/docs/guides/extending-the-admin-ui/admin-ui-theming-branding/index.md +133 -0
- package/docs/guides/extending-the-admin-ui/alerts/alerts-01.webp +0 -0
- package/docs/guides/extending-the-admin-ui/alerts/index.md +56 -0
- package/docs/guides/extending-the-admin-ui/bulk-actions/bulk-actions-screenshot.webp +0 -0
- package/docs/guides/extending-the-admin-ui/bulk-actions/index.md +78 -0
- package/docs/guides/extending-the-admin-ui/creating-detail-views/index.md +332 -0
- package/docs/guides/extending-the-admin-ui/creating-list-views/index.md +331 -0
- package/docs/guides/extending-the-admin-ui/custom-data-table-components/custom-data-table-location.webp +0 -0
- package/docs/guides/extending-the-admin-ui/custom-data-table-components/custom-data-table.webp +0 -0
- package/docs/guides/extending-the-admin-ui/custom-data-table-components/index.md +111 -0
- package/docs/guides/extending-the-admin-ui/custom-detail-components/detail-component.webp +0 -0
- package/docs/guides/extending-the-admin-ui/custom-detail-components/index.md +198 -0
- package/docs/guides/extending-the-admin-ui/custom-form-inputs/index.md +285 -0
- package/docs/guides/extending-the-admin-ui/custom-form-inputs/ui-extensions-custom-field-default.webp +0 -0
- package/docs/guides/extending-the-admin-ui/custom-form-inputs/ui-extensions-custom-field-slider.webp +0 -0
- package/docs/guides/extending-the-admin-ui/custom-timeline-components/index.md +79 -0
- package/docs/guides/extending-the-admin-ui/custom-timeline-components/timeline-entry.webp +0 -0
- package/docs/guides/extending-the-admin-ui/dashboard-widgets/dashboard-widgets.webp +0 -0
- package/docs/guides/extending-the-admin-ui/dashboard-widgets/index.md +149 -0
- package/docs/guides/extending-the-admin-ui/defining-routes/index.md +777 -0
- package/docs/guides/extending-the-admin-ui/defining-routes/route-area.webp +0 -0
- package/docs/guides/extending-the-admin-ui/defining-routes/ui-extensions-greeter.webp +0 -0
- package/docs/guides/extending-the-admin-ui/getting-started/index.md +656 -0
- package/docs/guides/extending-the-admin-ui/getting-started/provider-extension-points.webp +0 -0
- package/docs/guides/extending-the-admin-ui/nav-menu/index.md +97 -0
- package/docs/guides/extending-the-admin-ui/nav-menu/nav-menu-id.webp +0 -0
- package/docs/guides/extending-the-admin-ui/nav-menu/ui-extensions-navbar.webp +0 -0
- package/docs/guides/extending-the-admin-ui/page-tabs/index.md +44 -0
- package/docs/guides/extending-the-admin-ui/page-tabs/ui-extensions-tabs.webp +0 -0
- package/docs/guides/extending-the-admin-ui/ui-library/buttons.webp +0 -0
- package/docs/guides/extending-the-admin-ui/ui-library/card.webp +0 -0
- package/docs/guides/extending-the-admin-ui/ui-library/form-inputs.webp +0 -0
- package/docs/guides/extending-the-admin-ui/ui-library/icons.webp +0 -0
- package/docs/guides/extending-the-admin-ui/ui-library/index.md +356 -0
- package/docs/guides/extending-the-admin-ui/ui-library/layout.webp +0 -0
- package/docs/guides/extending-the-admin-ui/using-other-frameworks/index.md +205 -0
- package/docs/guides/extending-the-admin-ui/using-other-frameworks/ui-extensions-cra.jpg +0 -0
- package/docs/guides/extending-the-dashboard/alerts/alert.webp +0 -0
- package/docs/guides/extending-the-dashboard/alerts/index.md +89 -0
- package/docs/guides/extending-the-dashboard/creating-pages/detail-pages.md +316 -0
- package/docs/guides/extending-the-dashboard/creating-pages/index.md +90 -0
- package/docs/guides/extending-the-dashboard/creating-pages/list-pages.md +206 -0
- package/docs/guides/extending-the-dashboard/creating-pages/tabbed-page-example.webp +0 -0
- package/docs/guides/extending-the-dashboard/creating-pages/tabbed-pages.md +144 -0
- package/docs/guides/extending-the-dashboard/custom-form-components/color-picker.webp +0 -0
- package/docs/guides/extending-the-dashboard/custom-form-components/dev-mode.webp +0 -0
- package/docs/guides/extending-the-dashboard/custom-form-components/example-currency-input.webp +0 -0
- package/docs/guides/extending-the-dashboard/custom-form-components/example-email-input.webp +0 -0
- package/docs/guides/extending-the-dashboard/custom-form-components/example-slug-input.webp +0 -0
- package/docs/guides/extending-the-dashboard/custom-form-components/example-tags-input.webp +0 -0
- package/docs/guides/extending-the-dashboard/custom-form-components/form-component-examples.mdx +445 -0
- package/docs/guides/extending-the-dashboard/custom-form-components/index.md +465 -0
- package/docs/guides/extending-the-dashboard/custom-form-components/locator.webp +0 -0
- package/docs/guides/extending-the-dashboard/custom-form-components/relation-selectors.md +687 -0
- package/docs/guides/extending-the-dashboard/customizing-pages/action-bar-button.webp +0 -0
- package/docs/guides/extending-the-dashboard/customizing-pages/action-bar-dropdown.webp +0 -0
- package/docs/guides/extending-the-dashboard/customizing-pages/action-bar-items.md +272 -0
- package/docs/guides/extending-the-dashboard/customizing-pages/custom-widget.webp +0 -0
- package/docs/guides/extending-the-dashboard/customizing-pages/customizing-detail-pages.md +129 -0
- package/docs/guides/extending-the-dashboard/customizing-pages/customizing-list-pages.md +93 -0
- package/docs/guides/extending-the-dashboard/customizing-pages/customizing-login-page.md +66 -0
- package/docs/guides/extending-the-dashboard/customizing-pages/history-entries.md +43 -0
- package/docs/guides/extending-the-dashboard/customizing-pages/history-entry.webp +0 -0
- package/docs/guides/extending-the-dashboard/customizing-pages/index.md +10 -0
- package/docs/guides/extending-the-dashboard/customizing-pages/insights-widgets.md +57 -0
- package/docs/guides/extending-the-dashboard/customizing-pages/login-page.webp +0 -0
- package/docs/guides/extending-the-dashboard/customizing-pages/page-blocks.md +244 -0
- package/docs/guides/extending-the-dashboard/data-fetching/index.md +126 -0
- package/docs/guides/extending-the-dashboard/data-fetching/type-inference.webp +0 -0
- package/docs/guides/extending-the-dashboard/deployment/index.md +200 -0
- package/docs/guides/extending-the-dashboard/extending-overview/dev-mode.webp +0 -0
- package/docs/guides/extending-the-dashboard/extending-overview/index.md +228 -0
- package/docs/guides/extending-the-dashboard/extending-overview/location-id.webp +0 -0
- package/docs/guides/extending-the-dashboard/getting-started/detail-view.webp +0 -0
- package/docs/guides/extending-the-dashboard/getting-started/index.md +194 -0
- package/docs/guides/extending-the-dashboard/getting-started/list-view-empty.webp +0 -0
- package/docs/guides/extending-the-dashboard/getting-started/list-view-full.webp +0 -0
- package/docs/guides/extending-the-dashboard/getting-started/page-block.webp +0 -0
- package/docs/guides/extending-the-dashboard/getting-started/test-page.webp +0 -0
- package/docs/guides/extending-the-dashboard/localization/index.md +94 -0
- package/docs/guides/extending-the-dashboard/migration/index.md +1902 -0
- package/docs/guides/extending-the-dashboard/navigation/dev-mode-nav.webp +0 -0
- package/docs/guides/extending-the-dashboard/navigation/index.md +322 -0
- package/docs/guides/extending-the-dashboard/navigation/unauthenticated-page.webp +0 -0
- package/docs/guides/extending-the-dashboard/tech-stack/index.md +395 -0
- package/docs/guides/extending-the-dashboard/theming/index.md +180 -0
- package/docs/guides/extending-the-dashboard/theming/show-colour-value-inspection.gif +0 -0
- package/docs/guides/getting-started/graphql-intro/index.mdx +572 -0
- package/docs/guides/getting-started/installation/app-screens.webp +0 -0
- package/docs/guides/getting-started/installation/index.md +234 -0
- package/docs/guides/getting-started/try-the-api/graphiql-docs.jpeg +0 -0
- package/docs/guides/getting-started/try-the-api/graphiql.jpeg +0 -0
- package/docs/guides/getting-started/try-the-api/index.mdx +238 -0
- package/docs/guides/how-to/cms-integration-plugin/index.mdx +2083 -0
- package/docs/guides/how-to/codegen/index.md +280 -0
- package/docs/guides/how-to/configurable-products/index.md +138 -0
- package/docs/guides/how-to/digital-products/index.mdx +485 -0
- package/docs/guides/how-to/digital-products/product-variant.webp +0 -0
- package/docs/guides/how-to/digital-products/shipping-method.webp +0 -0
- package/docs/guides/how-to/github-oauth-authentication/index.mdx +360 -0
- package/docs/guides/how-to/google-oauth-authentication/index.mdx +494 -0
- package/docs/guides/how-to/multi-vendor-marketplaces/aggregate-order.webp +0 -0
- package/docs/guides/how-to/multi-vendor-marketplaces/index.md +197 -0
- package/docs/guides/how-to/paginated-list/index.mdx +360 -0
- package/docs/guides/how-to/publish-plugin/index.mdx +402 -0
- package/docs/guides/how-to/s3-asset-storage/index.mdx +572 -0
- package/docs/guides/how-to/telemetry/grafana-logs.webp +0 -0
- package/docs/guides/how-to/telemetry/grafana-trace.webp +0 -0
- package/docs/guides/how-to/telemetry/index.md +260 -0
- package/docs/guides/how-to/telemetry/jaeger-trace.webp +0 -0
- package/docs/guides/storefront/active-order/index.mdx +201 -0
- package/docs/guides/storefront/checkout-flow/index.mdx +428 -0
- package/docs/guides/storefront/codegen/index.mdx +157 -0
- package/docs/guides/storefront/connect-api/index.mdx +677 -0
- package/docs/guides/storefront/customer-accounts/index.mdx +389 -0
- package/docs/guides/storefront/customer-accounts/pw-reset.webp +0 -0
- package/docs/guides/storefront/customer-accounts/verification.webp +0 -0
- package/docs/guides/storefront/listing-products/index.mdx +711 -0
- package/docs/guides/storefront/navigation-menu/index.mdx +157 -0
- package/docs/guides/storefront/order-workflow/index.md +231 -0
- package/docs/guides/storefront/order-workflow/order_class_diagram.png +0 -0
- package/docs/guides/storefront/order-workflow/order_state_diagram.png +0 -0
- package/docs/guides/storefront/product-detail/index.mdx +295 -0
- package/docs/guides/storefront/storefront-starters/angular-storefront.webp +0 -0
- package/docs/guides/storefront/storefront-starters/index.mdx +69 -0
- package/docs/guides/storefront/storefront-starters/next-storefront.webp +0 -0
- package/docs/guides/storefront/storefront-starters/qwik-storefront.webp +0 -0
- package/docs/guides/storefront/storefront-starters/remix-storefront.webp +0 -0
- package/docs/reference/admin-ui-api/action-bar/action-bar-context.md +82 -0
- package/docs/reference/admin-ui-api/action-bar/action-bar-dropdown-menu-item.md +93 -0
- package/docs/reference/admin-ui-api/action-bar/action-bar-item.md +106 -0
- package/docs/reference/admin-ui-api/action-bar/action-bar-location-id.md +17 -0
- package/docs/reference/admin-ui-api/action-bar/add-action-bar-dropdown-menu-item.md +38 -0
- package/docs/reference/admin-ui-api/action-bar/add-action-bar-item.md +36 -0
- package/docs/reference/admin-ui-api/action-bar/index.md +5 -0
- package/docs/reference/admin-ui-api/action-bar/page-location-id.md +61 -0
- package/docs/reference/admin-ui-api/action-bar/router-link-definition.md +16 -0
- package/docs/reference/admin-ui-api/alerts/alert-config.md +88 -0
- package/docs/reference/admin-ui-api/alerts/alert-context.md +52 -0
- package/docs/reference/admin-ui-api/alerts/index.md +5 -0
- package/docs/reference/admin-ui-api/alerts/register-alert.md +23 -0
- package/docs/reference/admin-ui-api/bulk-actions/bulk-action.md +229 -0
- package/docs/reference/admin-ui-api/bulk-actions/index.md +5 -0
- package/docs/reference/admin-ui-api/bulk-actions/register-bulk-action.md +63 -0
- package/docs/reference/admin-ui-api/components/asset-picker-dialog-component.md +160 -0
- package/docs/reference/admin-ui-api/components/chip-component.md +63 -0
- package/docs/reference/admin-ui-api/components/currency-input-component.md +174 -0
- package/docs/reference/admin-ui-api/components/data-table-component.md +238 -0
- package/docs/reference/admin-ui-api/components/data-table2component.md +354 -0
- package/docs/reference/admin-ui-api/components/datetime-picker-component.md +262 -0
- package/docs/reference/admin-ui-api/components/dropdown-component.md +86 -0
- package/docs/reference/admin-ui-api/components/facet-value-selector-component.md +155 -0
- package/docs/reference/admin-ui-api/components/index.md +5 -0
- package/docs/reference/admin-ui-api/components/object-tree-component.md +86 -0
- package/docs/reference/admin-ui-api/components/order-state-label-component.md +41 -0
- package/docs/reference/admin-ui-api/components/product-variant-selector-component.md +75 -0
- package/docs/reference/admin-ui-api/components/rich-text-editor-component.md +108 -0
- package/docs/reference/admin-ui-api/components/zone-selector-component.md +124 -0
- package/docs/reference/admin-ui-api/custom-detail-components/custom-detail-component-config.md +41 -0
- package/docs/reference/admin-ui-api/custom-detail-components/custom-detail-component-location-id.md +36 -0
- package/docs/reference/admin-ui-api/custom-detail-components/custom-detail-component.md +36 -0
- package/docs/reference/admin-ui-api/custom-detail-components/index.md +5 -0
- package/docs/reference/admin-ui-api/custom-detail-components/register-custom-detail-component.md +69 -0
- package/docs/reference/admin-ui-api/custom-history-entry-components/customer-history-entry-component.md +32 -0
- package/docs/reference/admin-ui-api/custom-history-entry-components/history-entry-component.md +57 -0
- package/docs/reference/admin-ui-api/custom-history-entry-components/history-entry-config.md +35 -0
- package/docs/reference/admin-ui-api/custom-history-entry-components/index.md +5 -0
- package/docs/reference/admin-ui-api/custom-history-entry-components/order-history-entry-component.md +32 -0
- package/docs/reference/admin-ui-api/custom-history-entry-components/register-history-entry-component.md +79 -0
- package/docs/reference/admin-ui-api/custom-input-components/default-inputs.md +1034 -0
- package/docs/reference/admin-ui-api/custom-input-components/form-input-component.md +56 -0
- package/docs/reference/admin-ui-api/custom-input-components/index.md +5 -0
- package/docs/reference/admin-ui-api/custom-input-components/register-form-input-component.md +71 -0
- package/docs/reference/admin-ui-api/custom-table-components/custom-column-component.md +32 -0
- package/docs/reference/admin-ui-api/custom-table-components/data-table-component-config.md +48 -0
- package/docs/reference/admin-ui-api/custom-table-components/index.md +5 -0
- package/docs/reference/admin-ui-api/custom-table-components/register-data-table-component.md +55 -0
- package/docs/reference/admin-ui-api/dashboard-widgets/dashboard-widget-config.md +60 -0
- package/docs/reference/admin-ui-api/dashboard-widgets/index.md +5 -0
- package/docs/reference/admin-ui-api/dashboard-widgets/register-dashboard-widget.md +27 -0
- package/docs/reference/admin-ui-api/dashboard-widgets/set-dashboard-widget-layout.md +22 -0
- package/docs/reference/admin-ui-api/dashboard-widgets/widget-layout-definition.md +16 -0
- package/docs/reference/admin-ui-api/directives/if-multichannel-directive.md +41 -0
- package/docs/reference/admin-ui-api/directives/if-permissions-directive.md +43 -0
- package/docs/reference/admin-ui-api/directives/index.md +5 -0
- package/docs/reference/admin-ui-api/index.md +13 -0
- package/docs/reference/admin-ui-api/list-detail-views/base-detail-component.md +168 -0
- package/docs/reference/admin-ui-api/list-detail-views/base-entity-resolver.md +54 -0
- package/docs/reference/admin-ui-api/list-detail-views/base-list-component.md +155 -0
- package/docs/reference/admin-ui-api/list-detail-views/detail-component-with-resolver.md +52 -0
- package/docs/reference/admin-ui-api/list-detail-views/index.md +5 -0
- package/docs/reference/admin-ui-api/list-detail-views/typed-base-detail-component.md +51 -0
- package/docs/reference/admin-ui-api/list-detail-views/typed-base-list-component.md +125 -0
- package/docs/reference/admin-ui-api/nav-menu/add-nav-menu-item.md +52 -0
- package/docs/reference/admin-ui-api/nav-menu/add-nav-menu-section.md +47 -0
- package/docs/reference/admin-ui-api/nav-menu/index.md +5 -0
- package/docs/reference/admin-ui-api/nav-menu/nav-menu-item.md +66 -0
- package/docs/reference/admin-ui-api/nav-menu/nav-menu-section.md +83 -0
- package/docs/reference/admin-ui-api/nav-menu/navigation-types.md +38 -0
- package/docs/reference/admin-ui-api/pipes/asset-preview-pipe.md +41 -0
- package/docs/reference/admin-ui-api/pipes/duration-pipe.md +45 -0
- package/docs/reference/admin-ui-api/pipes/file-size-pipe.md +38 -0
- package/docs/reference/admin-ui-api/pipes/has-permission-pipe.md +51 -0
- package/docs/reference/admin-ui-api/pipes/index.md +5 -0
- package/docs/reference/admin-ui-api/pipes/locale-currency-name-pipe.md +47 -0
- package/docs/reference/admin-ui-api/pipes/locale-currency-pipe.md +54 -0
- package/docs/reference/admin-ui-api/pipes/locale-date-pipe.md +48 -0
- package/docs/reference/admin-ui-api/pipes/locale-language-name-pipe.md +47 -0
- package/docs/reference/admin-ui-api/pipes/locale-region-name-pipe.md +47 -0
- package/docs/reference/admin-ui-api/pipes/time-ago-pipe.md +44 -0
- package/docs/reference/admin-ui-api/react-components/action-bar.md +36 -0
- package/docs/reference/admin-ui-api/react-components/card.md +36 -0
- package/docs/reference/admin-ui-api/react-components/cds-icon.md +34 -0
- package/docs/reference/admin-ui-api/react-components/form-field.md +42 -0
- package/docs/reference/admin-ui-api/react-components/index.md +5 -0
- package/docs/reference/admin-ui-api/react-components/link.md +34 -0
- package/docs/reference/admin-ui-api/react-components/page-block.md +36 -0
- package/docs/reference/admin-ui-api/react-components/page-detail-layout.md +36 -0
- package/docs/reference/admin-ui-api/react-components/rich-text-editor.md +42 -0
- package/docs/reference/admin-ui-api/react-extensions/index.md +5 -0
- package/docs/reference/admin-ui-api/react-extensions/react-custom-detail-component-config.md +41 -0
- package/docs/reference/admin-ui-api/react-extensions/react-data-table-component-config.md +48 -0
- package/docs/reference/admin-ui-api/react-extensions/register-react-custom-detail-component.md +23 -0
- package/docs/reference/admin-ui-api/react-extensions/register-react-data-table-component.md +55 -0
- package/docs/reference/admin-ui-api/react-extensions/register-react-form-input-component.md +26 -0
- package/docs/reference/admin-ui-api/react-extensions/register-react-route-component-options.md +18 -0
- package/docs/reference/admin-ui-api/react-extensions/register-react-route-component.md +22 -0
- package/docs/reference/admin-ui-api/react-hooks/index.md +5 -0
- package/docs/reference/admin-ui-api/react-hooks/use-detail-component-data.md +39 -0
- package/docs/reference/admin-ui-api/react-hooks/use-form-control.md +36 -0
- package/docs/reference/admin-ui-api/react-hooks/use-injector.md +39 -0
- package/docs/reference/admin-ui-api/react-hooks/use-lazy-query.md +74 -0
- package/docs/reference/admin-ui-api/react-hooks/use-mutation.md +62 -0
- package/docs/reference/admin-ui-api/react-hooks/use-page-metadata.md +36 -0
- package/docs/reference/admin-ui-api/react-hooks/use-query.md +59 -0
- package/docs/reference/admin-ui-api/react-hooks/use-rich-text-editor.md +30 -0
- package/docs/reference/admin-ui-api/react-hooks/use-route-params.md +29 -0
- package/docs/reference/admin-ui-api/routes/index.md +5 -0
- package/docs/reference/admin-ui-api/routes/register-route-component-options.md +28 -0
- package/docs/reference/admin-ui-api/routes/register-route-component.md +57 -0
- package/docs/reference/admin-ui-api/services/data-service.md +142 -0
- package/docs/reference/admin-ui-api/services/index.md +5 -0
- package/docs/reference/admin-ui-api/services/modal-service.md +199 -0
- package/docs/reference/admin-ui-api/services/notification-service.md +126 -0
- package/docs/reference/admin-ui-api/tabs/index.md +5 -0
- package/docs/reference/admin-ui-api/tabs/page-tab-config.md +70 -0
- package/docs/reference/admin-ui-api/tabs/register-page-tab.md +38 -0
- package/docs/reference/admin-ui-api/ui-devkit/admin-ui-extension.md +417 -0
- package/docs/reference/admin-ui-api/ui-devkit/compile-ui-extensions.md +22 -0
- package/docs/reference/admin-ui-api/ui-devkit/helpers.md +39 -0
- package/docs/reference/admin-ui-api/ui-devkit/index.md +5 -0
- package/docs/reference/admin-ui-api/ui-devkit/ui-devkit-client.md +160 -0
- package/docs/reference/admin-ui-api/ui-devkit/ui-extension-build-command.md +16 -0
- package/docs/reference/admin-ui-api/ui-devkit/ui-extension-compiler-options.md +118 -0
- package/docs/reference/admin-ui-api/ui-devkit/ui-extension-compiler-process-argument.md +16 -0
- package/docs/reference/core-plugins/admin-ui-plugin/admin-ui-plugin-options.md +67 -0
- package/docs/reference/core-plugins/admin-ui-plugin/index.md +94 -0
- package/docs/reference/core-plugins/asset-server-plugin/asset-server-options.md +106 -0
- package/docs/reference/core-plugins/asset-server-plugin/cache-config.md +36 -0
- package/docs/reference/core-plugins/asset-server-plugin/hashed-asset-naming-strategy.md +47 -0
- package/docs/reference/core-plugins/asset-server-plugin/image-transform-mode.md +21 -0
- package/docs/reference/core-plugins/asset-server-plugin/image-transform-preset.md +57 -0
- package/docs/reference/core-plugins/asset-server-plugin/image-transform-strategy.md +144 -0
- package/docs/reference/core-plugins/asset-server-plugin/index.md +189 -0
- package/docs/reference/core-plugins/asset-server-plugin/local-asset-storage-strategy.md +74 -0
- package/docs/reference/core-plugins/asset-server-plugin/preset-only-strategy.md +118 -0
- package/docs/reference/core-plugins/asset-server-plugin/s3asset-storage-strategy.md +225 -0
- package/docs/reference/core-plugins/asset-server-plugin/sharp-asset-preview-strategy.md +118 -0
- package/docs/reference/core-plugins/dashboard-plugin/dashboard-plugin-options.md +43 -0
- package/docs/reference/core-plugins/dashboard-plugin/index.md +106 -0
- package/docs/reference/core-plugins/elasticsearch-plugin/elasticsearch-options.md +695 -0
- package/docs/reference/core-plugins/elasticsearch-plugin/index.md +193 -0
- package/docs/reference/core-plugins/email-plugin/email-event-handler-with-async-data.md +33 -0
- package/docs/reference/core-plugins/email-plugin/email-event-handler.md +299 -0
- package/docs/reference/core-plugins/email-plugin/email-event-listener.md +42 -0
- package/docs/reference/core-plugins/email-plugin/email-generator.md +78 -0
- package/docs/reference/core-plugins/email-plugin/email-plugin-options.md +154 -0
- package/docs/reference/core-plugins/email-plugin/email-plugin-types.md +276 -0
- package/docs/reference/core-plugins/email-plugin/email-send-event.md +34 -0
- package/docs/reference/core-plugins/email-plugin/email-sender.md +92 -0
- package/docs/reference/core-plugins/email-plugin/email-utils.md +54 -0
- package/docs/reference/core-plugins/email-plugin/index.md +309 -0
- package/docs/reference/core-plugins/email-plugin/template-loader.md +96 -0
- package/docs/reference/core-plugins/email-plugin/transport-options.md +241 -0
- package/docs/reference/core-plugins/graphiql-plugin/index.md +89 -0
- package/docs/reference/core-plugins/harden-plugin/default-vendure-complexity-estimator.md +30 -0
- package/docs/reference/core-plugins/harden-plugin/harden-plugin-options.md +106 -0
- package/docs/reference/core-plugins/harden-plugin/index.md +169 -0
- package/docs/reference/core-plugins/index.md +5 -0
- package/docs/reference/core-plugins/job-queue-plugin/bull-mqjob-queue-plugin.md +211 -0
- package/docs/reference/core-plugins/job-queue-plugin/bull-mqjob-queue-strategy.md +93 -0
- package/docs/reference/core-plugins/job-queue-plugin/bull-mqplugin-options.md +142 -0
- package/docs/reference/core-plugins/job-queue-plugin/index.md +5 -0
- package/docs/reference/core-plugins/job-queue-plugin/pub-sub-job-queue-strategy.md +65 -0
- package/docs/reference/core-plugins/job-queue-plugin/pub-sub-plugin.md +36 -0
- package/docs/reference/core-plugins/payments-plugin/braintree-plugin.md +350 -0
- package/docs/reference/core-plugins/payments-plugin/index.md +5 -0
- package/docs/reference/core-plugins/payments-plugin/mollie-plugin.md +209 -0
- package/docs/reference/core-plugins/payments-plugin/stripe-plugin.md +355 -0
- package/docs/reference/core-plugins/sentry-plugin/index.md +158 -0
- package/docs/reference/core-plugins/sentry-plugin/sentry-plugin-options.md +32 -0
- package/docs/reference/core-plugins/sentry-plugin/sentry-service.md +47 -0
- package/docs/reference/core-plugins/stellate-plugin/index.md +277 -0
- package/docs/reference/core-plugins/stellate-plugin/purge-rule.md +91 -0
- package/docs/reference/core-plugins/stellate-plugin/stellate-plugin-options.md +65 -0
- package/docs/reference/core-plugins/stellate-plugin/stellate-service.md +71 -0
- package/docs/reference/core-plugins/telemetry-plugin/get-sdk-configuration.md +92 -0
- package/docs/reference/core-plugins/telemetry-plugin/index.md +131 -0
- package/docs/reference/core-plugins/telemetry-plugin/otel-logger.md +102 -0
- package/docs/reference/core-plugins/telemetry-plugin/register-method-hooks.md +46 -0
- package/docs/reference/core-plugins/telemetry-plugin/telemetry-plugin-options.md +77 -0
- package/docs/reference/dashboard/components/asset-gallery.md +127 -0
- package/docs/reference/dashboard/components/asset-picker-dialog.md +76 -0
- package/docs/reference/dashboard/components/channel-chip.md +22 -0
- package/docs/reference/dashboard/components/detail-page-button.md +49 -0
- package/docs/reference/dashboard/components/facet-value-chip.md +22 -0
- package/docs/reference/dashboard/components/facet-value-selector.md +85 -0
- package/docs/reference/dashboard/components/index.md +5 -0
- package/docs/reference/dashboard/components/permission-guard.md +63 -0
- package/docs/reference/dashboard/components/vendure-image.md +199 -0
- package/docs/reference/dashboard/detail-views/detail-page.md +91 -0
- package/docs/reference/dashboard/detail-views/index.md +5 -0
- package/docs/reference/dashboard/detail-views/use-detail-page.md +234 -0
- package/docs/reference/dashboard/detail-views/use-generated-form.md +105 -0
- package/docs/reference/dashboard/extensions-api/action-bar.md +66 -0
- package/docs/reference/dashboard/extensions-api/alerts.md +78 -0
- package/docs/reference/dashboard/extensions-api/data-tables.md +55 -0
- package/docs/reference/dashboard/extensions-api/define-dashboard-extension.md +142 -0
- package/docs/reference/dashboard/extensions-api/detail-forms.md +81 -0
- package/docs/reference/dashboard/extensions-api/form-components.md +188 -0
- package/docs/reference/dashboard/extensions-api/history-entries.md +246 -0
- package/docs/reference/dashboard/extensions-api/index.md +5 -0
- package/docs/reference/dashboard/extensions-api/login.md +113 -0
- package/docs/reference/dashboard/extensions-api/navigation.md +128 -0
- package/docs/reference/dashboard/extensions-api/page-blocks.md +143 -0
- package/docs/reference/dashboard/extensions-api/routes.md +69 -0
- package/docs/reference/dashboard/extensions-api/widgets.md +61 -0
- package/docs/reference/dashboard/form-components/affixed-input.md +34 -0
- package/docs/reference/dashboard/form-components/boolean-input.md +22 -0
- package/docs/reference/dashboard/form-components/checkbox-input.md +22 -0
- package/docs/reference/dashboard/form-components/date-time-input.md +22 -0
- package/docs/reference/dashboard/form-components/form-field-wrapper.md +80 -0
- package/docs/reference/dashboard/form-components/index.md +5 -0
- package/docs/reference/dashboard/form-components/money-input.md +23 -0
- package/docs/reference/dashboard/form-components/number-input.md +22 -0
- package/docs/reference/dashboard/form-components/password-input.md +22 -0
- package/docs/reference/dashboard/form-components/rich-text-input.md +22 -0
- package/docs/reference/dashboard/form-components/slug-input.md +57 -0
- package/docs/reference/dashboard/form-components/text-input.md +13 -0
- package/docs/reference/dashboard/form-components/textarea-input.md +22 -0
- package/docs/reference/dashboard/form-components/translatable-form-field-wrapper.md +70 -0
- package/docs/reference/dashboard/hooks/index.md +5 -0
- package/docs/reference/dashboard/hooks/use-alerts.md +65 -0
- package/docs/reference/dashboard/hooks/use-auth.md +84 -0
- package/docs/reference/dashboard/hooks/use-channel.md +72 -0
- package/docs/reference/dashboard/hooks/use-custom-field-config.md +24 -0
- package/docs/reference/dashboard/hooks/use-display-locale.md +32 -0
- package/docs/reference/dashboard/hooks/use-drag-and-drop.md +22 -0
- package/docs/reference/dashboard/hooks/use-local-format.md +30 -0
- package/docs/reference/dashboard/hooks/use-paginated-list.md +29 -0
- package/docs/reference/dashboard/hooks/use-permissions.md +25 -0
- package/docs/reference/dashboard/hooks/use-sorted-languages.md +30 -0
- package/docs/reference/dashboard/hooks/use-ui-language-loader.md +18 -0
- package/docs/reference/dashboard/hooks/use-widget-filters.md +16 -0
- package/docs/reference/dashboard/list-views/bulk-actions.md +199 -0
- package/docs/reference/dashboard/list-views/data-table-cell-component.md +45 -0
- package/docs/reference/dashboard/list-views/data-table.md +209 -0
- package/docs/reference/dashboard/list-views/index.md +5 -0
- package/docs/reference/dashboard/list-views/list-page.md +493 -0
- package/docs/reference/dashboard/list-views/paginated-list-data-table.md +303 -0
- package/docs/reference/dashboard/page-layout/index.md +54 -0
- package/docs/reference/dashboard/page-layout/page-action-bar.md +62 -0
- package/docs/reference/dashboard/page-layout/page-block.md +137 -0
- package/docs/reference/dashboard/page-layout/page-title.md +22 -0
- package/docs/reference/dashboard/page-layout/page.md +100 -0
- package/docs/reference/dashboard/page-layout/use-page-block.md +32 -0
- package/docs/reference/dashboard/vite-plugin/index.md +5 -0
- package/docs/reference/dashboard/vite-plugin/vendure-dashboard-plugin.md +356 -0
- package/docs/reference/graphql-api/_index.md +16 -0
- package/docs/reference/graphql-api/admin/_index.md +13 -0
- package/docs/reference/graphql-api/admin/enums.md +1142 -0
- package/docs/reference/graphql-api/admin/input-types.md +4631 -0
- package/docs/reference/graphql-api/admin/mutations.md +1985 -0
- package/docs/reference/graphql-api/admin/object-types.md +4515 -0
- package/docs/reference/graphql-api/admin/queries.md +760 -0
- package/docs/reference/graphql-api/shop/_index.md +13 -0
- package/docs/reference/graphql-api/shop/enums.md +1072 -0
- package/docs/reference/graphql-api/shop/input-types.md +1192 -0
- package/docs/reference/graphql-api/shop/mutations.md +431 -0
- package/docs/reference/graphql-api/shop/object-types.md +3406 -0
- package/docs/reference/graphql-api/shop/queries.md +247 -0
- package/docs/reference/index.mdx +38 -0
- package/docs/reference/links.webp +0 -0
- package/docs/reference/typescript-api/_index.md +13 -0
- package/docs/reference/typescript-api/assets/asset-naming-strategy.md +56 -0
- package/docs/reference/typescript-api/assets/asset-options.md +58 -0
- package/docs/reference/typescript-api/assets/asset-preview-strategy.md +45 -0
- package/docs/reference/typescript-api/assets/asset-storage-strategy.md +84 -0
- package/docs/reference/typescript-api/assets/default-asset-naming-strategy.md +39 -0
- package/docs/reference/typescript-api/assets/index.md +5 -0
- package/docs/reference/typescript-api/auth/auth-options.md +165 -0
- package/docs/reference/typescript-api/auth/authentication-strategy.md +97 -0
- package/docs/reference/typescript-api/auth/bcrypt-password-hashing-strategy.md +38 -0
- package/docs/reference/typescript-api/auth/cookie-options.md +108 -0
- package/docs/reference/typescript-api/auth/default-password-validation-strategy.md +44 -0
- package/docs/reference/typescript-api/auth/default-session-cache-strategy.md +73 -0
- package/docs/reference/typescript-api/auth/default-verification-token-strategy.md +47 -0
- package/docs/reference/typescript-api/auth/external-authentication-service.md +98 -0
- package/docs/reference/typescript-api/auth/in-memory-session-cache-strategy.md +63 -0
- package/docs/reference/typescript-api/auth/index.md +5 -0
- package/docs/reference/typescript-api/auth/native-authentication-strategy.md +58 -0
- package/docs/reference/typescript-api/auth/noop-session-cache-strategy.md +51 -0
- package/docs/reference/typescript-api/auth/password-hashing-strategy.md +45 -0
- package/docs/reference/typescript-api/auth/password-validation-strategy.md +43 -0
- package/docs/reference/typescript-api/auth/permission-definition.md +269 -0
- package/docs/reference/typescript-api/auth/session-cache-strategy.md +275 -0
- package/docs/reference/typescript-api/auth/superadmin-credentials.md +36 -0
- package/docs/reference/typescript-api/auth/verification-token-strategy.md +45 -0
- package/docs/reference/typescript-api/cache/cache-config.md +44 -0
- package/docs/reference/typescript-api/cache/cache-service.md +76 -0
- package/docs/reference/typescript-api/cache/cache-strategy.md +103 -0
- package/docs/reference/typescript-api/cache/default-cache-plugin.md +73 -0
- package/docs/reference/typescript-api/cache/index.md +79 -0
- package/docs/reference/typescript-api/cache/redis-cache-plugin.md +85 -0
- package/docs/reference/typescript-api/cache/redis-cache-strategy.md +75 -0
- package/docs/reference/typescript-api/cache/request-context-cache-service.md +54 -0
- package/docs/reference/typescript-api/cache/self-refreshing-cache.md +152 -0
- package/docs/reference/typescript-api/cache/sql-cache-strategy.md +87 -0
- package/docs/reference/typescript-api/common/admin-ui/admin-ui-app-config.md +43 -0
- package/docs/reference/typescript-api/common/admin-ui/admin-ui-app-dev-mode-config.md +47 -0
- package/docs/reference/typescript-api/common/admin-ui/admin-ui-config.md +139 -0
- package/docs/reference/typescript-api/common/admin-ui/index.md +5 -0
- package/docs/reference/typescript-api/common/async-queue.md +38 -0
- package/docs/reference/typescript-api/common/bootstrap.md +129 -0
- package/docs/reference/typescript-api/common/currency-code.md +174 -0
- package/docs/reference/typescript-api/common/entity-relation-paths.md +34 -0
- package/docs/reference/typescript-api/common/i18n-service.md +74 -0
- package/docs/reference/typescript-api/common/id.md +17 -0
- package/docs/reference/typescript-api/common/index.md +5 -0
- package/docs/reference/typescript-api/common/injectable-strategy.md +48 -0
- package/docs/reference/typescript-api/common/injector.md +47 -0
- package/docs/reference/typescript-api/common/job-state.md +23 -0
- package/docs/reference/typescript-api/common/json-compatible.md +23 -0
- package/docs/reference/typescript-api/common/language-code.md +177 -0
- package/docs/reference/typescript-api/common/middleware.md +72 -0
- package/docs/reference/typescript-api/common/paginated-list.md +36 -0
- package/docs/reference/typescript-api/common/permission.md +136 -0
- package/docs/reference/typescript-api/common/price-calculation-result.md +36 -0
- package/docs/reference/typescript-api/common/process-context.md +55 -0
- package/docs/reference/typescript-api/common/vendure_version.md +22 -0
- package/docs/reference/typescript-api/configurable-operation-def/config-arg-type.md +22 -0
- package/docs/reference/typescript-api/configurable-operation-def/config-args.md +89 -0
- package/docs/reference/typescript-api/configurable-operation-def/configurable-operation-def-options.md +57 -0
- package/docs/reference/typescript-api/configurable-operation-def/default-form-component-id.md +34 -0
- package/docs/reference/typescript-api/configurable-operation-def/default-form-config-hash.md +137 -0
- package/docs/reference/typescript-api/configurable-operation-def/index.md +149 -0
- package/docs/reference/typescript-api/configurable-operation-def/localized-string-array.md +28 -0
- package/docs/reference/typescript-api/configuration/api-options.md +159 -0
- package/docs/reference/typescript-api/configuration/collection-filter.md +76 -0
- package/docs/reference/typescript-api/configuration/default-config.md +13 -0
- package/docs/reference/typescript-api/configuration/default-slug-strategy.md +46 -0
- package/docs/reference/typescript-api/configuration/entity-duplicator.md +195 -0
- package/docs/reference/typescript-api/configuration/entity-id-decorator.md +24 -0
- package/docs/reference/typescript-api/configuration/entity-id-strategy.md +168 -0
- package/docs/reference/typescript-api/configuration/entity-options.md +153 -0
- package/docs/reference/typescript-api/configuration/index.md +5 -0
- package/docs/reference/typescript-api/configuration/merge-config.md +49 -0
- package/docs/reference/typescript-api/configuration/product-variant-price-selection-strategy.md +71 -0
- package/docs/reference/typescript-api/configuration/product-variant-price-update-strategy.md +185 -0
- package/docs/reference/typescript-api/configuration/runtime-vendure-config.md +111 -0
- package/docs/reference/typescript-api/configuration/settings-store-fields.md +29 -0
- package/docs/reference/typescript-api/configuration/slug-strategy.md +47 -0
- package/docs/reference/typescript-api/configuration/system-options.md +50 -0
- package/docs/reference/typescript-api/configuration/trust-proxy-options.md +19 -0
- package/docs/reference/typescript-api/configuration/vendure-config.md +168 -0
- package/docs/reference/typescript-api/custom-fields/custom-field-config.md +25 -0
- package/docs/reference/typescript-api/custom-fields/custom-field-type.md +42 -0
- package/docs/reference/typescript-api/custom-fields/index.md +70 -0
- package/docs/reference/typescript-api/custom-fields/struct-custom-field-config.md +21 -0
- package/docs/reference/typescript-api/custom-fields/struct-field-config.md +41 -0
- package/docs/reference/typescript-api/custom-fields/typed-custom-single-field-config.md +24 -0
- package/docs/reference/typescript-api/data-access/calculated-property-subscriber.md +38 -0
- package/docs/reference/typescript-api/data-access/calculated.md +62 -0
- package/docs/reference/typescript-api/data-access/entity-hydrator.md +103 -0
- package/docs/reference/typescript-api/data-access/get-entity-or-throw-options.md +53 -0
- package/docs/reference/typescript-api/data-access/hydrate-options.md +40 -0
- package/docs/reference/typescript-api/data-access/index.md +5 -0
- package/docs/reference/typescript-api/data-access/list-query-builder.md +239 -0
- package/docs/reference/typescript-api/data-access/transactional-connection.md +173 -0
- package/docs/reference/typescript-api/default-search-plugin/default-search-plugin-init-options.md +126 -0
- package/docs/reference/typescript-api/default-search-plugin/index.md +64 -0
- package/docs/reference/typescript-api/default-search-plugin/mysql-search-strategy.md +56 -0
- package/docs/reference/typescript-api/default-search-plugin/postgres-search-strategy.md +56 -0
- package/docs/reference/typescript-api/default-search-plugin/search-strategy.md +58 -0
- package/docs/reference/typescript-api/default-search-plugin/sqlite-search-strategy.md +57 -0
- package/docs/reference/typescript-api/entities/address.md +124 -0
- package/docs/reference/typescript-api/entities/administrator.md +78 -0
- package/docs/reference/typescript-api/entities/anonymous-session.md +34 -0
- package/docs/reference/typescript-api/entities/asset.md +135 -0
- package/docs/reference/typescript-api/entities/authenticated-session.md +48 -0
- package/docs/reference/typescript-api/entities/authentication-method.md +156 -0
- package/docs/reference/typescript-api/entities/channel.md +233 -0
- package/docs/reference/typescript-api/entities/collection.md +152 -0
- package/docs/reference/typescript-api/entities/country.md +40 -0
- package/docs/reference/typescript-api/entities/customer-group.md +63 -0
- package/docs/reference/typescript-api/entities/customer-history-entry.md +40 -0
- package/docs/reference/typescript-api/entities/customer.md +122 -0
- package/docs/reference/typescript-api/entities/facet-value.md +98 -0
- package/docs/reference/typescript-api/entities/facet.md +89 -0
- package/docs/reference/typescript-api/entities/fulfillment.md +84 -0
- package/docs/reference/typescript-api/entities/global-settings.md +66 -0
- package/docs/reference/typescript-api/entities/history-entry.md +66 -0
- package/docs/reference/typescript-api/entities/index.md +5 -0
- package/docs/reference/typescript-api/entities/interfaces.md +125 -0
- package/docs/reference/typescript-api/entities/order-history-entry.md +40 -0
- package/docs/reference/typescript-api/entities/order-line-reference.md +174 -0
- package/docs/reference/typescript-api/entities/order-line.md +344 -0
- package/docs/reference/typescript-api/entities/order-modification.md +103 -0
- package/docs/reference/typescript-api/entities/order.md +284 -0
- package/docs/reference/typescript-api/entities/orderable-asset.md +61 -0
- package/docs/reference/typescript-api/entities/payment-method.md +94 -0
- package/docs/reference/typescript-api/entities/payment.md +96 -0
- package/docs/reference/typescript-api/entities/product-option-group.md +84 -0
- package/docs/reference/typescript-api/entities/product-option.md +90 -0
- package/docs/reference/typescript-api/entities/product-variant-price.md +70 -0
- package/docs/reference/typescript-api/entities/product-variant.md +251 -0
- package/docs/reference/typescript-api/entities/product.md +134 -0
- package/docs/reference/typescript-api/entities/promotion.md +190 -0
- package/docs/reference/typescript-api/entities/province.md +39 -0
- package/docs/reference/typescript-api/entities/refund.md +120 -0
- package/docs/reference/typescript-api/entities/region.md +87 -0
- package/docs/reference/typescript-api/entities/role.md +62 -0
- package/docs/reference/typescript-api/entities/seller.md +63 -0
- package/docs/reference/typescript-api/entities/session.md +87 -0
- package/docs/reference/typescript-api/entities/settings-store-entry.md +57 -0
- package/docs/reference/typescript-api/entities/shipping-line.md +150 -0
- package/docs/reference/typescript-api/entities/shipping-method.md +123 -0
- package/docs/reference/typescript-api/entities/stock-level.md +87 -0
- package/docs/reference/typescript-api/entities/stock-location.md +76 -0
- package/docs/reference/typescript-api/entities/stock-movement.md +270 -0
- package/docs/reference/typescript-api/entities/surcharge.md +102 -0
- package/docs/reference/typescript-api/entities/tag.md +40 -0
- package/docs/reference/typescript-api/entities/tax-category.md +68 -0
- package/docs/reference/typescript-api/entities/tax-rate.md +138 -0
- package/docs/reference/typescript-api/entities/user.md +111 -0
- package/docs/reference/typescript-api/entities/vendure-entity.md +49 -0
- package/docs/reference/typescript-api/entities/zone.md +78 -0
- package/docs/reference/typescript-api/errors/error-handler-strategy.md +88 -0
- package/docs/reference/typescript-api/errors/error-result-union.md +30 -0
- package/docs/reference/typescript-api/errors/error-types.md +197 -0
- package/docs/reference/typescript-api/errors/i18n-error.md +39 -0
- package/docs/reference/typescript-api/errors/index.md +5 -0
- package/docs/reference/typescript-api/errors/is-graph-ql-error-result.md +40 -0
- package/docs/reference/typescript-api/events/blocking-event-handler-options.md +57 -0
- package/docs/reference/typescript-api/events/event-bus.md +136 -0
- package/docs/reference/typescript-api/events/event-types.md +1689 -0
- package/docs/reference/typescript-api/events/index.md +5 -0
- package/docs/reference/typescript-api/events/vendure-entity-event.md +57 -0
- package/docs/reference/typescript-api/events/vendure-event.md +35 -0
- package/docs/reference/typescript-api/fulfillment/fulfillment-handler.md +173 -0
- package/docs/reference/typescript-api/fulfillment/fulfillment-process.md +71 -0
- package/docs/reference/typescript-api/fulfillment/fulfillment-state.md +21 -0
- package/docs/reference/typescript-api/fulfillment/fulfillment-states.md +18 -0
- package/docs/reference/typescript-api/fulfillment/fulfillment-transition-data.md +41 -0
- package/docs/reference/typescript-api/fulfillment/index.md +5 -0
- package/docs/reference/typescript-api/health-check/health-check-registry-service.md +70 -0
- package/docs/reference/typescript-api/health-check/health-check-strategy.md +70 -0
- package/docs/reference/typescript-api/health-check/http-health-check-strategy.md +61 -0
- package/docs/reference/typescript-api/health-check/index.md +5 -0
- package/docs/reference/typescript-api/health-check/type-ormhealth-check-strategy.md +64 -0
- package/docs/reference/typescript-api/import-export/asset-import-strategy.md +46 -0
- package/docs/reference/typescript-api/import-export/asset-importer.md +32 -0
- package/docs/reference/typescript-api/import-export/default-asset-import-strategy.md +48 -0
- package/docs/reference/typescript-api/import-export/fast-importer-service.md +67 -0
- package/docs/reference/typescript-api/import-export/import-export-options.md +36 -0
- package/docs/reference/typescript-api/import-export/import-parser.md +280 -0
- package/docs/reference/typescript-api/import-export/importer.md +54 -0
- package/docs/reference/typescript-api/import-export/index.md +5 -0
- package/docs/reference/typescript-api/import-export/initial-data.md +71 -0
- package/docs/reference/typescript-api/import-export/populate.md +71 -0
- package/docs/reference/typescript-api/import-export/populator.md +38 -0
- package/docs/reference/typescript-api/job-queue/default-job-queue-plugin.md +245 -0
- package/docs/reference/typescript-api/job-queue/in-memory-job-buffer-storage-strategy.md +55 -0
- package/docs/reference/typescript-api/job-queue/in-memory-job-queue-strategy.md +110 -0
- package/docs/reference/typescript-api/job-queue/index.md +84 -0
- package/docs/reference/typescript-api/job-queue/inspectable-job-queue-strategy.md +60 -0
- package/docs/reference/typescript-api/job-queue/job-buffer-storage-strategy.md +78 -0
- package/docs/reference/typescript-api/job-queue/job-buffer.md +119 -0
- package/docs/reference/typescript-api/job-queue/job-queue-options.md +56 -0
- package/docs/reference/typescript-api/job-queue/job-queue-service.md +128 -0
- package/docs/reference/typescript-api/job-queue/job-queue-strategy.md +59 -0
- package/docs/reference/typescript-api/job-queue/job.md +195 -0
- package/docs/reference/typescript-api/job-queue/polling-job-queue-strategy.md +122 -0
- package/docs/reference/typescript-api/job-queue/sql-job-queue-strategy.md +84 -0
- package/docs/reference/typescript-api/job-queue/subscribable-job.md +44 -0
- package/docs/reference/typescript-api/job-queue/types.md +199 -0
- package/docs/reference/typescript-api/logger/default-logger.md +81 -0
- package/docs/reference/typescript-api/logger/index.md +120 -0
- package/docs/reference/typescript-api/logger/log-level.md +30 -0
- package/docs/reference/typescript-api/logger/vendure-logger.md +60 -0
- package/docs/reference/typescript-api/migration/generate-migration.md +28 -0
- package/docs/reference/typescript-api/migration/index.md +5 -0
- package/docs/reference/typescript-api/migration/migration-options.md +36 -0
- package/docs/reference/typescript-api/migration/revert-last-migration.md +23 -0
- package/docs/reference/typescript-api/migration/run-migrations.md +23 -0
- package/docs/reference/typescript-api/money/big-int-money-strategy.md +68 -0
- package/docs/reference/typescript-api/money/default-money-strategy.md +47 -0
- package/docs/reference/typescript-api/money/index.md +5 -0
- package/docs/reference/typescript-api/money/money-decorator.md +23 -0
- package/docs/reference/typescript-api/money/money-strategy.md +116 -0
- package/docs/reference/typescript-api/money/round-money.md +26 -0
- package/docs/reference/typescript-api/orders/active-order-service.md +69 -0
- package/docs/reference/typescript-api/orders/active-order-strategy.md +203 -0
- package/docs/reference/typescript-api/orders/changed-price-handling-strategy.md +51 -0
- package/docs/reference/typescript-api/orders/custom-order-states.md +18 -0
- package/docs/reference/typescript-api/orders/default-active-order-strategy.md +52 -0
- package/docs/reference/typescript-api/orders/default-guest-checkout-strategy.md +93 -0
- package/docs/reference/typescript-api/orders/default-order-item-price-calculation-strategy.md +33 -0
- package/docs/reference/typescript-api/orders/default-order-placed-strategy.md +33 -0
- package/docs/reference/typescript-api/orders/default-stock-allocation-strategy.md +33 -0
- package/docs/reference/typescript-api/orders/guest-checkout-strategy.md +56 -0
- package/docs/reference/typescript-api/orders/index.md +5 -0
- package/docs/reference/typescript-api/orders/merge-strategies.md +114 -0
- package/docs/reference/typescript-api/orders/order-by-code-access-strategy.md +91 -0
- package/docs/reference/typescript-api/orders/order-code-strategy.md +88 -0
- package/docs/reference/typescript-api/orders/order-interceptor.md +250 -0
- package/docs/reference/typescript-api/orders/order-item-price-calculation-strategy.md +91 -0
- package/docs/reference/typescript-api/orders/order-merge-strategy.md +80 -0
- package/docs/reference/typescript-api/orders/order-options.md +145 -0
- package/docs/reference/typescript-api/orders/order-placed-strategy.md +54 -0
- package/docs/reference/typescript-api/orders/order-process.md +271 -0
- package/docs/reference/typescript-api/orders/order-seller-strategy.md +124 -0
- package/docs/reference/typescript-api/orders/stock-allocation-strategy.md +46 -0
- package/docs/reference/typescript-api/payment/default-payment-process.md +13 -0
- package/docs/reference/typescript-api/payment/default-refund-process.md +13 -0
- package/docs/reference/typescript-api/payment/dummy-payment-handler.md +31 -0
- package/docs/reference/typescript-api/payment/index.md +5 -0
- package/docs/reference/typescript-api/payment/payment-method-config-options.md +69 -0
- package/docs/reference/typescript-api/payment/payment-method-eligibility-checker.md +95 -0
- package/docs/reference/typescript-api/payment/payment-method-handler.md +83 -0
- package/docs/reference/typescript-api/payment/payment-method-types.md +386 -0
- package/docs/reference/typescript-api/payment/payment-options.md +57 -0
- package/docs/reference/typescript-api/payment/payment-process.md +62 -0
- package/docs/reference/typescript-api/payment/payment-state.md +20 -0
- package/docs/reference/typescript-api/payment/payment-states.md +18 -0
- package/docs/reference/typescript-api/payment/payment-transition-data.md +42 -0
- package/docs/reference/typescript-api/payment/refund-process.md +55 -0
- package/docs/reference/typescript-api/payment/refund-state.md +16 -0
- package/docs/reference/typescript-api/payment/refund-states.md +18 -0
- package/docs/reference/typescript-api/payment/refund-transition-data.md +41 -0
- package/docs/reference/typescript-api/plugin/index.md +5 -0
- package/docs/reference/typescript-api/plugin/plugin-common-module.md +28 -0
- package/docs/reference/typescript-api/plugin/plugin-utilities.md +96 -0
- package/docs/reference/typescript-api/plugin/vendure-plugin-metadata.md +147 -0
- package/docs/reference/typescript-api/plugin/vendure-plugin.md +52 -0
- package/docs/reference/typescript-api/products-stock/catalog-options.md +70 -0
- package/docs/reference/typescript-api/products-stock/default-product-variant-price-calculation-strategy.md +38 -0
- package/docs/reference/typescript-api/products-stock/default-stock-display-strategy.md +40 -0
- package/docs/reference/typescript-api/products-stock/default-stock-location-strategy.md +47 -0
- package/docs/reference/typescript-api/products-stock/index.md +5 -0
- package/docs/reference/typescript-api/products-stock/multi-channel-stock-location-strategy.md +47 -0
- package/docs/reference/typescript-api/products-stock/product-variant-price-calculation-strategy.md +95 -0
- package/docs/reference/typescript-api/products-stock/stock-display-strategy.md +47 -0
- package/docs/reference/typescript-api/products-stock/stock-location-strategy.md +157 -0
- package/docs/reference/typescript-api/promotions/facet-value-checker.md +78 -0
- package/docs/reference/typescript-api/promotions/index.md +5 -0
- package/docs/reference/typescript-api/promotions/promotion-action.md +454 -0
- package/docs/reference/typescript-api/promotions/promotion-condition.md +117 -0
- package/docs/reference/typescript-api/promotions/promotion-options.md +35 -0
- package/docs/reference/typescript-api/request/allow-decorator.md +53 -0
- package/docs/reference/typescript-api/request/api-decorator.md +28 -0
- package/docs/reference/typescript-api/request/api-type.md +16 -0
- package/docs/reference/typescript-api/request/ctx-decorator.md +23 -0
- package/docs/reference/typescript-api/request/index.md +5 -0
- package/docs/reference/typescript-api/request/relations-decorator.md +116 -0
- package/docs/reference/typescript-api/request/request-context-service.md +47 -0
- package/docs/reference/typescript-api/request/request-context.md +205 -0
- package/docs/reference/typescript-api/request/transaction-decorator.md +82 -0
- package/docs/reference/typescript-api/scheduled-tasks/clean-sessions-task.md +40 -0
- package/docs/reference/typescript-api/scheduled-tasks/default-scheduler-plugin.md +86 -0
- package/docs/reference/typescript-api/scheduled-tasks/default-scheduler-strategy.md +76 -0
- package/docs/reference/typescript-api/scheduled-tasks/index.md +5 -0
- package/docs/reference/typescript-api/scheduled-tasks/scheduled-task.md +196 -0
- package/docs/reference/typescript-api/scheduled-tasks/scheduler-options.md +47 -0
- package/docs/reference/typescript-api/scheduled-tasks/scheduler-service.md +62 -0
- package/docs/reference/typescript-api/scheduled-tasks/scheduler-strategy.md +141 -0
- package/docs/reference/typescript-api/service-helpers/entity-duplicator-service.md +43 -0
- package/docs/reference/typescript-api/service-helpers/index.md +5 -0
- package/docs/reference/typescript-api/service-helpers/order-calculator.md +54 -0
- package/docs/reference/typescript-api/service-helpers/order-modifier.md +91 -0
- package/docs/reference/typescript-api/service-helpers/product-price-applicator.md +62 -0
- package/docs/reference/typescript-api/service-helpers/slug-validator.md +86 -0
- package/docs/reference/typescript-api/service-helpers/translatable-saver.md +66 -0
- package/docs/reference/typescript-api/service-helpers/translator-service.md +63 -0
- package/docs/reference/typescript-api/services/administrator-service.md +71 -0
- package/docs/reference/typescript-api/services/asset-service.md +177 -0
- package/docs/reference/typescript-api/services/auth-service.md +54 -0
- package/docs/reference/typescript-api/services/channel-service.md +111 -0
- package/docs/reference/typescript-api/services/collection-service.md +186 -0
- package/docs/reference/typescript-api/services/country-service.md +71 -0
- package/docs/reference/typescript-api/services/customer-group-service.md +77 -0
- package/docs/reference/typescript-api/services/customer-service.md +203 -0
- package/docs/reference/typescript-api/services/entity-slug-service.md +37 -0
- package/docs/reference/typescript-api/services/facet-service.md +95 -0
- package/docs/reference/typescript-api/services/facet-value-service.md +104 -0
- package/docs/reference/typescript-api/services/fulfillment-service.md +69 -0
- package/docs/reference/typescript-api/services/global-settings-service.md +41 -0
- package/docs/reference/typescript-api/services/history-service.md +172 -0
- package/docs/reference/typescript-api/services/index.md +5 -0
- package/docs/reference/typescript-api/services/initializer-service.md +36 -0
- package/docs/reference/typescript-api/services/order-service.md +440 -0
- package/docs/reference/typescript-api/services/order-testing-service.md +44 -0
- package/docs/reference/typescript-api/services/payment-method-service.md +105 -0
- package/docs/reference/typescript-api/services/payment-service.md +105 -0
- package/docs/reference/typescript-api/services/product-option-group-service.md +67 -0
- package/docs/reference/typescript-api/services/product-option-service.md +64 -0
- package/docs/reference/typescript-api/services/product-service.md +111 -0
- package/docs/reference/typescript-api/services/product-variant-service.md +179 -0
- package/docs/reference/typescript-api/services/promotion-service.md +127 -0
- package/docs/reference/typescript-api/services/province-service.md +59 -0
- package/docs/reference/typescript-api/services/role-service.md +113 -0
- package/docs/reference/typescript-api/services/search-service.md +37 -0
- package/docs/reference/typescript-api/services/seller-service.md +65 -0
- package/docs/reference/typescript-api/services/session-service.md +105 -0
- package/docs/reference/typescript-api/services/settings-store-service.md +194 -0
- package/docs/reference/typescript-api/services/shipping-method-service.md +95 -0
- package/docs/reference/typescript-api/services/slug-service.md +35 -0
- package/docs/reference/typescript-api/services/stock-level-service.md +62 -0
- package/docs/reference/typescript-api/services/stock-location-service.md +115 -0
- package/docs/reference/typescript-api/services/stock-movement-service.md +95 -0
- package/docs/reference/typescript-api/services/tag-service.md +71 -0
- package/docs/reference/typescript-api/services/tax-category-service.md +59 -0
- package/docs/reference/typescript-api/services/tax-rate-service.md +66 -0
- package/docs/reference/typescript-api/services/user-service.md +132 -0
- package/docs/reference/typescript-api/services/zone-service.md +77 -0
- package/docs/reference/typescript-api/settings-store/cleanup-orphaned-settings-store-entries-options.md +48 -0
- package/docs/reference/typescript-api/settings-store/cleanup-orphaned-settings-store-entries-result.md +41 -0
- package/docs/reference/typescript-api/settings-store/index.md +38 -0
- package/docs/reference/typescript-api/settings-store/orphaned-settings-store-entry.md +48 -0
- package/docs/reference/typescript-api/settings-store/set-settings-store-value-result.md +42 -0
- package/docs/reference/typescript-api/settings-store/settings-store-field-config.md +92 -0
- package/docs/reference/typescript-api/settings-store/settings-store-registration.md +36 -0
- package/docs/reference/typescript-api/settings-store/settings-store-scope-function.md +35 -0
- package/docs/reference/typescript-api/settings-store/settings-store-scopes.md +36 -0
- package/docs/reference/typescript-api/shipping/check-shipping-eligibility-checker-fn.md +27 -0
- package/docs/reference/typescript-api/shipping/default-shipping-line-assignment-strategy.md +33 -0
- package/docs/reference/typescript-api/shipping/index.md +5 -0
- package/docs/reference/typescript-api/shipping/shipping-calculator.md +121 -0
- package/docs/reference/typescript-api/shipping/shipping-eligibility-checker-config.md +39 -0
- package/docs/reference/typescript-api/shipping/shipping-eligibility-checker.md +60 -0
- package/docs/reference/typescript-api/shipping/shipping-line-assignment-strategy.md +75 -0
- package/docs/reference/typescript-api/shipping/shipping-options.md +63 -0
- package/docs/reference/typescript-api/shipping/should-run-check-fn.md +44 -0
- package/docs/reference/typescript-api/state-machine/fsm.md +66 -0
- package/docs/reference/typescript-api/state-machine/index.md +5 -0
- package/docs/reference/typescript-api/state-machine/state-machine-config.md +103 -0
- package/docs/reference/typescript-api/state-machine/transitions.md +43 -0
- package/docs/reference/typescript-api/tax/address-based-tax-zone-strategy.md +57 -0
- package/docs/reference/typescript-api/tax/default-tax-line-calculation-strategy.md +33 -0
- package/docs/reference/typescript-api/tax/default-tax-zone-strategy.md +35 -0
- package/docs/reference/typescript-api/tax/index.md +5 -0
- package/docs/reference/typescript-api/tax/tax-line-calculation-strategy.md +90 -0
- package/docs/reference/typescript-api/tax/tax-options.md +35 -0
- package/docs/reference/typescript-api/tax/tax-zone-strategy.md +54 -0
- package/docs/reference/typescript-api/telemetry/index.md +5 -0
- package/docs/reference/typescript-api/telemetry/instrument.md +47 -0
- package/docs/reference/typescript-api/telemetry/instrumentation-strategy.md +35 -0
- package/docs/reference/typescript-api/telemetry/wrapped-method-args.md +56 -0
- package/docs/reference/typescript-api/testing/create-error-result-guard.md +33 -0
- package/docs/reference/typescript-api/testing/create-test-environment.md +47 -0
- package/docs/reference/typescript-api/testing/error-result-guard.md +73 -0
- package/docs/reference/typescript-api/testing/get-superadmin-context.md +23 -0
- package/docs/reference/typescript-api/testing/index.md +5 -0
- package/docs/reference/typescript-api/testing/register-initializer.md +27 -0
- package/docs/reference/typescript-api/testing/simple-graph-qlclient.md +123 -0
- package/docs/reference/typescript-api/testing/test-config.md +30 -0
- package/docs/reference/typescript-api/testing/test-db-initializer.md +60 -0
- package/docs/reference/typescript-api/testing/test-environment.md +42 -0
- package/docs/reference/typescript-api/testing/test-server-options.md +47 -0
- package/docs/reference/typescript-api/testing/test-server.md +60 -0
- package/docs/reference/typescript-api/testing/testing-logger.md +140 -0
- package/docs/reference/typescript-api/worker/bootstrap-worker.md +76 -0
- package/docs/reference/typescript-api/worker/index.md +5 -0
- package/docs/reference/typescript-api/worker/vendure-worker.md +50 -0
- package/docs/reference/typescript-api/worker/worker-health-check-config.md +41 -0
- package/docs/user-guide/catalog/collections.md +27 -0
- package/docs/user-guide/catalog/facets.md +34 -0
- package/docs/user-guide/catalog/product-variants.png +0 -0
- package/docs/user-guide/catalog/products.md +35 -0
- package/docs/user-guide/catalog/screen-facet-add.webp +0 -0
- package/docs/user-guide/catalog/screen-facet-list.webp +0 -0
- package/docs/user-guide/catalog/screen-inventory.webp +0 -0
- package/docs/user-guide/customers/index.md +30 -0
- package/docs/user-guide/customers/screen-customer-group.webp +0 -0
- package/docs/user-guide/index.md +7 -0
- package/docs/user-guide/localization/index.md +42 -0
- package/docs/user-guide/localization/screen-ui-language.webp +0 -0
- package/docs/user-guide/orders/draft-orders.md +28 -0
- package/docs/user-guide/orders/order-state-diagram-for-admin.png +0 -0
- package/docs/user-guide/orders/orders.md +65 -0
- package/docs/user-guide/orders/screen-fulfillment-shipped.webp +0 -0
- package/docs/user-guide/orders/screen-fulfillment.webp +0 -0
- package/docs/user-guide/orders/screen-modification.webp +0 -0
- package/docs/user-guide/orders/screen-modify-button.webp +0 -0
- package/docs/user-guide/orders/screen-refund-button.webp +0 -0
- package/docs/user-guide/orders/screen-settle-payment.webp +0 -0
- package/docs/user-guide/promotions/index.md +44 -0
- package/docs/user-guide/settings/administrators-roles.md +34 -0
- package/docs/user-guide/settings/channels.md +18 -0
- package/docs/user-guide/settings/countries-zones.md +12 -0
- package/docs/user-guide/settings/global-settings.md +12 -0
- package/docs/user-guide/settings/payment-methods.md +32 -0
- package/docs/user-guide/settings/screen-shipping-test.webp +0 -0
- package/docs/user-guide/settings/screen-translations.webp +0 -0
- package/docs/user-guide/settings/shipping-methods.md +55 -0
- package/docs/user-guide/settings/taxes.md +32 -0
- package/package.json +32 -0
|
@@ -0,0 +1,1985 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "Mutations"
|
|
3
|
+
generated: true
|
|
4
|
+
---
|
|
5
|
+
<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
## addCustomersToGroup
|
|
10
|
+
<div class="graphql-code-block">
|
|
11
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
12
|
+
<div class="graphql-code-line top-level comment">Add Customers to a CustomerGroup</div>
|
|
13
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
14
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
15
|
+
<div class="graphql-code-line ">addCustomersToGroup(customerGroupId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!, customerIds: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]!): <a href="/reference/graphql-api/admin/object-types#customergroup">CustomerGroup</a>!</div>
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
<div class="graphql-code-line top-level">}</div>
|
|
19
|
+
</div>
|
|
20
|
+
|
|
21
|
+
## addFulfillmentToOrder
|
|
22
|
+
<div class="graphql-code-block">
|
|
23
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
24
|
+
<div class="graphql-code-line ">addFulfillmentToOrder(input: <a href="/reference/graphql-api/admin/input-types#fulfillorderinput">FulfillOrderInput</a>!): <a href="/reference/graphql-api/admin/object-types#addfulfillmenttoorderresult">AddFulfillmentToOrderResult</a>!</div>
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
<div class="graphql-code-line top-level">}</div>
|
|
28
|
+
</div>
|
|
29
|
+
|
|
30
|
+
## addItemToDraftOrder
|
|
31
|
+
<div class="graphql-code-block">
|
|
32
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
33
|
+
<div class="graphql-code-line top-level comment">Adds an item to the draft Order.</div>
|
|
34
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
35
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
36
|
+
<div class="graphql-code-line ">addItemToDraftOrder(orderId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!, input: <a href="/reference/graphql-api/admin/input-types#additemtodraftorderinput">AddItemToDraftOrderInput</a>!): <a href="/reference/graphql-api/admin/object-types#updateorderitemsresult">UpdateOrderItemsResult</a>!</div>
|
|
37
|
+
|
|
38
|
+
|
|
39
|
+
<div class="graphql-code-line top-level">}</div>
|
|
40
|
+
</div>
|
|
41
|
+
|
|
42
|
+
## addManualPaymentToOrder
|
|
43
|
+
<div class="graphql-code-block">
|
|
44
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
45
|
+
<div class="graphql-code-line top-level comment">Used to manually create a new Payment against an Order.</div>
|
|
46
|
+
|
|
47
|
+
<div class="graphql-code-line top-level comment">This can be used by an Administrator when an Order is in the ArrangingPayment state.</div>
|
|
48
|
+
|
|
49
|
+
<div class="graphql-code-line top-level comment"></div>
|
|
50
|
+
|
|
51
|
+
<div class="graphql-code-line top-level comment">It is also used when a completed Order</div>
|
|
52
|
+
|
|
53
|
+
<div class="graphql-code-line top-level comment">has been modified (using `modifyOrder`) and the price has increased. The extra payment</div>
|
|
54
|
+
|
|
55
|
+
<div class="graphql-code-line top-level comment">can then be manually arranged by the administrator, and the details used to create a new</div>
|
|
56
|
+
|
|
57
|
+
<div class="graphql-code-line top-level comment">Payment.</div>
|
|
58
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
59
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
60
|
+
<div class="graphql-code-line ">addManualPaymentToOrder(input: <a href="/reference/graphql-api/admin/input-types#manualpaymentinput">ManualPaymentInput</a>!): <a href="/reference/graphql-api/admin/object-types#addmanualpaymenttoorderresult">AddManualPaymentToOrderResult</a>!</div>
|
|
61
|
+
|
|
62
|
+
|
|
63
|
+
<div class="graphql-code-line top-level">}</div>
|
|
64
|
+
</div>
|
|
65
|
+
|
|
66
|
+
## addMembersToZone
|
|
67
|
+
<div class="graphql-code-block">
|
|
68
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
69
|
+
<div class="graphql-code-line top-level comment">Add members to a Zone</div>
|
|
70
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
71
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
72
|
+
<div class="graphql-code-line ">addMembersToZone(zoneId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!, memberIds: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]!): <a href="/reference/graphql-api/admin/object-types#zone">Zone</a>!</div>
|
|
73
|
+
|
|
74
|
+
|
|
75
|
+
<div class="graphql-code-line top-level">}</div>
|
|
76
|
+
</div>
|
|
77
|
+
|
|
78
|
+
## addNoteToCustomer
|
|
79
|
+
<div class="graphql-code-block">
|
|
80
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
81
|
+
<div class="graphql-code-line ">addNoteToCustomer(input: <a href="/reference/graphql-api/admin/input-types#addnotetocustomerinput">AddNoteToCustomerInput</a>!): <a href="/reference/graphql-api/admin/object-types#customer">Customer</a>!</div>
|
|
82
|
+
|
|
83
|
+
|
|
84
|
+
<div class="graphql-code-line top-level">}</div>
|
|
85
|
+
</div>
|
|
86
|
+
|
|
87
|
+
## addNoteToOrder
|
|
88
|
+
<div class="graphql-code-block">
|
|
89
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
90
|
+
<div class="graphql-code-line ">addNoteToOrder(input: <a href="/reference/graphql-api/admin/input-types#addnotetoorderinput">AddNoteToOrderInput</a>!): <a href="/reference/graphql-api/admin/object-types#order">Order</a>!</div>
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
<div class="graphql-code-line top-level">}</div>
|
|
94
|
+
</div>
|
|
95
|
+
|
|
96
|
+
## addOptionGroupToProduct
|
|
97
|
+
<div class="graphql-code-block">
|
|
98
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
99
|
+
<div class="graphql-code-line top-level comment">Add an OptionGroup to a Product</div>
|
|
100
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
101
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
102
|
+
<div class="graphql-code-line ">addOptionGroupToProduct(productId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!, optionGroupId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#product">Product</a>!</div>
|
|
103
|
+
|
|
104
|
+
|
|
105
|
+
<div class="graphql-code-line top-level">}</div>
|
|
106
|
+
</div>
|
|
107
|
+
|
|
108
|
+
## adjustDraftOrderLine
|
|
109
|
+
<div class="graphql-code-block">
|
|
110
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
111
|
+
<div class="graphql-code-line top-level comment">Adjusts a draft OrderLine. If custom fields are defined on the OrderLine entity, a third argument 'customFields' of type <code>OrderLineCustomFieldsInput</code> will be available.</div>
|
|
112
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
113
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
114
|
+
<div class="graphql-code-line ">adjustDraftOrderLine(orderId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!, input: <a href="/reference/graphql-api/admin/input-types#adjustdraftorderlineinput">AdjustDraftOrderLineInput</a>!): <a href="/reference/graphql-api/admin/object-types#updateorderitemsresult">UpdateOrderItemsResult</a>!</div>
|
|
115
|
+
|
|
116
|
+
|
|
117
|
+
<div class="graphql-code-line top-level">}</div>
|
|
118
|
+
</div>
|
|
119
|
+
|
|
120
|
+
## applyCouponCodeToDraftOrder
|
|
121
|
+
<div class="graphql-code-block">
|
|
122
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
123
|
+
<div class="graphql-code-line top-level comment">Applies the given coupon code to the draft Order</div>
|
|
124
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
125
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
126
|
+
<div class="graphql-code-line ">applyCouponCodeToDraftOrder(orderId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!, couponCode: <a href="/reference/graphql-api/admin/object-types#string">String</a>!): <a href="/reference/graphql-api/admin/object-types#applycouponcoderesult">ApplyCouponCodeResult</a>!</div>
|
|
127
|
+
|
|
128
|
+
|
|
129
|
+
<div class="graphql-code-line top-level">}</div>
|
|
130
|
+
</div>
|
|
131
|
+
|
|
132
|
+
## assignAssetsToChannel
|
|
133
|
+
<div class="graphql-code-block">
|
|
134
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
135
|
+
<div class="graphql-code-line top-level comment">Assign assets to channel</div>
|
|
136
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
137
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
138
|
+
<div class="graphql-code-line ">assignAssetsToChannel(input: <a href="/reference/graphql-api/admin/input-types#assignassetstochannelinput">AssignAssetsToChannelInput</a>!): [<a href="/reference/graphql-api/admin/object-types#asset">Asset</a>!]!</div>
|
|
139
|
+
|
|
140
|
+
|
|
141
|
+
<div class="graphql-code-line top-level">}</div>
|
|
142
|
+
</div>
|
|
143
|
+
|
|
144
|
+
## assignCollectionsToChannel
|
|
145
|
+
<div class="graphql-code-block">
|
|
146
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
147
|
+
<div class="graphql-code-line top-level comment">Assigns Collections to the specified Channel</div>
|
|
148
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
149
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
150
|
+
<div class="graphql-code-line ">assignCollectionsToChannel(input: <a href="/reference/graphql-api/admin/input-types#assigncollectionstochannelinput">AssignCollectionsToChannelInput</a>!): [<a href="/reference/graphql-api/admin/object-types#collection">Collection</a>!]!</div>
|
|
151
|
+
|
|
152
|
+
|
|
153
|
+
<div class="graphql-code-line top-level">}</div>
|
|
154
|
+
</div>
|
|
155
|
+
|
|
156
|
+
## assignFacetsToChannel
|
|
157
|
+
<div class="graphql-code-block">
|
|
158
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
159
|
+
<div class="graphql-code-line top-level comment">Assigns Facets to the specified Channel</div>
|
|
160
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
161
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
162
|
+
<div class="graphql-code-line ">assignFacetsToChannel(input: <a href="/reference/graphql-api/admin/input-types#assignfacetstochannelinput">AssignFacetsToChannelInput</a>!): [<a href="/reference/graphql-api/admin/object-types#facet">Facet</a>!]!</div>
|
|
163
|
+
|
|
164
|
+
|
|
165
|
+
<div class="graphql-code-line top-level">}</div>
|
|
166
|
+
</div>
|
|
167
|
+
|
|
168
|
+
## assignPaymentMethodsToChannel
|
|
169
|
+
<div class="graphql-code-block">
|
|
170
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
171
|
+
<div class="graphql-code-line top-level comment">Assigns PaymentMethods to the specified Channel</div>
|
|
172
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
173
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
174
|
+
<div class="graphql-code-line ">assignPaymentMethodsToChannel(input: <a href="/reference/graphql-api/admin/input-types#assignpaymentmethodstochannelinput">AssignPaymentMethodsToChannelInput</a>!): [<a href="/reference/graphql-api/admin/object-types#paymentmethod">PaymentMethod</a>!]!</div>
|
|
175
|
+
|
|
176
|
+
|
|
177
|
+
<div class="graphql-code-line top-level">}</div>
|
|
178
|
+
</div>
|
|
179
|
+
|
|
180
|
+
## assignProductVariantsToChannel
|
|
181
|
+
<div class="graphql-code-block">
|
|
182
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
183
|
+
<div class="graphql-code-line top-level comment">Assigns ProductVariants to the specified Channel</div>
|
|
184
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
185
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
186
|
+
<div class="graphql-code-line ">assignProductVariantsToChannel(input: <a href="/reference/graphql-api/admin/input-types#assignproductvariantstochannelinput">AssignProductVariantsToChannelInput</a>!): [<a href="/reference/graphql-api/admin/object-types#productvariant">ProductVariant</a>!]!</div>
|
|
187
|
+
|
|
188
|
+
|
|
189
|
+
<div class="graphql-code-line top-level">}</div>
|
|
190
|
+
</div>
|
|
191
|
+
|
|
192
|
+
## assignProductsToChannel
|
|
193
|
+
<div class="graphql-code-block">
|
|
194
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
195
|
+
<div class="graphql-code-line top-level comment">Assigns all ProductVariants of Product to the specified Channel</div>
|
|
196
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
197
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
198
|
+
<div class="graphql-code-line ">assignProductsToChannel(input: <a href="/reference/graphql-api/admin/input-types#assignproductstochannelinput">AssignProductsToChannelInput</a>!): [<a href="/reference/graphql-api/admin/object-types#product">Product</a>!]!</div>
|
|
199
|
+
|
|
200
|
+
|
|
201
|
+
<div class="graphql-code-line top-level">}</div>
|
|
202
|
+
</div>
|
|
203
|
+
|
|
204
|
+
## assignPromotionsToChannel
|
|
205
|
+
<div class="graphql-code-block">
|
|
206
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
207
|
+
<div class="graphql-code-line top-level comment">Assigns Promotions to the specified Channel</div>
|
|
208
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
209
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
210
|
+
<div class="graphql-code-line ">assignPromotionsToChannel(input: <a href="/reference/graphql-api/admin/input-types#assignpromotionstochannelinput">AssignPromotionsToChannelInput</a>!): [<a href="/reference/graphql-api/admin/object-types#promotion">Promotion</a>!]!</div>
|
|
211
|
+
|
|
212
|
+
|
|
213
|
+
<div class="graphql-code-line top-level">}</div>
|
|
214
|
+
</div>
|
|
215
|
+
|
|
216
|
+
## assignRoleToAdministrator
|
|
217
|
+
<div class="graphql-code-block">
|
|
218
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
219
|
+
<div class="graphql-code-line top-level comment">Assign a Role to an Administrator</div>
|
|
220
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
221
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
222
|
+
<div class="graphql-code-line ">assignRoleToAdministrator(administratorId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!, roleId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#administrator">Administrator</a>!</div>
|
|
223
|
+
|
|
224
|
+
|
|
225
|
+
<div class="graphql-code-line top-level">}</div>
|
|
226
|
+
</div>
|
|
227
|
+
|
|
228
|
+
## assignShippingMethodsToChannel
|
|
229
|
+
<div class="graphql-code-block">
|
|
230
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
231
|
+
<div class="graphql-code-line top-level comment">Assigns ShippingMethods to the specified Channel</div>
|
|
232
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
233
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
234
|
+
<div class="graphql-code-line ">assignShippingMethodsToChannel(input: <a href="/reference/graphql-api/admin/input-types#assignshippingmethodstochannelinput">AssignShippingMethodsToChannelInput</a>!): [<a href="/reference/graphql-api/admin/object-types#shippingmethod">ShippingMethod</a>!]!</div>
|
|
235
|
+
|
|
236
|
+
|
|
237
|
+
<div class="graphql-code-line top-level">}</div>
|
|
238
|
+
</div>
|
|
239
|
+
|
|
240
|
+
## assignStockLocationsToChannel
|
|
241
|
+
<div class="graphql-code-block">
|
|
242
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
243
|
+
<div class="graphql-code-line top-level comment">Assigns StockLocations to the specified Channel</div>
|
|
244
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
245
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
246
|
+
<div class="graphql-code-line ">assignStockLocationsToChannel(input: <a href="/reference/graphql-api/admin/input-types#assignstocklocationstochannelinput">AssignStockLocationsToChannelInput</a>!): [<a href="/reference/graphql-api/admin/object-types#stocklocation">StockLocation</a>!]!</div>
|
|
247
|
+
|
|
248
|
+
|
|
249
|
+
<div class="graphql-code-line top-level">}</div>
|
|
250
|
+
</div>
|
|
251
|
+
|
|
252
|
+
## authenticate
|
|
253
|
+
<div class="graphql-code-block">
|
|
254
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
255
|
+
<div class="graphql-code-line top-level comment">Authenticates the user using a named authentication strategy</div>
|
|
256
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
257
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
258
|
+
<div class="graphql-code-line ">authenticate(input: <a href="/reference/graphql-api/admin/input-types#authenticationinput">AuthenticationInput</a>!, rememberMe: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a>): <a href="/reference/graphql-api/admin/object-types#authenticationresult">AuthenticationResult</a>!</div>
|
|
259
|
+
|
|
260
|
+
|
|
261
|
+
<div class="graphql-code-line top-level">}</div>
|
|
262
|
+
</div>
|
|
263
|
+
|
|
264
|
+
## cancelJob
|
|
265
|
+
<div class="graphql-code-block">
|
|
266
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
267
|
+
<div class="graphql-code-line ">cancelJob(jobId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#job">Job</a>!</div>
|
|
268
|
+
|
|
269
|
+
|
|
270
|
+
<div class="graphql-code-line top-level">}</div>
|
|
271
|
+
</div>
|
|
272
|
+
|
|
273
|
+
## cancelOrder
|
|
274
|
+
<div class="graphql-code-block">
|
|
275
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
276
|
+
<div class="graphql-code-line ">cancelOrder(input: <a href="/reference/graphql-api/admin/input-types#cancelorderinput">CancelOrderInput</a>!): <a href="/reference/graphql-api/admin/object-types#cancelorderresult">CancelOrderResult</a>!</div>
|
|
277
|
+
|
|
278
|
+
|
|
279
|
+
<div class="graphql-code-line top-level">}</div>
|
|
280
|
+
</div>
|
|
281
|
+
|
|
282
|
+
## cancelPayment
|
|
283
|
+
<div class="graphql-code-block">
|
|
284
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
285
|
+
<div class="graphql-code-line ">cancelPayment(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#cancelpaymentresult">CancelPaymentResult</a>!</div>
|
|
286
|
+
|
|
287
|
+
|
|
288
|
+
<div class="graphql-code-line top-level">}</div>
|
|
289
|
+
</div>
|
|
290
|
+
|
|
291
|
+
## createAdministrator
|
|
292
|
+
<div class="graphql-code-block">
|
|
293
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
294
|
+
<div class="graphql-code-line top-level comment">Create a new Administrator</div>
|
|
295
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
296
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
297
|
+
<div class="graphql-code-line ">createAdministrator(input: <a href="/reference/graphql-api/admin/input-types#createadministratorinput">CreateAdministratorInput</a>!): <a href="/reference/graphql-api/admin/object-types#administrator">Administrator</a>!</div>
|
|
298
|
+
|
|
299
|
+
|
|
300
|
+
<div class="graphql-code-line top-level">}</div>
|
|
301
|
+
</div>
|
|
302
|
+
|
|
303
|
+
## createAssets
|
|
304
|
+
<div class="graphql-code-block">
|
|
305
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
306
|
+
<div class="graphql-code-line top-level comment">Create a new Asset</div>
|
|
307
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
308
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
309
|
+
<div class="graphql-code-line ">createAssets(input: [<a href="/reference/graphql-api/admin/input-types#createassetinput">CreateAssetInput</a>!]!): [<a href="/reference/graphql-api/admin/object-types#createassetresult">CreateAssetResult</a>!]!</div>
|
|
310
|
+
|
|
311
|
+
|
|
312
|
+
<div class="graphql-code-line top-level">}</div>
|
|
313
|
+
</div>
|
|
314
|
+
|
|
315
|
+
## createChannel
|
|
316
|
+
<div class="graphql-code-block">
|
|
317
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
318
|
+
<div class="graphql-code-line top-level comment">Create a new Channel</div>
|
|
319
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
320
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
321
|
+
<div class="graphql-code-line ">createChannel(input: <a href="/reference/graphql-api/admin/input-types#createchannelinput">CreateChannelInput</a>!): <a href="/reference/graphql-api/admin/object-types#createchannelresult">CreateChannelResult</a>!</div>
|
|
322
|
+
|
|
323
|
+
|
|
324
|
+
<div class="graphql-code-line top-level">}</div>
|
|
325
|
+
</div>
|
|
326
|
+
|
|
327
|
+
## createCollection
|
|
328
|
+
<div class="graphql-code-block">
|
|
329
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
330
|
+
<div class="graphql-code-line top-level comment">Create a new Collection</div>
|
|
331
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
332
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
333
|
+
<div class="graphql-code-line ">createCollection(input: <a href="/reference/graphql-api/admin/input-types#createcollectioninput">CreateCollectionInput</a>!): <a href="/reference/graphql-api/admin/object-types#collection">Collection</a>!</div>
|
|
334
|
+
|
|
335
|
+
|
|
336
|
+
<div class="graphql-code-line top-level">}</div>
|
|
337
|
+
</div>
|
|
338
|
+
|
|
339
|
+
## createCountry
|
|
340
|
+
<div class="graphql-code-block">
|
|
341
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
342
|
+
<div class="graphql-code-line top-level comment">Create a new Country</div>
|
|
343
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
344
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
345
|
+
<div class="graphql-code-line ">createCountry(input: <a href="/reference/graphql-api/admin/input-types#createcountryinput">CreateCountryInput</a>!): <a href="/reference/graphql-api/admin/object-types#country">Country</a>!</div>
|
|
346
|
+
|
|
347
|
+
|
|
348
|
+
<div class="graphql-code-line top-level">}</div>
|
|
349
|
+
</div>
|
|
350
|
+
|
|
351
|
+
## createCustomer
|
|
352
|
+
<div class="graphql-code-block">
|
|
353
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
354
|
+
<div class="graphql-code-line top-level comment">Create a new Customer. If a password is provided, a new User will also be created an linked to the Customer.</div>
|
|
355
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
356
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
357
|
+
<div class="graphql-code-line ">createCustomer(input: <a href="/reference/graphql-api/admin/input-types#createcustomerinput">CreateCustomerInput</a>!, password: <a href="/reference/graphql-api/admin/object-types#string">String</a>): <a href="/reference/graphql-api/admin/object-types#createcustomerresult">CreateCustomerResult</a>!</div>
|
|
358
|
+
|
|
359
|
+
|
|
360
|
+
<div class="graphql-code-line top-level">}</div>
|
|
361
|
+
</div>
|
|
362
|
+
|
|
363
|
+
## createCustomerAddress
|
|
364
|
+
<div class="graphql-code-block">
|
|
365
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
366
|
+
<div class="graphql-code-line top-level comment">Create a new Address and associate it with the Customer specified by customerId</div>
|
|
367
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
368
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
369
|
+
<div class="graphql-code-line ">createCustomerAddress(customerId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!, input: <a href="/reference/graphql-api/admin/input-types#createaddressinput">CreateAddressInput</a>!): <a href="/reference/graphql-api/admin/object-types#address">Address</a>!</div>
|
|
370
|
+
|
|
371
|
+
|
|
372
|
+
<div class="graphql-code-line top-level">}</div>
|
|
373
|
+
</div>
|
|
374
|
+
|
|
375
|
+
## createCustomerGroup
|
|
376
|
+
<div class="graphql-code-block">
|
|
377
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
378
|
+
<div class="graphql-code-line top-level comment">Create a new CustomerGroup</div>
|
|
379
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
380
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
381
|
+
<div class="graphql-code-line ">createCustomerGroup(input: <a href="/reference/graphql-api/admin/input-types#createcustomergroupinput">CreateCustomerGroupInput</a>!): <a href="/reference/graphql-api/admin/object-types#customergroup">CustomerGroup</a>!</div>
|
|
382
|
+
|
|
383
|
+
|
|
384
|
+
<div class="graphql-code-line top-level">}</div>
|
|
385
|
+
</div>
|
|
386
|
+
|
|
387
|
+
## createDraftOrder
|
|
388
|
+
<div class="graphql-code-block">
|
|
389
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
390
|
+
<div class="graphql-code-line top-level comment">Creates a draft Order</div>
|
|
391
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
392
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
393
|
+
<div class="graphql-code-line ">createDraftOrder: <a href="/reference/graphql-api/admin/object-types#order">Order</a>!</div>
|
|
394
|
+
|
|
395
|
+
|
|
396
|
+
<div class="graphql-code-line top-level">}</div>
|
|
397
|
+
</div>
|
|
398
|
+
|
|
399
|
+
## createFacet
|
|
400
|
+
<div class="graphql-code-block">
|
|
401
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
402
|
+
<div class="graphql-code-line top-level comment">Create a new Facet</div>
|
|
403
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
404
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
405
|
+
<div class="graphql-code-line ">createFacet(input: <a href="/reference/graphql-api/admin/input-types#createfacetinput">CreateFacetInput</a>!): <a href="/reference/graphql-api/admin/object-types#facet">Facet</a>!</div>
|
|
406
|
+
|
|
407
|
+
|
|
408
|
+
<div class="graphql-code-line top-level">}</div>
|
|
409
|
+
</div>
|
|
410
|
+
|
|
411
|
+
## createFacetValue
|
|
412
|
+
<div class="graphql-code-block">
|
|
413
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
414
|
+
<div class="graphql-code-line top-level comment">Create a single FacetValue</div>
|
|
415
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
416
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
417
|
+
<div class="graphql-code-line ">createFacetValue(input: <a href="/reference/graphql-api/admin/input-types#createfacetvalueinput">CreateFacetValueInput</a>!): <a href="/reference/graphql-api/admin/object-types#facetvalue">FacetValue</a>!</div>
|
|
418
|
+
|
|
419
|
+
|
|
420
|
+
<div class="graphql-code-line top-level">}</div>
|
|
421
|
+
</div>
|
|
422
|
+
|
|
423
|
+
## createFacetValues
|
|
424
|
+
<div class="graphql-code-block">
|
|
425
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
426
|
+
<div class="graphql-code-line top-level comment">Create one or more FacetValues</div>
|
|
427
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
428
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
429
|
+
<div class="graphql-code-line ">createFacetValues(input: [<a href="/reference/graphql-api/admin/input-types#createfacetvalueinput">CreateFacetValueInput</a>!]!): [<a href="/reference/graphql-api/admin/object-types#facetvalue">FacetValue</a>!]!</div>
|
|
430
|
+
|
|
431
|
+
|
|
432
|
+
<div class="graphql-code-line top-level">}</div>
|
|
433
|
+
</div>
|
|
434
|
+
|
|
435
|
+
## createPaymentMethod
|
|
436
|
+
<div class="graphql-code-block">
|
|
437
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
438
|
+
<div class="graphql-code-line top-level comment">Create existing PaymentMethod</div>
|
|
439
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
440
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
441
|
+
<div class="graphql-code-line ">createPaymentMethod(input: <a href="/reference/graphql-api/admin/input-types#createpaymentmethodinput">CreatePaymentMethodInput</a>!): <a href="/reference/graphql-api/admin/object-types#paymentmethod">PaymentMethod</a>!</div>
|
|
442
|
+
|
|
443
|
+
|
|
444
|
+
<div class="graphql-code-line top-level">}</div>
|
|
445
|
+
</div>
|
|
446
|
+
|
|
447
|
+
## createProduct
|
|
448
|
+
<div class="graphql-code-block">
|
|
449
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
450
|
+
<div class="graphql-code-line top-level comment">Create a new Product</div>
|
|
451
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
452
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
453
|
+
<div class="graphql-code-line ">createProduct(input: <a href="/reference/graphql-api/admin/input-types#createproductinput">CreateProductInput</a>!): <a href="/reference/graphql-api/admin/object-types#product">Product</a>!</div>
|
|
454
|
+
|
|
455
|
+
|
|
456
|
+
<div class="graphql-code-line top-level">}</div>
|
|
457
|
+
</div>
|
|
458
|
+
|
|
459
|
+
## createProductOption
|
|
460
|
+
<div class="graphql-code-block">
|
|
461
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
462
|
+
<div class="graphql-code-line top-level comment">Create a new ProductOption within a ProductOptionGroup</div>
|
|
463
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
464
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
465
|
+
<div class="graphql-code-line ">createProductOption(input: <a href="/reference/graphql-api/admin/input-types#createproductoptioninput">CreateProductOptionInput</a>!): <a href="/reference/graphql-api/admin/object-types#productoption">ProductOption</a>!</div>
|
|
466
|
+
|
|
467
|
+
|
|
468
|
+
<div class="graphql-code-line top-level">}</div>
|
|
469
|
+
</div>
|
|
470
|
+
|
|
471
|
+
## createProductOptionGroup
|
|
472
|
+
<div class="graphql-code-block">
|
|
473
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
474
|
+
<div class="graphql-code-line top-level comment">Create a new ProductOptionGroup</div>
|
|
475
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
476
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
477
|
+
<div class="graphql-code-line ">createProductOptionGroup(input: <a href="/reference/graphql-api/admin/input-types#createproductoptiongroupinput">CreateProductOptionGroupInput</a>!): <a href="/reference/graphql-api/admin/object-types#productoptiongroup">ProductOptionGroup</a>!</div>
|
|
478
|
+
|
|
479
|
+
|
|
480
|
+
<div class="graphql-code-line top-level">}</div>
|
|
481
|
+
</div>
|
|
482
|
+
|
|
483
|
+
## createProductVariants
|
|
484
|
+
<div class="graphql-code-block">
|
|
485
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
486
|
+
<div class="graphql-code-line top-level comment">Create a set of ProductVariants based on the OptionGroups assigned to the given Product</div>
|
|
487
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
488
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
489
|
+
<div class="graphql-code-line ">createProductVariants(input: [<a href="/reference/graphql-api/admin/input-types#createproductvariantinput">CreateProductVariantInput</a>!]!): [<a href="/reference/graphql-api/admin/object-types#productvariant">ProductVariant</a>]!</div>
|
|
490
|
+
|
|
491
|
+
|
|
492
|
+
<div class="graphql-code-line top-level">}</div>
|
|
493
|
+
</div>
|
|
494
|
+
|
|
495
|
+
## createPromotion
|
|
496
|
+
<div class="graphql-code-block">
|
|
497
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
498
|
+
<div class="graphql-code-line ">createPromotion(input: <a href="/reference/graphql-api/admin/input-types#createpromotioninput">CreatePromotionInput</a>!): <a href="/reference/graphql-api/admin/object-types#createpromotionresult">CreatePromotionResult</a>!</div>
|
|
499
|
+
|
|
500
|
+
|
|
501
|
+
<div class="graphql-code-line top-level">}</div>
|
|
502
|
+
</div>
|
|
503
|
+
|
|
504
|
+
## createProvince
|
|
505
|
+
<div class="graphql-code-block">
|
|
506
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
507
|
+
<div class="graphql-code-line top-level comment">Create a new Province</div>
|
|
508
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
509
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
510
|
+
<div class="graphql-code-line ">createProvince(input: <a href="/reference/graphql-api/admin/input-types#createprovinceinput">CreateProvinceInput</a>!): <a href="/reference/graphql-api/admin/object-types#province">Province</a>!</div>
|
|
511
|
+
|
|
512
|
+
|
|
513
|
+
<div class="graphql-code-line top-level">}</div>
|
|
514
|
+
</div>
|
|
515
|
+
|
|
516
|
+
## createRole
|
|
517
|
+
<div class="graphql-code-block">
|
|
518
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
519
|
+
<div class="graphql-code-line top-level comment">Create a new Role</div>
|
|
520
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
521
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
522
|
+
<div class="graphql-code-line ">createRole(input: <a href="/reference/graphql-api/admin/input-types#createroleinput">CreateRoleInput</a>!): <a href="/reference/graphql-api/admin/object-types#role">Role</a>!</div>
|
|
523
|
+
|
|
524
|
+
|
|
525
|
+
<div class="graphql-code-line top-level">}</div>
|
|
526
|
+
</div>
|
|
527
|
+
|
|
528
|
+
## createSeller
|
|
529
|
+
<div class="graphql-code-block">
|
|
530
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
531
|
+
<div class="graphql-code-line top-level comment">Create a new Seller</div>
|
|
532
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
533
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
534
|
+
<div class="graphql-code-line ">createSeller(input: <a href="/reference/graphql-api/admin/input-types#createsellerinput">CreateSellerInput</a>!): <a href="/reference/graphql-api/admin/object-types#seller">Seller</a>!</div>
|
|
535
|
+
|
|
536
|
+
|
|
537
|
+
<div class="graphql-code-line top-level">}</div>
|
|
538
|
+
</div>
|
|
539
|
+
|
|
540
|
+
## createShippingMethod
|
|
541
|
+
<div class="graphql-code-block">
|
|
542
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
543
|
+
<div class="graphql-code-line top-level comment">Create a new ShippingMethod</div>
|
|
544
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
545
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
546
|
+
<div class="graphql-code-line ">createShippingMethod(input: <a href="/reference/graphql-api/admin/input-types#createshippingmethodinput">CreateShippingMethodInput</a>!): <a href="/reference/graphql-api/admin/object-types#shippingmethod">ShippingMethod</a>!</div>
|
|
547
|
+
|
|
548
|
+
|
|
549
|
+
<div class="graphql-code-line top-level">}</div>
|
|
550
|
+
</div>
|
|
551
|
+
|
|
552
|
+
## createStockLocation
|
|
553
|
+
<div class="graphql-code-block">
|
|
554
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
555
|
+
<div class="graphql-code-line ">createStockLocation(input: <a href="/reference/graphql-api/admin/input-types#createstocklocationinput">CreateStockLocationInput</a>!): <a href="/reference/graphql-api/admin/object-types#stocklocation">StockLocation</a>!</div>
|
|
556
|
+
|
|
557
|
+
|
|
558
|
+
<div class="graphql-code-line top-level">}</div>
|
|
559
|
+
</div>
|
|
560
|
+
|
|
561
|
+
## createTag
|
|
562
|
+
<div class="graphql-code-block">
|
|
563
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
564
|
+
<div class="graphql-code-line top-level comment">Create a new Tag</div>
|
|
565
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
566
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
567
|
+
<div class="graphql-code-line ">createTag(input: <a href="/reference/graphql-api/admin/input-types#createtaginput">CreateTagInput</a>!): <a href="/reference/graphql-api/admin/object-types#tag">Tag</a>!</div>
|
|
568
|
+
|
|
569
|
+
|
|
570
|
+
<div class="graphql-code-line top-level">}</div>
|
|
571
|
+
</div>
|
|
572
|
+
|
|
573
|
+
## createTaxCategory
|
|
574
|
+
<div class="graphql-code-block">
|
|
575
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
576
|
+
<div class="graphql-code-line top-level comment">Create a new TaxCategory</div>
|
|
577
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
578
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
579
|
+
<div class="graphql-code-line ">createTaxCategory(input: <a href="/reference/graphql-api/admin/input-types#createtaxcategoryinput">CreateTaxCategoryInput</a>!): <a href="/reference/graphql-api/admin/object-types#taxcategory">TaxCategory</a>!</div>
|
|
580
|
+
|
|
581
|
+
|
|
582
|
+
<div class="graphql-code-line top-level">}</div>
|
|
583
|
+
</div>
|
|
584
|
+
|
|
585
|
+
## createTaxRate
|
|
586
|
+
<div class="graphql-code-block">
|
|
587
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
588
|
+
<div class="graphql-code-line top-level comment">Create a new TaxRate</div>
|
|
589
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
590
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
591
|
+
<div class="graphql-code-line ">createTaxRate(input: <a href="/reference/graphql-api/admin/input-types#createtaxrateinput">CreateTaxRateInput</a>!): <a href="/reference/graphql-api/admin/object-types#taxrate">TaxRate</a>!</div>
|
|
592
|
+
|
|
593
|
+
|
|
594
|
+
<div class="graphql-code-line top-level">}</div>
|
|
595
|
+
</div>
|
|
596
|
+
|
|
597
|
+
## createZone
|
|
598
|
+
<div class="graphql-code-block">
|
|
599
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
600
|
+
<div class="graphql-code-line top-level comment">Create a new Zone</div>
|
|
601
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
602
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
603
|
+
<div class="graphql-code-line ">createZone(input: <a href="/reference/graphql-api/admin/input-types#createzoneinput">CreateZoneInput</a>!): <a href="/reference/graphql-api/admin/object-types#zone">Zone</a>!</div>
|
|
604
|
+
|
|
605
|
+
|
|
606
|
+
<div class="graphql-code-line top-level">}</div>
|
|
607
|
+
</div>
|
|
608
|
+
|
|
609
|
+
## deleteAdministrator
|
|
610
|
+
<div class="graphql-code-block">
|
|
611
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
612
|
+
<div class="graphql-code-line top-level comment">Delete an Administrator</div>
|
|
613
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
614
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
615
|
+
<div class="graphql-code-line ">deleteAdministrator(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!</div>
|
|
616
|
+
|
|
617
|
+
|
|
618
|
+
<div class="graphql-code-line top-level">}</div>
|
|
619
|
+
</div>
|
|
620
|
+
|
|
621
|
+
## deleteAdministrators
|
|
622
|
+
<div class="graphql-code-block">
|
|
623
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
624
|
+
<div class="graphql-code-line top-level comment">Delete multiple Administrators</div>
|
|
625
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
626
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
627
|
+
<div class="graphql-code-line ">deleteAdministrators(ids: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]!): [<a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!]!</div>
|
|
628
|
+
|
|
629
|
+
|
|
630
|
+
<div class="graphql-code-line top-level">}</div>
|
|
631
|
+
</div>
|
|
632
|
+
|
|
633
|
+
## deleteAsset
|
|
634
|
+
<div class="graphql-code-block">
|
|
635
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
636
|
+
<div class="graphql-code-line top-level comment">Delete an Asset</div>
|
|
637
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
638
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
639
|
+
<div class="graphql-code-line ">deleteAsset(input: <a href="/reference/graphql-api/admin/input-types#deleteassetinput">DeleteAssetInput</a>!): <a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!</div>
|
|
640
|
+
|
|
641
|
+
|
|
642
|
+
<div class="graphql-code-line top-level">}</div>
|
|
643
|
+
</div>
|
|
644
|
+
|
|
645
|
+
## deleteAssets
|
|
646
|
+
<div class="graphql-code-block">
|
|
647
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
648
|
+
<div class="graphql-code-line top-level comment">Delete multiple Assets</div>
|
|
649
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
650
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
651
|
+
<div class="graphql-code-line ">deleteAssets(input: <a href="/reference/graphql-api/admin/input-types#deleteassetsinput">DeleteAssetsInput</a>!): <a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!</div>
|
|
652
|
+
|
|
653
|
+
|
|
654
|
+
<div class="graphql-code-line top-level">}</div>
|
|
655
|
+
</div>
|
|
656
|
+
|
|
657
|
+
## deleteChannel
|
|
658
|
+
<div class="graphql-code-block">
|
|
659
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
660
|
+
<div class="graphql-code-line top-level comment">Delete a Channel</div>
|
|
661
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
662
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
663
|
+
<div class="graphql-code-line ">deleteChannel(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!</div>
|
|
664
|
+
|
|
665
|
+
|
|
666
|
+
<div class="graphql-code-line top-level">}</div>
|
|
667
|
+
</div>
|
|
668
|
+
|
|
669
|
+
## deleteChannels
|
|
670
|
+
<div class="graphql-code-block">
|
|
671
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
672
|
+
<div class="graphql-code-line top-level comment">Delete multiple Channels</div>
|
|
673
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
674
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
675
|
+
<div class="graphql-code-line ">deleteChannels(ids: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]!): [<a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!]!</div>
|
|
676
|
+
|
|
677
|
+
|
|
678
|
+
<div class="graphql-code-line top-level">}</div>
|
|
679
|
+
</div>
|
|
680
|
+
|
|
681
|
+
## deleteCollection
|
|
682
|
+
<div class="graphql-code-block">
|
|
683
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
684
|
+
<div class="graphql-code-line top-level comment">Delete a Collection and all of its descendants</div>
|
|
685
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
686
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
687
|
+
<div class="graphql-code-line ">deleteCollection(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!</div>
|
|
688
|
+
|
|
689
|
+
|
|
690
|
+
<div class="graphql-code-line top-level">}</div>
|
|
691
|
+
</div>
|
|
692
|
+
|
|
693
|
+
## deleteCollections
|
|
694
|
+
<div class="graphql-code-block">
|
|
695
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
696
|
+
<div class="graphql-code-line top-level comment">Delete multiple Collections and all of their descendants</div>
|
|
697
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
698
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
699
|
+
<div class="graphql-code-line ">deleteCollections(ids: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]!): [<a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!]!</div>
|
|
700
|
+
|
|
701
|
+
|
|
702
|
+
<div class="graphql-code-line top-level">}</div>
|
|
703
|
+
</div>
|
|
704
|
+
|
|
705
|
+
## deleteCountries
|
|
706
|
+
<div class="graphql-code-block">
|
|
707
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
708
|
+
<div class="graphql-code-line top-level comment">Delete multiple Countries</div>
|
|
709
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
710
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
711
|
+
<div class="graphql-code-line ">deleteCountries(ids: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]!): [<a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!]!</div>
|
|
712
|
+
|
|
713
|
+
|
|
714
|
+
<div class="graphql-code-line top-level">}</div>
|
|
715
|
+
</div>
|
|
716
|
+
|
|
717
|
+
## deleteCountry
|
|
718
|
+
<div class="graphql-code-block">
|
|
719
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
720
|
+
<div class="graphql-code-line top-level comment">Delete a Country</div>
|
|
721
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
722
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
723
|
+
<div class="graphql-code-line ">deleteCountry(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!</div>
|
|
724
|
+
|
|
725
|
+
|
|
726
|
+
<div class="graphql-code-line top-level">}</div>
|
|
727
|
+
</div>
|
|
728
|
+
|
|
729
|
+
## deleteCustomer
|
|
730
|
+
<div class="graphql-code-block">
|
|
731
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
732
|
+
<div class="graphql-code-line top-level comment">Delete a Customer</div>
|
|
733
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
734
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
735
|
+
<div class="graphql-code-line ">deleteCustomer(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!</div>
|
|
736
|
+
|
|
737
|
+
|
|
738
|
+
<div class="graphql-code-line top-level">}</div>
|
|
739
|
+
</div>
|
|
740
|
+
|
|
741
|
+
## deleteCustomerAddress
|
|
742
|
+
<div class="graphql-code-block">
|
|
743
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
744
|
+
<div class="graphql-code-line top-level comment">Update an existing Address</div>
|
|
745
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
746
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
747
|
+
<div class="graphql-code-line ">deleteCustomerAddress(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#success">Success</a>!</div>
|
|
748
|
+
|
|
749
|
+
|
|
750
|
+
<div class="graphql-code-line top-level">}</div>
|
|
751
|
+
</div>
|
|
752
|
+
|
|
753
|
+
## deleteCustomerGroup
|
|
754
|
+
<div class="graphql-code-block">
|
|
755
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
756
|
+
<div class="graphql-code-line top-level comment">Delete a CustomerGroup</div>
|
|
757
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
758
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
759
|
+
<div class="graphql-code-line ">deleteCustomerGroup(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!</div>
|
|
760
|
+
|
|
761
|
+
|
|
762
|
+
<div class="graphql-code-line top-level">}</div>
|
|
763
|
+
</div>
|
|
764
|
+
|
|
765
|
+
## deleteCustomerGroups
|
|
766
|
+
<div class="graphql-code-block">
|
|
767
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
768
|
+
<div class="graphql-code-line top-level comment">Delete multiple CustomerGroups</div>
|
|
769
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
770
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
771
|
+
<div class="graphql-code-line ">deleteCustomerGroups(ids: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]!): [<a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!]!</div>
|
|
772
|
+
|
|
773
|
+
|
|
774
|
+
<div class="graphql-code-line top-level">}</div>
|
|
775
|
+
</div>
|
|
776
|
+
|
|
777
|
+
## deleteCustomerNote
|
|
778
|
+
<div class="graphql-code-block">
|
|
779
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
780
|
+
<div class="graphql-code-line ">deleteCustomerNote(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!</div>
|
|
781
|
+
|
|
782
|
+
|
|
783
|
+
<div class="graphql-code-line top-level">}</div>
|
|
784
|
+
</div>
|
|
785
|
+
|
|
786
|
+
## deleteCustomers
|
|
787
|
+
<div class="graphql-code-block">
|
|
788
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
789
|
+
<div class="graphql-code-line top-level comment">Deletes Customers</div>
|
|
790
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
791
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
792
|
+
<div class="graphql-code-line ">deleteCustomers(ids: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]!): [<a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!]!</div>
|
|
793
|
+
|
|
794
|
+
|
|
795
|
+
<div class="graphql-code-line top-level">}</div>
|
|
796
|
+
</div>
|
|
797
|
+
|
|
798
|
+
## deleteDraftOrder
|
|
799
|
+
<div class="graphql-code-block">
|
|
800
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
801
|
+
<div class="graphql-code-line top-level comment">Deletes a draft Order</div>
|
|
802
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
803
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
804
|
+
<div class="graphql-code-line ">deleteDraftOrder(orderId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!</div>
|
|
805
|
+
|
|
806
|
+
|
|
807
|
+
<div class="graphql-code-line top-level">}</div>
|
|
808
|
+
</div>
|
|
809
|
+
|
|
810
|
+
## deleteFacet
|
|
811
|
+
<div class="graphql-code-block">
|
|
812
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
813
|
+
<div class="graphql-code-line top-level comment">Delete an existing Facet</div>
|
|
814
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
815
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
816
|
+
<div class="graphql-code-line ">deleteFacet(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!, force: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a>): <a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!</div>
|
|
817
|
+
|
|
818
|
+
|
|
819
|
+
<div class="graphql-code-line top-level">}</div>
|
|
820
|
+
</div>
|
|
821
|
+
|
|
822
|
+
## deleteFacetValues
|
|
823
|
+
<div class="graphql-code-block">
|
|
824
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
825
|
+
<div class="graphql-code-line top-level comment">Delete one or more FacetValues</div>
|
|
826
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
827
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
828
|
+
<div class="graphql-code-line ">deleteFacetValues(ids: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]!, force: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a>): [<a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!]!</div>
|
|
829
|
+
|
|
830
|
+
|
|
831
|
+
<div class="graphql-code-line top-level">}</div>
|
|
832
|
+
</div>
|
|
833
|
+
|
|
834
|
+
## deleteFacets
|
|
835
|
+
<div class="graphql-code-block">
|
|
836
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
837
|
+
<div class="graphql-code-line top-level comment">Delete multiple existing Facets</div>
|
|
838
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
839
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
840
|
+
<div class="graphql-code-line ">deleteFacets(ids: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]!, force: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a>): [<a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!]!</div>
|
|
841
|
+
|
|
842
|
+
|
|
843
|
+
<div class="graphql-code-line top-level">}</div>
|
|
844
|
+
</div>
|
|
845
|
+
|
|
846
|
+
## deleteOrderNote
|
|
847
|
+
<div class="graphql-code-block">
|
|
848
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
849
|
+
<div class="graphql-code-line ">deleteOrderNote(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!</div>
|
|
850
|
+
|
|
851
|
+
|
|
852
|
+
<div class="graphql-code-line top-level">}</div>
|
|
853
|
+
</div>
|
|
854
|
+
|
|
855
|
+
## deletePaymentMethod
|
|
856
|
+
<div class="graphql-code-block">
|
|
857
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
858
|
+
<div class="graphql-code-line top-level comment">Delete a PaymentMethod</div>
|
|
859
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
860
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
861
|
+
<div class="graphql-code-line ">deletePaymentMethod(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!, force: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a>): <a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!</div>
|
|
862
|
+
|
|
863
|
+
|
|
864
|
+
<div class="graphql-code-line top-level">}</div>
|
|
865
|
+
</div>
|
|
866
|
+
|
|
867
|
+
## deletePaymentMethods
|
|
868
|
+
<div class="graphql-code-block">
|
|
869
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
870
|
+
<div class="graphql-code-line top-level comment">Delete multiple PaymentMethods</div>
|
|
871
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
872
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
873
|
+
<div class="graphql-code-line ">deletePaymentMethods(ids: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]!, force: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a>): [<a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!]!</div>
|
|
874
|
+
|
|
875
|
+
|
|
876
|
+
<div class="graphql-code-line top-level">}</div>
|
|
877
|
+
</div>
|
|
878
|
+
|
|
879
|
+
## deleteProduct
|
|
880
|
+
<div class="graphql-code-block">
|
|
881
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
882
|
+
<div class="graphql-code-line top-level comment">Delete a Product</div>
|
|
883
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
884
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
885
|
+
<div class="graphql-code-line ">deleteProduct(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!</div>
|
|
886
|
+
|
|
887
|
+
|
|
888
|
+
<div class="graphql-code-line top-level">}</div>
|
|
889
|
+
</div>
|
|
890
|
+
|
|
891
|
+
## deleteProductOption
|
|
892
|
+
<div class="graphql-code-block">
|
|
893
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
894
|
+
<div class="graphql-code-line top-level comment">Delete a ProductOption</div>
|
|
895
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
896
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
897
|
+
<div class="graphql-code-line ">deleteProductOption(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!</div>
|
|
898
|
+
|
|
899
|
+
|
|
900
|
+
<div class="graphql-code-line top-level">}</div>
|
|
901
|
+
</div>
|
|
902
|
+
|
|
903
|
+
## deleteProductVariant
|
|
904
|
+
<div class="graphql-code-block">
|
|
905
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
906
|
+
<div class="graphql-code-line top-level comment">Delete a ProductVariant</div>
|
|
907
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
908
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
909
|
+
<div class="graphql-code-line ">deleteProductVariant(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!</div>
|
|
910
|
+
|
|
911
|
+
|
|
912
|
+
<div class="graphql-code-line top-level">}</div>
|
|
913
|
+
</div>
|
|
914
|
+
|
|
915
|
+
## deleteProductVariants
|
|
916
|
+
<div class="graphql-code-block">
|
|
917
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
918
|
+
<div class="graphql-code-line top-level comment">Delete multiple ProductVariants</div>
|
|
919
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
920
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
921
|
+
<div class="graphql-code-line ">deleteProductVariants(ids: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]!): [<a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!]!</div>
|
|
922
|
+
|
|
923
|
+
|
|
924
|
+
<div class="graphql-code-line top-level">}</div>
|
|
925
|
+
</div>
|
|
926
|
+
|
|
927
|
+
## deleteProducts
|
|
928
|
+
<div class="graphql-code-block">
|
|
929
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
930
|
+
<div class="graphql-code-line top-level comment">Delete multiple Products</div>
|
|
931
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
932
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
933
|
+
<div class="graphql-code-line ">deleteProducts(ids: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]!): [<a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!]!</div>
|
|
934
|
+
|
|
935
|
+
|
|
936
|
+
<div class="graphql-code-line top-level">}</div>
|
|
937
|
+
</div>
|
|
938
|
+
|
|
939
|
+
## deletePromotion
|
|
940
|
+
<div class="graphql-code-block">
|
|
941
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
942
|
+
<div class="graphql-code-line ">deletePromotion(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!</div>
|
|
943
|
+
|
|
944
|
+
|
|
945
|
+
<div class="graphql-code-line top-level">}</div>
|
|
946
|
+
</div>
|
|
947
|
+
|
|
948
|
+
## deletePromotions
|
|
949
|
+
<div class="graphql-code-block">
|
|
950
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
951
|
+
<div class="graphql-code-line ">deletePromotions(ids: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]!): [<a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!]!</div>
|
|
952
|
+
|
|
953
|
+
|
|
954
|
+
<div class="graphql-code-line top-level">}</div>
|
|
955
|
+
</div>
|
|
956
|
+
|
|
957
|
+
## deleteProvince
|
|
958
|
+
<div class="graphql-code-block">
|
|
959
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
960
|
+
<div class="graphql-code-line top-level comment">Delete a Province</div>
|
|
961
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
962
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
963
|
+
<div class="graphql-code-line ">deleteProvince(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!</div>
|
|
964
|
+
|
|
965
|
+
|
|
966
|
+
<div class="graphql-code-line top-level">}</div>
|
|
967
|
+
</div>
|
|
968
|
+
|
|
969
|
+
## deleteRole
|
|
970
|
+
<div class="graphql-code-block">
|
|
971
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
972
|
+
<div class="graphql-code-line top-level comment">Delete an existing Role</div>
|
|
973
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
974
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
975
|
+
<div class="graphql-code-line ">deleteRole(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!</div>
|
|
976
|
+
|
|
977
|
+
|
|
978
|
+
<div class="graphql-code-line top-level">}</div>
|
|
979
|
+
</div>
|
|
980
|
+
|
|
981
|
+
## deleteRoles
|
|
982
|
+
<div class="graphql-code-block">
|
|
983
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
984
|
+
<div class="graphql-code-line top-level comment">Delete multiple Roles</div>
|
|
985
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
986
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
987
|
+
<div class="graphql-code-line ">deleteRoles(ids: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]!): [<a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!]!</div>
|
|
988
|
+
|
|
989
|
+
|
|
990
|
+
<div class="graphql-code-line top-level">}</div>
|
|
991
|
+
</div>
|
|
992
|
+
|
|
993
|
+
## deleteSeller
|
|
994
|
+
<div class="graphql-code-block">
|
|
995
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
996
|
+
<div class="graphql-code-line top-level comment">Delete a Seller</div>
|
|
997
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
998
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
999
|
+
<div class="graphql-code-line ">deleteSeller(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!</div>
|
|
1000
|
+
|
|
1001
|
+
|
|
1002
|
+
<div class="graphql-code-line top-level">}</div>
|
|
1003
|
+
</div>
|
|
1004
|
+
|
|
1005
|
+
## deleteSellers
|
|
1006
|
+
<div class="graphql-code-block">
|
|
1007
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1008
|
+
<div class="graphql-code-line top-level comment">Delete multiple Sellers</div>
|
|
1009
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1010
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
1011
|
+
<div class="graphql-code-line ">deleteSellers(ids: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]!): [<a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!]!</div>
|
|
1012
|
+
|
|
1013
|
+
|
|
1014
|
+
<div class="graphql-code-line top-level">}</div>
|
|
1015
|
+
</div>
|
|
1016
|
+
|
|
1017
|
+
## deleteShippingMethod
|
|
1018
|
+
<div class="graphql-code-block">
|
|
1019
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1020
|
+
<div class="graphql-code-line top-level comment">Delete a ShippingMethod</div>
|
|
1021
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1022
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
1023
|
+
<div class="graphql-code-line ">deleteShippingMethod(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!</div>
|
|
1024
|
+
|
|
1025
|
+
|
|
1026
|
+
<div class="graphql-code-line top-level">}</div>
|
|
1027
|
+
</div>
|
|
1028
|
+
|
|
1029
|
+
## deleteShippingMethods
|
|
1030
|
+
<div class="graphql-code-block">
|
|
1031
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1032
|
+
<div class="graphql-code-line top-level comment">Delete multiple ShippingMethods</div>
|
|
1033
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1034
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
1035
|
+
<div class="graphql-code-line ">deleteShippingMethods(ids: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]!): [<a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!]!</div>
|
|
1036
|
+
|
|
1037
|
+
|
|
1038
|
+
<div class="graphql-code-line top-level">}</div>
|
|
1039
|
+
</div>
|
|
1040
|
+
|
|
1041
|
+
## deleteStockLocation
|
|
1042
|
+
<div class="graphql-code-block">
|
|
1043
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
1044
|
+
<div class="graphql-code-line ">deleteStockLocation(input: <a href="/reference/graphql-api/admin/input-types#deletestocklocationinput">DeleteStockLocationInput</a>!): <a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!</div>
|
|
1045
|
+
|
|
1046
|
+
|
|
1047
|
+
<div class="graphql-code-line top-level">}</div>
|
|
1048
|
+
</div>
|
|
1049
|
+
|
|
1050
|
+
## deleteStockLocations
|
|
1051
|
+
<div class="graphql-code-block">
|
|
1052
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
1053
|
+
<div class="graphql-code-line ">deleteStockLocations(input: [<a href="/reference/graphql-api/admin/input-types#deletestocklocationinput">DeleteStockLocationInput</a>!]!): [<a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!]!</div>
|
|
1054
|
+
|
|
1055
|
+
|
|
1056
|
+
<div class="graphql-code-line top-level">}</div>
|
|
1057
|
+
</div>
|
|
1058
|
+
|
|
1059
|
+
## deleteTag
|
|
1060
|
+
<div class="graphql-code-block">
|
|
1061
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1062
|
+
<div class="graphql-code-line top-level comment">Delete an existing Tag</div>
|
|
1063
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1064
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
1065
|
+
<div class="graphql-code-line ">deleteTag(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!</div>
|
|
1066
|
+
|
|
1067
|
+
|
|
1068
|
+
<div class="graphql-code-line top-level">}</div>
|
|
1069
|
+
</div>
|
|
1070
|
+
|
|
1071
|
+
## deleteTaxCategories
|
|
1072
|
+
<div class="graphql-code-block">
|
|
1073
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1074
|
+
<div class="graphql-code-line top-level comment">Deletes multiple TaxCategories</div>
|
|
1075
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1076
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
1077
|
+
<div class="graphql-code-line ">deleteTaxCategories(ids: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]!): [<a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!]!</div>
|
|
1078
|
+
|
|
1079
|
+
|
|
1080
|
+
<div class="graphql-code-line top-level">}</div>
|
|
1081
|
+
</div>
|
|
1082
|
+
|
|
1083
|
+
## deleteTaxCategory
|
|
1084
|
+
<div class="graphql-code-block">
|
|
1085
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1086
|
+
<div class="graphql-code-line top-level comment">Deletes a TaxCategory</div>
|
|
1087
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1088
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
1089
|
+
<div class="graphql-code-line ">deleteTaxCategory(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!</div>
|
|
1090
|
+
|
|
1091
|
+
|
|
1092
|
+
<div class="graphql-code-line top-level">}</div>
|
|
1093
|
+
</div>
|
|
1094
|
+
|
|
1095
|
+
## deleteTaxRate
|
|
1096
|
+
<div class="graphql-code-block">
|
|
1097
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1098
|
+
<div class="graphql-code-line top-level comment">Delete a TaxRate</div>
|
|
1099
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1100
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
1101
|
+
<div class="graphql-code-line ">deleteTaxRate(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!</div>
|
|
1102
|
+
|
|
1103
|
+
|
|
1104
|
+
<div class="graphql-code-line top-level">}</div>
|
|
1105
|
+
</div>
|
|
1106
|
+
|
|
1107
|
+
## deleteTaxRates
|
|
1108
|
+
<div class="graphql-code-block">
|
|
1109
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1110
|
+
<div class="graphql-code-line top-level comment">Delete multiple TaxRates</div>
|
|
1111
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1112
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
1113
|
+
<div class="graphql-code-line ">deleteTaxRates(ids: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]!): [<a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!]!</div>
|
|
1114
|
+
|
|
1115
|
+
|
|
1116
|
+
<div class="graphql-code-line top-level">}</div>
|
|
1117
|
+
</div>
|
|
1118
|
+
|
|
1119
|
+
## deleteZone
|
|
1120
|
+
<div class="graphql-code-block">
|
|
1121
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1122
|
+
<div class="graphql-code-line top-level comment">Delete a Zone</div>
|
|
1123
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1124
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
1125
|
+
<div class="graphql-code-line ">deleteZone(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!</div>
|
|
1126
|
+
|
|
1127
|
+
|
|
1128
|
+
<div class="graphql-code-line top-level">}</div>
|
|
1129
|
+
</div>
|
|
1130
|
+
|
|
1131
|
+
## deleteZones
|
|
1132
|
+
<div class="graphql-code-block">
|
|
1133
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1134
|
+
<div class="graphql-code-line top-level comment">Delete a Zone</div>
|
|
1135
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1136
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
1137
|
+
<div class="graphql-code-line ">deleteZones(ids: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]!): [<a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!]!</div>
|
|
1138
|
+
|
|
1139
|
+
|
|
1140
|
+
<div class="graphql-code-line top-level">}</div>
|
|
1141
|
+
</div>
|
|
1142
|
+
|
|
1143
|
+
## duplicateEntity
|
|
1144
|
+
<div class="graphql-code-block">
|
|
1145
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1146
|
+
<div class="graphql-code-line top-level comment">Duplicate an existing entity using a specific EntityDuplicator.</div>
|
|
1147
|
+
|
|
1148
|
+
<div class="graphql-code-line top-level comment">Since v2.2.0.</div>
|
|
1149
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1150
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
1151
|
+
<div class="graphql-code-line ">duplicateEntity(input: <a href="/reference/graphql-api/admin/input-types#duplicateentityinput">DuplicateEntityInput</a>!): <a href="/reference/graphql-api/admin/object-types#duplicateentityresult">DuplicateEntityResult</a>!</div>
|
|
1152
|
+
|
|
1153
|
+
|
|
1154
|
+
<div class="graphql-code-line top-level">}</div>
|
|
1155
|
+
</div>
|
|
1156
|
+
|
|
1157
|
+
## flushBufferedJobs
|
|
1158
|
+
<div class="graphql-code-block">
|
|
1159
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
1160
|
+
<div class="graphql-code-line ">flushBufferedJobs(bufferIds: [<a href="/reference/graphql-api/admin/object-types#string">String</a>!]): <a href="/reference/graphql-api/admin/object-types#success">Success</a>!</div>
|
|
1161
|
+
|
|
1162
|
+
|
|
1163
|
+
<div class="graphql-code-line top-level">}</div>
|
|
1164
|
+
</div>
|
|
1165
|
+
|
|
1166
|
+
## importProducts
|
|
1167
|
+
<div class="graphql-code-block">
|
|
1168
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
1169
|
+
<div class="graphql-code-line ">importProducts(csvFile: <a href="/reference/graphql-api/admin/object-types#upload">Upload</a>!): <a href="/reference/graphql-api/admin/object-types#importinfo">ImportInfo</a></div>
|
|
1170
|
+
|
|
1171
|
+
|
|
1172
|
+
<div class="graphql-code-line top-level">}</div>
|
|
1173
|
+
</div>
|
|
1174
|
+
|
|
1175
|
+
## login
|
|
1176
|
+
<div class="graphql-code-block">
|
|
1177
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1178
|
+
<div class="graphql-code-line top-level comment">Authenticates the user using the native authentication strategy. This mutation is an alias for authenticate({ native: { ... }})</div>
|
|
1179
|
+
|
|
1180
|
+
<div class="graphql-code-line top-level comment"></div>
|
|
1181
|
+
|
|
1182
|
+
<div class="graphql-code-line top-level comment">The <code>rememberMe</code> option applies when using cookie-based sessions, and if <code>true</code> it will set the maxAge of the session cookie</div>
|
|
1183
|
+
|
|
1184
|
+
<div class="graphql-code-line top-level comment">to 1 year.</div>
|
|
1185
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1186
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
1187
|
+
<div class="graphql-code-line ">login(username: <a href="/reference/graphql-api/admin/object-types#string">String</a>!, password: <a href="/reference/graphql-api/admin/object-types#string">String</a>!, rememberMe: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a>): <a href="/reference/graphql-api/admin/object-types#nativeauthenticationresult">NativeAuthenticationResult</a>!</div>
|
|
1188
|
+
|
|
1189
|
+
|
|
1190
|
+
<div class="graphql-code-line top-level">}</div>
|
|
1191
|
+
</div>
|
|
1192
|
+
|
|
1193
|
+
## logout
|
|
1194
|
+
<div class="graphql-code-block">
|
|
1195
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
1196
|
+
<div class="graphql-code-line ">logout: <a href="/reference/graphql-api/admin/object-types#success">Success</a>!</div>
|
|
1197
|
+
|
|
1198
|
+
|
|
1199
|
+
<div class="graphql-code-line top-level">}</div>
|
|
1200
|
+
</div>
|
|
1201
|
+
|
|
1202
|
+
## modifyOrder
|
|
1203
|
+
<div class="graphql-code-block">
|
|
1204
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1205
|
+
<div class="graphql-code-line top-level comment">Allows an Order to be modified after it has been completed by the Customer. The Order must first</div>
|
|
1206
|
+
|
|
1207
|
+
<div class="graphql-code-line top-level comment">be in the <code>Modifying</code> state.</div>
|
|
1208
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1209
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
1210
|
+
<div class="graphql-code-line ">modifyOrder(input: <a href="/reference/graphql-api/admin/input-types#modifyorderinput">ModifyOrderInput</a>!): <a href="/reference/graphql-api/admin/object-types#modifyorderresult">ModifyOrderResult</a>!</div>
|
|
1211
|
+
|
|
1212
|
+
|
|
1213
|
+
<div class="graphql-code-line top-level">}</div>
|
|
1214
|
+
</div>
|
|
1215
|
+
|
|
1216
|
+
## moveCollection
|
|
1217
|
+
<div class="graphql-code-block">
|
|
1218
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1219
|
+
<div class="graphql-code-line top-level comment">Move a Collection to a different parent or index</div>
|
|
1220
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1221
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
1222
|
+
<div class="graphql-code-line ">moveCollection(input: <a href="/reference/graphql-api/admin/input-types#movecollectioninput">MoveCollectionInput</a>!): <a href="/reference/graphql-api/admin/object-types#collection">Collection</a>!</div>
|
|
1223
|
+
|
|
1224
|
+
|
|
1225
|
+
<div class="graphql-code-line top-level">}</div>
|
|
1226
|
+
</div>
|
|
1227
|
+
|
|
1228
|
+
## refundOrder
|
|
1229
|
+
<div class="graphql-code-block">
|
|
1230
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
1231
|
+
<div class="graphql-code-line ">refundOrder(input: <a href="/reference/graphql-api/admin/input-types#refundorderinput">RefundOrderInput</a>!): <a href="/reference/graphql-api/admin/object-types#refundorderresult">RefundOrderResult</a>!</div>
|
|
1232
|
+
|
|
1233
|
+
|
|
1234
|
+
<div class="graphql-code-line top-level">}</div>
|
|
1235
|
+
</div>
|
|
1236
|
+
|
|
1237
|
+
## reindex
|
|
1238
|
+
<div class="graphql-code-block">
|
|
1239
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
1240
|
+
<div class="graphql-code-line ">reindex: <a href="/reference/graphql-api/admin/object-types#job">Job</a>!</div>
|
|
1241
|
+
|
|
1242
|
+
|
|
1243
|
+
<div class="graphql-code-line top-level">}</div>
|
|
1244
|
+
</div>
|
|
1245
|
+
|
|
1246
|
+
## removeCollectionsFromChannel
|
|
1247
|
+
<div class="graphql-code-block">
|
|
1248
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1249
|
+
<div class="graphql-code-line top-level comment">Removes Collections from the specified Channel</div>
|
|
1250
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1251
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
1252
|
+
<div class="graphql-code-line ">removeCollectionsFromChannel(input: <a href="/reference/graphql-api/admin/input-types#removecollectionsfromchannelinput">RemoveCollectionsFromChannelInput</a>!): [<a href="/reference/graphql-api/admin/object-types#collection">Collection</a>!]!</div>
|
|
1253
|
+
|
|
1254
|
+
|
|
1255
|
+
<div class="graphql-code-line top-level">}</div>
|
|
1256
|
+
</div>
|
|
1257
|
+
|
|
1258
|
+
## removeCouponCodeFromDraftOrder
|
|
1259
|
+
<div class="graphql-code-block">
|
|
1260
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1261
|
+
<div class="graphql-code-line top-level comment">Removes the given coupon code from the draft Order</div>
|
|
1262
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1263
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
1264
|
+
<div class="graphql-code-line ">removeCouponCodeFromDraftOrder(orderId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!, couponCode: <a href="/reference/graphql-api/admin/object-types#string">String</a>!): <a href="/reference/graphql-api/admin/object-types#order">Order</a></div>
|
|
1265
|
+
|
|
1266
|
+
|
|
1267
|
+
<div class="graphql-code-line top-level">}</div>
|
|
1268
|
+
</div>
|
|
1269
|
+
|
|
1270
|
+
## removeCustomersFromGroup
|
|
1271
|
+
<div class="graphql-code-block">
|
|
1272
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1273
|
+
<div class="graphql-code-line top-level comment">Remove Customers from a CustomerGroup</div>
|
|
1274
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1275
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
1276
|
+
<div class="graphql-code-line ">removeCustomersFromGroup(customerGroupId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!, customerIds: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]!): <a href="/reference/graphql-api/admin/object-types#customergroup">CustomerGroup</a>!</div>
|
|
1277
|
+
|
|
1278
|
+
|
|
1279
|
+
<div class="graphql-code-line top-level">}</div>
|
|
1280
|
+
</div>
|
|
1281
|
+
|
|
1282
|
+
## removeDraftOrderLine
|
|
1283
|
+
<div class="graphql-code-block">
|
|
1284
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1285
|
+
<div class="graphql-code-line top-level comment">Remove an OrderLine from the draft Order</div>
|
|
1286
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1287
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
1288
|
+
<div class="graphql-code-line ">removeDraftOrderLine(orderId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!, orderLineId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#removeorderitemsresult">RemoveOrderItemsResult</a>!</div>
|
|
1289
|
+
|
|
1290
|
+
|
|
1291
|
+
<div class="graphql-code-line top-level">}</div>
|
|
1292
|
+
</div>
|
|
1293
|
+
|
|
1294
|
+
## removeFacetsFromChannel
|
|
1295
|
+
<div class="graphql-code-block">
|
|
1296
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1297
|
+
<div class="graphql-code-line top-level comment">Removes Facets from the specified Channel</div>
|
|
1298
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1299
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
1300
|
+
<div class="graphql-code-line ">removeFacetsFromChannel(input: <a href="/reference/graphql-api/admin/input-types#removefacetsfromchannelinput">RemoveFacetsFromChannelInput</a>!): [<a href="/reference/graphql-api/admin/object-types#removefacetfromchannelresult">RemoveFacetFromChannelResult</a>!]!</div>
|
|
1301
|
+
|
|
1302
|
+
|
|
1303
|
+
<div class="graphql-code-line top-level">}</div>
|
|
1304
|
+
</div>
|
|
1305
|
+
|
|
1306
|
+
## removeMembersFromZone
|
|
1307
|
+
<div class="graphql-code-block">
|
|
1308
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1309
|
+
<div class="graphql-code-line top-level comment">Remove members from a Zone</div>
|
|
1310
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1311
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
1312
|
+
<div class="graphql-code-line ">removeMembersFromZone(zoneId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!, memberIds: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]!): <a href="/reference/graphql-api/admin/object-types#zone">Zone</a>!</div>
|
|
1313
|
+
|
|
1314
|
+
|
|
1315
|
+
<div class="graphql-code-line top-level">}</div>
|
|
1316
|
+
</div>
|
|
1317
|
+
|
|
1318
|
+
## removeOptionGroupFromProduct
|
|
1319
|
+
<div class="graphql-code-block">
|
|
1320
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1321
|
+
<div class="graphql-code-line top-level comment">Remove an OptionGroup from a Product. If the OptionGroup is in use by any ProductVariants</div>
|
|
1322
|
+
|
|
1323
|
+
<div class="graphql-code-line top-level comment">the mutation will return a ProductOptionInUseError, and the OptionGroup will not be removed.</div>
|
|
1324
|
+
|
|
1325
|
+
<div class="graphql-code-line top-level comment">Setting the <code>force</code> argument to <code>true</code> will override this and remove the OptionGroup anyway,</div>
|
|
1326
|
+
|
|
1327
|
+
<div class="graphql-code-line top-level comment">as well as removing any of the group's options from the Product's ProductVariants.</div>
|
|
1328
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1329
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
1330
|
+
<div class="graphql-code-line ">removeOptionGroupFromProduct(productId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!, optionGroupId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!, force: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a>): <a href="/reference/graphql-api/admin/object-types#removeoptiongroupfromproductresult">RemoveOptionGroupFromProductResult</a>!</div>
|
|
1331
|
+
|
|
1332
|
+
|
|
1333
|
+
<div class="graphql-code-line top-level">}</div>
|
|
1334
|
+
</div>
|
|
1335
|
+
|
|
1336
|
+
## removePaymentMethodsFromChannel
|
|
1337
|
+
<div class="graphql-code-block">
|
|
1338
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1339
|
+
<div class="graphql-code-line top-level comment">Removes PaymentMethods from the specified Channel</div>
|
|
1340
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1341
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
1342
|
+
<div class="graphql-code-line ">removePaymentMethodsFromChannel(input: <a href="/reference/graphql-api/admin/input-types#removepaymentmethodsfromchannelinput">RemovePaymentMethodsFromChannelInput</a>!): [<a href="/reference/graphql-api/admin/object-types#paymentmethod">PaymentMethod</a>!]!</div>
|
|
1343
|
+
|
|
1344
|
+
|
|
1345
|
+
<div class="graphql-code-line top-level">}</div>
|
|
1346
|
+
</div>
|
|
1347
|
+
|
|
1348
|
+
## removeProductVariantsFromChannel
|
|
1349
|
+
<div class="graphql-code-block">
|
|
1350
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1351
|
+
<div class="graphql-code-line top-level comment">Removes ProductVariants from the specified Channel</div>
|
|
1352
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1353
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
1354
|
+
<div class="graphql-code-line ">removeProductVariantsFromChannel(input: <a href="/reference/graphql-api/admin/input-types#removeproductvariantsfromchannelinput">RemoveProductVariantsFromChannelInput</a>!): [<a href="/reference/graphql-api/admin/object-types#productvariant">ProductVariant</a>!]!</div>
|
|
1355
|
+
|
|
1356
|
+
|
|
1357
|
+
<div class="graphql-code-line top-level">}</div>
|
|
1358
|
+
</div>
|
|
1359
|
+
|
|
1360
|
+
## removeProductsFromChannel
|
|
1361
|
+
<div class="graphql-code-block">
|
|
1362
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1363
|
+
<div class="graphql-code-line top-level comment">Removes all ProductVariants of Product from the specified Channel</div>
|
|
1364
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1365
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
1366
|
+
<div class="graphql-code-line ">removeProductsFromChannel(input: <a href="/reference/graphql-api/admin/input-types#removeproductsfromchannelinput">RemoveProductsFromChannelInput</a>!): [<a href="/reference/graphql-api/admin/object-types#product">Product</a>!]!</div>
|
|
1367
|
+
|
|
1368
|
+
|
|
1369
|
+
<div class="graphql-code-line top-level">}</div>
|
|
1370
|
+
</div>
|
|
1371
|
+
|
|
1372
|
+
## removePromotionsFromChannel
|
|
1373
|
+
<div class="graphql-code-block">
|
|
1374
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1375
|
+
<div class="graphql-code-line top-level comment">Removes Promotions from the specified Channel</div>
|
|
1376
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1377
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
1378
|
+
<div class="graphql-code-line ">removePromotionsFromChannel(input: <a href="/reference/graphql-api/admin/input-types#removepromotionsfromchannelinput">RemovePromotionsFromChannelInput</a>!): [<a href="/reference/graphql-api/admin/object-types#promotion">Promotion</a>!]!</div>
|
|
1379
|
+
|
|
1380
|
+
|
|
1381
|
+
<div class="graphql-code-line top-level">}</div>
|
|
1382
|
+
</div>
|
|
1383
|
+
|
|
1384
|
+
## removeSettledJobs
|
|
1385
|
+
<div class="graphql-code-block">
|
|
1386
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1387
|
+
<div class="graphql-code-line top-level comment">Remove all settled jobs in the given queues older than the given date. Returns the number of jobs deleted.</div>
|
|
1388
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1389
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
1390
|
+
<div class="graphql-code-line ">removeSettledJobs(queueNames: [<a href="/reference/graphql-api/admin/object-types#string">String</a>!], olderThan: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>): <a href="/reference/graphql-api/admin/object-types#int">Int</a>!</div>
|
|
1391
|
+
|
|
1392
|
+
|
|
1393
|
+
<div class="graphql-code-line top-level">}</div>
|
|
1394
|
+
</div>
|
|
1395
|
+
|
|
1396
|
+
## removeShippingMethodsFromChannel
|
|
1397
|
+
<div class="graphql-code-block">
|
|
1398
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1399
|
+
<div class="graphql-code-line top-level comment">Removes ShippingMethods from the specified Channel</div>
|
|
1400
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1401
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
1402
|
+
<div class="graphql-code-line ">removeShippingMethodsFromChannel(input: <a href="/reference/graphql-api/admin/input-types#removeshippingmethodsfromchannelinput">RemoveShippingMethodsFromChannelInput</a>!): [<a href="/reference/graphql-api/admin/object-types#shippingmethod">ShippingMethod</a>!]!</div>
|
|
1403
|
+
|
|
1404
|
+
|
|
1405
|
+
<div class="graphql-code-line top-level">}</div>
|
|
1406
|
+
</div>
|
|
1407
|
+
|
|
1408
|
+
## removeStockLocationsFromChannel
|
|
1409
|
+
<div class="graphql-code-block">
|
|
1410
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1411
|
+
<div class="graphql-code-line top-level comment">Removes StockLocations from the specified Channel</div>
|
|
1412
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1413
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
1414
|
+
<div class="graphql-code-line ">removeStockLocationsFromChannel(input: <a href="/reference/graphql-api/admin/input-types#removestocklocationsfromchannelinput">RemoveStockLocationsFromChannelInput</a>!): [<a href="/reference/graphql-api/admin/object-types#stocklocation">StockLocation</a>!]!</div>
|
|
1415
|
+
|
|
1416
|
+
|
|
1417
|
+
<div class="graphql-code-line top-level">}</div>
|
|
1418
|
+
</div>
|
|
1419
|
+
|
|
1420
|
+
## runPendingSearchIndexUpdates
|
|
1421
|
+
<div class="graphql-code-block">
|
|
1422
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
1423
|
+
<div class="graphql-code-line ">runPendingSearchIndexUpdates: <a href="/reference/graphql-api/admin/object-types#success">Success</a>!</div>
|
|
1424
|
+
|
|
1425
|
+
|
|
1426
|
+
<div class="graphql-code-line top-level">}</div>
|
|
1427
|
+
</div>
|
|
1428
|
+
|
|
1429
|
+
## runScheduledTask
|
|
1430
|
+
<div class="graphql-code-block">
|
|
1431
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
1432
|
+
<div class="graphql-code-line ">runScheduledTask(id: <a href="/reference/graphql-api/admin/object-types#string">String</a>!): <a href="/reference/graphql-api/admin/object-types#success">Success</a>!</div>
|
|
1433
|
+
|
|
1434
|
+
|
|
1435
|
+
<div class="graphql-code-line top-level">}</div>
|
|
1436
|
+
</div>
|
|
1437
|
+
|
|
1438
|
+
## setCustomerForDraftOrder
|
|
1439
|
+
<div class="graphql-code-block">
|
|
1440
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
1441
|
+
<div class="graphql-code-line ">setCustomerForDraftOrder(orderId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!, customerId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>, input: <a href="/reference/graphql-api/admin/input-types#createcustomerinput">CreateCustomerInput</a>): <a href="/reference/graphql-api/admin/object-types#setcustomerfordraftorderresult">SetCustomerForDraftOrderResult</a>!</div>
|
|
1442
|
+
|
|
1443
|
+
|
|
1444
|
+
<div class="graphql-code-line top-level">}</div>
|
|
1445
|
+
</div>
|
|
1446
|
+
|
|
1447
|
+
## setDraftOrderBillingAddress
|
|
1448
|
+
<div class="graphql-code-block">
|
|
1449
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1450
|
+
<div class="graphql-code-line top-level comment">Sets the billing address for a draft Order</div>
|
|
1451
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1452
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
1453
|
+
<div class="graphql-code-line ">setDraftOrderBillingAddress(orderId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!, input: <a href="/reference/graphql-api/admin/input-types#createaddressinput">CreateAddressInput</a>!): <a href="/reference/graphql-api/admin/object-types#order">Order</a>!</div>
|
|
1454
|
+
|
|
1455
|
+
|
|
1456
|
+
<div class="graphql-code-line top-level">}</div>
|
|
1457
|
+
</div>
|
|
1458
|
+
|
|
1459
|
+
## setDraftOrderCustomFields
|
|
1460
|
+
<div class="graphql-code-block">
|
|
1461
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1462
|
+
<div class="graphql-code-line top-level comment">Allows any custom fields to be set for the active order</div>
|
|
1463
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1464
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
1465
|
+
<div class="graphql-code-line ">setDraftOrderCustomFields(orderId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!, input: <a href="/reference/graphql-api/admin/input-types#updateorderinput">UpdateOrderInput</a>!): <a href="/reference/graphql-api/admin/object-types#order">Order</a>!</div>
|
|
1466
|
+
|
|
1467
|
+
|
|
1468
|
+
<div class="graphql-code-line top-level">}</div>
|
|
1469
|
+
</div>
|
|
1470
|
+
|
|
1471
|
+
## setDraftOrderShippingAddress
|
|
1472
|
+
<div class="graphql-code-block">
|
|
1473
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1474
|
+
<div class="graphql-code-line top-level comment">Sets the shipping address for a draft Order</div>
|
|
1475
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1476
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
1477
|
+
<div class="graphql-code-line ">setDraftOrderShippingAddress(orderId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!, input: <a href="/reference/graphql-api/admin/input-types#createaddressinput">CreateAddressInput</a>!): <a href="/reference/graphql-api/admin/object-types#order">Order</a>!</div>
|
|
1478
|
+
|
|
1479
|
+
|
|
1480
|
+
<div class="graphql-code-line top-level">}</div>
|
|
1481
|
+
</div>
|
|
1482
|
+
|
|
1483
|
+
## setDraftOrderShippingMethod
|
|
1484
|
+
<div class="graphql-code-block">
|
|
1485
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1486
|
+
<div class="graphql-code-line top-level comment">Sets the shipping method by id, which can be obtained with the <code>eligibleShippingMethodsForDraftOrder</code> query</div>
|
|
1487
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1488
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
1489
|
+
<div class="graphql-code-line ">setDraftOrderShippingMethod(orderId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!, shippingMethodId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#setordershippingmethodresult">SetOrderShippingMethodResult</a>!</div>
|
|
1490
|
+
|
|
1491
|
+
|
|
1492
|
+
<div class="graphql-code-line top-level">}</div>
|
|
1493
|
+
</div>
|
|
1494
|
+
|
|
1495
|
+
## setOrderCustomFields
|
|
1496
|
+
<div class="graphql-code-block">
|
|
1497
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
1498
|
+
<div class="graphql-code-line ">setOrderCustomFields(input: <a href="/reference/graphql-api/admin/input-types#updateorderinput">UpdateOrderInput</a>!): <a href="/reference/graphql-api/admin/object-types#order">Order</a></div>
|
|
1499
|
+
|
|
1500
|
+
|
|
1501
|
+
<div class="graphql-code-line top-level">}</div>
|
|
1502
|
+
</div>
|
|
1503
|
+
|
|
1504
|
+
## setOrderCustomer
|
|
1505
|
+
<div class="graphql-code-block">
|
|
1506
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1507
|
+
<div class="graphql-code-line top-level comment">Allows a different Customer to be assigned to an Order. Added in v2.2.0.</div>
|
|
1508
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1509
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
1510
|
+
<div class="graphql-code-line ">setOrderCustomer(input: <a href="/reference/graphql-api/admin/input-types#setordercustomerinput">SetOrderCustomerInput</a>!): <a href="/reference/graphql-api/admin/object-types#order">Order</a></div>
|
|
1511
|
+
|
|
1512
|
+
|
|
1513
|
+
<div class="graphql-code-line top-level">}</div>
|
|
1514
|
+
</div>
|
|
1515
|
+
|
|
1516
|
+
## setSettingsStoreValue
|
|
1517
|
+
<div class="graphql-code-block">
|
|
1518
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1519
|
+
<div class="graphql-code-line top-level comment">Set a single key-value pair (automatically scoped based on field configuration)</div>
|
|
1520
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1521
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
1522
|
+
<div class="graphql-code-line ">setSettingsStoreValue(input: <a href="/reference/graphql-api/admin/input-types#settingsstoreinput">SettingsStoreInput</a>!): <a href="/reference/graphql-api/admin/object-types#setsettingsstorevalueresult">SetSettingsStoreValueResult</a>!</div>
|
|
1523
|
+
|
|
1524
|
+
|
|
1525
|
+
<div class="graphql-code-line top-level">}</div>
|
|
1526
|
+
</div>
|
|
1527
|
+
|
|
1528
|
+
## setSettingsStoreValues
|
|
1529
|
+
<div class="graphql-code-block">
|
|
1530
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1531
|
+
<div class="graphql-code-line top-level comment">Set multiple key-value pairs in a transaction (each automatically scoped)</div>
|
|
1532
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1533
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
1534
|
+
<div class="graphql-code-line ">setSettingsStoreValues(inputs: [<a href="/reference/graphql-api/admin/input-types#settingsstoreinput">SettingsStoreInput</a>!]!): [<a href="/reference/graphql-api/admin/object-types#setsettingsstorevalueresult">SetSettingsStoreValueResult</a>!]!</div>
|
|
1535
|
+
|
|
1536
|
+
|
|
1537
|
+
<div class="graphql-code-line top-level">}</div>
|
|
1538
|
+
</div>
|
|
1539
|
+
|
|
1540
|
+
## settlePayment
|
|
1541
|
+
<div class="graphql-code-block">
|
|
1542
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
1543
|
+
<div class="graphql-code-line ">settlePayment(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#settlepaymentresult">SettlePaymentResult</a>!</div>
|
|
1544
|
+
|
|
1545
|
+
|
|
1546
|
+
<div class="graphql-code-line top-level">}</div>
|
|
1547
|
+
</div>
|
|
1548
|
+
|
|
1549
|
+
## settleRefund
|
|
1550
|
+
<div class="graphql-code-block">
|
|
1551
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
1552
|
+
<div class="graphql-code-line ">settleRefund(input: <a href="/reference/graphql-api/admin/input-types#settlerefundinput">SettleRefundInput</a>!): <a href="/reference/graphql-api/admin/object-types#settlerefundresult">SettleRefundResult</a>!</div>
|
|
1553
|
+
|
|
1554
|
+
|
|
1555
|
+
<div class="graphql-code-line top-level">}</div>
|
|
1556
|
+
</div>
|
|
1557
|
+
|
|
1558
|
+
## transitionFulfillmentToState
|
|
1559
|
+
<div class="graphql-code-block">
|
|
1560
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
1561
|
+
<div class="graphql-code-line ">transitionFulfillmentToState(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!, state: <a href="/reference/graphql-api/admin/object-types#string">String</a>!): <a href="/reference/graphql-api/admin/object-types#transitionfulfillmenttostateresult">TransitionFulfillmentToStateResult</a>!</div>
|
|
1562
|
+
|
|
1563
|
+
|
|
1564
|
+
<div class="graphql-code-line top-level">}</div>
|
|
1565
|
+
</div>
|
|
1566
|
+
|
|
1567
|
+
## transitionOrderToState
|
|
1568
|
+
<div class="graphql-code-block">
|
|
1569
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
1570
|
+
<div class="graphql-code-line ">transitionOrderToState(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!, state: <a href="/reference/graphql-api/admin/object-types#string">String</a>!): <a href="/reference/graphql-api/admin/object-types#transitionordertostateresult">TransitionOrderToStateResult</a></div>
|
|
1571
|
+
|
|
1572
|
+
|
|
1573
|
+
<div class="graphql-code-line top-level">}</div>
|
|
1574
|
+
</div>
|
|
1575
|
+
|
|
1576
|
+
## transitionPaymentToState
|
|
1577
|
+
<div class="graphql-code-block">
|
|
1578
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
1579
|
+
<div class="graphql-code-line ">transitionPaymentToState(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!, state: <a href="/reference/graphql-api/admin/object-types#string">String</a>!): <a href="/reference/graphql-api/admin/object-types#transitionpaymenttostateresult">TransitionPaymentToStateResult</a>!</div>
|
|
1580
|
+
|
|
1581
|
+
|
|
1582
|
+
<div class="graphql-code-line top-level">}</div>
|
|
1583
|
+
</div>
|
|
1584
|
+
|
|
1585
|
+
## unsetDraftOrderBillingAddress
|
|
1586
|
+
<div class="graphql-code-block">
|
|
1587
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1588
|
+
<div class="graphql-code-line top-level comment">Unsets the billing address for a draft Order</div>
|
|
1589
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1590
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
1591
|
+
<div class="graphql-code-line ">unsetDraftOrderBillingAddress(orderId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#order">Order</a>!</div>
|
|
1592
|
+
|
|
1593
|
+
|
|
1594
|
+
<div class="graphql-code-line top-level">}</div>
|
|
1595
|
+
</div>
|
|
1596
|
+
|
|
1597
|
+
## unsetDraftOrderShippingAddress
|
|
1598
|
+
<div class="graphql-code-block">
|
|
1599
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1600
|
+
<div class="graphql-code-line top-level comment">Unsets the shipping address for a draft Order</div>
|
|
1601
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1602
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
1603
|
+
<div class="graphql-code-line ">unsetDraftOrderShippingAddress(orderId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#order">Order</a>!</div>
|
|
1604
|
+
|
|
1605
|
+
|
|
1606
|
+
<div class="graphql-code-line top-level">}</div>
|
|
1607
|
+
</div>
|
|
1608
|
+
|
|
1609
|
+
## updateActiveAdministrator
|
|
1610
|
+
<div class="graphql-code-block">
|
|
1611
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1612
|
+
<div class="graphql-code-line top-level comment">Update the active (currently logged-in) Administrator</div>
|
|
1613
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1614
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
1615
|
+
<div class="graphql-code-line ">updateActiveAdministrator(input: <a href="/reference/graphql-api/admin/input-types#updateactiveadministratorinput">UpdateActiveAdministratorInput</a>!): <a href="/reference/graphql-api/admin/object-types#administrator">Administrator</a>!</div>
|
|
1616
|
+
|
|
1617
|
+
|
|
1618
|
+
<div class="graphql-code-line top-level">}</div>
|
|
1619
|
+
</div>
|
|
1620
|
+
|
|
1621
|
+
## updateAdministrator
|
|
1622
|
+
<div class="graphql-code-block">
|
|
1623
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1624
|
+
<div class="graphql-code-line top-level comment">Update an existing Administrator</div>
|
|
1625
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1626
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
1627
|
+
<div class="graphql-code-line ">updateAdministrator(input: <a href="/reference/graphql-api/admin/input-types#updateadministratorinput">UpdateAdministratorInput</a>!): <a href="/reference/graphql-api/admin/object-types#administrator">Administrator</a>!</div>
|
|
1628
|
+
|
|
1629
|
+
|
|
1630
|
+
<div class="graphql-code-line top-level">}</div>
|
|
1631
|
+
</div>
|
|
1632
|
+
|
|
1633
|
+
## updateAsset
|
|
1634
|
+
<div class="graphql-code-block">
|
|
1635
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1636
|
+
<div class="graphql-code-line top-level comment">Update an existing Asset</div>
|
|
1637
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1638
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
1639
|
+
<div class="graphql-code-line ">updateAsset(input: <a href="/reference/graphql-api/admin/input-types#updateassetinput">UpdateAssetInput</a>!): <a href="/reference/graphql-api/admin/object-types#asset">Asset</a>!</div>
|
|
1640
|
+
|
|
1641
|
+
|
|
1642
|
+
<div class="graphql-code-line top-level">}</div>
|
|
1643
|
+
</div>
|
|
1644
|
+
|
|
1645
|
+
## updateChannel
|
|
1646
|
+
<div class="graphql-code-block">
|
|
1647
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1648
|
+
<div class="graphql-code-line top-level comment">Update an existing Channel</div>
|
|
1649
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1650
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
1651
|
+
<div class="graphql-code-line ">updateChannel(input: <a href="/reference/graphql-api/admin/input-types#updatechannelinput">UpdateChannelInput</a>!): <a href="/reference/graphql-api/admin/object-types#updatechannelresult">UpdateChannelResult</a>!</div>
|
|
1652
|
+
|
|
1653
|
+
|
|
1654
|
+
<div class="graphql-code-line top-level">}</div>
|
|
1655
|
+
</div>
|
|
1656
|
+
|
|
1657
|
+
## updateCollection
|
|
1658
|
+
<div class="graphql-code-block">
|
|
1659
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1660
|
+
<div class="graphql-code-line top-level comment">Update an existing Collection</div>
|
|
1661
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1662
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
1663
|
+
<div class="graphql-code-line ">updateCollection(input: <a href="/reference/graphql-api/admin/input-types#updatecollectioninput">UpdateCollectionInput</a>!): <a href="/reference/graphql-api/admin/object-types#collection">Collection</a>!</div>
|
|
1664
|
+
|
|
1665
|
+
|
|
1666
|
+
<div class="graphql-code-line top-level">}</div>
|
|
1667
|
+
</div>
|
|
1668
|
+
|
|
1669
|
+
## updateCountry
|
|
1670
|
+
<div class="graphql-code-block">
|
|
1671
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1672
|
+
<div class="graphql-code-line top-level comment">Update an existing Country</div>
|
|
1673
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1674
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
1675
|
+
<div class="graphql-code-line ">updateCountry(input: <a href="/reference/graphql-api/admin/input-types#updatecountryinput">UpdateCountryInput</a>!): <a href="/reference/graphql-api/admin/object-types#country">Country</a>!</div>
|
|
1676
|
+
|
|
1677
|
+
|
|
1678
|
+
<div class="graphql-code-line top-level">}</div>
|
|
1679
|
+
</div>
|
|
1680
|
+
|
|
1681
|
+
## updateCustomer
|
|
1682
|
+
<div class="graphql-code-block">
|
|
1683
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1684
|
+
<div class="graphql-code-line top-level comment">Update an existing Customer</div>
|
|
1685
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1686
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
1687
|
+
<div class="graphql-code-line ">updateCustomer(input: <a href="/reference/graphql-api/admin/input-types#updatecustomerinput">UpdateCustomerInput</a>!): <a href="/reference/graphql-api/admin/object-types#updatecustomerresult">UpdateCustomerResult</a>!</div>
|
|
1688
|
+
|
|
1689
|
+
|
|
1690
|
+
<div class="graphql-code-line top-level">}</div>
|
|
1691
|
+
</div>
|
|
1692
|
+
|
|
1693
|
+
## updateCustomerAddress
|
|
1694
|
+
<div class="graphql-code-block">
|
|
1695
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1696
|
+
<div class="graphql-code-line top-level comment">Update an existing Address</div>
|
|
1697
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1698
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
1699
|
+
<div class="graphql-code-line ">updateCustomerAddress(input: <a href="/reference/graphql-api/admin/input-types#updateaddressinput">UpdateAddressInput</a>!): <a href="/reference/graphql-api/admin/object-types#address">Address</a>!</div>
|
|
1700
|
+
|
|
1701
|
+
|
|
1702
|
+
<div class="graphql-code-line top-level">}</div>
|
|
1703
|
+
</div>
|
|
1704
|
+
|
|
1705
|
+
## updateCustomerGroup
|
|
1706
|
+
<div class="graphql-code-block">
|
|
1707
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1708
|
+
<div class="graphql-code-line top-level comment">Update an existing CustomerGroup</div>
|
|
1709
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1710
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
1711
|
+
<div class="graphql-code-line ">updateCustomerGroup(input: <a href="/reference/graphql-api/admin/input-types#updatecustomergroupinput">UpdateCustomerGroupInput</a>!): <a href="/reference/graphql-api/admin/object-types#customergroup">CustomerGroup</a>!</div>
|
|
1712
|
+
|
|
1713
|
+
|
|
1714
|
+
<div class="graphql-code-line top-level">}</div>
|
|
1715
|
+
</div>
|
|
1716
|
+
|
|
1717
|
+
## updateCustomerNote
|
|
1718
|
+
<div class="graphql-code-block">
|
|
1719
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
1720
|
+
<div class="graphql-code-line ">updateCustomerNote(input: <a href="/reference/graphql-api/admin/input-types#updatecustomernoteinput">UpdateCustomerNoteInput</a>!): <a href="/reference/graphql-api/admin/object-types#historyentry">HistoryEntry</a>!</div>
|
|
1721
|
+
|
|
1722
|
+
|
|
1723
|
+
<div class="graphql-code-line top-level">}</div>
|
|
1724
|
+
</div>
|
|
1725
|
+
|
|
1726
|
+
## updateFacet
|
|
1727
|
+
<div class="graphql-code-block">
|
|
1728
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1729
|
+
<div class="graphql-code-line top-level comment">Update an existing Facet</div>
|
|
1730
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1731
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
1732
|
+
<div class="graphql-code-line ">updateFacet(input: <a href="/reference/graphql-api/admin/input-types#updatefacetinput">UpdateFacetInput</a>!): <a href="/reference/graphql-api/admin/object-types#facet">Facet</a>!</div>
|
|
1733
|
+
|
|
1734
|
+
|
|
1735
|
+
<div class="graphql-code-line top-level">}</div>
|
|
1736
|
+
</div>
|
|
1737
|
+
|
|
1738
|
+
## updateFacetValue
|
|
1739
|
+
<div class="graphql-code-block">
|
|
1740
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1741
|
+
<div class="graphql-code-line top-level comment">Update a single FacetValue</div>
|
|
1742
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1743
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
1744
|
+
<div class="graphql-code-line ">updateFacetValue(input: <a href="/reference/graphql-api/admin/input-types#updatefacetvalueinput">UpdateFacetValueInput</a>!): <a href="/reference/graphql-api/admin/object-types#facetvalue">FacetValue</a>!</div>
|
|
1745
|
+
|
|
1746
|
+
|
|
1747
|
+
<div class="graphql-code-line top-level">}</div>
|
|
1748
|
+
</div>
|
|
1749
|
+
|
|
1750
|
+
## updateFacetValues
|
|
1751
|
+
<div class="graphql-code-block">
|
|
1752
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1753
|
+
<div class="graphql-code-line top-level comment">Update one or more FacetValues</div>
|
|
1754
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1755
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
1756
|
+
<div class="graphql-code-line ">updateFacetValues(input: [<a href="/reference/graphql-api/admin/input-types#updatefacetvalueinput">UpdateFacetValueInput</a>!]!): [<a href="/reference/graphql-api/admin/object-types#facetvalue">FacetValue</a>!]!</div>
|
|
1757
|
+
|
|
1758
|
+
|
|
1759
|
+
<div class="graphql-code-line top-level">}</div>
|
|
1760
|
+
</div>
|
|
1761
|
+
|
|
1762
|
+
## updateGlobalSettings
|
|
1763
|
+
<div class="graphql-code-block">
|
|
1764
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
1765
|
+
<div class="graphql-code-line ">updateGlobalSettings(input: <a href="/reference/graphql-api/admin/input-types#updateglobalsettingsinput">UpdateGlobalSettingsInput</a>!): <a href="/reference/graphql-api/admin/object-types#updateglobalsettingsresult">UpdateGlobalSettingsResult</a>!</div>
|
|
1766
|
+
|
|
1767
|
+
|
|
1768
|
+
<div class="graphql-code-line top-level">}</div>
|
|
1769
|
+
</div>
|
|
1770
|
+
|
|
1771
|
+
## updateOrderNote
|
|
1772
|
+
<div class="graphql-code-block">
|
|
1773
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
1774
|
+
<div class="graphql-code-line ">updateOrderNote(input: <a href="/reference/graphql-api/admin/input-types#updateordernoteinput">UpdateOrderNoteInput</a>!): <a href="/reference/graphql-api/admin/object-types#historyentry">HistoryEntry</a>!</div>
|
|
1775
|
+
|
|
1776
|
+
|
|
1777
|
+
<div class="graphql-code-line top-level">}</div>
|
|
1778
|
+
</div>
|
|
1779
|
+
|
|
1780
|
+
## updatePaymentMethod
|
|
1781
|
+
<div class="graphql-code-block">
|
|
1782
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1783
|
+
<div class="graphql-code-line top-level comment">Update an existing PaymentMethod</div>
|
|
1784
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1785
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
1786
|
+
<div class="graphql-code-line ">updatePaymentMethod(input: <a href="/reference/graphql-api/admin/input-types#updatepaymentmethodinput">UpdatePaymentMethodInput</a>!): <a href="/reference/graphql-api/admin/object-types#paymentmethod">PaymentMethod</a>!</div>
|
|
1787
|
+
|
|
1788
|
+
|
|
1789
|
+
<div class="graphql-code-line top-level">}</div>
|
|
1790
|
+
</div>
|
|
1791
|
+
|
|
1792
|
+
## updateProduct
|
|
1793
|
+
<div class="graphql-code-block">
|
|
1794
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1795
|
+
<div class="graphql-code-line top-level comment">Update an existing Product</div>
|
|
1796
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1797
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
1798
|
+
<div class="graphql-code-line ">updateProduct(input: <a href="/reference/graphql-api/admin/input-types#updateproductinput">UpdateProductInput</a>!): <a href="/reference/graphql-api/admin/object-types#product">Product</a>!</div>
|
|
1799
|
+
|
|
1800
|
+
|
|
1801
|
+
<div class="graphql-code-line top-level">}</div>
|
|
1802
|
+
</div>
|
|
1803
|
+
|
|
1804
|
+
## updateProductOption
|
|
1805
|
+
<div class="graphql-code-block">
|
|
1806
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1807
|
+
<div class="graphql-code-line top-level comment">Create a new ProductOption within a ProductOptionGroup</div>
|
|
1808
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1809
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
1810
|
+
<div class="graphql-code-line ">updateProductOption(input: <a href="/reference/graphql-api/admin/input-types#updateproductoptioninput">UpdateProductOptionInput</a>!): <a href="/reference/graphql-api/admin/object-types#productoption">ProductOption</a>!</div>
|
|
1811
|
+
|
|
1812
|
+
|
|
1813
|
+
<div class="graphql-code-line top-level">}</div>
|
|
1814
|
+
</div>
|
|
1815
|
+
|
|
1816
|
+
## updateProductOptionGroup
|
|
1817
|
+
<div class="graphql-code-block">
|
|
1818
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1819
|
+
<div class="graphql-code-line top-level comment">Update an existing ProductOptionGroup</div>
|
|
1820
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1821
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
1822
|
+
<div class="graphql-code-line ">updateProductOptionGroup(input: <a href="/reference/graphql-api/admin/input-types#updateproductoptiongroupinput">UpdateProductOptionGroupInput</a>!): <a href="/reference/graphql-api/admin/object-types#productoptiongroup">ProductOptionGroup</a>!</div>
|
|
1823
|
+
|
|
1824
|
+
|
|
1825
|
+
<div class="graphql-code-line top-level">}</div>
|
|
1826
|
+
</div>
|
|
1827
|
+
|
|
1828
|
+
## updateProductVariant
|
|
1829
|
+
<div class="graphql-code-block">
|
|
1830
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1831
|
+
<div class="graphql-code-line top-level comment">Update an existing ProductVariant</div>
|
|
1832
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1833
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
1834
|
+
<div class="graphql-code-line ">updateProductVariant(input: <a href="/reference/graphql-api/admin/input-types#updateproductvariantinput">UpdateProductVariantInput</a>!): <a href="/reference/graphql-api/admin/object-types#productvariant">ProductVariant</a>!</div>
|
|
1835
|
+
|
|
1836
|
+
|
|
1837
|
+
<div class="graphql-code-line top-level">}</div>
|
|
1838
|
+
</div>
|
|
1839
|
+
|
|
1840
|
+
## updateProductVariants
|
|
1841
|
+
<div class="graphql-code-block">
|
|
1842
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1843
|
+
<div class="graphql-code-line top-level comment">Update existing ProductVariants</div>
|
|
1844
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1845
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
1846
|
+
<div class="graphql-code-line ">updateProductVariants(input: [<a href="/reference/graphql-api/admin/input-types#updateproductvariantinput">UpdateProductVariantInput</a>!]!): [<a href="/reference/graphql-api/admin/object-types#productvariant">ProductVariant</a>]!</div>
|
|
1847
|
+
|
|
1848
|
+
|
|
1849
|
+
<div class="graphql-code-line top-level">}</div>
|
|
1850
|
+
</div>
|
|
1851
|
+
|
|
1852
|
+
## updateProducts
|
|
1853
|
+
<div class="graphql-code-block">
|
|
1854
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1855
|
+
<div class="graphql-code-line top-level comment">Update multiple existing Products</div>
|
|
1856
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1857
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
1858
|
+
<div class="graphql-code-line ">updateProducts(input: [<a href="/reference/graphql-api/admin/input-types#updateproductinput">UpdateProductInput</a>!]!): [<a href="/reference/graphql-api/admin/object-types#product">Product</a>!]!</div>
|
|
1859
|
+
|
|
1860
|
+
|
|
1861
|
+
<div class="graphql-code-line top-level">}</div>
|
|
1862
|
+
</div>
|
|
1863
|
+
|
|
1864
|
+
## updatePromotion
|
|
1865
|
+
<div class="graphql-code-block">
|
|
1866
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
1867
|
+
<div class="graphql-code-line ">updatePromotion(input: <a href="/reference/graphql-api/admin/input-types#updatepromotioninput">UpdatePromotionInput</a>!): <a href="/reference/graphql-api/admin/object-types#updatepromotionresult">UpdatePromotionResult</a>!</div>
|
|
1868
|
+
|
|
1869
|
+
|
|
1870
|
+
<div class="graphql-code-line top-level">}</div>
|
|
1871
|
+
</div>
|
|
1872
|
+
|
|
1873
|
+
## updateProvince
|
|
1874
|
+
<div class="graphql-code-block">
|
|
1875
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1876
|
+
<div class="graphql-code-line top-level comment">Update an existing Province</div>
|
|
1877
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1878
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
1879
|
+
<div class="graphql-code-line ">updateProvince(input: <a href="/reference/graphql-api/admin/input-types#updateprovinceinput">UpdateProvinceInput</a>!): <a href="/reference/graphql-api/admin/object-types#province">Province</a>!</div>
|
|
1880
|
+
|
|
1881
|
+
|
|
1882
|
+
<div class="graphql-code-line top-level">}</div>
|
|
1883
|
+
</div>
|
|
1884
|
+
|
|
1885
|
+
## updateRole
|
|
1886
|
+
<div class="graphql-code-block">
|
|
1887
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1888
|
+
<div class="graphql-code-line top-level comment">Update an existing Role</div>
|
|
1889
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1890
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
1891
|
+
<div class="graphql-code-line ">updateRole(input: <a href="/reference/graphql-api/admin/input-types#updateroleinput">UpdateRoleInput</a>!): <a href="/reference/graphql-api/admin/object-types#role">Role</a>!</div>
|
|
1892
|
+
|
|
1893
|
+
|
|
1894
|
+
<div class="graphql-code-line top-level">}</div>
|
|
1895
|
+
</div>
|
|
1896
|
+
|
|
1897
|
+
## updateScheduledTask
|
|
1898
|
+
<div class="graphql-code-block">
|
|
1899
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
1900
|
+
<div class="graphql-code-line ">updateScheduledTask(input: <a href="/reference/graphql-api/admin/input-types#updatescheduledtaskinput">UpdateScheduledTaskInput</a>!): <a href="/reference/graphql-api/admin/object-types#scheduledtask">ScheduledTask</a>!</div>
|
|
1901
|
+
|
|
1902
|
+
|
|
1903
|
+
<div class="graphql-code-line top-level">}</div>
|
|
1904
|
+
</div>
|
|
1905
|
+
|
|
1906
|
+
## updateSeller
|
|
1907
|
+
<div class="graphql-code-block">
|
|
1908
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1909
|
+
<div class="graphql-code-line top-level comment">Update an existing Seller</div>
|
|
1910
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1911
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
1912
|
+
<div class="graphql-code-line ">updateSeller(input: <a href="/reference/graphql-api/admin/input-types#updatesellerinput">UpdateSellerInput</a>!): <a href="/reference/graphql-api/admin/object-types#seller">Seller</a>!</div>
|
|
1913
|
+
|
|
1914
|
+
|
|
1915
|
+
<div class="graphql-code-line top-level">}</div>
|
|
1916
|
+
</div>
|
|
1917
|
+
|
|
1918
|
+
## updateShippingMethod
|
|
1919
|
+
<div class="graphql-code-block">
|
|
1920
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1921
|
+
<div class="graphql-code-line top-level comment">Update an existing ShippingMethod</div>
|
|
1922
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1923
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
1924
|
+
<div class="graphql-code-line ">updateShippingMethod(input: <a href="/reference/graphql-api/admin/input-types#updateshippingmethodinput">UpdateShippingMethodInput</a>!): <a href="/reference/graphql-api/admin/object-types#shippingmethod">ShippingMethod</a>!</div>
|
|
1925
|
+
|
|
1926
|
+
|
|
1927
|
+
<div class="graphql-code-line top-level">}</div>
|
|
1928
|
+
</div>
|
|
1929
|
+
|
|
1930
|
+
## updateStockLocation
|
|
1931
|
+
<div class="graphql-code-block">
|
|
1932
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
1933
|
+
<div class="graphql-code-line ">updateStockLocation(input: <a href="/reference/graphql-api/admin/input-types#updatestocklocationinput">UpdateStockLocationInput</a>!): <a href="/reference/graphql-api/admin/object-types#stocklocation">StockLocation</a>!</div>
|
|
1934
|
+
|
|
1935
|
+
|
|
1936
|
+
<div class="graphql-code-line top-level">}</div>
|
|
1937
|
+
</div>
|
|
1938
|
+
|
|
1939
|
+
## updateTag
|
|
1940
|
+
<div class="graphql-code-block">
|
|
1941
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1942
|
+
<div class="graphql-code-line top-level comment">Update an existing Tag</div>
|
|
1943
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1944
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
1945
|
+
<div class="graphql-code-line ">updateTag(input: <a href="/reference/graphql-api/admin/input-types#updatetaginput">UpdateTagInput</a>!): <a href="/reference/graphql-api/admin/object-types#tag">Tag</a>!</div>
|
|
1946
|
+
|
|
1947
|
+
|
|
1948
|
+
<div class="graphql-code-line top-level">}</div>
|
|
1949
|
+
</div>
|
|
1950
|
+
|
|
1951
|
+
## updateTaxCategory
|
|
1952
|
+
<div class="graphql-code-block">
|
|
1953
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1954
|
+
<div class="graphql-code-line top-level comment">Update an existing TaxCategory</div>
|
|
1955
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1956
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
1957
|
+
<div class="graphql-code-line ">updateTaxCategory(input: <a href="/reference/graphql-api/admin/input-types#updatetaxcategoryinput">UpdateTaxCategoryInput</a>!): <a href="/reference/graphql-api/admin/object-types#taxcategory">TaxCategory</a>!</div>
|
|
1958
|
+
|
|
1959
|
+
|
|
1960
|
+
<div class="graphql-code-line top-level">}</div>
|
|
1961
|
+
</div>
|
|
1962
|
+
|
|
1963
|
+
## updateTaxRate
|
|
1964
|
+
<div class="graphql-code-block">
|
|
1965
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1966
|
+
<div class="graphql-code-line top-level comment">Update an existing TaxRate</div>
|
|
1967
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1968
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
1969
|
+
<div class="graphql-code-line ">updateTaxRate(input: <a href="/reference/graphql-api/admin/input-types#updatetaxrateinput">UpdateTaxRateInput</a>!): <a href="/reference/graphql-api/admin/object-types#taxrate">TaxRate</a>!</div>
|
|
1970
|
+
|
|
1971
|
+
|
|
1972
|
+
<div class="graphql-code-line top-level">}</div>
|
|
1973
|
+
</div>
|
|
1974
|
+
|
|
1975
|
+
## updateZone
|
|
1976
|
+
<div class="graphql-code-block">
|
|
1977
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1978
|
+
<div class="graphql-code-line top-level comment">Update an existing Zone</div>
|
|
1979
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1980
|
+
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> {</div>
|
|
1981
|
+
<div class="graphql-code-line ">updateZone(input: <a href="/reference/graphql-api/admin/input-types#updatezoneinput">UpdateZoneInput</a>!): <a href="/reference/graphql-api/admin/object-types#zone">Zone</a>!</div>
|
|
1982
|
+
|
|
1983
|
+
|
|
1984
|
+
<div class="graphql-code-line top-level">}</div>
|
|
1985
|
+
</div>
|