@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,1192 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "Input Objects"
|
|
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
|
+
## AddItemInput
|
|
10
|
+
|
|
11
|
+
<div class="graphql-code-block">
|
|
12
|
+
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">AddItemInput</span> {</div>
|
|
13
|
+
<div class="graphql-code-line ">productVariantId: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
|
|
14
|
+
|
|
15
|
+
<div class="graphql-code-line ">quantity: <a href="/reference/graphql-api/shop/object-types#int">Int</a>!</div>
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
<div class="graphql-code-line top-level">}</div>
|
|
19
|
+
</div>
|
|
20
|
+
|
|
21
|
+
## AuthenticationInput
|
|
22
|
+
|
|
23
|
+
<div class="graphql-code-block">
|
|
24
|
+
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">AuthenticationInput</span> {</div>
|
|
25
|
+
<div class="graphql-code-line ">native: <a href="/reference/graphql-api/shop/input-types#nativeauthinput">NativeAuthInput</a></div>
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
<div class="graphql-code-line top-level">}</div>
|
|
29
|
+
</div>
|
|
30
|
+
|
|
31
|
+
## BooleanListOperators
|
|
32
|
+
|
|
33
|
+
<div class="graphql-code-block">
|
|
34
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
35
|
+
<div class="graphql-code-line top-level comment">Operators for filtering on a list of Boolean fields</div>
|
|
36
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
37
|
+
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">BooleanListOperators</span> {</div>
|
|
38
|
+
<div class="graphql-code-line ">inList: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a>!</div>
|
|
39
|
+
|
|
40
|
+
|
|
41
|
+
<div class="graphql-code-line top-level">}</div>
|
|
42
|
+
</div>
|
|
43
|
+
|
|
44
|
+
## BooleanOperators
|
|
45
|
+
|
|
46
|
+
<div class="graphql-code-block">
|
|
47
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
48
|
+
<div class="graphql-code-line top-level comment">Operators for filtering on a Boolean field</div>
|
|
49
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
50
|
+
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">BooleanOperators</span> {</div>
|
|
51
|
+
<div class="graphql-code-line ">eq: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a></div>
|
|
52
|
+
|
|
53
|
+
<div class="graphql-code-line ">isNull: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a></div>
|
|
54
|
+
|
|
55
|
+
|
|
56
|
+
<div class="graphql-code-line top-level">}</div>
|
|
57
|
+
</div>
|
|
58
|
+
|
|
59
|
+
## CollectionFilterParameter
|
|
60
|
+
|
|
61
|
+
<div class="graphql-code-block">
|
|
62
|
+
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">CollectionFilterParameter</span> {</div>
|
|
63
|
+
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/input-types#idoperators">IDOperators</a></div>
|
|
64
|
+
|
|
65
|
+
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/input-types#dateoperators">DateOperators</a></div>
|
|
66
|
+
|
|
67
|
+
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/input-types#dateoperators">DateOperators</a></div>
|
|
68
|
+
|
|
69
|
+
<div class="graphql-code-line ">languageCode: <a href="/reference/graphql-api/shop/input-types#stringoperators">StringOperators</a></div>
|
|
70
|
+
|
|
71
|
+
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/input-types#stringoperators">StringOperators</a></div>
|
|
72
|
+
|
|
73
|
+
<div class="graphql-code-line ">slug: <a href="/reference/graphql-api/shop/input-types#stringoperators">StringOperators</a></div>
|
|
74
|
+
|
|
75
|
+
<div class="graphql-code-line ">position: <a href="/reference/graphql-api/shop/input-types#numberoperators">NumberOperators</a></div>
|
|
76
|
+
|
|
77
|
+
<div class="graphql-code-line ">description: <a href="/reference/graphql-api/shop/input-types#stringoperators">StringOperators</a></div>
|
|
78
|
+
|
|
79
|
+
<div class="graphql-code-line ">parentId: <a href="/reference/graphql-api/shop/input-types#idoperators">IDOperators</a></div>
|
|
80
|
+
|
|
81
|
+
<div class="graphql-code-line ">_and: [<a href="/reference/graphql-api/shop/input-types#collectionfilterparameter">CollectionFilterParameter</a>!]</div>
|
|
82
|
+
|
|
83
|
+
<div class="graphql-code-line ">_or: [<a href="/reference/graphql-api/shop/input-types#collectionfilterparameter">CollectionFilterParameter</a>!]</div>
|
|
84
|
+
|
|
85
|
+
|
|
86
|
+
<div class="graphql-code-line top-level">}</div>
|
|
87
|
+
</div>
|
|
88
|
+
|
|
89
|
+
## CollectionListOptions
|
|
90
|
+
|
|
91
|
+
<div class="graphql-code-block">
|
|
92
|
+
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">CollectionListOptions</span> {</div>
|
|
93
|
+
<div class="graphql-code-line ">topLevelOnly: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a></div>
|
|
94
|
+
|
|
95
|
+
<div class="graphql-code-line comment">"""</div>
|
|
96
|
+
<div class="graphql-code-line comment">Skips the first n results, for use in pagination</div>
|
|
97
|
+
<div class="graphql-code-line comment">"""</div>
|
|
98
|
+
<div class="graphql-code-line ">skip: <a href="/reference/graphql-api/shop/object-types#int">Int</a></div>
|
|
99
|
+
|
|
100
|
+
<div class="graphql-code-line comment">"""</div>
|
|
101
|
+
<div class="graphql-code-line comment">Takes n results, for use in pagination</div>
|
|
102
|
+
<div class="graphql-code-line comment">"""</div>
|
|
103
|
+
<div class="graphql-code-line ">take: <a href="/reference/graphql-api/shop/object-types#int">Int</a></div>
|
|
104
|
+
|
|
105
|
+
<div class="graphql-code-line comment">"""</div>
|
|
106
|
+
<div class="graphql-code-line comment">Specifies which properties to sort the results by</div>
|
|
107
|
+
<div class="graphql-code-line comment">"""</div>
|
|
108
|
+
<div class="graphql-code-line ">sort: <a href="/reference/graphql-api/shop/input-types#collectionsortparameter">CollectionSortParameter</a></div>
|
|
109
|
+
|
|
110
|
+
<div class="graphql-code-line comment">"""</div>
|
|
111
|
+
<div class="graphql-code-line comment">Allows the results to be filtered</div>
|
|
112
|
+
<div class="graphql-code-line comment">"""</div>
|
|
113
|
+
<div class="graphql-code-line ">filter: <a href="/reference/graphql-api/shop/input-types#collectionfilterparameter">CollectionFilterParameter</a></div>
|
|
114
|
+
|
|
115
|
+
<div class="graphql-code-line comment">"""</div>
|
|
116
|
+
<div class="graphql-code-line comment">Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND.</div>
|
|
117
|
+
<div class="graphql-code-line comment">"""</div>
|
|
118
|
+
<div class="graphql-code-line ">filterOperator: <a href="/reference/graphql-api/shop/enums#logicaloperator">LogicalOperator</a></div>
|
|
119
|
+
|
|
120
|
+
|
|
121
|
+
<div class="graphql-code-line top-level">}</div>
|
|
122
|
+
</div>
|
|
123
|
+
|
|
124
|
+
## CollectionSortParameter
|
|
125
|
+
|
|
126
|
+
<div class="graphql-code-block">
|
|
127
|
+
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">CollectionSortParameter</span> {</div>
|
|
128
|
+
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
|
|
129
|
+
|
|
130
|
+
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
|
|
131
|
+
|
|
132
|
+
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
|
|
133
|
+
|
|
134
|
+
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
|
|
135
|
+
|
|
136
|
+
<div class="graphql-code-line ">slug: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
|
|
137
|
+
|
|
138
|
+
<div class="graphql-code-line ">position: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
|
|
139
|
+
|
|
140
|
+
<div class="graphql-code-line ">description: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
|
|
141
|
+
|
|
142
|
+
<div class="graphql-code-line ">parentId: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
<div class="graphql-code-line top-level">}</div>
|
|
146
|
+
</div>
|
|
147
|
+
|
|
148
|
+
## ConfigArgInput
|
|
149
|
+
|
|
150
|
+
<div class="graphql-code-block">
|
|
151
|
+
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">ConfigArgInput</span> {</div>
|
|
152
|
+
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
|
|
153
|
+
|
|
154
|
+
<div class="graphql-code-line comment">"""</div>
|
|
155
|
+
<div class="graphql-code-line comment">A JSON stringified representation of the actual value</div>
|
|
156
|
+
<div class="graphql-code-line comment">"""</div>
|
|
157
|
+
<div class="graphql-code-line ">value: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
|
|
158
|
+
|
|
159
|
+
|
|
160
|
+
<div class="graphql-code-line top-level">}</div>
|
|
161
|
+
</div>
|
|
162
|
+
|
|
163
|
+
## ConfigurableOperationInput
|
|
164
|
+
|
|
165
|
+
<div class="graphql-code-block">
|
|
166
|
+
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">ConfigurableOperationInput</span> {</div>
|
|
167
|
+
<div class="graphql-code-line ">code: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
|
|
168
|
+
|
|
169
|
+
<div class="graphql-code-line ">arguments: [<a href="/reference/graphql-api/shop/input-types#configarginput">ConfigArgInput</a>!]!</div>
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
<div class="graphql-code-line top-level">}</div>
|
|
173
|
+
</div>
|
|
174
|
+
|
|
175
|
+
## CreateAddressInput
|
|
176
|
+
|
|
177
|
+
<div class="graphql-code-block">
|
|
178
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
179
|
+
<div class="graphql-code-line top-level comment">Input used to create an Address.</div>
|
|
180
|
+
|
|
181
|
+
<div class="graphql-code-line top-level comment"></div>
|
|
182
|
+
|
|
183
|
+
<div class="graphql-code-line top-level comment">The countryCode must correspond to a <code>code</code> property of a Country that has been defined in the</div>
|
|
184
|
+
|
|
185
|
+
<div class="graphql-code-line top-level comment">Vendure server. The <code>code</code> property is typically a 2-character ISO code such as "GB", "US", "DE" etc.</div>
|
|
186
|
+
|
|
187
|
+
<div class="graphql-code-line top-level comment">If an invalid code is passed, the mutation will fail.</div>
|
|
188
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
189
|
+
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">CreateAddressInput</span> {</div>
|
|
190
|
+
<div class="graphql-code-line ">fullName: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
|
|
191
|
+
|
|
192
|
+
<div class="graphql-code-line ">company: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
|
|
193
|
+
|
|
194
|
+
<div class="graphql-code-line ">streetLine1: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
|
|
195
|
+
|
|
196
|
+
<div class="graphql-code-line ">streetLine2: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
|
|
197
|
+
|
|
198
|
+
<div class="graphql-code-line ">city: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
|
|
199
|
+
|
|
200
|
+
<div class="graphql-code-line ">province: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
|
|
201
|
+
|
|
202
|
+
<div class="graphql-code-line ">postalCode: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
|
|
203
|
+
|
|
204
|
+
<div class="graphql-code-line ">countryCode: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
|
|
205
|
+
|
|
206
|
+
<div class="graphql-code-line ">phoneNumber: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
|
|
207
|
+
|
|
208
|
+
<div class="graphql-code-line ">defaultShippingAddress: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a></div>
|
|
209
|
+
|
|
210
|
+
<div class="graphql-code-line ">defaultBillingAddress: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a></div>
|
|
211
|
+
|
|
212
|
+
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
|
|
213
|
+
|
|
214
|
+
|
|
215
|
+
<div class="graphql-code-line top-level">}</div>
|
|
216
|
+
</div>
|
|
217
|
+
|
|
218
|
+
## CreateCustomerInput
|
|
219
|
+
|
|
220
|
+
<div class="graphql-code-block">
|
|
221
|
+
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">CreateCustomerInput</span> {</div>
|
|
222
|
+
<div class="graphql-code-line ">title: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
|
|
223
|
+
|
|
224
|
+
<div class="graphql-code-line ">firstName: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
|
|
225
|
+
|
|
226
|
+
<div class="graphql-code-line ">lastName: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
|
|
227
|
+
|
|
228
|
+
<div class="graphql-code-line ">phoneNumber: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
|
|
229
|
+
|
|
230
|
+
<div class="graphql-code-line ">emailAddress: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
|
|
231
|
+
|
|
232
|
+
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
|
|
233
|
+
|
|
234
|
+
|
|
235
|
+
<div class="graphql-code-line top-level">}</div>
|
|
236
|
+
</div>
|
|
237
|
+
|
|
238
|
+
## CustomerFilterParameter
|
|
239
|
+
|
|
240
|
+
<div class="graphql-code-block">
|
|
241
|
+
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">CustomerFilterParameter</span> {</div>
|
|
242
|
+
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/input-types#idoperators">IDOperators</a></div>
|
|
243
|
+
|
|
244
|
+
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/input-types#dateoperators">DateOperators</a></div>
|
|
245
|
+
|
|
246
|
+
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/input-types#dateoperators">DateOperators</a></div>
|
|
247
|
+
|
|
248
|
+
<div class="graphql-code-line ">title: <a href="/reference/graphql-api/shop/input-types#stringoperators">StringOperators</a></div>
|
|
249
|
+
|
|
250
|
+
<div class="graphql-code-line ">firstName: <a href="/reference/graphql-api/shop/input-types#stringoperators">StringOperators</a></div>
|
|
251
|
+
|
|
252
|
+
<div class="graphql-code-line ">lastName: <a href="/reference/graphql-api/shop/input-types#stringoperators">StringOperators</a></div>
|
|
253
|
+
|
|
254
|
+
<div class="graphql-code-line ">phoneNumber: <a href="/reference/graphql-api/shop/input-types#stringoperators">StringOperators</a></div>
|
|
255
|
+
|
|
256
|
+
<div class="graphql-code-line ">emailAddress: <a href="/reference/graphql-api/shop/input-types#stringoperators">StringOperators</a></div>
|
|
257
|
+
|
|
258
|
+
<div class="graphql-code-line ">_and: [<a href="/reference/graphql-api/shop/input-types#customerfilterparameter">CustomerFilterParameter</a>!]</div>
|
|
259
|
+
|
|
260
|
+
<div class="graphql-code-line ">_or: [<a href="/reference/graphql-api/shop/input-types#customerfilterparameter">CustomerFilterParameter</a>!]</div>
|
|
261
|
+
|
|
262
|
+
|
|
263
|
+
<div class="graphql-code-line top-level">}</div>
|
|
264
|
+
</div>
|
|
265
|
+
|
|
266
|
+
## CustomerListOptions
|
|
267
|
+
|
|
268
|
+
<div class="graphql-code-block">
|
|
269
|
+
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">CustomerListOptions</span> {</div>
|
|
270
|
+
<div class="graphql-code-line comment">"""</div>
|
|
271
|
+
<div class="graphql-code-line comment">Skips the first n results, for use in pagination</div>
|
|
272
|
+
<div class="graphql-code-line comment">"""</div>
|
|
273
|
+
<div class="graphql-code-line ">skip: <a href="/reference/graphql-api/shop/object-types#int">Int</a></div>
|
|
274
|
+
|
|
275
|
+
<div class="graphql-code-line comment">"""</div>
|
|
276
|
+
<div class="graphql-code-line comment">Takes n results, for use in pagination</div>
|
|
277
|
+
<div class="graphql-code-line comment">"""</div>
|
|
278
|
+
<div class="graphql-code-line ">take: <a href="/reference/graphql-api/shop/object-types#int">Int</a></div>
|
|
279
|
+
|
|
280
|
+
<div class="graphql-code-line comment">"""</div>
|
|
281
|
+
<div class="graphql-code-line comment">Specifies which properties to sort the results by</div>
|
|
282
|
+
<div class="graphql-code-line comment">"""</div>
|
|
283
|
+
<div class="graphql-code-line ">sort: <a href="/reference/graphql-api/shop/input-types#customersortparameter">CustomerSortParameter</a></div>
|
|
284
|
+
|
|
285
|
+
<div class="graphql-code-line comment">"""</div>
|
|
286
|
+
<div class="graphql-code-line comment">Allows the results to be filtered</div>
|
|
287
|
+
<div class="graphql-code-line comment">"""</div>
|
|
288
|
+
<div class="graphql-code-line ">filter: <a href="/reference/graphql-api/shop/input-types#customerfilterparameter">CustomerFilterParameter</a></div>
|
|
289
|
+
|
|
290
|
+
<div class="graphql-code-line comment">"""</div>
|
|
291
|
+
<div class="graphql-code-line comment">Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND.</div>
|
|
292
|
+
<div class="graphql-code-line comment">"""</div>
|
|
293
|
+
<div class="graphql-code-line ">filterOperator: <a href="/reference/graphql-api/shop/enums#logicaloperator">LogicalOperator</a></div>
|
|
294
|
+
|
|
295
|
+
|
|
296
|
+
<div class="graphql-code-line top-level">}</div>
|
|
297
|
+
</div>
|
|
298
|
+
|
|
299
|
+
## CustomerSortParameter
|
|
300
|
+
|
|
301
|
+
<div class="graphql-code-block">
|
|
302
|
+
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">CustomerSortParameter</span> {</div>
|
|
303
|
+
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
|
|
304
|
+
|
|
305
|
+
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
|
|
306
|
+
|
|
307
|
+
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
|
|
308
|
+
|
|
309
|
+
<div class="graphql-code-line ">title: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
|
|
310
|
+
|
|
311
|
+
<div class="graphql-code-line ">firstName: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
|
|
312
|
+
|
|
313
|
+
<div class="graphql-code-line ">lastName: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
|
|
314
|
+
|
|
315
|
+
<div class="graphql-code-line ">phoneNumber: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
|
|
316
|
+
|
|
317
|
+
<div class="graphql-code-line ">emailAddress: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
|
|
318
|
+
|
|
319
|
+
|
|
320
|
+
<div class="graphql-code-line top-level">}</div>
|
|
321
|
+
</div>
|
|
322
|
+
|
|
323
|
+
## DateListOperators
|
|
324
|
+
|
|
325
|
+
<div class="graphql-code-block">
|
|
326
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
327
|
+
<div class="graphql-code-line top-level comment">Operators for filtering on a list of Date fields</div>
|
|
328
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
329
|
+
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">DateListOperators</span> {</div>
|
|
330
|
+
<div class="graphql-code-line ">inList: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
|
|
331
|
+
|
|
332
|
+
|
|
333
|
+
<div class="graphql-code-line top-level">}</div>
|
|
334
|
+
</div>
|
|
335
|
+
|
|
336
|
+
## DateOperators
|
|
337
|
+
|
|
338
|
+
<div class="graphql-code-block">
|
|
339
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
340
|
+
<div class="graphql-code-line top-level comment">Operators for filtering on a DateTime field</div>
|
|
341
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
342
|
+
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">DateOperators</span> {</div>
|
|
343
|
+
<div class="graphql-code-line ">eq: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a></div>
|
|
344
|
+
|
|
345
|
+
<div class="graphql-code-line ">before: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a></div>
|
|
346
|
+
|
|
347
|
+
<div class="graphql-code-line ">after: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a></div>
|
|
348
|
+
|
|
349
|
+
<div class="graphql-code-line ">between: <a href="/reference/graphql-api/shop/input-types#daterange">DateRange</a></div>
|
|
350
|
+
|
|
351
|
+
<div class="graphql-code-line ">isNull: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a></div>
|
|
352
|
+
|
|
353
|
+
|
|
354
|
+
<div class="graphql-code-line top-level">}</div>
|
|
355
|
+
</div>
|
|
356
|
+
|
|
357
|
+
## DateRange
|
|
358
|
+
|
|
359
|
+
<div class="graphql-code-block">
|
|
360
|
+
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">DateRange</span> {</div>
|
|
361
|
+
<div class="graphql-code-line ">start: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
|
|
362
|
+
|
|
363
|
+
<div class="graphql-code-line ">end: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
|
|
364
|
+
|
|
365
|
+
|
|
366
|
+
<div class="graphql-code-line top-level">}</div>
|
|
367
|
+
</div>
|
|
368
|
+
|
|
369
|
+
## FacetFilterParameter
|
|
370
|
+
|
|
371
|
+
<div class="graphql-code-block">
|
|
372
|
+
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">FacetFilterParameter</span> {</div>
|
|
373
|
+
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/input-types#idoperators">IDOperators</a></div>
|
|
374
|
+
|
|
375
|
+
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/input-types#dateoperators">DateOperators</a></div>
|
|
376
|
+
|
|
377
|
+
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/input-types#dateoperators">DateOperators</a></div>
|
|
378
|
+
|
|
379
|
+
<div class="graphql-code-line ">languageCode: <a href="/reference/graphql-api/shop/input-types#stringoperators">StringOperators</a></div>
|
|
380
|
+
|
|
381
|
+
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/input-types#stringoperators">StringOperators</a></div>
|
|
382
|
+
|
|
383
|
+
<div class="graphql-code-line ">code: <a href="/reference/graphql-api/shop/input-types#stringoperators">StringOperators</a></div>
|
|
384
|
+
|
|
385
|
+
<div class="graphql-code-line ">_and: [<a href="/reference/graphql-api/shop/input-types#facetfilterparameter">FacetFilterParameter</a>!]</div>
|
|
386
|
+
|
|
387
|
+
<div class="graphql-code-line ">_or: [<a href="/reference/graphql-api/shop/input-types#facetfilterparameter">FacetFilterParameter</a>!]</div>
|
|
388
|
+
|
|
389
|
+
|
|
390
|
+
<div class="graphql-code-line top-level">}</div>
|
|
391
|
+
</div>
|
|
392
|
+
|
|
393
|
+
## FacetListOptions
|
|
394
|
+
|
|
395
|
+
<div class="graphql-code-block">
|
|
396
|
+
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">FacetListOptions</span> {</div>
|
|
397
|
+
<div class="graphql-code-line comment">"""</div>
|
|
398
|
+
<div class="graphql-code-line comment">Skips the first n results, for use in pagination</div>
|
|
399
|
+
<div class="graphql-code-line comment">"""</div>
|
|
400
|
+
<div class="graphql-code-line ">skip: <a href="/reference/graphql-api/shop/object-types#int">Int</a></div>
|
|
401
|
+
|
|
402
|
+
<div class="graphql-code-line comment">"""</div>
|
|
403
|
+
<div class="graphql-code-line comment">Takes n results, for use in pagination</div>
|
|
404
|
+
<div class="graphql-code-line comment">"""</div>
|
|
405
|
+
<div class="graphql-code-line ">take: <a href="/reference/graphql-api/shop/object-types#int">Int</a></div>
|
|
406
|
+
|
|
407
|
+
<div class="graphql-code-line comment">"""</div>
|
|
408
|
+
<div class="graphql-code-line comment">Specifies which properties to sort the results by</div>
|
|
409
|
+
<div class="graphql-code-line comment">"""</div>
|
|
410
|
+
<div class="graphql-code-line ">sort: <a href="/reference/graphql-api/shop/input-types#facetsortparameter">FacetSortParameter</a></div>
|
|
411
|
+
|
|
412
|
+
<div class="graphql-code-line comment">"""</div>
|
|
413
|
+
<div class="graphql-code-line comment">Allows the results to be filtered</div>
|
|
414
|
+
<div class="graphql-code-line comment">"""</div>
|
|
415
|
+
<div class="graphql-code-line ">filter: <a href="/reference/graphql-api/shop/input-types#facetfilterparameter">FacetFilterParameter</a></div>
|
|
416
|
+
|
|
417
|
+
<div class="graphql-code-line comment">"""</div>
|
|
418
|
+
<div class="graphql-code-line comment">Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND.</div>
|
|
419
|
+
<div class="graphql-code-line comment">"""</div>
|
|
420
|
+
<div class="graphql-code-line ">filterOperator: <a href="/reference/graphql-api/shop/enums#logicaloperator">LogicalOperator</a></div>
|
|
421
|
+
|
|
422
|
+
|
|
423
|
+
<div class="graphql-code-line top-level">}</div>
|
|
424
|
+
</div>
|
|
425
|
+
|
|
426
|
+
## FacetSortParameter
|
|
427
|
+
|
|
428
|
+
<div class="graphql-code-block">
|
|
429
|
+
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">FacetSortParameter</span> {</div>
|
|
430
|
+
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
|
|
431
|
+
|
|
432
|
+
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
|
|
433
|
+
|
|
434
|
+
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
|
|
435
|
+
|
|
436
|
+
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
|
|
437
|
+
|
|
438
|
+
<div class="graphql-code-line ">code: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
|
|
439
|
+
|
|
440
|
+
|
|
441
|
+
<div class="graphql-code-line top-level">}</div>
|
|
442
|
+
</div>
|
|
443
|
+
|
|
444
|
+
## FacetValueFilterInput
|
|
445
|
+
|
|
446
|
+
<div class="graphql-code-block">
|
|
447
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
448
|
+
<div class="graphql-code-line top-level comment">Used to construct boolean expressions for filtering search results</div>
|
|
449
|
+
|
|
450
|
+
<div class="graphql-code-line top-level comment">by FacetValue ID. Examples:</div>
|
|
451
|
+
|
|
452
|
+
<div class="graphql-code-line top-level comment"></div>
|
|
453
|
+
|
|
454
|
+
<div class="graphql-code-line top-level comment">* ID=1 OR ID=2: `{ facetValueFilters: [{ or: [1,2] }] }`</div>
|
|
455
|
+
|
|
456
|
+
<div class="graphql-code-line top-level comment">* ID=1 AND ID=2: `{ facetValueFilters: [{ and: 1 }, { and: 2 }] }`</div>
|
|
457
|
+
|
|
458
|
+
<div class="graphql-code-line top-level comment">* ID=1 AND (ID=2 OR ID=3): `{ facetValueFilters: [{ and: 1 }, { or: [2,3] }] }`</div>
|
|
459
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
460
|
+
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">FacetValueFilterInput</span> {</div>
|
|
461
|
+
<div class="graphql-code-line ">and: <a href="/reference/graphql-api/shop/object-types#id">ID</a></div>
|
|
462
|
+
|
|
463
|
+
<div class="graphql-code-line ">or: [<a href="/reference/graphql-api/shop/object-types#id">ID</a>!]</div>
|
|
464
|
+
|
|
465
|
+
|
|
466
|
+
<div class="graphql-code-line top-level">}</div>
|
|
467
|
+
</div>
|
|
468
|
+
|
|
469
|
+
## FacetValueFilterParameter
|
|
470
|
+
|
|
471
|
+
<div class="graphql-code-block">
|
|
472
|
+
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">FacetValueFilterParameter</span> {</div>
|
|
473
|
+
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/input-types#idoperators">IDOperators</a></div>
|
|
474
|
+
|
|
475
|
+
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/input-types#dateoperators">DateOperators</a></div>
|
|
476
|
+
|
|
477
|
+
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/input-types#dateoperators">DateOperators</a></div>
|
|
478
|
+
|
|
479
|
+
<div class="graphql-code-line ">languageCode: <a href="/reference/graphql-api/shop/input-types#stringoperators">StringOperators</a></div>
|
|
480
|
+
|
|
481
|
+
<div class="graphql-code-line ">facetId: <a href="/reference/graphql-api/shop/input-types#idoperators">IDOperators</a></div>
|
|
482
|
+
|
|
483
|
+
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/input-types#stringoperators">StringOperators</a></div>
|
|
484
|
+
|
|
485
|
+
<div class="graphql-code-line ">code: <a href="/reference/graphql-api/shop/input-types#stringoperators">StringOperators</a></div>
|
|
486
|
+
|
|
487
|
+
<div class="graphql-code-line ">_and: [<a href="/reference/graphql-api/shop/input-types#facetvaluefilterparameter">FacetValueFilterParameter</a>!]</div>
|
|
488
|
+
|
|
489
|
+
<div class="graphql-code-line ">_or: [<a href="/reference/graphql-api/shop/input-types#facetvaluefilterparameter">FacetValueFilterParameter</a>!]</div>
|
|
490
|
+
|
|
491
|
+
|
|
492
|
+
<div class="graphql-code-line top-level">}</div>
|
|
493
|
+
</div>
|
|
494
|
+
|
|
495
|
+
## FacetValueListOptions
|
|
496
|
+
|
|
497
|
+
<div class="graphql-code-block">
|
|
498
|
+
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">FacetValueListOptions</span> {</div>
|
|
499
|
+
<div class="graphql-code-line comment">"""</div>
|
|
500
|
+
<div class="graphql-code-line comment">Skips the first n results, for use in pagination</div>
|
|
501
|
+
<div class="graphql-code-line comment">"""</div>
|
|
502
|
+
<div class="graphql-code-line ">skip: <a href="/reference/graphql-api/shop/object-types#int">Int</a></div>
|
|
503
|
+
|
|
504
|
+
<div class="graphql-code-line comment">"""</div>
|
|
505
|
+
<div class="graphql-code-line comment">Takes n results, for use in pagination</div>
|
|
506
|
+
<div class="graphql-code-line comment">"""</div>
|
|
507
|
+
<div class="graphql-code-line ">take: <a href="/reference/graphql-api/shop/object-types#int">Int</a></div>
|
|
508
|
+
|
|
509
|
+
<div class="graphql-code-line comment">"""</div>
|
|
510
|
+
<div class="graphql-code-line comment">Specifies which properties to sort the results by</div>
|
|
511
|
+
<div class="graphql-code-line comment">"""</div>
|
|
512
|
+
<div class="graphql-code-line ">sort: <a href="/reference/graphql-api/shop/input-types#facetvaluesortparameter">FacetValueSortParameter</a></div>
|
|
513
|
+
|
|
514
|
+
<div class="graphql-code-line comment">"""</div>
|
|
515
|
+
<div class="graphql-code-line comment">Allows the results to be filtered</div>
|
|
516
|
+
<div class="graphql-code-line comment">"""</div>
|
|
517
|
+
<div class="graphql-code-line ">filter: <a href="/reference/graphql-api/shop/input-types#facetvaluefilterparameter">FacetValueFilterParameter</a></div>
|
|
518
|
+
|
|
519
|
+
<div class="graphql-code-line comment">"""</div>
|
|
520
|
+
<div class="graphql-code-line comment">Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND.</div>
|
|
521
|
+
<div class="graphql-code-line comment">"""</div>
|
|
522
|
+
<div class="graphql-code-line ">filterOperator: <a href="/reference/graphql-api/shop/enums#logicaloperator">LogicalOperator</a></div>
|
|
523
|
+
|
|
524
|
+
|
|
525
|
+
<div class="graphql-code-line top-level">}</div>
|
|
526
|
+
</div>
|
|
527
|
+
|
|
528
|
+
## FacetValueSortParameter
|
|
529
|
+
|
|
530
|
+
<div class="graphql-code-block">
|
|
531
|
+
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">FacetValueSortParameter</span> {</div>
|
|
532
|
+
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
|
|
533
|
+
|
|
534
|
+
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
|
|
535
|
+
|
|
536
|
+
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
|
|
537
|
+
|
|
538
|
+
<div class="graphql-code-line ">facetId: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
|
|
539
|
+
|
|
540
|
+
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
|
|
541
|
+
|
|
542
|
+
<div class="graphql-code-line ">code: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
|
|
543
|
+
|
|
544
|
+
|
|
545
|
+
<div class="graphql-code-line top-level">}</div>
|
|
546
|
+
</div>
|
|
547
|
+
|
|
548
|
+
## HistoryEntryFilterParameter
|
|
549
|
+
|
|
550
|
+
<div class="graphql-code-block">
|
|
551
|
+
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">HistoryEntryFilterParameter</span> {</div>
|
|
552
|
+
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/input-types#idoperators">IDOperators</a></div>
|
|
553
|
+
|
|
554
|
+
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/input-types#dateoperators">DateOperators</a></div>
|
|
555
|
+
|
|
556
|
+
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/input-types#dateoperators">DateOperators</a></div>
|
|
557
|
+
|
|
558
|
+
<div class="graphql-code-line ">type: <a href="/reference/graphql-api/shop/input-types#stringoperators">StringOperators</a></div>
|
|
559
|
+
|
|
560
|
+
<div class="graphql-code-line ">_and: [<a href="/reference/graphql-api/shop/input-types#historyentryfilterparameter">HistoryEntryFilterParameter</a>!]</div>
|
|
561
|
+
|
|
562
|
+
<div class="graphql-code-line ">_or: [<a href="/reference/graphql-api/shop/input-types#historyentryfilterparameter">HistoryEntryFilterParameter</a>!]</div>
|
|
563
|
+
|
|
564
|
+
|
|
565
|
+
<div class="graphql-code-line top-level">}</div>
|
|
566
|
+
</div>
|
|
567
|
+
|
|
568
|
+
## HistoryEntryListOptions
|
|
569
|
+
|
|
570
|
+
<div class="graphql-code-block">
|
|
571
|
+
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">HistoryEntryListOptions</span> {</div>
|
|
572
|
+
<div class="graphql-code-line comment">"""</div>
|
|
573
|
+
<div class="graphql-code-line comment">Skips the first n results, for use in pagination</div>
|
|
574
|
+
<div class="graphql-code-line comment">"""</div>
|
|
575
|
+
<div class="graphql-code-line ">skip: <a href="/reference/graphql-api/shop/object-types#int">Int</a></div>
|
|
576
|
+
|
|
577
|
+
<div class="graphql-code-line comment">"""</div>
|
|
578
|
+
<div class="graphql-code-line comment">Takes n results, for use in pagination</div>
|
|
579
|
+
<div class="graphql-code-line comment">"""</div>
|
|
580
|
+
<div class="graphql-code-line ">take: <a href="/reference/graphql-api/shop/object-types#int">Int</a></div>
|
|
581
|
+
|
|
582
|
+
<div class="graphql-code-line comment">"""</div>
|
|
583
|
+
<div class="graphql-code-line comment">Specifies which properties to sort the results by</div>
|
|
584
|
+
<div class="graphql-code-line comment">"""</div>
|
|
585
|
+
<div class="graphql-code-line ">sort: <a href="/reference/graphql-api/shop/input-types#historyentrysortparameter">HistoryEntrySortParameter</a></div>
|
|
586
|
+
|
|
587
|
+
<div class="graphql-code-line comment">"""</div>
|
|
588
|
+
<div class="graphql-code-line comment">Allows the results to be filtered</div>
|
|
589
|
+
<div class="graphql-code-line comment">"""</div>
|
|
590
|
+
<div class="graphql-code-line ">filter: <a href="/reference/graphql-api/shop/input-types#historyentryfilterparameter">HistoryEntryFilterParameter</a></div>
|
|
591
|
+
|
|
592
|
+
<div class="graphql-code-line comment">"""</div>
|
|
593
|
+
<div class="graphql-code-line comment">Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND.</div>
|
|
594
|
+
<div class="graphql-code-line comment">"""</div>
|
|
595
|
+
<div class="graphql-code-line ">filterOperator: <a href="/reference/graphql-api/shop/enums#logicaloperator">LogicalOperator</a></div>
|
|
596
|
+
|
|
597
|
+
|
|
598
|
+
<div class="graphql-code-line top-level">}</div>
|
|
599
|
+
</div>
|
|
600
|
+
|
|
601
|
+
## HistoryEntrySortParameter
|
|
602
|
+
|
|
603
|
+
<div class="graphql-code-block">
|
|
604
|
+
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">HistoryEntrySortParameter</span> {</div>
|
|
605
|
+
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
|
|
606
|
+
|
|
607
|
+
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
|
|
608
|
+
|
|
609
|
+
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
|
|
610
|
+
|
|
611
|
+
|
|
612
|
+
<div class="graphql-code-line top-level">}</div>
|
|
613
|
+
</div>
|
|
614
|
+
|
|
615
|
+
## IDListOperators
|
|
616
|
+
|
|
617
|
+
<div class="graphql-code-block">
|
|
618
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
619
|
+
<div class="graphql-code-line top-level comment">Operators for filtering on a list of ID fields</div>
|
|
620
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
621
|
+
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">IDListOperators</span> {</div>
|
|
622
|
+
<div class="graphql-code-line ">inList: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
|
|
623
|
+
|
|
624
|
+
|
|
625
|
+
<div class="graphql-code-line top-level">}</div>
|
|
626
|
+
</div>
|
|
627
|
+
|
|
628
|
+
## IDOperators
|
|
629
|
+
|
|
630
|
+
<div class="graphql-code-block">
|
|
631
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
632
|
+
<div class="graphql-code-line top-level comment">Operators for filtering on an ID field</div>
|
|
633
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
634
|
+
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">IDOperators</span> {</div>
|
|
635
|
+
<div class="graphql-code-line ">eq: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
|
|
636
|
+
|
|
637
|
+
<div class="graphql-code-line ">notEq: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
|
|
638
|
+
|
|
639
|
+
<div class="graphql-code-line ">in: [<a href="/reference/graphql-api/shop/object-types#string">String</a>!]</div>
|
|
640
|
+
|
|
641
|
+
<div class="graphql-code-line ">notIn: [<a href="/reference/graphql-api/shop/object-types#string">String</a>!]</div>
|
|
642
|
+
|
|
643
|
+
<div class="graphql-code-line ">isNull: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a></div>
|
|
644
|
+
|
|
645
|
+
|
|
646
|
+
<div class="graphql-code-line top-level">}</div>
|
|
647
|
+
</div>
|
|
648
|
+
|
|
649
|
+
## NativeAuthInput
|
|
650
|
+
|
|
651
|
+
<div class="graphql-code-block">
|
|
652
|
+
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">NativeAuthInput</span> {</div>
|
|
653
|
+
<div class="graphql-code-line ">username: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
|
|
654
|
+
|
|
655
|
+
<div class="graphql-code-line ">password: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
|
|
656
|
+
|
|
657
|
+
|
|
658
|
+
<div class="graphql-code-line top-level">}</div>
|
|
659
|
+
</div>
|
|
660
|
+
|
|
661
|
+
## NumberListOperators
|
|
662
|
+
|
|
663
|
+
<div class="graphql-code-block">
|
|
664
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
665
|
+
<div class="graphql-code-line top-level comment">Operators for filtering on a list of Number fields</div>
|
|
666
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
667
|
+
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">NumberListOperators</span> {</div>
|
|
668
|
+
<div class="graphql-code-line ">inList: <a href="/reference/graphql-api/shop/object-types#float">Float</a>!</div>
|
|
669
|
+
|
|
670
|
+
|
|
671
|
+
<div class="graphql-code-line top-level">}</div>
|
|
672
|
+
</div>
|
|
673
|
+
|
|
674
|
+
## NumberOperators
|
|
675
|
+
|
|
676
|
+
<div class="graphql-code-block">
|
|
677
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
678
|
+
<div class="graphql-code-line top-level comment">Operators for filtering on a Int or Float field</div>
|
|
679
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
680
|
+
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">NumberOperators</span> {</div>
|
|
681
|
+
<div class="graphql-code-line ">eq: <a href="/reference/graphql-api/shop/object-types#float">Float</a></div>
|
|
682
|
+
|
|
683
|
+
<div class="graphql-code-line ">lt: <a href="/reference/graphql-api/shop/object-types#float">Float</a></div>
|
|
684
|
+
|
|
685
|
+
<div class="graphql-code-line ">lte: <a href="/reference/graphql-api/shop/object-types#float">Float</a></div>
|
|
686
|
+
|
|
687
|
+
<div class="graphql-code-line ">gt: <a href="/reference/graphql-api/shop/object-types#float">Float</a></div>
|
|
688
|
+
|
|
689
|
+
<div class="graphql-code-line ">gte: <a href="/reference/graphql-api/shop/object-types#float">Float</a></div>
|
|
690
|
+
|
|
691
|
+
<div class="graphql-code-line ">between: <a href="/reference/graphql-api/shop/input-types#numberrange">NumberRange</a></div>
|
|
692
|
+
|
|
693
|
+
<div class="graphql-code-line ">isNull: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a></div>
|
|
694
|
+
|
|
695
|
+
|
|
696
|
+
<div class="graphql-code-line top-level">}</div>
|
|
697
|
+
</div>
|
|
698
|
+
|
|
699
|
+
## NumberRange
|
|
700
|
+
|
|
701
|
+
<div class="graphql-code-block">
|
|
702
|
+
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">NumberRange</span> {</div>
|
|
703
|
+
<div class="graphql-code-line ">start: <a href="/reference/graphql-api/shop/object-types#float">Float</a>!</div>
|
|
704
|
+
|
|
705
|
+
<div class="graphql-code-line ">end: <a href="/reference/graphql-api/shop/object-types#float">Float</a>!</div>
|
|
706
|
+
|
|
707
|
+
|
|
708
|
+
<div class="graphql-code-line top-level">}</div>
|
|
709
|
+
</div>
|
|
710
|
+
|
|
711
|
+
## OrderFilterParameter
|
|
712
|
+
|
|
713
|
+
<div class="graphql-code-block">
|
|
714
|
+
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">OrderFilterParameter</span> {</div>
|
|
715
|
+
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/input-types#idoperators">IDOperators</a></div>
|
|
716
|
+
|
|
717
|
+
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/input-types#dateoperators">DateOperators</a></div>
|
|
718
|
+
|
|
719
|
+
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/input-types#dateoperators">DateOperators</a></div>
|
|
720
|
+
|
|
721
|
+
<div class="graphql-code-line ">type: <a href="/reference/graphql-api/shop/input-types#stringoperators">StringOperators</a></div>
|
|
722
|
+
|
|
723
|
+
<div class="graphql-code-line ">orderPlacedAt: <a href="/reference/graphql-api/shop/input-types#dateoperators">DateOperators</a></div>
|
|
724
|
+
|
|
725
|
+
<div class="graphql-code-line ">code: <a href="/reference/graphql-api/shop/input-types#stringoperators">StringOperators</a></div>
|
|
726
|
+
|
|
727
|
+
<div class="graphql-code-line ">state: <a href="/reference/graphql-api/shop/input-types#stringoperators">StringOperators</a></div>
|
|
728
|
+
|
|
729
|
+
<div class="graphql-code-line ">active: <a href="/reference/graphql-api/shop/input-types#booleanoperators">BooleanOperators</a></div>
|
|
730
|
+
|
|
731
|
+
<div class="graphql-code-line ">totalQuantity: <a href="/reference/graphql-api/shop/input-types#numberoperators">NumberOperators</a></div>
|
|
732
|
+
|
|
733
|
+
<div class="graphql-code-line ">subTotal: <a href="/reference/graphql-api/shop/input-types#numberoperators">NumberOperators</a></div>
|
|
734
|
+
|
|
735
|
+
<div class="graphql-code-line ">subTotalWithTax: <a href="/reference/graphql-api/shop/input-types#numberoperators">NumberOperators</a></div>
|
|
736
|
+
|
|
737
|
+
<div class="graphql-code-line ">currencyCode: <a href="/reference/graphql-api/shop/input-types#stringoperators">StringOperators</a></div>
|
|
738
|
+
|
|
739
|
+
<div class="graphql-code-line ">shipping: <a href="/reference/graphql-api/shop/input-types#numberoperators">NumberOperators</a></div>
|
|
740
|
+
|
|
741
|
+
<div class="graphql-code-line ">shippingWithTax: <a href="/reference/graphql-api/shop/input-types#numberoperators">NumberOperators</a></div>
|
|
742
|
+
|
|
743
|
+
<div class="graphql-code-line ">total: <a href="/reference/graphql-api/shop/input-types#numberoperators">NumberOperators</a></div>
|
|
744
|
+
|
|
745
|
+
<div class="graphql-code-line ">totalWithTax: <a href="/reference/graphql-api/shop/input-types#numberoperators">NumberOperators</a></div>
|
|
746
|
+
|
|
747
|
+
<div class="graphql-code-line ">_and: [<a href="/reference/graphql-api/shop/input-types#orderfilterparameter">OrderFilterParameter</a>!]</div>
|
|
748
|
+
|
|
749
|
+
<div class="graphql-code-line ">_or: [<a href="/reference/graphql-api/shop/input-types#orderfilterparameter">OrderFilterParameter</a>!]</div>
|
|
750
|
+
|
|
751
|
+
|
|
752
|
+
<div class="graphql-code-line top-level">}</div>
|
|
753
|
+
</div>
|
|
754
|
+
|
|
755
|
+
## OrderListOptions
|
|
756
|
+
|
|
757
|
+
<div class="graphql-code-block">
|
|
758
|
+
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">OrderListOptions</span> {</div>
|
|
759
|
+
<div class="graphql-code-line comment">"""</div>
|
|
760
|
+
<div class="graphql-code-line comment">Skips the first n results, for use in pagination</div>
|
|
761
|
+
<div class="graphql-code-line comment">"""</div>
|
|
762
|
+
<div class="graphql-code-line ">skip: <a href="/reference/graphql-api/shop/object-types#int">Int</a></div>
|
|
763
|
+
|
|
764
|
+
<div class="graphql-code-line comment">"""</div>
|
|
765
|
+
<div class="graphql-code-line comment">Takes n results, for use in pagination</div>
|
|
766
|
+
<div class="graphql-code-line comment">"""</div>
|
|
767
|
+
<div class="graphql-code-line ">take: <a href="/reference/graphql-api/shop/object-types#int">Int</a></div>
|
|
768
|
+
|
|
769
|
+
<div class="graphql-code-line comment">"""</div>
|
|
770
|
+
<div class="graphql-code-line comment">Specifies which properties to sort the results by</div>
|
|
771
|
+
<div class="graphql-code-line comment">"""</div>
|
|
772
|
+
<div class="graphql-code-line ">sort: <a href="/reference/graphql-api/shop/input-types#ordersortparameter">OrderSortParameter</a></div>
|
|
773
|
+
|
|
774
|
+
<div class="graphql-code-line comment">"""</div>
|
|
775
|
+
<div class="graphql-code-line comment">Allows the results to be filtered</div>
|
|
776
|
+
<div class="graphql-code-line comment">"""</div>
|
|
777
|
+
<div class="graphql-code-line ">filter: <a href="/reference/graphql-api/shop/input-types#orderfilterparameter">OrderFilterParameter</a></div>
|
|
778
|
+
|
|
779
|
+
<div class="graphql-code-line comment">"""</div>
|
|
780
|
+
<div class="graphql-code-line comment">Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND.</div>
|
|
781
|
+
<div class="graphql-code-line comment">"""</div>
|
|
782
|
+
<div class="graphql-code-line ">filterOperator: <a href="/reference/graphql-api/shop/enums#logicaloperator">LogicalOperator</a></div>
|
|
783
|
+
|
|
784
|
+
|
|
785
|
+
<div class="graphql-code-line top-level">}</div>
|
|
786
|
+
</div>
|
|
787
|
+
|
|
788
|
+
## OrderSortParameter
|
|
789
|
+
|
|
790
|
+
<div class="graphql-code-block">
|
|
791
|
+
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">OrderSortParameter</span> {</div>
|
|
792
|
+
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
|
|
793
|
+
|
|
794
|
+
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
|
|
795
|
+
|
|
796
|
+
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
|
|
797
|
+
|
|
798
|
+
<div class="graphql-code-line ">orderPlacedAt: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
|
|
799
|
+
|
|
800
|
+
<div class="graphql-code-line ">code: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
|
|
801
|
+
|
|
802
|
+
<div class="graphql-code-line ">state: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
|
|
803
|
+
|
|
804
|
+
<div class="graphql-code-line ">totalQuantity: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
|
|
805
|
+
|
|
806
|
+
<div class="graphql-code-line ">subTotal: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
|
|
807
|
+
|
|
808
|
+
<div class="graphql-code-line ">subTotalWithTax: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
|
|
809
|
+
|
|
810
|
+
<div class="graphql-code-line ">shipping: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
|
|
811
|
+
|
|
812
|
+
<div class="graphql-code-line ">shippingWithTax: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
|
|
813
|
+
|
|
814
|
+
<div class="graphql-code-line ">total: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
|
|
815
|
+
|
|
816
|
+
<div class="graphql-code-line ">totalWithTax: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
|
|
817
|
+
|
|
818
|
+
|
|
819
|
+
<div class="graphql-code-line top-level">}</div>
|
|
820
|
+
</div>
|
|
821
|
+
|
|
822
|
+
## PaymentInput
|
|
823
|
+
|
|
824
|
+
<div class="graphql-code-block">
|
|
825
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
826
|
+
<div class="graphql-code-line top-level comment">Passed as input to the <code>addPaymentToOrder</code> mutation.</div>
|
|
827
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
828
|
+
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">PaymentInput</span> {</div>
|
|
829
|
+
<div class="graphql-code-line comment">"""</div>
|
|
830
|
+
<div class="graphql-code-line comment">This field should correspond to the <code>code</code> property of a PaymentMethod.</div>
|
|
831
|
+
<div class="graphql-code-line comment">"""</div>
|
|
832
|
+
<div class="graphql-code-line ">method: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
|
|
833
|
+
|
|
834
|
+
<div class="graphql-code-line comment">"""</div>
|
|
835
|
+
<div class="graphql-code-line comment">This field should contain arbitrary data passed to the specified PaymentMethodHandler's <code>createPayment()</code> method</div>
|
|
836
|
+
|
|
837
|
+
<div class="graphql-code-line comment">as the "metadata" argument. For example, it could contain an ID for the payment and other</div>
|
|
838
|
+
|
|
839
|
+
<div class="graphql-code-line comment">data generated by the payment provider.</div>
|
|
840
|
+
<div class="graphql-code-line comment">"""</div>
|
|
841
|
+
<div class="graphql-code-line ">metadata: <a href="/reference/graphql-api/shop/object-types#json">JSON</a>!</div>
|
|
842
|
+
|
|
843
|
+
|
|
844
|
+
<div class="graphql-code-line top-level">}</div>
|
|
845
|
+
</div>
|
|
846
|
+
|
|
847
|
+
## ProductFilterParameter
|
|
848
|
+
|
|
849
|
+
<div class="graphql-code-block">
|
|
850
|
+
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">ProductFilterParameter</span> {</div>
|
|
851
|
+
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/input-types#idoperators">IDOperators</a></div>
|
|
852
|
+
|
|
853
|
+
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/input-types#dateoperators">DateOperators</a></div>
|
|
854
|
+
|
|
855
|
+
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/input-types#dateoperators">DateOperators</a></div>
|
|
856
|
+
|
|
857
|
+
<div class="graphql-code-line ">languageCode: <a href="/reference/graphql-api/shop/input-types#stringoperators">StringOperators</a></div>
|
|
858
|
+
|
|
859
|
+
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/input-types#stringoperators">StringOperators</a></div>
|
|
860
|
+
|
|
861
|
+
<div class="graphql-code-line ">slug: <a href="/reference/graphql-api/shop/input-types#stringoperators">StringOperators</a></div>
|
|
862
|
+
|
|
863
|
+
<div class="graphql-code-line ">description: <a href="/reference/graphql-api/shop/input-types#stringoperators">StringOperators</a></div>
|
|
864
|
+
|
|
865
|
+
<div class="graphql-code-line ">enabled: <a href="/reference/graphql-api/shop/input-types#booleanoperators">BooleanOperators</a></div>
|
|
866
|
+
|
|
867
|
+
<div class="graphql-code-line ">_and: [<a href="/reference/graphql-api/shop/input-types#productfilterparameter">ProductFilterParameter</a>!]</div>
|
|
868
|
+
|
|
869
|
+
<div class="graphql-code-line ">_or: [<a href="/reference/graphql-api/shop/input-types#productfilterparameter">ProductFilterParameter</a>!]</div>
|
|
870
|
+
|
|
871
|
+
|
|
872
|
+
<div class="graphql-code-line top-level">}</div>
|
|
873
|
+
</div>
|
|
874
|
+
|
|
875
|
+
## ProductListOptions
|
|
876
|
+
|
|
877
|
+
<div class="graphql-code-block">
|
|
878
|
+
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">ProductListOptions</span> {</div>
|
|
879
|
+
<div class="graphql-code-line comment">"""</div>
|
|
880
|
+
<div class="graphql-code-line comment">Skips the first n results, for use in pagination</div>
|
|
881
|
+
<div class="graphql-code-line comment">"""</div>
|
|
882
|
+
<div class="graphql-code-line ">skip: <a href="/reference/graphql-api/shop/object-types#int">Int</a></div>
|
|
883
|
+
|
|
884
|
+
<div class="graphql-code-line comment">"""</div>
|
|
885
|
+
<div class="graphql-code-line comment">Takes n results, for use in pagination</div>
|
|
886
|
+
<div class="graphql-code-line comment">"""</div>
|
|
887
|
+
<div class="graphql-code-line ">take: <a href="/reference/graphql-api/shop/object-types#int">Int</a></div>
|
|
888
|
+
|
|
889
|
+
<div class="graphql-code-line comment">"""</div>
|
|
890
|
+
<div class="graphql-code-line comment">Specifies which properties to sort the results by</div>
|
|
891
|
+
<div class="graphql-code-line comment">"""</div>
|
|
892
|
+
<div class="graphql-code-line ">sort: <a href="/reference/graphql-api/shop/input-types#productsortparameter">ProductSortParameter</a></div>
|
|
893
|
+
|
|
894
|
+
<div class="graphql-code-line comment">"""</div>
|
|
895
|
+
<div class="graphql-code-line comment">Allows the results to be filtered</div>
|
|
896
|
+
<div class="graphql-code-line comment">"""</div>
|
|
897
|
+
<div class="graphql-code-line ">filter: <a href="/reference/graphql-api/shop/input-types#productfilterparameter">ProductFilterParameter</a></div>
|
|
898
|
+
|
|
899
|
+
<div class="graphql-code-line comment">"""</div>
|
|
900
|
+
<div class="graphql-code-line comment">Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND.</div>
|
|
901
|
+
<div class="graphql-code-line comment">"""</div>
|
|
902
|
+
<div class="graphql-code-line ">filterOperator: <a href="/reference/graphql-api/shop/enums#logicaloperator">LogicalOperator</a></div>
|
|
903
|
+
|
|
904
|
+
|
|
905
|
+
<div class="graphql-code-line top-level">}</div>
|
|
906
|
+
</div>
|
|
907
|
+
|
|
908
|
+
## ProductSortParameter
|
|
909
|
+
|
|
910
|
+
<div class="graphql-code-block">
|
|
911
|
+
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">ProductSortParameter</span> {</div>
|
|
912
|
+
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
|
|
913
|
+
|
|
914
|
+
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
|
|
915
|
+
|
|
916
|
+
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
|
|
917
|
+
|
|
918
|
+
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
|
|
919
|
+
|
|
920
|
+
<div class="graphql-code-line ">slug: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
|
|
921
|
+
|
|
922
|
+
<div class="graphql-code-line ">description: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
|
|
923
|
+
|
|
924
|
+
|
|
925
|
+
<div class="graphql-code-line top-level">}</div>
|
|
926
|
+
</div>
|
|
927
|
+
|
|
928
|
+
## ProductVariantFilterParameter
|
|
929
|
+
|
|
930
|
+
<div class="graphql-code-block">
|
|
931
|
+
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">ProductVariantFilterParameter</span> {</div>
|
|
932
|
+
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/input-types#idoperators">IDOperators</a></div>
|
|
933
|
+
|
|
934
|
+
<div class="graphql-code-line ">productId: <a href="/reference/graphql-api/shop/input-types#idoperators">IDOperators</a></div>
|
|
935
|
+
|
|
936
|
+
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/input-types#dateoperators">DateOperators</a></div>
|
|
937
|
+
|
|
938
|
+
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/input-types#dateoperators">DateOperators</a></div>
|
|
939
|
+
|
|
940
|
+
<div class="graphql-code-line ">languageCode: <a href="/reference/graphql-api/shop/input-types#stringoperators">StringOperators</a></div>
|
|
941
|
+
|
|
942
|
+
<div class="graphql-code-line ">sku: <a href="/reference/graphql-api/shop/input-types#stringoperators">StringOperators</a></div>
|
|
943
|
+
|
|
944
|
+
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/input-types#stringoperators">StringOperators</a></div>
|
|
945
|
+
|
|
946
|
+
<div class="graphql-code-line ">price: <a href="/reference/graphql-api/shop/input-types#numberoperators">NumberOperators</a></div>
|
|
947
|
+
|
|
948
|
+
<div class="graphql-code-line ">currencyCode: <a href="/reference/graphql-api/shop/input-types#stringoperators">StringOperators</a></div>
|
|
949
|
+
|
|
950
|
+
<div class="graphql-code-line ">priceWithTax: <a href="/reference/graphql-api/shop/input-types#numberoperators">NumberOperators</a></div>
|
|
951
|
+
|
|
952
|
+
<div class="graphql-code-line ">stockLevel: <a href="/reference/graphql-api/shop/input-types#stringoperators">StringOperators</a></div>
|
|
953
|
+
|
|
954
|
+
<div class="graphql-code-line ">_and: [<a href="/reference/graphql-api/shop/input-types#productvariantfilterparameter">ProductVariantFilterParameter</a>!]</div>
|
|
955
|
+
|
|
956
|
+
<div class="graphql-code-line ">_or: [<a href="/reference/graphql-api/shop/input-types#productvariantfilterparameter">ProductVariantFilterParameter</a>!]</div>
|
|
957
|
+
|
|
958
|
+
|
|
959
|
+
<div class="graphql-code-line top-level">}</div>
|
|
960
|
+
</div>
|
|
961
|
+
|
|
962
|
+
## ProductVariantListOptions
|
|
963
|
+
|
|
964
|
+
<div class="graphql-code-block">
|
|
965
|
+
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">ProductVariantListOptions</span> {</div>
|
|
966
|
+
<div class="graphql-code-line comment">"""</div>
|
|
967
|
+
<div class="graphql-code-line comment">Skips the first n results, for use in pagination</div>
|
|
968
|
+
<div class="graphql-code-line comment">"""</div>
|
|
969
|
+
<div class="graphql-code-line ">skip: <a href="/reference/graphql-api/shop/object-types#int">Int</a></div>
|
|
970
|
+
|
|
971
|
+
<div class="graphql-code-line comment">"""</div>
|
|
972
|
+
<div class="graphql-code-line comment">Takes n results, for use in pagination</div>
|
|
973
|
+
<div class="graphql-code-line comment">"""</div>
|
|
974
|
+
<div class="graphql-code-line ">take: <a href="/reference/graphql-api/shop/object-types#int">Int</a></div>
|
|
975
|
+
|
|
976
|
+
<div class="graphql-code-line comment">"""</div>
|
|
977
|
+
<div class="graphql-code-line comment">Specifies which properties to sort the results by</div>
|
|
978
|
+
<div class="graphql-code-line comment">"""</div>
|
|
979
|
+
<div class="graphql-code-line ">sort: <a href="/reference/graphql-api/shop/input-types#productvariantsortparameter">ProductVariantSortParameter</a></div>
|
|
980
|
+
|
|
981
|
+
<div class="graphql-code-line comment">"""</div>
|
|
982
|
+
<div class="graphql-code-line comment">Allows the results to be filtered</div>
|
|
983
|
+
<div class="graphql-code-line comment">"""</div>
|
|
984
|
+
<div class="graphql-code-line ">filter: <a href="/reference/graphql-api/shop/input-types#productvariantfilterparameter">ProductVariantFilterParameter</a></div>
|
|
985
|
+
|
|
986
|
+
<div class="graphql-code-line comment">"""</div>
|
|
987
|
+
<div class="graphql-code-line comment">Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND.</div>
|
|
988
|
+
<div class="graphql-code-line comment">"""</div>
|
|
989
|
+
<div class="graphql-code-line ">filterOperator: <a href="/reference/graphql-api/shop/enums#logicaloperator">LogicalOperator</a></div>
|
|
990
|
+
|
|
991
|
+
|
|
992
|
+
<div class="graphql-code-line top-level">}</div>
|
|
993
|
+
</div>
|
|
994
|
+
|
|
995
|
+
## ProductVariantSortParameter
|
|
996
|
+
|
|
997
|
+
<div class="graphql-code-block">
|
|
998
|
+
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">ProductVariantSortParameter</span> {</div>
|
|
999
|
+
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
|
|
1000
|
+
|
|
1001
|
+
<div class="graphql-code-line ">productId: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
|
|
1002
|
+
|
|
1003
|
+
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
|
|
1004
|
+
|
|
1005
|
+
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
|
|
1006
|
+
|
|
1007
|
+
<div class="graphql-code-line ">sku: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
|
|
1008
|
+
|
|
1009
|
+
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
|
|
1010
|
+
|
|
1011
|
+
<div class="graphql-code-line ">price: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
|
|
1012
|
+
|
|
1013
|
+
<div class="graphql-code-line ">priceWithTax: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
|
|
1014
|
+
|
|
1015
|
+
<div class="graphql-code-line ">stockLevel: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
|
|
1016
|
+
|
|
1017
|
+
|
|
1018
|
+
<div class="graphql-code-line top-level">}</div>
|
|
1019
|
+
</div>
|
|
1020
|
+
|
|
1021
|
+
## RegisterCustomerInput
|
|
1022
|
+
|
|
1023
|
+
<div class="graphql-code-block">
|
|
1024
|
+
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">RegisterCustomerInput</span> {</div>
|
|
1025
|
+
<div class="graphql-code-line ">emailAddress: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
|
|
1026
|
+
|
|
1027
|
+
<div class="graphql-code-line ">title: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
|
|
1028
|
+
|
|
1029
|
+
<div class="graphql-code-line ">firstName: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
|
|
1030
|
+
|
|
1031
|
+
<div class="graphql-code-line ">lastName: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
|
|
1032
|
+
|
|
1033
|
+
<div class="graphql-code-line ">phoneNumber: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
|
|
1034
|
+
|
|
1035
|
+
<div class="graphql-code-line ">password: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
|
|
1036
|
+
|
|
1037
|
+
|
|
1038
|
+
<div class="graphql-code-line top-level">}</div>
|
|
1039
|
+
</div>
|
|
1040
|
+
|
|
1041
|
+
## SearchInput
|
|
1042
|
+
|
|
1043
|
+
<div class="graphql-code-block">
|
|
1044
|
+
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">SearchInput</span> {</div>
|
|
1045
|
+
<div class="graphql-code-line ">term: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
|
|
1046
|
+
|
|
1047
|
+
<div class="graphql-code-line ">facetValueIds: [<a href="/reference/graphql-api/shop/object-types#id">ID</a>!]</div>
|
|
1048
|
+
|
|
1049
|
+
<div class="graphql-code-line ">facetValueOperator: <a href="/reference/graphql-api/shop/enums#logicaloperator">LogicalOperator</a></div>
|
|
1050
|
+
|
|
1051
|
+
<div class="graphql-code-line ">facetValueFilters: [<a href="/reference/graphql-api/shop/input-types#facetvaluefilterinput">FacetValueFilterInput</a>!]</div>
|
|
1052
|
+
|
|
1053
|
+
<div class="graphql-code-line ">collectionId: <a href="/reference/graphql-api/shop/object-types#id">ID</a></div>
|
|
1054
|
+
|
|
1055
|
+
<div class="graphql-code-line ">collectionSlug: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
|
|
1056
|
+
|
|
1057
|
+
<div class="graphql-code-line ">groupByProduct: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a></div>
|
|
1058
|
+
|
|
1059
|
+
<div class="graphql-code-line ">take: <a href="/reference/graphql-api/shop/object-types#int">Int</a></div>
|
|
1060
|
+
|
|
1061
|
+
<div class="graphql-code-line ">skip: <a href="/reference/graphql-api/shop/object-types#int">Int</a></div>
|
|
1062
|
+
|
|
1063
|
+
<div class="graphql-code-line ">sort: <a href="/reference/graphql-api/shop/input-types#searchresultsortparameter">SearchResultSortParameter</a></div>
|
|
1064
|
+
|
|
1065
|
+
|
|
1066
|
+
<div class="graphql-code-line top-level">}</div>
|
|
1067
|
+
</div>
|
|
1068
|
+
|
|
1069
|
+
## SearchResultSortParameter
|
|
1070
|
+
|
|
1071
|
+
<div class="graphql-code-block">
|
|
1072
|
+
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">SearchResultSortParameter</span> {</div>
|
|
1073
|
+
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
|
|
1074
|
+
|
|
1075
|
+
<div class="graphql-code-line ">price: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
|
|
1076
|
+
|
|
1077
|
+
|
|
1078
|
+
<div class="graphql-code-line top-level">}</div>
|
|
1079
|
+
</div>
|
|
1080
|
+
|
|
1081
|
+
## StringListOperators
|
|
1082
|
+
|
|
1083
|
+
<div class="graphql-code-block">
|
|
1084
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1085
|
+
<div class="graphql-code-line top-level comment">Operators for filtering on a list of String fields</div>
|
|
1086
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1087
|
+
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">StringListOperators</span> {</div>
|
|
1088
|
+
<div class="graphql-code-line ">inList: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
|
|
1089
|
+
|
|
1090
|
+
|
|
1091
|
+
<div class="graphql-code-line top-level">}</div>
|
|
1092
|
+
</div>
|
|
1093
|
+
|
|
1094
|
+
## StringOperators
|
|
1095
|
+
|
|
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">Operators for filtering on a String field</div>
|
|
1099
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1100
|
+
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">StringOperators</span> {</div>
|
|
1101
|
+
<div class="graphql-code-line ">eq: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
|
|
1102
|
+
|
|
1103
|
+
<div class="graphql-code-line ">notEq: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
|
|
1104
|
+
|
|
1105
|
+
<div class="graphql-code-line ">contains: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
|
|
1106
|
+
|
|
1107
|
+
<div class="graphql-code-line ">notContains: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
|
|
1108
|
+
|
|
1109
|
+
<div class="graphql-code-line ">in: [<a href="/reference/graphql-api/shop/object-types#string">String</a>!]</div>
|
|
1110
|
+
|
|
1111
|
+
<div class="graphql-code-line ">notIn: [<a href="/reference/graphql-api/shop/object-types#string">String</a>!]</div>
|
|
1112
|
+
|
|
1113
|
+
<div class="graphql-code-line ">regex: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
|
|
1114
|
+
|
|
1115
|
+
<div class="graphql-code-line ">isNull: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a></div>
|
|
1116
|
+
|
|
1117
|
+
|
|
1118
|
+
<div class="graphql-code-line top-level">}</div>
|
|
1119
|
+
</div>
|
|
1120
|
+
|
|
1121
|
+
## UpdateAddressInput
|
|
1122
|
+
|
|
1123
|
+
<div class="graphql-code-block">
|
|
1124
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1125
|
+
<div class="graphql-code-line top-level comment">Input used to update an Address.</div>
|
|
1126
|
+
|
|
1127
|
+
<div class="graphql-code-line top-level comment"></div>
|
|
1128
|
+
|
|
1129
|
+
<div class="graphql-code-line top-level comment">The countryCode must correspond to a <code>code</code> property of a Country that has been defined in the</div>
|
|
1130
|
+
|
|
1131
|
+
<div class="graphql-code-line top-level comment">Vendure server. The <code>code</code> property is typically a 2-character ISO code such as "GB", "US", "DE" etc.</div>
|
|
1132
|
+
|
|
1133
|
+
<div class="graphql-code-line top-level comment">If an invalid code is passed, the mutation will fail.</div>
|
|
1134
|
+
<div class="graphql-code-line top-level comment">"""</div>
|
|
1135
|
+
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">UpdateAddressInput</span> {</div>
|
|
1136
|
+
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
|
|
1137
|
+
|
|
1138
|
+
<div class="graphql-code-line ">fullName: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
|
|
1139
|
+
|
|
1140
|
+
<div class="graphql-code-line ">company: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
|
|
1141
|
+
|
|
1142
|
+
<div class="graphql-code-line ">streetLine1: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
|
|
1143
|
+
|
|
1144
|
+
<div class="graphql-code-line ">streetLine2: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
|
|
1145
|
+
|
|
1146
|
+
<div class="graphql-code-line ">city: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
|
|
1147
|
+
|
|
1148
|
+
<div class="graphql-code-line ">province: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
|
|
1149
|
+
|
|
1150
|
+
<div class="graphql-code-line ">postalCode: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
|
|
1151
|
+
|
|
1152
|
+
<div class="graphql-code-line ">countryCode: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
|
|
1153
|
+
|
|
1154
|
+
<div class="graphql-code-line ">phoneNumber: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
|
|
1155
|
+
|
|
1156
|
+
<div class="graphql-code-line ">defaultShippingAddress: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a></div>
|
|
1157
|
+
|
|
1158
|
+
<div class="graphql-code-line ">defaultBillingAddress: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a></div>
|
|
1159
|
+
|
|
1160
|
+
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
|
|
1161
|
+
|
|
1162
|
+
|
|
1163
|
+
<div class="graphql-code-line top-level">}</div>
|
|
1164
|
+
</div>
|
|
1165
|
+
|
|
1166
|
+
## UpdateCustomerInput
|
|
1167
|
+
|
|
1168
|
+
<div class="graphql-code-block">
|
|
1169
|
+
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">UpdateCustomerInput</span> {</div>
|
|
1170
|
+
<div class="graphql-code-line ">title: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
|
|
1171
|
+
|
|
1172
|
+
<div class="graphql-code-line ">firstName: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
|
|
1173
|
+
|
|
1174
|
+
<div class="graphql-code-line ">lastName: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
|
|
1175
|
+
|
|
1176
|
+
<div class="graphql-code-line ">phoneNumber: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
|
|
1177
|
+
|
|
1178
|
+
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
|
|
1179
|
+
|
|
1180
|
+
|
|
1181
|
+
<div class="graphql-code-line top-level">}</div>
|
|
1182
|
+
</div>
|
|
1183
|
+
|
|
1184
|
+
## UpdateOrderInput
|
|
1185
|
+
|
|
1186
|
+
<div class="graphql-code-block">
|
|
1187
|
+
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">UpdateOrderInput</span> {</div>
|
|
1188
|
+
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
|
|
1189
|
+
|
|
1190
|
+
|
|
1191
|
+
<div class="graphql-code-line top-level">}</div>
|
|
1192
|
+
</div>
|