From ecfe2868d7d3a41a21464d71b33c790d6b2ee9c5 Mon Sep 17 00:00:00 2001 From: Lukas Heinze Date: Wed, 7 Aug 2024 09:28:10 +0200 Subject: [PATCH 1/9] SW6: updated api client to be compatible with Shopware 6.6.1.2 --- .../api-client/generated/core/ApiError.ts | 3 + .../generated/core/ApiRequestOptions.ts | 2 +- .../api-client/generated/core/ApiResult.ts | 3 +- .../generated/core/CancelablePromise.ts | 6 +- .../api-client/generated/core/OpenAPI.ts | 4 +- .../shopware/api-client/generated/index.ts | 11 + .../AccountNewsletterRecipientResult.ts | 10 +- .../api-client/generated/models/AclRole.ts | 1 - .../api-client/generated/models/App.ts | 1 - .../generated/models/AppActionButton.ts | 1 - .../models/AppAdministrationSnippet.ts | 1 - .../generated/models/AppCmsBlock.ts | 1 - .../generated/models/AppFlowAction.ts | 1 - .../generated/models/AppFlowEvent.ts | 1 - .../generated/models/AppPaymentMethod.ts | 1 - .../generated/models/AppScriptCondition.ts | 1 - .../generated/models/AppShippingMethod.ts | 13 + .../generated/models/AppTemplate.ts | 1 - .../generated/models/ArrayStruct.ts | 2 - .../generated/models/CalculatedPrice.ts | 30 ++ .../api-client/generated/models/Cart.ts | 2 - .../api-client/generated/models/CartItems.ts | 7 +- .../api-client/generated/models/Category.ts | 15 +- .../generated/models/CategoryJsonApi.ts | 63 ++- .../api-client/generated/models/CmsBlock.ts | 6 +- .../generated/models/CmsFactoryElement.ts | 10 + .../api-client/generated/models/CmsPage.ts | 9 +- .../api-client/generated/models/CmsSection.ts | 5 +- .../api-client/generated/models/CmsSlot.ts | 2 - .../api-client/generated/models/Country.ts | 6 +- .../generated/models/CountryJsonApi.ts | 16 +- .../generated/models/CountryState.ts | 3 +- .../generated/models/CountryStateJsonApi.ts | 4 +- .../api-client/generated/models/Criteria.ts | 9 +- .../generated/models/CrossSellingElement.ts | 14 + .../models/CrossSellingElementCollection.ts | 20 +- .../api-client/generated/models/Currency.ts | 15 +- .../models/CurrencyCountryRounding.ts | 1 - .../generated/models/CurrencyJsonApi.ts | 16 +- .../generated/models/CustomEntity.ts | 1 - .../generated/models/CustomField.ts | 1 - .../generated/models/CustomFieldSet.ts | 1 - .../models/CustomFieldSetRelation.ts | 1 - .../api-client/generated/models/Customer.ts | 10 +- .../generated/models/CustomerAddress.ts | 4 +- .../generated/models/CustomerGroup.ts | 10 +- .../generated/models/CustomerRecovery.ts | 1 - .../generated/models/CustomerTag.ts | 2 - .../generated/models/CustomerWishlist.ts | 3 +- .../models/CustomerWishlistProduct.ts | 3 +- .../generated/models/DeliveryTime.ts | 3 +- .../api-client/generated/models/Document.ts | 12 +- .../generated/models/DocumentBaseConfig.ts | 4 +- .../models/DocumentBaseConfigSalesChannel.ts | 3 +- .../generated/models/DocumentType.ts | 3 +- .../generated/models/EntitySearchResult.ts | 2 - .../models/FindProductVariantRouteResponse.ts | 1 - .../api-client/generated/models/Flow.ts | 1 - .../generated/models/FlowSequence.ts | 1 - .../generated/models/FlowTemplate.ts | 1 - .../generated/models/ImportExportFile.ts | 1 - .../generated/models/ImportExportLog.ts | 1 - .../generated/models/ImportExportProfile.ts | 1 - .../generated/models/Integration.ts | 1 - .../generated/models/LandingPage.ts | 7 +- .../generated/models/LandingPageJsonApi.ts | 25 +- .../api-client/generated/models/Language.ts | 6 +- .../generated/models/LanguageJsonApi.ts | 43 +- .../api-client/generated/models/LineItem.ts | 6 +- .../generated/models/LineItemType.ts | 5 + .../api-client/generated/models/ListPrice.ts | 11 + .../api-client/generated/models/Locale.ts | 3 +- .../api-client/generated/models/LogEntry.ts | 1 - .../generated/models/MailHeaderFooter.ts | 1 - .../generated/models/MailTemplate.ts | 4 +- .../generated/models/MailTemplateMedia.ts | 4 +- .../generated/models/MailTemplateType.ts | 3 +- .../generated/models/MainCategory.ts | 3 +- .../generated/models/MainCategoryJsonApi.ts | 4 +- .../api-client/generated/models/Media.ts | 17 +- .../generated/models/MediaDefaultFolder.ts | 1 - .../generated/models/MediaFolder.ts | 1 - .../models/MediaFolderConfiguration.ts | 1 - .../api-client/generated/models/MediaTag.ts | 2 - .../generated/models/MediaThumbnail.ts | 6 +- .../generated/models/MediaThumbnailSize.ts | 3 +- .../models/NavigationRouteResponse.ts | 2 - .../generated/models/NavigationType.ts | 5 + .../generated/models/NewsletterRecipient.ts | 1 - .../models/NewsletterRecipientJsonApi.ts | 2 - .../generated/models/Notification.ts | 1 - .../generated/models/NumberRange.ts | 1 - .../models/NumberRangeSalesChannel.ts | 1 - .../generated/models/NumberRangeState.ts | 1 - .../generated/models/NumberRangeType.ts | 1 - .../api-client/generated/models/Order.ts | 21 +- .../generated/models/OrderAddress.ts | 4 +- .../generated/models/OrderCustomer.ts | 6 +- .../generated/models/OrderDelivery.ts | 6 +- .../generated/models/OrderDeliveryPosition.ts | 3 +- .../generated/models/OrderLineItem.ts | 10 +- .../generated/models/OrderLineItemDownload.ts | 6 +- .../generated/models/OrderRouteResponse.ts | 4 +- .../api-client/generated/models/OrderTag.ts | 2 - .../generated/models/OrderTransaction.ts | 6 +- .../models/OrderTransactionCapture.ts | 7 +- .../models/OrderTransactionCaptureRefund.ts | 8 +- .../OrderTransactionCaptureRefundPosition.ts | 6 +- .../generated/models/PaymentMethod.ts | 9 +- .../generated/models/PaymentMethodJsonApi.ts | 21 +- .../api-client/generated/models/Plugin.ts | 1 - .../api-client/generated/models/Product.ts | 64 ++- .../models/ProductConfiguratorSetting.ts | 4 +- .../generated/models/ProductCrossSelling.ts | 3 +- .../ProductCrossSellingAssignedProducts.ts | 1 - .../generated/models/ProductDetailResponse.ts | 4 +- .../generated/models/ProductDownload.ts | 4 +- .../generated/models/ProductExport.ts | 1 - .../generated/models/ProductFeatureSet.ts | 1 - .../generated/models/ProductJsonApi.ts | 221 ++++++++- .../models/ProductKeywordDictionary.ts | 1 - .../models/ProductListingCriteria.ts | 2 - .../generated/models/ProductListingFlags.ts | 1 - .../generated/models/ProductListingResult.ts | 35 +- .../generated/models/ProductManufacturer.ts | 4 +- .../generated/models/ProductMedia.ts | 6 +- .../generated/models/ProductPrice.ts | 1 - .../generated/models/ProductReview.ts | 5 +- .../generated/models/ProductSearchConfig.ts | 1 - .../models/ProductSearchConfigField.ts | 1 - .../generated/models/ProductSearchKeyword.ts | 1 - .../generated/models/ProductSorting.ts | 1 - .../generated/models/ProductStream.ts | 3 +- .../generated/models/ProductStreamFilter.ts | 1 - .../generated/models/ProductVisibility.ts | 1 - .../api-client/generated/models/Promotion.ts | 1 - .../generated/models/PromotionDiscount.ts | 1 - .../models/PromotionDiscountPrices.ts | 1 - .../models/PromotionIndividualCode.ts | 1 - .../generated/models/PromotionSalesChannel.ts | 1 - .../generated/models/PromotionSetgroup.ts | 1 - .../generated/models/PropertyGroup.ts | 6 +- .../generated/models/PropertyGroupOption.ts | 7 +- .../generated/models/ReferencePrice.ts | 20 + .../api-client/generated/models/Rule.ts | 1 - .../generated/models/RuleCondition.ts | 1 - .../generated/models/SalesChannel.ts | 6 +- .../generated/models/SalesChannelAnalytics.ts | 1 - .../generated/models/SalesChannelContext.ts | 93 +--- .../generated/models/SalesChannelDomain.ts | 4 +- .../generated/models/SalesChannelType.ts | 1 - .../api-client/generated/models/Salutation.ts | 3 +- .../generated/models/SalutationJsonApi.ts | 4 +- .../generated/models/ScheduledTask.ts | 1 - .../api-client/generated/models/Script.ts | 1 - .../api-client/generated/models/SeoUrl.ts | 11 +- .../generated/models/SeoUrlJsonApi.ts | 10 +- .../generated/models/SeoUrlTemplate.ts | 1 - .../generated/models/ShippingMethod.ts | 9 +- .../generated/models/ShippingMethodJsonApi.ts | 62 ++- .../models/ShippingMethodPageRouteResponse.ts | 2 +- .../generated/models/ShippingMethodPrice.ts | 3 +- .../api-client/generated/models/Sitemap.ts | 6 +- .../api-client/generated/models/Snippet.ts | 1 - .../api-client/generated/models/SnippetSet.ts | 4 +- .../generated/models/StateMachine.ts | 6 +- .../generated/models/StateMachineHistory.ts | 2 - .../generated/models/StateMachineState.ts | 1 - .../models/StateMachineTransition.ts | 1 - .../api-client/generated/models/Struct.ts | 1 - .../generated/models/SuccessResponse.ts | 1 - .../generated/models/SystemConfig.ts | 4 +- .../api-client/generated/models/Tag.ts | 4 +- .../api-client/generated/models/Tax.ts | 3 +- .../generated/models/TaxProvider.ts | 3 +- .../api-client/generated/models/TaxRule.ts | 1 - .../generated/models/TaxRuleType.ts | 1 - .../api-client/generated/models/Theme.ts | 6 +- .../api-client/generated/models/Unit.ts | 3 +- .../api-client/generated/models/User.ts | 1 - .../generated/models/UserAccessKey.ts | 1 - .../api-client/generated/models/UserConfig.ts | 1 - .../generated/models/UserRecovery.ts | 1 - .../api-client/generated/models/Webhook.ts | 1 - .../generated/models/WebhookEventLog.ts | 1 - .../models/WishlistLoadRouteResponse.ts | 4 +- .../api-client/generated/models/accept.ts | 2 +- .../api-client/generated/models/attributes.ts | 2 +- .../generated/models/contentType.ts | 2 +- .../api-client/generated/models/data.ts | 2 - .../api-client/generated/models/error.ts | 6 +- .../api-client/generated/models/failure.ts | 2 - .../api-client/generated/models/info.ts | 2 - .../api-client/generated/models/jsonapi.ts | 2 - .../api-client/generated/models/link.ts | 2 - .../api-client/generated/models/linkage.ts | 2 - .../api-client/generated/models/links.ts | 2 - .../api-client/generated/models/meta.ts | 2 +- .../api-client/generated/models/pagination.ts | 1 - .../generated/models/relationshipLinks.ts | 2 +- .../generated/models/relationshipToMany.ts | 2 - .../generated/models/relationshipToOne.ts | 2 - .../generated/models/relationships.ts | 2 - .../api-client/generated/models/resource.ts | 2 - .../api-client/generated/models/success.ts | 2 - .../generated/services/AddressShopware.ts | 9 - .../generated/services/ApiShopware.ts | 3 - .../generated/services/AppShopware.ts | 3 - .../generated/services/AppSystemShopware.ts | 35 ++ .../generated/services/CartShopware.ts | 45 +- .../generated/services/CategoryShopware.ts | 102 ++--- .../generated/services/ContentShopware.ts | 32 +- .../generated/services/DocumentShopware.ts | 4 - .../EndpointsSupportingCriteriaShopware.ts | 430 +++++++++--------- .../services/LoginRegistrationShopware.ts | 8 - .../generated/services/NewsletterShopware.ts | 18 +- .../generated/services/OrderShopware.ts | 74 ++- .../services/PaymentMethodShopware.ts | 4 - .../services/PaymentShippingShopware.ts | 7 +- .../generated/services/ProductShopware.ts | 122 +++-- .../generated/services/ProfileShopware.ts | 19 +- .../generated/services/ScriptShopware.ts | 3 - .../services/SitemapRoutesShopware.ts | 7 +- .../services/SystemContextShopware.ts | 120 +++-- .../services/SystemInfoHealthcheckShopware.ts | 77 ++++ .../generated/services/WishlistShopware.ts | 7 - .../shopware/api-client/openapi3.json | 2 +- 227 files changed, 1409 insertions(+), 1122 deletions(-) create mode 100644 src/platforms/shopware/api-client/generated/models/AppShippingMethod.ts create mode 100644 src/platforms/shopware/api-client/generated/models/CalculatedPrice.ts create mode 100644 src/platforms/shopware/api-client/generated/models/CmsFactoryElement.ts create mode 100644 src/platforms/shopware/api-client/generated/models/CrossSellingElement.ts create mode 100644 src/platforms/shopware/api-client/generated/models/LineItemType.ts create mode 100644 src/platforms/shopware/api-client/generated/models/ListPrice.ts create mode 100644 src/platforms/shopware/api-client/generated/models/NavigationType.ts create mode 100644 src/platforms/shopware/api-client/generated/models/ReferencePrice.ts create mode 100644 src/platforms/shopware/api-client/generated/services/AppSystemShopware.ts create mode 100644 src/platforms/shopware/api-client/generated/services/SystemInfoHealthcheckShopware.ts diff --git a/src/platforms/shopware/api-client/generated/core/ApiError.ts b/src/platforms/shopware/api-client/generated/core/ApiError.ts index b1ebab63..5d518420 100644 --- a/src/platforms/shopware/api-client/generated/core/ApiError.ts +++ b/src/platforms/shopware/api-client/generated/core/ApiError.ts @@ -10,6 +10,7 @@ export class ApiError extends Error { public readonly statusCode: number; public readonly statusMessage: string; public readonly body: any; + public readonly response: any; public readonly request: ApiRequestOptions; constructor(request: ApiRequestOptions, response: ApiResult, message: string) { @@ -19,7 +20,9 @@ export class ApiError extends Error { this.url = response.url; this.statusCode = response.status; this.statusMessage = response.statusText; + // @ts-ignore this.body = response._data.errors; + this.response = response; this.request = request; } } diff --git a/src/platforms/shopware/api-client/generated/core/ApiRequestOptions.ts b/src/platforms/shopware/api-client/generated/core/ApiRequestOptions.ts index a078b413..c19adcc9 100644 --- a/src/platforms/shopware/api-client/generated/core/ApiRequestOptions.ts +++ b/src/platforms/shopware/api-client/generated/core/ApiRequestOptions.ts @@ -1,7 +1,7 @@ /* generated using openapi-typescript-codegen -- do no edit */ /* istanbul ignore file */ /* tslint:disable */ - +/* eslint-disable */ export type ApiRequestOptions = { readonly method: 'GET' | 'PUT' | 'POST' | 'DELETE' | 'OPTIONS' | 'HEAD' | 'PATCH'; readonly url: string; diff --git a/src/platforms/shopware/api-client/generated/core/ApiResult.ts b/src/platforms/shopware/api-client/generated/core/ApiResult.ts index 4381046d..ad8fef2b 100644 --- a/src/platforms/shopware/api-client/generated/core/ApiResult.ts +++ b/src/platforms/shopware/api-client/generated/core/ApiResult.ts @@ -1,9 +1,8 @@ /* generated using openapi-typescript-codegen -- do no edit */ /* istanbul ignore file */ /* tslint:disable */ - +/* eslint-disable */ export type ApiResult = { - readonly _data: any readonly url: string; readonly ok: boolean; readonly status: number; diff --git a/src/platforms/shopware/api-client/generated/core/CancelablePromise.ts b/src/platforms/shopware/api-client/generated/core/CancelablePromise.ts index 55fef851..eb02246c 100644 --- a/src/platforms/shopware/api-client/generated/core/CancelablePromise.ts +++ b/src/platforms/shopware/api-client/generated/core/CancelablePromise.ts @@ -51,7 +51,7 @@ export class CancelablePromise implements Promise { return; } this.#isResolved = true; - this.#resolve?.(value); + if (this.#resolve) this.#resolve(value); }; const onReject = (reason?: any): void => { @@ -59,7 +59,7 @@ export class CancelablePromise implements Promise { return; } this.#isRejected = true; - this.#reject?.(reason); + if (this.#reject) this.#reject(reason); }; const onCancel = (cancelHandler: () => void): void => { @@ -122,7 +122,7 @@ export class CancelablePromise implements Promise { } } this.#cancelHandlers.length = 0; - this.#reject?.(new CancelError('Request aborted')); + if (this.#reject) this.#reject(new CancelError('Request aborted')); } public get isCancelled(): boolean { diff --git a/src/platforms/shopware/api-client/generated/core/OpenAPI.ts b/src/platforms/shopware/api-client/generated/core/OpenAPI.ts index ad25a722..bf2678cb 100644 --- a/src/platforms/shopware/api-client/generated/core/OpenAPI.ts +++ b/src/platforms/shopware/api-client/generated/core/OpenAPI.ts @@ -20,8 +20,8 @@ export type OpenAPIConfig = { }; export const OpenAPI: OpenAPIConfig = { - BASE: 'http://localhost/store-api', - VERSION: '6.5.3.3', + BASE: 'https://sw661-playground.dmf-kunden.com/store-api', + VERSION: '6.6.1.2', WITH_CREDENTIALS: false, CREDENTIALS: 'include', TOKEN: undefined, diff --git a/src/platforms/shopware/api-client/generated/index.ts b/src/platforms/shopware/api-client/generated/index.ts index 184f882e..fb62617d 100644 --- a/src/platforms/shopware/api-client/generated/index.ts +++ b/src/platforms/shopware/api-client/generated/index.ts @@ -6,6 +6,7 @@ export { ApiError } from './core/ApiError'; export { CancelablePromise, CancelError } from './core/CancelablePromise'; export { OpenAPI } from './core/OpenAPI'; export type { OpenAPIConfig } from './core/OpenAPI'; + export type { accept } from './models/accept'; export type { AccountNewsletterRecipientResult } from './models/AccountNewsletterRecipientResult'; export type { AclRole } from './models/AclRole'; @@ -17,14 +18,17 @@ export type { AppFlowAction } from './models/AppFlowAction'; export type { AppFlowEvent } from './models/AppFlowEvent'; export type { AppPaymentMethod } from './models/AppPaymentMethod'; export type { AppScriptCondition } from './models/AppScriptCondition'; +export type { AppShippingMethod } from './models/AppShippingMethod'; export type { AppTemplate } from './models/AppTemplate'; export type { ArrayStruct } from './models/ArrayStruct'; export type { attributes } from './models/attributes'; +export type { CalculatedPrice } from './models/CalculatedPrice'; export type { Cart } from './models/Cart'; export type { CartItems } from './models/CartItems'; export type { Category } from './models/Category'; export type { CategoryJsonApi } from './models/CategoryJsonApi'; export type { CmsBlock } from './models/CmsBlock'; +export type { CmsFactoryElement } from './models/CmsFactoryElement'; export type { CmsPage } from './models/CmsPage'; export type { CmsSection } from './models/CmsSection'; export type { CmsSlot } from './models/CmsSlot'; @@ -34,6 +38,7 @@ export type { CountryJsonApi } from './models/CountryJsonApi'; export type { CountryState } from './models/CountryState'; export type { CountryStateJsonApi } from './models/CountryStateJsonApi'; export type { Criteria } from './models/Criteria'; +export type { CrossSellingElement } from './models/CrossSellingElement'; export type { CrossSellingElementCollection } from './models/CrossSellingElementCollection'; export type { Currency } from './models/Currency'; export type { CurrencyCountryRounding } from './models/CurrencyCountryRounding'; @@ -73,9 +78,11 @@ export type { LandingPageJsonApi } from './models/LandingPageJsonApi'; export type { Language } from './models/Language'; export type { LanguageJsonApi } from './models/LanguageJsonApi'; export type { LineItem } from './models/LineItem'; +export type { LineItemType } from './models/LineItemType'; export type { link } from './models/link'; export type { linkage } from './models/linkage'; export type { links } from './models/links'; +export type { ListPrice } from './models/ListPrice'; export type { Locale } from './models/Locale'; export type { LogEntry } from './models/LogEntry'; export type { MailHeaderFooter } from './models/MailHeaderFooter'; @@ -93,6 +100,7 @@ export type { MediaThumbnail } from './models/MediaThumbnail'; export type { MediaThumbnailSize } from './models/MediaThumbnailSize'; export type { meta } from './models/meta'; export type { NavigationRouteResponse } from './models/NavigationRouteResponse'; +export type { NavigationType } from './models/NavigationType'; export type { NewsletterRecipient } from './models/NewsletterRecipient'; export type { NewsletterRecipientJsonApi } from './models/NewsletterRecipientJsonApi'; export type { Notification } from './models/Notification'; @@ -149,6 +157,7 @@ export type { PromotionSalesChannel } from './models/PromotionSalesChannel'; export type { PromotionSetgroup } from './models/PromotionSetgroup'; export type { PropertyGroup } from './models/PropertyGroup'; export type { PropertyGroupOption } from './models/PropertyGroupOption'; +export type { ReferencePrice } from './models/ReferencePrice'; export type { relationshipLinks } from './models/relationshipLinks'; export type { relationships } from './models/relationships'; export type { relationshipToMany } from './models/relationshipToMany'; @@ -201,6 +210,7 @@ export type { WishlistLoadRouteResponse } from './models/WishlistLoadRouteRespon export { AddressShopware } from './services/AddressShopware'; export { ApiShopware } from './services/ApiShopware'; export { AppShopware } from './services/AppShopware'; +export { AppSystemShopware } from './services/AppSystemShopware'; export { CartShopware } from './services/CartShopware'; export { CategoryShopware } from './services/CategoryShopware'; export { ContentShopware } from './services/ContentShopware'; @@ -217,4 +227,5 @@ export { ScriptShopware } from './services/ScriptShopware'; export { PwaShopware } from './services/PwaShopware'; export { SitemapRoutesShopware } from './services/SitemapRoutesShopware'; export { SystemContextShopware } from './services/SystemContextShopware'; +export { SystemInfoHealthcheckShopware } from './services/SystemInfoHealthcheckShopware'; export { WishlistShopware } from './services/WishlistShopware'; diff --git a/src/platforms/shopware/api-client/generated/models/AccountNewsletterRecipientResult.ts b/src/platforms/shopware/api-client/generated/models/AccountNewsletterRecipientResult.ts index 488c2069..f4909c5a 100644 --- a/src/platforms/shopware/api-client/generated/models/AccountNewsletterRecipientResult.ts +++ b/src/platforms/shopware/api-client/generated/models/AccountNewsletterRecipientResult.ts @@ -2,10 +2,8 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - -import type { Struct } from './Struct'; - -export type AccountNewsletterRecipientResult = (Struct & { - status?: string; -}); +export type AccountNewsletterRecipientResult = { + status: 'undefined' | 'notSet' | 'direct' | 'optIn' | 'optOut'; + apiAlias: 'account_newsletter_recipient'; +}; diff --git a/src/platforms/shopware/api-client/generated/models/AclRole.ts b/src/platforms/shopware/api-client/generated/models/AclRole.ts index 22dc2dc7..4ff691bd 100644 --- a/src/platforms/shopware/api-client/generated/models/AclRole.ts +++ b/src/platforms/shopware/api-client/generated/models/AclRole.ts @@ -2,7 +2,6 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - /** * Added since version: 6.0.0.0 */ diff --git a/src/platforms/shopware/api-client/generated/models/App.ts b/src/platforms/shopware/api-client/generated/models/App.ts index 06599945..7fa9f7e8 100644 --- a/src/platforms/shopware/api-client/generated/models/App.ts +++ b/src/platforms/shopware/api-client/generated/models/App.ts @@ -2,7 +2,6 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - /** * Added since version: 6.3.1.0 */ diff --git a/src/platforms/shopware/api-client/generated/models/AppActionButton.ts b/src/platforms/shopware/api-client/generated/models/AppActionButton.ts index 1e7a2a18..b1807058 100644 --- a/src/platforms/shopware/api-client/generated/models/AppActionButton.ts +++ b/src/platforms/shopware/api-client/generated/models/AppActionButton.ts @@ -2,7 +2,6 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - /** * Added since version: 6.3.1.0 */ diff --git a/src/platforms/shopware/api-client/generated/models/AppAdministrationSnippet.ts b/src/platforms/shopware/api-client/generated/models/AppAdministrationSnippet.ts index dd6e098d..46daf7de 100644 --- a/src/platforms/shopware/api-client/generated/models/AppAdministrationSnippet.ts +++ b/src/platforms/shopware/api-client/generated/models/AppAdministrationSnippet.ts @@ -2,7 +2,6 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - /** * Added since version: 6.4.15.0 */ diff --git a/src/platforms/shopware/api-client/generated/models/AppCmsBlock.ts b/src/platforms/shopware/api-client/generated/models/AppCmsBlock.ts index ed856ae8..224cdc6d 100644 --- a/src/platforms/shopware/api-client/generated/models/AppCmsBlock.ts +++ b/src/platforms/shopware/api-client/generated/models/AppCmsBlock.ts @@ -2,7 +2,6 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - /** * Added since version: 6.4.2.0 */ diff --git a/src/platforms/shopware/api-client/generated/models/AppFlowAction.ts b/src/platforms/shopware/api-client/generated/models/AppFlowAction.ts index 7d604056..b2f3e1f7 100644 --- a/src/platforms/shopware/api-client/generated/models/AppFlowAction.ts +++ b/src/platforms/shopware/api-client/generated/models/AppFlowAction.ts @@ -2,7 +2,6 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - /** * Added since version: 6.4.10.0 */ diff --git a/src/platforms/shopware/api-client/generated/models/AppFlowEvent.ts b/src/platforms/shopware/api-client/generated/models/AppFlowEvent.ts index 34116326..74d6ea34 100644 --- a/src/platforms/shopware/api-client/generated/models/AppFlowEvent.ts +++ b/src/platforms/shopware/api-client/generated/models/AppFlowEvent.ts @@ -2,7 +2,6 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - /** * Added since version: 6.5.2.0 */ diff --git a/src/platforms/shopware/api-client/generated/models/AppPaymentMethod.ts b/src/platforms/shopware/api-client/generated/models/AppPaymentMethod.ts index ce4ac2f4..b0c3ca32 100644 --- a/src/platforms/shopware/api-client/generated/models/AppPaymentMethod.ts +++ b/src/platforms/shopware/api-client/generated/models/AppPaymentMethod.ts @@ -2,7 +2,6 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - /** * Added since version: 6.4.1.0 */ diff --git a/src/platforms/shopware/api-client/generated/models/AppScriptCondition.ts b/src/platforms/shopware/api-client/generated/models/AppScriptCondition.ts index c5160c20..aec42f70 100644 --- a/src/platforms/shopware/api-client/generated/models/AppScriptCondition.ts +++ b/src/platforms/shopware/api-client/generated/models/AppScriptCondition.ts @@ -2,7 +2,6 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - /** * Added since version: 6.4.10.3 */ diff --git a/src/platforms/shopware/api-client/generated/models/AppShippingMethod.ts b/src/platforms/shopware/api-client/generated/models/AppShippingMethod.ts new file mode 100644 index 00000000..f8de8b27 --- /dev/null +++ b/src/platforms/shopware/api-client/generated/models/AppShippingMethod.ts @@ -0,0 +1,13 @@ +/* generated using openapi-typescript-codegen -- do no edit */ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +/** + * Added since version: 6.5.7.0 + */ +export type AppShippingMethod = { + id?: string; + readonly createdAt: string; + readonly updatedAt?: string; +}; + diff --git a/src/platforms/shopware/api-client/generated/models/AppTemplate.ts b/src/platforms/shopware/api-client/generated/models/AppTemplate.ts index fc05f2f1..5e6683e3 100644 --- a/src/platforms/shopware/api-client/generated/models/AppTemplate.ts +++ b/src/platforms/shopware/api-client/generated/models/AppTemplate.ts @@ -2,7 +2,6 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - /** * Added since version: 6.3.1.0 */ diff --git a/src/platforms/shopware/api-client/generated/models/ArrayStruct.ts b/src/platforms/shopware/api-client/generated/models/ArrayStruct.ts index a62925b2..c413446c 100644 --- a/src/platforms/shopware/api-client/generated/models/ArrayStruct.ts +++ b/src/platforms/shopware/api-client/generated/models/ArrayStruct.ts @@ -2,7 +2,5 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - import type { Struct } from './Struct'; - export type ArrayStruct = Struct; diff --git a/src/platforms/shopware/api-client/generated/models/CalculatedPrice.ts b/src/platforms/shopware/api-client/generated/models/CalculatedPrice.ts new file mode 100644 index 00000000..f91c43bb --- /dev/null +++ b/src/platforms/shopware/api-client/generated/models/CalculatedPrice.ts @@ -0,0 +1,30 @@ +/* generated using openapi-typescript-codegen -- do no edit */ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import type { ListPrice } from './ListPrice'; +import type { ReferencePrice } from './ReferencePrice'; +/** + * Represents a product along with detailed information required to display a variant selection. + */ +export type CalculatedPrice = { + unitPrice: number; + quantity: number; + totalPrice: number; + calculatedTaxes: Array<{ + apiAlias: 'cart_tax_calculated'; + tax: number; + taxRate: number; + price: number; + }>; + referencePrice: ReferencePrice | null; + listPrice: ListPrice | null; + regulationPrice: { + price?: number; + apiAlias?: 'cart_regulation_price'; + } | null; + hasRange: boolean; + variantId?: string | null; + apiAlias: 'calculated_price'; +}; + diff --git a/src/platforms/shopware/api-client/generated/models/Cart.ts b/src/platforms/shopware/api-client/generated/models/Cart.ts index bdce0837..9dfd7248 100644 --- a/src/platforms/shopware/api-client/generated/models/Cart.ts +++ b/src/platforms/shopware/api-client/generated/models/Cart.ts @@ -2,10 +2,8 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - import type { LineItem } from './LineItem'; import type { Struct } from './Struct'; - export type Cart = (Struct & { /** * Name of the cart - for example `guest-cart` diff --git a/src/platforms/shopware/api-client/generated/models/CartItems.ts b/src/platforms/shopware/api-client/generated/models/CartItems.ts index 3d310995..72c6739f 100644 --- a/src/platforms/shopware/api-client/generated/models/CartItems.ts +++ b/src/platforms/shopware/api-client/generated/models/CartItems.ts @@ -2,11 +2,8 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - import type { LineItem } from './LineItem'; -import type { Struct } from './Struct'; - -export type CartItems = (Struct & { +export type CartItems = { items?: Array; -}); +}; diff --git a/src/platforms/shopware/api-client/generated/models/Category.ts b/src/platforms/shopware/api-client/generated/models/Category.ts index c0c5df39..9795cea1 100644 --- a/src/platforms/shopware/api-client/generated/models/Category.ts +++ b/src/platforms/shopware/api-client/generated/models/Category.ts @@ -2,16 +2,15 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - import type { CmsPage } from './CmsPage'; import type { Media } from './Media'; import type { SeoUrl } from './SeoUrl'; - +import type { Tag } from './Tag'; /** * Added since version: 6.0.0.0 */ export type Category = { - id?: string; + id: string; versionId?: string; parentId?: string; parentVersionId?: string; @@ -19,10 +18,10 @@ export type Category = { afterCategoryVersionId?: string; mediaId?: string; displayNestedProducts: boolean; - readonly breadcrumb?: Array; + readonly breadcrumb: Array; readonly level?: number; readonly path?: string; - readonly childCount?: number; + readonly childCount: number; type: string; productAssignmentType: string; visible?: boolean; @@ -50,11 +49,13 @@ export type Category = { customEntityTypeId?: string; readonly createdAt: string; readonly updatedAt?: string; - translated?: Record; + translated: Record; parent?: Category; - children?: Array; + children: Array | null; media?: Media; + tags?: Array; cmsPage?: CmsPage; seoUrls?: Array; + apiAlias?: 'category'; }; diff --git a/src/platforms/shopware/api-client/generated/models/CategoryJsonApi.ts b/src/platforms/shopware/api-client/generated/models/CategoryJsonApi.ts index 34f9bcad..6f31cc69 100644 --- a/src/platforms/shopware/api-client/generated/models/CategoryJsonApi.ts +++ b/src/platforms/shopware/api-client/generated/models/CategoryJsonApi.ts @@ -2,14 +2,12 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - import type { resource } from './resource'; - /** * Added since version: 6.0.0.0 */ export type CategoryJsonApi = (resource & { - id?: string; + id: string; versionId?: string; parentId?: string; parentVersionId?: string; @@ -17,7 +15,7 @@ export type CategoryJsonApi = (resource & { afterCategoryVersionId?: string; mediaId?: string; displayNestedProducts: boolean; - readonly breadcrumb?: Array; + readonly breadcrumb?: Array>; readonly level?: number; readonly path?: string; readonly childCount?: number; @@ -49,6 +47,61 @@ export type CategoryJsonApi = (resource & { readonly createdAt: string; readonly updatedAt?: string; translated?: Record; - relationships?: any; + relationships?: { + parent?: { + links?: { + related?: string; + }; + data?: { + type?: string; + id?: string; + }; + }; + children?: { + links?: { + related?: string; + }; + data?: Array<{ + type?: string; + id?: string; + }>; + }; + media?: { + links?: { + related?: string; + }; + data?: { + type?: string; + id?: string; + }; + }; + tags?: { + links?: { + related?: string; + }; + data?: Array<{ + type?: string; + id?: string; + }>; + }; + cmsPage?: { + links?: { + related?: string; + }; + data?: { + type?: string; + id?: string; + }; + }; + seoUrls?: { + links?: { + related?: string; + }; + data?: Array<{ + type?: string; + id?: string; + }>; + }; + }; }); diff --git a/src/platforms/shopware/api-client/generated/models/CmsBlock.ts b/src/platforms/shopware/api-client/generated/models/CmsBlock.ts index c7c3a2b9..314a8042 100644 --- a/src/platforms/shopware/api-client/generated/models/CmsBlock.ts +++ b/src/platforms/shopware/api-client/generated/models/CmsBlock.ts @@ -2,15 +2,12 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - import type { CmsSlot } from './CmsSlot'; import type { Media } from './Media'; - /** * Added since version: 6.0.0.0 */ export type CmsBlock = { - _uniqueIdentifier: string, id?: string; position: number; type: string; @@ -36,6 +33,7 @@ export type CmsBlock = { readonly createdAt: string; readonly updatedAt?: string; backgroundMedia?: Media; - slots?: CmsSlot[]; + slots: Array; + apiAlias: 'cms_block'; }; diff --git a/src/platforms/shopware/api-client/generated/models/CmsFactoryElement.ts b/src/platforms/shopware/api-client/generated/models/CmsFactoryElement.ts new file mode 100644 index 00000000..2c452306 --- /dev/null +++ b/src/platforms/shopware/api-client/generated/models/CmsFactoryElement.ts @@ -0,0 +1,10 @@ +/* generated using openapi-typescript-codegen -- do no edit */ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +export type CmsFactoryElement = { + id?: string; + readonly createdAt: string; + readonly updatedAt?: string; +}; + diff --git a/src/platforms/shopware/api-client/generated/models/CmsPage.ts b/src/platforms/shopware/api-client/generated/models/CmsPage.ts index 46612af2..ea2756e5 100644 --- a/src/platforms/shopware/api-client/generated/models/CmsPage.ts +++ b/src/platforms/shopware/api-client/generated/models/CmsPage.ts @@ -2,16 +2,14 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - import type { CmsSection } from './CmsSection'; import type { LandingPage } from './LandingPage'; import type { Media } from './Media'; - /** * Added since version: 6.0.0.0 */ export type CmsPage = { - id?: string; + id: string; versionId?: string; name?: string; type: string; @@ -25,8 +23,9 @@ export type CmsPage = { readonly createdAt: string; readonly updatedAt?: string; translated?: Record; - sections?: CmsSection; + sections: Array; previewMedia?: Media; - landingPages?: LandingPage; + landingPages?: Array; + apiAlias: 'cms_page'; }; diff --git a/src/platforms/shopware/api-client/generated/models/CmsSection.ts b/src/platforms/shopware/api-client/generated/models/CmsSection.ts index 05c23c5a..c3c9a6b8 100644 --- a/src/platforms/shopware/api-client/generated/models/CmsSection.ts +++ b/src/platforms/shopware/api-client/generated/models/CmsSection.ts @@ -2,11 +2,9 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - import type { CmsBlock } from './CmsBlock'; import type { CmsPage } from './CmsPage'; import type { Media } from './Media'; - /** * Added since version: 6.0.0.0 */ @@ -33,6 +31,7 @@ export type CmsSection = { readonly updatedAt?: string; page?: CmsPage; backgroundMedia?: Media; - blocks?: CmsBlock[]; + blocks: Array; + apiAlias: 'cms_section'; }; diff --git a/src/platforms/shopware/api-client/generated/models/CmsSlot.ts b/src/platforms/shopware/api-client/generated/models/CmsSlot.ts index ed279bef..a1457601 100644 --- a/src/platforms/shopware/api-client/generated/models/CmsSlot.ts +++ b/src/platforms/shopware/api-client/generated/models/CmsSlot.ts @@ -2,9 +2,7 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - import type { CmsBlock } from './CmsBlock'; - /** * Added since version: 6.0.0.0 */ diff --git a/src/platforms/shopware/api-client/generated/models/Country.ts b/src/platforms/shopware/api-client/generated/models/Country.ts index 8729fa83..a65516b9 100644 --- a/src/platforms/shopware/api-client/generated/models/Country.ts +++ b/src/platforms/shopware/api-client/generated/models/Country.ts @@ -2,14 +2,12 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - import type { CountryState } from './CountryState'; - /** * Added since version: 6.0.0.0 */ export type Country = { - id?: string; + id: string; name: string; iso?: string; position?: number; @@ -41,6 +39,6 @@ export type Country = { readonly createdAt: string; readonly updatedAt?: string; translated?: Record; - states?: CountryState; + states?: Array; }; diff --git a/src/platforms/shopware/api-client/generated/models/CountryJsonApi.ts b/src/platforms/shopware/api-client/generated/models/CountryJsonApi.ts index edd3f2aa..a2ef20fa 100644 --- a/src/platforms/shopware/api-client/generated/models/CountryJsonApi.ts +++ b/src/platforms/shopware/api-client/generated/models/CountryJsonApi.ts @@ -2,14 +2,12 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - import type { resource } from './resource'; - /** * Added since version: 6.0.0.0 */ export type CountryJsonApi = (resource & { - id?: string; + id: string; name: string; iso?: string; position?: number; @@ -41,6 +39,16 @@ export type CountryJsonApi = (resource & { readonly createdAt: string; readonly updatedAt?: string; translated?: Record; - relationships?: any; + relationships?: { + states?: { + links?: { + related?: string; + }; + data?: Array<{ + type?: string; + id?: string; + }>; + }; + }; }); diff --git a/src/platforms/shopware/api-client/generated/models/CountryState.ts b/src/platforms/shopware/api-client/generated/models/CountryState.ts index aaa684ec..e955befe 100644 --- a/src/platforms/shopware/api-client/generated/models/CountryState.ts +++ b/src/platforms/shopware/api-client/generated/models/CountryState.ts @@ -2,12 +2,11 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - /** * Added since version: 6.0.0.0 */ export type CountryState = { - id?: string; + id: string; countryId: string; shortCode: string; name: string; diff --git a/src/platforms/shopware/api-client/generated/models/CountryStateJsonApi.ts b/src/platforms/shopware/api-client/generated/models/CountryStateJsonApi.ts index c63bc613..bf719a4d 100644 --- a/src/platforms/shopware/api-client/generated/models/CountryStateJsonApi.ts +++ b/src/platforms/shopware/api-client/generated/models/CountryStateJsonApi.ts @@ -2,14 +2,12 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - import type { resource } from './resource'; - /** * Added since version: 6.0.0.0 */ export type CountryStateJsonApi = (resource & { - id?: string; + id: string; countryId: string; shortCode: string; name: string; diff --git a/src/platforms/shopware/api-client/generated/models/Criteria.ts b/src/platforms/shopware/api-client/generated/models/Criteria.ts index 3c6eb8fb..e400823b 100644 --- a/src/platforms/shopware/api-client/generated/models/Criteria.ts +++ b/src/platforms/shopware/api-client/generated/models/Criteria.ts @@ -2,7 +2,6 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - /** * Search parameters. For more information, see our documentation on [Search Queries](https://shopware.stoplight.io/docs/store-api/docs/concepts/search-queries.md#structure) */ @@ -69,12 +68,8 @@ export type Criteria = { */ fields?: Array; /** - * Whether the total for the total number of hits should be determined for the search query. 0 = disabled total count, 1 = calculate exact total amount (slow), 2 = calculate only for next page (fast) - */ - 'total-count-mode'?: 0 | 1 | 2; - /** - * Restricts the output to the defined fields + * Whether the total for the total number of hits should be determined for the search query. none = disabled total count, exact = calculate exact total amount (slow), next-pages = calculate only for next page (fast) */ - includes?: any; + 'total-count-mode'?: 'none' | 'exact' | 'next-pages'; }; diff --git a/src/platforms/shopware/api-client/generated/models/CrossSellingElement.ts b/src/platforms/shopware/api-client/generated/models/CrossSellingElement.ts new file mode 100644 index 00000000..e0a1c060 --- /dev/null +++ b/src/platforms/shopware/api-client/generated/models/CrossSellingElement.ts @@ -0,0 +1,14 @@ +/* generated using openapi-typescript-codegen -- do no edit */ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import type { Product } from './Product'; +import type { ProductCrossSelling } from './ProductCrossSelling'; +export type CrossSellingElement = { + crossSelling: ProductCrossSelling; + products: Array; + total: number; + streamId?: string; + apiAlias: 'cross_selling_element'; +}; + diff --git a/src/platforms/shopware/api-client/generated/models/CrossSellingElementCollection.ts b/src/platforms/shopware/api-client/generated/models/CrossSellingElementCollection.ts index 5ad8c858..f983bf4e 100644 --- a/src/platforms/shopware/api-client/generated/models/CrossSellingElementCollection.ts +++ b/src/platforms/shopware/api-client/generated/models/CrossSellingElementCollection.ts @@ -2,21 +2,5 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - -import type { Product } from './Product'; - -export type CrossSellingElementCollection = Array<{ - crossSelling?: { - name?: string; - position?: number; - sortBy?: string; - sortDirection?: string; - limit?: number; - active?: boolean; - productId?: string; - productStreamId?: string; - type?: string; - }; - products?: Array; - total?: number; -}>; +import type { CrossSellingElement } from './CrossSellingElement'; +export type CrossSellingElementCollection = Array; diff --git a/src/platforms/shopware/api-client/generated/models/Currency.ts b/src/platforms/shopware/api-client/generated/models/Currency.ts index 35834191..2c9f9c50 100644 --- a/src/platforms/shopware/api-client/generated/models/Currency.ts +++ b/src/platforms/shopware/api-client/generated/models/Currency.ts @@ -2,12 +2,11 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - /** * Added since version: 6.0.0.0 */ export type Currency = { - id?: string; + id: string; factor: number; symbol: string; isoCode: string; @@ -21,14 +20,14 @@ export type Currency = { taxFreeFrom?: number; customFields?: Record; itemRounding: { - decimals?: number; - interval?: number; - roundForNet?: boolean; + decimals: number; + interval: number; + roundForNet: boolean; }; totalRounding: { - decimals?: number; - interval?: number; - roundForNet?: boolean; + decimals: number; + interval: number; + roundForNet: boolean; }; readonly createdAt: string; readonly updatedAt?: string; diff --git a/src/platforms/shopware/api-client/generated/models/CurrencyCountryRounding.ts b/src/platforms/shopware/api-client/generated/models/CurrencyCountryRounding.ts index 851614c2..afec672a 100644 --- a/src/platforms/shopware/api-client/generated/models/CurrencyCountryRounding.ts +++ b/src/platforms/shopware/api-client/generated/models/CurrencyCountryRounding.ts @@ -2,7 +2,6 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - /** * Added since version: 6.4.0.0 */ diff --git a/src/platforms/shopware/api-client/generated/models/CurrencyJsonApi.ts b/src/platforms/shopware/api-client/generated/models/CurrencyJsonApi.ts index daa81f80..b5e6d963 100644 --- a/src/platforms/shopware/api-client/generated/models/CurrencyJsonApi.ts +++ b/src/platforms/shopware/api-client/generated/models/CurrencyJsonApi.ts @@ -2,14 +2,12 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - import type { resource } from './resource'; - /** * Added since version: 6.0.0.0 */ export type CurrencyJsonApi = (resource & { - id?: string; + id: string; factor: number; symbol: string; isoCode: string; @@ -23,14 +21,14 @@ export type CurrencyJsonApi = (resource & { taxFreeFrom?: number; customFields?: Record; itemRounding: { - decimals?: number; - interval?: number; - roundForNet?: boolean; + decimals: number; + interval: number; + roundForNet: boolean; }; totalRounding: { - decimals?: number; - interval?: number; - roundForNet?: boolean; + decimals: number; + interval: number; + roundForNet: boolean; }; readonly createdAt: string; readonly updatedAt?: string; diff --git a/src/platforms/shopware/api-client/generated/models/CustomEntity.ts b/src/platforms/shopware/api-client/generated/models/CustomEntity.ts index 0ea8ab0e..91023d87 100644 --- a/src/platforms/shopware/api-client/generated/models/CustomEntity.ts +++ b/src/platforms/shopware/api-client/generated/models/CustomEntity.ts @@ -2,7 +2,6 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - /** * Added since version: 6.4.9.0 */ diff --git a/src/platforms/shopware/api-client/generated/models/CustomField.ts b/src/platforms/shopware/api-client/generated/models/CustomField.ts index 90fa7367..95caa02a 100644 --- a/src/platforms/shopware/api-client/generated/models/CustomField.ts +++ b/src/platforms/shopware/api-client/generated/models/CustomField.ts @@ -2,7 +2,6 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - /** * Added since version: 6.0.0.0 */ diff --git a/src/platforms/shopware/api-client/generated/models/CustomFieldSet.ts b/src/platforms/shopware/api-client/generated/models/CustomFieldSet.ts index 4dbb7ed1..117ada91 100644 --- a/src/platforms/shopware/api-client/generated/models/CustomFieldSet.ts +++ b/src/platforms/shopware/api-client/generated/models/CustomFieldSet.ts @@ -2,7 +2,6 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - /** * Added since version: 6.0.0.0 */ diff --git a/src/platforms/shopware/api-client/generated/models/CustomFieldSetRelation.ts b/src/platforms/shopware/api-client/generated/models/CustomFieldSetRelation.ts index 074050de..f7f7a8ee 100644 --- a/src/platforms/shopware/api-client/generated/models/CustomFieldSetRelation.ts +++ b/src/platforms/shopware/api-client/generated/models/CustomFieldSetRelation.ts @@ -2,7 +2,6 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - /** * Added since version: 6.0.0.0 */ diff --git a/src/platforms/shopware/api-client/generated/models/Customer.ts b/src/platforms/shopware/api-client/generated/models/Customer.ts index c5510889..6a1af421 100644 --- a/src/platforms/shopware/api-client/generated/models/Customer.ts +++ b/src/platforms/shopware/api-client/generated/models/Customer.ts @@ -2,18 +2,17 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - import type { CustomerAddress } from './CustomerAddress'; import type { CustomerGroup } from './CustomerGroup'; import type { Language } from './Language'; import type { PaymentMethod } from './PaymentMethod'; import type { Salutation } from './Salutation'; - +import type { Tag } from './Tag'; /** * Added since version: 6.0.0.0 */ export type Customer = { - id?: string; + id: string; groupId: string; defaultPaymentMethodId: string; salesChannelId: string; @@ -56,8 +55,11 @@ export type Customer = { language?: Language; lastPaymentMethod?: PaymentMethod; defaultBillingAddress?: CustomerAddress; + activeBillingAddress?: CustomerAddress; defaultShippingAddress?: CustomerAddress; + activeShippingAddress?: CustomerAddress; salutation?: Salutation; - addresses?: CustomerAddress; + addresses?: Array; + tags?: Array; }; diff --git a/src/platforms/shopware/api-client/generated/models/CustomerAddress.ts b/src/platforms/shopware/api-client/generated/models/CustomerAddress.ts index d78cdb1f..7fabcf81 100644 --- a/src/platforms/shopware/api-client/generated/models/CustomerAddress.ts +++ b/src/platforms/shopware/api-client/generated/models/CustomerAddress.ts @@ -2,16 +2,14 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - import type { Country } from './Country'; import type { CountryState } from './CountryState'; import type { Salutation } from './Salutation'; - /** * Added since version: 6.0.0.0 */ export type CustomerAddress = { - id?: string; + id: string; customerId: string; countryId: string; countryStateId?: string; diff --git a/src/platforms/shopware/api-client/generated/models/CustomerGroup.ts b/src/platforms/shopware/api-client/generated/models/CustomerGroup.ts index d93b7561..f2cb6cb1 100644 --- a/src/platforms/shopware/api-client/generated/models/CustomerGroup.ts +++ b/src/platforms/shopware/api-client/generated/models/CustomerGroup.ts @@ -2,12 +2,11 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - /** * Added since version: 6.0.0.0 */ export type CustomerGroup = { - id?: string; + id: string; name: string; displayGross?: boolean; customFields?: Record; @@ -18,6 +17,11 @@ export type CustomerGroup = { registrationSeoMetaDescription?: string; readonly createdAt: string; readonly updatedAt?: string; - translated?: Record; + translated: { + name?: string; + registrationIntroduction?: string; + registrationSeoMetaDescription?: string; + registrationTitle?: string; + }; }; diff --git a/src/platforms/shopware/api-client/generated/models/CustomerRecovery.ts b/src/platforms/shopware/api-client/generated/models/CustomerRecovery.ts index 1061a54e..4a9dd0f7 100644 --- a/src/platforms/shopware/api-client/generated/models/CustomerRecovery.ts +++ b/src/platforms/shopware/api-client/generated/models/CustomerRecovery.ts @@ -2,7 +2,6 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - /** * Added since version: 6.1.0.0 */ diff --git a/src/platforms/shopware/api-client/generated/models/CustomerTag.ts b/src/platforms/shopware/api-client/generated/models/CustomerTag.ts index 1cb5bd33..556a3fa8 100644 --- a/src/platforms/shopware/api-client/generated/models/CustomerTag.ts +++ b/src/platforms/shopware/api-client/generated/models/CustomerTag.ts @@ -2,9 +2,7 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - import type { Tag } from './Tag'; - /** * Added since version: 6.0.0.0 */ diff --git a/src/platforms/shopware/api-client/generated/models/CustomerWishlist.ts b/src/platforms/shopware/api-client/generated/models/CustomerWishlist.ts index d93e3746..a2a0c86a 100644 --- a/src/platforms/shopware/api-client/generated/models/CustomerWishlist.ts +++ b/src/platforms/shopware/api-client/generated/models/CustomerWishlist.ts @@ -2,12 +2,11 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - /** * Added since version: 6.3.4.0 */ export type CustomerWishlist = { - id?: string; + id: string; customerId: string; customFields?: Record; readonly createdAt: string; diff --git a/src/platforms/shopware/api-client/generated/models/CustomerWishlistProduct.ts b/src/platforms/shopware/api-client/generated/models/CustomerWishlistProduct.ts index d3e32070..b3374814 100644 --- a/src/platforms/shopware/api-client/generated/models/CustomerWishlistProduct.ts +++ b/src/platforms/shopware/api-client/generated/models/CustomerWishlistProduct.ts @@ -2,12 +2,11 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - /** * Added since version: 6.3.4.0 */ export type CustomerWishlistProduct = { - id?: string; + id: string; productId: string; productVersionId?: string; readonly createdAt: string; diff --git a/src/platforms/shopware/api-client/generated/models/DeliveryTime.ts b/src/platforms/shopware/api-client/generated/models/DeliveryTime.ts index c7e9bc6f..457b5f50 100644 --- a/src/platforms/shopware/api-client/generated/models/DeliveryTime.ts +++ b/src/platforms/shopware/api-client/generated/models/DeliveryTime.ts @@ -2,12 +2,11 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - /** * Added since version: 6.0.0.0 */ export type DeliveryTime = { - id?: string; + id: string; name: string; min: number; max: number; diff --git a/src/platforms/shopware/api-client/generated/models/Document.ts b/src/platforms/shopware/api-client/generated/models/Document.ts index 2aabb829..a14459a0 100644 --- a/src/platforms/shopware/api-client/generated/models/Document.ts +++ b/src/platforms/shopware/api-client/generated/models/Document.ts @@ -2,33 +2,35 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - import type { DocumentType } from './DocumentType'; import type { Media } from './Media'; import type { Order } from './Order'; - /** * Added since version: 6.0.0.0 */ export type Document = { - id?: string; + id: string; documentTypeId: string; fileType: string; referencedDocumentId?: string; orderId: string; documentMediaFileId?: string; orderVersionId?: string; - config: Record; + config: { + name: string; + title: string; + }; sent?: boolean; static?: boolean; deepLinkCode: string; + documentNumber?: string; customFields?: Record; readonly createdAt: string; readonly updatedAt?: string; documentType?: DocumentType; order?: Order; referencedDocument?: Document; - dependentDocuments?: Document; + dependentDocuments?: Array; documentMediaFile?: Media; }; diff --git a/src/platforms/shopware/api-client/generated/models/DocumentBaseConfig.ts b/src/platforms/shopware/api-client/generated/models/DocumentBaseConfig.ts index 648e772e..473d435f 100644 --- a/src/platforms/shopware/api-client/generated/models/DocumentBaseConfig.ts +++ b/src/platforms/shopware/api-client/generated/models/DocumentBaseConfig.ts @@ -2,14 +2,12 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - import type { Media } from './Media'; - /** * Added since version: 6.0.0.0 */ export type DocumentBaseConfig = { - id?: string; + id: string; documentTypeId: string; logoId?: string; name: string; diff --git a/src/platforms/shopware/api-client/generated/models/DocumentBaseConfigSalesChannel.ts b/src/platforms/shopware/api-client/generated/models/DocumentBaseConfigSalesChannel.ts index cc997588..d863b87d 100644 --- a/src/platforms/shopware/api-client/generated/models/DocumentBaseConfigSalesChannel.ts +++ b/src/platforms/shopware/api-client/generated/models/DocumentBaseConfigSalesChannel.ts @@ -2,12 +2,11 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - /** * Added since version: 6.0.0.0 */ export type DocumentBaseConfigSalesChannel = { - id?: string; + id: string; documentBaseConfigId: string; salesChannelId?: string; documentTypeId?: string; diff --git a/src/platforms/shopware/api-client/generated/models/DocumentType.ts b/src/platforms/shopware/api-client/generated/models/DocumentType.ts index 9024ad0d..29c7298e 100644 --- a/src/platforms/shopware/api-client/generated/models/DocumentType.ts +++ b/src/platforms/shopware/api-client/generated/models/DocumentType.ts @@ -2,12 +2,11 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - /** * Added since version: 6.0.0.0 */ export type DocumentType = { - id?: string; + id: string; name: string; technicalName: string; readonly createdAt: string; diff --git a/src/platforms/shopware/api-client/generated/models/EntitySearchResult.ts b/src/platforms/shopware/api-client/generated/models/EntitySearchResult.ts index 719f0801..ec76661e 100644 --- a/src/platforms/shopware/api-client/generated/models/EntitySearchResult.ts +++ b/src/platforms/shopware/api-client/generated/models/EntitySearchResult.ts @@ -2,9 +2,7 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - import type { Struct } from './Struct'; - export type EntitySearchResult = (Struct & { entity?: string; /** diff --git a/src/platforms/shopware/api-client/generated/models/FindProductVariantRouteResponse.ts b/src/platforms/shopware/api-client/generated/models/FindProductVariantRouteResponse.ts index 9f52462a..d35876c7 100644 --- a/src/platforms/shopware/api-client/generated/models/FindProductVariantRouteResponse.ts +++ b/src/platforms/shopware/api-client/generated/models/FindProductVariantRouteResponse.ts @@ -2,7 +2,6 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - export type FindProductVariantRouteResponse = { foundCombination?: { variantId?: string; diff --git a/src/platforms/shopware/api-client/generated/models/Flow.ts b/src/platforms/shopware/api-client/generated/models/Flow.ts index a56b7ddc..2089262b 100644 --- a/src/platforms/shopware/api-client/generated/models/Flow.ts +++ b/src/platforms/shopware/api-client/generated/models/Flow.ts @@ -2,7 +2,6 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - /** * Added since version: 6.4.6.0 */ diff --git a/src/platforms/shopware/api-client/generated/models/FlowSequence.ts b/src/platforms/shopware/api-client/generated/models/FlowSequence.ts index 11f4bfc0..37ecf84f 100644 --- a/src/platforms/shopware/api-client/generated/models/FlowSequence.ts +++ b/src/platforms/shopware/api-client/generated/models/FlowSequence.ts @@ -2,7 +2,6 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - /** * Added since version: 6.4.6.0 */ diff --git a/src/platforms/shopware/api-client/generated/models/FlowTemplate.ts b/src/platforms/shopware/api-client/generated/models/FlowTemplate.ts index 1cff56b0..e5cd799a 100644 --- a/src/platforms/shopware/api-client/generated/models/FlowTemplate.ts +++ b/src/platforms/shopware/api-client/generated/models/FlowTemplate.ts @@ -2,7 +2,6 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - /** * Added since version: 6.4.18.0 */ diff --git a/src/platforms/shopware/api-client/generated/models/ImportExportFile.ts b/src/platforms/shopware/api-client/generated/models/ImportExportFile.ts index 9057dc1d..0e758059 100644 --- a/src/platforms/shopware/api-client/generated/models/ImportExportFile.ts +++ b/src/platforms/shopware/api-client/generated/models/ImportExportFile.ts @@ -2,7 +2,6 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - /** * Added since version: 6.0.0.0 */ diff --git a/src/platforms/shopware/api-client/generated/models/ImportExportLog.ts b/src/platforms/shopware/api-client/generated/models/ImportExportLog.ts index 10d04ab2..48b08e23 100644 --- a/src/platforms/shopware/api-client/generated/models/ImportExportLog.ts +++ b/src/platforms/shopware/api-client/generated/models/ImportExportLog.ts @@ -2,7 +2,6 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - /** * Added since version: 6.0.0.0 */ diff --git a/src/platforms/shopware/api-client/generated/models/ImportExportProfile.ts b/src/platforms/shopware/api-client/generated/models/ImportExportProfile.ts index 41d02785..fb4b8313 100644 --- a/src/platforms/shopware/api-client/generated/models/ImportExportProfile.ts +++ b/src/platforms/shopware/api-client/generated/models/ImportExportProfile.ts @@ -2,7 +2,6 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - /** * Added since version: 6.0.0.0 */ diff --git a/src/platforms/shopware/api-client/generated/models/Integration.ts b/src/platforms/shopware/api-client/generated/models/Integration.ts index a8304e5d..4f60816d 100644 --- a/src/platforms/shopware/api-client/generated/models/Integration.ts +++ b/src/platforms/shopware/api-client/generated/models/Integration.ts @@ -2,7 +2,6 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - /** * Added since version: 6.0.0.0 */ diff --git a/src/platforms/shopware/api-client/generated/models/LandingPage.ts b/src/platforms/shopware/api-client/generated/models/LandingPage.ts index 5ec4efdc..871f478e 100644 --- a/src/platforms/shopware/api-client/generated/models/LandingPage.ts +++ b/src/platforms/shopware/api-client/generated/models/LandingPage.ts @@ -2,15 +2,13 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - import type { CmsPage } from './CmsPage'; import type { SeoUrl } from './SeoUrl'; - /** * Added since version: 6.4.0.0 */ export type LandingPage = { - id?: string; + id: string; versionId?: string; active?: boolean; name: string; @@ -26,6 +24,7 @@ export type LandingPage = { readonly updatedAt?: string; translated?: Record; cmsPage?: CmsPage; - seoUrls?: SeoUrl; + seoUrls?: Array; + apiAlias: 'landing_page'; }; diff --git a/src/platforms/shopware/api-client/generated/models/LandingPageJsonApi.ts b/src/platforms/shopware/api-client/generated/models/LandingPageJsonApi.ts index 18150d85..c1d59c79 100644 --- a/src/platforms/shopware/api-client/generated/models/LandingPageJsonApi.ts +++ b/src/platforms/shopware/api-client/generated/models/LandingPageJsonApi.ts @@ -2,14 +2,12 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - import type { resource } from './resource'; - /** * Added since version: 6.4.0.0 */ export type LandingPageJsonApi = (resource & { - id?: string; + id: string; versionId?: string; active?: boolean; name: string; @@ -24,6 +22,25 @@ export type LandingPageJsonApi = (resource & { readonly createdAt: string; readonly updatedAt?: string; translated?: Record; - relationships?: any; + relationships?: { + cmsPage?: { + links?: { + related?: string; + }; + data?: { + type?: string; + id?: string; + }; + }; + seoUrls?: { + links?: { + related?: string; + }; + data?: Array<{ + type?: string; + id?: string; + }>; + }; + }; }); diff --git a/src/platforms/shopware/api-client/generated/models/Language.ts b/src/platforms/shopware/api-client/generated/models/Language.ts index 25f41c3f..54833fac 100644 --- a/src/platforms/shopware/api-client/generated/models/Language.ts +++ b/src/platforms/shopware/api-client/generated/models/Language.ts @@ -2,14 +2,12 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - import type { Locale } from './Locale'; - /** * Added since version: 6.0.0.0 */ export type Language = { - id?: string; + id: string; parentId?: string; localeId: string; translationCodeId?: string; @@ -20,6 +18,6 @@ export type Language = { parent?: Language; locale?: Locale; translationCode?: Locale; - children?: Language; + children?: Array; }; diff --git a/src/platforms/shopware/api-client/generated/models/LanguageJsonApi.ts b/src/platforms/shopware/api-client/generated/models/LanguageJsonApi.ts index 9db4e4ae..b746eeb3 100644 --- a/src/platforms/shopware/api-client/generated/models/LanguageJsonApi.ts +++ b/src/platforms/shopware/api-client/generated/models/LanguageJsonApi.ts @@ -2,14 +2,12 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - import type { resource } from './resource'; - /** * Added since version: 6.0.0.0 */ export type LanguageJsonApi = (resource & { - id?: string; + id: string; parentId?: string; localeId: string; translationCodeId?: string; @@ -17,6 +15,43 @@ export type LanguageJsonApi = (resource & { customFields?: Record; readonly createdAt: string; readonly updatedAt?: string; - relationships?: any; + relationships?: { + parent?: { + links?: { + related?: string; + }; + data?: { + type?: string; + id?: string; + }; + }; + locale?: { + links?: { + related?: string; + }; + data?: { + type?: string; + id?: string; + }; + }; + translationCode?: { + links?: { + related?: string; + }; + data?: { + type?: string; + id?: string; + }; + }; + children?: { + links?: { + related?: string; + }; + data?: Array<{ + type?: string; + id?: string; + }>; + }; + }; }); diff --git a/src/platforms/shopware/api-client/generated/models/LineItem.ts b/src/platforms/shopware/api-client/generated/models/LineItem.ts index 7c881f26..1a7ab4cb 100644 --- a/src/platforms/shopware/api-client/generated/models/LineItem.ts +++ b/src/platforms/shopware/api-client/generated/models/LineItem.ts @@ -2,13 +2,13 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - +import type { LineItemType } from './LineItemType'; export type LineItem = { - id?: string; + id: string; referencedId?: string; label?: string; quantity?: number; - type?: string; + type: LineItemType; good?: boolean; description?: string; removable?: boolean; diff --git a/src/platforms/shopware/api-client/generated/models/LineItemType.ts b/src/platforms/shopware/api-client/generated/models/LineItemType.ts new file mode 100644 index 00000000..636e497e --- /dev/null +++ b/src/platforms/shopware/api-client/generated/models/LineItemType.ts @@ -0,0 +1,5 @@ +/* generated using openapi-typescript-codegen -- do no edit */ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +export type LineItemType = 'product' | 'credit' | 'custom' | 'promotion' | 'discount' | 'container'; diff --git a/src/platforms/shopware/api-client/generated/models/ListPrice.ts b/src/platforms/shopware/api-client/generated/models/ListPrice.ts new file mode 100644 index 00000000..bfc340b7 --- /dev/null +++ b/src/platforms/shopware/api-client/generated/models/ListPrice.ts @@ -0,0 +1,11 @@ +/* generated using openapi-typescript-codegen -- do no edit */ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +export type ListPrice = { + discount?: number; + percentage?: number; + price?: number; + apiAlias: 'cart_list_price'; +}; + diff --git a/src/platforms/shopware/api-client/generated/models/Locale.ts b/src/platforms/shopware/api-client/generated/models/Locale.ts index 4e2b369a..d905a8ae 100644 --- a/src/platforms/shopware/api-client/generated/models/Locale.ts +++ b/src/platforms/shopware/api-client/generated/models/Locale.ts @@ -2,12 +2,11 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - /** * Added since version: 6.0.0.0 */ export type Locale = { - id?: string; + id: string; code: string; name: string; territory: string; diff --git a/src/platforms/shopware/api-client/generated/models/LogEntry.ts b/src/platforms/shopware/api-client/generated/models/LogEntry.ts index 39f24352..9568c5e7 100644 --- a/src/platforms/shopware/api-client/generated/models/LogEntry.ts +++ b/src/platforms/shopware/api-client/generated/models/LogEntry.ts @@ -2,7 +2,6 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - /** * Added since version: 6.0.0.0 */ diff --git a/src/platforms/shopware/api-client/generated/models/MailHeaderFooter.ts b/src/platforms/shopware/api-client/generated/models/MailHeaderFooter.ts index 9eb3cf33..9f536d1e 100644 --- a/src/platforms/shopware/api-client/generated/models/MailHeaderFooter.ts +++ b/src/platforms/shopware/api-client/generated/models/MailHeaderFooter.ts @@ -2,7 +2,6 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - /** * Added since version: 6.0.0.0 */ diff --git a/src/platforms/shopware/api-client/generated/models/MailTemplate.ts b/src/platforms/shopware/api-client/generated/models/MailTemplate.ts index 50b16b3d..207fcb62 100644 --- a/src/platforms/shopware/api-client/generated/models/MailTemplate.ts +++ b/src/platforms/shopware/api-client/generated/models/MailTemplate.ts @@ -2,10 +2,8 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - import type { MailTemplateMedia } from './MailTemplateMedia'; import type { MailTemplateType } from './MailTemplateType'; - /** * Added since version: 6.0.0.0 */ @@ -20,6 +18,6 @@ export type MailTemplate = { readonly updatedAt?: string; translated?: Record; mailTemplateType?: MailTemplateType; - media?: MailTemplateMedia; + media?: Array; }; diff --git a/src/platforms/shopware/api-client/generated/models/MailTemplateMedia.ts b/src/platforms/shopware/api-client/generated/models/MailTemplateMedia.ts index 35a7df21..6061f8b4 100644 --- a/src/platforms/shopware/api-client/generated/models/MailTemplateMedia.ts +++ b/src/platforms/shopware/api-client/generated/models/MailTemplateMedia.ts @@ -2,14 +2,12 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - import type { Media } from './Media'; - /** * Added since version: 6.0.0.0 */ export type MailTemplateMedia = { - id?: string; + id: string; mailTemplateId: string; languageId: string; mediaId: string; diff --git a/src/platforms/shopware/api-client/generated/models/MailTemplateType.ts b/src/platforms/shopware/api-client/generated/models/MailTemplateType.ts index ddd6c687..37a4316a 100644 --- a/src/platforms/shopware/api-client/generated/models/MailTemplateType.ts +++ b/src/platforms/shopware/api-client/generated/models/MailTemplateType.ts @@ -2,12 +2,11 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - /** * Added since version: 6.0.0.0 */ export type MailTemplateType = { - id?: string; + id: string; name: string; technicalName: string; customFields?: Record; diff --git a/src/platforms/shopware/api-client/generated/models/MainCategory.ts b/src/platforms/shopware/api-client/generated/models/MainCategory.ts index 36f2fc95..9a7ca47a 100644 --- a/src/platforms/shopware/api-client/generated/models/MainCategory.ts +++ b/src/platforms/shopware/api-client/generated/models/MainCategory.ts @@ -2,12 +2,11 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - /** * Added since version: 6.1.0.0 */ export type MainCategory = { - id?: string; + id: string; productId: string; productVersionId?: string; categoryId: string; diff --git a/src/platforms/shopware/api-client/generated/models/MainCategoryJsonApi.ts b/src/platforms/shopware/api-client/generated/models/MainCategoryJsonApi.ts index b234ba73..6d9a1a9e 100644 --- a/src/platforms/shopware/api-client/generated/models/MainCategoryJsonApi.ts +++ b/src/platforms/shopware/api-client/generated/models/MainCategoryJsonApi.ts @@ -2,14 +2,12 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - import type { resource } from './resource'; - /** * Added since version: 6.1.0.0 */ export type MainCategoryJsonApi = (resource & { - id?: string; + id: string; productId: string; productVersionId?: string; categoryId: string; diff --git a/src/platforms/shopware/api-client/generated/models/Media.ts b/src/platforms/shopware/api-client/generated/models/Media.ts index 19d32ea5..9ade3348 100644 --- a/src/platforms/shopware/api-client/generated/models/Media.ts +++ b/src/platforms/shopware/api-client/generated/models/Media.ts @@ -2,35 +2,36 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - import type { MediaThumbnail } from './MediaThumbnail'; - /** * Added since version: 6.0.0.0 */ export type Media = { - id?: string; + id: string; readonly mimeType?: string; - readonly fileExtension?: string; + readonly fileExtension: string; readonly uploadedAt?: string; - readonly fileName?: string; + readonly fileName: string; readonly fileSize?: number; readonly metaData?: Record; + config?: Record; alt?: string; title?: string; /** * Runtime field, cannot be used as part of the criteria. */ - url?: string; + url: string; + path: string; /** * Runtime field, cannot be used as part of the criteria. */ - hasFile?: boolean; - private?: boolean; + hasFile: boolean; + private: boolean; customFields?: Record; readonly createdAt: string; readonly updatedAt?: string; translated?: Record; thumbnails?: Array; + apiAlias: 'media'; }; diff --git a/src/platforms/shopware/api-client/generated/models/MediaDefaultFolder.ts b/src/platforms/shopware/api-client/generated/models/MediaDefaultFolder.ts index 6f71449e..2088241a 100644 --- a/src/platforms/shopware/api-client/generated/models/MediaDefaultFolder.ts +++ b/src/platforms/shopware/api-client/generated/models/MediaDefaultFolder.ts @@ -2,7 +2,6 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - /** * Added since version: 6.0.0.0 */ diff --git a/src/platforms/shopware/api-client/generated/models/MediaFolder.ts b/src/platforms/shopware/api-client/generated/models/MediaFolder.ts index 7e86a010..65a28bc4 100644 --- a/src/platforms/shopware/api-client/generated/models/MediaFolder.ts +++ b/src/platforms/shopware/api-client/generated/models/MediaFolder.ts @@ -2,7 +2,6 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - /** * Added since version: 6.0.0.0 */ diff --git a/src/platforms/shopware/api-client/generated/models/MediaFolderConfiguration.ts b/src/platforms/shopware/api-client/generated/models/MediaFolderConfiguration.ts index 2b69a41a..ba4d958b 100644 --- a/src/platforms/shopware/api-client/generated/models/MediaFolderConfiguration.ts +++ b/src/platforms/shopware/api-client/generated/models/MediaFolderConfiguration.ts @@ -2,7 +2,6 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - /** * Added since version: 6.0.0.0 */ diff --git a/src/platforms/shopware/api-client/generated/models/MediaTag.ts b/src/platforms/shopware/api-client/generated/models/MediaTag.ts index 2d6d0acf..1349bbc3 100644 --- a/src/platforms/shopware/api-client/generated/models/MediaTag.ts +++ b/src/platforms/shopware/api-client/generated/models/MediaTag.ts @@ -2,10 +2,8 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - import type { Media } from './Media'; import type { Tag } from './Tag'; - /** * Added since version: 6.0.0.0 */ diff --git a/src/platforms/shopware/api-client/generated/models/MediaThumbnail.ts b/src/platforms/shopware/api-client/generated/models/MediaThumbnail.ts index 28f05cf4..a56f0e26 100644 --- a/src/platforms/shopware/api-client/generated/models/MediaThumbnail.ts +++ b/src/platforms/shopware/api-client/generated/models/MediaThumbnail.ts @@ -2,19 +2,19 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - /** * Added since version: 6.0.0.0 */ export type MediaThumbnail = { - id?: string; + id: string; mediaId: string; readonly width: number; readonly height: number; /** * Runtime field, cannot be used as part of the criteria. */ - url?: string; + url: string; + path?: string; customFields?: Record; readonly createdAt: string; readonly updatedAt?: string; diff --git a/src/platforms/shopware/api-client/generated/models/MediaThumbnailSize.ts b/src/platforms/shopware/api-client/generated/models/MediaThumbnailSize.ts index d2790888..e4552e04 100644 --- a/src/platforms/shopware/api-client/generated/models/MediaThumbnailSize.ts +++ b/src/platforms/shopware/api-client/generated/models/MediaThumbnailSize.ts @@ -2,12 +2,11 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - /** * Added since version: 6.0.0.0 */ export type MediaThumbnailSize = { - id?: string; + id: string; width: number; height: number; customFields?: Record; diff --git a/src/platforms/shopware/api-client/generated/models/NavigationRouteResponse.ts b/src/platforms/shopware/api-client/generated/models/NavigationRouteResponse.ts index 08ad016f..e35bd62e 100644 --- a/src/platforms/shopware/api-client/generated/models/NavigationRouteResponse.ts +++ b/src/platforms/shopware/api-client/generated/models/NavigationRouteResponse.ts @@ -2,7 +2,5 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - import type { Category } from './Category'; - export type NavigationRouteResponse = Array; diff --git a/src/platforms/shopware/api-client/generated/models/NavigationType.ts b/src/platforms/shopware/api-client/generated/models/NavigationType.ts new file mode 100644 index 00000000..08368927 --- /dev/null +++ b/src/platforms/shopware/api-client/generated/models/NavigationType.ts @@ -0,0 +1,5 @@ +/* generated using openapi-typescript-codegen -- do no edit */ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +export type NavigationType = 'main-navigation' | 'footer-navigation' | 'service-navigation'; diff --git a/src/platforms/shopware/api-client/generated/models/NewsletterRecipient.ts b/src/platforms/shopware/api-client/generated/models/NewsletterRecipient.ts index 25c22087..e15522a4 100644 --- a/src/platforms/shopware/api-client/generated/models/NewsletterRecipient.ts +++ b/src/platforms/shopware/api-client/generated/models/NewsletterRecipient.ts @@ -2,7 +2,6 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - /** * Added since version: 6.0.0.0 */ diff --git a/src/platforms/shopware/api-client/generated/models/NewsletterRecipientJsonApi.ts b/src/platforms/shopware/api-client/generated/models/NewsletterRecipientJsonApi.ts index b10875bf..2c3f799e 100644 --- a/src/platforms/shopware/api-client/generated/models/NewsletterRecipientJsonApi.ts +++ b/src/platforms/shopware/api-client/generated/models/NewsletterRecipientJsonApi.ts @@ -2,9 +2,7 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - import type { resource } from './resource'; - /** * Added since version: 6.0.0.0 */ diff --git a/src/platforms/shopware/api-client/generated/models/Notification.ts b/src/platforms/shopware/api-client/generated/models/Notification.ts index 6347199c..c5ba79c8 100644 --- a/src/platforms/shopware/api-client/generated/models/Notification.ts +++ b/src/platforms/shopware/api-client/generated/models/Notification.ts @@ -2,7 +2,6 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - /** * Added since version: 6.4.7.0 */ diff --git a/src/platforms/shopware/api-client/generated/models/NumberRange.ts b/src/platforms/shopware/api-client/generated/models/NumberRange.ts index 4876a434..30c292da 100644 --- a/src/platforms/shopware/api-client/generated/models/NumberRange.ts +++ b/src/platforms/shopware/api-client/generated/models/NumberRange.ts @@ -2,7 +2,6 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - /** * Added since version: 6.0.0.0 */ diff --git a/src/platforms/shopware/api-client/generated/models/NumberRangeSalesChannel.ts b/src/platforms/shopware/api-client/generated/models/NumberRangeSalesChannel.ts index 824c98e9..17205135 100644 --- a/src/platforms/shopware/api-client/generated/models/NumberRangeSalesChannel.ts +++ b/src/platforms/shopware/api-client/generated/models/NumberRangeSalesChannel.ts @@ -2,7 +2,6 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - /** * Added since version: 6.0.0.0 */ diff --git a/src/platforms/shopware/api-client/generated/models/NumberRangeState.ts b/src/platforms/shopware/api-client/generated/models/NumberRangeState.ts index 8372021e..2c2f801e 100644 --- a/src/platforms/shopware/api-client/generated/models/NumberRangeState.ts +++ b/src/platforms/shopware/api-client/generated/models/NumberRangeState.ts @@ -2,7 +2,6 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - /** * Added since version: 6.0.0.0 */ diff --git a/src/platforms/shopware/api-client/generated/models/NumberRangeType.ts b/src/platforms/shopware/api-client/generated/models/NumberRangeType.ts index 7fecc2a4..fb6fd2ad 100644 --- a/src/platforms/shopware/api-client/generated/models/NumberRangeType.ts +++ b/src/platforms/shopware/api-client/generated/models/NumberRangeType.ts @@ -2,7 +2,6 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - /** * Added since version: 6.0.0.0 */ diff --git a/src/platforms/shopware/api-client/generated/models/Order.ts b/src/platforms/shopware/api-client/generated/models/Order.ts index d9068849..6f659e02 100644 --- a/src/platforms/shopware/api-client/generated/models/Order.ts +++ b/src/platforms/shopware/api-client/generated/models/Order.ts @@ -2,7 +2,6 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - import type { Currency } from './Currency'; import type { Document } from './Document'; import type { Language } from './Language'; @@ -13,12 +12,11 @@ import type { OrderLineItem } from './OrderLineItem'; import type { OrderTransaction } from './OrderTransaction'; import type { StateMachineState } from './StateMachineState'; import type { Tag } from './Tag'; - /** * Added since version: 6.0.0.0 */ export type Order = { - id?: string; + id: string; versionId?: string; orderNumber?: string; billingAddressId: string; @@ -27,7 +25,7 @@ export type Order = { languageId: string; salesChannelId: string; orderDateTime: string; - readonly orderDate?: string; + readonly orderDate: string; price?: { netPrice: number; totalPrice: number; @@ -63,21 +61,22 @@ export type Order = { affiliateCode?: string; campaignCode?: string; customerComment?: string; + source?: string; customFields?: Record; createdById?: string; updatedById?: string; readonly createdAt: string; readonly updatedAt?: string; - stateMachineState?: StateMachineState; + stateMachineState: StateMachineState; orderCustomer?: OrderCustomer; currency?: Currency; language?: Language; - addresses?: OrderAddress; + addresses?: Array; billingAddress?: OrderAddress; - deliveries?: OrderDelivery; - lineItems?: OrderLineItem; - transactions?: OrderTransaction; - documents?: Document; - tags?: Tag; + deliveries?: Array; + lineItems?: Array; + transactions?: Array; + documents: Array; + tags?: Array; }; diff --git a/src/platforms/shopware/api-client/generated/models/OrderAddress.ts b/src/platforms/shopware/api-client/generated/models/OrderAddress.ts index fc179681..b8ea52ef 100644 --- a/src/platforms/shopware/api-client/generated/models/OrderAddress.ts +++ b/src/platforms/shopware/api-client/generated/models/OrderAddress.ts @@ -2,16 +2,14 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - import type { Country } from './Country'; import type { CountryState } from './CountryState'; import type { Salutation } from './Salutation'; - /** * Added since version: 6.0.0.0 */ export type OrderAddress = { - id?: string; + id: string; versionId?: string; countryId: string; countryStateId?: string; diff --git a/src/platforms/shopware/api-client/generated/models/OrderCustomer.ts b/src/platforms/shopware/api-client/generated/models/OrderCustomer.ts index ac754ee6..28654724 100644 --- a/src/platforms/shopware/api-client/generated/models/OrderCustomer.ts +++ b/src/platforms/shopware/api-client/generated/models/OrderCustomer.ts @@ -2,17 +2,15 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - import type { Salutation } from './Salutation'; - /** * Added since version: 6.0.0.0 */ export type OrderCustomer = { - id?: string; + id: string; versionId?: string; email: string; - salutationId: string; + salutationId?: string; firstName: string; lastName: string; company?: string; diff --git a/src/platforms/shopware/api-client/generated/models/OrderDelivery.ts b/src/platforms/shopware/api-client/generated/models/OrderDelivery.ts index dbe7b427..f9305e51 100644 --- a/src/platforms/shopware/api-client/generated/models/OrderDelivery.ts +++ b/src/platforms/shopware/api-client/generated/models/OrderDelivery.ts @@ -2,17 +2,15 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - import type { OrderAddress } from './OrderAddress'; import type { OrderDeliveryPosition } from './OrderDeliveryPosition'; import type { ShippingMethod } from './ShippingMethod'; import type { StateMachineState } from './StateMachineState'; - /** * Added since version: 6.0.0.0 */ export type OrderDelivery = { - id?: string; + id: string; versionId?: string; orderId: string; orderVersionId?: string; @@ -45,6 +43,6 @@ export type OrderDelivery = { stateMachineState?: StateMachineState; shippingOrderAddress?: OrderAddress; shippingMethod?: ShippingMethod; - positions?: OrderDeliveryPosition; + positions?: Array; }; diff --git a/src/platforms/shopware/api-client/generated/models/OrderDeliveryPosition.ts b/src/platforms/shopware/api-client/generated/models/OrderDeliveryPosition.ts index 5b2e3b3f..6a5b7c87 100644 --- a/src/platforms/shopware/api-client/generated/models/OrderDeliveryPosition.ts +++ b/src/platforms/shopware/api-client/generated/models/OrderDeliveryPosition.ts @@ -2,12 +2,11 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - /** * Added since version: 6.0.0.0 */ export type OrderDeliveryPosition = { - id?: string; + id: string; versionId?: string; orderDeliveryId: string; orderDeliveryVersionId?: string; diff --git a/src/platforms/shopware/api-client/generated/models/OrderLineItem.ts b/src/platforms/shopware/api-client/generated/models/OrderLineItem.ts index 6a19ca7b..5d0ca775 100644 --- a/src/platforms/shopware/api-client/generated/models/OrderLineItem.ts +++ b/src/platforms/shopware/api-client/generated/models/OrderLineItem.ts @@ -2,16 +2,14 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - import type { Media } from './Media'; import type { OrderDeliveryPosition } from './OrderDeliveryPosition'; import type { OrderLineItemDownload } from './OrderLineItemDownload'; - /** * Added since version: 6.0.0.0 */ export type OrderLineItem = { - id?: string; + id: string; versionId?: string; orderId: string; orderVersionId?: string; @@ -39,9 +37,9 @@ export type OrderLineItem = { readonly createdAt: string; readonly updatedAt?: string; cover?: Media; - orderDeliveryPositions?: OrderDeliveryPosition; - downloads?: OrderLineItemDownload; + orderDeliveryPositions?: Array; + downloads?: Array; parent?: OrderLineItem; - children: OrderLineItem; + children: Array; }; diff --git a/src/platforms/shopware/api-client/generated/models/OrderLineItemDownload.ts b/src/platforms/shopware/api-client/generated/models/OrderLineItemDownload.ts index dbf5d71a..9fcadec1 100644 --- a/src/platforms/shopware/api-client/generated/models/OrderLineItemDownload.ts +++ b/src/platforms/shopware/api-client/generated/models/OrderLineItemDownload.ts @@ -2,15 +2,13 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - import type { Media } from './Media'; import type { OrderLineItem } from './OrderLineItem'; - /** * Added since version: 6.4.19.0 */ export type OrderLineItemDownload = { - id?: string; + id: string; versionId?: string; orderLineItemId: string; orderLineItemVersionId?: string; @@ -21,6 +19,6 @@ export type OrderLineItemDownload = { readonly createdAt: string; readonly updatedAt?: string; orderLineItem?: OrderLineItem; - media?: Media; + media: Media; }; diff --git a/src/platforms/shopware/api-client/generated/models/OrderRouteResponse.ts b/src/platforms/shopware/api-client/generated/models/OrderRouteResponse.ts index baecad32..f30f48d5 100644 --- a/src/platforms/shopware/api-client/generated/models/OrderRouteResponse.ts +++ b/src/platforms/shopware/api-client/generated/models/OrderRouteResponse.ts @@ -2,9 +2,9 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - +import type { Order } from './Order'; export type OrderRouteResponse = { - orders?: Record; + orders?: Array; /** * The key-value pairs contain the uuid of the order as key and a boolean as value, indicating that the payment method can still be changed. */ diff --git a/src/platforms/shopware/api-client/generated/models/OrderTag.ts b/src/platforms/shopware/api-client/generated/models/OrderTag.ts index d9042bcc..72bcdedb 100644 --- a/src/platforms/shopware/api-client/generated/models/OrderTag.ts +++ b/src/platforms/shopware/api-client/generated/models/OrderTag.ts @@ -2,10 +2,8 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - import type { Order } from './Order'; import type { Tag } from './Tag'; - /** * Added since version: 6.0.0.0 */ diff --git a/src/platforms/shopware/api-client/generated/models/OrderTransaction.ts b/src/platforms/shopware/api-client/generated/models/OrderTransaction.ts index 624b1e36..67b4b167 100644 --- a/src/platforms/shopware/api-client/generated/models/OrderTransaction.ts +++ b/src/platforms/shopware/api-client/generated/models/OrderTransaction.ts @@ -2,16 +2,14 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - import type { OrderTransactionCapture } from './OrderTransactionCapture'; import type { PaymentMethod } from './PaymentMethod'; import type { StateMachineState } from './StateMachineState'; - /** * Added since version: 6.0.0.0 */ export type OrderTransaction = { - id?: string; + id: string; versionId?: string; orderId: string; orderVersionId?: string; @@ -38,6 +36,6 @@ export type OrderTransaction = { readonly updatedAt?: string; stateMachineState?: StateMachineState; paymentMethod?: PaymentMethod; - captures?: OrderTransactionCapture; + captures?: Array; }; diff --git a/src/platforms/shopware/api-client/generated/models/OrderTransactionCapture.ts b/src/platforms/shopware/api-client/generated/models/OrderTransactionCapture.ts index e0865535..9f1e0896 100644 --- a/src/platforms/shopware/api-client/generated/models/OrderTransactionCapture.ts +++ b/src/platforms/shopware/api-client/generated/models/OrderTransactionCapture.ts @@ -2,16 +2,15 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - import type { OrderTransaction } from './OrderTransaction'; import type { OrderTransactionCaptureRefund } from './OrderTransactionCaptureRefund'; import type { StateMachineState } from './StateMachineState'; - /** * Added since version: 6.4.12.0 */ export type OrderTransactionCapture = { - id?: string; + id: string; + versionId?: string; orderTransactionId: string; orderTransactionVersionId?: string; stateId: string; @@ -37,6 +36,6 @@ export type OrderTransactionCapture = { readonly updatedAt?: string; stateMachineState?: StateMachineState; transaction?: OrderTransaction; - refunds?: OrderTransactionCaptureRefund; + refunds?: Array; }; diff --git a/src/platforms/shopware/api-client/generated/models/OrderTransactionCaptureRefund.ts b/src/platforms/shopware/api-client/generated/models/OrderTransactionCaptureRefund.ts index 932a0cdb..aefc3009 100644 --- a/src/platforms/shopware/api-client/generated/models/OrderTransactionCaptureRefund.ts +++ b/src/platforms/shopware/api-client/generated/models/OrderTransactionCaptureRefund.ts @@ -2,17 +2,17 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - import type { OrderTransactionCapture } from './OrderTransactionCapture'; import type { OrderTransactionCaptureRefundPosition } from './OrderTransactionCaptureRefundPosition'; import type { StateMachineState } from './StateMachineState'; - /** * Added since version: 6.4.12.0 */ export type OrderTransactionCaptureRefund = { - id?: string; + id: string; + versionId?: string; captureId: string; + captureVersionId?: string; stateId: string; externalReference?: string; reason?: string; @@ -37,6 +37,6 @@ export type OrderTransactionCaptureRefund = { readonly updatedAt?: string; stateMachineState?: StateMachineState; transactionCapture?: OrderTransactionCapture; - positions?: OrderTransactionCaptureRefundPosition; + positions?: Array; }; diff --git a/src/platforms/shopware/api-client/generated/models/OrderTransactionCaptureRefundPosition.ts b/src/platforms/shopware/api-client/generated/models/OrderTransactionCaptureRefundPosition.ts index 9e8794c3..f1adc080 100644 --- a/src/platforms/shopware/api-client/generated/models/OrderTransactionCaptureRefundPosition.ts +++ b/src/platforms/shopware/api-client/generated/models/OrderTransactionCaptureRefundPosition.ts @@ -2,16 +2,16 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - import type { OrderLineItem } from './OrderLineItem'; import type { OrderTransactionCaptureRefund } from './OrderTransactionCaptureRefund'; - /** * Added since version: 6.4.12.0 */ export type OrderTransactionCaptureRefundPosition = { - id?: string; + id: string; + versionId?: string; refundId: string; + refundVersionId?: string; orderLineItemId: string; orderLineItemVersionId?: string; externalReference?: string; diff --git a/src/platforms/shopware/api-client/generated/models/PaymentMethod.ts b/src/platforms/shopware/api-client/generated/models/PaymentMethod.ts index c29954e8..aad4aaa1 100644 --- a/src/platforms/shopware/api-client/generated/models/PaymentMethod.ts +++ b/src/platforms/shopware/api-client/generated/models/PaymentMethod.ts @@ -2,14 +2,12 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - import type { Media } from './Media'; - /** * Added since version: 6.0.0.0 */ export type PaymentMethod = { - id?: string; + id: string; name: string; readonly distinguishableName?: string; description?: string; @@ -34,10 +32,15 @@ export type PaymentMethod = { * Runtime field, cannot be used as part of the criteria. */ readonly refundable?: boolean; + /** + * Runtime field, cannot be used as part of the criteria. + */ + readonly recurring?: boolean; /** * Runtime field, cannot be used as part of the criteria. */ shortName?: string; + technicalName?: string; readonly createdAt: string; readonly updatedAt?: string; translated?: Record; diff --git a/src/platforms/shopware/api-client/generated/models/PaymentMethodJsonApi.ts b/src/platforms/shopware/api-client/generated/models/PaymentMethodJsonApi.ts index 83ddc83b..e9416099 100644 --- a/src/platforms/shopware/api-client/generated/models/PaymentMethodJsonApi.ts +++ b/src/platforms/shopware/api-client/generated/models/PaymentMethodJsonApi.ts @@ -2,14 +2,12 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - import type { resource } from './resource'; - /** * Added since version: 6.0.0.0 */ export type PaymentMethodJsonApi = (resource & { - id?: string; + id: string; name: string; readonly distinguishableName?: string; description?: string; @@ -34,13 +32,28 @@ export type PaymentMethodJsonApi = (resource & { * Runtime field, cannot be used as part of the criteria. */ readonly refundable?: boolean; + /** + * Runtime field, cannot be used as part of the criteria. + */ + readonly recurring?: boolean; /** * Runtime field, cannot be used as part of the criteria. */ shortName?: string; + technicalName?: string; readonly createdAt: string; readonly updatedAt?: string; translated?: Record; - relationships?: any; + relationships?: { + media?: { + links?: { + related?: string; + }; + data?: { + type?: string; + id?: string; + }; + }; + }; }); diff --git a/src/platforms/shopware/api-client/generated/models/Plugin.ts b/src/platforms/shopware/api-client/generated/models/Plugin.ts index a13ceffa..4dfe3f71 100644 --- a/src/platforms/shopware/api-client/generated/models/Plugin.ts +++ b/src/platforms/shopware/api-client/generated/models/Plugin.ts @@ -2,7 +2,6 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - /** * Added since version: 6.0.0.0 */ diff --git a/src/platforms/shopware/api-client/generated/models/Product.ts b/src/platforms/shopware/api-client/generated/models/Product.ts index f6293c09..1f72a5bf 100644 --- a/src/platforms/shopware/api-client/generated/models/Product.ts +++ b/src/platforms/shopware/api-client/generated/models/Product.ts @@ -2,10 +2,11 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - +import type { CalculatedPrice } from './CalculatedPrice'; import type { Category } from './Category'; import type { CmsPage } from './CmsPage'; import type { DeliveryTime } from './DeliveryTime'; +import type { ListPrice } from './ListPrice'; import type { MainCategory } from './MainCategory'; import type { ProductConfiguratorSetting } from './ProductConfiguratorSetting'; import type { ProductCrossSelling } from './ProductCrossSelling'; @@ -15,15 +16,16 @@ import type { ProductMedia } from './ProductMedia'; import type { ProductReview } from './ProductReview'; import type { ProductStream } from './ProductStream'; import type { PropertyGroupOption } from './PropertyGroupOption'; +import type { ReferencePrice } from './ReferencePrice'; import type { SeoUrl } from './SeoUrl'; +import type { Tag } from './Tag'; import type { Tax } from './Tax'; import type { Unit } from './Unit'; - /** - * Added since version: 6.0.0.0 + * Represents a product along with detailed information required to display a variant selection. */ export type Product = { - id?: string; + id: string; versionId?: string; parentId?: string; parentVersionId?: string; @@ -38,12 +40,12 @@ export type Product = { cmsPageId?: string; cmsPageVersionId?: string; productNumber: string; - stock: number; restockTime?: number; active?: boolean; - readonly availableStock?: number; readonly available?: boolean; isCloseout?: boolean; + readonly availableStock?: number; + stock: number; readonly displayGroup?: string; manufacturerNumber?: string; ean?: string; @@ -64,6 +66,7 @@ export type Product = { readonly propertyIds?: Array; readonly optionIds?: Array; readonly streamIds?: Array; + readonly tagIds?: Array; readonly categoryIds?: Array; readonly childCount?: number; readonly sales?: number; @@ -76,13 +79,25 @@ export type Product = { packUnit?: string; packUnitPlural?: string; customFields?: Record; - calculatedPrice?: Record; - calculatedPrices?: Array; + calculatedPrice: CalculatedPrice; + calculatedPrices: Array; /** * Runtime field, cannot be used as part of the criteria. */ calculatedMaxPurchase?: number; - calculatedCheapestPrice?: Record; + calculatedCheapestPrice?: (CalculatedPrice & { + unitPrice?: number; + quantity?: number; + totalPrice?: number; + referencePrice?: ReferencePrice | null; + listPrice?: ListPrice | null; + regulationPrice?: { + price: number; + } | null; + hasRange?: boolean; + variantId?: string | null; + apiAlias?: 'calculated_cheapest_price'; + }); /** * Runtime field, cannot be used as part of the criteria. */ @@ -91,9 +106,9 @@ export type Product = { readonly createdAt: string; readonly updatedAt?: string; translated?: Record; - downloads?: ProductDownload; + downloads?: Array; parent?: Product; - children?: Product; + children?: Array; deliveryTime?: DeliveryTime; tax?: Tax; manufacturer?: ProductManufacturer; @@ -102,16 +117,21 @@ export type Product = { cmsPage?: CmsPage; canonicalProduct?: Product; media?: Array; - crossSellings?: ProductCrossSelling; - configuratorSettings?: ProductConfiguratorSetting; - productReviews?: ProductReview; - mainCategories?: MainCategory; - seoUrls?: SeoUrl; - options?: PropertyGroupOption; - properties?: PropertyGroupOption; - categories?: Category; - streams?: ProductStream; - categoriesRo?: Category; - seoCategory?: Category; + crossSellings?: Array; + configuratorSettings?: Array; + productReviews?: Array; + mainCategories?: Array; + seoUrls?: Array; + options?: Array; + properties?: Array; + categories?: Array; + streams?: Array; + categoriesRo?: Array; + tags?: Array; + seoCategory: Category; + apiAlias: 'product'; + variantListingConfig?: { + displayParent?: boolean; + } | null; }; diff --git a/src/platforms/shopware/api-client/generated/models/ProductConfiguratorSetting.ts b/src/platforms/shopware/api-client/generated/models/ProductConfiguratorSetting.ts index 8078a864..03ac41fc 100644 --- a/src/platforms/shopware/api-client/generated/models/ProductConfiguratorSetting.ts +++ b/src/platforms/shopware/api-client/generated/models/ProductConfiguratorSetting.ts @@ -2,15 +2,13 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - import type { Media } from './Media'; import type { PropertyGroupOption } from './PropertyGroupOption'; - /** * Added since version: 6.0.0.0 */ export type ProductConfiguratorSetting = { - id?: string; + id: string; versionId?: string; productId: string; productVersionId?: string; diff --git a/src/platforms/shopware/api-client/generated/models/ProductCrossSelling.ts b/src/platforms/shopware/api-client/generated/models/ProductCrossSelling.ts index 96a65631..e02f96fa 100644 --- a/src/platforms/shopware/api-client/generated/models/ProductCrossSelling.ts +++ b/src/platforms/shopware/api-client/generated/models/ProductCrossSelling.ts @@ -2,12 +2,11 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - /** * Added since version: 6.1.0.0 */ export type ProductCrossSelling = { - id?: string; + id: string; name: string; position: number; sortBy?: string; diff --git a/src/platforms/shopware/api-client/generated/models/ProductCrossSellingAssignedProducts.ts b/src/platforms/shopware/api-client/generated/models/ProductCrossSellingAssignedProducts.ts index 38818ec4..a68a94df 100644 --- a/src/platforms/shopware/api-client/generated/models/ProductCrossSellingAssignedProducts.ts +++ b/src/platforms/shopware/api-client/generated/models/ProductCrossSellingAssignedProducts.ts @@ -2,7 +2,6 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - /** * Added since version: 6.2.0.0 */ diff --git a/src/platforms/shopware/api-client/generated/models/ProductDetailResponse.ts b/src/platforms/shopware/api-client/generated/models/ProductDetailResponse.ts index a3a5b12f..954de8e8 100644 --- a/src/platforms/shopware/api-client/generated/models/ProductDetailResponse.ts +++ b/src/platforms/shopware/api-client/generated/models/ProductDetailResponse.ts @@ -2,15 +2,13 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - import type { Product } from './Product'; import type { PropertyGroup } from './PropertyGroup'; - /** * Represents a product along with detailed information required to display a variant selection. */ export type ProductDetailResponse = { - product?: Product; + product: Product; /** * List of property groups with their corresponding options and information on how to display them. */ diff --git a/src/platforms/shopware/api-client/generated/models/ProductDownload.ts b/src/platforms/shopware/api-client/generated/models/ProductDownload.ts index 344a251b..8ee607da 100644 --- a/src/platforms/shopware/api-client/generated/models/ProductDownload.ts +++ b/src/platforms/shopware/api-client/generated/models/ProductDownload.ts @@ -2,15 +2,13 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - import type { Media } from './Media'; import type { Product } from './Product'; - /** * Added since version: 6.4.19.0 */ export type ProductDownload = { - id?: string; + id: string; versionId?: string; productId: string; productVersionId?: string; diff --git a/src/platforms/shopware/api-client/generated/models/ProductExport.ts b/src/platforms/shopware/api-client/generated/models/ProductExport.ts index 45d53a20..e1b87372 100644 --- a/src/platforms/shopware/api-client/generated/models/ProductExport.ts +++ b/src/platforms/shopware/api-client/generated/models/ProductExport.ts @@ -2,7 +2,6 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - /** * Added since version: 6.1.0.0 */ diff --git a/src/platforms/shopware/api-client/generated/models/ProductFeatureSet.ts b/src/platforms/shopware/api-client/generated/models/ProductFeatureSet.ts index 21bd13ed..090ce0d4 100644 --- a/src/platforms/shopware/api-client/generated/models/ProductFeatureSet.ts +++ b/src/platforms/shopware/api-client/generated/models/ProductFeatureSet.ts @@ -2,7 +2,6 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - /** * Added since version: 6.3.0.0 */ diff --git a/src/platforms/shopware/api-client/generated/models/ProductJsonApi.ts b/src/platforms/shopware/api-client/generated/models/ProductJsonApi.ts index 8d45dd79..17e8de08 100644 --- a/src/platforms/shopware/api-client/generated/models/ProductJsonApi.ts +++ b/src/platforms/shopware/api-client/generated/models/ProductJsonApi.ts @@ -2,14 +2,12 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - import type { resource } from './resource'; - /** * Added since version: 6.0.0.0 */ export type ProductJsonApi = (resource & { - id?: string; + id: string; versionId?: string; parentId?: string; parentVersionId?: string; @@ -24,12 +22,12 @@ export type ProductJsonApi = (resource & { cmsPageId?: string; cmsPageVersionId?: string; productNumber: string; - stock: number; restockTime?: number; active?: boolean; - readonly availableStock?: number; readonly available?: boolean; isCloseout?: boolean; + readonly availableStock?: number; + stock: number; readonly displayGroup?: string; manufacturerNumber?: string; ean?: string; @@ -50,6 +48,7 @@ export type ProductJsonApi = (resource & { readonly propertyIds?: Array; readonly optionIds?: Array; readonly streamIds?: Array; + readonly tagIds?: Array; readonly categoryIds?: Array; readonly childCount?: number; readonly sales?: number; @@ -63,7 +62,7 @@ export type ProductJsonApi = (resource & { packUnitPlural?: string; customFields?: Record; calculatedPrice?: Record; - calculatedPrices?: Array; + calculatedPrices?: Array>; /** * Runtime field, cannot be used as part of the criteria. */ @@ -77,6 +76,214 @@ export type ProductJsonApi = (resource & { readonly createdAt: string; readonly updatedAt?: string; translated?: Record; - relationships?: any; + relationships?: { + downloads?: { + links?: { + related?: string; + }; + data?: Array<{ + type?: string; + id?: string; + }>; + }; + parent?: { + links?: { + related?: string; + }; + data?: { + type?: string; + id?: string; + }; + }; + children?: { + links?: { + related?: string; + }; + data?: Array<{ + type?: string; + id?: string; + }>; + }; + deliveryTime?: { + links?: { + related?: string; + }; + data?: { + type?: string; + id?: string; + }; + }; + tax?: { + links?: { + related?: string; + }; + data?: { + type?: string; + id?: string; + }; + }; + manufacturer?: { + links?: { + related?: string; + }; + data?: { + type?: string; + id?: string; + }; + }; + unit?: { + links?: { + related?: string; + }; + data?: { + type?: string; + id?: string; + }; + }; + cover?: { + links?: { + related?: string; + }; + data?: { + type?: string; + id?: string; + }; + }; + cmsPage?: { + links?: { + related?: string; + }; + data?: { + type?: string; + id?: string; + }; + }; + canonicalProduct?: { + links?: { + related?: string; + }; + data?: { + type?: string; + id?: string; + }; + }; + media?: { + links?: { + related?: string; + }; + data?: Array<{ + type?: string; + id?: string; + }>; + }; + crossSellings?: { + links?: { + related?: string; + }; + data?: Array<{ + type?: string; + id?: string; + }>; + }; + configuratorSettings?: { + links?: { + related?: string; + }; + data?: Array<{ + type?: string; + id?: string; + }>; + }; + productReviews?: { + links?: { + related?: string; + }; + data?: Array<{ + type?: string; + id?: string; + }>; + }; + mainCategories?: { + links?: { + related?: string; + }; + data?: Array<{ + type?: string; + id?: string; + }>; + }; + seoUrls?: { + links?: { + related?: string; + }; + data?: Array<{ + type?: string; + id?: string; + }>; + }; + options?: { + links?: { + related?: string; + }; + data?: Array<{ + type?: string; + id?: string; + }>; + }; + properties?: { + links?: { + related?: string; + }; + data?: Array<{ + type?: string; + id?: string; + }>; + }; + categories?: { + links?: { + related?: string; + }; + data?: Array<{ + type?: string; + id?: string; + }>; + }; + streams?: { + links?: { + related?: string; + }; + data?: Array<{ + type?: string; + id?: string; + }>; + }; + categoriesRo?: { + links?: { + related?: string; + }; + data?: Array<{ + type?: string; + id?: string; + }>; + }; + tags?: { + links?: { + related?: string; + }; + data?: Array<{ + type?: string; + id?: string; + }>; + }; + seoCategory?: { + links?: { + related?: string; + }; + data?: { + type?: string; + id?: string; + }; + }; + }; }); diff --git a/src/platforms/shopware/api-client/generated/models/ProductKeywordDictionary.ts b/src/platforms/shopware/api-client/generated/models/ProductKeywordDictionary.ts index 6b6fbbb6..eb01de89 100644 --- a/src/platforms/shopware/api-client/generated/models/ProductKeywordDictionary.ts +++ b/src/platforms/shopware/api-client/generated/models/ProductKeywordDictionary.ts @@ -2,7 +2,6 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - /** * Added since version: 6.0.0.0 */ diff --git a/src/platforms/shopware/api-client/generated/models/ProductListingCriteria.ts b/src/platforms/shopware/api-client/generated/models/ProductListingCriteria.ts index f70bde22..8002f854 100644 --- a/src/platforms/shopware/api-client/generated/models/ProductListingCriteria.ts +++ b/src/platforms/shopware/api-client/generated/models/ProductListingCriteria.ts @@ -2,9 +2,7 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - import type { Criteria } from './Criteria'; - export type ProductListingCriteria = (Criteria & { /** * Specifies the sorting of the products by `availableSortings`. If not set, the default sorting will be set according to the shop settings. The available sorting options are sent within the response under the `availableSortings` key. In order to sort by a field, consider using the `sort` parameter from the listing criteria. Do not use both parameters together, as it might lead to unexpected results. diff --git a/src/platforms/shopware/api-client/generated/models/ProductListingFlags.ts b/src/platforms/shopware/api-client/generated/models/ProductListingFlags.ts index 2fae9d53..2ae71638 100644 --- a/src/platforms/shopware/api-client/generated/models/ProductListingFlags.ts +++ b/src/platforms/shopware/api-client/generated/models/ProductListingFlags.ts @@ -2,7 +2,6 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - /** * Additional flags for product listings */ diff --git a/src/platforms/shopware/api-client/generated/models/ProductListingResult.ts b/src/platforms/shopware/api-client/generated/models/ProductListingResult.ts index 2b84fb93..46e1a008 100644 --- a/src/platforms/shopware/api-client/generated/models/ProductListingResult.ts +++ b/src/platforms/shopware/api-client/generated/models/ProductListingResult.ts @@ -2,30 +2,39 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - import type { EntitySearchResult } from './EntitySearchResult'; import type { Product } from './Product'; - export type ProductListingResult = (EntitySearchResult & { /** * Contains the state of the filters. These can be used to create listing filters. */ - currentFilters?: { - navigationId?: string; - manufacturer?: Array>; - price?: { - min?: number; - max?: number; + currentFilters: { + navigationId: string; + manufacturer: Array; + price: { + min: number; + max: number; }; - rating?: number; - 'shipping-free'?: boolean; - properties?: Array>; + rating: number | null; + 'shipping-free': boolean; + properties: Array; + search?: string; }; /** * Contains the available sorting. These can be used to show a sorting select-box in the product listing. */ - availableSortings?: Array>; + availableSortings: Array<{ + label: string; + translated: { + label: string; + }; + key: string; + priority: number; + apiAlias: 'product_sorting'; + }>; sorting?: string; - elements?: Array; + elements: Array; + entity?: 'product'; + apiAlias: 'product_listing'; }); diff --git a/src/platforms/shopware/api-client/generated/models/ProductManufacturer.ts b/src/platforms/shopware/api-client/generated/models/ProductManufacturer.ts index ae204203..3e095676 100644 --- a/src/platforms/shopware/api-client/generated/models/ProductManufacturer.ts +++ b/src/platforms/shopware/api-client/generated/models/ProductManufacturer.ts @@ -2,14 +2,12 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - import type { Media } from './Media'; - /** * Added since version: 6.0.0.0 */ export type ProductManufacturer = { - id?: string; + id: string; versionId?: string; mediaId?: string; link?: string; diff --git a/src/platforms/shopware/api-client/generated/models/ProductMedia.ts b/src/platforms/shopware/api-client/generated/models/ProductMedia.ts index 8d039b54..1a567ac7 100644 --- a/src/platforms/shopware/api-client/generated/models/ProductMedia.ts +++ b/src/platforms/shopware/api-client/generated/models/ProductMedia.ts @@ -2,14 +2,13 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - import type { Media } from './Media'; - +import type { MediaThumbnail } from './MediaThumbnail'; /** * Added since version: 6.0.0.0 */ export type ProductMedia = { - id?: string; + id: string; versionId?: string; productId: string; productVersionId?: string; @@ -19,5 +18,6 @@ export type ProductMedia = { readonly createdAt: string; readonly updatedAt?: string; media?: Media; + thumbnails?: MediaThumbnail; }; diff --git a/src/platforms/shopware/api-client/generated/models/ProductPrice.ts b/src/platforms/shopware/api-client/generated/models/ProductPrice.ts index 16d33a8d..b798351c 100644 --- a/src/platforms/shopware/api-client/generated/models/ProductPrice.ts +++ b/src/platforms/shopware/api-client/generated/models/ProductPrice.ts @@ -2,7 +2,6 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - /** * Added since version: 6.0.0.0 */ diff --git a/src/platforms/shopware/api-client/generated/models/ProductReview.ts b/src/platforms/shopware/api-client/generated/models/ProductReview.ts index 71f49d1e..cab22b03 100644 --- a/src/platforms/shopware/api-client/generated/models/ProductReview.ts +++ b/src/platforms/shopware/api-client/generated/models/ProductReview.ts @@ -2,19 +2,18 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - /** * Added since version: 6.0.0.0 */ export type ProductReview = { - id?: string; + id: string; productId: string; productVersionId?: string; salesChannelId: string; languageId: string; title: string; content: string; - points?: number; + points: number; status?: boolean; comment?: string; customFields?: Record; diff --git a/src/platforms/shopware/api-client/generated/models/ProductSearchConfig.ts b/src/platforms/shopware/api-client/generated/models/ProductSearchConfig.ts index 5f73d572..edc5fc14 100644 --- a/src/platforms/shopware/api-client/generated/models/ProductSearchConfig.ts +++ b/src/platforms/shopware/api-client/generated/models/ProductSearchConfig.ts @@ -2,7 +2,6 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - /** * Added since version: 6.3.5.0 */ diff --git a/src/platforms/shopware/api-client/generated/models/ProductSearchConfigField.ts b/src/platforms/shopware/api-client/generated/models/ProductSearchConfigField.ts index b8bb4ec0..0e8ca4e4 100644 --- a/src/platforms/shopware/api-client/generated/models/ProductSearchConfigField.ts +++ b/src/platforms/shopware/api-client/generated/models/ProductSearchConfigField.ts @@ -2,7 +2,6 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - /** * Added since version: 6.3.5.0 */ diff --git a/src/platforms/shopware/api-client/generated/models/ProductSearchKeyword.ts b/src/platforms/shopware/api-client/generated/models/ProductSearchKeyword.ts index 1558355e..179c1409 100644 --- a/src/platforms/shopware/api-client/generated/models/ProductSearchKeyword.ts +++ b/src/platforms/shopware/api-client/generated/models/ProductSearchKeyword.ts @@ -2,7 +2,6 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - /** * Added since version: 6.0.0.0 */ diff --git a/src/platforms/shopware/api-client/generated/models/ProductSorting.ts b/src/platforms/shopware/api-client/generated/models/ProductSorting.ts index 600014c9..c350fd2f 100644 --- a/src/platforms/shopware/api-client/generated/models/ProductSorting.ts +++ b/src/platforms/shopware/api-client/generated/models/ProductSorting.ts @@ -2,7 +2,6 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - /** * Added since version: 6.3.2.0 */ diff --git a/src/platforms/shopware/api-client/generated/models/ProductStream.ts b/src/platforms/shopware/api-client/generated/models/ProductStream.ts index 9fa3a397..5144cfe3 100644 --- a/src/platforms/shopware/api-client/generated/models/ProductStream.ts +++ b/src/platforms/shopware/api-client/generated/models/ProductStream.ts @@ -2,12 +2,11 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - /** * Added since version: 6.0.0.0 */ export type ProductStream = { - id?: string; + id: string; name: string; description?: string; customFields?: Record; diff --git a/src/platforms/shopware/api-client/generated/models/ProductStreamFilter.ts b/src/platforms/shopware/api-client/generated/models/ProductStreamFilter.ts index 34e145d0..8751eae3 100644 --- a/src/platforms/shopware/api-client/generated/models/ProductStreamFilter.ts +++ b/src/platforms/shopware/api-client/generated/models/ProductStreamFilter.ts @@ -2,7 +2,6 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - /** * Added since version: 6.0.0.0 */ diff --git a/src/platforms/shopware/api-client/generated/models/ProductVisibility.ts b/src/platforms/shopware/api-client/generated/models/ProductVisibility.ts index 393e49f1..54abe907 100644 --- a/src/platforms/shopware/api-client/generated/models/ProductVisibility.ts +++ b/src/platforms/shopware/api-client/generated/models/ProductVisibility.ts @@ -2,7 +2,6 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - /** * Added since version: 6.0.0.0 */ diff --git a/src/platforms/shopware/api-client/generated/models/Promotion.ts b/src/platforms/shopware/api-client/generated/models/Promotion.ts index ac3afe6f..76ce6508 100644 --- a/src/platforms/shopware/api-client/generated/models/Promotion.ts +++ b/src/platforms/shopware/api-client/generated/models/Promotion.ts @@ -2,7 +2,6 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - /** * Added since version: 6.0.0.0 */ diff --git a/src/platforms/shopware/api-client/generated/models/PromotionDiscount.ts b/src/platforms/shopware/api-client/generated/models/PromotionDiscount.ts index 27738880..386da06e 100644 --- a/src/platforms/shopware/api-client/generated/models/PromotionDiscount.ts +++ b/src/platforms/shopware/api-client/generated/models/PromotionDiscount.ts @@ -2,7 +2,6 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - /** * Added since version: 6.0.0.0 */ diff --git a/src/platforms/shopware/api-client/generated/models/PromotionDiscountPrices.ts b/src/platforms/shopware/api-client/generated/models/PromotionDiscountPrices.ts index 3fc88e89..34243f17 100644 --- a/src/platforms/shopware/api-client/generated/models/PromotionDiscountPrices.ts +++ b/src/platforms/shopware/api-client/generated/models/PromotionDiscountPrices.ts @@ -2,7 +2,6 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - /** * Added since version: 6.0.0.0 */ diff --git a/src/platforms/shopware/api-client/generated/models/PromotionIndividualCode.ts b/src/platforms/shopware/api-client/generated/models/PromotionIndividualCode.ts index 25824a17..c590b93d 100644 --- a/src/platforms/shopware/api-client/generated/models/PromotionIndividualCode.ts +++ b/src/platforms/shopware/api-client/generated/models/PromotionIndividualCode.ts @@ -2,7 +2,6 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - /** * Added since version: 6.0.0.0 */ diff --git a/src/platforms/shopware/api-client/generated/models/PromotionSalesChannel.ts b/src/platforms/shopware/api-client/generated/models/PromotionSalesChannel.ts index c418f17a..77d42a5f 100644 --- a/src/platforms/shopware/api-client/generated/models/PromotionSalesChannel.ts +++ b/src/platforms/shopware/api-client/generated/models/PromotionSalesChannel.ts @@ -2,7 +2,6 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - /** * Added since version: 6.0.0.0 */ diff --git a/src/platforms/shopware/api-client/generated/models/PromotionSetgroup.ts b/src/platforms/shopware/api-client/generated/models/PromotionSetgroup.ts index bb78c542..b7fa7a8a 100644 --- a/src/platforms/shopware/api-client/generated/models/PromotionSetgroup.ts +++ b/src/platforms/shopware/api-client/generated/models/PromotionSetgroup.ts @@ -2,7 +2,6 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - /** * Added since version: 6.0.0.0 */ diff --git a/src/platforms/shopware/api-client/generated/models/PropertyGroup.ts b/src/platforms/shopware/api-client/generated/models/PropertyGroup.ts index 9ddc9428..f8d4aacd 100644 --- a/src/platforms/shopware/api-client/generated/models/PropertyGroup.ts +++ b/src/platforms/shopware/api-client/generated/models/PropertyGroup.ts @@ -2,14 +2,12 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - import type { PropertyGroupOption } from './PropertyGroupOption'; - /** * Added since version: 6.0.0.0 */ export type PropertyGroup = { - id?: string; + id: string; name: string; description?: string; displayType: string; @@ -21,6 +19,6 @@ export type PropertyGroup = { readonly createdAt: string; readonly updatedAt?: string; translated?: Record; - options?: PropertyGroupOption; + options?: Array; }; diff --git a/src/platforms/shopware/api-client/generated/models/PropertyGroupOption.ts b/src/platforms/shopware/api-client/generated/models/PropertyGroupOption.ts index 8e98827a..11ab7c5d 100644 --- a/src/platforms/shopware/api-client/generated/models/PropertyGroupOption.ts +++ b/src/platforms/shopware/api-client/generated/models/PropertyGroupOption.ts @@ -2,15 +2,13 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - import type { Media } from './Media'; import type { PropertyGroup } from './PropertyGroup'; - /** * Added since version: 6.0.0.0 */ export type PropertyGroupOption = { - id?: string; + id: string; groupId: string; name: string; position?: number; @@ -21,6 +19,7 @@ export type PropertyGroupOption = { readonly updatedAt?: string; translated?: Record; media?: Media; - group?: PropertyGroup; + group: PropertyGroup; + option: string; }; diff --git a/src/platforms/shopware/api-client/generated/models/ReferencePrice.ts b/src/platforms/shopware/api-client/generated/models/ReferencePrice.ts new file mode 100644 index 00000000..69768238 --- /dev/null +++ b/src/platforms/shopware/api-client/generated/models/ReferencePrice.ts @@ -0,0 +1,20 @@ +/* generated using openapi-typescript-codegen -- do no edit */ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import type { ListPrice } from './ListPrice'; +export type ReferencePrice = { + purchaseUnit?: number; + referenceUnit?: number; + unitName: string; + price?: number; + apiAlias?: 'cart_price_reference'; + listPrice: ListPrice | null; + regulationPrice: { + price?: number; + apiAlias?: 'cart_regulation_price'; + } | null; + hasRange: boolean; + variantId?: string | null; +}; + diff --git a/src/platforms/shopware/api-client/generated/models/Rule.ts b/src/platforms/shopware/api-client/generated/models/Rule.ts index 181c6c0c..805e2cf8 100644 --- a/src/platforms/shopware/api-client/generated/models/Rule.ts +++ b/src/platforms/shopware/api-client/generated/models/Rule.ts @@ -2,7 +2,6 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - /** * Added since version: 6.0.0.0 */ diff --git a/src/platforms/shopware/api-client/generated/models/RuleCondition.ts b/src/platforms/shopware/api-client/generated/models/RuleCondition.ts index b6b876d0..85e56b4a 100644 --- a/src/platforms/shopware/api-client/generated/models/RuleCondition.ts +++ b/src/platforms/shopware/api-client/generated/models/RuleCondition.ts @@ -2,7 +2,6 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - /** * Added since version: 6.0.0.0 */ diff --git a/src/platforms/shopware/api-client/generated/models/SalesChannel.ts b/src/platforms/shopware/api-client/generated/models/SalesChannel.ts index c88a7371..26b525f3 100644 --- a/src/platforms/shopware/api-client/generated/models/SalesChannel.ts +++ b/src/platforms/shopware/api-client/generated/models/SalesChannel.ts @@ -2,7 +2,6 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - import type { Category } from './Category'; import type { Country } from './Country'; import type { Currency } from './Currency'; @@ -10,12 +9,11 @@ import type { Language } from './Language'; import type { PaymentMethod } from './PaymentMethod'; import type { SalesChannelDomain } from './SalesChannelDomain'; import type { ShippingMethod } from './ShippingMethod'; - /** * Added since version: 6.0.0.0 */ export type SalesChannel = { - id?: string; + id: string; languageId: string; customerGroupId: string; currencyId: string; @@ -47,7 +45,7 @@ export type SalesChannel = { paymentMethod?: PaymentMethod; shippingMethod?: ShippingMethod; country?: Country; - domains?: SalesChannelDomain; + domains?: Array; navigationCategory?: Category; footerCategory?: Category; serviceCategory?: Category; diff --git a/src/platforms/shopware/api-client/generated/models/SalesChannelAnalytics.ts b/src/platforms/shopware/api-client/generated/models/SalesChannelAnalytics.ts index 12813474..b0f309a3 100644 --- a/src/platforms/shopware/api-client/generated/models/SalesChannelAnalytics.ts +++ b/src/platforms/shopware/api-client/generated/models/SalesChannelAnalytics.ts @@ -2,7 +2,6 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - /** * Added since version: 6.2.0.0 */ diff --git a/src/platforms/shopware/api-client/generated/models/SalesChannelContext.ts b/src/platforms/shopware/api-client/generated/models/SalesChannelContext.ts index a2d0bc39..5ffbb47d 100644 --- a/src/platforms/shopware/api-client/generated/models/SalesChannelContext.ts +++ b/src/platforms/shopware/api-client/generated/models/SalesChannelContext.ts @@ -2,9 +2,13 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - +import type { Country } from './Country'; +import type { Currency } from './Currency'; +import type { Customer } from './Customer'; +import type { CustomerAddress } from './CustomerAddress'; +import type { PaymentMethod } from './PaymentMethod'; +import type { ShippingMethod } from './ShippingMethod'; import type { Struct } from './Struct'; - export type SalesChannelContext = (Struct & { /** * Context the user session @@ -24,19 +28,7 @@ export type SalesChannelContext = (Struct & { name?: string; displayGross?: boolean; }; - /** - * Currency associated with the current user - */ - currency?: { - isoCode?: string; - factor?: number; - symbol?: string; - shortName?: string; - name?: string; - position?: number; - decimalPrecision?: number; - isSystemDefault?: boolean; - }; + currency?: Currency; /** * Information about the current sales channel */ @@ -70,70 +62,14 @@ export type SalesChannelContext = (Struct & { taxRate?: number; name?: string; }>; - /** - * Information about the current customer - `null` if the customer is not logged in - */ - customer?: { - groupId?: string; - defaultPaymentMethodId?: string; - salesChannelId?: string; - languageId?: string; - lastPaymentMethodId?: string; - defaultBillingAddressId?: string; - defaultShippingAddressId?: string; - customerNumber?: string; - salutationId?: string; - firstName?: string; - lastName?: string; - company?: string; - password?: string; - email?: string; - title?: string; - affiliateCode?: string; - campaignCode?: string; - active?: boolean; - doubleOptInRegistration?: boolean; - doubleOptInEmailSentDate?: string; - doubleOptInConfirmDate?: string; - hash?: string; - guest?: boolean; - firstLogin?: string; - lastLogin?: string; - newsletter?: boolean; - birthday?: string; - lastOrderDate?: string; - orderCount?: number; - legacyEncoder?: string; - legacyPassword?: string; - autoIncrement?: number; - remoteAddress?: string; - }; - /** - * Selected payment method - */ - paymentMethod?: { - pluginId?: string; - handlerIdentifier?: string; - name?: string; - description?: string; - position?: number; - active?: boolean; - availabilityRuleId?: string; - mediaId?: string; - formattedHandlerIdentifier?: string; - }; - /** - * Selected shipping method - */ - shippingMethod?: { - name?: string; - active?: boolean; - description?: string; - trackingUrl?: string; - deliveryTimeId?: string; - availabilityRuleId?: string; - mediaId?: string; + customer?: Customer; + paymentMethod?: PaymentMethod; + shippingLocation?: { + apiAlias?: 'cart_delivery_shipping_location'; + country?: Country; + address?: CustomerAddress; }; + shippingMethod?: ShippingMethod; /** * Core context with general configuration values and state */ @@ -142,6 +78,7 @@ export type SalesChannelContext = (Struct & { currencyId?: string; currencyFactor?: number; currencyPrecision?: number; + languageIdChain?: Array; scope?: string; source?: string; taxState?: string; diff --git a/src/platforms/shopware/api-client/generated/models/SalesChannelDomain.ts b/src/platforms/shopware/api-client/generated/models/SalesChannelDomain.ts index d15d8f06..43a45f7a 100644 --- a/src/platforms/shopware/api-client/generated/models/SalesChannelDomain.ts +++ b/src/platforms/shopware/api-client/generated/models/SalesChannelDomain.ts @@ -2,16 +2,14 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - import type { Currency } from './Currency'; import type { Language } from './Language'; import type { SalesChannel } from './SalesChannel'; - /** * Added since version: 6.0.0.0 */ export type SalesChannelDomain = { - id?: string; + id: string; url: string; salesChannelId: string; languageId: string; diff --git a/src/platforms/shopware/api-client/generated/models/SalesChannelType.ts b/src/platforms/shopware/api-client/generated/models/SalesChannelType.ts index f4633af4..7fd80e0d 100644 --- a/src/platforms/shopware/api-client/generated/models/SalesChannelType.ts +++ b/src/platforms/shopware/api-client/generated/models/SalesChannelType.ts @@ -2,7 +2,6 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - /** * Added since version: 6.0.0.0 */ diff --git a/src/platforms/shopware/api-client/generated/models/Salutation.ts b/src/platforms/shopware/api-client/generated/models/Salutation.ts index 6c737ce7..a2c023c5 100644 --- a/src/platforms/shopware/api-client/generated/models/Salutation.ts +++ b/src/platforms/shopware/api-client/generated/models/Salutation.ts @@ -2,12 +2,11 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - /** * Added since version: 6.0.0.0 */ export type Salutation = { - id?: string; + id: string; salutationKey: string; displayName: string; letterName: string; diff --git a/src/platforms/shopware/api-client/generated/models/SalutationJsonApi.ts b/src/platforms/shopware/api-client/generated/models/SalutationJsonApi.ts index d80991b5..6a2f19cb 100644 --- a/src/platforms/shopware/api-client/generated/models/SalutationJsonApi.ts +++ b/src/platforms/shopware/api-client/generated/models/SalutationJsonApi.ts @@ -2,14 +2,12 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - import type { resource } from './resource'; - /** * Added since version: 6.0.0.0 */ export type SalutationJsonApi = (resource & { - id?: string; + id: string; salutationKey: string; displayName: string; letterName: string; diff --git a/src/platforms/shopware/api-client/generated/models/ScheduledTask.ts b/src/platforms/shopware/api-client/generated/models/ScheduledTask.ts index eccd23eb..679117a2 100644 --- a/src/platforms/shopware/api-client/generated/models/ScheduledTask.ts +++ b/src/platforms/shopware/api-client/generated/models/ScheduledTask.ts @@ -2,7 +2,6 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - /** * Added since version: 6.0.0.0 */ diff --git a/src/platforms/shopware/api-client/generated/models/Script.ts b/src/platforms/shopware/api-client/generated/models/Script.ts index 4e4ffb7d..1480c722 100644 --- a/src/platforms/shopware/api-client/generated/models/Script.ts +++ b/src/platforms/shopware/api-client/generated/models/Script.ts @@ -2,7 +2,6 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - /** * Added since version: 6.4.7.0 */ diff --git a/src/platforms/shopware/api-client/generated/models/SeoUrl.ts b/src/platforms/shopware/api-client/generated/models/SeoUrl.ts index 6409b0be..2520267a 100644 --- a/src/platforms/shopware/api-client/generated/models/SeoUrl.ts +++ b/src/platforms/shopware/api-client/generated/models/SeoUrl.ts @@ -2,16 +2,15 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - /** * Added since version: 6.0.0.0 */ export type SeoUrl = { - id?: string; + id: string; salesChannelId?: string; languageId: string; foreignKey: string; - routeName: string; + routeName: 'frontend.navigation.page' | 'frontend.landing.page' | 'frontend.detail.page'; pathInfo: string; seoPathInfo: string; isCanonical?: boolean; @@ -20,12 +19,12 @@ export type SeoUrl = { /** * Runtime field, cannot be used as part of the criteria. */ - url?: string; - customFields?: Record; + error?: string; /** * Runtime field, cannot be used as part of the criteria. */ - isValid?: boolean; + url?: string; + customFields?: Record; readonly createdAt: string; readonly updatedAt?: string; }; diff --git a/src/platforms/shopware/api-client/generated/models/SeoUrlJsonApi.ts b/src/platforms/shopware/api-client/generated/models/SeoUrlJsonApi.ts index 44ef3a8f..f795c8c5 100644 --- a/src/platforms/shopware/api-client/generated/models/SeoUrlJsonApi.ts +++ b/src/platforms/shopware/api-client/generated/models/SeoUrlJsonApi.ts @@ -2,14 +2,12 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - import type { resource } from './resource'; - /** * Added since version: 6.0.0.0 */ export type SeoUrlJsonApi = (resource & { - id?: string; + id: string; salesChannelId?: string; languageId: string; foreignKey: string; @@ -22,12 +20,12 @@ export type SeoUrlJsonApi = (resource & { /** * Runtime field, cannot be used as part of the criteria. */ - url?: string; - customFields?: Record; + error?: string; /** * Runtime field, cannot be used as part of the criteria. */ - isValid?: boolean; + url?: string; + customFields?: Record; readonly createdAt: string; readonly updatedAt?: string; }); diff --git a/src/platforms/shopware/api-client/generated/models/SeoUrlTemplate.ts b/src/platforms/shopware/api-client/generated/models/SeoUrlTemplate.ts index 6e8a7299..56ffc9bd 100644 --- a/src/platforms/shopware/api-client/generated/models/SeoUrlTemplate.ts +++ b/src/platforms/shopware/api-client/generated/models/SeoUrlTemplate.ts @@ -2,7 +2,6 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - /** * Added since version: 6.0.0.0 */ diff --git a/src/platforms/shopware/api-client/generated/models/ShippingMethod.ts b/src/platforms/shopware/api-client/generated/models/ShippingMethod.ts index 5ba7f04b..9d0fa23f 100644 --- a/src/platforms/shopware/api-client/generated/models/ShippingMethod.ts +++ b/src/platforms/shopware/api-client/generated/models/ShippingMethod.ts @@ -2,19 +2,17 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - import type { DeliveryTime } from './DeliveryTime'; import type { Media } from './Media'; import type { Rule } from './Rule'; import type { ShippingMethodPrice } from './ShippingMethodPrice'; import type { Tag } from './Tag'; import type { Tax } from './Tax'; - /** * Added since version: 6.0.0.0 */ export type ShippingMethod = { - id?: string; + id: string; name: string; active?: boolean; position?: number; @@ -24,14 +22,15 @@ export type ShippingMethod = { taxType: string; description?: string; trackingUrl?: string; + technicalName?: string; readonly createdAt: string; readonly updatedAt?: string; translated?: Record; deliveryTime?: DeliveryTime; availabilityRule?: Rule; - prices?: ShippingMethodPrice; + prices?: Array; media?: Media; - tags?: Tag; + tags?: Array; tax?: Tax; }; diff --git a/src/platforms/shopware/api-client/generated/models/ShippingMethodJsonApi.ts b/src/platforms/shopware/api-client/generated/models/ShippingMethodJsonApi.ts index 1e90cb1d..90d86559 100644 --- a/src/platforms/shopware/api-client/generated/models/ShippingMethodJsonApi.ts +++ b/src/platforms/shopware/api-client/generated/models/ShippingMethodJsonApi.ts @@ -2,14 +2,12 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - import type { resource } from './resource'; - /** * Added since version: 6.0.0.0 */ export type ShippingMethodJsonApi = (resource & { - id?: string; + id: string; name: string; active?: boolean; position?: number; @@ -19,9 +17,65 @@ export type ShippingMethodJsonApi = (resource & { taxType: string; description?: string; trackingUrl?: string; + technicalName?: string; readonly createdAt: string; readonly updatedAt?: string; translated?: Record; - relationships?: any; + relationships?: { + deliveryTime?: { + links?: { + related?: string; + }; + data?: { + type?: string; + id?: string; + }; + }; + availabilityRule?: { + links?: { + related?: string; + }; + data?: { + type?: string; + id?: string; + }; + }; + prices?: { + links?: { + related?: string; + }; + data?: Array<{ + type?: string; + id?: string; + }>; + }; + media?: { + links?: { + related?: string; + }; + data?: { + type?: string; + id?: string; + }; + }; + tags?: { + links?: { + related?: string; + }; + data?: Array<{ + type?: string; + id?: string; + }>; + }; + tax?: { + links?: { + related?: string; + }; + data?: { + type?: string; + id?: string; + }; + }; + }; }); diff --git a/src/platforms/shopware/api-client/generated/models/ShippingMethodPageRouteResponse.ts b/src/platforms/shopware/api-client/generated/models/ShippingMethodPageRouteResponse.ts index bc1bb6e4..53d11174 100644 --- a/src/platforms/shopware/api-client/generated/models/ShippingMethodPageRouteResponse.ts +++ b/src/platforms/shopware/api-client/generated/models/ShippingMethodPageRouteResponse.ts @@ -1,7 +1,7 @@ /* generated using openapi-typescript-codegen -- do no edit */ /* istanbul ignore file */ /* tslint:disable */ - +/* eslint-disable */ export type ShippingMethodPageRouteResponse = Array<{ name?: string; active?: boolean; diff --git a/src/platforms/shopware/api-client/generated/models/ShippingMethodPrice.ts b/src/platforms/shopware/api-client/generated/models/ShippingMethodPrice.ts index 8c932c4f..37febc1e 100644 --- a/src/platforms/shopware/api-client/generated/models/ShippingMethodPrice.ts +++ b/src/platforms/shopware/api-client/generated/models/ShippingMethodPrice.ts @@ -2,12 +2,11 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - /** * Added since version: 6.0.0.0 */ export type ShippingMethodPrice = { - id?: string; + id: string; shippingMethodId: string; ruleId?: string; calculation?: number; diff --git a/src/platforms/shopware/api-client/generated/models/Sitemap.ts b/src/platforms/shopware/api-client/generated/models/Sitemap.ts index deb18bf4..4e414b7e 100644 --- a/src/platforms/shopware/api-client/generated/models/Sitemap.ts +++ b/src/platforms/shopware/api-client/generated/models/Sitemap.ts @@ -2,11 +2,9 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - import type { Struct } from './Struct'; - export type Sitemap = (Struct & { - filename?: string; - created?: string; + filename: string; + created: string; }); diff --git a/src/platforms/shopware/api-client/generated/models/Snippet.ts b/src/platforms/shopware/api-client/generated/models/Snippet.ts index 357800ad..e41fd710 100644 --- a/src/platforms/shopware/api-client/generated/models/Snippet.ts +++ b/src/platforms/shopware/api-client/generated/models/Snippet.ts @@ -2,7 +2,6 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - /** * Added since version: 6.0.0.0 */ diff --git a/src/platforms/shopware/api-client/generated/models/SnippetSet.ts b/src/platforms/shopware/api-client/generated/models/SnippetSet.ts index a4e46521..867e4d3a 100644 --- a/src/platforms/shopware/api-client/generated/models/SnippetSet.ts +++ b/src/platforms/shopware/api-client/generated/models/SnippetSet.ts @@ -2,9 +2,7 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - import type { Snippet } from './Snippet'; - /** * Added since version: 6.0.0.0 */ @@ -15,6 +13,6 @@ export type SnippetSet = { customFields?: Record; readonly createdAt: string; readonly updatedAt?: string; - snippets?: Snippet; + snippets?: Array; }; diff --git a/src/platforms/shopware/api-client/generated/models/StateMachine.ts b/src/platforms/shopware/api-client/generated/models/StateMachine.ts index 7c62a8d2..be64b359 100644 --- a/src/platforms/shopware/api-client/generated/models/StateMachine.ts +++ b/src/platforms/shopware/api-client/generated/models/StateMachine.ts @@ -2,10 +2,8 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - import type { StateMachineState } from './StateMachineState'; import type { StateMachineTransition } from './StateMachineTransition'; - /** * Added since version: 6.0.0.0 */ @@ -14,7 +12,7 @@ export type StateMachine = { readonly createdAt: string; readonly updatedAt?: string; translated?: Record; - states?: StateMachineState; - transitions?: StateMachineTransition; + states?: Array; + transitions?: Array; }; diff --git a/src/platforms/shopware/api-client/generated/models/StateMachineHistory.ts b/src/platforms/shopware/api-client/generated/models/StateMachineHistory.ts index 210eacd8..2907256c 100644 --- a/src/platforms/shopware/api-client/generated/models/StateMachineHistory.ts +++ b/src/platforms/shopware/api-client/generated/models/StateMachineHistory.ts @@ -2,9 +2,7 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - import type { StateMachineState } from './StateMachineState'; - /** * Added since version: 6.0.0.0 */ diff --git a/src/platforms/shopware/api-client/generated/models/StateMachineState.ts b/src/platforms/shopware/api-client/generated/models/StateMachineState.ts index 38e0a4b0..e6ebc505 100644 --- a/src/platforms/shopware/api-client/generated/models/StateMachineState.ts +++ b/src/platforms/shopware/api-client/generated/models/StateMachineState.ts @@ -2,7 +2,6 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - /** * Added since version: 6.0.0.0 */ diff --git a/src/platforms/shopware/api-client/generated/models/StateMachineTransition.ts b/src/platforms/shopware/api-client/generated/models/StateMachineTransition.ts index 00e77519..af3e9db1 100644 --- a/src/platforms/shopware/api-client/generated/models/StateMachineTransition.ts +++ b/src/platforms/shopware/api-client/generated/models/StateMachineTransition.ts @@ -2,7 +2,6 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - /** * Added since version: 6.0.0.0 */ diff --git a/src/platforms/shopware/api-client/generated/models/Struct.ts b/src/platforms/shopware/api-client/generated/models/Struct.ts index 04cd76e2..deeb09c6 100644 --- a/src/platforms/shopware/api-client/generated/models/Struct.ts +++ b/src/platforms/shopware/api-client/generated/models/Struct.ts @@ -2,7 +2,6 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - export type Struct = { /** * Alias which can be used to restrict response fields. For more information see [includes](https://shopware.stoplight.io/docs/store-api/docs/concepts/search-queries.md#includes-apialias). diff --git a/src/platforms/shopware/api-client/generated/models/SuccessResponse.ts b/src/platforms/shopware/api-client/generated/models/SuccessResponse.ts index cb738b9d..39956040 100644 --- a/src/platforms/shopware/api-client/generated/models/SuccessResponse.ts +++ b/src/platforms/shopware/api-client/generated/models/SuccessResponse.ts @@ -2,7 +2,6 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - export type SuccessResponse = { success?: boolean; }; diff --git a/src/platforms/shopware/api-client/generated/models/SystemConfig.ts b/src/platforms/shopware/api-client/generated/models/SystemConfig.ts index 6d803405..27a29a81 100644 --- a/src/platforms/shopware/api-client/generated/models/SystemConfig.ts +++ b/src/platforms/shopware/api-client/generated/models/SystemConfig.ts @@ -2,14 +2,12 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - import type { SalesChannel } from './SalesChannel'; - /** * Added since version: 6.0.0.0 */ export type SystemConfig = { - id?: string; + id: string; configurationKey: string; configurationValue: { _value?: Record; diff --git a/src/platforms/shopware/api-client/generated/models/Tag.ts b/src/platforms/shopware/api-client/generated/models/Tag.ts index f67b29ab..017726ad 100644 --- a/src/platforms/shopware/api-client/generated/models/Tag.ts +++ b/src/platforms/shopware/api-client/generated/models/Tag.ts @@ -2,12 +2,12 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - /** * Added since version: 6.0.0.0 */ export type Tag = { - id?: string; + id: string; + name: string; readonly createdAt: string; readonly updatedAt?: string; }; diff --git a/src/platforms/shopware/api-client/generated/models/Tax.ts b/src/platforms/shopware/api-client/generated/models/Tax.ts index 6d55a051..e5782175 100644 --- a/src/platforms/shopware/api-client/generated/models/Tax.ts +++ b/src/platforms/shopware/api-client/generated/models/Tax.ts @@ -2,12 +2,11 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - /** * Added since version: 6.0.0.0 */ export type Tax = { - id?: string; + id: string; taxRate: number; name: string; /** diff --git a/src/platforms/shopware/api-client/generated/models/TaxProvider.ts b/src/platforms/shopware/api-client/generated/models/TaxProvider.ts index 6e7f9691..2bf547a1 100644 --- a/src/platforms/shopware/api-client/generated/models/TaxProvider.ts +++ b/src/platforms/shopware/api-client/generated/models/TaxProvider.ts @@ -2,12 +2,11 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - /** * Added since version: 6.5.0.0 */ export type TaxProvider = { - id?: string; + id: string; active?: boolean; name: string; priority: number; diff --git a/src/platforms/shopware/api-client/generated/models/TaxRule.ts b/src/platforms/shopware/api-client/generated/models/TaxRule.ts index c9372668..c1f65525 100644 --- a/src/platforms/shopware/api-client/generated/models/TaxRule.ts +++ b/src/platforms/shopware/api-client/generated/models/TaxRule.ts @@ -2,7 +2,6 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - /** * Added since version: 6.1.0.0 */ diff --git a/src/platforms/shopware/api-client/generated/models/TaxRuleType.ts b/src/platforms/shopware/api-client/generated/models/TaxRuleType.ts index 4f3a7c6b..62c29b2a 100644 --- a/src/platforms/shopware/api-client/generated/models/TaxRuleType.ts +++ b/src/platforms/shopware/api-client/generated/models/TaxRuleType.ts @@ -2,7 +2,6 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - /** * Added since version: 6.1.0.0 */ diff --git a/src/platforms/shopware/api-client/generated/models/Theme.ts b/src/platforms/shopware/api-client/generated/models/Theme.ts index 0216e448..205a633e 100644 --- a/src/platforms/shopware/api-client/generated/models/Theme.ts +++ b/src/platforms/shopware/api-client/generated/models/Theme.ts @@ -2,14 +2,12 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - import type { Media } from './Media'; - /** * Added since version: 6.0.0.0 */ export type Theme = { - id?: string; + id: string; technicalName?: string; name: string; author: string; @@ -25,6 +23,6 @@ export type Theme = { readonly createdAt: string; readonly updatedAt?: string; translated?: Record; - media?: Media; + media?: Array; }; diff --git a/src/platforms/shopware/api-client/generated/models/Unit.ts b/src/platforms/shopware/api-client/generated/models/Unit.ts index 55a95cab..d04fcafa 100644 --- a/src/platforms/shopware/api-client/generated/models/Unit.ts +++ b/src/platforms/shopware/api-client/generated/models/Unit.ts @@ -2,12 +2,11 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - /** * Added since version: 6.0.0.0 */ export type Unit = { - id?: string; + id: string; shortCode: string; name: string; customFields?: Record; diff --git a/src/platforms/shopware/api-client/generated/models/User.ts b/src/platforms/shopware/api-client/generated/models/User.ts index e8be647b..8b8e2ff3 100644 --- a/src/platforms/shopware/api-client/generated/models/User.ts +++ b/src/platforms/shopware/api-client/generated/models/User.ts @@ -2,7 +2,6 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - /** * Added since version: 6.0.0.0 */ diff --git a/src/platforms/shopware/api-client/generated/models/UserAccessKey.ts b/src/platforms/shopware/api-client/generated/models/UserAccessKey.ts index 72feb8ff..ef6371ae 100644 --- a/src/platforms/shopware/api-client/generated/models/UserAccessKey.ts +++ b/src/platforms/shopware/api-client/generated/models/UserAccessKey.ts @@ -2,7 +2,6 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - /** * Added since version: 6.0.0.0 */ diff --git a/src/platforms/shopware/api-client/generated/models/UserConfig.ts b/src/platforms/shopware/api-client/generated/models/UserConfig.ts index 83f95dd5..f7b7dcff 100644 --- a/src/platforms/shopware/api-client/generated/models/UserConfig.ts +++ b/src/platforms/shopware/api-client/generated/models/UserConfig.ts @@ -2,7 +2,6 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - /** * Added since version: 6.3.5.0 */ diff --git a/src/platforms/shopware/api-client/generated/models/UserRecovery.ts b/src/platforms/shopware/api-client/generated/models/UserRecovery.ts index dbd20c00..06823fd8 100644 --- a/src/platforms/shopware/api-client/generated/models/UserRecovery.ts +++ b/src/platforms/shopware/api-client/generated/models/UserRecovery.ts @@ -2,7 +2,6 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - /** * Added since version: 6.0.0.0 */ diff --git a/src/platforms/shopware/api-client/generated/models/Webhook.ts b/src/platforms/shopware/api-client/generated/models/Webhook.ts index c3b0ff4f..eeb7bd25 100644 --- a/src/platforms/shopware/api-client/generated/models/Webhook.ts +++ b/src/platforms/shopware/api-client/generated/models/Webhook.ts @@ -2,7 +2,6 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - /** * Added since version: 6.3.1.0 */ diff --git a/src/platforms/shopware/api-client/generated/models/WebhookEventLog.ts b/src/platforms/shopware/api-client/generated/models/WebhookEventLog.ts index 5a91a7dc..a33f3283 100644 --- a/src/platforms/shopware/api-client/generated/models/WebhookEventLog.ts +++ b/src/platforms/shopware/api-client/generated/models/WebhookEventLog.ts @@ -2,7 +2,6 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - /** * Added since version: 6.4.1.0 */ diff --git a/src/platforms/shopware/api-client/generated/models/WishlistLoadRouteResponse.ts b/src/platforms/shopware/api-client/generated/models/WishlistLoadRouteResponse.ts index fb51a96c..c7b8d8dc 100644 --- a/src/platforms/shopware/api-client/generated/models/WishlistLoadRouteResponse.ts +++ b/src/platforms/shopware/api-client/generated/models/WishlistLoadRouteResponse.ts @@ -2,14 +2,12 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - import type { ProductListingResult } from './ProductListingResult'; - export type WishlistLoadRouteResponse = { wishlist?: { customerId?: string; salesChannelId?: string; }; - products?: Array; + products?: ProductListingResult; }; diff --git a/src/platforms/shopware/api-client/generated/models/accept.ts b/src/platforms/shopware/api-client/generated/models/accept.ts index cafd31ce..e9d6c832 100644 --- a/src/platforms/shopware/api-client/generated/models/accept.ts +++ b/src/platforms/shopware/api-client/generated/models/accept.ts @@ -1,7 +1,7 @@ /* generated using openapi-typescript-codegen -- do no edit */ /* istanbul ignore file */ /* tslint:disable */ - +/* eslint-disable */ /** * Accepted response content types */ diff --git a/src/platforms/shopware/api-client/generated/models/attributes.ts b/src/platforms/shopware/api-client/generated/models/attributes.ts index d4c337cc..e3e4e6a2 100644 --- a/src/platforms/shopware/api-client/generated/models/attributes.ts +++ b/src/platforms/shopware/api-client/generated/models/attributes.ts @@ -1,7 +1,7 @@ /* generated using openapi-typescript-codegen -- do no edit */ /* istanbul ignore file */ /* tslint:disable */ - +/* eslint-disable */ /** * Members of the attributes object ("attributes") represent information about the resource object in which it's defined. */ diff --git a/src/platforms/shopware/api-client/generated/models/contentType.ts b/src/platforms/shopware/api-client/generated/models/contentType.ts index 511a9dbe..7b1b64ed 100644 --- a/src/platforms/shopware/api-client/generated/models/contentType.ts +++ b/src/platforms/shopware/api-client/generated/models/contentType.ts @@ -1,7 +1,7 @@ /* generated using openapi-typescript-codegen -- do no edit */ /* istanbul ignore file */ /* tslint:disable */ - +/* eslint-disable */ /** * Content type of the request */ diff --git a/src/platforms/shopware/api-client/generated/models/data.ts b/src/platforms/shopware/api-client/generated/models/data.ts index b791b25a..589f78f2 100644 --- a/src/platforms/shopware/api-client/generated/models/data.ts +++ b/src/platforms/shopware/api-client/generated/models/data.ts @@ -2,9 +2,7 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - import type { resource } from './resource'; - /** * The document's "primary data" is a representation of the resource or collection of resources targeted by a request. */ diff --git a/src/platforms/shopware/api-client/generated/models/error.ts b/src/platforms/shopware/api-client/generated/models/error.ts index 9e3f4e3e..ee0282c3 100644 --- a/src/platforms/shopware/api-client/generated/models/error.ts +++ b/src/platforms/shopware/api-client/generated/models/error.ts @@ -2,10 +2,8 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - import type { links } from './links'; import type { meta } from './meta'; - export type error = { /** * A unique identifier for this particular occurrence of the problem. @@ -28,6 +26,10 @@ export type error = { * A human-readable explanation specific to this occurrence of the problem. */ detail?: string; + /** + * A human-readable description of the problem. + */ + description?: string; source?: { /** * A JSON Pointer [RFC6901] to the associated entity in the request document [e.g. "/data" for a primary data object, or "/data/attributes/title" for a specific attribute]. diff --git a/src/platforms/shopware/api-client/generated/models/failure.ts b/src/platforms/shopware/api-client/generated/models/failure.ts index 612cbdd7..1d052f26 100644 --- a/src/platforms/shopware/api-client/generated/models/failure.ts +++ b/src/platforms/shopware/api-client/generated/models/failure.ts @@ -2,11 +2,9 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - import type { error } from './error'; import type { links } from './links'; import type { meta } from './meta'; - export type failure = { meta?: meta; links?: links; diff --git a/src/platforms/shopware/api-client/generated/models/info.ts b/src/platforms/shopware/api-client/generated/models/info.ts index bc9388a2..03db5afc 100644 --- a/src/platforms/shopware/api-client/generated/models/info.ts +++ b/src/platforms/shopware/api-client/generated/models/info.ts @@ -2,11 +2,9 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - import type { jsonapi } from './jsonapi'; import type { links } from './links'; import type { meta } from './meta'; - export type info = { meta: meta; links?: links; diff --git a/src/platforms/shopware/api-client/generated/models/jsonapi.ts b/src/platforms/shopware/api-client/generated/models/jsonapi.ts index 73c6ae17..f7750c7d 100644 --- a/src/platforms/shopware/api-client/generated/models/jsonapi.ts +++ b/src/platforms/shopware/api-client/generated/models/jsonapi.ts @@ -2,9 +2,7 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - import type { meta } from './meta'; - /** * An object describing the server's implementation */ diff --git a/src/platforms/shopware/api-client/generated/models/link.ts b/src/platforms/shopware/api-client/generated/models/link.ts index a00398d5..4fddf4d5 100644 --- a/src/platforms/shopware/api-client/generated/models/link.ts +++ b/src/platforms/shopware/api-client/generated/models/link.ts @@ -2,9 +2,7 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - import type { meta } from './meta'; - /** * A link **MUST** be represented as either: a string containing the link's URL or a link object. */ diff --git a/src/platforms/shopware/api-client/generated/models/linkage.ts b/src/platforms/shopware/api-client/generated/models/linkage.ts index c0ee7526..ca836d61 100644 --- a/src/platforms/shopware/api-client/generated/models/linkage.ts +++ b/src/platforms/shopware/api-client/generated/models/linkage.ts @@ -2,9 +2,7 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - import type { meta } from './meta'; - /** * The "type" and "id" to non-empty members. */ diff --git a/src/platforms/shopware/api-client/generated/models/links.ts b/src/platforms/shopware/api-client/generated/models/links.ts index 7e875d64..4316828f 100644 --- a/src/platforms/shopware/api-client/generated/models/links.ts +++ b/src/platforms/shopware/api-client/generated/models/links.ts @@ -2,7 +2,5 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - import type { link } from './link'; - export type links = Record; diff --git a/src/platforms/shopware/api-client/generated/models/meta.ts b/src/platforms/shopware/api-client/generated/models/meta.ts index 37a71131..4b7db9da 100644 --- a/src/platforms/shopware/api-client/generated/models/meta.ts +++ b/src/platforms/shopware/api-client/generated/models/meta.ts @@ -1,7 +1,7 @@ /* generated using openapi-typescript-codegen -- do no edit */ /* istanbul ignore file */ /* tslint:disable */ - +/* eslint-disable */ /** * Non-standard meta-information that can not be represented as an attribute or relationship. */ diff --git a/src/platforms/shopware/api-client/generated/models/pagination.ts b/src/platforms/shopware/api-client/generated/models/pagination.ts index bbf9f26b..9932b08e 100644 --- a/src/platforms/shopware/api-client/generated/models/pagination.ts +++ b/src/platforms/shopware/api-client/generated/models/pagination.ts @@ -2,7 +2,6 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - export type pagination = { /** * The first page of data diff --git a/src/platforms/shopware/api-client/generated/models/relationshipLinks.ts b/src/platforms/shopware/api-client/generated/models/relationshipLinks.ts index 79893f17..9448d862 100644 --- a/src/platforms/shopware/api-client/generated/models/relationshipLinks.ts +++ b/src/platforms/shopware/api-client/generated/models/relationshipLinks.ts @@ -1,7 +1,7 @@ /* generated using openapi-typescript-codegen -- do no edit */ /* istanbul ignore file */ /* tslint:disable */ - +/* eslint-disable */ /** * A resource object **MAY** contain references to other resource objects ("relationships"). Relationships may be to-one or to-many. Relationships can be specified by including a member in a resource's links object. */ diff --git a/src/platforms/shopware/api-client/generated/models/relationshipToMany.ts b/src/platforms/shopware/api-client/generated/models/relationshipToMany.ts index 2027dcc2..6c2a8789 100644 --- a/src/platforms/shopware/api-client/generated/models/relationshipToMany.ts +++ b/src/platforms/shopware/api-client/generated/models/relationshipToMany.ts @@ -2,9 +2,7 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - import type { linkage } from './linkage'; - /** * An array of objects each containing \"type\" and \"id\" members for to-many relationships. */ diff --git a/src/platforms/shopware/api-client/generated/models/relationshipToOne.ts b/src/platforms/shopware/api-client/generated/models/relationshipToOne.ts index 080a7e03..8ba0dde4 100644 --- a/src/platforms/shopware/api-client/generated/models/relationshipToOne.ts +++ b/src/platforms/shopware/api-client/generated/models/relationshipToOne.ts @@ -2,8 +2,6 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - import type { linkage } from './linkage'; - export type relationshipToOne = linkage; diff --git a/src/platforms/shopware/api-client/generated/models/relationships.ts b/src/platforms/shopware/api-client/generated/models/relationships.ts index ca3cab77..3f334df1 100644 --- a/src/platforms/shopware/api-client/generated/models/relationships.ts +++ b/src/platforms/shopware/api-client/generated/models/relationships.ts @@ -2,11 +2,9 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - import type { relationshipLinks } from './relationshipLinks'; import type { relationshipToMany } from './relationshipToMany'; import type { relationshipToOne } from './relationshipToOne'; - /** * Members of the relationships object ("relationships") represent references from the resource object in which it's defined to other resource objects. */ diff --git a/src/platforms/shopware/api-client/generated/models/resource.ts b/src/platforms/shopware/api-client/generated/models/resource.ts index 4f39c968..9d986254 100644 --- a/src/platforms/shopware/api-client/generated/models/resource.ts +++ b/src/platforms/shopware/api-client/generated/models/resource.ts @@ -2,12 +2,10 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - import type { attributes } from './attributes'; import type { links } from './links'; import type { meta } from './meta'; import type { relationships } from './relationships'; - /** * "Resource objects" appear in a JSON API document to represent resources. */ diff --git a/src/platforms/shopware/api-client/generated/models/success.ts b/src/platforms/shopware/api-client/generated/models/success.ts index 0df92abe..48710855 100644 --- a/src/platforms/shopware/api-client/generated/models/success.ts +++ b/src/platforms/shopware/api-client/generated/models/success.ts @@ -2,13 +2,11 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ - import type { data } from './data'; import type { links } from './links'; import type { meta } from './meta'; import type { pagination } from './pagination'; import type { resource } from './resource'; - export type success = { meta?: meta; /** diff --git a/src/platforms/shopware/api-client/generated/services/AddressShopware.ts b/src/platforms/shopware/api-client/generated/services/AddressShopware.ts index 418f1bce..30e82953 100644 --- a/src/platforms/shopware/api-client/generated/services/AddressShopware.ts +++ b/src/platforms/shopware/api-client/generated/services/AddressShopware.ts @@ -4,13 +4,10 @@ /* eslint-disable */ import type { Criteria } from '../models/Criteria'; import type { CustomerAddress } from '../models/CustomerAddress'; - import type { CancelablePromise } from '../core/CancelablePromise'; import { OpenAPI } from '../core/OpenAPI'; import { request as __request } from '../core/request'; - export class AddressShopware { - /** * Delete an address of a customer * Delete an address of customer. @@ -38,7 +35,6 @@ export class AddressShopware { }, }); } - /** * Modify an address of a customer * Modifies an existing address of a customer. @@ -61,7 +57,6 @@ export class AddressShopware { mediaType: 'application/json', }); } - /** * Fetch addresses of a customer * Lists all addresses of the current customer and allows filtering them based on a criteria. @@ -79,7 +74,6 @@ export class AddressShopware { mediaType: 'application/json', }); } - /** * Change a customer's default shipping address * Updates the default (preselected) shipping addresses of a customer. @@ -98,7 +92,6 @@ export class AddressShopware { }, }); } - /** * Change a customer's default billing address * Updates the default (preselected) billing addresses of a customer. @@ -117,7 +110,6 @@ export class AddressShopware { }, }); } - /** * Create a new address for a customer * Creates a new address for a customer. @@ -135,5 +127,4 @@ export class AddressShopware { mediaType: 'application/json', }); } - } diff --git a/src/platforms/shopware/api-client/generated/services/ApiShopware.ts b/src/platforms/shopware/api-client/generated/services/ApiShopware.ts index 893e1c2b..d5732d69 100644 --- a/src/platforms/shopware/api-client/generated/services/ApiShopware.ts +++ b/src/platforms/shopware/api-client/generated/services/ApiShopware.ts @@ -5,9 +5,7 @@ import type { CancelablePromise } from '../core/CancelablePromise'; import { OpenAPI } from '../core/OpenAPI'; import { request as __request } from '../core/request'; - export class ApiShopware { - /** * Access point for different api logics which are provided by apps over script hooks * @param hook Dynamic hook which used to build the hook name @@ -25,5 +23,4 @@ export class ApiShopware { }, }); } - } diff --git a/src/platforms/shopware/api-client/generated/services/AppShopware.ts b/src/platforms/shopware/api-client/generated/services/AppShopware.ts index 70f17ca9..8fbe72a0 100644 --- a/src/platforms/shopware/api-client/generated/services/AppShopware.ts +++ b/src/platforms/shopware/api-client/generated/services/AppShopware.ts @@ -5,9 +5,7 @@ import type { CancelablePromise } from '../core/CancelablePromise'; import { OpenAPI } from '../core/OpenAPI'; import { request as __request } from '../core/request'; - export class AppShopware { - /** * Access point for different api logics which are provided by apps over script hooks * @param hook Dynamic hook which used to build the hook name @@ -25,5 +23,4 @@ export class AppShopware { }, }); } - } diff --git a/src/platforms/shopware/api-client/generated/services/AppSystemShopware.ts b/src/platforms/shopware/api-client/generated/services/AppSystemShopware.ts new file mode 100644 index 00000000..478e4539 --- /dev/null +++ b/src/platforms/shopware/api-client/generated/services/AppSystemShopware.ts @@ -0,0 +1,35 @@ +/* generated using openapi-typescript-codegen -- do no edit */ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import type { CancelablePromise } from '../core/CancelablePromise'; +import { OpenAPI } from '../core/OpenAPI'; +import { request as __request } from '../core/request'; +export class AppSystemShopware { + /** + * Generate JWT token for app system backend + * Generate JWT token for authenticated communication with the app server + * @param name Name of the app + * @param requestBody + * @returns any + * @throws ApiError + */ + public static generateJwtAppSystemAppServer( + name: string, + requestBody?: Record, + ): CancelablePromise<{ + token?: string; + expires?: string; + shopId?: string; + }> { + return __request(OpenAPI, { + method: 'POST', + url: '/app-system/{name}/generate-token', + path: { + 'name': name, + }, + body: requestBody, + mediaType: 'application/json', + }); + } +} diff --git a/src/platforms/shopware/api-client/generated/services/CartShopware.ts b/src/platforms/shopware/api-client/generated/services/CartShopware.ts index ced61b12..f42549b3 100644 --- a/src/platforms/shopware/api-client/generated/services/CartShopware.ts +++ b/src/platforms/shopware/api-client/generated/services/CartShopware.ts @@ -4,32 +4,22 @@ /* eslint-disable */ import type { Cart } from '../models/Cart'; import type { CartItems } from '../models/CartItems'; - import type { CancelablePromise } from '../core/CancelablePromise'; import { OpenAPI } from '../core/OpenAPI'; import { request as __request } from '../core/request'; - export class CartShopware { - /** * Fetch or create a cart * Used to fetch the current cart or for creating a new one. - * @param name The name of the new cart. This parameter will only be used when creating a new cart. * @returns Cart Cart * @throws ApiError */ - public static readCart( - name?: string, - ): CancelablePromise { + public static readCart(): CancelablePromise { return __request(OpenAPI, { method: 'GET', url: '/checkout/cart', - query: { - 'name': name, - }, }); } - /** * Delete a cart * This route deletes the cart of the customer. @@ -42,7 +32,6 @@ export class CartShopware { url: '/checkout/cart', }); } - /** * Add items to the cart * This route adds items to the cart. An item can be a product or promotion for example. They are referenced by the `referencedId`-parameter. @@ -62,17 +51,17 @@ export class CartShopware { mediaType: 'application/json', }); } - /** + * @deprecated * Remove items from the cart - * This route removes items from the cart and recalculates it. + * DEPRECATED: use removeLineItem instead. This route removes items from the cart and recalculates it. * * Example: [Working with the cart - Guide](https://developer.shopware.com/docs/guides/integrations-api/store-api-guide/work-with-the-cart#deleting-items-in-the-cart) * @param ids A list of product identifiers. * @returns Cart The updated cart. * @throws ApiError */ - public static removeLineItem( + public static removeLineItemDeprecated( ids: Array, ): CancelablePromise { return __request(OpenAPI, { @@ -83,7 +72,6 @@ export class CartShopware { }, }); } - /** * Update items in the cart * This route updates items in the cart. A typical example is updating the quantity of an item. @@ -103,5 +91,28 @@ export class CartShopware { mediaType: 'application/json', }); } - + /** + * Remove items from the cart + * This route removes items from the cart and recalculates it. + * + * Example: [Working with the cart - Guide](https://developer.shopware.com/docs/guides/integrations-api/store-api-guide/work-with-the-cart#deleting-items-in-the-cart) + * @param requestBody + * @returns Cart The updated cart. + * @throws ApiError + */ + public static removeLineItem( + requestBody: { + /** + * A list of product identifiers. + */ + ids: Array; + }, + ): CancelablePromise { + return __request(OpenAPI, { + method: 'POST', + url: '/checkout/cart/line-item/delete', + body: requestBody, + mediaType: 'application/json', + }); + } } diff --git a/src/platforms/shopware/api-client/generated/services/CategoryShopware.ts b/src/platforms/shopware/api-client/generated/services/CategoryShopware.ts index 33187e08..e29d7f08 100644 --- a/src/platforms/shopware/api-client/generated/services/CategoryShopware.ts +++ b/src/platforms/shopware/api-client/generated/services/CategoryShopware.ts @@ -6,14 +6,57 @@ import type { Category } from '../models/Category'; import type { Criteria } from '../models/Criteria'; import type { EntitySearchResult } from '../models/EntitySearchResult'; import type { NavigationRouteResponse } from '../models/NavigationRouteResponse'; +import type { NavigationType } from '../models/NavigationType'; import type { ProductListingCriteria } from '../models/ProductListingCriteria'; - import type { CancelablePromise } from '../core/CancelablePromise'; import { OpenAPI } from '../core/OpenAPI'; import { request as __request } from '../core/request'; - export class CategoryShopware { - + /** + * Fetch a navigation menu + * This endpoint returns categories that can be used as a page navigation. You can either return them as a tree or as a flat list. You can also control the depth of the tree. + * + * Instead of passing uuids, you can also use one of the following aliases for the activeId and rootId parameters to get the respective navigations of your sales channel. + * + * * main-navigation + * * service-navigation + * * footer-navigation + * @param activeId Identifier of the active category in the navigation tree (if not used, just set to the same as rootId). + * @param rootId Identifier of the root category for your desired navigation tree. You can use it to fetch sub-trees of your navigation tree. + * @param requestBody + * @param swIncludeSeoUrls Instructs Shopware to try and resolve SEO URLs for the given navigation item + * @returns NavigationRouteResponse All available navigations + * @throws ApiError + */ + public static readNavigation( + activeId: (string | NavigationType), + rootId: (string | NavigationType), + requestBody: (Criteria & { + /** + * Determines the depth of fetched navigation levels. + */ + depth?: number; + /** + * Return the categories as a tree or as a flat list. + */ + buildTree?: Array>; + }), + swIncludeSeoUrls?: boolean, + ): CancelablePromise { + return __request(OpenAPI, { + method: 'POST', + url: '/navigation/{activeId}/{rootId}', + path: { + 'activeId': activeId, + 'rootId': rootId, + }, + headers: { + 'sw-include-seo-urls': swIncludeSeoUrls, + }, + body: requestBody, + mediaType: 'application/json', + }); + } /** * Fetch a list of categories * Perform a filtered search for categories. @@ -33,11 +76,11 @@ export class CategoryShopware { mediaType: 'application/json', }); } - /** * Fetch a single category * This endpoint returns information about the category, as well as a fully resolved (hydrated with mapping values) CMS page, if one is assigned to the category. You can pass slots which should be resolved exclusively. * @param navigationId Identifier of the category to be fetched + * @param swIncludeSeoUrls Instructs Shopware to try and resolve SEO URLs for the given navigation item * @param slots Resolves only the given slot identifiers. The identifiers have to be seperated by a '|' character * @param requestBody * @returns Category The loaded category with cms page @@ -45,6 +88,7 @@ export class CategoryShopware { */ public static readCategory( navigationId: string, + swIncludeSeoUrls?: boolean, slots?: string, requestBody?: (Criteria & ProductListingCriteria), ): CancelablePromise { @@ -54,58 +98,14 @@ export class CategoryShopware { path: { 'navigationId': navigationId, }, - query: { - 'slots': slots, - }, - body: requestBody, - mediaType: 'application/json', - }); - } - - /** - * Fetch a navigation menu - * This endpoint returns categories that can be used as a page navigation. You can either return them as a tree or as a flat list. You can also control the depth of the tree. - * - * Instead of passing uuids, you can also use one of the following aliases for the activeId and rootId parameters to get the respective navigations of your sales channel. - * - * * main-navigation - * * service-navigation - * * footer-navigation - * @param activeId Identifier of the active category in the navigation tree (if not used, just set to the same as rootId). - * @param rootId Identifier of the root category for your desired navigation tree. You can use it to fetch sub-trees of your navigation tree. - * @param requestBody - * @param swIncludeSeoUrls Instructs Shopware to try and resolve SEO URLs for the given navigation item - * @returns NavigationRouteResponse All available navigations - * @throws ApiError - */ - public static readNavigation( - activeId: string, - rootId: string, - requestBody: (Criteria & { - /** - * Determines the depth of fetched navigation levels. - */ - depth?: any; - /** - * Return the categories as a tree or as a flat list. - */ - buildTree?: any; - }), - swIncludeSeoUrls?: boolean, - ): CancelablePromise { - return __request(OpenAPI, { - method: 'POST', - url: '/navigation/{activeId}/{rootId}', - path: { - 'activeId': activeId, - 'rootId': rootId, - }, headers: { 'sw-include-seo-urls': swIncludeSeoUrls, }, + query: { + 'slots': slots, + }, body: requestBody, mediaType: 'application/json', }); } - } diff --git a/src/platforms/shopware/api-client/generated/services/ContentShopware.ts b/src/platforms/shopware/api-client/generated/services/ContentShopware.ts index 60d0189c..adc27852 100644 --- a/src/platforms/shopware/api-client/generated/services/ContentShopware.ts +++ b/src/platforms/shopware/api-client/generated/services/ContentShopware.ts @@ -5,14 +5,37 @@ import type { CmsPage } from '../models/CmsPage'; import type { Criteria } from '../models/Criteria'; import type { LandingPage } from '../models/LandingPage'; +import type { Media } from '../models/Media'; import type { ProductListingCriteria } from '../models/ProductListingCriteria'; - import type { CancelablePromise } from '../core/CancelablePromise'; import { OpenAPI } from '../core/OpenAPI'; import { request as __request } from '../core/request'; - export class ContentShopware { - + /** + * Fetch and resolve Media Entities + * Fetch one or multiple Media Entities with the corresponding Identifier. + * @param requestBody + * @returns Media The loaded MediaCollection containing the requested Media Entities. + * @throws ApiError + */ + public static readMedia( + requestBody?: { + /** + * Identifier (UUID) of the media entity to be fetched. + */ + ids: Array; + }, + ): CancelablePromise> { + return __request(OpenAPI, { + method: 'POST', + url: '/media', + body: requestBody, + mediaType: 'application/json', + errors: { + 404: `Not Found`, + }, + }); + } /** * Fetch and resolve a CMS page * Loads a content management page by its identifier and resolve the slot data. This could be media files, product listing and so on. @@ -47,7 +70,6 @@ export class ContentShopware { }, }); } - /** * Submit a contact form message * Used for submitting contact forms. Be aware that there can be more required fields, depending on the system settings. @@ -111,7 +133,6 @@ export class ContentShopware { mediaType: 'application/json', }); } - /** * Fetch a landing page with the resolved CMS page * Loads a landing page by its identifier and resolves the CMS page. @@ -146,5 +167,4 @@ export class ContentShopware { }, }); } - } diff --git a/src/platforms/shopware/api-client/generated/services/DocumentShopware.ts b/src/platforms/shopware/api-client/generated/services/DocumentShopware.ts index b4829cdf..9cf48137 100644 --- a/src/platforms/shopware/api-client/generated/services/DocumentShopware.ts +++ b/src/platforms/shopware/api-client/generated/services/DocumentShopware.ts @@ -4,13 +4,10 @@ /* eslint-disable */ import type { Criteria } from '../models/Criteria'; import type { Document } from '../models/Document'; - import type { CancelablePromise } from '../core/CancelablePromise'; import { OpenAPI } from '../core/OpenAPI'; import { request as __request } from '../core/request'; - export class DocumentShopware { - /** * Download generated document * Returns blob file of a generated document to download. @@ -36,5 +33,4 @@ export class DocumentShopware { mediaType: 'application/json', }); } - } diff --git a/src/platforms/shopware/api-client/generated/services/EndpointsSupportingCriteriaShopware.ts b/src/platforms/shopware/api-client/generated/services/EndpointsSupportingCriteriaShopware.ts index 50ce44cd..f558f665 100644 --- a/src/platforms/shopware/api-client/generated/services/EndpointsSupportingCriteriaShopware.ts +++ b/src/platforms/shopware/api-client/generated/services/EndpointsSupportingCriteriaShopware.ts @@ -2,6 +2,7 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ +import type { AccountNewsletterRecipientResult } from '../models/AccountNewsletterRecipientResult'; import type { Category } from '../models/Category'; import type { Country } from '../models/Country'; import type { CountryState } from '../models/CountryState'; @@ -14,6 +15,7 @@ import type { EntitySearchResult } from '../models/EntitySearchResult'; import type { LandingPage } from '../models/LandingPage'; import type { Language } from '../models/Language'; import type { NavigationRouteResponse } from '../models/NavigationRouteResponse'; +import type { NavigationType } from '../models/NavigationType'; import type { OrderRouteResponse } from '../models/OrderRouteResponse'; import type { PaymentMethod } from '../models/PaymentMethod'; import type { Product } from '../models/Product'; @@ -23,67 +25,118 @@ import type { Salutation } from '../models/Salutation'; import type { SeoUrl } from '../models/SeoUrl'; import type { ShippingMethod } from '../models/ShippingMethod'; import type { WishlistLoadRouteResponse } from '../models/WishlistLoadRouteResponse'; - import type { CancelablePromise } from '../core/CancelablePromise'; import { OpenAPI } from '../core/OpenAPI'; import { request as __request } from '../core/request'; - export class EndpointsSupportingCriteriaShopware { - /** - * Fetch newsletter recipients - * Perform a filtered search for newsletter recipients. + * Fetch a list of orders + * List orders of a customer. * @param requestBody - * @returns any + * @returns OrderRouteResponse An array of orders and an indicator if the payment of the order can be changed. * @throws ApiError */ - public static readNewsletterRecipient( - requestBody?: Criteria, - ): CancelablePromise { + public static readOrder( + requestBody: (Criteria & { + /** + * Check if the payment method of the order is still changeable. + */ + checkPromotion?: boolean; + }), + ): CancelablePromise { return __request(OpenAPI, { method: 'POST', - url: '/account/newsletter-recipient', + url: '/order', body: requestBody, mediaType: 'application/json', }); } - /** - * Get information about current customer - * Returns information about the current customer. + * Fetch a navigation menu + * This endpoint returns categories that can be used as a page navigation. You can either return them as a tree or as a flat list. You can also control the depth of the tree. + * + * Instead of passing uuids, you can also use one of the following aliases for the activeId and rootId parameters to get the respective navigations of your sales channel. + * + * * main-navigation + * * service-navigation + * * footer-navigation + * @param activeId Identifier of the active category in the navigation tree (if not used, just set to the same as rootId). + * @param rootId Identifier of the root category for your desired navigation tree. You can use it to fetch sub-trees of your navigation tree. * @param requestBody - * @returns Customer Returns the logged in customer, also for guest sessions. Check for the value of `guest` field to see whether the customer is a guest. + * @param swIncludeSeoUrls Instructs Shopware to try and resolve SEO URLs for the given navigation item + * @returns NavigationRouteResponse All available navigations * @throws ApiError */ - public static readCustomer( + public static readNavigation( + activeId: (string | NavigationType), + rootId: (string | NavigationType), + requestBody: (Criteria & { + /** + * Determines the depth of fetched navigation levels. + */ + depth?: number; + /** + * Return the categories as a tree or as a flat list. + */ + buildTree?: Array>; + }), + swIncludeSeoUrls?: boolean, + ): CancelablePromise { + return __request(OpenAPI, { + method: 'POST', + url: '/navigation/{activeId}/{rootId}', + path: { + 'activeId': activeId, + 'rootId': rootId, + }, + headers: { + 'sw-include-seo-urls': swIncludeSeoUrls, + }, + body: requestBody, + mediaType: 'application/json', + }); + } + /** + * Fetch a wishlist + * Fetch a customer's wishlist. Products on the wishlist can be filtered using a criteria object. + * + * **Important constraints** + * + * * Anonymous (not logged-in) customers can not have wishlists. + * * The wishlist feature has to be activated. + * @param requestBody + * @returns WishlistLoadRouteResponse + * @throws ApiError + */ + public static readCustomerWishlist( requestBody?: Criteria, - ): CancelablePromise { + ): CancelablePromise { return __request(OpenAPI, { method: 'POST', - url: '/account/customer', + url: '/customer/wishlist', body: requestBody, mediaType: 'application/json', }); } - /** - * Fetch addresses of a customer - * Lists all addresses of the current customer and allows filtering them based on a criteria. + * Fetch countries + * Perform a filtered search for countries * @param requestBody - * @returns CustomerAddress + * @returns any Entity search result containing countries. * @throws ApiError */ - public static listAddress( + public static readCountry( requestBody?: Criteria, - ): CancelablePromise> { + ): CancelablePromise<({ + elements?: Array; + } & EntitySearchResult)> { return __request(OpenAPI, { method: 'POST', - url: '/account/list-address', + url: '/country', body: requestBody, mediaType: 'application/json', }); } - /** * Fetch a list of categories * Perform a filtered search for categories. @@ -103,11 +156,11 @@ export class EndpointsSupportingCriteriaShopware { mediaType: 'application/json', }); } - /** * Fetch a single category * This endpoint returns information about the category, as well as a fully resolved (hydrated with mapping values) CMS page, if one is assigned to the category. You can pass slots which should be resolved exclusively. * @param navigationId Identifier of the category to be fetched + * @param swIncludeSeoUrls Instructs Shopware to try and resolve SEO URLs for the given navigation item * @param slots Resolves only the given slot identifiers. The identifiers have to be seperated by a '|' character * @param requestBody * @returns Category The loaded category with cms page @@ -115,6 +168,7 @@ export class EndpointsSupportingCriteriaShopware { */ public static readCategory( navigationId: string, + swIncludeSeoUrls?: boolean, slots?: string, requestBody?: (Criteria & ProductListingCriteria), ): CancelablePromise { @@ -124,6 +178,9 @@ export class EndpointsSupportingCriteriaShopware { path: { 'navigationId': navigationId, }, + headers: { + 'sw-include-seo-urls': swIncludeSeoUrls, + }, query: { 'slots': slots, }, @@ -131,280 +188,222 @@ export class EndpointsSupportingCriteriaShopware { mediaType: 'application/json', }); } - /** - * Fetch the states of a country - * Perform a filtered search the states for a country - * @param countryId + * Fetch a landing page with the resolved CMS page + * Loads a landing page by its identifier and resolves the CMS page. + * + * **Important notice** + * + * The criteria passed with this route also affects the listing, if there is one within the cms page. + * @param landingPageId Identifier of the landing page. * @param requestBody - * @returns any Entity search result containing countries. + * @returns LandingPage The loaded landing page with cms page * @throws ApiError */ - public static readCountryState( - countryId: string, - requestBody?: Criteria, - ): CancelablePromise<({ - elements?: Array; - } & EntitySearchResult)> { + public static readLandingPage( + landingPageId: string, + requestBody?: (Criteria & ({ + /** + * Resolves only the given slot identifiers. The identifiers have to be seperated by a `|` character. + */ + slots?: string; + } & ProductListingCriteria)), + ): CancelablePromise { return __request(OpenAPI, { method: 'POST', - url: '/country-state/{countryId}', + url: '/landing-page/{landingPageId}', path: { - 'countryId': countryId, + 'landingPageId': landingPageId, }, body: requestBody, mediaType: 'application/json', + errors: { + 404: `Not Found`, + }, }); } - /** - * Fetch countries - * Perform a filtered search for countries + * Fetch newsletter recipients + * Perform a filtered search for newsletter recipients. * @param requestBody - * @returns any Entity search result containing countries. + * @returns AccountNewsletterRecipientResult * @throws ApiError */ - public static readCountry( + public static readNewsletterRecipient( requestBody?: Criteria, - ): CancelablePromise<({ - elements?: Array; - } & EntitySearchResult)> { + ): CancelablePromise> { return __request(OpenAPI, { method: 'POST', - url: '/country', + url: '/account/newsletter-recipient', body: requestBody, mediaType: 'application/json', }); } - /** - * Fetch currencies - * Perform a filtered search for currencies. + * Get information about current customer + * Returns information about the current customer. * @param requestBody - * @returns any Entity search result containing currencies. + * @returns Customer Returns the logged in customer, also for guest sessions. Check for the value of `guest` field to see whether the customer is a guest. * @throws ApiError */ - public static readCurrency( + public static readCustomer( requestBody?: Criteria, - ): CancelablePromise<({ - elements?: Array; - } & EntitySearchResult)> { + ): CancelablePromise { return __request(OpenAPI, { method: 'POST', - url: '/currency', + url: '/account/customer', body: requestBody, mediaType: 'application/json', }); } - /** - * Fetch a wishlist - * Fetch a customer's wishlist. Products on the wishlist can be filtered using a criteria object. - * - * **Important constraints** - * - * * Anonymous (not logged-in) customers can not have wishlists. - * * The wishlist feature has to be activated. + * Fetch addresses of a customer + * Lists all addresses of the current customer and allows filtering them based on a criteria. * @param requestBody - * @returns WishlistLoadRouteResponse + * @returns CustomerAddress * @throws ApiError */ - public static readCustomerWishlist( + public static listAddress( requestBody?: Criteria, - ): CancelablePromise { + ): CancelablePromise> { return __request(OpenAPI, { method: 'POST', - url: '/customer/wishlist', + url: '/account/list-address', body: requestBody, mediaType: 'application/json', }); } - /** - * Download generated document - * Returns blob file of a generated document to download. - * @param documentId - * @param deepLinkCode + * Fetch SEO routes + * Perform a filtered search for seo urls. * @param requestBody - * @returns Document Returns the document information and blob to download. + * @returns any Entity search result containing seo urls. * @throws ApiError */ - public static download( - documentId: string, - deepLinkCode: string, + public static readSeoUrl( requestBody?: Criteria, - ): CancelablePromise { + ): CancelablePromise<({ + elements: Array; + } & EntitySearchResult)> { return __request(OpenAPI, { method: 'POST', - url: '/document/download/{documentId}/{deepLinkCode}', - path: { - 'documentId': documentId, - 'deepLinkCode': deepLinkCode, - }, + url: '/seo-url', body: requestBody, mediaType: 'application/json', + errors: { + 404: `Not Found`, + }, }); } - /** - * Fetch a landing page with the resolved CMS page - * Loads a landing page by its identifier and resolves the CMS page. - * - * **Important notice** - * - * The criteria passed with this route also affects the listing, if there is one within the cms page. - * @param landingPageId Identifier of the landing page. + * Fetch languages + * Perform a filtered search for languages. * @param requestBody - * @returns LandingPage The loaded landing page with cms page + * @returns any Entity search result containing languages. * @throws ApiError */ - public static readLandingPage( - landingPageId: string, - requestBody?: (Criteria & ({ - /** - * Resolves only the given slot identifiers. The identifiers have to be seperated by a `|` character. - */ - slots?: string; - } & ProductListingCriteria)), - ): CancelablePromise { + public static readLanguages( + requestBody?: Criteria, + ): CancelablePromise<({ + elements: Array; + } & EntitySearchResult)> { return __request(OpenAPI, { method: 'POST', - url: '/landing-page/{landingPageId}', - path: { - 'landingPageId': landingPageId, - }, + url: '/language', body: requestBody, mediaType: 'application/json', - errors: { - 404: `Not Found`, - }, }); } - /** - * Fetch languages - * Perform a filtered search for languages. + * Fetch currencies + * Perform a filtered search for currencies. * @param requestBody - * @returns any Entity search result containing languages. + * @returns any Entity search result containing currencies. * @throws ApiError */ - public static readLanguages( + public static readCurrency( requestBody?: Criteria, ): CancelablePromise<({ - elements?: Array; + elements?: Array; } & EntitySearchResult)> { return __request(OpenAPI, { method: 'POST', - url: '/language', + url: '/currency', body: requestBody, mediaType: 'application/json', }); } - /** - * Fetch a navigation menu - * This endpoint returns categories that can be used as a page navigation. You can either return them as a tree or as a flat list. You can also control the depth of the tree. - * - * Instead of passing uuids, you can also use one of the following aliases for the activeId and rootId parameters to get the respective navigations of your sales channel. - * - * * main-navigation - * * service-navigation - * * footer-navigation - * @param activeId Identifier of the active category in the navigation tree (if not used, just set to the same as rootId). - * @param rootId Identifier of the root category for your desired navigation tree. You can use it to fetch sub-trees of your navigation tree. + * Download generated document + * Returns blob file of a generated document to download. + * @param documentId + * @param deepLinkCode * @param requestBody - * @param swIncludeSeoUrls Instructs Shopware to try and resolve SEO URLs for the given navigation item - * @returns NavigationRouteResponse All available navigations + * @returns Document Returns the document information and blob to download. * @throws ApiError */ - public static readNavigation( - activeId: string, - rootId: string, - requestBody: (Criteria & { - /** - * Determines the depth of fetched navigation levels. - */ - depth?: any; - /** - * Return the categories as a tree or as a flat list. - */ - buildTree?: any; - }), - swIncludeSeoUrls?: boolean, - ): CancelablePromise { + public static download( + documentId: string, + deepLinkCode: string, + requestBody?: Criteria, + ): CancelablePromise { return __request(OpenAPI, { method: 'POST', - url: '/navigation/{activeId}/{rootId}', + url: '/document/download/{documentId}/{deepLinkCode}', path: { - 'activeId': activeId, - 'rootId': rootId, - }, - headers: { - 'sw-include-seo-urls': swIncludeSeoUrls, + 'documentId': documentId, + 'deepLinkCode': deepLinkCode, }, body: requestBody, mediaType: 'application/json', }); } - /** - * Fetch a list of orders - * List orders of a customer. + * Fetch salutations + * Perform a filtered search for salutations. * @param requestBody - * @returns OrderRouteResponse An array of orders and an indicator if the payment of the order can be changed. + * @returns any Entity search result containing salutations. * @throws ApiError */ - public static readOrder( - requestBody: (Criteria & { - /** - * Check if the payment method of the order is still changeable. - */ - checkPromotion?: boolean; - }), - ): CancelablePromise { + public static readSalutation( + requestBody?: Criteria, + ): CancelablePromise<({ + elements?: Array; + } & EntitySearchResult)> { return __request(OpenAPI, { method: 'POST', - url: '/order', + url: '/salutation', body: requestBody, mediaType: 'application/json', }); } - /** - * Loads all available payment methods + * Fetch the states of a country + * Perform a filtered search the states for a country + * @param countryId * @param requestBody - * @returns any + * @returns any Entity search result containing countries. * @throws ApiError */ - public static readPaymentMethod( - requestBody: (Criteria & { - /** - * List only available - */ - onlyAvailable?: boolean; - }), - ): CancelablePromise<{ - /** - * Total amount - */ - total?: number; - /** - * aggregation result - */ - aggregations?: Record; - elements?: Array; - }> { + public static readCountryState( + countryId: string, + requestBody?: Criteria, + ): CancelablePromise<({ + elements?: Array; + } & EntitySearchResult)> { return __request(OpenAPI, { method: 'POST', - url: '/payment-method', + url: '/country-state/{countryId}', + path: { + 'countryId': countryId, + }, body: requestBody, mediaType: 'application/json', }); } - /** * Fetch a list of products - * List products that match the given criteria. For performance ressons a limit should always be set. + * List products that match the given criteria. For performance reasons a limit should always be set. * @param requestBody * @returns any Entity search result containing products * @throws ApiError @@ -421,7 +420,6 @@ export class EndpointsSupportingCriteriaShopware { mediaType: 'application/json', }); } - /** * Fetch product reviews * Perform a filtered search for product reviews. @@ -446,50 +444,37 @@ export class EndpointsSupportingCriteriaShopware { mediaType: 'application/json', }); } - /** - * Fetch salutations - * Perform a filtered search for salutations. - * @param requestBody - * @returns any Entity search result containing salutations. - * @throws ApiError - */ - public static readSalutation( - requestBody?: Criteria, - ): CancelablePromise<({ - elements?: Array; - } & EntitySearchResult)> { - return __request(OpenAPI, { - method: 'POST', - url: '/salutation', - body: requestBody, - mediaType: 'application/json', - }); - } - - /** - * Fetch SEO routes - * Perform a filtered search for seo urls. + * Loads all available payment methods * @param requestBody - * @returns any Entity search result containing seo urls. + * @returns any * @throws ApiError */ - public static readSeoUrl( - requestBody?: Criteria, - ): CancelablePromise<({ - elements?: Array; - } & EntitySearchResult)> { + public static readPaymentMethod( + requestBody: (Criteria & { + /** + * List only available + */ + onlyAvailable?: boolean; + }), + ): CancelablePromise<{ + /** + * Total amount + */ + total?: number; + /** + * aggregation result + */ + aggregations?: Record; + elements?: Array; + }> { return __request(OpenAPI, { method: 'POST', - url: '/seo-url', + url: '/payment-method', body: requestBody, mediaType: 'application/json', - errors: { - 404: `Not Found`, - }, }); } - /** * Fetch shipping methods * Perform a filtered search for shipping methods. @@ -522,5 +507,4 @@ export class EndpointsSupportingCriteriaShopware { mediaType: 'application/json', }); } - } diff --git a/src/platforms/shopware/api-client/generated/services/LoginRegistrationShopware.ts b/src/platforms/shopware/api-client/generated/services/LoginRegistrationShopware.ts index 82438596..ebf621d0 100644 --- a/src/platforms/shopware/api-client/generated/services/LoginRegistrationShopware.ts +++ b/src/platforms/shopware/api-client/generated/services/LoginRegistrationShopware.ts @@ -5,13 +5,10 @@ import type { Customer } from '../models/Customer'; import type { CustomerAddress } from '../models/CustomerAddress'; import type { CustomerGroup } from '../models/CustomerGroup'; - import type { CancelablePromise } from '../core/CancelablePromise'; import { OpenAPI } from '../core/OpenAPI'; import { request as __request } from '../core/request'; - export class LoginRegistrationShopware { - /** * Log in a customer * Logs in customers given their credentials. @@ -41,7 +38,6 @@ export class LoginRegistrationShopware { }, }); } - /** * Log out a customer * Logs out a customer. @@ -57,7 +53,6 @@ export class LoginRegistrationShopware { }, }); } - /** * Confirm a customer registration * Confirms a customer registration when double opt-in is activated. @@ -90,7 +85,6 @@ export class LoginRegistrationShopware { }, }); } - /** * Register a customer * Registers a customer. Used both for normal customers and guest customers.See the Guide "Register a customer" for more information on customer registration. @@ -171,7 +165,6 @@ export class LoginRegistrationShopware { mediaType: 'application/json', }); } - /** * Fetch registration settings for customer group * @param customerGroupId Customer group id @@ -189,5 +182,4 @@ export class LoginRegistrationShopware { }, }); } - } diff --git a/src/platforms/shopware/api-client/generated/services/NewsletterShopware.ts b/src/platforms/shopware/api-client/generated/services/NewsletterShopware.ts index 5ef0e3f1..a89bcbed 100644 --- a/src/platforms/shopware/api-client/generated/services/NewsletterShopware.ts +++ b/src/platforms/shopware/api-client/generated/services/NewsletterShopware.ts @@ -2,24 +2,22 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ +import type { AccountNewsletterRecipientResult } from '../models/AccountNewsletterRecipientResult'; import type { Criteria } from '../models/Criteria'; - import type { CancelablePromise } from '../core/CancelablePromise'; import { OpenAPI } from '../core/OpenAPI'; import { request as __request } from '../core/request'; - export class NewsletterShopware { - /** * Fetch newsletter recipients * Perform a filtered search for newsletter recipients. * @param requestBody - * @returns any + * @returns AccountNewsletterRecipientResult * @throws ApiError */ public static readNewsletterRecipient( requestBody?: Criteria, - ): CancelablePromise { + ): CancelablePromise> { return __request(OpenAPI, { method: 'POST', url: '/account/newsletter-recipient', @@ -27,7 +25,6 @@ export class NewsletterShopware { mediaType: 'application/json', }); } - /** * Confirm a newsletter registration * You have to use the hash from the link sent out via email to confirm the user registration. @@ -54,7 +51,6 @@ export class NewsletterShopware { mediaType: 'application/json', }); } - /** * Create or remove a newsletter subscription * This route is used to create/remove/confirm a newsletter subscription. @@ -78,7 +74,7 @@ export class NewsletterShopware { /** * Defines what should be done. */ - option: any; + option: string; /** * Url of the storefront of the shop. This will be used for generating the link to the /newsletter/confirm inside the confirm email. */ @@ -86,7 +82,7 @@ export class NewsletterShopware { /** * Identifier of the salutation. */ - salutationId?: any; + salutationId?: string; /** * First name */ @@ -114,7 +110,7 @@ export class NewsletterShopware { /** * Identifier of the language. */ - languageId?: any; + languageId?: string; /** * Custom field data that should be added to the subscription. */ @@ -128,7 +124,6 @@ export class NewsletterShopware { mediaType: 'application/json', }); } - /** * Remove a newsletter subscription * Removes a newsletter recipient from the mailing lists. @@ -151,5 +146,4 @@ export class NewsletterShopware { mediaType: 'application/json', }); } - } diff --git a/src/platforms/shopware/api-client/generated/services/OrderShopware.ts b/src/platforms/shopware/api-client/generated/services/OrderShopware.ts index ed64217d..d68f1e77 100644 --- a/src/platforms/shopware/api-client/generated/services/OrderShopware.ts +++ b/src/platforms/shopware/api-client/generated/services/OrderShopware.ts @@ -7,46 +7,10 @@ import type { Order } from '../models/Order'; import type { OrderRouteResponse } from '../models/OrderRouteResponse'; import type { StateMachineState } from '../models/StateMachineState'; import type { SuccessResponse } from '../models/SuccessResponse'; - import type { CancelablePromise } from '../core/CancelablePromise'; import { OpenAPI } from '../core/OpenAPI'; import { request as __request } from '../core/request'; - export class OrderShopware { - - /** - * Create an order from a cart - * Creates a new order from the current cart and deletes the cart. - * - * If you are using the [prepared payment flow](https://developer.shopware.com/docs/concepts/commerce/checkout-concept/payments#2.1-prepare-payment-optional), this endpoint also receives additional transaction details. The exact name of the parameters depends on the implementation of the corresponding *payment handler*. - * @param requestBody Contains additional metadata which is stored together with the order. It can also contain payment transaction details. - * @returns Order Order - * @throws ApiError - */ - public static createOrder( - requestBody?: { - /** - * Adds a comment from the customer to the order. - */ - customerComment?: string; - /** - * The affiliate code can be used to track which referrer the customer came through. An example could be `Price-comparison-company-XY`. - */ - affiliateCode?: string; - /** - * The campaign code is used to track which action the customer came from. An example could be `Summer-Deals` - */ - campaignCode?: string; - }, - ): CancelablePromise { - return __request(OpenAPI, { - method: 'POST', - url: '/checkout/order', - body: requestBody, - mediaType: 'application/json', - }); - } - /** * Cancel an order * Cancels an order. The order state will be set to 'cancelled'. @@ -61,7 +25,7 @@ export class OrderShopware { /** * The identifier of the order to be canceled. */ - orderId?: string; + orderId: string; }, ): CancelablePromise { return __request(OpenAPI, { @@ -71,7 +35,6 @@ export class OrderShopware { mediaType: 'application/json', }); } - /** * Fetch a list of orders * List orders of a customer. @@ -94,7 +57,6 @@ export class OrderShopware { mediaType: 'application/json', }); } - /** * Update the payment method of an order * Changes the payment method of a specific order. You can use the /order route to find out if the payment method of an order can be changed - take a look at the `paymentChangeable`- array in the response. @@ -121,7 +83,6 @@ export class OrderShopware { mediaType: 'application/json', }); } - /** * Download a purchased file * Download a file included in the given order and with the given id. Access must be granted. @@ -143,5 +104,36 @@ export class OrderShopware { }, }); } - + /** + * Create an order from a cart + * Creates a new order from the current cart and deletes the cart. + * + * If you are using the [prepared payment flow](https://developer.shopware.com/docs/concepts/commerce/checkout-concept/payments#2.1-prepare-payment-optional), this endpoint also receives additional transaction details. The exact name of the parameters depends on the implementation of the corresponding *payment handler*. + * @param requestBody Contains additional metadata which is stored together with the order. It can also contain payment transaction details. + * @returns Order Order + * @throws ApiError + */ + public static createOrder( + requestBody?: { + /** + * Adds a comment from the customer to the order. + */ + customerComment?: string; + /** + * The affiliate code can be used to track which referrer the customer came through. An example could be `Price-comparison-company-XY`. + */ + affiliateCode?: string; + /** + * The campaign code is used to track which action the customer came from. An example could be `Summer-Deals` + */ + campaignCode?: string; + }, + ): CancelablePromise { + return __request(OpenAPI, { + method: 'POST', + url: '/checkout/order', + body: requestBody, + mediaType: 'application/json', + }); + } } diff --git a/src/platforms/shopware/api-client/generated/services/PaymentMethodShopware.ts b/src/platforms/shopware/api-client/generated/services/PaymentMethodShopware.ts index 6d41b6f2..33b1791d 100644 --- a/src/platforms/shopware/api-client/generated/services/PaymentMethodShopware.ts +++ b/src/platforms/shopware/api-client/generated/services/PaymentMethodShopware.ts @@ -4,13 +4,10 @@ /* eslint-disable */ import type { Criteria } from '../models/Criteria'; import type { PaymentMethod } from '../models/PaymentMethod'; - import type { CancelablePromise } from '../core/CancelablePromise'; import { OpenAPI } from '../core/OpenAPI'; import { request as __request } from '../core/request'; - export class PaymentMethodShopware { - /** * Loads all available payment methods * @param requestBody @@ -42,5 +39,4 @@ export class PaymentMethodShopware { mediaType: 'application/json', }); } - } diff --git a/src/platforms/shopware/api-client/generated/services/PaymentShippingShopware.ts b/src/platforms/shopware/api-client/generated/services/PaymentShippingShopware.ts index ebdcc621..694ac060 100644 --- a/src/platforms/shopware/api-client/generated/services/PaymentShippingShopware.ts +++ b/src/platforms/shopware/api-client/generated/services/PaymentShippingShopware.ts @@ -4,13 +4,10 @@ /* eslint-disable */ import type { Criteria } from '../models/Criteria'; import type { ShippingMethod } from '../models/ShippingMethod'; - import type { CancelablePromise } from '../core/CancelablePromise'; import { OpenAPI } from '../core/OpenAPI'; import { request as __request } from '../core/request'; - export class PaymentShippingShopware { - /** * Initiate a payment for an order * This generic endpoint is should be called to initiate a payment flow after an order has been created. The details of the payment flow can differ depending on the payment integration and might require calling additional operations or the setup of webhooks. @@ -35,7 +32,7 @@ export class PaymentShippingShopware { */ errorUrl?: string; }, - ): CancelablePromise { + ): CancelablePromise> { return __request(OpenAPI, { method: 'POST', url: '/handle-payment', @@ -43,7 +40,6 @@ export class PaymentShippingShopware { mediaType: 'application/json', }); } - /** * Fetch shipping methods * Perform a filtered search for shipping methods. @@ -76,5 +72,4 @@ export class PaymentShippingShopware { mediaType: 'application/json', }); } - } diff --git a/src/platforms/shopware/api-client/generated/services/ProductShopware.ts b/src/platforms/shopware/api-client/generated/services/ProductShopware.ts index 5f7d503f..5d5cc6b7 100644 --- a/src/platforms/shopware/api-client/generated/services/ProductShopware.ts +++ b/src/platforms/shopware/api-client/generated/services/ProductShopware.ts @@ -12,13 +12,10 @@ import type { ProductListingCriteria } from '../models/ProductListingCriteria'; import type { ProductListingFlags } from '../models/ProductListingFlags'; import type { ProductListingResult } from '../models/ProductListingResult'; import type { ProductReview } from '../models/ProductReview'; - import type { CancelablePromise } from '../core/CancelablePromise'; import { OpenAPI } from '../core/OpenAPI'; import { request as __request } from '../core/request'; - export class ProductShopware { - /** * Export product export * @param accessKey Access Key @@ -39,17 +36,18 @@ export class ProductShopware { }, }); } - /** * Fetch a product listing by category * Fetches a product listing for a specific category. It also provides filters, sortings and property aggregations, analogous to the /search endpoint. * @param categoryId Identifier of a category. + * @param swIncludeSeoUrls Determines if the response must contain a SeoUrl entity for a product entity * @param requestBody * @returns ProductListingResult Returns a product listing containing all products and additional fields to display a listing. * @throws ApiError */ public static readProductListing( categoryId: string, + swIncludeSeoUrls?: boolean, requestBody?: (ProductListingCriteria & ProductListingFlags), ): CancelablePromise { return __request(OpenAPI, { @@ -58,11 +56,59 @@ export class ProductShopware { path: { 'categoryId': categoryId, }, + headers: { + 'sw-include-seo-urls': swIncludeSeoUrls, + }, + body: requestBody, + mediaType: 'application/json', + }); + } + /** + * Search for products + * Performs a search for products which can be used to display a product listing. + * @param requestBody + * @returns ProductListingResult Returns a product listing containing all products and additional fields to display a listing. + * @throws ApiError + */ + public static searchPage( + requestBody?: ({ + /** + * Using the search parameter, the server performs a text search on all records based on their data model and weighting as defined in the entity definition using the SearchRanking flag. + */ + search: string; + } & ProductListingCriteria & ProductListingFlags), + ): CancelablePromise { + return __request(OpenAPI, { + method: 'POST', + url: '/search', + body: requestBody, + mediaType: 'application/json', + }); + } + /** + * Search for products (suggest) + * Can be used to implement search previews or suggestion listings, that don’t require any interaction. + * @param requestBody + * @returns ProductListingResult Returns a product listing containing all products and additional fields. + * + * Note: Aggregations, currentFilters and availableSortings are empty in this response. If you need them to display a listing, use the /search route instead. + * @throws ApiError + */ + public static searchSuggest( + requestBody: ({ + /** + * Using the search parameter, the server performs a text search on all records based on their data model and weighting as defined in the entity definition using the SearchRanking flag. + */ + search: string; + } & ProductListingFlags), + ): CancelablePromise { + return __request(OpenAPI, { + method: 'POST', + url: '/search-suggest', body: requestBody, mediaType: 'application/json', }); } - /** * Fetch cross-selling groups of a product * This route is used to load the cross sellings for a product. A product has several cross selling definitions in which several products are linked. The route returns the cross sellings together with the linked products @@ -81,16 +127,17 @@ export class ProductShopware { }, }); } - /** * Fetch a single product * This route is used to load a single product with the corresponding details. In addition to loading the data, the best variant of the product is determined when a parent id is passed. * @param productId Product ID + * @param requestBody * @returns ProductDetailResponse Product information along with variant groups and options * @throws ApiError */ public static readProductDetail( productId: string, + requestBody?: Criteria, ): CancelablePromise { return __request(OpenAPI, { method: 'POST', @@ -98,12 +145,13 @@ export class ProductShopware { path: { 'productId': productId, }, + body: requestBody, + mediaType: 'application/json', }); } - /** * Fetch a list of products - * List products that match the given criteria. For performance ressons a limit should always be set. + * List products that match the given criteria. For performance reasons a limit should always be set. * @param requestBody * @returns any Entity search result containing products * @throws ApiError @@ -120,7 +168,6 @@ export class ProductShopware { mediaType: 'application/json', }); } - /** * Fetch product reviews * Perform a filtered search for product reviews. @@ -145,7 +192,6 @@ export class ProductShopware { mediaType: 'application/json', }); } - /** * Save a product review * Saves a review for a product. Reviews have to be activated in the settings. @@ -168,15 +214,15 @@ export class ProductShopware { /** * The title of the review. */ - title: any; + title: string; /** * The content of review. */ - content: any; + content: string; /** * The review rating for the product. */ - points: any; + points: number; }, ): CancelablePromise { return __request(OpenAPI, { @@ -189,7 +235,6 @@ export class ProductShopware { mediaType: 'application/json', }); } - /** * Search for a matching variant by product options. * Performs a search for product variants and returns the best matching variant. @@ -221,53 +266,4 @@ export class ProductShopware { mediaType: 'application/json', }); } - - /** - * Search for products (suggest) - * Can be used to implement search previews or suggestion listings, that don’t require any interaction. - * @param requestBody - * @returns ProductListingResult Returns a product listing containing all products and additional fields. - * - * Note: Aggregations, currentFilters and availableSortings are empty in this response. If you need them to display a listing, use the /search route instead. - * @throws ApiError - */ - public static searchSuggest( - requestBody: ({ - /** - * Using the search parameter, the server performs a text search on all records based on their data model and weighting as defined in the entity definition using the SearchRanking flag. - */ - search: string; - } & ProductListingFlags), - ): CancelablePromise { - return __request(OpenAPI, { - method: 'POST', - url: '/search-suggest', - body: requestBody, - mediaType: 'application/json', - }); - } - - /** - * Search for products - * Performs a search for products which can be used to display a product listing. - * @param requestBody - * @returns ProductListingResult Returns a product listing containing all products and additional fields to display a listing. - * @throws ApiError - */ - public static searchPage( - requestBody?: ({ - /** - * Using the search parameter, the server performs a text search on all records based on their data model and weighting as defined in the entity definition using the SearchRanking flag. - */ - search: string; - } & ProductListingCriteria & ProductListingFlags), - ): CancelablePromise { - return __request(OpenAPI, { - method: 'POST', - url: '/search', - body: requestBody, - mediaType: 'application/json', - }); - } - } diff --git a/src/platforms/shopware/api-client/generated/services/ProfileShopware.ts b/src/platforms/shopware/api-client/generated/services/ProfileShopware.ts index 2c58e7b6..11918bea 100644 --- a/src/platforms/shopware/api-client/generated/services/ProfileShopware.ts +++ b/src/platforms/shopware/api-client/generated/services/ProfileShopware.ts @@ -2,27 +2,25 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ +import type { AccountNewsletterRecipientResult } from '../models/AccountNewsletterRecipientResult'; import type { Criteria } from '../models/Criteria'; import type { Customer } from '../models/Customer'; import type { Struct } from '../models/Struct'; import type { SuccessResponse } from '../models/SuccessResponse'; - import type { CancelablePromise } from '../core/CancelablePromise'; import { OpenAPI } from '../core/OpenAPI'; import { request as __request } from '../core/request'; - export class ProfileShopware { - /** * Fetch newsletter recipients * Perform a filtered search for newsletter recipients. * @param requestBody - * @returns any + * @returns AccountNewsletterRecipientResult * @throws ApiError */ public static readNewsletterRecipient( requestBody?: Criteria, - ): CancelablePromise { + ): CancelablePromise> { return __request(OpenAPI, { method: 'POST', url: '/account/newsletter-recipient', @@ -30,7 +28,6 @@ export class ProfileShopware { mediaType: 'application/json', }); } - /** * Change the customer's information * Make changes to a customer's account, like changing their name, salutation or title. @@ -81,7 +78,6 @@ export class ProfileShopware { mediaType: 'application/json', }); } - /** * Change the customer's email address * Changes a customer's email address to a new email address, using their current password as a validation. @@ -112,7 +108,6 @@ export class ProfileShopware { mediaType: 'application/json', }); } - /** * Change the customer's language. * Changes the language of the logged in customer @@ -135,7 +130,6 @@ export class ProfileShopware { mediaType: 'application/json', }); } - /** * Change the customer's password * Changes a customer's password using their current password as a validation. @@ -166,7 +160,6 @@ export class ProfileShopware { mediaType: 'application/json', }); } - /** * Change the customer's default payment method * Changes a customer's default (preselected) payment method. @@ -185,7 +178,6 @@ export class ProfileShopware { }, }); } - /** * Checks if the customer recovery entry for a given hash is expired. * This can be used to validate a provided hash has a valid and not expired customer recovery hash. @@ -208,7 +200,6 @@ export class ProfileShopware { mediaType: 'application/json', }); } - /** * Get information about current customer * Returns information about the current customer. @@ -226,7 +217,6 @@ export class ProfileShopware { mediaType: 'application/json', }); } - /** * Delete the customer's profile * Deletes a customer profile along with their addresses, wishlists and associated data. Created orders and their payment/shipping information (addresses) and reviews are not deleted. @@ -239,7 +229,6 @@ export class ProfileShopware { url: '/account/customer', }); } - /** * Reset a password with recovery credentials * This operation is Step 2 of the password reset flow. It is required to conduct Step 1 "Send a password recovery mail" in order to obtain the required credentials for this step.Resets a customer's password using credentials from a password recovery mail as a validation. @@ -270,7 +259,6 @@ export class ProfileShopware { mediaType: 'application/json', }); } - /** * Send a password recovery mail * This operation is Step 1 of the password reset flow. Make sure to implement Step 2 "Reset password with recovery credentials" in order to allow for the complete flow in your application. Sends a recovery mail containing a link with credentials that allows a customer to reset their password. @@ -299,5 +287,4 @@ export class ProfileShopware { mediaType: 'application/json', }); } - } diff --git a/src/platforms/shopware/api-client/generated/services/ScriptShopware.ts b/src/platforms/shopware/api-client/generated/services/ScriptShopware.ts index ce1a0cc1..4a923972 100644 --- a/src/platforms/shopware/api-client/generated/services/ScriptShopware.ts +++ b/src/platforms/shopware/api-client/generated/services/ScriptShopware.ts @@ -5,9 +5,7 @@ import type { CancelablePromise } from '../core/CancelablePromise'; import { OpenAPI } from '../core/OpenAPI'; import { request as __request } from '../core/request'; - export class ScriptShopware { - /** * Access point for different api logics which are provided by apps over script hooks * @param hook Dynamic hook which used to build the hook name @@ -25,5 +23,4 @@ export class ScriptShopware { }, }); } - } diff --git a/src/platforms/shopware/api-client/generated/services/SitemapRoutesShopware.ts b/src/platforms/shopware/api-client/generated/services/SitemapRoutesShopware.ts index 517eb18a..76ea33a0 100644 --- a/src/platforms/shopware/api-client/generated/services/SitemapRoutesShopware.ts +++ b/src/platforms/shopware/api-client/generated/services/SitemapRoutesShopware.ts @@ -6,13 +6,10 @@ import type { Criteria } from '../models/Criteria'; import type { EntitySearchResult } from '../models/EntitySearchResult'; import type { SeoUrl } from '../models/SeoUrl'; import type { Sitemap } from '../models/Sitemap'; - import type { CancelablePromise } from '../core/CancelablePromise'; import { OpenAPI } from '../core/OpenAPI'; import { request as __request } from '../core/request'; - export class SitemapRoutesShopware { - /** * Fetch SEO routes * Perform a filtered search for seo urls. @@ -23,7 +20,7 @@ export class SitemapRoutesShopware { public static readSeoUrl( requestBody?: Criteria, ): CancelablePromise<({ - elements?: Array; + elements: Array; } & EntitySearchResult)> { return __request(OpenAPI, { method: 'POST', @@ -35,7 +32,6 @@ export class SitemapRoutesShopware { }, }); } - /** * Fetch sitemaps * Fetches a list of compressed sitemap files, which are often used by search engines. @@ -48,5 +44,4 @@ export class SitemapRoutesShopware { url: '/sitemap', }); } - } diff --git a/src/platforms/shopware/api-client/generated/services/SystemContextShopware.ts b/src/platforms/shopware/api-client/generated/services/SystemContextShopware.ts index 63418f7e..823d097f 100644 --- a/src/platforms/shopware/api-client/generated/services/SystemContextShopware.ts +++ b/src/platforms/shopware/api-client/generated/services/SystemContextShopware.ts @@ -10,13 +10,48 @@ import type { EntitySearchResult } from '../models/EntitySearchResult'; import type { Language } from '../models/Language'; import type { SalesChannelContext } from '../models/SalesChannelContext'; import type { Salutation } from '../models/Salutation'; - import type { CancelablePromise } from '../core/CancelablePromise'; import { OpenAPI } from '../core/OpenAPI'; import { request as __request } from '../core/request'; - export class SystemContextShopware { - + /** + * Fetch countries + * Perform a filtered search for countries + * @param requestBody + * @returns any Entity search result containing countries. + * @throws ApiError + */ + public static readCountry( + requestBody?: Criteria, + ): CancelablePromise<({ + elements?: Array; + } & EntitySearchResult)> { + return __request(OpenAPI, { + method: 'POST', + url: '/country', + body: requestBody, + mediaType: 'application/json', + }); + } + /** + * Fetch languages + * Perform a filtered search for languages. + * @param requestBody + * @returns any Entity search result containing languages. + * @throws ApiError + */ + public static readLanguages( + requestBody?: Criteria, + ): CancelablePromise<({ + elements: Array; + } & EntitySearchResult)> { + return __request(OpenAPI, { + method: 'POST', + url: '/language', + body: requestBody, + mediaType: 'application/json', + }); + } /** * Fetch the current context * Fetches the current context. This includes for example the `customerGroup`, `currency`, `taxRules` and many more. @@ -29,7 +64,6 @@ export class SystemContextShopware { url: '/context', }); } - /** * Modify the current context * Used for switching the context. A typical example would be changing the language or changing the currency. @@ -80,52 +114,6 @@ export class SystemContextShopware { mediaType: 'application/json', }); } - - /** - * Fetch the states of a country - * Perform a filtered search the states for a country - * @param countryId - * @param requestBody - * @returns any Entity search result containing countries. - * @throws ApiError - */ - public static readCountryState( - countryId: string, - requestBody?: Criteria, - ): CancelablePromise<({ - elements?: Array; - } & EntitySearchResult)> { - return __request(OpenAPI, { - method: 'POST', - url: '/country-state/{countryId}', - path: { - 'countryId': countryId, - }, - body: requestBody, - mediaType: 'application/json', - }); - } - - /** - * Fetch countries - * Perform a filtered search for countries - * @param requestBody - * @returns any Entity search result containing countries. - * @throws ApiError - */ - public static readCountry( - requestBody?: Criteria, - ): CancelablePromise<({ - elements?: Array; - } & EntitySearchResult)> { - return __request(OpenAPI, { - method: 'POST', - url: '/country', - body: requestBody, - mediaType: 'application/json', - }); - } - /** * Fetch currencies * Perform a filtered search for currencies. @@ -145,45 +133,47 @@ export class SystemContextShopware { mediaType: 'application/json', }); } - /** - * Fetch languages - * Perform a filtered search for languages. + * Fetch salutations + * Perform a filtered search for salutations. * @param requestBody - * @returns any Entity search result containing languages. + * @returns any Entity search result containing salutations. * @throws ApiError */ - public static readLanguages( + public static readSalutation( requestBody?: Criteria, ): CancelablePromise<({ - elements?: Array; + elements?: Array; } & EntitySearchResult)> { return __request(OpenAPI, { method: 'POST', - url: '/language', + url: '/salutation', body: requestBody, mediaType: 'application/json', }); } - /** - * Fetch salutations - * Perform a filtered search for salutations. + * Fetch the states of a country + * Perform a filtered search the states for a country + * @param countryId * @param requestBody - * @returns any Entity search result containing salutations. + * @returns any Entity search result containing countries. * @throws ApiError */ - public static readSalutation( + public static readCountryState( + countryId: string, requestBody?: Criteria, ): CancelablePromise<({ - elements?: Array; + elements?: Array; } & EntitySearchResult)> { return __request(OpenAPI, { method: 'POST', - url: '/salutation', + url: '/country-state/{countryId}', + path: { + 'countryId': countryId, + }, body: requestBody, mediaType: 'application/json', }); } - } diff --git a/src/platforms/shopware/api-client/generated/services/SystemInfoHealthcheckShopware.ts b/src/platforms/shopware/api-client/generated/services/SystemInfoHealthcheckShopware.ts new file mode 100644 index 00000000..239329bb --- /dev/null +++ b/src/platforms/shopware/api-client/generated/services/SystemInfoHealthcheckShopware.ts @@ -0,0 +1,77 @@ +/* generated using openapi-typescript-codegen -- do no edit */ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import type { CancelablePromise } from '../core/CancelablePromise'; +import { OpenAPI } from '../core/OpenAPI'; +import { request as __request } from '../core/request'; +export class SystemInfoHealthcheckShopware { + /** + * Get OpenAPI Specification + * Get information about the store API in OpenAPI format. + * @param type Type of the api + * @returns any Returns information about the store API. + * @throws ApiError + */ + public static apiInfo( + type?: 'jsonapi' | 'json', + ): CancelablePromise<{ + openapi: string; + info: { + title: string; + summary?: string; + description?: string; + termsOfService?: string; + contact?: { + name?: string; + url?: string; + email?: string; + }; + license?: { + name: string; + identifier?: string; + url?: string; + }; + version: string; + }; + jsonSchemaDialect?: string; + webhooks?: Record; + servers?: Array<{ + url: string; + }>; + components?: { + schemas?: Record; + responses?: Record; + parameters?: Record; + examples?: Record; + requestBodies?: Record; + headers?: Record; + securitySchemes?: Record; + links?: Record; + callbacks?: Record; + pathItems?: Record; + }; + security?: Array>; + paths?: Record; + tags?: Array<{ + name: string; + description?: string; + externalDocs?: { + description?: string; + url: string; + }; + }>; + externalDocs?: { + description?: string; + url: string; + }; + }> { + return __request(OpenAPI, { + method: 'GET', + url: '/_info/openapi3.json', + query: { + 'type': type, + }, + }); + } +} diff --git a/src/platforms/shopware/api-client/generated/services/WishlistShopware.ts b/src/platforms/shopware/api-client/generated/services/WishlistShopware.ts index 71b67a1a..d49c77ef 100644 --- a/src/platforms/shopware/api-client/generated/services/WishlistShopware.ts +++ b/src/platforms/shopware/api-client/generated/services/WishlistShopware.ts @@ -5,13 +5,10 @@ import type { Criteria } from '../models/Criteria'; import type { SuccessResponse } from '../models/SuccessResponse'; import type { WishlistLoadRouteResponse } from '../models/WishlistLoadRouteResponse'; - import type { CancelablePromise } from '../core/CancelablePromise'; import { OpenAPI } from '../core/OpenAPI'; import { request as __request } from '../core/request'; - export class WishlistShopware { - /** * Add a product to a wishlist * Adds a product to a customers wishlist. @@ -35,7 +32,6 @@ export class WishlistShopware { }, }); } - /** * Fetch a wishlist * Fetch a customer's wishlist. Products on the wishlist can be filtered using a criteria object. @@ -58,7 +54,6 @@ export class WishlistShopware { mediaType: 'application/json', }); } - /** * Create a wishlist for a customer * Create a new wishlist for a logged in customer or extend the existing wishlist given a set of products. @@ -87,7 +82,6 @@ export class WishlistShopware { mediaType: 'application/json', }); } - /** * Remove a product from a wishlist * Removes a product from a customer's wishlist. @@ -114,5 +108,4 @@ export class WishlistShopware { }, }); } - } diff --git a/src/platforms/shopware/api-client/openapi3.json b/src/platforms/shopware/api-client/openapi3.json index c1fe71ba..842616c1 100644 --- a/src/platforms/shopware/api-client/openapi3.json +++ b/src/platforms/shopware/api-client/openapi3.json @@ -1 +1 @@ -{"openapi":"3.0.0","info":{"title":"Shopware Store API","description":"This endpoint reference contains an overview of all endpoints comprising the Shopware Store API","version":"6.5.3.3"},"servers":[{"url":"http://localhost/store-api"}],"components":{"schemas":{"success":{"required":["data"],"properties":{"meta":{"$ref":"#/components/schemas/meta"},"links":{"description":"Link members related to the primary data.","allOf":[{"$ref":"#/components/schemas/links"},{"$ref":"#/components/schemas/pagination"}]},"data":{"$ref":"#/components/schemas/data"},"included":{"description":"To reduce the number of HTTP requests, servers **MAY** allow responses that include related resources along with the requested primary resources. Such responses are called \"compound documents\".","type":"array","items":{"$ref":"#/components/schemas/resource"},"uniqueItems":true}},"type":"object","additionalProperties":false},"failure":{"required":["errors"],"properties":{"meta":{"$ref":"#/components/schemas/meta"},"links":{"$ref":"#/components/schemas/links"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/error"},"uniqueItems":true}},"type":"object","additionalProperties":false},"info":{"required":["meta"],"properties":{"meta":{"$ref":"#/components/schemas/meta"},"links":{"$ref":"#/components/schemas/links"},"jsonapi":{"$ref":"#/components/schemas/jsonapi"}},"type":"object"},"meta":{"description":"Non-standard meta-information that can not be represented as an attribute or relationship.","type":"object","additionalProperties":true},"data":{"description":"The document's \"primary data\" is a representation of the resource or collection of resources targeted by a request.","oneOf":[{"$ref":"#/components/schemas/resource"},{"description":"An array of resource objects, an array of resource identifier objects, or an empty array ([]), for requests that target resource collections.","type":"array","items":{"$ref":"#/components/schemas/resource"},"uniqueItems":true}]},"resource":{"description":"\"Resource objects\" appear in a JSON API document to represent resources.","required":["type","id"],"properties":{"type":{"type":"string"},"id":{"type":"string"},"attributes":{"$ref":"#/components/schemas/attributes"},"relationships":{"$ref":"#/components/schemas/relationships"},"links":{"$ref":"#/components/schemas/links"},"meta":{"$ref":"#/components/schemas/meta"}},"type":"object"},"relationshipLinks":{"description":"A resource object **MAY** contain references to other resource objects (\"relationships\"). Relationships may be to-one or to-many. Relationships can be specified by including a member in a resource's links object.","properties":{"self":{"allOf":[{"description":"A `self` member, whose value is a URL for the relationship itself (a \"relationship URL\"). This URL allows the client to directly manipulate the relationship. For example, it would allow a client to remove an `author` from an `article` without deleting the people resource itself.","type":"array"},{"$ref":"#/components/schemas/link"}]},"related":{"$ref":"#/components/schemas/link"}},"type":"object","additionalProperties":true},"links":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/link"}},"link":{"description":"A link **MUST** be represented as either: a string containing the link's URL or a link object.","oneOf":[{"description":"A string containing the link's URL.","type":"string","format":"uri-reference"},{"type":"object","required":["href"],"properties":{"href":{"description":"A string containing the link's URL.","type":"string","format":"uri-reference"},"meta":{"$ref":"#/components/schemas/meta"}}}]},"attributes":{"description":"Members of the attributes object (\"attributes\") represent information about the resource object in which it's defined.","type":"object","additionalProperties":true},"relationships":{"description":"Members of the relationships object (\"relationships\") represent references from the resource object in which it's defined to other resource objects.","type":"object","anyOf":[{"required":["data"]},{"required":["meta"]},{"required":["links"]},{"type":"object","properties":{"links":{"$ref":"#/components/schemas/relationshipLinks"},"data":{"description":"Member, whose value represents \"resource linkage\".","oneOf":[{"$ref":"#/components/schemas/relationshipToOne"},{"$ref":"#/components/schemas/relationshipToMany"}]}}}],"additionalProperties":false},"relationshipToOne":{"allOf":[{"description":"References to other resource objects in a to-one (\"relationship\"). Relationships can be specified by including a member in a resource's links object."},{"$ref":"#/components/schemas/linkage"}]},"relationshipToMany":{"description":"An array of objects each containing \\\"type\\\" and \\\"id\\\" members for to-many relationships.","type":"array","items":{"$ref":"#/components/schemas/linkage"},"uniqueItems":true},"linkage":{"description":"The \"type\" and \"id\" to non-empty members.","required":["type","id"],"properties":{"type":{"type":"string"},"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"meta":{"$ref":"#/components/schemas/meta"}},"type":"object","additionalProperties":false},"pagination":{"properties":{"first":{"description":"The first page of data","type":"string","format":"uri-reference"},"last":{"description":"The last page of data","type":"string","format":"uri-reference"},"prev":{"description":"The previous page of data","type":"string","format":"uri-reference"},"next":{"description":"The next page of data","type":"string","format":"uri-reference"}},"type":"object"},"jsonapi":{"description":"An object describing the server's implementation","properties":{"version":{"type":"string"},"meta":{"$ref":"#/components/schemas/meta"}},"type":"object","additionalProperties":false},"error":{"properties":{"id":{"type":"string","description":"A unique identifier for this particular occurrence of the problem."},"links":{"$ref":"#/components/schemas/links"},"status":{"type":"string","description":"The HTTP status code applicable to this problem, expressed as a string value."},"code":{"type":"string","description":"An application-specific error code, expressed as a string value."},"title":{"type":"string","description":"A short, human-readable summary of the problem. It **SHOULD NOT** change from occurrence to occurrence of the problem, except for purposes of localization."},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem."},"source":{"type":"object","properties":{"pointer":{"type":"string","description":"A JSON Pointer [RFC6901] to the associated entity in the request document [e.g. \"/data\" for a primary data object, or \"/data/attributes/title\" for a specific attribute]."},"parameter":{"type":"string","description":"A string indicating which query parameter caused the error."}}},"meta":{"$ref":"#/components/schemas/meta"}},"type":"object","additionalProperties":false},"AclRole":{"description":"Added since version: 6.0.0.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"App":{"description":"Added since version: 6.3.1.0","required":["createdAt","label"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"}},"type":"object"},"AppActionButton":{"description":"Added since version: 6.3.1.0","required":["createdAt","label"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"}},"type":"object"},"AppAdministrationSnippet":{"description":"Added since version: 6.4.15.0","required":["value","appId","localeId","createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"value":{"type":"string"},"appId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"localeId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"AppCmsBlock":{"description":"Added since version: 6.4.2.0","required":["createdAt","label"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"}},"type":"object"},"AppFlowAction":{"description":"Added since version: 6.4.10.0","required":["createdAt","label"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"}},"type":"object"},"AppFlowEvent":{"description":"Added since version: 6.5.2.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"AppPaymentMethod":{"description":"Added since version: 6.4.1.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"AppScriptCondition":{"description":"Added since version: 6.4.10.3","required":["createdAt","name"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"}},"type":"object"},"AppTemplate":{"description":"Added since version: 6.3.1.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"CategoryJsonApi":{"description":"Added since version: 6.0.0.0","allOf":[{"$ref":"#/components/schemas/resource"},{"required":["displayNestedProducts","type","productAssignmentType","createdAt","name"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"versionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"parentId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"parentVersionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"afterCategoryId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"afterCategoryVersionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"mediaId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"displayNestedProducts":{"type":"boolean"},"breadcrumb":{"type":"array","items":{"additionalProperties":false},"readOnly":true},"level":{"type":"integer","format":"int64","readOnly":true},"path":{"type":"string","readOnly":true},"childCount":{"type":"integer","format":"int64","readOnly":true},"type":{"type":"string"},"productAssignmentType":{"type":"string"},"visible":{"type":"boolean"},"active":{"type":"boolean"},"cmsPageIdSwitched":{"description":"Runtime field, cannot be used as part of the criteria.","type":"boolean"},"visibleChildCount":{"description":"Runtime field, cannot be used as part of the criteria.","type":"integer","format":"int64"},"name":{"type":"string"},"customFields":{"type":"object"},"linkType":{"type":"string"},"internalLink":{"type":"string","pattern":"^[0-9a-f]{32}$"},"externalLink":{"type":"string"},"linkNewTab":{"type":"boolean"},"description":{"type":"string"},"metaTitle":{"type":"string"},"metaDescription":{"type":"string"},"keywords":{"type":"string"},"cmsPageId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"cmsPageVersionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"customEntityTypeId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"},"relationships":{"properties":{"parent":{"properties":{"links":{"type":"object","properties":{"related":{"type":"string","format":"uri-reference","example":"/category/018990e91e0370a88c54492a6857a12a/parent"}}},"data":{"type":"object","properties":{"type":{"type":"string","example":"category"},"id":{"type":"string","pattern":"^[0-9a-f]{32}$","example":"018990e91e047019b2b9a6cd2ad907bd"}}}},"type":"object"},"children":{"properties":{"links":{"type":"object","properties":{"related":{"type":"string","format":"uri-reference","example":"/category/018990e91e0370a88c54492a6857a12a/children"}}},"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","example":"category"},"id":{"type":"string","example":"018990e91e047019b2b9a6cd2b64310a"}}}}},"type":"object"},"media":{"properties":{"links":{"type":"object","properties":{"related":{"type":"string","format":"uri-reference","example":"/category/018990e91e0370a88c54492a6857a12a/media"}}},"data":{"type":"object","properties":{"type":{"type":"string","example":"media"},"id":{"type":"string","pattern":"^[0-9a-f]{32}$","example":"018990e91e047019b2b9a6cd2b75f86e"}}}},"type":"object"},"cmsPage":{"properties":{"links":{"type":"object","properties":{"related":{"type":"string","format":"uri-reference","example":"/category/018990e91e0370a88c54492a6857a12a/cmsPage"}}},"data":{"type":"object","properties":{"type":{"type":"string","example":"cms_page"},"id":{"type":"string","pattern":"^[0-9a-f]{32}$","example":"018990e91e047019b2b9a6cd2c157d49"}}}},"type":"object"},"seoUrls":{"properties":{"links":{"type":"object","properties":{"related":{"type":"string","format":"uri-reference","example":"/category/018990e91e0370a88c54492a6857a12a/seoUrls"}}},"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","example":"seo_url"},"id":{"type":"string","example":"018990e91e047019b2b9a6cd2ca4c201"}}}}},"type":"object"}}}},"type":"object"}]},"Category":{"description":"Added since version: 6.0.0.0","required":["displayNestedProducts","type","productAssignmentType","createdAt","name"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"versionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"parentId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"parentVersionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"afterCategoryId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"afterCategoryVersionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"mediaId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"displayNestedProducts":{"type":"boolean"},"breadcrumb":{"type":"array","items":{"additionalProperties":false},"readOnly":true},"level":{"type":"integer","format":"int64","readOnly":true},"path":{"type":"string","readOnly":true},"childCount":{"type":"integer","format":"int64","readOnly":true},"type":{"type":"string"},"productAssignmentType":{"type":"string"},"visible":{"type":"boolean"},"active":{"type":"boolean"},"cmsPageIdSwitched":{"description":"Runtime field, cannot be used as part of the criteria.","type":"boolean"},"visibleChildCount":{"description":"Runtime field, cannot be used as part of the criteria.","type":"integer","format":"int64"},"name":{"type":"string"},"customFields":{"type":"object"},"linkType":{"type":"string"},"internalLink":{"type":"string","pattern":"^[0-9a-f]{32}$"},"externalLink":{"type":"string"},"linkNewTab":{"type":"boolean"},"description":{"type":"string"},"metaTitle":{"type":"string"},"metaDescription":{"type":"string"},"keywords":{"type":"string"},"cmsPageId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"cmsPageVersionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"customEntityTypeId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"},"parent":{"$ref":"#/components/schemas/Category"},"children":{"$ref":"#/components/schemas/Category"},"media":{"$ref":"#/components/schemas/Media"},"cmsPage":{"$ref":"#/components/schemas/CmsPage"},"seoUrls":{"$ref":"#/components/schemas/SeoUrl"}},"type":"object"},"CmsBlock":{"description":"Added since version: 6.0.0.0","required":["position","type","sectionId","createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"position":{"type":"integer","format":"int64"},"type":{"type":"string"},"name":{"type":"string"},"sectionPosition":{"type":"string"},"marginTop":{"type":"string"},"marginBottom":{"type":"string"},"marginLeft":{"type":"string"},"marginRight":{"type":"string"},"backgroundColor":{"type":"string"},"backgroundMediaId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"backgroundMediaMode":{"type":"string"},"cssClass":{"type":"string"},"visibility":{"properties":{"mobile":{"type":"boolean"},"desktop":{"type":"boolean"},"tablet":{"type":"boolean"}},"type":"object"},"sectionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"customFields":{"type":"object"},"versionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"cmsSectionVersionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"backgroundMedia":{"$ref":"#/components/schemas/Media"},"slots":{"$ref":"#/components/schemas/CmsSlot"}},"type":"object"},"CmsPage":{"description":"Added since version: 6.0.0.0","required":["type","createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"versionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"name":{"type":"string"},"type":{"type":"string"},"entity":{"type":"string"},"cssClass":{"type":"string"},"config":{"properties":{"backgroundColor":{"type":"string"}},"type":"object"},"previewMediaId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"customFields":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"},"sections":{"$ref":"#/components/schemas/CmsSection"},"previewMedia":{"$ref":"#/components/schemas/Media"},"landingPages":{"$ref":"#/components/schemas/LandingPage"}},"type":"object"},"CmsSection":{"description":"Added since version: 6.0.0.0","required":["position","type","pageId","createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"position":{"type":"integer","format":"int64"},"type":{"type":"string"},"name":{"type":"string"},"sizingMode":{"type":"string"},"mobileBehavior":{"type":"string"},"backgroundColor":{"type":"string"},"backgroundMediaId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"backgroundMediaMode":{"type":"string"},"cssClass":{"type":"string"},"pageId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"visibility":{"properties":{"mobile":{"type":"boolean"},"desktop":{"type":"boolean"},"tablet":{"type":"boolean"}},"type":"object"},"customFields":{"type":"object"},"cmsPageVersionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"page":{"$ref":"#/components/schemas/CmsPage"},"backgroundMedia":{"$ref":"#/components/schemas/Media"},"blocks":{"$ref":"#/components/schemas/CmsBlock"}},"type":"object"},"CmsSlot":{"description":"Added since version: 6.0.0.0","required":["type","slot","blockId","createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"versionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"type":{"type":"string"},"slot":{"type":"string"},"locked":{"type":"boolean"},"config":{"type":"object"},"customFields":{"type":"object"},"data":{"type":"object","readOnly":true},"blockId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"fieldConfig":{"type":"object"},"cmsBlockVersionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"},"block":{"$ref":"#/components/schemas/CmsBlock"}},"type":"object"},"CountryJsonApi":{"description":"Added since version: 6.0.0.0","allOf":[{"$ref":"#/components/schemas/resource"},{"required":["createdAt","name","addressFormat"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"name":{"type":"string"},"iso":{"type":"string"},"position":{"type":"integer","format":"int64"},"active":{"type":"boolean"},"shippingAvailable":{"type":"boolean"},"iso3":{"type":"string"},"displayStateInRegistration":{"type":"boolean"},"forceStateInRegistration":{"type":"boolean"},"checkVatIdPattern":{"type":"boolean"},"vatIdRequired":{"type":"boolean"},"vatIdPattern":{"type":"string"},"customFields":{"type":"object"},"customerTax":{"required":["enabled","currencyId","amount"],"properties":{"enabled":{"type":"boolean"},"currencyId":{"type":"string"},"amount":{"type":"number","format":"float"}},"type":"object"},"companyTax":{"required":["enabled","currencyId","amount"],"properties":{"enabled":{"type":"boolean"},"currencyId":{"type":"string"},"amount":{"type":"number","format":"float"}},"type":"object"},"postalCodeRequired":{"type":"boolean"},"checkPostalCodePattern":{"type":"boolean"},"checkAdvancedPostalCodePattern":{"type":"boolean"},"advancedPostalCodePattern":{"type":"string"},"addressFormat":{"type":"object"},"defaultPostalCodePattern":{"type":"string"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"},"relationships":{"properties":{"states":{"properties":{"links":{"type":"object","properties":{"related":{"type":"string","format":"uri-reference","example":"/country/018990e91e057384a37760a59605ae48/states"}}},"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","example":"country_state"},"id":{"type":"string","example":"018990e91e057384a37760a596fcd1cc"}}}}},"type":"object"}}}},"type":"object"}]},"Country":{"description":"Added since version: 6.0.0.0","required":["createdAt","name","addressFormat"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"name":{"type":"string"},"iso":{"type":"string"},"position":{"type":"integer","format":"int64"},"active":{"type":"boolean"},"shippingAvailable":{"type":"boolean"},"iso3":{"type":"string"},"displayStateInRegistration":{"type":"boolean"},"forceStateInRegistration":{"type":"boolean"},"checkVatIdPattern":{"type":"boolean"},"vatIdRequired":{"type":"boolean"},"vatIdPattern":{"type":"string"},"customFields":{"type":"object"},"customerTax":{"required":["enabled","currencyId","amount"],"properties":{"enabled":{"type":"boolean"},"currencyId":{"type":"string"},"amount":{"type":"number","format":"float"}},"type":"object"},"companyTax":{"required":["enabled","currencyId","amount"],"properties":{"enabled":{"type":"boolean"},"currencyId":{"type":"string"},"amount":{"type":"number","format":"float"}},"type":"object"},"postalCodeRequired":{"type":"boolean"},"checkPostalCodePattern":{"type":"boolean"},"checkAdvancedPostalCodePattern":{"type":"boolean"},"advancedPostalCodePattern":{"type":"string"},"addressFormat":{"type":"object"},"defaultPostalCodePattern":{"type":"string"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"},"states":{"$ref":"#/components/schemas/CountryState"}},"type":"object"},"CountryStateJsonApi":{"description":"Added since version: 6.0.0.0","allOf":[{"$ref":"#/components/schemas/resource"},{"required":["countryId","shortCode","createdAt","name"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"countryId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"shortCode":{"type":"string"},"name":{"type":"string"},"position":{"type":"integer","format":"int64"},"active":{"type":"boolean"},"customFields":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"}},"type":"object"}]},"CountryState":{"description":"Added since version: 6.0.0.0","required":["countryId","shortCode","createdAt","name"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"countryId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"shortCode":{"type":"string"},"name":{"type":"string"},"position":{"type":"integer","format":"int64"},"active":{"type":"boolean"},"customFields":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"}},"type":"object"},"CurrencyJsonApi":{"description":"Added since version: 6.0.0.0","allOf":[{"$ref":"#/components/schemas/resource"},{"required":["factor","symbol","isoCode","itemRounding","totalRounding","createdAt","shortName","name"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"factor":{"type":"number","format":"float"},"symbol":{"type":"string"},"isoCode":{"type":"string"},"shortName":{"type":"string"},"name":{"type":"string"},"position":{"type":"integer","format":"int64"},"isSystemDefault":{"description":"Runtime field, cannot be used as part of the criteria.","type":"boolean"},"taxFreeFrom":{"type":"number","format":"float"},"customFields":{"type":"object"},"itemRounding":{"properties":{"decimals":{"type":"integer","format":"int64"},"interval":{"type":"number","format":"float"},"roundForNet":{"type":"boolean"}},"type":"object"},"totalRounding":{"properties":{"decimals":{"type":"integer","format":"int64"},"interval":{"type":"number","format":"float"},"roundForNet":{"type":"boolean"}},"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"}},"type":"object"}]},"Currency":{"description":"Added since version: 6.0.0.0","required":["factor","symbol","isoCode","itemRounding","totalRounding","createdAt","shortName","name"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"factor":{"type":"number","format":"float"},"symbol":{"type":"string"},"isoCode":{"type":"string"},"shortName":{"type":"string"},"name":{"type":"string"},"position":{"type":"integer","format":"int64"},"isSystemDefault":{"description":"Runtime field, cannot be used as part of the criteria.","type":"boolean"},"taxFreeFrom":{"type":"number","format":"float"},"customFields":{"type":"object"},"itemRounding":{"properties":{"decimals":{"type":"integer","format":"int64"},"interval":{"type":"number","format":"float"},"roundForNet":{"type":"boolean"}},"type":"object"},"totalRounding":{"properties":{"decimals":{"type":"integer","format":"int64"},"interval":{"type":"number","format":"float"},"roundForNet":{"type":"boolean"}},"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"}},"type":"object"},"CurrencyCountryRounding":{"description":"Added since version: 6.4.0.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"CustomEntity":{"description":"Added since version: 6.4.9.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"CustomField":{"description":"Added since version: 6.0.0.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"CustomFieldSet":{"description":"Added since version: 6.0.0.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"CustomFieldSetRelation":{"description":"Added since version: 6.0.0.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"Customer":{"description":"Added since version: 6.0.0.0","required":["groupId","defaultPaymentMethodId","salesChannelId","languageId","defaultBillingAddressId","defaultShippingAddressId","customerNumber","firstName","lastName","email","accountType","createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"groupId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"defaultPaymentMethodId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"salesChannelId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"languageId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"lastPaymentMethodId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"defaultBillingAddressId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"defaultShippingAddressId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"customerNumber":{"type":"string"},"salutationId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"firstName":{"type":"string"},"lastName":{"type":"string"},"company":{"type":"string"},"email":{"type":"string"},"title":{"type":"string"},"vatIds":{"type":"array","items":{"type":"string"}},"affiliateCode":{"type":"string"},"campaignCode":{"type":"string"},"active":{"type":"boolean"},"doubleOptInRegistration":{"type":"boolean"},"doubleOptInEmailSentDate":{"type":"string","format":"date-time"},"doubleOptInConfirmDate":{"type":"string","format":"date-time"},"hash":{"type":"string"},"guest":{"type":"boolean"},"firstLogin":{"type":"string","format":"date-time"},"lastLogin":{"type":"string","format":"date-time"},"birthday":{"type":"string"},"lastOrderDate":{"type":"string","format":"date-time","readOnly":true},"orderCount":{"type":"integer","format":"int64","readOnly":true},"orderTotalAmount":{"type":"number","format":"float","readOnly":true},"reviewCount":{"type":"integer","format":"int64","readOnly":true},"customFields":{"type":"object"},"tagIds":{"type":"array","items":{"type":"string","pattern":"^[0-9a-f]{32}$"},"readOnly":true},"accountType":{"type":"string"},"createdById":{"type":"string","pattern":"^[0-9a-f]{32}$"},"updatedById":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"group":{"$ref":"#/components/schemas/CustomerGroup"},"defaultPaymentMethod":{"$ref":"#/components/schemas/PaymentMethod"},"language":{"$ref":"#/components/schemas/Language"},"lastPaymentMethod":{"$ref":"#/components/schemas/PaymentMethod"},"defaultBillingAddress":{"$ref":"#/components/schemas/CustomerAddress"},"defaultShippingAddress":{"$ref":"#/components/schemas/CustomerAddress"},"salutation":{"$ref":"#/components/schemas/Salutation"},"addresses":{"$ref":"#/components/schemas/CustomerAddress"}},"type":"object"},"CustomerAddress":{"description":"Added since version: 6.0.0.0","required":["customerId","countryId","firstName","lastName","city","street","createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"customerId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"countryId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"countryStateId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"salutationId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"firstName":{"type":"string"},"lastName":{"type":"string"},"zipcode":{"type":"string"},"city":{"type":"string"},"company":{"type":"string"},"street":{"type":"string"},"department":{"type":"string"},"title":{"type":"string"},"phoneNumber":{"type":"string"},"additionalAddressLine1":{"type":"string"},"additionalAddressLine2":{"type":"string"},"customFields":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"country":{"$ref":"#/components/schemas/Country"},"countryState":{"$ref":"#/components/schemas/CountryState"},"salutation":{"$ref":"#/components/schemas/Salutation"}},"type":"object"},"CustomerGroup":{"description":"Added since version: 6.0.0.0","required":["createdAt","name"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"name":{"type":"string"},"displayGross":{"type":"boolean"},"customFields":{"type":"object"},"registrationActive":{"type":"boolean"},"registrationTitle":{"type":"string"},"registrationIntroduction":{"type":"string"},"registrationOnlyCompanyRegistration":{"type":"boolean"},"registrationSeoMetaDescription":{"type":"string"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"}},"type":"object"},"CustomerRecovery":{"description":"Added since version: 6.1.0.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"CustomerTag":{"description":"Added since version: 6.0.0.0","required":["customerId","tagId"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"customerId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"tagId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"tag":{"$ref":"#/components/schemas/Tag"}},"type":"object"},"CustomerWishlist":{"description":"Added since version: 6.3.4.0","required":["customerId","createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"customerId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"customFields":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"CustomerWishlistProduct":{"description":"Added since version: 6.3.4.0","required":["productId","createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"productId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"productVersionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"DeliveryTime":{"description":"Added since version: 6.0.0.0","required":["name","min","max","unit","createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"name":{"type":"string"},"min":{"type":"integer","format":"int64"},"max":{"type":"integer","format":"int64"},"unit":{"type":"string"},"customFields":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"}},"type":"object"},"Document":{"description":"Added since version: 6.0.0.0","required":["documentTypeId","fileType","orderId","config","deepLinkCode","createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"documentTypeId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"fileType":{"type":"string"},"referencedDocumentId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"orderId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"documentMediaFileId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"orderVersionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"config":{"type":"object"},"sent":{"type":"boolean"},"static":{"type":"boolean"},"deepLinkCode":{"type":"string"},"customFields":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"documentType":{"$ref":"#/components/schemas/DocumentType"},"order":{"$ref":"#/components/schemas/Order"},"referencedDocument":{"$ref":"#/components/schemas/Document"},"dependentDocuments":{"$ref":"#/components/schemas/Document"},"documentMediaFile":{"$ref":"#/components/schemas/Media"}},"type":"object"},"DocumentBaseConfig":{"description":"Added since version: 6.0.0.0","required":["documentTypeId","name","global","createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"documentTypeId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"logoId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"name":{"type":"string"},"filenamePrefix":{"type":"string"},"filenameSuffix":{"type":"string"},"global":{"type":"boolean"},"documentNumber":{"type":"string"},"config":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"customFields":{"type":"object"},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"logo":{"$ref":"#/components/schemas/Media"}},"type":"object"},"DocumentBaseConfigSalesChannel":{"description":"Added since version: 6.0.0.0","required":["documentBaseConfigId","createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"documentBaseConfigId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"salesChannelId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"documentTypeId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"DocumentType":{"description":"Added since version: 6.0.0.0","required":["technicalName","createdAt","name"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"name":{"type":"string"},"technicalName":{"type":"string"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"customFields":{"type":"object"},"translated":{"type":"object"}},"type":"object"},"Flow":{"description":"Added since version: 6.4.6.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"FlowSequence":{"description":"Added since version: 6.4.6.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"FlowTemplate":{"description":"Added since version: 6.4.18.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"ImportExportFile":{"description":"Added since version: 6.0.0.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"ImportExportLog":{"description":"Added since version: 6.0.0.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"ImportExportProfile":{"description":"Added since version: 6.0.0.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"}},"type":"object"},"Integration":{"description":"Added since version: 6.0.0.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"LandingPageJsonApi":{"description":"Added since version: 6.4.0.0","allOf":[{"$ref":"#/components/schemas/resource"},{"required":["createdAt","name","url"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"versionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"active":{"type":"boolean"},"name":{"type":"string"},"customFields":{"type":"object"},"slotConfig":{"type":"object"},"metaTitle":{"type":"string"},"metaDescription":{"type":"string"},"keywords":{"type":"string"},"url":{"type":"string"},"cmsPageId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"cmsPageVersionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"},"relationships":{"properties":{"cmsPage":{"properties":{"links":{"type":"object","properties":{"related":{"type":"string","format":"uri-reference","example":"/landing-page/018990e91e0971a7ad2291fedd3a9100/cmsPage"}}},"data":{"type":"object","properties":{"type":{"type":"string","example":"cms_page"},"id":{"type":"string","pattern":"^[0-9a-f]{32}$","example":"018990e91e0971a7ad2291feddee3878"}}}},"type":"object"},"seoUrls":{"properties":{"links":{"type":"object","properties":{"related":{"type":"string","format":"uri-reference","example":"/landing-page/018990e91e0971a7ad2291fedd3a9100/seoUrls"}}},"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","example":"seo_url"},"id":{"type":"string","example":"018990e91e0971a7ad2291fede1044ed"}}}}},"type":"object"}}}},"type":"object"}]},"LandingPage":{"description":"Added since version: 6.4.0.0","required":["createdAt","name","url"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"versionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"active":{"type":"boolean"},"name":{"type":"string"},"customFields":{"type":"object"},"slotConfig":{"type":"object"},"metaTitle":{"type":"string"},"metaDescription":{"type":"string"},"keywords":{"type":"string"},"url":{"type":"string"},"cmsPageId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"cmsPageVersionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"},"cmsPage":{"$ref":"#/components/schemas/CmsPage"},"seoUrls":{"$ref":"#/components/schemas/SeoUrl"}},"type":"object"},"LanguageJsonApi":{"description":"Added since version: 6.0.0.0","allOf":[{"$ref":"#/components/schemas/resource"},{"required":["localeId","name","createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"parentId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"localeId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"translationCodeId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"name":{"type":"string"},"customFields":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"relationships":{"properties":{"parent":{"properties":{"links":{"type":"object","properties":{"related":{"type":"string","format":"uri-reference","example":"/language/018990e91e0a73a2ae91f09eafc76a2f/parent"}}},"data":{"type":"object","properties":{"type":{"type":"string","example":"language"},"id":{"type":"string","pattern":"^[0-9a-f]{32}$","example":"018990e91e0a73a2ae91f09eb05cf3d5"}}}},"type":"object"},"locale":{"properties":{"links":{"type":"object","properties":{"related":{"type":"string","format":"uri-reference","example":"/language/018990e91e0a73a2ae91f09eafc76a2f/locale"}}},"data":{"type":"object","properties":{"type":{"type":"string","example":"locale"},"id":{"type":"string","pattern":"^[0-9a-f]{32}$","example":"018990e91e0a73a2ae91f09eb122819a"}}}},"type":"object"},"translationCode":{"properties":{"links":{"type":"object","properties":{"related":{"type":"string","format":"uri-reference","example":"/language/018990e91e0a73a2ae91f09eafc76a2f/translationCode"}}},"data":{"type":"object","properties":{"type":{"type":"string","example":"locale"},"id":{"type":"string","pattern":"^[0-9a-f]{32}$","example":"018990e91e0a73a2ae91f09eb1e6cc61"}}}},"type":"object"},"children":{"properties":{"links":{"type":"object","properties":{"related":{"type":"string","format":"uri-reference","example":"/language/018990e91e0a73a2ae91f09eafc76a2f/children"}}},"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","example":"language"},"id":{"type":"string","example":"018990e91e0a73a2ae91f09eb20102b8"}}}}},"type":"object"}}}},"type":"object"}]},"Language":{"description":"Added since version: 6.0.0.0","required":["localeId","name","createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"parentId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"localeId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"translationCodeId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"name":{"type":"string"},"customFields":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"parent":{"$ref":"#/components/schemas/Language"},"locale":{"$ref":"#/components/schemas/Locale"},"translationCode":{"$ref":"#/components/schemas/Locale"},"children":{"$ref":"#/components/schemas/Language"}},"type":"object"},"Locale":{"description":"Added since version: 6.0.0.0","required":["code","createdAt","name","territory"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"code":{"type":"string"},"name":{"type":"string"},"territory":{"type":"string"},"customFields":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"}},"type":"object"},"LogEntry":{"description":"Added since version: 6.0.0.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"MailHeaderFooter":{"description":"Added since version: 6.0.0.0","required":["createdAt","name"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"systemDefault":{"type":"boolean"},"name":{"type":"string"},"description":{"type":"string"},"headerHtml":{"type":"string"},"headerPlain":{"type":"string"},"footerHtml":{"type":"string"},"footerPlain":{"type":"string"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"}},"type":"object"},"MailTemplate":{"description":"Added since version: 6.0.0.0","required":["createdAt","subject","contentHtml","contentPlain"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"systemDefault":{"type":"boolean"},"senderName":{"type":"string"},"contentHtml":{"type":"string"},"contentPlain":{"type":"string"},"customFields":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"},"mailTemplateType":{"$ref":"#/components/schemas/MailTemplateType"},"media":{"$ref":"#/components/schemas/MailTemplateMedia"}},"type":"object"},"MailTemplateMedia":{"description":"Added since version: 6.0.0.0","required":["mailTemplateId","languageId","mediaId"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"mailTemplateId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"languageId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"mediaId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"position":{"type":"integer","format":"int64"},"media":{"$ref":"#/components/schemas/Media"}},"type":"object"},"MailTemplateType":{"description":"Added since version: 6.0.0.0","required":["technicalName","createdAt","name"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"name":{"type":"string"},"technicalName":{"type":"string"},"customFields":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"}},"type":"object"},"MainCategoryJsonApi":{"description":"Added since version: 6.1.0.0","allOf":[{"$ref":"#/components/schemas/resource"},{"required":["productId","categoryId","salesChannelId","createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"productId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"productVersionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"categoryId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"categoryVersionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"salesChannelId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"}]},"MainCategory":{"description":"Added since version: 6.1.0.0","required":["productId","categoryId","salesChannelId","createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"productId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"productVersionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"categoryId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"categoryVersionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"salesChannelId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"Media":{"description":"Added since version: 6.0.0.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"mimeType":{"type":"string","readOnly":true},"fileExtension":{"type":"string","readOnly":true},"uploadedAt":{"type":"string","format":"date-time","readOnly":true},"fileName":{"type":"string","readOnly":true},"fileSize":{"type":"integer","format":"int64","readOnly":true},"metaData":{"type":"object","readOnly":true},"alt":{"type":"string"},"title":{"type":"string"},"url":{"description":"Runtime field, cannot be used as part of the criteria.","type":"string"},"hasFile":{"description":"Runtime field, cannot be used as part of the criteria.","type":"boolean"},"private":{"type":"boolean"},"customFields":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"},"thumbnails":{"$ref":"#/components/schemas/MediaThumbnail"}},"type":"object"},"MediaDefaultFolder":{"description":"Added since version: 6.0.0.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"MediaFolder":{"description":"Added since version: 6.0.0.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"MediaFolderConfiguration":{"description":"Added since version: 6.0.0.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"MediaTag":{"description":"Added since version: 6.0.0.0","required":["mediaId","tagId"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"mediaId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"tagId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"media":{"$ref":"#/components/schemas/Media"},"tag":{"$ref":"#/components/schemas/Tag"}},"type":"object"},"MediaThumbnail":{"description":"Added since version: 6.0.0.0","required":["mediaId","width","height","createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"mediaId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"width":{"type":"integer","format":"int64","readOnly":true},"height":{"type":"integer","format":"int64","readOnly":true},"url":{"description":"Runtime field, cannot be used as part of the criteria.","type":"string"},"customFields":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"MediaThumbnailSize":{"description":"Added since version: 6.0.0.0","required":["width","height","createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"width":{"type":"integer","format":"int64"},"height":{"type":"integer","format":"int64"},"customFields":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"NewsletterRecipientJsonApi":{"description":"Added since version: 6.0.0.0","allOf":[{"$ref":"#/components/schemas/resource"},{"required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"}]},"NewsletterRecipient":{"description":"Added since version: 6.0.0.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"Notification":{"description":"Added since version: 6.4.7.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"NumberRange":{"description":"Added since version: 6.0.0.0","required":["createdAt","name"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"}},"type":"object"},"NumberRangeSalesChannel":{"description":"Added since version: 6.0.0.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"NumberRangeState":{"description":"Added since version: 6.0.0.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"NumberRangeType":{"description":"Added since version: 6.0.0.0","required":["createdAt","typeName"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"}},"type":"object"},"Order":{"description":"Added since version: 6.0.0.0","required":["billingAddressId","currencyId","languageId","salesChannelId","orderDateTime","currencyFactor","createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"versionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"orderNumber":{"type":"string"},"billingAddressId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"billingAddressVersionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"currencyId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"languageId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"salesChannelId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"orderDateTime":{"type":"string","format":"date-time"},"orderDate":{"type":"string","readOnly":true},"price":{"required":["netPrice","totalPrice","positionPrice","rawTotal","taxStatus"],"properties":{"netPrice":{"type":"number","format":"float"},"totalPrice":{"type":"number","format":"float"},"calculatedTaxes":{"type":"object"},"taxRules":{"type":"object"},"positionPrice":{"type":"number","format":"float"},"rawTotal":{"type":"number","format":"float"},"taxStatus":{"type":"string"}},"type":"object"},"amountTotal":{"type":"number","format":"float","readOnly":true},"amountNet":{"type":"number","format":"float","readOnly":true},"positionPrice":{"type":"number","format":"float","readOnly":true},"taxStatus":{"type":"string","readOnly":true},"shippingCosts":{"required":["unitPrice","totalPrice","quantity"],"properties":{"unitPrice":{"type":"number","format":"float"},"totalPrice":{"type":"number","format":"float"},"quantity":{"type":"integer","format":"int64"},"calculatedTaxes":{"type":"object"},"taxRules":{"type":"object"},"referencePrice":{"type":"object"},"listPrice":{"properties":{"price":{"type":"number","format":"float"},"discount":{"type":"number","format":"float"},"percentage":{"type":"number","format":"float"}},"type":"object"},"regulationPrice":{"properties":{"price":{"type":"number","format":"float"}},"type":"object"}},"type":"object"},"shippingTotal":{"type":"number","format":"float","readOnly":true},"currencyFactor":{"type":"number","format":"float"},"deepLinkCode":{"type":"string"},"affiliateCode":{"type":"string"},"campaignCode":{"type":"string"},"customerComment":{"type":"string"},"customFields":{"type":"object"},"createdById":{"type":"string","pattern":"^[0-9a-f]{32}$"},"updatedById":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"stateMachineState":{"$ref":"#/components/schemas/StateMachineState"},"orderCustomer":{"$ref":"#/components/schemas/OrderCustomer"},"currency":{"$ref":"#/components/schemas/Currency"},"language":{"$ref":"#/components/schemas/Language"},"addresses":{"$ref":"#/components/schemas/OrderAddress"},"billingAddress":{"$ref":"#/components/schemas/OrderAddress"},"deliveries":{"$ref":"#/components/schemas/OrderDelivery"},"lineItems":{"$ref":"#/components/schemas/OrderLineItem"},"transactions":{"$ref":"#/components/schemas/OrderTransaction"},"documents":{"$ref":"#/components/schemas/Document"},"tags":{"$ref":"#/components/schemas/Tag"}},"type":"object"},"OrderAddress":{"description":"Added since version: 6.0.0.0","required":["countryId","firstName","lastName","street","city","createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"versionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"countryId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"countryStateId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"firstName":{"type":"string"},"lastName":{"type":"string"},"street":{"type":"string"},"zipcode":{"type":"string"},"city":{"type":"string"},"company":{"type":"string"},"department":{"type":"string"},"title":{"type":"string"},"vatId":{"type":"string"},"phoneNumber":{"type":"string"},"additionalAddressLine1":{"type":"string"},"additionalAddressLine2":{"type":"string"},"customFields":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"country":{"$ref":"#/components/schemas/Country"},"countryState":{"$ref":"#/components/schemas/CountryState"},"salutation":{"$ref":"#/components/schemas/Salutation"}},"type":"object"},"OrderCustomer":{"description":"Added since version: 6.0.0.0","required":["email","salutationId","firstName","lastName","createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"versionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"email":{"type":"string"},"salutationId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"firstName":{"type":"string"},"lastName":{"type":"string"},"company":{"type":"string"},"title":{"type":"string"},"vatIds":{"type":"array","items":{"type":"string"}},"customerNumber":{"type":"string"},"customFields":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"salutation":{"$ref":"#/components/schemas/Salutation"}},"type":"object"},"OrderDelivery":{"description":"Added since version: 6.0.0.0","required":["orderId","shippingOrderAddressId","shippingMethodId","stateId","trackingCodes","shippingDateEarliest","shippingDateLatest","createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"versionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"orderId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"orderVersionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"shippingOrderAddressId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"shippingOrderAddressVersionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"shippingMethodId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"stateId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"trackingCodes":{"type":"array","items":{"type":"string"}},"shippingDateEarliest":{"type":"string","format":"date-time"},"shippingDateLatest":{"type":"string","format":"date-time"},"shippingCosts":{"required":["unitPrice","totalPrice","quantity"],"properties":{"unitPrice":{"type":"number","format":"float"},"totalPrice":{"type":"number","format":"float"},"quantity":{"type":"integer","format":"int64"},"calculatedTaxes":{"type":"object"},"taxRules":{"type":"object"},"referencePrice":{"type":"object"},"listPrice":{"properties":{"price":{"type":"number","format":"float"},"discount":{"type":"number","format":"float"},"percentage":{"type":"number","format":"float"}},"type":"object"},"regulationPrice":{"properties":{"price":{"type":"number","format":"float"}},"type":"object"}},"type":"object"},"customFields":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"stateMachineState":{"$ref":"#/components/schemas/StateMachineState"},"shippingOrderAddress":{"$ref":"#/components/schemas/OrderAddress"},"shippingMethod":{"$ref":"#/components/schemas/ShippingMethod"},"positions":{"$ref":"#/components/schemas/OrderDeliveryPosition"}},"type":"object"},"OrderDeliveryPosition":{"description":"Added since version: 6.0.0.0","required":["orderDeliveryId","orderLineItemId","createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"versionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"orderDeliveryId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"orderDeliveryVersionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"orderLineItemId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"orderLineItemVersionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"price":{"required":["unitPrice","totalPrice","quantity"],"properties":{"unitPrice":{"type":"number","format":"float"},"totalPrice":{"type":"number","format":"float"},"quantity":{"type":"integer","format":"int64"},"calculatedTaxes":{"type":"object"},"taxRules":{"type":"object"},"referencePrice":{"type":"object"},"listPrice":{"properties":{"price":{"type":"number","format":"float"},"discount":{"type":"number","format":"float"},"percentage":{"type":"number","format":"float"}},"type":"object"},"regulationPrice":{"properties":{"price":{"type":"number","format":"float"}},"type":"object"}},"type":"object"},"unitPrice":{"type":"number","format":"float"},"totalPrice":{"type":"number","format":"float"},"quantity":{"type":"integer","format":"int64"},"customFields":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"OrderLineItem":{"description":"Added since version: 6.0.0.0","required":["orderId","identifier","quantity","label","position","states","children","createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"versionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"orderId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"orderVersionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"productId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"productVersionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"parentId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"parentVersionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"coverId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"identifier":{"type":"string"},"referencedId":{"type":"string"},"quantity":{"type":"integer","format":"int64"},"label":{"type":"string"},"payload":{"type":"object"},"good":{"type":"boolean"},"removable":{"type":"boolean"},"stackable":{"type":"boolean"},"position":{"type":"integer","format":"int64"},"states":{"type":"array","items":{"type":"string"}},"priceDefinition":{"type":"object"},"unitPrice":{"type":"number","format":"float"},"totalPrice":{"type":"number","format":"float"},"description":{"type":"string"},"type":{"type":"string"},"customFields":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"cover":{"$ref":"#/components/schemas/Media"},"orderDeliveryPositions":{"$ref":"#/components/schemas/OrderDeliveryPosition"},"downloads":{"$ref":"#/components/schemas/OrderLineItemDownload"},"parent":{"$ref":"#/components/schemas/OrderLineItem"},"children":{"$ref":"#/components/schemas/OrderLineItem"}},"type":"object"},"OrderLineItemDownload":{"description":"Added since version: 6.4.19.0","required":["orderLineItemId","mediaId","position","accessGranted","createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"versionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"orderLineItemId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"orderLineItemVersionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"mediaId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"position":{"type":"integer","format":"int64"},"accessGranted":{"type":"boolean"},"customFields":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"orderLineItem":{"$ref":"#/components/schemas/OrderLineItem"},"media":{"$ref":"#/components/schemas/Media"}},"type":"object"},"OrderTag":{"description":"Added since version: 6.0.0.0","required":["orderId","tagId"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"orderId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"orderVersionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"tagId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"order":{"$ref":"#/components/schemas/Order"},"tag":{"$ref":"#/components/schemas/Tag"}},"type":"object"},"OrderTransaction":{"description":"Added since version: 6.0.0.0","required":["orderId","paymentMethodId","amount","stateId","createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"versionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"orderId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"orderVersionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"paymentMethodId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"amount":{"required":["unitPrice","totalPrice","quantity"],"properties":{"unitPrice":{"type":"number","format":"float"},"totalPrice":{"type":"number","format":"float"},"quantity":{"type":"integer","format":"int64"},"calculatedTaxes":{"type":"object"},"taxRules":{"type":"object"},"referencePrice":{"type":"object"},"listPrice":{"properties":{"price":{"type":"number","format":"float"},"discount":{"type":"number","format":"float"},"percentage":{"type":"number","format":"float"}},"type":"object"},"regulationPrice":{"properties":{"price":{"type":"number","format":"float"}},"type":"object"}},"type":"object"},"stateId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"customFields":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"stateMachineState":{"$ref":"#/components/schemas/StateMachineState"},"paymentMethod":{"$ref":"#/components/schemas/PaymentMethod"},"captures":{"$ref":"#/components/schemas/OrderTransactionCapture"}},"type":"object"},"OrderTransactionCapture":{"description":"Added since version: 6.4.12.0","required":["orderTransactionId","stateId","amount","createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"orderTransactionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"orderTransactionVersionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"stateId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"externalReference":{"type":"string"},"amount":{"required":["unitPrice","totalPrice","quantity"],"properties":{"unitPrice":{"type":"number","format":"float"},"totalPrice":{"type":"number","format":"float"},"quantity":{"type":"integer","format":"int64"},"calculatedTaxes":{"type":"object"},"taxRules":{"type":"object"},"referencePrice":{"type":"object"},"listPrice":{"properties":{"price":{"type":"number","format":"float"},"discount":{"type":"number","format":"float"},"percentage":{"type":"number","format":"float"}},"type":"object"},"regulationPrice":{"properties":{"price":{"type":"number","format":"float"}},"type":"object"}},"type":"object"},"customFields":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"stateMachineState":{"$ref":"#/components/schemas/StateMachineState"},"transaction":{"$ref":"#/components/schemas/OrderTransaction"},"refunds":{"$ref":"#/components/schemas/OrderTransactionCaptureRefund"}},"type":"object"},"OrderTransactionCaptureRefund":{"description":"Added since version: 6.4.12.0","required":["captureId","stateId","amount","createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"captureId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"stateId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"externalReference":{"type":"string"},"reason":{"type":"string"},"amount":{"required":["unitPrice","totalPrice","quantity"],"properties":{"unitPrice":{"type":"number","format":"float"},"totalPrice":{"type":"number","format":"float"},"quantity":{"type":"integer","format":"int64"},"calculatedTaxes":{"type":"object"},"taxRules":{"type":"object"},"referencePrice":{"type":"object"},"listPrice":{"properties":{"price":{"type":"number","format":"float"},"discount":{"type":"number","format":"float"},"percentage":{"type":"number","format":"float"}},"type":"object"},"regulationPrice":{"properties":{"price":{"type":"number","format":"float"}},"type":"object"}},"type":"object"},"customFields":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"stateMachineState":{"$ref":"#/components/schemas/StateMachineState"},"transactionCapture":{"$ref":"#/components/schemas/OrderTransactionCapture"},"positions":{"$ref":"#/components/schemas/OrderTransactionCaptureRefundPosition"}},"type":"object"},"OrderTransactionCaptureRefundPosition":{"description":"Added since version: 6.4.12.0","required":["refundId","orderLineItemId","amount","createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"refundId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"orderLineItemId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"orderLineItemVersionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"externalReference":{"type":"string"},"reason":{"type":"string"},"quantity":{"type":"integer","format":"int64"},"amount":{"required":["unitPrice","totalPrice","quantity"],"properties":{"unitPrice":{"type":"number","format":"float"},"totalPrice":{"type":"number","format":"float"},"quantity":{"type":"integer","format":"int64"},"calculatedTaxes":{"type":"object"},"taxRules":{"type":"object"},"referencePrice":{"type":"object"},"listPrice":{"properties":{"price":{"type":"number","format":"float"},"discount":{"type":"number","format":"float"},"percentage":{"type":"number","format":"float"}},"type":"object"},"regulationPrice":{"properties":{"price":{"type":"number","format":"float"}},"type":"object"}},"type":"object"},"customFields":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"orderLineItem":{"$ref":"#/components/schemas/OrderLineItem"},"orderTransactionCaptureRefund":{"$ref":"#/components/schemas/OrderTransactionCaptureRefund"}},"type":"object"},"PaymentMethodJsonApi":{"description":"Added since version: 6.0.0.0","allOf":[{"$ref":"#/components/schemas/resource"},{"required":["createdAt","name"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"name":{"type":"string"},"distinguishableName":{"type":"string","readOnly":true},"description":{"type":"string"},"position":{"type":"integer","format":"int64"},"active":{"type":"boolean"},"afterOrderEnabled":{"type":"boolean"},"customFields":{"type":"object"},"mediaId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"synchronous":{"description":"Runtime field, cannot be used as part of the criteria.","type":"boolean","readOnly":true},"asynchronous":{"description":"Runtime field, cannot be used as part of the criteria.","type":"boolean","readOnly":true},"prepared":{"description":"Runtime field, cannot be used as part of the criteria.","type":"boolean","readOnly":true},"refundable":{"description":"Runtime field, cannot be used as part of the criteria.","type":"boolean","readOnly":true},"shortName":{"description":"Runtime field, cannot be used as part of the criteria.","type":"string"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"},"relationships":{"properties":{"media":{"properties":{"links":{"type":"object","properties":{"related":{"type":"string","format":"uri-reference","example":"/payment-method/018990e91e1173b198b4af2f7a83c3cc/media"}}},"data":{"type":"object","properties":{"type":{"type":"string","example":"media"},"id":{"type":"string","pattern":"^[0-9a-f]{32}$","example":"018990e91e1173b198b4af2f7b22acf1"}}}},"type":"object"}}}},"type":"object"}]},"PaymentMethod":{"description":"Added since version: 6.0.0.0","required":["createdAt","name"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"name":{"type":"string"},"distinguishableName":{"type":"string","readOnly":true},"description":{"type":"string"},"position":{"type":"integer","format":"int64"},"active":{"type":"boolean"},"afterOrderEnabled":{"type":"boolean"},"customFields":{"type":"object"},"mediaId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"synchronous":{"description":"Runtime field, cannot be used as part of the criteria.","type":"boolean","readOnly":true},"asynchronous":{"description":"Runtime field, cannot be used as part of the criteria.","type":"boolean","readOnly":true},"prepared":{"description":"Runtime field, cannot be used as part of the criteria.","type":"boolean","readOnly":true},"refundable":{"description":"Runtime field, cannot be used as part of the criteria.","type":"boolean","readOnly":true},"shortName":{"description":"Runtime field, cannot be used as part of the criteria.","type":"string"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"},"media":{"$ref":"#/components/schemas/Media"}},"type":"object"},"Plugin":{"description":"Added since version: 6.0.0.0","required":["createdAt","label"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"}},"type":"object"},"ProductJsonApi":{"description":"Added since version: 6.0.0.0","allOf":[{"$ref":"#/components/schemas/resource"},{"required":["taxId","productNumber","stock","createdAt","name"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"versionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"parentId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"parentVersionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"manufacturerId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"productManufacturerVersionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"unitId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"taxId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"coverId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"productMediaVersionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"deliveryTimeId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"canonicalProductId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"cmsPageId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"cmsPageVersionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"productNumber":{"type":"string"},"stock":{"type":"integer","format":"int64"},"restockTime":{"type":"integer","format":"int64"},"active":{"type":"boolean"},"availableStock":{"type":"integer","format":"int64","readOnly":true},"available":{"type":"boolean","readOnly":true},"isCloseout":{"type":"boolean"},"displayGroup":{"type":"string","readOnly":true},"manufacturerNumber":{"type":"string"},"ean":{"type":"string"},"purchaseSteps":{"type":"integer","format":"int64"},"maxPurchase":{"type":"integer","format":"int64"},"minPurchase":{"type":"integer","format":"int64"},"purchaseUnit":{"type":"number","format":"float"},"referenceUnit":{"type":"number","format":"float"},"shippingFree":{"type":"boolean"},"markAsTopseller":{"type":"boolean"},"weight":{"type":"number","format":"float"},"width":{"type":"number","format":"float"},"height":{"type":"number","format":"float"},"length":{"type":"number","format":"float"},"releaseDate":{"type":"string","format":"date-time"},"ratingAverage":{"type":"number","format":"float","readOnly":true},"categoryTree":{"type":"array","items":{"type":"string","pattern":"^[0-9a-f]{32}$"},"readOnly":true},"propertyIds":{"type":"array","items":{"type":"string","pattern":"^[0-9a-f]{32}$"},"readOnly":true},"optionIds":{"type":"array","items":{"type":"string","pattern":"^[0-9a-f]{32}$"},"readOnly":true},"streamIds":{"type":"array","items":{"type":"string","pattern":"^[0-9a-f]{32}$"},"readOnly":true},"categoryIds":{"type":"array","items":{"type":"string","pattern":"^[0-9a-f]{32}$"},"readOnly":true},"childCount":{"type":"integer","format":"int64","readOnly":true},"sales":{"type":"integer","format":"int64","readOnly":true},"states":{"type":"array","items":{"type":"string"},"readOnly":true},"metaDescription":{"type":"string"},"name":{"type":"string"},"keywords":{"type":"string"},"description":{"type":"string"},"metaTitle":{"type":"string"},"packUnit":{"type":"string"},"packUnitPlural":{"type":"string"},"customFields":{"type":"object"},"calculatedPrice":{"type":"object"},"calculatedPrices":{"type":"array","items":{"additionalProperties":false}},"calculatedMaxPurchase":{"description":"Runtime field, cannot be used as part of the criteria.","type":"integer","format":"int64"},"calculatedCheapestPrice":{"type":"object"},"isNew":{"description":"Runtime field, cannot be used as part of the criteria.","type":"boolean"},"sortedProperties":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"},"relationships":{"properties":{"downloads":{"properties":{"links":{"type":"object","properties":{"related":{"type":"string","format":"uri-reference","example":"/product/018990e91e1173b198b4af2f7bb95398/downloads"}}},"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","example":"product_download"},"id":{"type":"string","example":"018990e91e12734b9f059d85b6265c7f"}}}}},"type":"object"},"parent":{"properties":{"links":{"type":"object","properties":{"related":{"type":"string","format":"uri-reference","example":"/product/018990e91e1173b198b4af2f7bb95398/parent"}}},"data":{"type":"object","properties":{"type":{"type":"string","example":"product"},"id":{"type":"string","pattern":"^[0-9a-f]{32}$","example":"018990e91e12734b9f059d85b6cb6fdf"}}}},"type":"object"},"children":{"properties":{"links":{"type":"object","properties":{"related":{"type":"string","format":"uri-reference","example":"/product/018990e91e1173b198b4af2f7bb95398/children"}}},"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","example":"product"},"id":{"type":"string","example":"018990e91e12734b9f059d85b72a13c2"}}}}},"type":"object"},"deliveryTime":{"properties":{"links":{"type":"object","properties":{"related":{"type":"string","format":"uri-reference","example":"/product/018990e91e1173b198b4af2f7bb95398/deliveryTime"}}},"data":{"type":"object","properties":{"type":{"type":"string","example":"delivery_time"},"id":{"type":"string","pattern":"^[0-9a-f]{32}$","example":"018990e91e12734b9f059d85b74af3f1"}}}},"type":"object"},"tax":{"properties":{"links":{"type":"object","properties":{"related":{"type":"string","format":"uri-reference","example":"/product/018990e91e1173b198b4af2f7bb95398/tax"}}},"data":{"type":"object","properties":{"type":{"type":"string","example":"tax"},"id":{"type":"string","pattern":"^[0-9a-f]{32}$","example":"018990e91e12734b9f059d85b80b74c2"}}}},"type":"object"},"manufacturer":{"properties":{"links":{"type":"object","properties":{"related":{"type":"string","format":"uri-reference","example":"/product/018990e91e1173b198b4af2f7bb95398/manufacturer"}}},"data":{"type":"object","properties":{"type":{"type":"string","example":"product_manufacturer"},"id":{"type":"string","pattern":"^[0-9a-f]{32}$","example":"018990e91e12734b9f059d85b8bd45e1"}}}},"type":"object"},"unit":{"properties":{"links":{"type":"object","properties":{"related":{"type":"string","format":"uri-reference","example":"/product/018990e91e1173b198b4af2f7bb95398/unit"}}},"data":{"type":"object","properties":{"type":{"type":"string","example":"unit"},"id":{"type":"string","pattern":"^[0-9a-f]{32}$","example":"018990e91e12734b9f059d85b8e6e0e7"}}}},"type":"object"},"cover":{"properties":{"links":{"type":"object","properties":{"related":{"type":"string","format":"uri-reference","example":"/product/018990e91e1173b198b4af2f7bb95398/cover"}}},"data":{"type":"object","properties":{"type":{"type":"string","example":"product_media"},"id":{"type":"string","pattern":"^[0-9a-f]{32}$","example":"018990e91e12734b9f059d85b9736220"}}}},"type":"object"},"cmsPage":{"properties":{"links":{"type":"object","properties":{"related":{"type":"string","format":"uri-reference","example":"/product/018990e91e1173b198b4af2f7bb95398/cmsPage"}}},"data":{"type":"object","properties":{"type":{"type":"string","example":"cms_page"},"id":{"type":"string","pattern":"^[0-9a-f]{32}$","example":"018990e91e12734b9f059d85ba0344c0"}}}},"type":"object"},"canonicalProduct":{"properties":{"links":{"type":"object","properties":{"related":{"type":"string","format":"uri-reference","example":"/product/018990e91e1173b198b4af2f7bb95398/canonicalProduct"}}},"data":{"type":"object","properties":{"type":{"type":"string","example":"product"},"id":{"type":"string","pattern":"^[0-9a-f]{32}$","example":"018990e91e12734b9f059d85ba5dab39"}}}},"type":"object"},"media":{"properties":{"links":{"type":"object","properties":{"related":{"type":"string","format":"uri-reference","example":"/product/018990e91e1173b198b4af2f7bb95398/media"}}},"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","example":"product_media"},"id":{"type":"string","example":"018990e91e12734b9f059d85ba97e2e0"}}}}},"type":"object"},"crossSellings":{"properties":{"links":{"type":"object","properties":{"related":{"type":"string","format":"uri-reference","example":"/product/018990e91e1173b198b4af2f7bb95398/crossSellings"}}},"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","example":"product_cross_selling"},"id":{"type":"string","example":"018990e91e12734b9f059d85bae1ceff"}}}}},"type":"object"},"configuratorSettings":{"properties":{"links":{"type":"object","properties":{"related":{"type":"string","format":"uri-reference","example":"/product/018990e91e1173b198b4af2f7bb95398/configuratorSettings"}}},"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","example":"product_configurator_setting"},"id":{"type":"string","example":"018990e91e12734b9f059d85bba1fcd3"}}}}},"type":"object"},"productReviews":{"properties":{"links":{"type":"object","properties":{"related":{"type":"string","format":"uri-reference","example":"/product/018990e91e1173b198b4af2f7bb95398/productReviews"}}},"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","example":"product_review"},"id":{"type":"string","example":"018990e91e12734b9f059d85bc581e7e"}}}}},"type":"object"},"mainCategories":{"properties":{"links":{"type":"object","properties":{"related":{"type":"string","format":"uri-reference","example":"/product/018990e91e1173b198b4af2f7bb95398/mainCategories"}}},"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","example":"main_category"},"id":{"type":"string","example":"018990e91e12734b9f059d85bd15ac09"}}}}},"type":"object"},"seoUrls":{"properties":{"links":{"type":"object","properties":{"related":{"type":"string","format":"uri-reference","example":"/product/018990e91e1173b198b4af2f7bb95398/seoUrls"}}},"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","example":"seo_url"},"id":{"type":"string","example":"018990e91e12734b9f059d85bd2f0e43"}}}}},"type":"object"},"options":{"properties":{"links":{"type":"object","properties":{"related":{"type":"string","format":"uri-reference","example":"/product/018990e91e1173b198b4af2f7bb95398/options"}}},"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","example":"property_group_option"},"id":{"type":"string","example":"018990e91e12734b9f059d85bd9ab5b5"}}}}},"type":"object"},"properties":{"properties":{"links":{"type":"object","properties":{"related":{"type":"string","format":"uri-reference","example":"/product/018990e91e1173b198b4af2f7bb95398/properties"}}},"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","example":"property_group_option"},"id":{"type":"string","example":"018990e91e12734b9f059d85be279242"}}}}},"type":"object"},"categories":{"properties":{"links":{"type":"object","properties":{"related":{"type":"string","format":"uri-reference","example":"/product/018990e91e1173b198b4af2f7bb95398/categories"}}},"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","example":"category"},"id":{"type":"string","example":"018990e91e12734b9f059d85be76c7a1"}}}}},"type":"object"},"streams":{"properties":{"links":{"type":"object","properties":{"related":{"type":"string","format":"uri-reference","example":"/product/018990e91e1173b198b4af2f7bb95398/streams"}}},"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","example":"product_stream"},"id":{"type":"string","example":"018990e91e12734b9f059d85bf3ae25b"}}}}},"type":"object"},"categoriesRo":{"properties":{"links":{"type":"object","properties":{"related":{"type":"string","format":"uri-reference","example":"/product/018990e91e1173b198b4af2f7bb95398/categoriesRo"}}},"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","example":"category"},"id":{"type":"string","example":"018990e91e12734b9f059d85bfa3bc2b"}}}}},"type":"object"},"seoCategory":{"properties":{"links":{"type":"object","properties":{"related":{"type":"string","format":"uri-reference","example":"/product/018990e91e1173b198b4af2f7bb95398/seoCategory"}}},"data":{"type":"object","properties":{"type":{"type":"string","example":"category"},"id":{"type":"string","pattern":"^[0-9a-f]{32}$","example":"018990e91e12734b9f059d85bff0bae2"}}}},"type":"object"}}}},"type":"object"}]},"Product":{"description":"Added since version: 6.0.0.0","required":["taxId","productNumber","stock","createdAt","name"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"versionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"parentId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"parentVersionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"manufacturerId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"productManufacturerVersionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"unitId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"taxId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"coverId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"productMediaVersionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"deliveryTimeId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"canonicalProductId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"cmsPageId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"cmsPageVersionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"productNumber":{"type":"string"},"stock":{"type":"integer","format":"int64"},"restockTime":{"type":"integer","format":"int64"},"active":{"type":"boolean"},"availableStock":{"type":"integer","format":"int64","readOnly":true},"available":{"type":"boolean","readOnly":true},"isCloseout":{"type":"boolean"},"displayGroup":{"type":"string","readOnly":true},"manufacturerNumber":{"type":"string"},"ean":{"type":"string"},"purchaseSteps":{"type":"integer","format":"int64"},"maxPurchase":{"type":"integer","format":"int64"},"minPurchase":{"type":"integer","format":"int64"},"purchaseUnit":{"type":"number","format":"float"},"referenceUnit":{"type":"number","format":"float"},"shippingFree":{"type":"boolean"},"markAsTopseller":{"type":"boolean"},"weight":{"type":"number","format":"float"},"width":{"type":"number","format":"float"},"height":{"type":"number","format":"float"},"length":{"type":"number","format":"float"},"releaseDate":{"type":"string","format":"date-time"},"ratingAverage":{"type":"number","format":"float","readOnly":true},"categoryTree":{"type":"array","items":{"type":"string","pattern":"^[0-9a-f]{32}$"},"readOnly":true},"propertyIds":{"type":"array","items":{"type":"string","pattern":"^[0-9a-f]{32}$"},"readOnly":true},"optionIds":{"type":"array","items":{"type":"string","pattern":"^[0-9a-f]{32}$"},"readOnly":true},"streamIds":{"type":"array","items":{"type":"string","pattern":"^[0-9a-f]{32}$"},"readOnly":true},"categoryIds":{"type":"array","items":{"type":"string","pattern":"^[0-9a-f]{32}$"},"readOnly":true},"childCount":{"type":"integer","format":"int64","readOnly":true},"sales":{"type":"integer","format":"int64","readOnly":true},"states":{"type":"array","items":{"type":"string"},"readOnly":true},"metaDescription":{"type":"string"},"name":{"type":"string"},"keywords":{"type":"string"},"description":{"type":"string"},"metaTitle":{"type":"string"},"packUnit":{"type":"string"},"packUnitPlural":{"type":"string"},"customFields":{"type":"object"},"calculatedPrice":{"type":"object"},"calculatedPrices":{"type":"array","items":{"additionalProperties":false}},"calculatedMaxPurchase":{"description":"Runtime field, cannot be used as part of the criteria.","type":"integer","format":"int64"},"calculatedCheapestPrice":{"type":"object"},"isNew":{"description":"Runtime field, cannot be used as part of the criteria.","type":"boolean"},"sortedProperties":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"},"downloads":{"$ref":"#/components/schemas/ProductDownload"},"parent":{"$ref":"#/components/schemas/Product"},"children":{"$ref":"#/components/schemas/Product"},"deliveryTime":{"$ref":"#/components/schemas/DeliveryTime"},"tax":{"$ref":"#/components/schemas/Tax"},"manufacturer":{"$ref":"#/components/schemas/ProductManufacturer"},"unit":{"$ref":"#/components/schemas/Unit"},"cover":{"$ref":"#/components/schemas/ProductMedia"},"cmsPage":{"$ref":"#/components/schemas/CmsPage"},"canonicalProduct":{"$ref":"#/components/schemas/Product"},"media":{"$ref":"#/components/schemas/ProductMedia"},"crossSellings":{"$ref":"#/components/schemas/ProductCrossSelling"},"configuratorSettings":{"$ref":"#/components/schemas/ProductConfiguratorSetting"},"productReviews":{"$ref":"#/components/schemas/ProductReview"},"mainCategories":{"$ref":"#/components/schemas/MainCategory"},"seoUrls":{"$ref":"#/components/schemas/SeoUrl"},"options":{"$ref":"#/components/schemas/PropertyGroupOption"},"properties":{"$ref":"#/components/schemas/PropertyGroupOption"},"categories":{"$ref":"#/components/schemas/Category"},"streams":{"$ref":"#/components/schemas/ProductStream"},"categoriesRo":{"$ref":"#/components/schemas/Category"},"seoCategory":{"$ref":"#/components/schemas/Category"}},"type":"object"},"ProductConfiguratorSetting":{"description":"Added since version: 6.0.0.0","required":["productId","optionId","createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"versionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"productId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"productVersionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"mediaId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"optionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"position":{"type":"integer","format":"int64"},"customFields":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"media":{"$ref":"#/components/schemas/Media"},"option":{"$ref":"#/components/schemas/PropertyGroupOption"}},"type":"object"},"ProductCrossSelling":{"description":"Added since version: 6.1.0.0","required":["name","position","type","createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"name":{"type":"string"},"position":{"type":"integer","format":"int64"},"sortBy":{"type":"string"},"sortDirection":{"type":"string"},"type":{"type":"string"},"active":{"type":"boolean"},"limit":{"type":"integer","format":"int64"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"}},"type":"object"},"ProductCrossSellingAssignedProducts":{"description":"Added since version: 6.2.0.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"ProductDownload":{"description":"Added since version: 6.4.19.0","required":["productId","mediaId","createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"versionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"productId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"productVersionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"mediaId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"position":{"type":"integer","format":"int64"},"customFields":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"product":{"$ref":"#/components/schemas/Product"},"media":{"$ref":"#/components/schemas/Media"}},"type":"object"},"ProductExport":{"description":"Added since version: 6.1.0.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"ProductFeatureSet":{"description":"Added since version: 6.3.0.0","required":["createdAt","name"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"}},"type":"object"},"ProductKeywordDictionary":{"description":"Added since version: 6.0.0.0","required":["languageId","keyword"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"languageId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"keyword":{"type":"string"}},"type":"object"},"ProductManufacturer":{"description":"Added since version: 6.0.0.0","required":["createdAt","name"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"versionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"mediaId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"link":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"customFields":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"},"media":{"$ref":"#/components/schemas/Media"}},"type":"object"},"ProductMedia":{"description":"Added since version: 6.0.0.0","required":["productId","mediaId","createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"versionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"productId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"productVersionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"mediaId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"position":{"type":"integer","format":"int64"},"customFields":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"media":{"$ref":"#/components/schemas/Media"}},"type":"object"},"ProductPrice":{"description":"Added since version: 6.0.0.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"ProductReview":{"description":"Added since version: 6.0.0.0","required":["productId","salesChannelId","languageId","title","content","createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"productId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"productVersionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"salesChannelId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"languageId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"title":{"type":"string"},"content":{"type":"string"},"points":{"type":"number","format":"float"},"status":{"type":"boolean"},"comment":{"type":"string"},"customFields":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"ProductSearchConfig":{"description":"Added since version: 6.3.5.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"ProductSearchConfigField":{"description":"Added since version: 6.3.5.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"ProductSearchKeyword":{"description":"Added since version: 6.0.0.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"ProductSorting":{"description":"Added since version: 6.3.2.0","required":["key","priority","createdAt","label"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"key":{"type":"string"},"priority":{"type":"integer","format":"int64"},"label":{"type":"string"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"}},"type":"object"},"ProductStream":{"description":"Added since version: 6.0.0.0","required":["createdAt","name"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"name":{"type":"string"},"description":{"type":"string"},"customFields":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"}},"type":"object"},"ProductStreamFilter":{"description":"Added since version: 6.0.0.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"ProductVisibility":{"description":"Added since version: 6.0.0.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"Promotion":{"description":"Added since version: 6.0.0.0","required":["createdAt","name"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"customFields":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"}},"type":"object"},"PromotionDiscount":{"description":"Added since version: 6.0.0.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"PromotionDiscountPrices":{"description":"Added since version: 6.0.0.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"PromotionIndividualCode":{"description":"Added since version: 6.0.0.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"PromotionSalesChannel":{"description":"Added since version: 6.0.0.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"PromotionSetgroup":{"description":"Added since version: 6.0.0.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"PropertyGroup":{"description":"Added since version: 6.0.0.0","required":["displayType","sortingType","createdAt","name"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"name":{"type":"string"},"description":{"type":"string"},"displayType":{"type":"string"},"sortingType":{"type":"string"},"filterable":{"type":"boolean"},"visibleOnProductDetailPage":{"type":"boolean"},"position":{"type":"integer","format":"int64"},"customFields":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"},"options":{"$ref":"#/components/schemas/PropertyGroupOption"}},"type":"object"},"PropertyGroupOption":{"description":"Added since version: 6.0.0.0","required":["groupId","createdAt","name"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"groupId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"name":{"type":"string"},"position":{"type":"integer","format":"int64"},"colorHexCode":{"type":"string"},"mediaId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"customFields":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"},"media":{"$ref":"#/components/schemas/Media"},"group":{"$ref":"#/components/schemas/PropertyGroup"}},"type":"object"},"Rule":{"description":"Added since version: 6.0.0.0","required":["name","createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"name":{"type":"string"},"description":{"type":"string"},"customFields":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"RuleCondition":{"description":"Added since version: 6.0.0.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"SalesChannel":{"description":"Added since version: 6.0.0.0","required":["languageId","customerGroupId","currencyId","paymentMethodId","shippingMethodId","countryId","navigationCategoryId","createdAt","name","homeEnabled"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"languageId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"customerGroupId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"currencyId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"paymentMethodId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"shippingMethodId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"countryId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"navigationCategoryId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"navigationCategoryVersionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"navigationCategoryDepth":{"type":"integer","format":"int64"},"footerCategoryId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"footerCategoryVersionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"serviceCategoryId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"serviceCategoryVersionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"mailHeaderFooterId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"hreflangDefaultDomainId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"name":{"type":"string"},"shortName":{"type":"string"},"taxCalculationType":{"type":"string"},"configuration":{"type":"object"},"active":{"type":"boolean"},"hreflangActive":{"type":"boolean"},"maintenance":{"type":"boolean"},"customFields":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"},"language":{"$ref":"#/components/schemas/Language"},"currency":{"$ref":"#/components/schemas/Currency"},"paymentMethod":{"$ref":"#/components/schemas/PaymentMethod"},"shippingMethod":{"$ref":"#/components/schemas/ShippingMethod"},"country":{"$ref":"#/components/schemas/Country"},"domains":{"$ref":"#/components/schemas/SalesChannelDomain"},"navigationCategory":{"$ref":"#/components/schemas/Category"},"footerCategory":{"$ref":"#/components/schemas/Category"},"serviceCategory":{"$ref":"#/components/schemas/Category"},"hreflangDefaultDomain":{"$ref":"#/components/schemas/SalesChannelDomain"}},"type":"object"},"SalesChannelAnalytics":{"description":"Added since version: 6.2.0.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"SalesChannelDomain":{"description":"Added since version: 6.0.0.0","required":["url","salesChannelId","languageId","currencyId","snippetSetId","createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"url":{"type":"string"},"salesChannelId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"languageId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"currencyId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"snippetSetId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"hreflangUseOnlyLocale":{"type":"boolean"},"customFields":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"language":{"$ref":"#/components/schemas/Language"},"currency":{"$ref":"#/components/schemas/Currency"},"salesChannelDefaultHreflang":{"$ref":"#/components/schemas/SalesChannel"}},"type":"object"},"SalesChannelType":{"description":"Added since version: 6.0.0.0","required":["createdAt","name"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"}},"type":"object"},"SalutationJsonApi":{"description":"Added since version: 6.0.0.0","allOf":[{"$ref":"#/components/schemas/resource"},{"required":["salutationKey","createdAt","displayName","letterName"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"salutationKey":{"type":"string"},"displayName":{"type":"string"},"letterName":{"type":"string"},"customFields":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"}},"type":"object"}]},"Salutation":{"description":"Added since version: 6.0.0.0","required":["salutationKey","createdAt","displayName","letterName"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"salutationKey":{"type":"string"},"displayName":{"type":"string"},"letterName":{"type":"string"},"customFields":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"}},"type":"object"},"ScheduledTask":{"description":"Added since version: 6.0.0.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"Script":{"description":"Added since version: 6.4.7.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"SeoUrlJsonApi":{"description":"Added since version: 6.0.0.0","allOf":[{"$ref":"#/components/schemas/resource"},{"required":["languageId","foreignKey","routeName","pathInfo","seoPathInfo","createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"salesChannelId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"languageId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"foreignKey":{"type":"string","pattern":"^[0-9a-f]{32}$"},"routeName":{"type":"string"},"pathInfo":{"type":"string"},"seoPathInfo":{"type":"string"},"isCanonical":{"type":"boolean"},"isModified":{"type":"boolean"},"isDeleted":{"type":"boolean"},"url":{"description":"Runtime field, cannot be used as part of the criteria.","type":"string"},"customFields":{"type":"object"},"isValid":{"description":"Runtime field, cannot be used as part of the criteria.","type":"boolean"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"}]},"SeoUrl":{"description":"Added since version: 6.0.0.0","required":["languageId","foreignKey","routeName","pathInfo","seoPathInfo","createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"salesChannelId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"languageId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"foreignKey":{"type":"string","pattern":"^[0-9a-f]{32}$"},"routeName":{"type":"string"},"pathInfo":{"type":"string"},"seoPathInfo":{"type":"string"},"isCanonical":{"type":"boolean"},"isModified":{"type":"boolean"},"isDeleted":{"type":"boolean"},"url":{"description":"Runtime field, cannot be used as part of the criteria.","type":"string"},"customFields":{"type":"object"},"isValid":{"description":"Runtime field, cannot be used as part of the criteria.","type":"boolean"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"SeoUrlTemplate":{"description":"Added since version: 6.0.0.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"salesChannelId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"isValid":{"type":"boolean"},"customFields":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"ShippingMethodJsonApi":{"description":"Added since version: 6.0.0.0","allOf":[{"$ref":"#/components/schemas/resource"},{"required":["deliveryTimeId","taxType","createdAt","name"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"name":{"type":"string"},"active":{"type":"boolean"},"position":{"type":"integer","format":"int64"},"customFields":{"type":"object"},"mediaId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"deliveryTimeId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"taxType":{"type":"string"},"description":{"type":"string"},"trackingUrl":{"type":"string"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"},"relationships":{"properties":{"deliveryTime":{"properties":{"links":{"type":"object","properties":{"related":{"type":"string","format":"uri-reference","example":"/shipping-method/018990e91e1872f7942def8fcd720666/deliveryTime"}}},"data":{"type":"object","properties":{"type":{"type":"string","example":"delivery_time"},"id":{"type":"string","pattern":"^[0-9a-f]{32}$","example":"018990e91e1872f7942def8fce1c97f1"}}}},"type":"object"},"availabilityRule":{"properties":{"links":{"type":"object","properties":{"related":{"type":"string","format":"uri-reference","example":"/shipping-method/018990e91e1872f7942def8fcd720666/availabilityRule"}}},"data":{"type":"object","properties":{"type":{"type":"string","example":"rule"},"id":{"type":"string","pattern":"^[0-9a-f]{32}$","example":"018990e91e1872f7942def8fcec3f8ea"}}}},"type":"object"},"prices":{"properties":{"links":{"type":"object","properties":{"related":{"type":"string","format":"uri-reference","example":"/shipping-method/018990e91e1872f7942def8fcd720666/prices"}}},"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","example":"shipping_method_price"},"id":{"type":"string","example":"018990e91e1872f7942def8fcf336969"}}}}},"type":"object"},"media":{"properties":{"links":{"type":"object","properties":{"related":{"type":"string","format":"uri-reference","example":"/shipping-method/018990e91e1872f7942def8fcd720666/media"}}},"data":{"type":"object","properties":{"type":{"type":"string","example":"media"},"id":{"type":"string","pattern":"^[0-9a-f]{32}$","example":"018990e91e1872f7942def8fd0073eaf"}}}},"type":"object"},"tags":{"properties":{"links":{"type":"object","properties":{"related":{"type":"string","format":"uri-reference","example":"/shipping-method/018990e91e1872f7942def8fcd720666/tags"}}},"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","example":"tag"},"id":{"type":"string","example":"018990e91e1872f7942def8fd010fcff"}}}}},"type":"object"},"tax":{"properties":{"links":{"type":"object","properties":{"related":{"type":"string","format":"uri-reference","example":"/shipping-method/018990e91e1872f7942def8fcd720666/tax"}}},"data":{"type":"object","properties":{"type":{"type":"string","example":"tax"},"id":{"type":"string","pattern":"^[0-9a-f]{32}$","example":"018990e91e1872f7942def8fd037a4aa"}}}},"type":"object"}}}},"type":"object"}]},"ShippingMethod":{"description":"Added since version: 6.0.0.0","required":["deliveryTimeId","taxType","createdAt","name"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"name":{"type":"string"},"active":{"type":"boolean"},"position":{"type":"integer","format":"int64"},"customFields":{"type":"object"},"mediaId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"deliveryTimeId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"taxType":{"type":"string"},"description":{"type":"string"},"trackingUrl":{"type":"string"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"},"deliveryTime":{"$ref":"#/components/schemas/DeliveryTime"},"availabilityRule":{"$ref":"#/components/schemas/Rule"},"prices":{"$ref":"#/components/schemas/ShippingMethodPrice"},"media":{"$ref":"#/components/schemas/Media"},"tags":{"$ref":"#/components/schemas/Tag"},"tax":{"$ref":"#/components/schemas/Tax"}},"type":"object"},"ShippingMethodPrice":{"description":"Added since version: 6.0.0.0","required":["shippingMethodId","createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"shippingMethodId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"ruleId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"calculation":{"type":"integer","format":"int64"},"calculationRuleId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"quantityStart":{"type":"number","format":"float"},"quantityEnd":{"type":"number","format":"float"},"currencyPrice":{"type":"object"},"customFields":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"Snippet":{"description":"Added since version: 6.0.0.0","required":["setId","translationKey","value","createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"setId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"translationKey":{"type":"string"},"value":{"type":"string"},"customFields":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"SnippetSet":{"description":"Added since version: 6.0.0.0","required":["name","iso","createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"name":{"type":"string"},"iso":{"type":"string"},"customFields":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"snippets":{"$ref":"#/components/schemas/Snippet"}},"type":"object"},"StateMachine":{"description":"Added since version: 6.0.0.0","required":["createdAt","name"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"},"states":{"$ref":"#/components/schemas/StateMachineState"},"transitions":{"$ref":"#/components/schemas/StateMachineTransition"}},"type":"object"},"StateMachineHistory":{"description":"Added since version: 6.0.0.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"fromStateMachineState":{"$ref":"#/components/schemas/StateMachineState"},"toStateMachineState":{"$ref":"#/components/schemas/StateMachineState"}},"type":"object"},"StateMachineState":{"description":"Added since version: 6.0.0.0","required":["technicalName","createdAt","name"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"technicalName":{"type":"string"},"name":{"type":"string"},"customFields":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"}},"type":"object"},"StateMachineTransition":{"description":"Added since version: 6.0.0.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"SystemConfig":{"description":"Added since version: 6.0.0.0","required":["configurationKey","configurationValue","createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"configurationKey":{"type":"string"},"configurationValue":{"properties":{"_value":{"type":"object"}},"type":"object"},"salesChannelId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"salesChannel":{"$ref":"#/components/schemas/SalesChannel"}},"type":"object"},"Tag":{"description":"Added since version: 6.0.0.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"Tax":{"description":"Added since version: 6.0.0.0","required":["taxRate","name","position","createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"taxRate":{"type":"number","format":"float"},"name":{"type":"string"},"position":{"description":"Added since version: 6.4.0.0.","type":"integer","format":"int64"},"customFields":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"TaxProvider":{"description":"Added since version: 6.5.0.0","required":["priority","createdAt","name"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"active":{"type":"boolean"},"name":{"type":"string"},"priority":{"type":"integer","format":"int64"},"processUrl":{"type":"string"},"appId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"customFields":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"}},"type":"object"},"TaxRule":{"description":"Added since version: 6.1.0.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"TaxRuleType":{"description":"Added since version: 6.1.0.0","required":["createdAt","typeName"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"}},"type":"object"},"Theme":{"description":"Added since version: 6.0.0.0","required":["name","author","active","createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"technicalName":{"type":"string"},"name":{"type":"string"},"author":{"type":"string"},"description":{"type":"string"},"labels":{"type":"object"},"helpTexts":{"type":"object"},"customFields":{"type":"object"},"previewMediaId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"parentThemeId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"baseConfig":{"type":"object"},"configValues":{"type":"object"},"active":{"type":"boolean"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"},"media":{"$ref":"#/components/schemas/Media"}},"type":"object"},"Unit":{"description":"Added since version: 6.0.0.0","required":["createdAt","shortCode","name"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"shortCode":{"type":"string"},"name":{"type":"string"},"customFields":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"}},"type":"object"},"User":{"description":"Added since version: 6.0.0.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"UserAccessKey":{"description":"Added since version: 6.0.0.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"UserConfig":{"description":"Added since version: 6.3.5.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"UserRecovery":{"description":"Added since version: 6.0.0.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"Webhook":{"description":"Added since version: 6.3.1.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"WebhookEventLog":{"description":"Added since version: 6.4.1.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"AccountNewsletterRecipientResult":{"allOf":[{"$ref":"#/components/schemas/Struct"},{"type":"object","properties":{"status":{"type":"string"}}}]},"ArrayStruct":{"$ref":"#/components/schemas/Struct"},"Cart":{"allOf":[{"$ref":"#/components/schemas/ArrayStruct"},{"type":"object","properties":{"name":{"description":"Name of the cart - for example `guest-cart`","type":"string"},"token":{"description":"Context token identifying the cart and the user session","type":"string"},"price":{"type":"object","properties":{"netPrice":{"description":"Net price of the cart","type":"number","format":"float"},"totalPrice":{"description":"Total price of the cart, including shipping costs, discounts and taxes","type":"number","format":"float"},"positionPrice":{"description":"Price for all line items in the cart","type":"number","format":"float"},"taxStatus":{"description":"Tax calculation for the cart. One of `gross`, `net` or `tax-free`","type":"string"}}},"lineItems":{"description":"All items within the cart","type":"array","items":{"$ref":"#/components/schemas/LineItem"}},"errors":{"type":"array","description":"A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.","items":{"type":"object","properties":{"key":{"type":"string"},"level":{"type":"string"},"message":{"type":"string"}}}},"transactions":{"description":"A list of all payment transactions associated with the current cart.","type":"array","items":{"type":"object","properties":{"paymentMethodId":{"type":"string"}}}},"modified":{"type":"boolean"},"customerComment":{"type":"string","description":"A comment that can be added to the cart."},"affiliateCode":{"type":"string","description":"An affiliate tracking code"},"campaignCode":{"type":"string","description":"A campaign tracking code"}}}]},"CartItems":{"allOf":[{"$ref":"#/components/schemas/ArrayStruct"},{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/LineItem"}}}}]},"Criteria":{"type":"object","description":"Search parameters. For more information, see our documentation on [Search Queries](https://shopware.stoplight.io/docs/store-api/docs/concepts/search-queries.md#structure)","properties":{"page":{"description":"Search result page","type":"integer"},"limit":{"description":"Number of items per result page","type":"integer"},"filter":{"type":"array","description":"List of filters to restrict the search result. For more information, see [Search Queries > Filter](https://shopware.stoplight.io/docs/store-api/docs/concepts/search-queries.md#filter)","items":{"type":"object","properties":{"type":{"type":"string"},"field":{"type":"string"},"value":{"type":"string"}},"required":["type","field","value"]}},"sort":{"type":"array","description":"Sorting in the search result.","items":{"type":"object","properties":{"field":{"type":"string"},"order":{"type":"string"},"naturalSorting":{"type":"boolean"}},"required":["field"]}},"post-filter":{"type":"array","description":"Filters that applied without affecting aggregations. For more information, see [Search Queries > Post Filter](https://shopware.stoplight.io/docs/store-api/docs/concepts/search-queries.md#post-filter)","items":{"type":"object","properties":{"type":{"type":"string"},"field":{"type":"string"},"value":{"type":"string"}},"required":["type","field","value"]}},"associations":{"type":"object","description":"Used to fetch associations which are not fetched by default."},"aggregations":{"type":"array","description":"Used to perform aggregations on the search result. For more information, see [Search Queries > Aggregations](https://shopware.stoplight.io/docs/store-api/docs/concepts/search-queries.md#aggregations)","items":{"type":"object","properties":{"name":{"description":"Give your aggregation an identifier, so you can find it easier","type":"string"},"type":{"description":"The type of aggregation","type":"string"},"field":{"description":"The field you want to aggregate over.","type":"string"}},"required":["name","type","field"]}},"grouping":{"type":"array","description":"Perform groupings over certain fields","items":{"type":"string","description":"Name of a field"}},"fields":{"type":"array","description":"Fields which should be returned in the search result.","items":{"type":"string","description":"Name of a field"}},"total-count-mode":{"description":"Whether the total for the total number of hits should be determined for the search query. 0 = disabled total count, 1 = calculate exact total amount (slow), 2 = calculate only for next page (fast)","type":"integer","default":0,"enum":[0,1,2]}}},"CrossSellingElementCollection":{"type":"array","items":{"type":"object","properties":{"crossSelling":{"type":"object","properties":{"name":{"type":"string"},"position":{"type":"integer","format":"int32"},"sortBy":{"type":"string"},"sortDirection":{"type":"string"},"limit":{"type":"integer","format":"int32"},"active":{"type":"boolean"},"productId":{"type":"string"},"productStreamId":{"type":"string"},"type":{"type":"string"}}},"products":{"type":"array","items":{"$ref":"#/components/schemas/Product"}},"total":{"type":"integer","format":"int32"}}}},"EntitySearchResult":{"allOf":[{"$ref":"#/components/schemas/ArrayStruct"},{"type":"object","properties":{"entity":{"type":"string"},"total":{"type":"integer","description":"The total number of found entities"},"aggregations":{"type":"array","description":"Contains aggregated data. A simple example is the determination of the average price from a product search query.","items":{"type":"object"}},"page":{"type":"integer","description":"The actual page. This can be used for pagination."},"limit":{"type":"integer","description":"The actual limit. This is used for pagination and goes together with the page."}}}]},"FindProductVariantRouteResponse":{"type":"object","properties":{"foundCombination":{"type":"object","properties":{"variantId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"options":{"type":"array","items":{"type":"string"}}}}}},"LineItem":{"type":"object","properties":{"id":{"type":"string"},"referencedId":{"type":"string"},"label":{"type":"string"},"quantity":{"type":"integer","format":"int32"},"type":{"type":"string"},"good":{"type":"boolean"},"description":{"type":"string"},"removable":{"type":"boolean"},"stackable":{"type":"boolean"},"modified":{"type":"boolean"}}},"NavigationRouteResponse":{"type":"array","items":{"$ref":"#/components/schemas/Category"}},"OrderRouteResponse":{"type":"object","properties":{"orders":{"type":"object","items":{"$ref":"#/components/schemas/Order"}},"paymentChangeable":{"type":"object","description":"The key-value pairs contain the uuid of the order as key and a boolean as value, indicating that the payment method can still be changed.","additionalProperties":{"type":"boolean"}}}},"ProductDetailResponse":{"type":"object","description":"Represents a product along with detailed information required to display a variant selection.","properties":{"product":{"$ref":"#/components/schemas/Product"},"configurator":{"type":"array","description":"List of property groups with their corresponding options and information on how to display them.","items":{"$ref":"#/components/schemas/PropertyGroup"}}}},"ProductListingCriteria":{"allOf":[{"$ref":"#/components/schemas/Criteria"},{"type":"object","description":"Additional search parameters for product listings","properties":{"order":{"description":"Specifies the sorting of the products by `availableSortings`. If not set, the default sorting will be set according to the shop settings. The available sorting options are sent within the response under the `availableSortings` key. In order to sort by a field, consider using the `sort` parameter from the listing criteria. Do not use both parameters together, as it might lead to unexpected results.","type":"string"},"limit":{"description":"Number of items per result page. If not set, the limit will be set according to the default products per page, defined in the system settings.","type":"integer","minimum":0},"p":{"description":"Search result page","type":"integer","default":1},"manufacturer":{"description":"Filter by manufacturers. List of manufacturer identifiers separated by a `|`.","type":"string"},"min-price":{"description":"Filters by a minimum product price. Has to be lower than the `max-price` filter.","type":"integer","minimum":0,"default":0},"max-price":{"description":"Filters by a maximum product price. Has to be higher than the `min-price` filter.","type":"integer","minimum":0,"default":0},"rating":{"description":"Filter products with a minimum average rating.","type":"integer"},"shipping-free":{"description":"Filters products that are marked as shipping-free.","type":"boolean","default":false},"properties":{"description":"Filters products by their properties. List of property identifiers separated by a `|`.","type":"string"},"manufacturer-filter":{"description":"Enables/disabled filtering by manufacturer. If set to false, the `manufacturer` filter will be ignored. Also the `aggregations[manufacturer]` key will be removed from the response.","type":"boolean","default":true},"price-filter":{"description":"Enables/disabled filtering by price. If set to false, the `min-price` and `max-price` filter will be ignored. Also the `aggregations[price]` key will be removed from the response.","type":"boolean","default":true},"rating-filter":{"description":"Enables/disabled filtering by rating. If set to false, the `rating` filter will be ignored. Also the `aggregations[rating]` key will be removed from the response.","type":"boolean","default":true},"shipping-free-filter":{"description":"Enables/disabled filtering by shipping-free products. If set to false, the `shipping-free` filter will be ignored. Also the `aggregations[shipping-free]` key will be removed from the response.","type":"boolean","default":true},"property-filter":{"description":"Enables/disabled filtering by properties products. If set to false, the `properties` filter will be ignored. Also the `aggregations[properties]` key will be removed from the response.","type":"boolean","default":true},"property-whitelist":{"description":"A whitelist of property identifiers which can be used for filtering. List of property identifiers separated by a `|`. The `property-filter` must be `true`, otherwise the whitelist has no effect.","type":"string"},"reduce-aggregations":{"description":"By sending the parameter `reduce-aggregations` , the post-filters that were applied by the customer, are also applied to the aggregations. This has the consequence that only values are returned in the aggregations that would lead to further filter results. This parameter is a flag, the value has no effect.","type":"string","nullable":true}}}]},"ProductListingFlags":{"type":"object","description":"Additional flags for product listings","properties":{"no-aggregations":{"description":"Resets all aggregations in the criteria. This parameter is a flag, the value has no effect.","type":"string","nullable":true},"only-aggregations":{"description":"If this flag is set, no products are fetched. Sorting and associations are also ignored. This parameter is a flag, the value has no effect.","type":"string","nullable":true}}},"ProductListingResult":{"allOf":[{"$ref":"#/components/schemas/EntitySearchResult"},{"type":"object","properties":{"currentFilters":{"type":"object","description":"Contains the state of the filters. These can be used to create listing filters.","properties":{"navigationId":{"type":"string"},"manufacturer":{"type":"array","items":{"type":"object"}},"price":{"type":"object","properties":{"min":{"type":"integer"},"max":{"type":"integer"}}},"rating":{"type":"integer"},"shipping-free":{"type":"boolean"},"properties":{"type":"array","items":{"type":"object"}}}},"availableSortings":{"type":"array","description":"Contains the available sorting. These can be used to show a sorting select-box in the product listing.","items":{"type":"object"}},"sorting":{"type":"string"},"elements":{"type":"array","items":{"$ref":"#/components/schemas/Product"}}}}]},"SalesChannelContext":{"allOf":[{"$ref":"#/components/schemas/ArrayStruct"},{"type":"object","properties":{"token":{"description":"Context the user session","type":"string"},"currentCustomerGroup":{"type":"object","description":"Customer group of the current user","properties":{"name":{"type":"string"},"displayGross":{"type":"boolean"}}},"fallbackCustomerGroup":{"description":"Fallback group if the default customer group is not applicable","type":"object","properties":{"name":{"type":"string"},"displayGross":{"type":"boolean"}}},"currency":{"type":"object","description":"Currency associated with the current user","properties":{"isoCode":{"type":"string"},"factor":{"type":"integer"},"symbol":{"type":"string"},"shortName":{"type":"string"},"name":{"type":"string"},"position":{"type":"integer","format":"int32"},"decimalPrecision":{"type":"integer","format":"int32"},"isSystemDefault":{"type":"boolean"}}},"salesChannel":{"description":"Information about the current sales channel","type":"object","properties":{"typeId":{"type":"string"},"languageId":{"type":"string"},"currencyId":{"type":"string"},"paymentMethodId":{"type":"string"},"shippingMethodId":{"type":"string"},"countryId":{"type":"string"},"navigationCategoryId":{"type":"string"},"navigationCategoryDepth":{"type":"integer","format":"int32"},"footerCategoryId":{"type":"string"},"serviceCategoryId":{"type":"string"},"name":{"type":"string"},"shortName":{"type":"string"},"accessKey":{"type":"string"},"active":{"type":"boolean"},"maintenance":{"type":"boolean"},"maintenanceIpWhitelist":{"type":"string"},"mailHeaderFooterId":{"type":"string"},"customerGroupId":{"type":"string"},"hreflangActive":{"type":"boolean"},"hreflangDefaultDomainId":{"type":"string"},"analyticsId":{"type":"string"}}},"taxRules":{"type":"array","description":"Currently active tax rules and/or rates","items":{"type":"object","properties":{"taxRate":{"type":"number","format":"float"},"name":{"type":"string"}}}},"customer":{"type":"object","description":"Information about the current customer - `null` if the customer is not logged in","properties":{"groupId":{"type":"string"},"defaultPaymentMethodId":{"type":"string"},"salesChannelId":{"type":"string"},"languageId":{"type":"string"},"lastPaymentMethodId":{"type":"string"},"defaultBillingAddressId":{"type":"string"},"defaultShippingAddressId":{"type":"string"},"customerNumber":{"type":"string"},"salutationId":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"company":{"type":"string"},"password":{"type":"string"},"email":{"type":"string"},"title":{"type":"string"},"affiliateCode":{"type":"string"},"campaignCode":{"type":"string"},"active":{"type":"boolean"},"doubleOptInRegistration":{"type":"boolean"},"doubleOptInEmailSentDate":{"type":"string","format":"date-time"},"doubleOptInConfirmDate":{"type":"string","format":"date-time"},"hash":{"type":"string"},"guest":{"type":"boolean"},"firstLogin":{"type":"string","format":"date-time"},"lastLogin":{"type":"string","format":"date-time"},"newsletter":{"type":"boolean"},"birthday":{"type":"string","format":"date-time"},"lastOrderDate":{"type":"string","format":"date-time"},"orderCount":{"type":"integer","format":"int32"},"legacyEncoder":{"type":"string"},"legacyPassword":{"type":"string"},"autoIncrement":{"type":"integer","format":"int32"},"remoteAddress":{"type":"string"}}},"paymentMethod":{"type":"object","description":"Selected payment method","properties":{"pluginId":{"type":"string"},"handlerIdentifier":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"position":{"type":"integer","format":"int32"},"active":{"type":"boolean"},"availabilityRuleId":{"type":"string"},"mediaId":{"type":"string"},"formattedHandlerIdentifier":{"type":"string"}}},"shippingMethod":{"type":"object","description":"Selected shipping method","properties":{"name":{"type":"string"},"active":{"type":"boolean"},"description":{"type":"string"},"trackingUrl":{"type":"string"},"deliveryTimeId":{"type":"string"},"availabilityRuleId":{"type":"string"},"mediaId":{"type":"string"}}},"context":{"description":"Core context with general configuration values and state","type":"object","properties":{"versionId":{"type":"string"},"currencyId":{"type":"string"},"currencyFactor":{"type":"integer"},"currencyPrecision":{"type":"integer","format":"int32"},"scope":{"type":"string"},"source":{"type":"string"},"taxState":{"type":"string"},"useCache":{"type":"boolean"}}}}}]},"ShippingMethodPageRouteResponse":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"active":{"type":"boolean"},"description":{"type":"string"},"deliveryTimeId":{"type":"string"},"deliveryTime":{"type":"object","properties":{"name":{"type":"string"},"min":{"type":"integer","format":"int32"},"max":{"type":"integer","format":"int32"},"unit":{"type":"string"}}},"translations":{"type":"array","items":{"type":"object","properties":{"shippingMethodId":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"}}}},"orderDeliveries":{"type":"array","items":{"type":"object","properties":{"orderId":{"type":"string"},"shippingOrderAddressId":{"type":"string"},"shippingMethodId":{"type":"string"},"shippingDateEarliest":{"type":"string","format":"date-time"},"shippingDateLatest":{"type":"string","format":"date-time"},"stateId":{"type":"string"}}}},"salesChannelDefaultAssignments":{"type":"array","items":{"type":"object","properties":{"typeId":{"type":"string"},"languageId":{"type":"string"},"currencyId":{"type":"string"},"paymentMethodId":{"type":"string"},"shippingMethodId":{"type":"string"},"countryId":{"type":"string"},"navigationCategoryId":{"type":"string"},"navigationCategoryDepth":{"type":"integer","format":"int32"},"footerCategoryId":{"type":"string"},"serviceCategoryId":{"type":"string"},"name":{"type":"string"},"shortName":{"type":"string"},"accessKey":{"type":"string"},"active":{"type":"boolean"},"maintenance":{"type":"boolean"},"maintenanceIpWhitelist":{"type":"string"},"mailHeaderFooterId":{"type":"string"},"customerGroupId":{"type":"string"},"hreflangActive":{"type":"boolean"},"hreflangDefaultDomainId":{"type":"string"}}}},"salesChannels":{"type":"array","items":{"type":"object","properties":{"typeId":{"type":"string"},"languageId":{"type":"string"},"currencyId":{"type":"string"},"paymentMethodId":{"type":"string"},"shippingMethodId":{"type":"string"},"countryId":{"type":"string"},"navigationCategoryId":{"type":"string"},"navigationCategoryDepth":{"type":"integer","format":"int32"},"footerCategoryId":{"type":"string"},"serviceCategoryId":{"type":"string"},"name":{"type":"string"},"shortName":{"type":"string"},"accessKey":{"type":"string"},"active":{"type":"boolean"},"maintenance":{"type":"boolean"},"maintenanceIpWhitelist":{"type":"string"},"mailHeaderFooterId":{"type":"string"},"customerGroupId":{"type":"string"},"hreflangActive":{"type":"boolean"},"hreflangDefaultDomainId":{"type":"string"}}}},"availabilityRule":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"priority":{"type":"integer","format":"int32"},"invalid":{"type":"boolean"}}},"availabilityRuleId":{"type":"string"},"prices":{"type":"array","items":{"type":"object","properties":{"shippingMethodId":{"type":"string"},"currencyId":{"type":"string"},"ruleId":{"type":"string"},"calculation":{"type":"integer","format":"int32"},"quantityStart":{"type":"number","format":"float"},"quantityEnd":{"type":"number","format":"float"},"price":{"type":"number","format":"float"},"calculationRuleId":{"type":"string"}}}},"mediaId":{"type":"string"},"media":{"type":"object","properties":{"userId":{"type":"string"},"mimeType":{"type":"string"},"fileExtension":{"type":"string"},"fileSize":{"type":"integer","format":"int32"},"title":{"type":"string"},"metaDataRaw":{"type":"string"},"mediaTypeRaw":{"type":"string"},"uploadedAt":{"type":"string","format":"date-time"},"alt":{"type":"string"},"url":{"type":"string"},"fileName":{"type":"string"},"mediaFolderId":{"type":"string"},"private":{"type":"boolean"},"thumbnailsRo":{"type":"string"}}},"tags":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"}}}}}}},"Sitemap":{"allOf":[{"$ref":"#/components/schemas/ArrayStruct"},{"type":"object","properties":{"filename":{"type":"string"},"created":{"type":"string","format":"date-time"}}}]},"Struct":{"type":"object","properties":{"apiAlias":{"type":"string","description":"Alias which can be used to restrict response fields. For more information see [includes](https://shopware.stoplight.io/docs/store-api/docs/concepts/search-queries.md#includes-apialias)."}}},"SuccessResponse":{"type":"object","properties":{"success":{"type":"boolean"}}},"WishlistLoadRouteResponse":{"type":"object","properties":{"wishlist":{"type":"object","properties":{"customerId":{"type":"string"},"salesChannelId":{"type":"string"}}},"products":{"type":"array","items":{"$ref":"#/components/schemas/ProductListingResult"}}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/failure"},"example":{"errors":[{"status":"400","title":"Bad Request","description":"Bad parameters for this endpoint. See documentation for the correct ones."}]}},"application/json":{"schema":{"$ref":"#/components/schemas/failure"},"example":{"errors":[{"status":"400","title":"Bad Request","description":"Bad parameters for this endpoint. See documentation for the correct ones."}]}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/failure"},"example":{"errors":[{"status":"401","title":"Unauthorized","description":"Authorization information is missing or invalid."}]}},"application/json":{"schema":{"$ref":"#/components/schemas/failure"},"example":{"errors":[{"status":"401","title":"Unauthorized","description":"Authorization information is missing or invalid."}]}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/failure"},"example":{"errors":[{"status":"403","title":"Forbidden","description":"This operation is restricted to logged in users."}]}},"application/json":{"schema":{"$ref":"#/components/schemas/failure"},"example":{"errors":[{"status":"403","title":"Forbidden","description":"This operation is restricted to logged in users."}]}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/failure"},"example":{"errors":[{"status":"404","title":"Not Found","description":"Resource with given parameter was not found."}]}},"application/json":{"schema":{"$ref":"#/components/schemas/failure"},"example":{"errors":[{"status":"404","title":"Not Found","description":"Resource with given parameter was not found."}]}}}},"ContextTokenResponse":{"type":"object","properties":{"contextToken":{"description":"Context token identifying the current user session.","type":"string"}}}},"parameters":{"contentType":{"name":"Content-Type","in":"header","description":"Content type of the request","required":true,"schema":{"type":"string","default":"application/json"}},"accept":{"name":"Accept","in":"header","description":"Accepted response content types","required":true,"schema":{"type":"string","default":"application/json"}}},"securitySchemes":{"ApiKey":{"type":"apiKey","description":"Identifies the sales channel you want to access the API through","name":"sw-access-key","in":"header"},"ContextToken":{"type":"apiKey","description":"Identifies an anonymous or identified user session","name":"sw-context-token","in":"header"}}},"security":[{"ApiKey":[]}],"paths":{"/account/newsletter-recipient":{"post":{"tags":["Profile","Newsletter","Endpoints supporting Criteria "],"summary":"Fetch newsletter recipients","description":"Perform a filtered search for newsletter recipients.","operationId":"readNewsletterRecipient","parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Criteria"}]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/AccountNewsletterRecipientResult"}}}}}},"security":[{"ApiKey":[]}]}},"/account/change-profile":{"post":{"tags":["Profile"],"summary":"Change the customer's information","description":"Make changes to a customer's account, like changing their name, salutation or title.","operationId":"changeProfile","requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["salutationId","firstName","lastName"],"properties":{"salutationId":{"description":"Id of the salutation for the customer account. Fetch options using `salutation` endpoint.","type":"string"},"title":{"description":"(Academic) title of the customer","type":"string"},"firstName":{"description":"Customer first name. Value will be reused for shipping and billing address if not provided explicitly.","type":"string"},"lastName":{"description":"Customer last name. Value will be reused for shipping and billing address if not provided explicitly.","type":"string"},"company":{"description":"Company of the customer. Only required when `accountType` is `business`.","type":"string"},"birthdayDay":{"description":"Birthday day","type":"integer"},"birthdayMonth":{"description":"Birthday month","type":"integer"},"birthdayYear":{"description":"Birthday year","type":"integer"}},"type":"object"}}}},"responses":{"200":{"description":"Returns a success response indicating a successful update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}}},"security":[{"ApiKey":[]}]}},"/account/change-email":{"post":{"tags":["Profile"],"summary":"Change the customer's email address","description":"Changes a customer's email address to a new email address, using their current password as a validation.","operationId":"changeEmail","requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["email","emailConfirmation","password"],"properties":{"email":{"description":"New email address. Has to be unique amongst all customers","type":"string"},"emailConfirmation":{"description":"Confirmation of the new email address.","type":"string"},"password":{"description":"Customer's current password","type":"string"}},"type":"object"}}}},"responses":{"200":{"description":"Returns a success response indicating a successful update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}}},"security":[{"ApiKey":[]}]}},"/account/change-language":{"post":{"tags":["Profile"],"summary":"Change the customer's language.","description":"Changes the language of the logged in customer","operationId":"changeLanguage","requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["languageId"],"properties":{"language":{"description":"New languageId","type":"string"}},"type":"object"}}}},"responses":{"200":{"description":"Returns a success response indicating a successful update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}}},"security":[{"ApiKey":[]}]}},"/account/change-password":{"post":{"tags":["Profile"],"summary":"Change the customer's password","description":"Changes a customer's password using their current password as a validation.","operationId":"changePassword","requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["password","newPassword","newPasswordConfirm"],"properties":{"password":{"description":"Current password of the customer","type":"string"},"newPassword":{"description":"New Password for the customer","type":"string"},"newPasswordConfirm":{"description":"Confirmation of the new password","type":"string"}},"type":"object"}}}},"responses":{"200":{"description":"Returns a success response indicating a successful update.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}}},"security":[{"ApiKey":[]}]}},"/account/change-payment-method/{paymentMethodId}":{"post":{"tags":["Profile"],"summary":"Change the customer's default payment method","description":"Changes a customer's default (preselected) payment method.","operationId":"changePaymentMethod","parameters":[{"name":"paymentMethodId","in":"path","description":"Identifier of the desired default payment method","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returns a success response indicating a successful update.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}}},"security":[{"ApiKey":[]}]}},"/account/customer-recovery-is-expired":{"post":{"tags":["Profile"],"summary":"Checks if the customer recovery entry for a given hash is expired.","description":"This can be used to validate a provided hash has a valid and not expired customer recovery hash.","operationId":"getCustomerRecoveryIsExpired","requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["hash"],"properties":{"hash":{"description":"Parameter from the link in the confirmation mail sent in Step 1","type":"string"}},"type":"object"}}}},"responses":{"200":{"description":"Returns a CustomerRecoveryIsExpiredResponse that indicates if the hash is expired or not.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ArrayStruct"}}}}},"security":[{"ApiKey":[]}]}},"/account/customer":{"post":{"tags":["Profile","Endpoints supporting Criteria "],"summary":"Get information about current customer","description":"Returns information about the current customer.","operationId":"readCustomer","parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Criteria"}]}}}},"responses":{"200":{"description":"Returns the logged in customer, also for guest sessions. Check for the value of `guest` field to see whether the customer is a guest.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Customer"}}}}},"security":[{"ApiKey":[]}]},"delete":{"tags":["Profile"],"summary":"Delete the customer's profile","description":"Deletes a customer profile along with their addresses, wishlists and associated data. Created orders and their payment/shipping information (addresses) and reviews are not deleted.","operationId":"deleteCustomer","responses":{"204":{"description":"Returns a no content response indicating a successful removal of the customer profile"}},"security":[{"ApiKey":[]}]}},"/account/address/{addressId}":{"delete":{"tags":["Address"],"summary":"Delete an address of a customer","description":"Delete an address of customer.\n\n Only addresses which are not set as default addresses for shipping or billing can be deleted. You can check the current default addresses of your customer using the profile information endpoint and change them using the default address endpoint.\n\n **A customer must have at least one address (which can be used for shipping and billing).**\n\n An automatic fallback is not applied.","operationId":"deleteCustomerAddress","parameters":[{"name":"addressId","in":"path","description":"ID of the address to be deleted.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content response, when the address has been deleted"},"400":{"description":"Response containing a list of errors, most likely due to the address being in use"}},"security":[{"ApiKey":[]}]},"patch":{"tags":["Address"],"summary":"Modify an address of a customer","description":"Modifies an existing address of a customer.","operationId":"updateCustomerAddress","parameters":[{"name":"addressId","in":"path","description":"Address ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerAddress"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerAddress"}}}}},"security":[{"ApiKey":[]}]}},"/account/list-address":{"post":{"tags":["Address","Endpoints supporting Criteria "],"summary":"Fetch addresses of a customer","description":"Lists all addresses of the current customer and allows filtering them based on a criteria.","operationId":"listAddress","parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Criteria"}]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CustomerAddress"}}}}}},"security":[{"ApiKey":[]}]}},"/account/login":{"post":{"tags":["Login & Registration"],"summary":"Log in a customer","description":"Logs in customers given their credentials.","operationId":"loginCustomer","requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["username","password"],"properties":{"username":{"description":"Email","type":"string"},"password":{"description":"Password","type":"string"}},"type":"object"}}}},"responses":{"200":{"$ref":"#/components/responses/ContextTokenResponse"},"401":{"description":"If credentials are incorrect an error is returned","content":{"application/json":{"schema":{"$ref":"#/components/schemas/failure"}}}}},"security":[{"ApiKey":[]}]}},"/account/logout":{"post":{"tags":["Login & Registration"],"summary":"Log out a customer","description":"Logs out a customer.","operationId":"logoutCustomer","responses":{"200":{"$ref":"#/components/responses/ContextTokenResponse"},"403":{"$ref":"#/components/responses/403"}},"security":[{"ApiKey":[]}]}},"/account/register-confirm":{"post":{"tags":["Login & Registration"],"summary":"Confirm a customer registration","description":"Confirms a customer registration when double opt-in is activated.\n\nLearn more about double opt-in registration in our guide \"Register a customer\".","operationId":"registerConfirm","requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["hash","em"],"properties":{"hash":{"description":"Hash from the email received","type":"string"},"em":{"description":"Email hash from the email received","type":"string"}},"type":"object"}}}},"responses":{"200":{"description":"Returns the logged in customer. The customer is automatically logged in with the `sw-context-token` header provided, which can be reused for subsequent requests."},"404":{"description":"No hash provided"},"412":{"description":"The customer has already been confirmed"}},"security":[{"ApiKey":[]}]}},"/account/register":{"post":{"tags":["Login & Registration"],"summary":"Register a customer","description":"Registers a customer. Used both for normal customers and guest customers.See the Guide \"Register a customer\" for more information on customer registration.","operationId":"register","requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["email","password","salutationId","firstName","lastName","acceptedDataProtection","storefrontUrl","billingAddress"],"properties":{"email":{"description":"Email of the customer. Has to be unique, unless `guest` is `true`","type":"string"},"password":{"description":"Password for the customer. Required, unless `guest` is `true`","type":"string"},"salutationId":{"description":"Id of the salutation for the customer account. Fetch options using `salutation` endpoint.","type":"string"},"firstName":{"description":"Customer first name. Value will be reused for shipping and billing address if not provided explicitly.","type":"string"},"lastName":{"description":"Customer last name. Value will be reused for shipping and billing address if not provided explicitly.","type":"string"},"acceptedDataProtection":{"description":"Flag indicating accepted data protection","type":"boolean"},"storefrontUrl":{"description":"URL of the storefront for that registration. Used in confirmation emails. Has to be one of the configured domains of the sales channel.","type":"string"},"billingAddress":{"$ref":"#/components/schemas/CustomerAddress"},"shippingAddress":{"$ref":"#/components/schemas/CustomerAddress"},"accountType":{"description":"Account type of the customer which can be either `private` or `business`.","type":"string","default":"private"},"guest":{"description":"If set, will create a guest customer. Guest customers can re-use an email address and don't need a password.","type":"boolean","default":false},"birthdayDay":{"description":"Birthday day","type":"integer"},"birthdayMonth":{"description":"Birthday month","type":"integer"},"birthdayYear":{"description":"Birthday year","type":"integer"},"title":{"description":"(Academic) title of the customer","type":"string"},"affiliateCode":{"description":"Field can be used to store an affiliate tracking code","type":"string"},"campaignCode":{"description":"Field can be used to store a campaign tracking code","type":"string"}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Customer"}}}}},"security":[{"ApiKey":[]}]}},"/account/recovery-password-confirm":{"post":{"tags":["Profile"],"summary":"Reset a password with recovery credentials","description":"This operation is Step 2 of the password reset flow. It is required to conduct Step 1 \"Send a password recovery mail\" in order to obtain the required credentials for this step.Resets a customer's password using credentials from a password recovery mail as a validation.","operationId":"recoveryPassword","requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["hash","newPassword","newPasswordConfirm"],"properties":{"hash":{"description":"Parameter from the link in the confirmation mail sent in Step 1","type":"string"},"newPassword":{"description":"New password for the customer","type":"string"},"newPasswordConfirm":{"description":"Confirmation of the new password","type":"string"}},"type":"object"}}}},"responses":{"200":{"description":"Returns a success response indicating a successful update.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}}},"security":[{"ApiKey":[]}]}},"/account/recovery-password":{"post":{"tags":["Profile"],"summary":"Send a password recovery mail","description":"This operation is Step 1 of the password reset flow. Make sure to implement Step 2 \"Reset password with recovery credentials\" in order to allow for the complete flow in your application. Sends a recovery mail containing a link with credentials that allows a customer to reset their password.","operationId":"sendRecoveryMail","requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["email","storefrontUrl"],"properties":{"email":{"description":"E-Mail address to identify the customer","type":"string"},"storefrontUrl":{"description":"URL of the storefront to use for the generated reset link. It has to be a domain that is configured in the sales channel domain settings.","type":"string"}},"type":"object"}}}},"responses":{"200":{"description":"If email corresponds to an existing customer, a mail will be sent out to that customer containing a link assembled using the following schema:\n\nReturns a success indicating a successful initialisation of the reset flow.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}}},"security":[{"ApiKey":[]}]}},"/account/address/default-shipping/{addressId}":{"patch":{"tags":["Address"],"summary":"Change a customer's default shipping address","description":"Updates the default (preselected) shipping addresses of a customer.","operationId":"defaultShippingAddress","parameters":[{"name":"addressId","in":"path","description":"Address ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":""}},"security":[{"ApiKey":[]}]}},"/account/address/default-billing/{addressId}":{"patch":{"tags":["Address"],"summary":"Change a customer's default billing address","description":"Updates the default (preselected) billing addresses of a customer.","operationId":"defaultBillingAddress","parameters":[{"name":"addressId","in":"path","description":"Address ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":""}},"security":[{"ApiKey":[]}]}},"/account/address":{"post":{"tags":["Address"],"summary":"Create a new address for a customer","description":"Creates a new address for a customer.","operationId":"createCustomerAddress","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerAddress"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerAddress"}}}}},"security":[{"ApiKey":[]}]}},"/category":{"post":{"tags":["Category","Endpoints supporting Criteria "],"summary":"Fetch a list of categories","description":"Perform a filtered search for categories.","operationId":"readCategoryList","parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Criteria"}]}}}},"responses":{"200":{"description":"Entity search result containing categories.","content":{"application/json":{"schema":{"type":"object","allOf":[{"properties":{"elements":{"type":"array","items":{"$ref":"#/components/schemas/Category"}}},"type":"object"},{"$ref":"#/components/schemas/EntitySearchResult"}]}}}}},"security":[{"ApiKey":[]}]}},"/category/{navigationId}":{"post":{"tags":["Category","Endpoints supporting Criteria "],"summary":"Fetch a single category","description":"This endpoint returns information about the category, as well as a fully resolved (hydrated with mapping values) CMS page, if one is assigned to the category. You can pass slots which should be resolved exclusively.","operationId":"readCategory","parameters":[{"name":"navigationId","in":"path","description":"Identifier of the category to be fetched","required":true,"schema":{"type":"string","pattern":"^[0-9a-f]{32}$"}},{"name":"slots","in":"query","description":"Resolves only the given slot identifiers. The identifiers have to be seperated by a '|' character","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Criteria"},{"$ref":"#/components/schemas/ProductListingCriteria"}]}}}},"responses":{"200":{"description":"The loaded category with cms page","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Category"}}}}},"security":[{"ApiKey":[]}]}},"/checkout/cart":{"get":{"tags":["Cart"],"summary":"Fetch or create a cart","description":"Used to fetch the current cart or for creating a new one.","operationId":"readCart","parameters":[{"name":"name","in":"query","description":"The name of the new cart. This parameter will only be used when creating a new cart.","schema":{"type":"string"}}],"responses":{"200":{"description":"Cart","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Cart"}}}}},"security":[{"ApiKey":[]}]},"delete":{"tags":["Cart"],"summary":"Delete a cart","description":"This route deletes the cart of the customer.","operationId":"deleteCart","responses":{"204":{"description":"Successfully deleted the cart","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}}},"security":[{"ApiKey":[]}]}},"/checkout/cart/line-item":{"post":{"tags":["Cart"],"summary":"Add items to the cart","description":"This route adds items to the cart. An item can be a product or promotion for example. They are referenced by the `referencedId`-parameter.\n\nExample: [Working with the cart - Guide](https://developer.shopware.com/docs/guides/integrations-api/store-api-guide/work-with-the-cart#adding-new-items-to-the-cart)","operationId":"addLineItem","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CartItems"}}}},"responses":{"200":{"description":"The updated cart.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Cart"}}}}},"security":[{"ApiKey":[]}]},"delete":{"tags":["Cart"],"summary":"Remove items from the cart","description":"This route removes items from the cart and recalculates it.\n\nExample: [Working with the cart - Guide](https://developer.shopware.com/docs/guides/integrations-api/store-api-guide/work-with-the-cart#deleting-items-in-the-cart)","operationId":"removeLineItem","parameters":[{"name":"ids","in":"query","description":"A list of product identifiers.","required":true,"schema":{"type":"array","items":{"type":"string","pattern":"^[0-9a-f]{32}$"}}}],"responses":{"200":{"description":"The updated cart.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Cart"}}}}},"security":[{"ApiKey":[]}]},"patch":{"tags":["Cart"],"summary":"Update items in the cart","description":"This route updates items in the cart. A typical example is updating the quantity of an item.\n\nExample: [Working with the cart - Guide](https://developer.shopware.com/docs/guides/integrations-api/store-api-guide/work-with-the-cart#updating-items-in-the-cart)","operationId":"updateLineItem","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CartItems"}}}},"responses":{"200":{"description":"The updated cart.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Cart"}}}}},"security":[{"ApiKey":[]}]}},"/checkout/order":{"post":{"tags":["Order"],"summary":"Create an order from a cart","description":"Creates a new order from the current cart and deletes the cart.\n\nIf you are using the [prepared payment flow](https://developer.shopware.com/docs/concepts/commerce/checkout-concept/payments#2.1-prepare-payment-optional), this endpoint also receives additional transaction details. The exact name of the parameters depends on the implementation of the corresponding *payment handler*.","operationId":"createOrder","requestBody":{"description":"Contains additional metadata which is stored together with the order. It can also contain payment transaction details.","content":{"application/json":{"schema":{"properties":{"customerComment":{"description":"Adds a comment from the customer to the order.","type":"string"},"affiliateCode":{"description":"The affiliate code can be used to track which referrer the customer came through. An example could be `Price-comparison-company-XY`.","type":"string"},"campaignCode":{"description":"The campaign code is used to track which action the customer came from. An example could be `Summer-Deals`","type":"string"}},"type":"object"}}}},"responses":{"200":{"description":"Order","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Order"}}}}},"security":[{"ApiKey":[]}]}},"/cms/{id}":{"post":{"tags":["Content"],"summary":"Fetch and resolve a CMS page","description":"Loads a content management page by its identifier and resolve the slot data. This could be media files, product listing and so on.\n\n**Important notice**\n\nThe criteria passed with this route also affects the listing, if there is one within the cms page.","operationId":"readCms","parameters":[{"name":"id","in":"path","description":"Identifier of the CMS page to be resolved","required":true,"schema":{"type":"string","pattern":"^[0-9a-f]{32}$"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","allOf":[{"properties":{"slots":{"description":"Resolves only the given slot identifiers. The identifiers have to be seperated by a `|` character.","type":"string"}},"type":"object"},{"$ref":"#/components/schemas/ProductListingCriteria"}]}}}},"responses":{"200":{"description":"The loaded cms page","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CmsPage"}}}},"404":{"$ref":"#/components/responses/404"}},"security":[{"ApiKey":[]}]}},"/contact-form":{"post":{"tags":["Content"],"summary":"Submit a contact form message","description":"Used for submitting contact forms. Be aware that there can be more required fields, depending on the system settings.","operationId":"sendContactMail","requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["salutationId","email","subject","comment"],"properties":{"salutationId":{"description":"Identifier of the salutation. Use `/api/salutation` endpoint to fetch possible values.","type":"string"},"firstName":{"description":"Firstname. This field may be required depending on the system settings.","type":"string"},"lastName":{"description":"Lastname. This field may be required depending on the system settings.","type":"string"},"email":{"description":"Email address","type":"string"},"phone":{"description":"Phone. This field may be required depending on the system settings.","type":"string"},"subject":{"description":"The subject of the contact form.","type":"string"},"comment":{"description":"The message of the contact form","type":"string"},"navigationId":{"description":"Identifier of the navigation page. Can be used to override the configuration.\nTake a look at the settings of a category containing a concact form in the administration.","type":"string"},"slotId":{"description":"Identifier of the cms element","type":"string"},"cmsPageType":{"description":"Type of the content management page","type":"string"},"entityName":{"description":"Entity name for slot config","type":"string"}},"type":"object"}}}},"responses":{"200":{"description":"Message sent successful."}},"security":[{"ApiKey":[]}]}},"/context":{"get":{"tags":["System & Context"],"summary":"Fetch the current context","description":"Fetches the current context. This includes for example the `customerGroup`, `currency`, `taxRules` and many more.","operationId":"readContext","responses":{"200":{"description":"Returns the current context.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SalesChannelContext"}}}}},"security":[{"ApiKey":[]}]},"patch":{"tags":["System & Context"],"summary":"Modify the current context","description":"Used for switching the context. A typical example would be changing the language or changing the currency.","operationId":"updateContext","requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"currencyId":{"description":"Currency","type":"string","pattern":"^[0-9a-f]{32}$"},"languageId":{"description":"Language","type":"string","pattern":"^[0-9a-f]{32}$"},"billingAddressId":{"description":"Billing Address","type":"string","pattern":"^[0-9a-f]{32}$"},"shippingAddressId":{"description":"Shipping Address","type":"string","pattern":"^[0-9a-f]{32}$"},"paymentMethodId":{"description":"Payment Method","type":"string","pattern":"^[0-9a-f]{32}$"},"shippingMethodId":{"description":"Shipping Method","type":"string","pattern":"^[0-9a-f]{32}$"},"countryId":{"description":"Country","type":"string","pattern":"^[0-9a-f]{32}$"},"countryStateId":{"description":"Country State","type":"string","pattern":"^[0-9a-f]{32}$"}},"type":"object"}}}},"responses":{"200":{"$ref":"#/components/responses/ContextTokenResponse"}},"security":[{"ApiKey":[]}]}},"/country-state/{countryId}":{"post":{"tags":["System & Context","Endpoints supporting Criteria "],"summary":"Fetch the states of a country","description":"Perform a filtered search the states for a country","operationId":"readCountryState","parameters":[{"name":"countryId","in":"path","required":true,"schema":{"type":"string","pattern":"^[0-9a-f]{32}$"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Criteria"}]}}}},"responses":{"200":{"description":"Entity search result containing countries.","content":{"application/json":{"schema":{"type":"object","allOf":[{"properties":{"elements":{"type":"array","items":{"$ref":"#/components/schemas/CountryState"}}},"type":"object"},{"$ref":"#/components/schemas/EntitySearchResult"}]}}}}},"security":[{"ApiKey":[]}]}},"/country":{"post":{"tags":["System & Context","Endpoints supporting Criteria "],"summary":"Fetch countries","description":"Perform a filtered search for countries","operationId":"readCountry","parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Criteria"}]}}}},"responses":{"200":{"description":"Entity search result containing countries.","content":{"application/json":{"schema":{"type":"object","allOf":[{"properties":{"elements":{"type":"array","items":{"$ref":"#/components/schemas/Country"}}},"type":"object"},{"$ref":"#/components/schemas/EntitySearchResult"}]}}}}},"security":[{"ApiKey":[]}]}},"/currency":{"post":{"tags":["System & Context","Endpoints supporting Criteria "],"summary":"Fetch currencies","description":"Perform a filtered search for currencies.","operationId":"readCurrency","parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Criteria"}]}}}},"responses":{"200":{"description":"Entity search result containing currencies.","content":{"application/json":{"schema":{"type":"object","allOf":[{"properties":{"elements":{"type":"array","items":{"$ref":"#/components/schemas/Currency"}}},"type":"object"},{"$ref":"#/components/schemas/EntitySearchResult"}]}}}}},"security":[{"ApiKey":[]}]}},"/customer-group-registration/config/{customerGroupId}":{"get":{"tags":["Login & Registration"],"summary":"Fetch registration settings for customer group","operationId":"getCustomerGroupRegistrationInfo","parameters":[{"name":"customerGroupId","in":"path","description":"Customer group id","required":true,"schema":{"type":"string","pattern":"^[0-9a-f]{32}$"}}],"responses":{"200":{"description":"Returns the customer group including registration settings.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerGroup"}}}}},"security":[{"ApiKey":[]}]}},"/customer/wishlist/add/{productId}":{"post":{"tags":["Wishlist"],"summary":"Add a product to a wishlist","description":"Adds a product to a customers wishlist.\n\n **Important constraints**\n\n * Anonymous (not logged-in) customers can not have wishlists.\n * The wishlist feature has to be activated.","operationId":"addProductOnWishlist","parameters":[{"name":"productId","in":"path","description":"Identifier of the product to be added.","required":true,"schema":{"type":"string","pattern":"^[0-9a-f]{32}$"}}],"responses":{"200":{"description":"Returns a success response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}}},"security":[{"ApiKey":[]}]}},"/customer/wishlist":{"post":{"tags":["Wishlist","Endpoints supporting Criteria "],"summary":"Fetch a wishlist","description":"Fetch a customer's wishlist. Products on the wishlist can be filtered using a criteria object.\n\n **Important constraints**\n\n * Anonymous (not logged-in) customers can not have wishlists.\n * The wishlist feature has to be activated.","operationId":"readCustomerWishlist","parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Criteria"}]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WishlistLoadRouteResponse"}}}}},"security":[{"ApiKey":[]}]}},"/customer/wishlist/merge":{"post":{"tags":["Wishlist"],"summary":"Create a wishlist for a customer","description":"Create a new wishlist for a logged in customer or extend the existing wishlist given a set of products.\n\n **Important constraints**\n\n * Anonymous (not logged-in) customers can not have wishlists.\n * A customer can only have a single wishlist.\n * The wishlist feature has to be activated.","operationId":"mergeProductOnWishlist","requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"productIds":{"description":"List product id","type":"array","items":{"description":"product id","type":"string","pattern":"^[0-9a-f]{32}$"}}},"type":"object"}}}},"responses":{"200":{"description":"Returns a success response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}}},"security":[{"ApiKey":[]}]}},"/customer/wishlist/delete/{productId}":{"delete":{"tags":["Wishlist"],"summary":"Remove a product from a wishlist","description":"Removes a product from a customer's wishlist.\n\n **Important constraints**\n\n * Anonymous (not logged-in) customers can not have wishlists.\n * The wishlist feature has to be activated.","operationId":"deleteProductOnWishlist","parameters":[{"name":"productId","in":"path","description":"The identifier of the product to be removed from the wishlist.","required":true,"schema":{"type":"string","pattern":"^[0-9a-f]{32}$"}}],"responses":{"200":{"description":"Returns a success response indicating a successful removal.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"404":{"description":"The removal of the product failed. Probably because the product could not be found on the wishlist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/failure"}}}}},"security":[{"ApiKey":[]}]}},"/document/download/{documentId}/{deepLinkCode}":{"post":{"tags":["Document","Endpoints supporting Criteria "],"summary":"Download generated document","description":"Returns blob file of a generated document to download.","operationId":"download","parameters":[{"name":"documentId","in":"path","required":true,"schema":{"type":"string","pattern":"^[0-9a-f]{32}$"}},{"name":"deepLinkCode","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Criteria"}]}}}},"responses":{"200":{"description":"Returns the document information and blob to download.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Document"}}}}},"security":[{"ApiKey":[]}]}},"/handle-payment":{"post":{"tags":["Payment & Shipping"],"summary":"Initiate a payment for an order","description":"This generic endpoint is should be called to initiate a payment flow after an order has been created. The details of the payment flow can differ depending on the payment integration and might require calling additional operations or the setup of webhooks.\n\nThe endpoint internally calls the payment handler of the payment method currently set for the order.","operationId":"handlePaymentMethod","requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["orderId"],"properties":{"orderId":{"description":"Identifier of an order","type":"string"},"finishUrl":{"description":"URL to which the client should be redirected after successful payment","type":"string"},"errorUrl":{"description":"URL to which the client should be redirected after erroneous payment","type":"string"}},"type":"object"}}}},"responses":{"200":{"description":"Redirect to external payment provider"}},"security":[{"ApiKey":[]}]}},"/landing-page/{landingPageId}":{"post":{"tags":["Content","Endpoints supporting Criteria "],"summary":"Fetch a landing page with the resolved CMS page","description":"Loads a landing page by its identifier and resolves the CMS page.\n\n**Important notice**\n\nThe criteria passed with this route also affects the listing, if there is one within the cms page.","operationId":"readLandingPage","parameters":[{"name":"landingPageId","in":"path","description":"Identifier of the landing page.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Criteria"},{"type":"object","allOf":[{"properties":{"slots":{"description":"Resolves only the given slot identifiers. The identifiers have to be seperated by a `|` character.","type":"string"}},"type":"object"},{"$ref":"#/components/schemas/ProductListingCriteria"}]}]}}}},"responses":{"200":{"description":"The loaded landing page with cms page","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LandingPage"}}}},"404":{"$ref":"#/components/responses/404"}},"security":[{"ApiKey":[]}]}},"/language":{"post":{"tags":["System & Context","Endpoints supporting Criteria "],"summary":"Fetch languages","description":"Perform a filtered search for languages.","operationId":"readLanguages","parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Criteria"}]}}}},"responses":{"200":{"description":"Entity search result containing languages.","content":{"application/json":{"schema":{"type":"object","allOf":[{"properties":{"elements":{"type":"array","items":{"$ref":"#/components/schemas/Language"}}},"type":"object"},{"$ref":"#/components/schemas/EntitySearchResult"}]}}}}},"security":[{"ApiKey":[]}]}},"/navigation/{activeId}/{rootId}":{"post":{"tags":["Category","Endpoints supporting Criteria "],"summary":"Fetch a navigation menu","description":"This endpoint returns categories that can be used as a page navigation. You can either return them as a tree or as a flat list. You can also control the depth of the tree.\n\n Instead of passing uuids, you can also use one of the following aliases for the activeId and rootId parameters to get the respective navigations of your sales channel.\n\n * main-navigation\n * service-navigation\n * footer-navigation","operationId":"readNavigation","parameters":[{"name":"sw-include-seo-urls","in":"header","description":"Instructs Shopware to try and resolve SEO URLs for the given navigation item","required":false,"schema":{"type":"boolean"}},{"name":"activeId","in":"path","description":"Identifier of the active category in the navigation tree (if not used, just set to the same as rootId).","required":true,"schema":{"type":"string","pattern":"^[0-9a-f]{32}$"}},{"name":"rootId","in":"path","description":"Identifier of the root category for your desired navigation tree. You can use it to fetch sub-trees of your navigation tree.","required":true,"schema":{"type":"string","pattern":"^[0-9a-f]{32}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Criteria"},{"properties":{"depth":{"description":"Determines the depth of fetched navigation levels."},"buildTree":{"description":"Return the categories as a tree or as a flat list."}},"type":"object"}]}}}},"responses":{"200":{"description":"All available navigations","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NavigationRouteResponse"}}}}},"security":[{"ApiKey":[]}]}},"/newsletter/confirm":{"post":{"tags":["Newsletter"],"summary":"Confirm a newsletter registration","description":"You have to use the hash from the link sent out via email to confirm the user registration.","operationId":"confirmNewsletter","requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["hash","em"],"properties":{"hash":{"description":"Hash parameter from link the in the confirmation mail","type":"string"},"em":{"description":"Email hash parameter from the link in the confirmation mail","type":"string"}},"type":"object"}}}},"responses":{"200":{"description":"The newsletter confirmation was successful."}},"security":[{"ApiKey":[]}]}},"/newsletter/subscribe":{"post":{"tags":["Newsletter"],"summary":"Create or remove a newsletter subscription","description":"This route is used to create/remove/confirm a newsletter subscription.\n\nThe `option` property controls what should happen:\n* `direct`: The subscription is directly active and does not need a confirmation.\n* `subscribe`: An email will be send to the provided email addrees containing a link to the /newsletter/confirm route.\nThe subscription is only successful, if the /newsletter/confirm route is called with the generated hashes.\n* `unsubscribe`: The email address will be removed from the newsletter subscriptions.\n* `confirmSubscribe`: Confirmes the newsletter subscription for the provided email address.","operationId":"subscribeToNewsletter","requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["email","option","storefrontUrl"],"properties":{"email":{"description":"Email address that will receive the confirmation and the newsletter.","type":"string"},"option":{"description":"Defines what should be done."},"storefrontUrl":{"description":"Url of the storefront of the shop. This will be used for generating the link to the /newsletter/confirm inside the confirm email.","type":"string"},"salutationId":{"description":"Identifier of the salutation."},"firstName":{"description":"First name","type":"string"},"lastName":{"description":"Last name","type":"string"},"street":{"description":"Street","type":"string"},"city":{"description":"City","type":"string"},"zipCode":{"description":"Zip code","type":"string"},"tags":{"description":"Zip code","type":"string"},"languageId":{"description":"Identifier of the language."},"customFields":{"description":"Custom field data that should be added to the subscription.","type":"string"}},"type":"object"}}}},"responses":{"200":{"description":"Success"}},"security":[{"ApiKey":[]}]}},"/newsletter/unsubscribe":{"post":{"tags":["Newsletter"],"summary":"Remove a newsletter subscription","description":"Removes a newsletter recipient from the mailing lists.","operationId":"unsubscribeToNewsletter","requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["email"],"properties":{"email":{"description":"Email address that should be removed from the mailing lists.","type":"string"}},"type":"object"}}}},"responses":{"200":{"description":"Unsubscribing was successful."}},"security":[{"ApiKey":[]}]}},"/order/state/cancel":{"post":{"tags":["Order"],"summary":"Cancel an order","description":"Cancels an order. The order state will be set to 'cancelled'.","operationId":"cancelOrder","requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"orderId":{"description":"The identifier of the order to be canceled.","type":"string"}},"type":"object"}}}},"responses":{"200":{"description":"Returns the state of the state machine\n\n example: More information about the state machine can be found in the corresponding guide: [Using the state machine](https://developer.shopware.com/docs/guides/plugins/plugins/checkout/order/using-the-state-machine)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StateMachineState"}}}}},"security":[{"ApiKey":[]}]}},"/order":{"post":{"tags":["Order","Endpoints supporting Criteria "],"summary":"Fetch a list of orders","description":"List orders of a customer.","operationId":"readOrder","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Criteria"},{"properties":{"checkPromotion":{"description":"Check if the payment method of the order is still changeable.","type":"boolean"}},"type":"object"}]}}}},"responses":{"200":{"description":"An array of orders and an indicator if the payment of the order can be changed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderRouteResponse"}}}}},"security":[{"ApiKey":[]}]}},"/order/payment":{"post":{"tags":["Order"],"summary":"Update the payment method of an order","description":"Changes the payment method of a specific order. You can use the /order route to find out if the payment method of an order can be changed - take a look at the `paymentChangeable`- array in the response.","operationId":"orderSetPayment","requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["paymentMethodId","orderId"],"properties":{"paymentMethodId":{"description":"The identifier of the paymentMethod to be set","type":"string"},"orderId":{"description":"The identifier of the order.","type":"string"}},"type":"object"}}}},"responses":{"200":{"description":"Successfully updated the payment method of the order.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}}},"security":[{"ApiKey":[]}]}},"/order/download/{orderId}/{downloadId}":{"get":{"tags":["Order"],"summary":"Download a purchased file","description":"Download a file included in the given order and with the given id. Access must be granted.","operationId":"orderDownloadFile","parameters":[{"name":"orderId","in":"path","required":true,"schema":{"type":"string","pattern":"^[0-9a-f]{32}$"}},{"name":"downloadId","in":"path","required":true,"schema":{"type":"string","pattern":"^[0-9a-f]{32}$"}}],"responses":{"200":{"description":"An arbitrary binary file.","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}}},"security":[{"ApiKey":[]}]}},"/payment-method":{"post":{"tags":["Payment Method","Endpoints supporting Criteria "],"summary":"Loads all available payment methods","operationId":"readPaymentMethod","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Criteria"},{"properties":{"onlyAvailable":{"description":"List only available","type":"boolean"}},"type":"object"}]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"properties":{"total":{"description":"Total amount","type":"integer"},"aggregations":{"description":"aggregation result","type":"object"},"elements":{"type":"array","items":{"$ref":"#/components/schemas/PaymentMethod"}}},"type":"object"}}}}},"security":[{"ApiKey":[]}]}},"/product-export/{accessKey}/{fileName}":{"get":{"tags":["Product"],"summary":"Export product export","operationId":"readProductExport","parameters":[{"name":"accessKey","in":"path","description":"Access Key","required":true,"schema":{"type":"string"}},{"name":"fileName","in":"path","description":"File Name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":""}},"security":[{"ApiKey":[]}]}},"/product-listing/{categoryId}":{"post":{"tags":["Product"],"summary":"Fetch a product listing by category","description":"Fetches a product listing for a specific category. It also provides filters, sortings and property aggregations, analogous to the /search endpoint.","operationId":"readProductListing","parameters":[{"name":"categoryId","in":"path","description":"Identifier of a category.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","allOf":[{"$ref":"#/components/schemas/ProductListingCriteria"},{"$ref":"#/components/schemas/ProductListingFlags"}]}}}},"responses":{"200":{"description":"Returns a product listing containing all products and additional fields to display a listing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductListingResult"}}}}},"security":[{"ApiKey":[]}]}},"/product/{productId}/cross-selling":{"post":{"tags":["Product"],"summary":"Fetch cross-selling groups of a product","description":"This route is used to load the cross sellings for a product. A product has several cross selling definitions in which several products are linked. The route returns the cross sellings together with the linked products","operationId":"readProductCrossSellings","parameters":[{"name":"productId","in":"path","description":"Product ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Found cross sellings","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CrossSellingElementCollection"}}}}},"security":[{"ApiKey":[]}]}},"/product/{productId}":{"post":{"tags":["Product"],"summary":"Fetch a single product","description":"This route is used to load a single product with the corresponding details. In addition to loading the data, the best variant of the product is determined when a parent id is passed.","operationId":"readProductDetail","parameters":[{"name":"productId","in":"path","description":"Product ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Product information along with variant groups and options","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductDetailResponse"}}}}},"security":[{"ApiKey":[]}]}},"/product":{"post":{"tags":["Product","Endpoints supporting Criteria "],"summary":"Fetch a list of products","description":"List products that match the given criteria. For performance ressons a limit should always be set.","operationId":"readProduct","parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Criteria"}]}}}},"responses":{"200":{"description":"Entity search result containing products","content":{"application/json":{"schema":{"type":"object","allOf":[{"properties":{"elements":{"type":"array","items":{"$ref":"#/components/schemas/Product"}}},"type":"object"},{"$ref":"#/components/schemas/EntitySearchResult"}]}}}}},"security":[{"ApiKey":[]}]}},"/product/{productId}/reviews":{"post":{"tags":["Product","Endpoints supporting Criteria "],"summary":"Fetch product reviews","description":"Perform a filtered search for product reviews.","operationId":"readProductReviews","parameters":[{"name":"productId","in":"path","description":"Identifier of the product.","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Criteria"}]}}}},"responses":{"200":{"description":"Entity search result containing product reviews","content":{"application/json":{"schema":{"type":"object","allOf":[{"properties":{"elements":{"type":"array","items":{"$ref":"#/components/schemas/ProductReview"}}},"type":"object"},{"$ref":"#/components/schemas/EntitySearchResult"}]}}}}},"security":[{"ApiKey":[]}]}},"/product/{productId}/review":{"post":{"tags":["Product"],"summary":"Save a product review","description":"Saves a review for a product. Reviews have to be activated in the settings.","operationId":"saveProductReview","parameters":[{"name":"productId","in":"path","description":"Identifier of the product which is reviewed.","required":true,"schema":{"type":"string","pattern":"^[0-9a-f]{32}$"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["title","content","points"],"properties":{"name":{"description":"The name of the review author. If not set, the first name of the customer is chosen.","type":"string"},"email":{"description":"The email address of the review author. If not set, the email of the customer is chosen.","type":"string"},"title":{"description":"The title of the review."},"content":{"description":"The content of review."},"points":{"description":"The review rating for the product."}},"type":"object"}}}},"responses":{"200":{"description":"Success response indicating the review was saved successfuly."}},"security":[{"ApiKey":[]}]}},"/product/{productId}/find-variant":{"post":{"tags":["Product"],"summary":"Search for a matching variant by product options.","description":"Performs a search for product variants and returns the best matching variant.","operationId":"searchProductVariantIds","parameters":[{"name":"productId","in":"path","description":"Product ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["options"],"properties":{"options":{"description":"The options parameter for the variant to find.","type":"array","items":{"type":"string"}},"switchedGroup":{"description":"The id of the option group that has been switched.","type":"string"}},"type":"object"}}}},"responses":{"200":{"description":"Returns an FoundCombination struct containing the ids matching the search.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FindProductVariantRouteResponse"}}}}},"security":[{"ApiKey":[]}]}},"/salutation":{"post":{"tags":["System & Context","Endpoints supporting Criteria "],"summary":"Fetch salutations","description":"Perform a filtered search for salutations.","operationId":"readSalutation","parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Criteria"}]}}}},"responses":{"200":{"description":"Entity search result containing salutations.","content":{"application/json":{"schema":{"type":"object","allOf":[{"properties":{"elements":{"type":"array","items":{"$ref":"#/components/schemas/Salutation"}}},"type":"object"},{"$ref":"#/components/schemas/EntitySearchResult"}]}}}}},"security":[{"ApiKey":[]}]}},"/script/{hook}":{"post":{"tags":["API","Script","App"],"summary":"Access point for different api logics which are provided by apps over script hooks","operationId":"postScriptStoreApiRoute","parameters":[{"name":"hook","in":"path","description":"Dynamic hook which used to build the hook name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returns different structures of results based on the called script."}},"security":[{"ApiKey":[]}]}},"/search-suggest":{"post":{"tags":["Product"],"summary":"Search for products (suggest)","description":"Can be used to implement search previews or suggestion listings, that don’t require any interaction.","operationId":"searchSuggest","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","allOf":[{"required":["search"],"properties":{"search":{"description":"Using the search parameter, the server performs a text search on all records based on their data model and weighting as defined in the entity definition using the SearchRanking flag.","type":"string"}},"type":"object"},{"$ref":"#/components/schemas/ProductListingFlags"}]}}}},"responses":{"200":{"description":"Returns a product listing containing all products and additional fields.\n\nNote: Aggregations, currentFilters and availableSortings are empty in this response. If you need them to display a listing, use the /search route instead.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductListingResult"}}}}},"security":[{"ApiKey":[]}]}},"/search":{"post":{"tags":["Product"],"summary":"Search for products","description":"Performs a search for products which can be used to display a product listing.","operationId":"searchPage","requestBody":{"content":{"application/json":{"schema":{"type":"object","allOf":[{"required":["search"],"properties":{"search":{"description":"Using the search parameter, the server performs a text search on all records based on their data model and weighting as defined in the entity definition using the SearchRanking flag.","type":"string"}},"type":"object"},{"$ref":"#/components/schemas/ProductListingCriteria"},{"$ref":"#/components/schemas/ProductListingFlags"}]}}}},"responses":{"200":{"description":"Returns a product listing containing all products and additional fields to display a listing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductListingResult"}}}}},"security":[{"ApiKey":[]}]}},"/seo-url":{"post":{"tags":["Sitemap & Routes","Endpoints supporting Criteria "],"summary":"Fetch SEO routes","description":"Perform a filtered search for seo urls.","operationId":"readSeoUrl","parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Criteria"}]}}}},"responses":{"200":{"description":"Entity search result containing seo urls.","content":{"application/json":{"schema":{"type":"object","allOf":[{"properties":{"elements":{"type":"array","items":{"$ref":"#/components/schemas/SeoUrl"}}},"type":"object"},{"$ref":"#/components/schemas/EntitySearchResult"}]}}}},"404":{"$ref":"#/components/responses/404"}},"security":[{"ApiKey":[]}]}},"/shipping-method":{"post":{"tags":["Payment & Shipping","Endpoints supporting Criteria "],"summary":"Fetch shipping methods","description":"Perform a filtered search for shipping methods.","operationId":"readShippingMethod","parameters":[{"name":"onlyAvailable","in":"query","description":"List only available shipping methods. This filters shipping methods methods which can not be used in the actual context because of their availability rule.","schema":{"type":"boolean"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Criteria"}]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"properties":{"total":{"description":"Total amount","type":"integer"},"aggregations":{"description":"aggregation result","type":"object"},"elements":{"type":"array","items":{"$ref":"#/components/schemas/ShippingMethod"}}},"type":"object"}}}}},"security":[{"ApiKey":[]}]}},"/sitemap":{"get":{"tags":["Sitemap & Routes"],"summary":"Fetch sitemaps","description":"Fetches a list of compressed sitemap files, which are often used by search engines.","operationId":"readSitemap","responses":{"200":{"description":"Returns a list of available sitemaps.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Sitemap"}}}}}},"security":[{"ApiKey":[]}]}}}} \ No newline at end of file +{"openapi":"3.0.0","info":{"title":"Shopware Store API","description":"This endpoint reference contains an overview of all endpoints comprising the Shopware Store API","version":"6.6.1.2"},"servers":[{"url":"https://sw661-playground.dmf-kunden.com/store-api"}],"components":{"schemas":{"success":{"required":["data"],"properties":{"meta":{"$ref":"#/components/schemas/meta"},"links":{"description":"Link members related to the primary data.","allOf":[{"$ref":"#/components/schemas/links"},{"$ref":"#/components/schemas/pagination"}]},"data":{"$ref":"#/components/schemas/data"},"included":{"description":"To reduce the number of HTTP requests, servers **MAY** allow responses that include related resources along with the requested primary resources. Such responses are called \"compound documents\".","type":"array","items":{"$ref":"#/components/schemas/resource"},"uniqueItems":true}},"type":"object","additionalProperties":false},"failure":{"required":["errors"],"properties":{"meta":{"$ref":"#/components/schemas/meta"},"links":{"$ref":"#/components/schemas/links"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/error"},"uniqueItems":true}},"type":"object","additionalProperties":false},"info":{"required":["meta"],"properties":{"meta":{"$ref":"#/components/schemas/meta"},"links":{"$ref":"#/components/schemas/links"},"jsonapi":{"$ref":"#/components/schemas/jsonapi"}},"type":"object"},"meta":{"description":"Non-standard meta-information that can not be represented as an attribute or relationship.","type":"object","additionalProperties":true},"data":{"description":"The document's \"primary data\" is a representation of the resource or collection of resources targeted by a request.","oneOf":[{"$ref":"#/components/schemas/resource"},{"description":"An array of resource objects, an array of resource identifier objects, or an empty array ([]), for requests that target resource collections.","type":"array","items":{"$ref":"#/components/schemas/resource"},"uniqueItems":true}]},"resource":{"description":"\"Resource objects\" appear in a JSON API document to represent resources.","required":["type","id"],"properties":{"type":{"type":"string"},"id":{"type":"string"},"attributes":{"$ref":"#/components/schemas/attributes"},"relationships":{"$ref":"#/components/schemas/relationships"},"links":{"$ref":"#/components/schemas/links"},"meta":{"$ref":"#/components/schemas/meta"}},"type":"object"},"relationshipLinks":{"description":"A resource object **MAY** contain references to other resource objects (\"relationships\"). Relationships may be to-one or to-many. Relationships can be specified by including a member in a resource's links object.","properties":{"self":{"allOf":[{"description":"A `self` member, whose value is a URL for the relationship itself (a \"relationship URL\"). This URL allows the client to directly manipulate the relationship. For example, it would allow a client to remove an `author` from an `article` without deleting the people resource itself.","type":"array"},{"$ref":"#/components/schemas/link"}]},"related":{"$ref":"#/components/schemas/link"}},"type":"object","additionalProperties":true},"links":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/link"}},"link":{"description":"A link **MUST** be represented as either: a string containing the link's URL or a link object.","oneOf":[{"description":"A string containing the link's URL.","type":"string","format":"uri-reference"},{"type":"object","required":["href"],"properties":{"href":{"description":"A string containing the link's URL.","type":"string","format":"uri-reference"},"meta":{"$ref":"#/components/schemas/meta"}}}]},"attributes":{"description":"Members of the attributes object (\"attributes\") represent information about the resource object in which it's defined.","type":"object","additionalProperties":true},"relationships":{"description":"Members of the relationships object (\"relationships\") represent references from the resource object in which it's defined to other resource objects.","type":"object","anyOf":[{"required":["data"]},{"required":["meta"]},{"required":["links"]},{"type":"object","properties":{"links":{"$ref":"#/components/schemas/relationshipLinks"},"data":{"description":"Member, whose value represents \"resource linkage\".","oneOf":[{"$ref":"#/components/schemas/relationshipToOne"},{"$ref":"#/components/schemas/relationshipToMany"}]}}}],"additionalProperties":false},"relationshipToOne":{"allOf":[{"description":"References to other resource objects in a to-one (\"relationship\"). Relationships can be specified by including a member in a resource's links object."},{"$ref":"#/components/schemas/linkage"}]},"relationshipToMany":{"description":"An array of objects each containing \\\"type\\\" and \\\"id\\\" members for to-many relationships.","type":"array","items":{"$ref":"#/components/schemas/linkage"},"uniqueItems":true},"linkage":{"description":"The \"type\" and \"id\" to non-empty members.","required":["type","id"],"properties":{"type":{"type":"string"},"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"meta":{"$ref":"#/components/schemas/meta"}},"type":"object","additionalProperties":false},"pagination":{"properties":{"first":{"description":"The first page of data","type":"string","format":"uri-reference"},"last":{"description":"The last page of data","type":"string","format":"uri-reference"},"prev":{"description":"The previous page of data","type":"string","format":"uri-reference"},"next":{"description":"The next page of data","type":"string","format":"uri-reference"}},"type":"object"},"jsonapi":{"description":"An object describing the server's implementation","properties":{"version":{"type":"string"},"meta":{"$ref":"#/components/schemas/meta"}},"type":"object","additionalProperties":false},"error":{"properties":{"id":{"type":"string","description":"A unique identifier for this particular occurrence of the problem."},"links":{"$ref":"#/components/schemas/links"},"status":{"type":"string","description":"The HTTP status code applicable to this problem, expressed as a string value."},"code":{"type":"string","description":"An application-specific error code, expressed as a string value."},"title":{"type":"string","description":"A short, human-readable summary of the problem. It **SHOULD NOT** change from occurrence to occurrence of the problem, except for purposes of localization."},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem."},"description":{"type":"string","description":"A human-readable description of the problem."},"source":{"type":"object","properties":{"pointer":{"type":"string","description":"A JSON Pointer [RFC6901] to the associated entity in the request document [e.g. \"/data\" for a primary data object, or \"/data/attributes/title\" for a specific attribute]."},"parameter":{"type":"string","description":"A string indicating which query parameter caused the error."}}},"meta":{"$ref":"#/components/schemas/meta"}},"type":"object","additionalProperties":false},"AclRole":{"description":"Added since version: 6.0.0.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"App":{"description":"Added since version: 6.3.1.0","required":["createdAt","label"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"}},"type":"object"},"AppActionButton":{"description":"Added since version: 6.3.1.0","required":["createdAt","label"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"}},"type":"object"},"AppAdministrationSnippet":{"description":"Added since version: 6.4.15.0","required":["value","appId","localeId","createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"value":{"type":"string"},"appId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"localeId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"AppCmsBlock":{"description":"Added since version: 6.4.2.0","required":["createdAt","label"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"}},"type":"object"},"AppFlowAction":{"description":"Added since version: 6.4.10.0","required":["createdAt","label"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"}},"type":"object"},"AppFlowEvent":{"description":"Added since version: 6.5.2.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"AppPaymentMethod":{"description":"Added since version: 6.4.1.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"AppScriptCondition":{"description":"Added since version: 6.4.10.3","required":["createdAt","name"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"}},"type":"object"},"AppShippingMethod":{"description":"Added since version: 6.5.7.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"AppTemplate":{"description":"Added since version: 6.3.1.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"CategoryJsonApi":{"description":"Added since version: 6.0.0.0","allOf":[{"$ref":"#/components/schemas/resource"},{"required":["id","displayNestedProducts","type","productAssignmentType","createdAt","name"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"versionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"parentId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"parentVersionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"afterCategoryId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"afterCategoryVersionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"mediaId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"displayNestedProducts":{"type":"boolean"},"breadcrumb":{"type":"array","items":{"type":"object","additionalProperties":false},"readOnly":true},"level":{"type":"integer","format":"int64","readOnly":true},"path":{"type":"string","readOnly":true},"childCount":{"type":"integer","format":"int64","readOnly":true},"type":{"type":"string"},"productAssignmentType":{"type":"string"},"visible":{"type":"boolean"},"active":{"type":"boolean"},"cmsPageIdSwitched":{"description":"Runtime field, cannot be used as part of the criteria.","type":"boolean"},"visibleChildCount":{"description":"Runtime field, cannot be used as part of the criteria.","type":"integer","format":"int64"},"name":{"type":"string"},"customFields":{"type":"object"},"linkType":{"type":"string"},"internalLink":{"type":"string","pattern":"^[0-9a-f]{32}$"},"externalLink":{"type":"string"},"linkNewTab":{"type":"boolean"},"description":{"type":"string"},"metaTitle":{"type":"string"},"metaDescription":{"type":"string"},"keywords":{"type":"string"},"cmsPageId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"cmsPageVersionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"customEntityTypeId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"},"relationships":{"properties":{"parent":{"properties":{"links":{"type":"object","properties":{"related":{"type":"string","format":"uri-reference","example":"/category/3adbdb3ac060038aa0e6e6c138ef9873/parent"}}},"data":{"type":"object","properties":{"type":{"type":"string","example":"category"},"id":{"type":"string","pattern":"^[0-9a-f]{32}$","example":"d0e45878043844ffc41aac437e86b602"}}}},"type":"object"},"children":{"properties":{"links":{"type":"object","properties":{"related":{"type":"string","format":"uri-reference","example":"/category/3adbdb3ac060038aa0e6e6c138ef9873/children"}}},"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","example":"category"},"id":{"type":"string","example":"268184c12df027f536154d099d497b31"}}}}},"type":"object"},"media":{"properties":{"links":{"type":"object","properties":{"related":{"type":"string","format":"uri-reference","example":"/category/3adbdb3ac060038aa0e6e6c138ef9873/media"}}},"data":{"type":"object","properties":{"type":{"type":"string","example":"media"},"id":{"type":"string","pattern":"^[0-9a-f]{32}$","example":"62933a2951ef01f4eafd9bdf4d3cd2f0"}}}},"type":"object"},"tags":{"properties":{"links":{"type":"object","properties":{"related":{"type":"string","format":"uri-reference","example":"/category/3adbdb3ac060038aa0e6e6c138ef9873/tags"}}},"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","example":"tag"},"id":{"type":"string","example":"d57ac45256849d9b13e2422d91580fb9"}}}}},"type":"object"},"cmsPage":{"properties":{"links":{"type":"object","properties":{"related":{"type":"string","format":"uri-reference","example":"/category/3adbdb3ac060038aa0e6e6c138ef9873/cmsPage"}}},"data":{"type":"object","properties":{"type":{"type":"string","example":"cms_page"},"id":{"type":"string","pattern":"^[0-9a-f]{32}$","example":"7b1460918b1abb93311108f3dc021c9b"}}}},"type":"object"},"seoUrls":{"properties":{"links":{"type":"object","properties":{"related":{"type":"string","format":"uri-reference","example":"/category/3adbdb3ac060038aa0e6e6c138ef9873/seoUrls"}}},"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","example":"seo_url"},"id":{"type":"string","example":"5321b5a71127b8b98cdd4b068ad56c4c"}}}}},"type":"object"}},"type":"object"}},"type":"object"}]},"Category":{"description":"Added since version: 6.0.0.0","required":["breadcrumb","children","childCount","translated","id","displayNestedProducts","type","productAssignmentType","createdAt","name"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"versionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"parentId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"parentVersionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"afterCategoryId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"afterCategoryVersionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"mediaId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"displayNestedProducts":{"type":"boolean"},"breadcrumb":{"type":"array","items":{"type":"string","additionalProperties":false},"readOnly":true},"level":{"type":"integer","format":"int64","readOnly":true},"path":{"type":"string","readOnly":true},"childCount":{"type":"number","format":"int64","readOnly":true},"type":{"type":"string"},"productAssignmentType":{"type":"string"},"visible":{"type":"boolean"},"active":{"type":"boolean"},"cmsPageIdSwitched":{"description":"Runtime field, cannot be used as part of the criteria.","type":"boolean"},"visibleChildCount":{"description":"Runtime field, cannot be used as part of the criteria.","type":"integer","format":"int64"},"name":{"type":"string"},"customFields":{"type":"object"},"linkType":{"type":"string"},"internalLink":{"type":"string","pattern":"^[0-9a-f]{32}$"},"externalLink":{"type":"string"},"linkNewTab":{"type":"boolean"},"description":{"type":"string"},"metaTitle":{"type":"string"},"metaDescription":{"type":"string"},"keywords":{"type":"string"},"cmsPageId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"cmsPageVersionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"customEntityTypeId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object","additionalProperties":true,"properties":{"breadcrumb":{"type":"array","items":{"type":"string"}}}},"parent":{"$ref":"#/components/schemas/Category"},"children":{"type":"array","items":{"$ref":"#/components/schemas/Category"},"nullable":true},"media":{"$ref":"#/components/schemas/Media"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/Tag"}},"cmsPage":{"$ref":"#/components/schemas/CmsPage"},"seoUrls":{"type":"array","items":{"$ref":"#/components/schemas/SeoUrl"}},"apiAlias":{"type":"string","enum":["category"]}},"type":"object"},"CmsBlock":{"description":"Added since version: 6.0.0.0","required":["apiAlias","slots","position","type","sectionId","createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"position":{"type":"integer","format":"int64"},"type":{"type":"string"},"name":{"type":"string"},"sectionPosition":{"type":"string"},"marginTop":{"type":"string"},"marginBottom":{"type":"string"},"marginLeft":{"type":"string"},"marginRight":{"type":"string"},"backgroundColor":{"type":"string"},"backgroundMediaId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"backgroundMediaMode":{"type":"string"},"cssClass":{"type":"string"},"visibility":{"properties":{"mobile":{"type":"boolean"},"desktop":{"type":"boolean"},"tablet":{"type":"boolean"}},"type":"object"},"sectionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"customFields":{"type":"object"},"versionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"cmsSectionVersionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"backgroundMedia":{"$ref":"#/components/schemas/Media"},"slots":{"type":"array","items":{"$ref":"#/components/schemas/CmsSlot"}},"apiAlias":{"type":"string","enum":["cms_block"]}},"type":"object"},"CmsFactoryElement":{"required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"CmsPage":{"description":"Added since version: 6.0.0.0","required":["apiAlias","sections","id","type","createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"versionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"name":{"type":"string"},"type":{"type":"string"},"entity":{"type":"string"},"cssClass":{"type":"string"},"config":{"properties":{"backgroundColor":{"type":"string"}},"type":"object"},"previewMediaId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"customFields":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"},"sections":{"type":"array","items":{"$ref":"#/components/schemas/CmsSection"}},"previewMedia":{"$ref":"#/components/schemas/Media"},"landingPages":{"type":"array","items":{"$ref":"#/components/schemas/LandingPage"}},"apiAlias":{"type":"string","enum":["cms_page"]}},"type":"object"},"CmsSection":{"description":"Added since version: 6.0.0.0","required":["apiAlias","blocks","position","type","pageId","createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"position":{"type":"integer","format":"int64"},"type":{"type":"string"},"name":{"type":"string"},"sizingMode":{"type":"string"},"mobileBehavior":{"type":"string"},"backgroundColor":{"type":"string"},"backgroundMediaId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"backgroundMediaMode":{"type":"string"},"cssClass":{"type":"string"},"pageId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"visibility":{"properties":{"mobile":{"type":"boolean"},"desktop":{"type":"boolean"},"tablet":{"type":"boolean"}},"type":"object"},"customFields":{"type":"object"},"cmsPageVersionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"page":{"$ref":"#/components/schemas/CmsPage"},"backgroundMedia":{"$ref":"#/components/schemas/Media"},"blocks":{"type":"array","items":{"$ref":"#/components/schemas/CmsBlock"}},"apiAlias":{"type":"string","enum":["cms_section"]}},"type":"object"},"CmsSlot":{"description":"Added since version: 6.0.0.0","required":["type","slot","blockId","createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"versionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"type":{"type":"string"},"slot":{"type":"string"},"locked":{"type":"boolean"},"config":{"type":"object"},"customFields":{"type":"object"},"data":{"type":"object","readOnly":true},"blockId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"fieldConfig":{"type":"object"},"cmsBlockVersionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"},"block":{"$ref":"#/components/schemas/CmsBlock"}},"type":"object"},"CountryJsonApi":{"description":"Added since version: 6.0.0.0","allOf":[{"$ref":"#/components/schemas/resource"},{"required":["id","createdAt","name","addressFormat"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"name":{"type":"string"},"iso":{"type":"string"},"position":{"type":"integer","format":"int64"},"active":{"type":"boolean"},"shippingAvailable":{"type":"boolean"},"iso3":{"type":"string"},"displayStateInRegistration":{"type":"boolean"},"forceStateInRegistration":{"type":"boolean"},"checkVatIdPattern":{"type":"boolean"},"vatIdRequired":{"type":"boolean"},"vatIdPattern":{"type":"string"},"customFields":{"type":"object"},"customerTax":{"required":["enabled","currencyId","amount"],"properties":{"enabled":{"type":"boolean"},"currencyId":{"type":"string"},"amount":{"type":"number","format":"float"}},"type":"object"},"companyTax":{"required":["enabled","currencyId","amount"],"properties":{"enabled":{"type":"boolean"},"currencyId":{"type":"string"},"amount":{"type":"number","format":"float"}},"type":"object"},"postalCodeRequired":{"type":"boolean"},"checkPostalCodePattern":{"type":"boolean"},"checkAdvancedPostalCodePattern":{"type":"boolean"},"advancedPostalCodePattern":{"type":"string"},"addressFormat":{"type":"object"},"defaultPostalCodePattern":{"type":"string"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"},"relationships":{"properties":{"states":{"properties":{"links":{"type":"object","properties":{"related":{"type":"string","format":"uri-reference","example":"/country/59716c97497eb9694541f7c3d37b1a4d/states"}}},"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","example":"country_state"},"id":{"type":"string","example":"34d955a0df5f7af9c9b4e4dccb3c3564"}}}}},"type":"object"}},"type":"object"}},"type":"object"}]},"Country":{"description":"Added since version: 6.0.0.0","required":["id","createdAt","name","addressFormat"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"name":{"type":"string"},"iso":{"type":"string"},"position":{"type":"integer","format":"int64"},"active":{"type":"boolean"},"shippingAvailable":{"type":"boolean"},"iso3":{"type":"string"},"displayStateInRegistration":{"type":"boolean"},"forceStateInRegistration":{"type":"boolean"},"checkVatIdPattern":{"type":"boolean"},"vatIdRequired":{"type":"boolean"},"vatIdPattern":{"type":"string"},"customFields":{"type":"object"},"customerTax":{"required":["enabled","currencyId","amount"],"properties":{"enabled":{"type":"boolean"},"currencyId":{"type":"string"},"amount":{"type":"number","format":"float"}},"type":"object"},"companyTax":{"required":["enabled","currencyId","amount"],"properties":{"enabled":{"type":"boolean"},"currencyId":{"type":"string"},"amount":{"type":"number","format":"float"}},"type":"object"},"postalCodeRequired":{"type":"boolean"},"checkPostalCodePattern":{"type":"boolean"},"checkAdvancedPostalCodePattern":{"type":"boolean"},"advancedPostalCodePattern":{"type":"string"},"addressFormat":{"type":"object"},"defaultPostalCodePattern":{"type":"string"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"},"states":{"type":"array","items":{"$ref":"#/components/schemas/CountryState"}}},"type":"object"},"CountryStateJsonApi":{"description":"Added since version: 6.0.0.0","allOf":[{"$ref":"#/components/schemas/resource"},{"required":["id","countryId","shortCode","createdAt","name"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"countryId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"shortCode":{"type":"string"},"name":{"type":"string"},"position":{"type":"integer","format":"int64"},"active":{"type":"boolean"},"customFields":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"}},"type":"object"}]},"CountryState":{"description":"Added since version: 6.0.0.0","required":["id","countryId","shortCode","createdAt","name"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"countryId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"shortCode":{"type":"string"},"name":{"type":"string"},"position":{"type":"integer","format":"int64"},"active":{"type":"boolean"},"customFields":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"}},"type":"object"},"CurrencyJsonApi":{"description":"Added since version: 6.0.0.0","allOf":[{"$ref":"#/components/schemas/resource"},{"required":["id","factor","symbol","isoCode","itemRounding","totalRounding","createdAt","shortName","name"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"factor":{"type":"number","format":"float"},"symbol":{"type":"string"},"isoCode":{"type":"string"},"shortName":{"type":"string"},"name":{"type":"string"},"position":{"type":"integer","format":"int64"},"isSystemDefault":{"description":"Runtime field, cannot be used as part of the criteria.","type":"boolean"},"taxFreeFrom":{"type":"number","format":"float"},"customFields":{"type":"object"},"itemRounding":{"required":["decimals","interval","roundForNet"],"properties":{"decimals":{"type":"integer","format":"int64"},"interval":{"type":"number","format":"float"},"roundForNet":{"type":"boolean"}},"type":"object"},"totalRounding":{"required":["decimals","interval","roundForNet"],"properties":{"decimals":{"type":"integer","format":"int64"},"interval":{"type":"number","format":"float"},"roundForNet":{"type":"boolean"}},"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"}},"type":"object"}]},"Currency":{"description":"Added since version: 6.0.0.0","required":["id","factor","symbol","isoCode","itemRounding","totalRounding","createdAt","shortName","name"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"factor":{"type":"number","format":"float"},"symbol":{"type":"string"},"isoCode":{"type":"string"},"shortName":{"type":"string"},"name":{"type":"string"},"position":{"type":"integer","format":"int64"},"isSystemDefault":{"description":"Runtime field, cannot be used as part of the criteria.","type":"boolean"},"taxFreeFrom":{"type":"number","format":"float"},"customFields":{"type":"object"},"itemRounding":{"required":["decimals","interval","roundForNet"],"properties":{"decimals":{"type":"integer","format":"int64"},"interval":{"type":"number","format":"float"},"roundForNet":{"type":"boolean"}},"type":"object"},"totalRounding":{"required":["decimals","interval","roundForNet"],"properties":{"decimals":{"type":"integer","format":"int64"},"interval":{"type":"number","format":"float"},"roundForNet":{"type":"boolean"}},"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"}},"type":"object"},"CurrencyCountryRounding":{"description":"Added since version: 6.4.0.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"CustomEntity":{"description":"Added since version: 6.4.9.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"CustomField":{"description":"Added since version: 6.0.0.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"CustomFieldSet":{"description":"Added since version: 6.0.0.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"CustomFieldSetRelation":{"description":"Added since version: 6.0.0.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"Customer":{"description":"Added since version: 6.0.0.0","required":["id","groupId","defaultPaymentMethodId","salesChannelId","languageId","defaultBillingAddressId","defaultShippingAddressId","customerNumber","firstName","lastName","email","accountType","createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"groupId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"defaultPaymentMethodId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"salesChannelId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"languageId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"lastPaymentMethodId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"defaultBillingAddressId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"defaultShippingAddressId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"customerNumber":{"type":"string"},"salutationId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"firstName":{"type":"string"},"lastName":{"type":"string"},"company":{"type":"string"},"email":{"type":"string"},"title":{"type":"string"},"vatIds":{"type":"array","items":{"type":"string"}},"affiliateCode":{"type":"string"},"campaignCode":{"type":"string"},"active":{"type":"boolean"},"doubleOptInRegistration":{"type":"boolean"},"doubleOptInEmailSentDate":{"type":"string","format":"date-time"},"doubleOptInConfirmDate":{"type":"string","format":"date-time"},"hash":{"type":"string"},"guest":{"type":"boolean"},"firstLogin":{"type":"string","format":"date-time"},"lastLogin":{"type":"string","format":"date-time"},"birthday":{"type":"string"},"lastOrderDate":{"type":"string","format":"date-time","readOnly":true},"orderCount":{"type":"integer","format":"int64","readOnly":true},"orderTotalAmount":{"type":"number","format":"float","readOnly":true},"reviewCount":{"type":"integer","format":"int64","readOnly":true},"customFields":{"type":"object"},"tagIds":{"type":"array","items":{"type":"string","pattern":"^[0-9a-f]{32}$"},"readOnly":true},"accountType":{"type":"string"},"createdById":{"type":"string","pattern":"^[0-9a-f]{32}$"},"updatedById":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"group":{"$ref":"#/components/schemas/CustomerGroup"},"defaultPaymentMethod":{"$ref":"#/components/schemas/PaymentMethod"},"language":{"$ref":"#/components/schemas/Language"},"lastPaymentMethod":{"$ref":"#/components/schemas/PaymentMethod"},"defaultBillingAddress":{"$ref":"#/components/schemas/CustomerAddress"},"activeBillingAddress":{"$ref":"#/components/schemas/CustomerAddress"},"defaultShippingAddress":{"$ref":"#/components/schemas/CustomerAddress"},"activeShippingAddress":{"$ref":"#/components/schemas/CustomerAddress"},"salutation":{"$ref":"#/components/schemas/Salutation"},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/CustomerAddress"}},"tags":{"type":"array","items":{"$ref":"#/components/schemas/Tag"}}},"type":"object"},"CustomerAddress":{"description":"Added since version: 6.0.0.0","required":["id","customerId","countryId","firstName","lastName","city","street","createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"customerId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"countryId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"countryStateId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"salutationId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"firstName":{"type":"string"},"lastName":{"type":"string"},"zipcode":{"type":"string"},"city":{"type":"string"},"company":{"type":"string"},"street":{"type":"string"},"department":{"type":"string"},"title":{"type":"string"},"phoneNumber":{"type":"string"},"additionalAddressLine1":{"type":"string"},"additionalAddressLine2":{"type":"string"},"customFields":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"country":{"$ref":"#/components/schemas/Country"},"countryState":{"$ref":"#/components/schemas/CountryState"},"salutation":{"$ref":"#/components/schemas/Salutation"}},"type":"object"},"CustomerGroup":{"description":"Added since version: 6.0.0.0","required":["translated","id","createdAt","name"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"name":{"type":"string"},"displayGross":{"type":"boolean"},"customFields":{"type":"object"},"registrationActive":{"type":"boolean"},"registrationTitle":{"type":"string"},"registrationIntroduction":{"type":"string"},"registrationOnlyCompanyRegistration":{"type":"boolean"},"registrationSeoMetaDescription":{"type":"string"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object","properties":{"name":{"type":"string"},"registrationIntroduction":{"type":"string"},"registrationSeoMetaDescription":{"type":"string"},"registrationTitle":{"type":"string"}}}},"type":"object"},"CustomerRecovery":{"description":"Added since version: 6.1.0.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"CustomerTag":{"description":"Added since version: 6.0.0.0","required":["customerId","tagId"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"customerId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"tagId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"tag":{"$ref":"#/components/schemas/Tag"}},"type":"object"},"CustomerWishlist":{"description":"Added since version: 6.3.4.0","required":["id","customerId","createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"customerId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"customFields":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"CustomerWishlistProduct":{"description":"Added since version: 6.3.4.0","required":["id","productId","createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"productId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"productVersionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"DeliveryTime":{"description":"Added since version: 6.0.0.0","required":["id","name","min","max","unit","createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"name":{"type":"string"},"min":{"type":"integer","format":"int64"},"max":{"type":"integer","format":"int64"},"unit":{"type":"string"},"customFields":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"}},"type":"object"},"Document":{"description":"Added since version: 6.0.0.0","required":["id","documentTypeId","fileType","orderId","config","deepLinkCode","createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"documentTypeId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"fileType":{"type":"string"},"referencedDocumentId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"orderId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"documentMediaFileId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"orderVersionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"config":{"type":"object","properties":{"name":{"type":"string"},"title":{"type":"string"}},"required":["name","title"]},"sent":{"type":"boolean"},"static":{"type":"boolean"},"deepLinkCode":{"type":"string"},"documentNumber":{"type":"string"},"customFields":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"documentType":{"$ref":"#/components/schemas/DocumentType"},"order":{"$ref":"#/components/schemas/Order"},"referencedDocument":{"$ref":"#/components/schemas/Document"},"dependentDocuments":{"type":"array","items":{"$ref":"#/components/schemas/Document"}},"documentMediaFile":{"$ref":"#/components/schemas/Media"}},"type":"object"},"DocumentBaseConfig":{"description":"Added since version: 6.0.0.0","required":["id","documentTypeId","name","global","createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"documentTypeId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"logoId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"name":{"type":"string"},"filenamePrefix":{"type":"string"},"filenameSuffix":{"type":"string"},"global":{"type":"boolean"},"documentNumber":{"type":"string"},"config":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"customFields":{"type":"object"},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"logo":{"$ref":"#/components/schemas/Media"}},"type":"object"},"DocumentBaseConfigSalesChannel":{"description":"Added since version: 6.0.0.0","required":["id","documentBaseConfigId","createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"documentBaseConfigId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"salesChannelId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"documentTypeId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"DocumentType":{"description":"Added since version: 6.0.0.0","required":["id","technicalName","createdAt","name"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"name":{"type":"string"},"technicalName":{"type":"string"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"customFields":{"type":"object"},"translated":{"type":"object"}},"type":"object"},"Flow":{"description":"Added since version: 6.4.6.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"FlowSequence":{"description":"Added since version: 6.4.6.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"FlowTemplate":{"description":"Added since version: 6.4.18.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"ImportExportFile":{"description":"Added since version: 6.0.0.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"ImportExportLog":{"description":"Added since version: 6.0.0.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"ImportExportProfile":{"description":"Added since version: 6.0.0.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"}},"type":"object"},"Integration":{"description":"Added since version: 6.0.0.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"LandingPageJsonApi":{"description":"Added since version: 6.4.0.0","allOf":[{"$ref":"#/components/schemas/resource"},{"required":["id","createdAt","name","url"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"versionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"active":{"type":"boolean"},"name":{"type":"string"},"customFields":{"type":"object"},"slotConfig":{"type":"object"},"metaTitle":{"type":"string"},"metaDescription":{"type":"string"},"keywords":{"type":"string"},"url":{"type":"string"},"cmsPageId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"cmsPageVersionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"},"relationships":{"properties":{"cmsPage":{"properties":{"links":{"type":"object","properties":{"related":{"type":"string","format":"uri-reference","example":"/landing-page/815c27537bec3b60c50a2ae4d2ce875d/cmsPage"}}},"data":{"type":"object","properties":{"type":{"type":"string","example":"cms_page"},"id":{"type":"string","pattern":"^[0-9a-f]{32}$","example":"7b1460918b1abb93311108f3dc021c9b"}}}},"type":"object"},"seoUrls":{"properties":{"links":{"type":"object","properties":{"related":{"type":"string","format":"uri-reference","example":"/landing-page/815c27537bec3b60c50a2ae4d2ce875d/seoUrls"}}},"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","example":"seo_url"},"id":{"type":"string","example":"5321b5a71127b8b98cdd4b068ad56c4c"}}}}},"type":"object"}},"type":"object"}},"type":"object"}]},"LandingPage":{"description":"Added since version: 6.4.0.0","required":["apiAlias","id","createdAt","name","url"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"versionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"active":{"type":"boolean"},"name":{"type":"string"},"customFields":{"type":"object"},"slotConfig":{"type":"object"},"metaTitle":{"type":"string"},"metaDescription":{"type":"string"},"keywords":{"type":"string"},"url":{"type":"string"},"cmsPageId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"cmsPageVersionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"},"cmsPage":{"$ref":"#/components/schemas/CmsPage"},"seoUrls":{"type":"array","items":{"$ref":"#/components/schemas/SeoUrl"}},"apiAlias":{"type":"string","enum":["landing_page"]}},"type":"object"},"LanguageJsonApi":{"description":"Added since version: 6.0.0.0","allOf":[{"$ref":"#/components/schemas/resource"},{"required":["id","localeId","name","createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"parentId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"localeId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"translationCodeId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"name":{"type":"string"},"customFields":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"relationships":{"properties":{"parent":{"properties":{"links":{"type":"object","properties":{"related":{"type":"string","format":"uri-reference","example":"/language/4994a8ffeba4ac3140beb89e8d41f174/parent"}}},"data":{"type":"object","properties":{"type":{"type":"string","example":"language"},"id":{"type":"string","pattern":"^[0-9a-f]{32}$","example":"d0e45878043844ffc41aac437e86b602"}}}},"type":"object"},"locale":{"properties":{"links":{"type":"object","properties":{"related":{"type":"string","format":"uri-reference","example":"/language/4994a8ffeba4ac3140beb89e8d41f174/locale"}}},"data":{"type":"object","properties":{"type":{"type":"string","example":"locale"},"id":{"type":"string","pattern":"^[0-9a-f]{32}$","example":"fb216d9e8791e63c8d12bdc420956839"}}}},"type":"object"},"translationCode":{"properties":{"links":{"type":"object","properties":{"related":{"type":"string","format":"uri-reference","example":"/language/4994a8ffeba4ac3140beb89e8d41f174/translationCode"}}},"data":{"type":"object","properties":{"type":{"type":"string","example":"locale"},"id":{"type":"string","pattern":"^[0-9a-f]{32}$","example":"6ef2035242b8fcb7b61c3a41850e60b3"}}}},"type":"object"},"children":{"properties":{"links":{"type":"object","properties":{"related":{"type":"string","format":"uri-reference","example":"/language/4994a8ffeba4ac3140beb89e8d41f174/children"}}},"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","example":"language"},"id":{"type":"string","example":"268184c12df027f536154d099d497b31"}}}}},"type":"object"}},"type":"object"}},"type":"object"}]},"Language":{"description":"Added since version: 6.0.0.0","required":["id","localeId","name","createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"parentId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"localeId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"translationCodeId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"name":{"type":"string"},"customFields":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"parent":{"$ref":"#/components/schemas/Language"},"locale":{"$ref":"#/components/schemas/Locale"},"translationCode":{"$ref":"#/components/schemas/Locale"},"children":{"type":"array","items":{"$ref":"#/components/schemas/Language"}}},"type":"object"},"Locale":{"description":"Added since version: 6.0.0.0","required":["id","code","createdAt","name","territory"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"code":{"type":"string"},"name":{"type":"string"},"territory":{"type":"string"},"customFields":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"}},"type":"object"},"LogEntry":{"description":"Added since version: 6.0.0.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"MailHeaderFooter":{"description":"Added since version: 6.0.0.0","required":["createdAt","name"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"systemDefault":{"type":"boolean"},"name":{"type":"string"},"description":{"type":"string"},"headerHtml":{"type":"string"},"headerPlain":{"type":"string"},"footerHtml":{"type":"string"},"footerPlain":{"type":"string"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"}},"type":"object"},"MailTemplate":{"description":"Added since version: 6.0.0.0","required":["createdAt","subject","contentHtml","contentPlain"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"systemDefault":{"type":"boolean"},"senderName":{"type":"string"},"contentHtml":{"type":"string"},"contentPlain":{"type":"string"},"customFields":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"},"mailTemplateType":{"$ref":"#/components/schemas/MailTemplateType"},"media":{"type":"array","items":{"$ref":"#/components/schemas/MailTemplateMedia"}}},"type":"object"},"MailTemplateMedia":{"description":"Added since version: 6.0.0.0","required":["id","mailTemplateId","languageId","mediaId"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"mailTemplateId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"languageId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"mediaId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"position":{"type":"integer","format":"int64"},"media":{"$ref":"#/components/schemas/Media"}},"type":"object"},"MailTemplateType":{"description":"Added since version: 6.0.0.0","required":["id","technicalName","createdAt","name"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"name":{"type":"string"},"technicalName":{"type":"string"},"customFields":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"}},"type":"object"},"MainCategoryJsonApi":{"description":"Added since version: 6.1.0.0","allOf":[{"$ref":"#/components/schemas/resource"},{"required":["id","productId","categoryId","salesChannelId","createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"productId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"productVersionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"categoryId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"categoryVersionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"salesChannelId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"}]},"MainCategory":{"description":"Added since version: 6.1.0.0","required":["id","productId","categoryId","salesChannelId","createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"productId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"productVersionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"categoryId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"categoryVersionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"salesChannelId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"Media":{"description":"Added since version: 6.0.0.0","required":["apiAlias","fileExtension","fileName","hasFile","path","private","url","id","createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"mimeType":{"type":"string","readOnly":true},"fileExtension":{"type":"string","readOnly":true},"uploadedAt":{"type":"string","format":"date-time","readOnly":true},"fileName":{"type":"string","readOnly":true},"fileSize":{"type":"integer","format":"int64","readOnly":true},"metaData":{"type":"object","readOnly":true},"config":{"type":"object"},"alt":{"type":"string"},"title":{"type":"string"},"url":{"description":"Runtime field, cannot be used as part of the criteria.","type":"string"},"path":{"type":"string"},"hasFile":{"description":"Runtime field, cannot be used as part of the criteria.","type":"boolean"},"private":{"type":"boolean"},"customFields":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"},"thumbnails":{"type":"array","items":{"$ref":"#/components/schemas/MediaThumbnail"}},"apiAlias":{"type":"string","enum":["media"]}},"type":"object"},"MediaDefaultFolder":{"description":"Added since version: 6.0.0.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"MediaFolder":{"description":"Added since version: 6.0.0.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"MediaFolderConfiguration":{"description":"Added since version: 6.0.0.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"MediaTag":{"description":"Added since version: 6.0.0.0","required":["mediaId","tagId"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"mediaId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"tagId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"media":{"$ref":"#/components/schemas/Media"},"tag":{"$ref":"#/components/schemas/Tag"}},"type":"object"},"MediaThumbnail":{"description":"Added since version: 6.0.0.0","required":["url","id","mediaId","width","height","createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"mediaId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"width":{"type":"integer","format":"int64","readOnly":true},"height":{"type":"integer","format":"int64","readOnly":true},"url":{"description":"Runtime field, cannot be used as part of the criteria.","type":"string"},"path":{"type":"string"},"customFields":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"MediaThumbnailSize":{"description":"Added since version: 6.0.0.0","required":["id","width","height","createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"width":{"type":"integer","format":"int64"},"height":{"type":"integer","format":"int64"},"customFields":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"NewsletterRecipientJsonApi":{"description":"Added since version: 6.0.0.0","allOf":[{"$ref":"#/components/schemas/resource"},{"required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"}]},"NewsletterRecipient":{"description":"Added since version: 6.0.0.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"Notification":{"description":"Added since version: 6.4.7.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"NumberRange":{"description":"Added since version: 6.0.0.0","required":["createdAt","name"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"}},"type":"object"},"NumberRangeSalesChannel":{"description":"Added since version: 6.0.0.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"NumberRangeState":{"description":"Added since version: 6.0.0.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"NumberRangeType":{"description":"Added since version: 6.0.0.0","required":["createdAt","typeName"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"}},"type":"object"},"Order":{"description":"Added since version: 6.0.0.0","required":["documents","orderDate","stateMachineState","id","billingAddressId","currencyId","languageId","salesChannelId","orderDateTime","currencyFactor","createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"versionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"orderNumber":{"type":"string"},"billingAddressId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"billingAddressVersionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"currencyId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"languageId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"salesChannelId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"orderDateTime":{"type":"string","format":"date-time"},"orderDate":{"type":"string","readOnly":true},"price":{"required":["netPrice","totalPrice","positionPrice","rawTotal","taxStatus"],"properties":{"netPrice":{"type":"number","format":"float"},"totalPrice":{"type":"number","format":"float"},"calculatedTaxes":{"type":"object"},"taxRules":{"type":"object"},"positionPrice":{"type":"number","format":"float"},"rawTotal":{"type":"number","format":"float"},"taxStatus":{"type":"string"}},"type":"object"},"amountTotal":{"type":"number","format":"float","readOnly":true},"amountNet":{"type":"number","format":"float","readOnly":true},"positionPrice":{"type":"number","format":"float","readOnly":true},"taxStatus":{"type":"string","readOnly":true},"shippingCosts":{"required":["unitPrice","totalPrice","quantity"],"properties":{"unitPrice":{"type":"number","format":"float"},"totalPrice":{"type":"number","format":"float"},"quantity":{"type":"integer","format":"int64"},"calculatedTaxes":{"type":"object"},"taxRules":{"type":"object"},"referencePrice":{"type":"object"},"listPrice":{"properties":{"price":{"type":"number","format":"float"},"discount":{"type":"number","format":"float"},"percentage":{"type":"number","format":"float"}},"type":"object"},"regulationPrice":{"properties":{"price":{"type":"number","format":"float"}},"type":"object"}},"type":"object"},"shippingTotal":{"type":"number","format":"float","readOnly":true},"currencyFactor":{"type":"number","format":"float"},"deepLinkCode":{"type":"string"},"affiliateCode":{"type":"string"},"campaignCode":{"type":"string"},"customerComment":{"type":"string"},"source":{"type":"string"},"customFields":{"type":"object"},"createdById":{"type":"string","pattern":"^[0-9a-f]{32}$"},"updatedById":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"stateMachineState":{"$ref":"#/components/schemas/StateMachineState"},"orderCustomer":{"$ref":"#/components/schemas/OrderCustomer"},"currency":{"$ref":"#/components/schemas/Currency"},"language":{"$ref":"#/components/schemas/Language"},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/OrderAddress"}},"billingAddress":{"$ref":"#/components/schemas/OrderAddress"},"deliveries":{"type":"array","items":{"$ref":"#/components/schemas/OrderDelivery"}},"lineItems":{"type":"array","items":{"$ref":"#/components/schemas/OrderLineItem"}},"transactions":{"type":"array","items":{"$ref":"#/components/schemas/OrderTransaction"}},"documents":{"type":"array","items":{"$ref":"#/components/schemas/Document"}},"tags":{"type":"array","items":{"$ref":"#/components/schemas/Tag"}}},"type":"object"},"OrderAddress":{"description":"Added since version: 6.0.0.0","required":["id","countryId","firstName","lastName","street","city","createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"versionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"countryId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"countryStateId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"firstName":{"type":"string"},"lastName":{"type":"string"},"street":{"type":"string"},"zipcode":{"type":"string"},"city":{"type":"string"},"company":{"type":"string"},"department":{"type":"string"},"title":{"type":"string"},"vatId":{"type":"string"},"phoneNumber":{"type":"string"},"additionalAddressLine1":{"type":"string"},"additionalAddressLine2":{"type":"string"},"customFields":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"country":{"$ref":"#/components/schemas/Country"},"countryState":{"$ref":"#/components/schemas/CountryState"},"salutation":{"$ref":"#/components/schemas/Salutation"}},"type":"object"},"OrderCustomer":{"description":"Added since version: 6.0.0.0","required":["id","email","firstName","lastName","createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"versionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"email":{"type":"string"},"salutationId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"firstName":{"type":"string"},"lastName":{"type":"string"},"company":{"type":"string"},"title":{"type":"string"},"vatIds":{"type":"array","items":{"type":"string"}},"customerNumber":{"type":"string"},"customFields":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"salutation":{"$ref":"#/components/schemas/Salutation"}},"type":"object"},"OrderDelivery":{"description":"Added since version: 6.0.0.0","required":["id","orderId","shippingOrderAddressId","shippingMethodId","stateId","trackingCodes","shippingDateEarliest","shippingDateLatest","createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"versionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"orderId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"orderVersionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"shippingOrderAddressId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"shippingOrderAddressVersionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"shippingMethodId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"stateId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"trackingCodes":{"type":"array","items":{"type":"string"}},"shippingDateEarliest":{"type":"string","format":"date-time"},"shippingDateLatest":{"type":"string","format":"date-time"},"shippingCosts":{"required":["unitPrice","totalPrice","quantity"],"properties":{"unitPrice":{"type":"number","format":"float"},"totalPrice":{"type":"number","format":"float"},"quantity":{"type":"integer","format":"int64"},"calculatedTaxes":{"type":"object"},"taxRules":{"type":"object"},"referencePrice":{"type":"object"},"listPrice":{"properties":{"price":{"type":"number","format":"float"},"discount":{"type":"number","format":"float"},"percentage":{"type":"number","format":"float"}},"type":"object"},"regulationPrice":{"properties":{"price":{"type":"number","format":"float"}},"type":"object"}},"type":"object"},"customFields":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"stateMachineState":{"$ref":"#/components/schemas/StateMachineState"},"shippingOrderAddress":{"$ref":"#/components/schemas/OrderAddress"},"shippingMethod":{"$ref":"#/components/schemas/ShippingMethod"},"positions":{"type":"array","items":{"$ref":"#/components/schemas/OrderDeliveryPosition"}}},"type":"object"},"OrderDeliveryPosition":{"description":"Added since version: 6.0.0.0","required":["id","orderDeliveryId","orderLineItemId","createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"versionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"orderDeliveryId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"orderDeliveryVersionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"orderLineItemId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"orderLineItemVersionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"price":{"required":["unitPrice","totalPrice","quantity"],"properties":{"unitPrice":{"type":"number","format":"float"},"totalPrice":{"type":"number","format":"float"},"quantity":{"type":"integer","format":"int64"},"calculatedTaxes":{"type":"object"},"taxRules":{"type":"object"},"referencePrice":{"type":"object"},"listPrice":{"properties":{"price":{"type":"number","format":"float"},"discount":{"type":"number","format":"float"},"percentage":{"type":"number","format":"float"}},"type":"object"},"regulationPrice":{"properties":{"price":{"type":"number","format":"float"}},"type":"object"}},"type":"object"},"unitPrice":{"type":"number","format":"float"},"totalPrice":{"type":"number","format":"float"},"quantity":{"type":"integer","format":"int64"},"customFields":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"OrderLineItem":{"description":"Added since version: 6.0.0.0","required":["id","orderId","identifier","quantity","label","position","states","children","createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"versionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"orderId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"orderVersionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"productId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"productVersionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"parentId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"parentVersionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"coverId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"identifier":{"type":"string"},"referencedId":{"type":"string"},"quantity":{"type":"integer","format":"int64"},"label":{"type":"string"},"payload":{"type":"object"},"good":{"type":"boolean"},"removable":{"type":"boolean"},"stackable":{"type":"boolean"},"position":{"type":"integer","format":"int64"},"states":{"type":"array","items":{"type":"string"}},"priceDefinition":{"type":"object"},"unitPrice":{"type":"number","format":"float"},"totalPrice":{"type":"number","format":"float"},"description":{"type":"string"},"type":{"type":"string"},"customFields":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"cover":{"$ref":"#/components/schemas/Media"},"orderDeliveryPositions":{"type":"array","items":{"$ref":"#/components/schemas/OrderDeliveryPosition"}},"downloads":{"type":"array","items":{"$ref":"#/components/schemas/OrderLineItemDownload"}},"parent":{"$ref":"#/components/schemas/OrderLineItem"},"children":{"type":"array","items":{"$ref":"#/components/schemas/OrderLineItem"}}},"type":"object"},"OrderLineItemDownload":{"description":"Added since version: 6.4.19.0","required":["media","id","orderLineItemId","mediaId","position","accessGranted","createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"versionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"orderLineItemId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"orderLineItemVersionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"mediaId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"position":{"type":"integer","format":"int64"},"accessGranted":{"type":"boolean"},"customFields":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"orderLineItem":{"$ref":"#/components/schemas/OrderLineItem"},"media":{"$ref":"#/components/schemas/Media"}},"type":"object"},"OrderTag":{"description":"Added since version: 6.0.0.0","required":["orderId","tagId"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"orderId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"orderVersionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"tagId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"order":{"$ref":"#/components/schemas/Order"},"tag":{"$ref":"#/components/schemas/Tag"}},"type":"object"},"OrderTransaction":{"description":"Added since version: 6.0.0.0","required":["id","orderId","paymentMethodId","amount","stateId","createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"versionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"orderId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"orderVersionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"paymentMethodId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"amount":{"required":["unitPrice","totalPrice","quantity"],"properties":{"unitPrice":{"type":"number","format":"float"},"totalPrice":{"type":"number","format":"float"},"quantity":{"type":"integer","format":"int64"},"calculatedTaxes":{"type":"object"},"taxRules":{"type":"object"},"referencePrice":{"type":"object"},"listPrice":{"properties":{"price":{"type":"number","format":"float"},"discount":{"type":"number","format":"float"},"percentage":{"type":"number","format":"float"}},"type":"object"},"regulationPrice":{"properties":{"price":{"type":"number","format":"float"}},"type":"object"}},"type":"object"},"stateId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"customFields":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"stateMachineState":{"$ref":"#/components/schemas/StateMachineState"},"paymentMethod":{"$ref":"#/components/schemas/PaymentMethod"},"captures":{"type":"array","items":{"$ref":"#/components/schemas/OrderTransactionCapture"}}},"type":"object"},"OrderTransactionCapture":{"description":"Added since version: 6.4.12.0","required":["id","orderTransactionId","stateId","amount","createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"versionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"orderTransactionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"orderTransactionVersionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"stateId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"externalReference":{"type":"string"},"amount":{"required":["unitPrice","totalPrice","quantity"],"properties":{"unitPrice":{"type":"number","format":"float"},"totalPrice":{"type":"number","format":"float"},"quantity":{"type":"integer","format":"int64"},"calculatedTaxes":{"type":"object"},"taxRules":{"type":"object"},"referencePrice":{"type":"object"},"listPrice":{"properties":{"price":{"type":"number","format":"float"},"discount":{"type":"number","format":"float"},"percentage":{"type":"number","format":"float"}},"type":"object"},"regulationPrice":{"properties":{"price":{"type":"number","format":"float"}},"type":"object"}},"type":"object"},"customFields":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"stateMachineState":{"$ref":"#/components/schemas/StateMachineState"},"transaction":{"$ref":"#/components/schemas/OrderTransaction"},"refunds":{"type":"array","items":{"$ref":"#/components/schemas/OrderTransactionCaptureRefund"}}},"type":"object"},"OrderTransactionCaptureRefund":{"description":"Added since version: 6.4.12.0","required":["id","captureId","stateId","amount","createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"versionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"captureId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"captureVersionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"stateId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"externalReference":{"type":"string"},"reason":{"type":"string"},"amount":{"required":["unitPrice","totalPrice","quantity"],"properties":{"unitPrice":{"type":"number","format":"float"},"totalPrice":{"type":"number","format":"float"},"quantity":{"type":"integer","format":"int64"},"calculatedTaxes":{"type":"object"},"taxRules":{"type":"object"},"referencePrice":{"type":"object"},"listPrice":{"properties":{"price":{"type":"number","format":"float"},"discount":{"type":"number","format":"float"},"percentage":{"type":"number","format":"float"}},"type":"object"},"regulationPrice":{"properties":{"price":{"type":"number","format":"float"}},"type":"object"}},"type":"object"},"customFields":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"stateMachineState":{"$ref":"#/components/schemas/StateMachineState"},"transactionCapture":{"$ref":"#/components/schemas/OrderTransactionCapture"},"positions":{"type":"array","items":{"$ref":"#/components/schemas/OrderTransactionCaptureRefundPosition"}}},"type":"object"},"OrderTransactionCaptureRefundPosition":{"description":"Added since version: 6.4.12.0","required":["id","refundId","orderLineItemId","amount","createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"versionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"refundId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"refundVersionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"orderLineItemId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"orderLineItemVersionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"externalReference":{"type":"string"},"reason":{"type":"string"},"quantity":{"type":"integer","format":"int64"},"amount":{"required":["unitPrice","totalPrice","quantity"],"properties":{"unitPrice":{"type":"number","format":"float"},"totalPrice":{"type":"number","format":"float"},"quantity":{"type":"integer","format":"int64"},"calculatedTaxes":{"type":"object"},"taxRules":{"type":"object"},"referencePrice":{"type":"object"},"listPrice":{"properties":{"price":{"type":"number","format":"float"},"discount":{"type":"number","format":"float"},"percentage":{"type":"number","format":"float"}},"type":"object"},"regulationPrice":{"properties":{"price":{"type":"number","format":"float"}},"type":"object"}},"type":"object"},"customFields":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"orderLineItem":{"$ref":"#/components/schemas/OrderLineItem"},"orderTransactionCaptureRefund":{"$ref":"#/components/schemas/OrderTransactionCaptureRefund"}},"type":"object"},"PaymentMethodJsonApi":{"description":"Added since version: 6.0.0.0","allOf":[{"$ref":"#/components/schemas/resource"},{"required":["id","createdAt","name"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"name":{"type":"string"},"distinguishableName":{"type":"string","readOnly":true},"description":{"type":"string"},"position":{"type":"integer","format":"int64"},"active":{"type":"boolean"},"afterOrderEnabled":{"type":"boolean"},"customFields":{"type":"object"},"mediaId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"synchronous":{"description":"Runtime field, cannot be used as part of the criteria.","type":"boolean","readOnly":true},"asynchronous":{"description":"Runtime field, cannot be used as part of the criteria.","type":"boolean","readOnly":true},"prepared":{"description":"Runtime field, cannot be used as part of the criteria.","type":"boolean","readOnly":true},"refundable":{"description":"Runtime field, cannot be used as part of the criteria.","type":"boolean","readOnly":true},"recurring":{"description":"Runtime field, cannot be used as part of the criteria.","type":"boolean","readOnly":true},"shortName":{"description":"Runtime field, cannot be used as part of the criteria.","type":"string"},"technicalName":{"type":"string"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"},"relationships":{"properties":{"media":{"properties":{"links":{"type":"object","properties":{"related":{"type":"string","format":"uri-reference","example":"/payment-method/da8da1569e6bef3249a7064261df833f/media"}}},"data":{"type":"object","properties":{"type":{"type":"string","example":"media"},"id":{"type":"string","pattern":"^[0-9a-f]{32}$","example":"62933a2951ef01f4eafd9bdf4d3cd2f0"}}}},"type":"object"}},"type":"object"}},"type":"object"}]},"PaymentMethod":{"description":"Added since version: 6.0.0.0","required":["id","createdAt","name"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"name":{"type":"string"},"distinguishableName":{"type":"string","readOnly":true},"description":{"type":"string"},"position":{"type":"integer","format":"int64"},"active":{"type":"boolean"},"afterOrderEnabled":{"type":"boolean"},"customFields":{"type":"object"},"mediaId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"synchronous":{"description":"Runtime field, cannot be used as part of the criteria.","type":"boolean","readOnly":true},"asynchronous":{"description":"Runtime field, cannot be used as part of the criteria.","type":"boolean","readOnly":true},"prepared":{"description":"Runtime field, cannot be used as part of the criteria.","type":"boolean","readOnly":true},"refundable":{"description":"Runtime field, cannot be used as part of the criteria.","type":"boolean","readOnly":true},"recurring":{"description":"Runtime field, cannot be used as part of the criteria.","type":"boolean","readOnly":true},"shortName":{"description":"Runtime field, cannot be used as part of the criteria.","type":"string"},"technicalName":{"type":"string"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"},"media":{"$ref":"#/components/schemas/Media"}},"type":"object"},"Plugin":{"description":"Added since version: 6.0.0.0","required":["createdAt","label"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"}},"type":"object"},"ProductJsonApi":{"description":"Added since version: 6.0.0.0","allOf":[{"$ref":"#/components/schemas/resource"},{"required":["id","taxId","productNumber","stock","createdAt","name"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"versionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"parentId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"parentVersionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"manufacturerId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"productManufacturerVersionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"unitId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"taxId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"coverId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"productMediaVersionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"deliveryTimeId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"canonicalProductId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"cmsPageId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"cmsPageVersionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"productNumber":{"type":"string"},"restockTime":{"type":"integer","format":"int64"},"active":{"type":"boolean"},"available":{"type":"boolean","readOnly":true},"isCloseout":{"type":"boolean"},"availableStock":{"type":"integer","format":"int64","readOnly":true},"stock":{"type":"integer","format":"int64"},"displayGroup":{"type":"string","readOnly":true},"manufacturerNumber":{"type":"string"},"ean":{"type":"string"},"purchaseSteps":{"type":"integer","format":"int64"},"maxPurchase":{"type":"integer","format":"int64"},"minPurchase":{"type":"integer","format":"int64"},"purchaseUnit":{"type":"number","format":"float"},"referenceUnit":{"type":"number","format":"float"},"shippingFree":{"type":"boolean"},"markAsTopseller":{"type":"boolean"},"weight":{"type":"number","format":"float"},"width":{"type":"number","format":"float"},"height":{"type":"number","format":"float"},"length":{"type":"number","format":"float"},"releaseDate":{"type":"string","format":"date-time"},"ratingAverage":{"type":"number","format":"float","readOnly":true},"categoryTree":{"type":"array","items":{"type":"string","pattern":"^[0-9a-f]{32}$"},"readOnly":true},"propertyIds":{"type":"array","items":{"type":"string","pattern":"^[0-9a-f]{32}$"},"readOnly":true},"optionIds":{"type":"array","items":{"type":"string","pattern":"^[0-9a-f]{32}$"},"readOnly":true},"streamIds":{"type":"array","items":{"type":"string","pattern":"^[0-9a-f]{32}$"},"readOnly":true},"tagIds":{"type":"array","items":{"type":"string","pattern":"^[0-9a-f]{32}$"},"readOnly":true},"categoryIds":{"type":"array","items":{"type":"string","pattern":"^[0-9a-f]{32}$"},"readOnly":true},"childCount":{"type":"integer","format":"int64","readOnly":true},"sales":{"type":"integer","format":"int64","readOnly":true},"states":{"type":"array","items":{"type":"string"},"readOnly":true},"metaDescription":{"type":"string"},"name":{"type":"string"},"keywords":{"type":"string"},"description":{"type":"string"},"metaTitle":{"type":"string"},"packUnit":{"type":"string"},"packUnitPlural":{"type":"string"},"customFields":{"type":"object"},"calculatedPrice":{"type":"object"},"calculatedPrices":{"type":"array","items":{"type":"object","additionalProperties":false}},"calculatedMaxPurchase":{"description":"Runtime field, cannot be used as part of the criteria.","type":"integer","format":"int64"},"calculatedCheapestPrice":{"type":"object"},"isNew":{"description":"Runtime field, cannot be used as part of the criteria.","type":"boolean"},"sortedProperties":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"},"relationships":{"properties":{"downloads":{"properties":{"links":{"type":"object","properties":{"related":{"type":"string","format":"uri-reference","example":"/product/deb10517653c255364175796ace3553f/downloads"}}},"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","example":"product_download"},"id":{"type":"string","example":"d07d50a751bc6ddf12bf3af0efee9b45"}}}}},"type":"object"},"parent":{"properties":{"links":{"type":"object","properties":{"related":{"type":"string","format":"uri-reference","example":"/product/deb10517653c255364175796ace3553f/parent"}}},"data":{"type":"object","properties":{"type":{"type":"string","example":"product"},"id":{"type":"string","pattern":"^[0-9a-f]{32}$","example":"d0e45878043844ffc41aac437e86b602"}}}},"type":"object"},"children":{"properties":{"links":{"type":"object","properties":{"related":{"type":"string","format":"uri-reference","example":"/product/deb10517653c255364175796ace3553f/children"}}},"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","example":"product"},"id":{"type":"string","example":"268184c12df027f536154d099d497b31"}}}}},"type":"object"},"deliveryTime":{"properties":{"links":{"type":"object","properties":{"related":{"type":"string","format":"uri-reference","example":"/product/deb10517653c255364175796ace3553f/deliveryTime"}}},"data":{"type":"object","properties":{"type":{"type":"string","example":"delivery_time"},"id":{"type":"string","pattern":"^[0-9a-f]{32}$","example":"8c888ae25a7bd42057370e31f7e01044"}}}},"type":"object"},"tax":{"properties":{"links":{"type":"object","properties":{"related":{"type":"string","format":"uri-reference","example":"/product/deb10517653c255364175796ace3553f/tax"}}},"data":{"type":"object","properties":{"type":{"type":"string","example":"tax"},"id":{"type":"string","pattern":"^[0-9a-f]{32}$","example":"06565e5611f23fdf8cc43e5077b92b54"}}}},"type":"object"},"manufacturer":{"properties":{"links":{"type":"object","properties":{"related":{"type":"string","format":"uri-reference","example":"/product/deb10517653c255364175796ace3553f/manufacturer"}}},"data":{"type":"object","properties":{"type":{"type":"string","example":"product_manufacturer"},"id":{"type":"string","pattern":"^[0-9a-f]{32}$","example":"c2904bca62b22443d6cf5e9d89cab204"}}}},"type":"object"},"unit":{"properties":{"links":{"type":"object","properties":{"related":{"type":"string","format":"uri-reference","example":"/product/deb10517653c255364175796ace3553f/unit"}}},"data":{"type":"object","properties":{"type":{"type":"string","example":"unit"},"id":{"type":"string","pattern":"^[0-9a-f]{32}$","example":"3e34bdebd9bd5edda27e8728904a2552"}}}},"type":"object"},"cover":{"properties":{"links":{"type":"object","properties":{"related":{"type":"string","format":"uri-reference","example":"/product/deb10517653c255364175796ace3553f/cover"}}},"data":{"type":"object","properties":{"type":{"type":"string","example":"product_media"},"id":{"type":"string","pattern":"^[0-9a-f]{32}$","example":"41d0e299ca1abeb2094852da042165c7"}}}},"type":"object"},"cmsPage":{"properties":{"links":{"type":"object","properties":{"related":{"type":"string","format":"uri-reference","example":"/product/deb10517653c255364175796ace3553f/cmsPage"}}},"data":{"type":"object","properties":{"type":{"type":"string","example":"cms_page"},"id":{"type":"string","pattern":"^[0-9a-f]{32}$","example":"7b1460918b1abb93311108f3dc021c9b"}}}},"type":"object"},"canonicalProduct":{"properties":{"links":{"type":"object","properties":{"related":{"type":"string","format":"uri-reference","example":"/product/deb10517653c255364175796ace3553f/canonicalProduct"}}},"data":{"type":"object","properties":{"type":{"type":"string","example":"product"},"id":{"type":"string","pattern":"^[0-9a-f]{32}$","example":"023995a50b56c0de077323e958b2bbcd"}}}},"type":"object"},"media":{"properties":{"links":{"type":"object","properties":{"related":{"type":"string","format":"uri-reference","example":"/product/deb10517653c255364175796ace3553f/media"}}},"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","example":"product_media"},"id":{"type":"string","example":"62933a2951ef01f4eafd9bdf4d3cd2f0"}}}}},"type":"object"},"crossSellings":{"properties":{"links":{"type":"object","properties":{"related":{"type":"string","format":"uri-reference","example":"/product/deb10517653c255364175796ace3553f/crossSellings"}}},"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","example":"product_cross_selling"},"id":{"type":"string","example":"89936e14544d1b403cecef938101b6b0"}}}}},"type":"object"},"configuratorSettings":{"properties":{"links":{"type":"object","properties":{"related":{"type":"string","format":"uri-reference","example":"/product/deb10517653c255364175796ace3553f/configuratorSettings"}}},"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","example":"product_configurator_setting"},"id":{"type":"string","example":"c0827fee13725d41f1fd7e292243f5aa"}}}}},"type":"object"},"productReviews":{"properties":{"links":{"type":"object","properties":{"related":{"type":"string","format":"uri-reference","example":"/product/deb10517653c255364175796ace3553f/productReviews"}}},"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","example":"product_review"},"id":{"type":"string","example":"01e78541ea343ed72424a5222796a4cd"}}}}},"type":"object"},"mainCategories":{"properties":{"links":{"type":"object","properties":{"related":{"type":"string","format":"uri-reference","example":"/product/deb10517653c255364175796ace3553f/mainCategories"}}},"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","example":"main_category"},"id":{"type":"string","example":"1fb731fc4139cbb575429e28846f0c39"}}}}},"type":"object"},"seoUrls":{"properties":{"links":{"type":"object","properties":{"related":{"type":"string","format":"uri-reference","example":"/product/deb10517653c255364175796ace3553f/seoUrls"}}},"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","example":"seo_url"},"id":{"type":"string","example":"5321b5a71127b8b98cdd4b068ad56c4c"}}}}},"type":"object"},"options":{"properties":{"links":{"type":"object","properties":{"related":{"type":"string","format":"uri-reference","example":"/product/deb10517653c255364175796ace3553f/options"}}},"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","example":"property_group_option"},"id":{"type":"string","example":"93da65a9fd0004d9477aeac024e08e15"}}}}},"type":"object"},"properties":{"properties":{"links":{"type":"object","properties":{"related":{"type":"string","format":"uri-reference","example":"/product/deb10517653c255364175796ace3553f/properties"}}},"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","example":"property_group_option"},"id":{"type":"string","example":"74693d2fc58b46bd06410f278e39aa71"}}}}},"type":"object"},"categories":{"properties":{"links":{"type":"object","properties":{"related":{"type":"string","format":"uri-reference","example":"/product/deb10517653c255364175796ace3553f/categories"}}},"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","example":"category"},"id":{"type":"string","example":"b0b5ccb4a195a07fd3eed14affb8695f"}}}}},"type":"object"},"streams":{"properties":{"links":{"type":"object","properties":{"related":{"type":"string","format":"uri-reference","example":"/product/deb10517653c255364175796ace3553f/streams"}}},"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","example":"product_stream"},"id":{"type":"string","example":"2f6f4768f1c2d7c8f1f54823723f1a70"}}}}},"type":"object"},"categoriesRo":{"properties":{"links":{"type":"object","properties":{"related":{"type":"string","format":"uri-reference","example":"/product/deb10517653c255364175796ace3553f/categoriesRo"}}},"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","example":"category"},"id":{"type":"string","example":"7f0702d3a90d965b8c9158c451f43fdb"}}}}},"type":"object"},"tags":{"properties":{"links":{"type":"object","properties":{"related":{"type":"string","format":"uri-reference","example":"/product/deb10517653c255364175796ace3553f/tags"}}},"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","example":"tag"},"id":{"type":"string","example":"d57ac45256849d9b13e2422d91580fb9"}}}}},"type":"object"},"seoCategory":{"properties":{"links":{"type":"object","properties":{"related":{"type":"string","format":"uri-reference","example":"/product/deb10517653c255364175796ace3553f/seoCategory"}}},"data":{"type":"object","properties":{"type":{"type":"string","example":"category"},"id":{"type":"string","pattern":"^[0-9a-f]{32}$","example":"9354d004d12e03d35ad8292bf0bb234d"}}}},"type":"object"}},"type":"object"}},"type":"object"}]},"Product":{"description":"Represents a product along with detailed information required to display a variant selection.","required":["apiAlias","calculatedPrice","calculatedPrices","seoCategory","id","taxId","productNumber","stock","createdAt","name"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"versionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"parentId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"parentVersionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"manufacturerId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"productManufacturerVersionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"unitId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"taxId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"coverId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"productMediaVersionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"deliveryTimeId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"canonicalProductId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"cmsPageId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"cmsPageVersionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"productNumber":{"type":"string"},"restockTime":{"type":"integer","format":"int64"},"active":{"type":"boolean"},"available":{"type":"boolean","readOnly":true},"isCloseout":{"type":"boolean"},"availableStock":{"type":"integer","format":"int64","readOnly":true},"stock":{"type":"integer","format":"int64"},"displayGroup":{"type":"string","readOnly":true},"manufacturerNumber":{"type":"string"},"ean":{"type":"string"},"purchaseSteps":{"type":"integer","format":"int64"},"maxPurchase":{"type":"integer","format":"int64"},"minPurchase":{"type":"integer","format":"int64"},"purchaseUnit":{"type":"number","format":"float"},"referenceUnit":{"type":"number","format":"float"},"shippingFree":{"type":"boolean"},"markAsTopseller":{"type":"boolean"},"weight":{"type":"number","format":"float"},"width":{"type":"number","format":"float"},"height":{"type":"number","format":"float"},"length":{"type":"number","format":"float"},"releaseDate":{"type":"string","format":"date-time"},"ratingAverage":{"type":"number","format":"float","readOnly":true},"categoryTree":{"type":"array","items":{"type":"string","pattern":"^[0-9a-f]{32}$"},"readOnly":true},"propertyIds":{"type":"array","items":{"type":"string","pattern":"^[0-9a-f]{32}$"},"readOnly":true},"optionIds":{"type":"array","items":{"type":"string","pattern":"^[0-9a-f]{32}$"},"readOnly":true},"streamIds":{"type":"array","items":{"type":"string","pattern":"^[0-9a-f]{32}$"},"readOnly":true},"tagIds":{"type":"array","items":{"type":"string","pattern":"^[0-9a-f]{32}$"},"readOnly":true},"categoryIds":{"type":"array","items":{"type":"string","pattern":"^[0-9a-f]{32}$"},"readOnly":true},"childCount":{"type":"integer","format":"int64","readOnly":true},"sales":{"type":"integer","format":"int64","readOnly":true},"states":{"type":"array","items":{"type":"string"},"readOnly":true},"metaDescription":{"type":"string"},"name":{"type":"string"},"keywords":{"type":"string"},"description":{"type":"string"},"metaTitle":{"type":"string"},"packUnit":{"type":"string"},"packUnitPlural":{"type":"string"},"customFields":{"type":"object"},"calculatedPrice":{"type":"object","$ref":"#/components/schemas/CalculatedPrice"},"calculatedPrices":{"type":"array","items":{"type":"object","additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/CalculatedPrice"}]}},"calculatedMaxPurchase":{"description":"Runtime field, cannot be used as part of the criteria.","type":"integer","format":"int64"},"calculatedCheapestPrice":{"type":"object","allOf":[{"$ref":"#/components/schemas/CalculatedPrice"},{"type":"object","properties":{"unitPrice":{"type":"number"},"quantity":{"type":"number"},"totalPrice":{"type":"number"},"referencePrice":{"oneOf":[{"$ref":"#/components/schemas/ReferencePrice"}],"nullable":true},"listPrice":{"oneOf":[{"$ref":"#/components/schemas/ListPrice"}],"nullable":true},"regulationPrice":{"type":"object","properties":{"price":{"type":"number"}},"required":["price"],"nullable":true},"hasRange":{"type":"boolean"},"variantId":{"type":"string","format":"","nullable":true},"apiAlias":{"type":"string","enum":["calculated_cheapest_price"]}}}]},"isNew":{"description":"Runtime field, cannot be used as part of the criteria.","type":"boolean"},"sortedProperties":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"},"downloads":{"type":"array","items":{"$ref":"#/components/schemas/ProductDownload"}},"parent":{"$ref":"#/components/schemas/Product"},"children":{"type":"array","items":{"$ref":"#/components/schemas/Product"}},"deliveryTime":{"$ref":"#/components/schemas/DeliveryTime"},"tax":{"$ref":"#/components/schemas/Tax"},"manufacturer":{"$ref":"#/components/schemas/ProductManufacturer"},"unit":{"$ref":"#/components/schemas/Unit"},"cover":{"$ref":"#/components/schemas/ProductMedia"},"cmsPage":{"$ref":"#/components/schemas/CmsPage"},"canonicalProduct":{"$ref":"#/components/schemas/Product"},"media":{"type":"array","items":{"$ref":"#/components/schemas/ProductMedia"}},"crossSellings":{"type":"array","items":{"$ref":"#/components/schemas/ProductCrossSelling"}},"configuratorSettings":{"type":"array","items":{"$ref":"#/components/schemas/ProductConfiguratorSetting"}},"productReviews":{"type":"array","items":{"$ref":"#/components/schemas/ProductReview"}},"mainCategories":{"type":"array","items":{"$ref":"#/components/schemas/MainCategory"}},"seoUrls":{"type":"array","items":{"$ref":"#/components/schemas/SeoUrl"}},"options":{"type":"array","items":{"$ref":"#/components/schemas/PropertyGroupOption"}},"properties":{"type":"array","items":{"$ref":"#/components/schemas/PropertyGroupOption"}},"categories":{"type":"array","items":{"$ref":"#/components/schemas/Category"}},"streams":{"type":"array","items":{"$ref":"#/components/schemas/ProductStream"}},"categoriesRo":{"type":"array","items":{"$ref":"#/components/schemas/Category"}},"tags":{"type":"array","items":{"$ref":"#/components/schemas/Tag"}},"seoCategory":{"$ref":"#/components/schemas/Category"},"apiAlias":{"type":"string","enum":["product"]},"variantListingConfig":{"nullable":true,"type":"object","properties":{"displayParent":{"type":"boolean"}}}},"type":"object"},"ProductConfiguratorSetting":{"description":"Added since version: 6.0.0.0","required":["id","productId","optionId","createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"versionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"productId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"productVersionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"mediaId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"optionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"position":{"type":"integer","format":"int64"},"customFields":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"media":{"$ref":"#/components/schemas/Media"},"option":{"$ref":"#/components/schemas/PropertyGroupOption"}},"type":"object"},"ProductCrossSelling":{"description":"Added since version: 6.1.0.0","required":["id","name","position","type","createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"name":{"type":"string"},"position":{"type":"integer","format":"int64"},"sortBy":{"type":"string"},"sortDirection":{"type":"string"},"type":{"type":"string"},"active":{"type":"boolean"},"limit":{"type":"integer","format":"int64"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"}},"type":"object"},"ProductCrossSellingAssignedProducts":{"description":"Added since version: 6.2.0.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"ProductDownload":{"description":"Added since version: 6.4.19.0","required":["id","productId","mediaId","createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"versionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"productId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"productVersionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"mediaId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"position":{"type":"integer","format":"int64"},"customFields":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"product":{"$ref":"#/components/schemas/Product"},"media":{"$ref":"#/components/schemas/Media"}},"type":"object"},"ProductExport":{"description":"Added since version: 6.1.0.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"ProductFeatureSet":{"description":"Added since version: 6.3.0.0","required":["createdAt","name"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"}},"type":"object"},"ProductKeywordDictionary":{"description":"Added since version: 6.0.0.0","required":["languageId","keyword"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"languageId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"keyword":{"type":"string"}},"type":"object"},"ProductManufacturer":{"description":"Added since version: 6.0.0.0","required":["id","createdAt","name"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"versionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"mediaId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"link":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"customFields":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"},"media":{"$ref":"#/components/schemas/Media"}},"type":"object"},"ProductMedia":{"description":"Added since version: 6.0.0.0","required":["id","productId","mediaId","createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"versionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"productId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"productVersionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"mediaId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"position":{"type":"integer","format":"int64"},"customFields":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"media":{"$ref":"#/components/schemas/Media"},"thumbnails":{"$ref":"#/components/schemas/MediaThumbnail"}},"type":"object"},"ProductPrice":{"description":"Added since version: 6.0.0.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"ProductReview":{"description":"Added since version: 6.0.0.0","required":["points","id","productId","salesChannelId","languageId","title","content","createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"productId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"productVersionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"salesChannelId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"languageId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"title":{"type":"string"},"content":{"type":"string"},"points":{"type":"number","format":"float"},"status":{"type":"boolean"},"comment":{"type":"string"},"customFields":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"ProductSearchConfig":{"description":"Added since version: 6.3.5.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"ProductSearchConfigField":{"description":"Added since version: 6.3.5.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"ProductSearchKeyword":{"description":"Added since version: 6.0.0.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"ProductSorting":{"description":"Added since version: 6.3.2.0","required":["key","priority","createdAt","label"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"key":{"type":"string"},"priority":{"type":"integer","format":"int64"},"label":{"type":"string"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"}},"type":"object"},"ProductStream":{"description":"Added since version: 6.0.0.0","required":["id","createdAt","name"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"name":{"type":"string"},"description":{"type":"string"},"customFields":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"}},"type":"object"},"ProductStreamFilter":{"description":"Added since version: 6.0.0.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"ProductVisibility":{"description":"Added since version: 6.0.0.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"Promotion":{"description":"Added since version: 6.0.0.0","required":["createdAt","name"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"customFields":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"}},"type":"object"},"PromotionDiscount":{"description":"Added since version: 6.0.0.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"PromotionDiscountPrices":{"description":"Added since version: 6.0.0.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"PromotionIndividualCode":{"description":"Added since version: 6.0.0.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"PromotionSalesChannel":{"description":"Added since version: 6.0.0.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"PromotionSetgroup":{"description":"Added since version: 6.0.0.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"PropertyGroup":{"description":"Added since version: 6.0.0.0","required":["id","displayType","sortingType","createdAt","name"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"name":{"type":"string"},"description":{"type":"string"},"displayType":{"type":"string"},"sortingType":{"type":"string"},"filterable":{"type":"boolean"},"visibleOnProductDetailPage":{"type":"boolean"},"position":{"type":"integer","format":"int64"},"customFields":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"},"options":{"type":"array","items":{"$ref":"#/components/schemas/PropertyGroupOption"}}},"type":"object"},"PropertyGroupOption":{"description":"Added since version: 6.0.0.0","required":["group","option","id","groupId","createdAt","name"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"groupId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"name":{"type":"string"},"position":{"type":"integer","format":"int64"},"colorHexCode":{"type":"string"},"mediaId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"customFields":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"},"media":{"$ref":"#/components/schemas/Media"},"group":{"$ref":"#/components/schemas/PropertyGroup"},"option":{"type":"string"}},"type":"object"},"Rule":{"description":"Added since version: 6.0.0.0","required":["name","createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"name":{"type":"string"},"description":{"type":"string"},"customFields":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"RuleCondition":{"description":"Added since version: 6.0.0.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"SalesChannel":{"description":"Added since version: 6.0.0.0","required":["id","languageId","customerGroupId","currencyId","paymentMethodId","shippingMethodId","countryId","navigationCategoryId","createdAt","name","homeEnabled"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"languageId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"customerGroupId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"currencyId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"paymentMethodId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"shippingMethodId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"countryId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"navigationCategoryId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"navigationCategoryVersionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"navigationCategoryDepth":{"type":"integer","format":"int64"},"footerCategoryId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"footerCategoryVersionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"serviceCategoryId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"serviceCategoryVersionId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"mailHeaderFooterId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"hreflangDefaultDomainId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"name":{"type":"string"},"shortName":{"type":"string"},"taxCalculationType":{"type":"string"},"configuration":{"type":"object"},"active":{"type":"boolean"},"hreflangActive":{"type":"boolean"},"maintenance":{"type":"boolean"},"customFields":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"},"language":{"$ref":"#/components/schemas/Language"},"currency":{"$ref":"#/components/schemas/Currency"},"paymentMethod":{"$ref":"#/components/schemas/PaymentMethod"},"shippingMethod":{"$ref":"#/components/schemas/ShippingMethod"},"country":{"$ref":"#/components/schemas/Country"},"domains":{"type":"array","items":{"$ref":"#/components/schemas/SalesChannelDomain"}},"navigationCategory":{"$ref":"#/components/schemas/Category"},"footerCategory":{"$ref":"#/components/schemas/Category"},"serviceCategory":{"$ref":"#/components/schemas/Category"},"hreflangDefaultDomain":{"$ref":"#/components/schemas/SalesChannelDomain"}},"type":"object"},"SalesChannelAnalytics":{"description":"Added since version: 6.2.0.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"SalesChannelDomain":{"description":"Added since version: 6.0.0.0","required":["id","url","salesChannelId","languageId","currencyId","snippetSetId","createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"url":{"type":"string"},"salesChannelId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"languageId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"currencyId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"snippetSetId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"hreflangUseOnlyLocale":{"type":"boolean"},"customFields":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"language":{"$ref":"#/components/schemas/Language"},"currency":{"$ref":"#/components/schemas/Currency"},"salesChannelDefaultHreflang":{"$ref":"#/components/schemas/SalesChannel"}},"type":"object"},"SalesChannelType":{"description":"Added since version: 6.0.0.0","required":["createdAt","name"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"}},"type":"object"},"SalutationJsonApi":{"description":"Added since version: 6.0.0.0","allOf":[{"$ref":"#/components/schemas/resource"},{"required":["id","salutationKey","createdAt","displayName","letterName"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"salutationKey":{"type":"string"},"displayName":{"type":"string"},"letterName":{"type":"string"},"customFields":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"}},"type":"object"}]},"Salutation":{"description":"Added since version: 6.0.0.0","required":["id","salutationKey","createdAt","displayName","letterName"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"salutationKey":{"type":"string"},"displayName":{"type":"string"},"letterName":{"type":"string"},"customFields":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"}},"type":"object"},"ScheduledTask":{"description":"Added since version: 6.0.0.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"Script":{"description":"Added since version: 6.4.7.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"SeoUrlJsonApi":{"description":"Added since version: 6.0.0.0","allOf":[{"$ref":"#/components/schemas/resource"},{"required":["id","languageId","foreignKey","routeName","pathInfo","seoPathInfo","createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"salesChannelId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"languageId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"foreignKey":{"type":"string","pattern":"^[0-9a-f]{32}$"},"routeName":{"type":"string"},"pathInfo":{"type":"string"},"seoPathInfo":{"type":"string"},"isCanonical":{"type":"boolean"},"isModified":{"type":"boolean"},"isDeleted":{"type":"boolean"},"error":{"description":"Runtime field, cannot be used as part of the criteria.","type":"string"},"url":{"description":"Runtime field, cannot be used as part of the criteria.","type":"string"},"customFields":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"}]},"SeoUrl":{"description":"Added since version: 6.0.0.0","required":["id","languageId","foreignKey","routeName","pathInfo","seoPathInfo","createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"salesChannelId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"languageId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"foreignKey":{"type":"string","pattern":"^[0-9a-f]{32}$"},"routeName":{"type":"string","enum":["frontend.navigation.page","frontend.landing.page","frontend.detail.page"]},"pathInfo":{"type":"string"},"seoPathInfo":{"type":"string"},"isCanonical":{"type":"boolean"},"isModified":{"type":"boolean"},"isDeleted":{"type":"boolean"},"error":{"description":"Runtime field, cannot be used as part of the criteria.","type":"string"},"url":{"description":"Runtime field, cannot be used as part of the criteria.","type":"string"},"customFields":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"SeoUrlTemplate":{"description":"Added since version: 6.0.0.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"salesChannelId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"isValid":{"type":"boolean"},"customFields":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"ShippingMethodJsonApi":{"description":"Added since version: 6.0.0.0","allOf":[{"$ref":"#/components/schemas/resource"},{"required":["id","deliveryTimeId","taxType","createdAt","name"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"name":{"type":"string"},"active":{"type":"boolean"},"position":{"type":"integer","format":"int64"},"customFields":{"type":"object"},"mediaId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"deliveryTimeId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"taxType":{"type":"string"},"description":{"type":"string"},"trackingUrl":{"type":"string"},"technicalName":{"type":"string"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"},"relationships":{"properties":{"deliveryTime":{"properties":{"links":{"type":"object","properties":{"related":{"type":"string","format":"uri-reference","example":"/shipping-method/d72e7a227a27328b28342b32fc66b6bf/deliveryTime"}}},"data":{"type":"object","properties":{"type":{"type":"string","example":"delivery_time"},"id":{"type":"string","pattern":"^[0-9a-f]{32}$","example":"8c888ae25a7bd42057370e31f7e01044"}}}},"type":"object"},"availabilityRule":{"properties":{"links":{"type":"object","properties":{"related":{"type":"string","format":"uri-reference","example":"/shipping-method/d72e7a227a27328b28342b32fc66b6bf/availabilityRule"}}},"data":{"type":"object","properties":{"type":{"type":"string","example":"rule"},"id":{"type":"string","pattern":"^[0-9a-f]{32}$","example":"9fbb7961d1cb158094924c679e1b302c"}}}},"type":"object"},"prices":{"properties":{"links":{"type":"object","properties":{"related":{"type":"string","format":"uri-reference","example":"/shipping-method/d72e7a227a27328b28342b32fc66b6bf/prices"}}},"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","example":"shipping_method_price"},"id":{"type":"string","example":"afae32efe0f84fece3f96b377b768b33"}}}}},"type":"object"},"media":{"properties":{"links":{"type":"object","properties":{"related":{"type":"string","format":"uri-reference","example":"/shipping-method/d72e7a227a27328b28342b32fc66b6bf/media"}}},"data":{"type":"object","properties":{"type":{"type":"string","example":"media"},"id":{"type":"string","pattern":"^[0-9a-f]{32}$","example":"62933a2951ef01f4eafd9bdf4d3cd2f0"}}}},"type":"object"},"tags":{"properties":{"links":{"type":"object","properties":{"related":{"type":"string","format":"uri-reference","example":"/shipping-method/d72e7a227a27328b28342b32fc66b6bf/tags"}}},"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","example":"tag"},"id":{"type":"string","example":"d57ac45256849d9b13e2422d91580fb9"}}}}},"type":"object"},"tax":{"properties":{"links":{"type":"object","properties":{"related":{"type":"string","format":"uri-reference","example":"/shipping-method/d72e7a227a27328b28342b32fc66b6bf/tax"}}},"data":{"type":"object","properties":{"type":{"type":"string","example":"tax"},"id":{"type":"string","pattern":"^[0-9a-f]{32}$","example":"06565e5611f23fdf8cc43e5077b92b54"}}}},"type":"object"}},"type":"object"}},"type":"object"}]},"ShippingMethod":{"description":"Added since version: 6.0.0.0","required":["id","deliveryTimeId","taxType","createdAt","name"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"name":{"type":"string"},"active":{"type":"boolean"},"position":{"type":"integer","format":"int64"},"customFields":{"type":"object"},"mediaId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"deliveryTimeId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"taxType":{"type":"string"},"description":{"type":"string"},"trackingUrl":{"type":"string"},"technicalName":{"type":"string"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"},"deliveryTime":{"$ref":"#/components/schemas/DeliveryTime"},"availabilityRule":{"$ref":"#/components/schemas/Rule"},"prices":{"type":"array","items":{"$ref":"#/components/schemas/ShippingMethodPrice"}},"media":{"$ref":"#/components/schemas/Media"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/Tag"}},"tax":{"$ref":"#/components/schemas/Tax"}},"type":"object"},"ShippingMethodPrice":{"description":"Added since version: 6.0.0.0","required":["id","shippingMethodId","createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"shippingMethodId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"ruleId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"calculation":{"type":"integer","format":"int64"},"calculationRuleId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"quantityStart":{"type":"number","format":"float"},"quantityEnd":{"type":"number","format":"float"},"currencyPrice":{"type":"object"},"customFields":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"Snippet":{"description":"Added since version: 6.0.0.0","required":["setId","translationKey","value","createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"setId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"translationKey":{"type":"string"},"value":{"type":"string"},"customFields":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"SnippetSet":{"description":"Added since version: 6.0.0.0","required":["name","iso","createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"name":{"type":"string"},"iso":{"type":"string"},"customFields":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"snippets":{"type":"array","items":{"$ref":"#/components/schemas/Snippet"}}},"type":"object"},"StateMachine":{"description":"Added since version: 6.0.0.0","required":["createdAt","name"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"},"states":{"type":"array","items":{"$ref":"#/components/schemas/StateMachineState"}},"transitions":{"type":"array","items":{"$ref":"#/components/schemas/StateMachineTransition"}}},"type":"object"},"StateMachineHistory":{"description":"Added since version: 6.0.0.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"fromStateMachineState":{"$ref":"#/components/schemas/StateMachineState"},"toStateMachineState":{"$ref":"#/components/schemas/StateMachineState"}},"type":"object"},"StateMachineState":{"description":"Added since version: 6.0.0.0","required":["technicalName","createdAt","name"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"technicalName":{"type":"string"},"name":{"type":"string"},"customFields":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"}},"type":"object"},"StateMachineTransition":{"description":"Added since version: 6.0.0.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"SystemConfig":{"description":"Added since version: 6.0.0.0","required":["id","configurationKey","configurationValue","createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"configurationKey":{"type":"string"},"configurationValue":{"properties":{"_value":{"type":"object"}},"type":"object"},"salesChannelId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"salesChannel":{"$ref":"#/components/schemas/SalesChannel"}},"type":"object"},"Tag":{"description":"Added since version: 6.0.0.0","required":["id","name","createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"name":{"type":"string"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"Tax":{"description":"Added since version: 6.0.0.0","required":["id","taxRate","name","position","createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"taxRate":{"type":"number","format":"float"},"name":{"type":"string"},"position":{"description":"Added since version: 6.4.0.0.","type":"integer","format":"int64"},"customFields":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"TaxProvider":{"description":"Added since version: 6.5.0.0","required":["id","priority","createdAt","name"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"active":{"type":"boolean"},"name":{"type":"string"},"priority":{"type":"integer","format":"int64"},"processUrl":{"type":"string"},"appId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"customFields":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"}},"type":"object"},"TaxRule":{"description":"Added since version: 6.1.0.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"TaxRuleType":{"description":"Added since version: 6.1.0.0","required":["createdAt","typeName"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"}},"type":"object"},"Theme":{"description":"Added since version: 6.0.0.0","required":["id","name","author","active","createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"technicalName":{"type":"string"},"name":{"type":"string"},"author":{"type":"string"},"description":{"type":"string"},"labels":{"type":"object"},"helpTexts":{"type":"object"},"customFields":{"type":"object"},"previewMediaId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"parentThemeId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"baseConfig":{"type":"object"},"configValues":{"type":"object"},"active":{"type":"boolean"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"},"media":{"type":"array","items":{"$ref":"#/components/schemas/Media"}}},"type":"object"},"Unit":{"description":"Added since version: 6.0.0.0","required":["id","createdAt","shortCode","name"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"shortCode":{"type":"string"},"name":{"type":"string"},"customFields":{"type":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"translated":{"type":"object"}},"type":"object"},"User":{"description":"Added since version: 6.0.0.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"UserAccessKey":{"description":"Added since version: 6.0.0.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"UserConfig":{"description":"Added since version: 6.3.5.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"UserRecovery":{"description":"Added since version: 6.0.0.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"Webhook":{"description":"Added since version: 6.3.1.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"WebhookEventLog":{"description":"Added since version: 6.4.1.0","required":["createdAt"],"properties":{"id":{"type":"string","pattern":"^[0-9a-f]{32}$"},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"type":"object"},"ProductListingFlags":{"type":"object","description":"Additional flags for product listings","properties":{"no-aggregations":{"description":"Resets all aggregations in the criteria. This parameter is a flag, the value has no effect.","type":"string","nullable":true},"only-aggregations":{"description":"If this flag is set, no products are fetched. Sorting and associations are also ignored. This parameter is a flag, the value has no effect.","type":"string","nullable":true}}},"SuccessResponse":{"type":"object","properties":{"success":{"type":"boolean"}}},"Sitemap":{"allOf":[{"$ref":"#/components/schemas/ArrayStruct"},{"type":"object","properties":{"filename":{"type":"string"},"created":{"type":"string","format":"date-time"}},"required":["filename","created"]}]},"Cart":{"allOf":[{"$ref":"#/components/schemas/ArrayStruct"},{"type":"object","properties":{"name":{"description":"Name of the cart - for example `guest-cart`","type":"string"},"token":{"description":"Context token identifying the cart and the user session","type":"string"},"price":{"type":"object","properties":{"netPrice":{"description":"Net price of the cart","type":"number","format":"float"},"totalPrice":{"description":"Total price of the cart, including shipping costs, discounts and taxes","type":"number","format":"float"},"positionPrice":{"description":"Price for all line items in the cart","type":"number","format":"float"},"taxStatus":{"description":"Tax calculation for the cart. One of `gross`, `net` or `tax-free`","type":"string"}}},"lineItems":{"description":"All items within the cart","type":"array","items":{"$ref":"#/components/schemas/LineItem"}},"errors":{"type":"array","description":"A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.","items":{"type":"object","properties":{"key":{"type":"string"},"level":{"type":"string"},"message":{"type":"string"}}}},"transactions":{"description":"A list of all payment transactions associated with the current cart.","type":"array","items":{"type":"object","properties":{"paymentMethodId":{"type":"string"}}}},"modified":{"type":"boolean"},"customerComment":{"type":"string","description":"A comment that can be added to the cart."},"affiliateCode":{"type":"string","description":"An affiliate tracking code"},"campaignCode":{"type":"string","description":"A campaign tracking code"}}}]},"NavigationType":{"type":"string","enum":["main-navigation","footer-navigation","service-navigation"]},"CrossSellingElementCollection":{"type":"array","items":{"$ref":"#/components/schemas/CrossSellingElement"}},"Struct":{"type":"object","properties":{"apiAlias":{"type":"string","description":"Alias which can be used to restrict response fields. For more information see [includes](https://shopware.stoplight.io/docs/store-api/docs/concepts/search-queries.md#includes-apialias)."}}},"CalculatedPrice":{"type":"object","description":"Represents a product along with detailed information required to display a variant selection.","properties":{"unitPrice":{"type":"number"},"quantity":{"type":"number"},"totalPrice":{"type":"number"},"calculatedTaxes":{"type":"array","items":{"type":"object","properties":{"apiAlias":{"type":"string","enum":["cart_tax_calculated"]},"tax":{"type":"number"},"taxRate":{"type":"number"},"price":{"type":"number"}},"required":["apiAlias","tax","taxRate","price"]}},"referencePrice":{"oneOf":[{"$ref":"#/components/schemas/ReferencePrice"}],"nullable":true},"listPrice":{"oneOf":[{"$ref":"#/components/schemas/ListPrice"}],"nullable":true},"regulationPrice":{"type":"object","properties":{"price":{"type":"number"},"apiAlias":{"type":"string","enum":["cart_regulation_price"]}},"nullable":true},"hasRange":{"type":"boolean"},"variantId":{"type":"string","format":"^[0-9a-f]{32}$","nullable":true},"apiAlias":{"type":"string","enum":["calculated_price"]}},"required":["apiAlias","hasRange","regulationPrice","listPrice","referencePrice","calculatedTaxes","totalPrice","quantity","unitPrice"]},"ProductListingCriteria":{"allOf":[{"$ref":"#/components/schemas/Criteria"},{"type":"object","description":"Additional search parameters for product listings","properties":{"order":{"description":"Specifies the sorting of the products by `availableSortings`. If not set, the default sorting will be set according to the shop settings. The available sorting options are sent within the response under the `availableSortings` key. In order to sort by a field, consider using the `sort` parameter from the listing criteria. Do not use both parameters together, as it might lead to unexpected results.","type":"string"},"limit":{"description":"Number of items per result page. If not set, the limit will be set according to the default products per page, defined in the system settings.","type":"integer","minimum":0},"p":{"description":"Search result page","type":"integer","default":1},"manufacturer":{"description":"Filter by manufacturers. List of manufacturer identifiers separated by a `|`.","type":"string"},"min-price":{"description":"Filters by a minimum product price. Has to be lower than the `max-price` filter.","type":"integer","minimum":0,"default":0},"max-price":{"description":"Filters by a maximum product price. Has to be higher than the `min-price` filter.","type":"integer","minimum":0,"default":0},"rating":{"description":"Filter products with a minimum average rating.","type":"integer"},"shipping-free":{"description":"Filters products that are marked as shipping-free.","type":"boolean","default":false},"properties":{"description":"Filters products by their properties. List of property identifiers separated by a `|`.","type":"string"},"manufacturer-filter":{"description":"Enables/disabled filtering by manufacturer. If set to false, the `manufacturer` filter will be ignored. Also the `aggregations[manufacturer]` key will be removed from the response.","type":"boolean","default":true},"price-filter":{"description":"Enables/disabled filtering by price. If set to false, the `min-price` and `max-price` filter will be ignored. Also the `aggregations[price]` key will be removed from the response.","type":"boolean","default":true},"rating-filter":{"description":"Enables/disabled filtering by rating. If set to false, the `rating` filter will be ignored. Also the `aggregations[rating]` key will be removed from the response.","type":"boolean","default":true},"shipping-free-filter":{"description":"Enables/disabled filtering by shipping-free products. If set to false, the `shipping-free` filter will be ignored. Also the `aggregations[shipping-free]` key will be removed from the response.","type":"boolean","default":true},"property-filter":{"description":"Enables/disabled filtering by properties products. If set to false, the `properties` filter will be ignored. Also the `aggregations[properties]` key will be removed from the response.","type":"boolean","default":true},"property-whitelist":{"description":"A whitelist of property identifiers which can be used for filtering. List of property identifiers separated by a `|`. The `property-filter` must be `true`, otherwise the whitelist has no effect.","type":"string"},"reduce-aggregations":{"description":"By sending the parameter `reduce-aggregations` , the post-filters that were applied by the customer, are also applied to the aggregations. This has the consequence that only values are returned in the aggregations that would lead to further filter results. This parameter is a flag, the value has no effect.","type":"string","nullable":true}}}]},"ProductListingResult":{"allOf":[{"$ref":"#/components/schemas/EntitySearchResult"},{"type":"object","properties":{"currentFilters":{"type":"object","description":"Contains the state of the filters. These can be used to create listing filters.","properties":{"navigationId":{"type":"string"},"manufacturer":{"type":"array","items":{"type":"string","pattern":"^[0-9a-f]{32}$"}},"price":{"type":"object","properties":{"min":{"type":"integer","default":0},"max":{"type":"integer","default":0}},"required":["min","max"]},"rating":{"type":"integer","nullable":true},"shipping-free":{"type":"boolean","default":false},"properties":{"type":"array","items":{"type":"string","pattern":"^[0-9a-f]{32}$"}},"search":{"type":"string"}},"required":["manufacturer","navigationId","price","properties","rating","shipping-free"]},"availableSortings":{"type":"array","description":"Contains the available sorting. These can be used to show a sorting select-box in the product listing.","items":{"type":"object","properties":{"label":{"type":"string"},"translated":{"type":"object","properties":{"label":{"type":"string"}},"required":["label"]},"key":{"type":"string"},"priority":{"type":"number"},"apiAlias":{"type":"string","enum":["product_sorting"]}},"required":["label","translated","key","priority","apiAlias"]}},"sorting":{"type":"string"},"elements":{"type":"array","items":{"$ref":"#/components/schemas/Product"}},"entity":{"type":"string","enum":["product"]},"apiAlias":{"type":"string","enum":["product_listing"]}},"required":["elements","availableSortings","currentFilters","apiAlias"]}]},"Criteria":{"type":"object","description":"Search parameters. For more information, see our documentation on [Search Queries](https://shopware.stoplight.io/docs/store-api/docs/concepts/search-queries.md#structure)","properties":{"page":{"description":"Search result page","type":"integer"},"limit":{"description":"Number of items per result page","type":"integer"},"filter":{"type":"array","description":"List of filters to restrict the search result. For more information, see [Search Queries > Filter](https://shopware.stoplight.io/docs/store-api/docs/concepts/search-queries.md#filter)","items":{"type":"object","properties":{"type":{"type":"string"},"field":{"type":"string"},"value":{"type":"string"}},"required":["type","field","value"]}},"sort":{"type":"array","description":"Sorting in the search result.","items":{"type":"object","properties":{"field":{"type":"string"},"order":{"type":"string"},"naturalSorting":{"type":"boolean"}},"required":["field"]}},"post-filter":{"type":"array","description":"Filters that applied without affecting aggregations. For more information, see [Search Queries > Post Filter](https://shopware.stoplight.io/docs/store-api/docs/concepts/search-queries.md#post-filter)","items":{"type":"object","properties":{"type":{"type":"string"},"field":{"type":"string"},"value":{"type":"string"}},"required":["type","field","value"]}},"associations":{"type":"object","description":"Used to fetch associations which are not fetched by default."},"aggregations":{"type":"array","description":"Used to perform aggregations on the search result. For more information, see [Search Queries > Aggregations](https://shopware.stoplight.io/docs/store-api/docs/concepts/search-queries.md#aggregations)","items":{"type":"object","properties":{"name":{"description":"Give your aggregation an identifier, so you can find it easier","type":"string"},"type":{"description":"The type of aggregation","type":"string"},"field":{"description":"The field you want to aggregate over.","type":"string"}},"required":["name","type","field"]}},"grouping":{"type":"array","description":"Perform groupings over certain fields","items":{"type":"string","description":"Name of a field"}},"fields":{"type":"array","description":"Fields which should be returned in the search result.","items":{"type":"string","description":"Name of a field"}},"total-count-mode":{"description":"Whether the total for the total number of hits should be determined for the search query. none = disabled total count, exact = calculate exact total amount (slow), next-pages = calculate only for next page (fast)","type":"string","default":"none","enum":["none","exact","next-pages"]}}},"NavigationRouteResponse":{"type":"array","items":{"$ref":"#/components/schemas/Category"}},"EntitySearchResult":{"allOf":[{"$ref":"#/components/schemas/ArrayStruct"},{"type":"object","properties":{"entity":{"type":"string"},"total":{"type":"integer","description":"The total number of found entities"},"aggregations":{"type":"array","description":"Contains aggregated data. A simple example is the determination of the average price from a product search query.","items":{"type":"object"}},"page":{"type":"integer","description":"The actual page. This can be used for pagination."},"limit":{"type":"integer","description":"The actual limit. This is used for pagination and goes together with the page."}}}]},"CartItems":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/LineItem"}}}},"OrderRouteResponse":{"type":"object","properties":{"orders":{"type":"array","items":{"$ref":"#/components/schemas/Order"}},"paymentChangeable":{"type":"object","description":"The key-value pairs contain the uuid of the order as key and a boolean as value, indicating that the payment method can still be changed.","additionalProperties":{"type":"boolean"}}}},"ShippingMethodPageRouteResponse":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"active":{"type":"boolean"},"description":{"type":"string"},"deliveryTimeId":{"type":"string"},"deliveryTime":{"type":"object","properties":{"name":{"type":"string"},"min":{"type":"integer","format":"int32"},"max":{"type":"integer","format":"int32"},"unit":{"type":"string"}}},"translations":{"type":"array","items":{"type":"object","properties":{"shippingMethodId":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"}}}},"orderDeliveries":{"type":"array","items":{"type":"object","properties":{"orderId":{"type":"string"},"shippingOrderAddressId":{"type":"string"},"shippingMethodId":{"type":"string"},"shippingDateEarliest":{"type":"string","format":"date-time"},"shippingDateLatest":{"type":"string","format":"date-time"},"stateId":{"type":"string"}}}},"salesChannelDefaultAssignments":{"type":"array","items":{"type":"object","properties":{"typeId":{"type":"string"},"languageId":{"type":"string"},"currencyId":{"type":"string"},"paymentMethodId":{"type":"string"},"shippingMethodId":{"type":"string"},"countryId":{"type":"string"},"navigationCategoryId":{"type":"string"},"navigationCategoryDepth":{"type":"integer","format":"int32"},"footerCategoryId":{"type":"string"},"serviceCategoryId":{"type":"string"},"name":{"type":"string"},"shortName":{"type":"string"},"accessKey":{"type":"string"},"active":{"type":"boolean"},"maintenance":{"type":"boolean"},"maintenanceIpWhitelist":{"type":"string"},"mailHeaderFooterId":{"type":"string"},"customerGroupId":{"type":"string"},"hreflangActive":{"type":"boolean"},"hreflangDefaultDomainId":{"type":"string"}}}},"salesChannels":{"type":"array","items":{"type":"object","properties":{"typeId":{"type":"string"},"languageId":{"type":"string"},"currencyId":{"type":"string"},"paymentMethodId":{"type":"string"},"shippingMethodId":{"type":"string"},"countryId":{"type":"string"},"navigationCategoryId":{"type":"string"},"navigationCategoryDepth":{"type":"integer","format":"int32"},"footerCategoryId":{"type":"string"},"serviceCategoryId":{"type":"string"},"name":{"type":"string"},"shortName":{"type":"string"},"accessKey":{"type":"string"},"active":{"type":"boolean"},"maintenance":{"type":"boolean"},"maintenanceIpWhitelist":{"type":"string"},"mailHeaderFooterId":{"type":"string"},"customerGroupId":{"type":"string"},"hreflangActive":{"type":"boolean"},"hreflangDefaultDomainId":{"type":"string"}}}},"availabilityRule":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"priority":{"type":"integer","format":"int32"},"invalid":{"type":"boolean"}}},"availabilityRuleId":{"type":"string"},"prices":{"type":"array","items":{"type":"object","properties":{"shippingMethodId":{"type":"string"},"currencyId":{"type":"string"},"ruleId":{"type":"string"},"calculation":{"type":"integer","format":"int32"},"quantityStart":{"type":"number","format":"float"},"quantityEnd":{"type":"number","format":"float"},"price":{"type":"number","format":"float"},"calculationRuleId":{"type":"string"}}}},"mediaId":{"type":"string"},"media":{"type":"object","properties":{"userId":{"type":"string"},"mimeType":{"type":"string"},"fileExtension":{"type":"string"},"fileSize":{"type":"integer","format":"int32"},"title":{"type":"string"},"metaDataRaw":{"type":"string"},"mediaTypeRaw":{"type":"string"},"uploadedAt":{"type":"string","format":"date-time"},"alt":{"type":"string"},"url":{"type":"string"},"fileName":{"type":"string"},"mediaFolderId":{"type":"string"},"private":{"type":"boolean"},"thumbnailsRo":{"type":"string"}}},"tags":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"}}}}}}},"LineItemType":{"type":"string","enum":["product","credit","custom","promotion","discount","container"]},"LineItem":{"type":"object","properties":{"id":{"type":"string"},"referencedId":{"type":"string"},"label":{"type":"string"},"quantity":{"type":"number"},"type":{"$ref":"#/components/schemas/LineItemType"},"good":{"type":"boolean"},"description":{"type":"string"},"removable":{"type":"boolean"},"stackable":{"type":"boolean"},"modified":{"type":"boolean"}},"required":["id","type"]},"AccountNewsletterRecipientResult":{"type":"object","properties":{"status":{"type":"string","enum":["undefined","notSet","direct","optIn","optOut"]},"apiAlias":{"type":"string","enum":["account_newsletter_recipient"]}},"required":["status","apiAlias"]},"CrossSellingElement":{"type":"object","properties":{"crossSelling":{"$ref":"#/components/schemas/ProductCrossSelling"},"products":{"type":"array","items":{"$ref":"#/components/schemas/Product"}},"total":{"type":"integer","format":"int32"},"streamId":{"type":"string","format":"uuid"},"apiAlias":{"type":"string","enum":["cross_selling_element"]}},"required":["crossSelling","products","total","apiAlias"]},"WishlistLoadRouteResponse":{"type":"object","properties":{"wishlist":{"type":"object","properties":{"customerId":{"type":"string"},"salesChannelId":{"type":"string"}}},"products":{"$ref":"#/components/schemas/ProductListingResult"}}},"FindProductVariantRouteResponse":{"type":"object","properties":{"foundCombination":{"type":"object","properties":{"variantId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"options":{"type":"array","items":{"type":"string"}}}}}},"ArrayStruct":{"$ref":"#/components/schemas/Struct"},"ListPrice":{"type":"object","description":"","properties":{"discount":{"type":"number"},"percentage":{"type":"number"},"price":{"type":"number"},"apiAlias":{"type":"string","enum":["cart_list_price"]}},"required":["apiAlias"]},"ReferencePrice":{"type":"object","properties":{"purchaseUnit":{"type":"number"},"referenceUnit":{"type":"number"},"unitName":{"type":"string"},"price":{"type":"number"},"apiAlias":{"type":"string","enum":["cart_price_reference"]},"listPrice":{"oneOf":[{"$ref":"#/components/schemas/ListPrice"}],"nullable":true},"regulationPrice":{"type":"object","properties":{"price":{"type":"number"},"apiAlias":{"type":"string","enum":["cart_regulation_price"]}},"nullable":true},"hasRange":{"type":"boolean"},"variantId":{"type":"string","format":"^[0-9a-f]{32}$","nullable":true}},"required":["hasRange","regulationPrice","listPrice","calculatedTaxes","totalPrice","quantity","unitName"]},"ProductDetailResponse":{"type":"object","description":"Represents a product along with detailed information required to display a variant selection.","properties":{"product":{"$ref":"#/components/schemas/Product"},"configurator":{"type":"array","description":"List of property groups with their corresponding options and information on how to display them.","items":{"$ref":"#/components/schemas/PropertyGroup"}}},"required":["product"]},"SalesChannelContext":{"allOf":[{"$ref":"#/components/schemas/ArrayStruct"},{"type":"object","properties":{"token":{"description":"Context the user session","type":"string"},"currentCustomerGroup":{"type":"object","description":"Customer group of the current user","properties":{"name":{"type":"string"},"displayGross":{"type":"boolean"}}},"fallbackCustomerGroup":{"description":"Fallback group if the default customer group is not applicable","type":"object","properties":{"name":{"type":"string"},"displayGross":{"type":"boolean"}}},"currency":{"$ref":"#/components/schemas/Currency"},"salesChannel":{"description":"Information about the current sales channel","type":"object","properties":{"typeId":{"type":"string"},"languageId":{"type":"string"},"currencyId":{"type":"string"},"paymentMethodId":{"type":"string"},"shippingMethodId":{"type":"string"},"countryId":{"type":"string"},"navigationCategoryId":{"type":"string"},"navigationCategoryDepth":{"type":"integer","format":"int32"},"footerCategoryId":{"type":"string"},"serviceCategoryId":{"type":"string"},"name":{"type":"string"},"shortName":{"type":"string"},"accessKey":{"type":"string"},"active":{"type":"boolean"},"maintenance":{"type":"boolean"},"maintenanceIpWhitelist":{"type":"string"},"mailHeaderFooterId":{"type":"string"},"customerGroupId":{"type":"string"},"hreflangActive":{"type":"boolean"},"hreflangDefaultDomainId":{"type":"string"},"analyticsId":{"type":"string"}}},"taxRules":{"type":"array","description":"Currently active tax rules and/or rates","items":{"type":"object","properties":{"taxRate":{"type":"number","format":"float"},"name":{"type":"string"}}}},"customer":{"$ref":"#/components/schemas/Customer"},"paymentMethod":{"$ref":"#/components/schemas/PaymentMethod"},"shippingLocation":{"type":"object","properties":{"apiAlias":{"type":"string","enum":["cart_delivery_shipping_location"]},"country":{"$ref":"#/components/schemas/Country"},"address":{"$ref":"#/components/schemas/CustomerAddress"}}},"shippingMethod":{"$ref":"#/components/schemas/ShippingMethod"},"context":{"description":"Core context with general configuration values and state","type":"object","properties":{"versionId":{"type":"string"},"currencyId":{"type":"string"},"currencyFactor":{"type":"integer"},"currencyPrecision":{"type":"integer","format":"int32"},"languageIdChain":{"type":"array","items":{"type":"string"}},"scope":{"type":"string"},"source":{"type":"string"},"taxState":{"type":"string"},"useCache":{"type":"boolean"}}}}}]}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/failure"},"example":{"errors":[{"status":"400","title":"Bad Request","description":"Bad parameters for this endpoint. See documentation for the correct ones."}]}},"application/json":{"schema":{"$ref":"#/components/schemas/failure"},"example":{"errors":[{"status":"400","title":"Bad Request","description":"Bad parameters for this endpoint. See documentation for the correct ones."}]}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/failure"},"example":{"errors":[{"status":"401","title":"Unauthorized","description":"Authorization information is missing or invalid."}]}},"application/json":{"schema":{"$ref":"#/components/schemas/failure"},"example":{"errors":[{"status":"401","title":"Unauthorized","description":"Authorization information is missing or invalid."}]}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/failure"},"example":{"errors":[{"status":"403","title":"Forbidden","description":"This operation is restricted to logged in users."}]}},"application/json":{"schema":{"$ref":"#/components/schemas/failure"},"example":{"errors":[{"status":"403","title":"Forbidden","description":"This operation is restricted to logged in users."}]}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/failure"},"example":{"errors":[{"status":"404","title":"Not Found","description":"Resource with given parameter was not found."}]}},"application/json":{"schema":{"$ref":"#/components/schemas/failure"},"example":{"errors":[{"status":"404","title":"Not Found","description":"Resource with given parameter was not found."}]}}}},"ContextTokenResponse":{"type":"object","properties":{"contextToken":{"description":"Context token identifying the current user session.","type":"string"}}},"OpenApi3":{"description":"Returns information about the store API.","content":{"application/json":{"schema":{"properties":{"openapi":{"type":"string"},"info":{"type":"object","properties":{"title":{"type":"string"},"summary":{"type":"string"},"description":{"type":"string"},"termsOfService":{"type":"string","format":"uri"},"contact":{"type":"object","properties":{"name":{"type":"string"},"url":{"type":"string","format":"uri"},"email":{"type":"string","format":"email"}}},"license":{"type":"object","properties":{"name":{"type":"string"},"identifier":{"type":"string"},"url":{"type":"string","format":"uri"}},"required":["name"]},"version":{"type":"string"}},"required":["title","version"]},"jsonSchemaDialect":{"type":"string"},"webhooks":{"type":"object"},"servers":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"}},"required":["url"]}},"components":{"type":"object","properties":{"schemas":{"type":"object"},"responses":{"type":"object"},"parameters":{"type":"object"},"examples":{"type":"object"},"requestBodies":{"type":"object"},"headers":{"type":"object"},"securitySchemes":{"type":"object"},"links":{"type":"object"},"callbacks":{"type":"object"},"pathItems":{"type":"object"}}},"security":{"type":"array","items":{"type":"object"}},"paths":{"type":"object"},"tags":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"externalDocs":{"type":"object","properties":{"description":{"type":"string"},"url":{"type":"string","format":"uri"}},"required":["url"]}},"required":["name"]}},"externalDocs":{"type":"object","properties":{"description":{"type":"string"},"url":{"type":"string","format":"uri"}},"required":["url"]}},"type":"object","required":["openapi","info"]}}}}},"parameters":{"contentType":{"name":"Content-Type","in":"header","description":"Content type of the request","required":true,"schema":{"type":"string","default":"application/json"}},"accept":{"name":"Accept","in":"header","description":"Accepted response content types","required":true,"schema":{"type":"string","default":"application/json"}}},"securitySchemes":{"ApiKey":{"type":"apiKey","description":"Identifies the sales channel you want to access the API through","name":"sw-access-key","in":"header"},"ContextToken":{"type":"apiKey","description":"Identifies an anonymous or identified user session","name":"sw-context-token","in":"header"}}},"security":[{"ApiKey":[]}],"paths":{"/media":{"post":{"tags":["Content"],"summary":"Fetch and resolve Media Entities","description":"Fetch one or multiple Media Entities with the corresponding Identifier.","operationId":"readMedia","requestBody":{"content":{"application/json":{"schema":{"properties":{"ids":{"description":"Identifier (UUID) of the media entity to be fetched.","type":"array","items":{"type":"string","pattern":"^[0-9a-f]{32}$"}}},"type":"object","required":["ids"]}}}},"responses":{"200":{"description":"The loaded MediaCollection containing the requested Media Entities.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Media"}}}}},"404":{"$ref":"#/components/responses/404"}},"security":[{"ApiKey":[]}]}},"/order/state/cancel":{"post":{"tags":["Order"],"summary":"Cancel an order","description":"Cancels an order. The order state will be set to 'cancelled'.","operationId":"cancelOrder","requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"orderId":{"description":"The identifier of the order to be canceled.","type":"string","pattern":"^[0-9a-f]{32}$"}},"type":"object","required":["orderId"]}}}},"responses":{"200":{"description":"Returns the state of the state machine\n\n example: More information about the state machine can be found in the corresponding guide: [Using the state machine](https://developer.shopware.com/docs/guides/plugins/plugins/checkout/order/using-the-state-machine)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StateMachineState"}}}}},"security":[{"ApiKey":[],"ContextToken":[]}]}},"/order":{"post":{"tags":["Order","Endpoints supporting Criteria "],"summary":"Fetch a list of orders","description":"List orders of a customer.","operationId":"readOrder","requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Criteria"},{"properties":{"checkPromotion":{"description":"Check if the payment method of the order is still changeable.","type":"boolean"}},"type":"object"}]}}}},"responses":{"200":{"description":"An array of orders and an indicator if the payment of the order can be changed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderRouteResponse"}}}}},"security":[{"ApiKey":[],"ContextToken":[]}]}},"/order/payment":{"post":{"tags":["Order"],"summary":"Update the payment method of an order","description":"Changes the payment method of a specific order. You can use the /order route to find out if the payment method of an order can be changed - take a look at the `paymentChangeable`- array in the response.","operationId":"orderSetPayment","requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["paymentMethodId","orderId"],"properties":{"paymentMethodId":{"description":"The identifier of the paymentMethod to be set","type":"string","pattern":"^[0-9a-f]{32}$"},"orderId":{"description":"The identifier of the order.","type":"string","pattern":"^[0-9a-f]{32}$"}},"type":"object"}}}},"responses":{"200":{"description":"Successfully updated the payment method of the order.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}}},"security":[{"ApiKey":[],"ContextToken":[]}]}},"/order/download/{orderId}/{downloadId}":{"get":{"tags":["Order"],"summary":"Download a purchased file","description":"Download a file included in the given order and with the given id. Access must be granted.","operationId":"orderDownloadFile","parameters":[{"name":"orderId","in":"path","required":true,"schema":{"type":"string","pattern":"^[0-9a-f]{32}$"}},{"name":"downloadId","in":"path","required":true,"schema":{"type":"string","pattern":"^[0-9a-f]{32}$"}}],"responses":{"200":{"description":"An arbitrary binary file.","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}}},"security":[{"ApiKey":[],"ContextToken":[]}]}},"/navigation/{activeId}/{rootId}":{"post":{"tags":["Category","Endpoints supporting Criteria "],"summary":"Fetch a navigation menu","description":"This endpoint returns categories that can be used as a page navigation. You can either return them as a tree or as a flat list. You can also control the depth of the tree.\n\n Instead of passing uuids, you can also use one of the following aliases for the activeId and rootId parameters to get the respective navigations of your sales channel.\n\n * main-navigation\n * service-navigation\n * footer-navigation","operationId":"readNavigation","parameters":[{"name":"sw-include-seo-urls","in":"header","description":"Instructs Shopware to try and resolve SEO URLs for the given navigation item","required":false,"schema":{"type":"boolean"}},{"name":"activeId","in":"path","description":"Identifier of the active category in the navigation tree (if not used, just set to the same as rootId).","required":true,"schema":{"oneOf":[{"type":"string","pattern":"^[0-9a-f]{32}$"},{"$ref":"#/components/schemas/NavigationType"}]}},{"name":"rootId","in":"path","description":"Identifier of the root category for your desired navigation tree. You can use it to fetch sub-trees of your navigation tree.","required":true,"schema":{"oneOf":[{"type":"string","pattern":"^[0-9a-f]{32}$"},{"$ref":"#/components/schemas/NavigationType"}]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Criteria"},{"properties":{"depth":{"description":"Determines the depth of fetched navigation levels.","type":"integer","format":"int32"},"buildTree":{"description":"Return the categories as a tree or as a flat list.","type":"array","items":{"type":"object"}}},"type":"object"}]}}}},"responses":{"200":{"description":"All available navigations","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NavigationRouteResponse"}}}}},"security":[{"ApiKey":[]}]}},"/customer/wishlist/add/{productId}":{"post":{"tags":["Wishlist"],"summary":"Add a product to a wishlist","description":"Adds a product to a customers wishlist.\n\n **Important constraints**\n\n * Anonymous (not logged-in) customers can not have wishlists.\n * The wishlist feature has to be activated.","operationId":"addProductOnWishlist","parameters":[{"name":"productId","in":"path","description":"Identifier of the product to be added.","required":true,"schema":{"type":"string","pattern":"^[0-9a-f]{32}$"}}],"responses":{"200":{"description":"Returns a success response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}}},"security":[{"ApiKey":[],"ContextToken":[]}]}},"/customer/wishlist":{"post":{"tags":["Wishlist","Endpoints supporting Criteria "],"summary":"Fetch a wishlist","description":"Fetch a customer's wishlist. Products on the wishlist can be filtered using a criteria object.\n\n **Important constraints**\n\n * Anonymous (not logged-in) customers can not have wishlists.\n * The wishlist feature has to be activated.","operationId":"readCustomerWishlist","requestBody":{"required":false,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Criteria"}]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WishlistLoadRouteResponse"}}}}},"security":[{"ApiKey":[],"ContextToken":[]}]}},"/customer/wishlist/merge":{"post":{"tags":["Wishlist"],"summary":"Create a wishlist for a customer","description":"Create a new wishlist for a logged in customer or extend the existing wishlist given a set of products.\n\n **Important constraints**\n\n * Anonymous (not logged-in) customers can not have wishlists.\n * A customer can only have a single wishlist.\n * The wishlist feature has to be activated.","operationId":"mergeProductOnWishlist","requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"productIds":{"description":"List product id","type":"array","items":{"description":"product id","type":"string","pattern":"^[0-9a-f]{32}$"}}},"type":"object"}}}},"responses":{"200":{"description":"Returns a success response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}}},"security":[{"ApiKey":[],"ContextToken":[]}]}},"/customer/wishlist/delete/{productId}":{"delete":{"tags":["Wishlist"],"summary":"Remove a product from a wishlist","description":"Removes a product from a customer's wishlist.\n\n **Important constraints**\n\n * Anonymous (not logged-in) customers can not have wishlists.\n * The wishlist feature has to be activated.","operationId":"deleteProductOnWishlist","parameters":[{"name":"productId","in":"path","description":"The identifier of the product to be removed from the wishlist.","required":true,"schema":{"type":"string","pattern":"^[0-9a-f]{32}$"}}],"responses":{"200":{"description":"Returns a success response indicating a successful removal.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"404":{"description":"The removal of the product failed. Probably because the product could not be found on the wishlist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/failure"}}}}},"security":[{"ApiKey":[],"ContextToken":[]}]}},"/country":{"post":{"tags":["System & Context","Endpoints supporting Criteria "],"summary":"Fetch countries","description":"Perform a filtered search for countries","operationId":"readCountry","requestBody":{"required":false,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Criteria"}]}}}},"responses":{"200":{"description":"Entity search result containing countries.","content":{"application/json":{"schema":{"allOf":[{"properties":{"elements":{"type":"array","items":{"$ref":"#/components/schemas/Country"}}},"type":"object"},{"$ref":"#/components/schemas/EntitySearchResult"}]}}}}},"security":[{"ApiKey":[]}]}},"/_info/openapi3.json":{"get":{"tags":["System Info & Healthcheck"],"summary":"Get OpenAPI Specification","description":"Get information about the store API in OpenAPI format.","operationId":"api-info","parameters":[{"name":"type","in":"query","description":"Type of the api","schema":{"type":"string","enum":["jsonapi","json"]}}],"responses":{"200":{"$ref":"#/components/responses/OpenApi3"}}}},"/product-export/{accessKey}/{fileName}":{"get":{"tags":["Product"],"summary":"Export product export","operationId":"readProductExport","parameters":[{"name":"accessKey","in":"path","description":"Access Key","required":true,"schema":{"type":"string"}},{"name":"fileName","in":"path","description":"File Name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":""}},"security":[{"ApiKey":[]}]}},"/product-listing/{categoryId}":{"post":{"tags":["Product"],"summary":"Fetch a product listing by category","description":"Fetches a product listing for a specific category. It also provides filters, sortings and property aggregations, analogous to the /search endpoint.","operationId":"readProductListing","parameters":[{"name":"sw-include-seo-urls","in":"header","description":"Determines if the response must contain a SeoUrl entity for a product entity","required":false,"schema":{"type":"boolean"}},{"name":"categoryId","in":"path","description":"Identifier of a category.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ProductListingCriteria"},{"$ref":"#/components/schemas/ProductListingFlags"}]}}}},"responses":{"200":{"description":"Returns a product listing containing all products and additional fields to display a listing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductListingResult"}}}}},"security":[{"ApiKey":[]}]}},"/cms/{id}":{"post":{"tags":["Content"],"summary":"Fetch and resolve a CMS page","description":"Loads a content management page by its identifier and resolve the slot data. This could be media files, product listing and so on.\n\n**Important notice**\n\nThe criteria passed with this route also affects the listing, if there is one within the cms page.","operationId":"readCms","parameters":[{"name":"id","in":"path","description":"Identifier of the CMS page to be resolved","required":true,"schema":{"type":"string","pattern":"^[0-9a-f]{32}$"}}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"properties":{"slots":{"description":"Resolves only the given slot identifiers. The identifiers have to be seperated by a `|` character.","type":"string"}},"type":"object"},{"$ref":"#/components/schemas/ProductListingCriteria"}]}}}},"responses":{"200":{"description":"The loaded cms page","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CmsPage"}}}},"404":{"$ref":"#/components/responses/404"}},"security":[{"ApiKey":[]}]}},"/contact-form":{"post":{"tags":["Content"],"summary":"Submit a contact form message","description":"Used for submitting contact forms. Be aware that there can be more required fields, depending on the system settings.","operationId":"sendContactMail","requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["salutationId","email","subject","comment"],"properties":{"salutationId":{"description":"Identifier of the salutation. Use `/api/salutation` endpoint to fetch possible values.","type":"string","pattern":"^[0-9a-f]{32}$"},"firstName":{"description":"Firstname. This field may be required depending on the system settings.","type":"string"},"lastName":{"description":"Lastname. This field may be required depending on the system settings.","type":"string"},"email":{"description":"Email address","type":"string"},"phone":{"description":"Phone. This field may be required depending on the system settings.","type":"string"},"subject":{"description":"The subject of the contact form.","type":"string"},"comment":{"description":"The message of the contact form","type":"string"},"navigationId":{"description":"Identifier of the navigation page. Can be used to override the configuration.\nTake a look at the settings of a category containing a concact form in the administration.","type":"string","pattern":"^[0-9a-f]{32}$"},"slotId":{"description":"Identifier of the cms element","type":"string","pattern":"^[0-9a-f]{32}$"},"cmsPageType":{"description":"Type of the content management page","type":"string"},"entityName":{"description":"Entity name for slot config","type":"string"}},"type":"object"}}}},"responses":{"200":{"description":"Message sent successful."}},"security":[{"ApiKey":[]}]}},"/category":{"post":{"tags":["Category","Endpoints supporting Criteria "],"summary":"Fetch a list of categories","description":"Perform a filtered search for categories.","operationId":"readCategoryList","requestBody":{"required":false,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Criteria"}]}}}},"responses":{"200":{"description":"Entity search result containing categories.","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"elements":{"type":"array","items":{"$ref":"#/components/schemas/Category"}}}},{"$ref":"#/components/schemas/EntitySearchResult"}]}}}}},"security":[{"ApiKey":[]}]}},"/category/{navigationId}":{"post":{"tags":["Category","Endpoints supporting Criteria "],"summary":"Fetch a single category","description":"This endpoint returns information about the category, as well as a fully resolved (hydrated with mapping values) CMS page, if one is assigned to the category. You can pass slots which should be resolved exclusively.","operationId":"readCategory","parameters":[{"name":"sw-include-seo-urls","in":"header","description":"Instructs Shopware to try and resolve SEO URLs for the given navigation item","required":false,"schema":{"type":"boolean"}},{"name":"navigationId","in":"path","description":"Identifier of the category to be fetched","required":true,"schema":{"type":"string","pattern":"^[0-9a-f]{32}$"}},{"name":"slots","in":"query","description":"Resolves only the given slot identifiers. The identifiers have to be seperated by a '|' character","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Criteria"},{"$ref":"#/components/schemas/ProductListingCriteria"}]}}}},"responses":{"200":{"description":"The loaded category with cms page","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Category"}}}}},"security":[{"ApiKey":[]}]}},"/landing-page/{landingPageId}":{"post":{"tags":["Content","Endpoints supporting Criteria "],"summary":"Fetch a landing page with the resolved CMS page","description":"Loads a landing page by its identifier and resolves the CMS page.\n\n**Important notice**\n\nThe criteria passed with this route also affects the listing, if there is one within the cms page.","operationId":"readLandingPage","parameters":[{"name":"landingPageId","in":"path","description":"Identifier of the landing page.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Criteria"},{"allOf":[{"properties":{"slots":{"description":"Resolves only the given slot identifiers. The identifiers have to be seperated by a `|` character.","type":"string"}},"type":"object"},{"$ref":"#/components/schemas/ProductListingCriteria"}]}]}}}},"responses":{"200":{"description":"The loaded landing page with cms page","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LandingPage"}}}},"404":{"$ref":"#/components/responses/404"}},"security":[{"ApiKey":[]}]}},"/account/newsletter-recipient":{"post":{"tags":["Profile","Newsletter","Endpoints supporting Criteria"],"summary":"Fetch newsletter recipients","description":"Perform a filtered search for newsletter recipients.","operationId":"readNewsletterRecipient","requestBody":{"required":false,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Criteria"}]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AccountNewsletterRecipientResult"}}}}}},"security":[{"ApiKey":[],"ContextToken":[]}]}},"/account/change-profile":{"post":{"tags":["Profile"],"summary":"Change the customer's information","description":"Make changes to a customer's account, like changing their name, salutation or title.","operationId":"changeProfile","requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["salutationId","firstName","lastName"],"properties":{"salutationId":{"description":"Id of the salutation for the customer account. Fetch options using `salutation` endpoint.","type":"string"},"title":{"description":"(Academic) title of the customer","type":"string"},"firstName":{"description":"Customer first name. Value will be reused for shipping and billing address if not provided explicitly.","type":"string"},"lastName":{"description":"Customer last name. Value will be reused for shipping and billing address if not provided explicitly.","type":"string"},"company":{"description":"Company of the customer. Only required when `accountType` is `business`.","type":"string"},"birthdayDay":{"description":"Birthday day","type":"integer"},"birthdayMonth":{"description":"Birthday month","type":"integer"},"birthdayYear":{"description":"Birthday year","type":"integer"}},"type":"object"}}}},"responses":{"200":{"description":"Returns a success response indicating a successful update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}}},"security":[{"ApiKey":[],"ContextToken":[]}]}},"/account/change-email":{"post":{"tags":["Profile"],"summary":"Change the customer's email address","description":"Changes a customer's email address to a new email address, using their current password as a validation.","operationId":"changeEmail","requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["email","emailConfirmation","password"],"properties":{"email":{"description":"New email address. Has to be unique amongst all customers","type":"string"},"emailConfirmation":{"description":"Confirmation of the new email address.","type":"string"},"password":{"description":"Customer's current password","type":"string"}},"type":"object"}}}},"responses":{"200":{"description":"Returns a success response indicating a successful update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}}},"security":[{"ApiKey":[],"ContextToken":[]}]}},"/account/change-language":{"post":{"tags":["Profile"],"summary":"Change the customer's language.","description":"Changes the language of the logged in customer","operationId":"changeLanguage","requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["languageId"],"properties":{"language":{"description":"New languageId","type":"string"}},"type":"object"}}}},"responses":{"200":{"description":"Returns a success response indicating a successful update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}}},"security":[{"ApiKey":[],"ContextToken":[]}]}},"/account/change-password":{"post":{"tags":["Profile"],"summary":"Change the customer's password","description":"Changes a customer's password using their current password as a validation.","operationId":"changePassword","requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["password","newPassword","newPasswordConfirm"],"properties":{"password":{"description":"Current password of the customer","type":"string"},"newPassword":{"description":"New Password for the customer","type":"string"},"newPasswordConfirm":{"description":"Confirmation of the new password","type":"string"}},"type":"object"}}}},"responses":{"200":{"description":"Returns a success response indicating a successful update.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}}},"security":[{"ApiKey":[],"ContextToken":[]}]}},"/account/change-payment-method/{paymentMethodId}":{"post":{"tags":["Profile"],"summary":"Change the customer's default payment method","description":"Changes a customer's default (preselected) payment method.","operationId":"changePaymentMethod","parameters":[{"name":"paymentMethodId","in":"path","description":"Identifier of the desired default payment method","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returns a success response indicating a successful update.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}}},"security":[{"ApiKey":[],"ContextToken":[]}]}},"/account/customer-recovery-is-expired":{"post":{"tags":["Profile"],"summary":"Checks if the customer recovery entry for a given hash is expired.","description":"This can be used to validate a provided hash has a valid and not expired customer recovery hash.","operationId":"getCustomerRecoveryIsExpired","requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["hash"],"properties":{"hash":{"description":"Parameter from the link in the confirmation mail sent in Step 1","type":"string"}},"type":"object"}}}},"responses":{"200":{"description":"Returns a CustomerRecoveryIsExpiredResponse that indicates if the hash is expired or not.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ArrayStruct"}}}}},"security":[{"ApiKey":[]}]}},"/account/customer":{"post":{"tags":["Profile","Endpoints supporting Criteria "],"summary":"Get information about current customer","description":"Returns information about the current customer.","operationId":"readCustomer","requestBody":{"required":false,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Criteria"}]}}}},"responses":{"200":{"description":"Returns the logged in customer, also for guest sessions. Check for the value of `guest` field to see whether the customer is a guest.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Customer"}}}}},"security":[{"ApiKey":[],"ContextToken":[]}]},"delete":{"tags":["Profile"],"summary":"Delete the customer's profile","description":"Deletes a customer profile along with their addresses, wishlists and associated data. Created orders and their payment/shipping information (addresses) and reviews are not deleted.","operationId":"deleteCustomer","responses":{"204":{"description":"Returns a no content response indicating a successful removal of the customer profile"}},"security":[{"ApiKey":[],"ContextToken":[]}]}},"/account/address/{addressId}":{"delete":{"tags":["Address"],"summary":"Delete an address of a customer","description":"Delete an address of customer.\n\n Only addresses which are not set as default addresses for shipping or billing can be deleted. You can check the current default addresses of your customer using the profile information endpoint and change them using the default address endpoint.\n\n **A customer must have at least one address (which can be used for shipping and billing).**\n\n An automatic fallback is not applied.","operationId":"deleteCustomerAddress","parameters":[{"name":"addressId","in":"path","description":"ID of the address to be deleted.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content response, when the address has been deleted"},"400":{"description":"Response containing a list of errors, most likely due to the address being in use"}},"security":[{"ApiKey":[],"ContextToken":[]}]},"patch":{"tags":["Address"],"summary":"Modify an address of a customer","description":"Modifies an existing address of a customer.","operationId":"updateCustomerAddress","parameters":[{"name":"addressId","in":"path","description":"Address ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerAddress"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerAddress"}}}}},"security":[{"ApiKey":[],"ContextToken":[]}]}},"/account/list-address":{"post":{"tags":["Address","Endpoints supporting Criteria "],"summary":"Fetch addresses of a customer","description":"Lists all addresses of the current customer and allows filtering them based on a criteria.","operationId":"listAddress","requestBody":{"required":false,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Criteria"}]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CustomerAddress"}}}}}},"security":[{"ApiKey":[],"ContextToken":[]}]}},"/account/login":{"post":{"tags":["Login & Registration"],"summary":"Log in a customer","description":"Logs in customers given their credentials.","operationId":"loginCustomer","requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["username","password"],"properties":{"username":{"description":"Email","type":"string"},"password":{"description":"Password","type":"string"}},"type":"object"}}}},"responses":{"200":{"$ref":"#/components/responses/ContextTokenResponse"},"401":{"description":"If credentials are incorrect an error is returned","content":{"application/json":{"schema":{"$ref":"#/components/schemas/failure"}}}}},"security":[{"ApiKey":[]}]}},"/account/logout":{"post":{"tags":["Login & Registration"],"summary":"Log out a customer","description":"Logs out a customer.","operationId":"logoutCustomer","responses":{"200":{"$ref":"#/components/responses/ContextTokenResponse"},"403":{"$ref":"#/components/responses/403"}},"security":[{"ApiKey":[],"ContextToken":[]}]}},"/account/register-confirm":{"post":{"tags":["Login & Registration"],"summary":"Confirm a customer registration","description":"Confirms a customer registration when double opt-in is activated.\n\nLearn more about double opt-in registration in our guide \"Register a customer\".","operationId":"registerConfirm","requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["hash","em"],"properties":{"hash":{"description":"Hash from the email received","type":"string"},"em":{"description":"Email hash from the email received","type":"string"}},"type":"object"}}}},"responses":{"200":{"description":"Returns the logged in customer. The customer is automatically logged in with the `sw-context-token` header provided, which can be reused for subsequent requests."},"404":{"description":"No hash provided"},"412":{"description":"The customer has already been confirmed"}},"security":[{"ApiKey":[]}]}},"/account/register":{"post":{"tags":["Login & Registration"],"summary":"Register a customer","description":"Registers a customer. Used both for normal customers and guest customers.See the Guide \"Register a customer\" for more information on customer registration.","operationId":"register","requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["email","password","salutationId","firstName","lastName","acceptedDataProtection","storefrontUrl","billingAddress"],"properties":{"email":{"description":"Email of the customer. Has to be unique, unless `guest` is `true`","type":"string"},"password":{"description":"Password for the customer. Required, unless `guest` is `true`","type":"string"},"salutationId":{"description":"Id of the salutation for the customer account. Fetch options using `salutation` endpoint.","type":"string"},"firstName":{"description":"Customer first name. Value will be reused for shipping and billing address if not provided explicitly.","type":"string"},"lastName":{"description":"Customer last name. Value will be reused for shipping and billing address if not provided explicitly.","type":"string"},"acceptedDataProtection":{"description":"Flag indicating accepted data protection","type":"boolean"},"storefrontUrl":{"description":"URL of the storefront for that registration. Used in confirmation emails. Has to be one of the configured domains of the sales channel.","type":"string"},"billingAddress":{"$ref":"#/components/schemas/CustomerAddress"},"shippingAddress":{"$ref":"#/components/schemas/CustomerAddress"},"accountType":{"description":"Account type of the customer which can be either `private` or `business`.","type":"string","default":"private"},"guest":{"description":"If set, will create a guest customer. Guest customers can re-use an email address and don't need a password.","type":"boolean","default":false},"birthdayDay":{"description":"Birthday day","type":"integer"},"birthdayMonth":{"description":"Birthday month","type":"integer"},"birthdayYear":{"description":"Birthday year","type":"integer"},"title":{"description":"(Academic) title of the customer","type":"string"},"affiliateCode":{"description":"Field can be used to store an affiliate tracking code","type":"string"},"campaignCode":{"description":"Field can be used to store a campaign tracking code","type":"string"}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Customer"}}}}},"security":[{"ApiKey":[]}]}},"/account/recovery-password-confirm":{"post":{"tags":["Profile"],"summary":"Reset a password with recovery credentials","description":"This operation is Step 2 of the password reset flow. It is required to conduct Step 1 \"Send a password recovery mail\" in order to obtain the required credentials for this step.Resets a customer's password using credentials from a password recovery mail as a validation.","operationId":"recoveryPassword","requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["hash","newPassword","newPasswordConfirm"],"properties":{"hash":{"description":"Parameter from the link in the confirmation mail sent in Step 1","type":"string"},"newPassword":{"description":"New password for the customer","type":"string"},"newPasswordConfirm":{"description":"Confirmation of the new password","type":"string"}},"type":"object"}}}},"responses":{"200":{"description":"Returns a success response indicating a successful update.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}}},"security":[{"ApiKey":[]}]}},"/account/recovery-password":{"post":{"tags":["Profile"],"summary":"Send a password recovery mail","description":"This operation is Step 1 of the password reset flow. Make sure to implement Step 2 \"Reset password with recovery credentials\" in order to allow for the complete flow in your application. Sends a recovery mail containing a link with credentials that allows a customer to reset their password.","operationId":"sendRecoveryMail","requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["email","storefrontUrl"],"properties":{"email":{"description":"E-Mail address to identify the customer","type":"string"},"storefrontUrl":{"description":"URL of the storefront to use for the generated reset link. It has to be a domain that is configured in the sales channel domain settings.","type":"string"}},"type":"object"}}}},"responses":{"200":{"description":"If email corresponds to an existing customer, a mail will be sent out to that customer containing a link assembled using the following schema:\n\nReturns a success indicating a successful initialisation of the reset flow.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}}},"security":[{"ApiKey":[]}]}},"/account/address/default-shipping/{addressId}":{"patch":{"tags":["Address"],"summary":"Change a customer's default shipping address","description":"Updates the default (preselected) shipping addresses of a customer.","operationId":"defaultShippingAddress","parameters":[{"name":"addressId","in":"path","description":"Address ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":""}},"security":[{"ApiKey":[],"ContextToken":[]}]}},"/account/address/default-billing/{addressId}":{"patch":{"tags":["Address"],"summary":"Change a customer's default billing address","description":"Updates the default (preselected) billing addresses of a customer.","operationId":"defaultBillingAddress","parameters":[{"name":"addressId","in":"path","description":"Address ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":""}},"security":[{"ApiKey":[],"ContextToken":[]}]}},"/account/address":{"post":{"tags":["Address"],"summary":"Create a new address for a customer","description":"Creates a new address for a customer.","operationId":"createCustomerAddress","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerAddress"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerAddress"}}}}},"security":[{"ApiKey":[],"ContextToken":[]}]}},"/app-system/{name}/generate-token":{"post":{"tags":["App system"],"summary":"Generate JWT token for app system backend","description":"Generate JWT token for authenticated communication with the app server","operationId":"generateJWTAppSystemAppServer","parameters":[{"in":"path","name":"name","required":true,"description":"Name of the app","schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"token":{"type":"string"},"expires":{"type":"string","format":"date-time"},"shopId":{"type":"string"}}}}}}},"security":[{"ApiKey":[]}]}},"/seo-url":{"post":{"tags":["Sitemap & Routes","Endpoints supporting Criteria "],"summary":"Fetch SEO routes","description":"Perform a filtered search for seo urls.","operationId":"readSeoUrl","requestBody":{"required":false,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Criteria"}]}}}},"responses":{"200":{"description":"Entity search result containing seo urls.","content":{"application/json":{"schema":{"allOf":[{"properties":{"elements":{"type":"array","items":{"$ref":"#/components/schemas/SeoUrl"}}},"type":"object","required":["elements"]},{"$ref":"#/components/schemas/EntitySearchResult"}]}}}},"404":{"$ref":"#/components/responses/404"}},"security":[{"ApiKey":[]}]}},"/language":{"post":{"tags":["System & Context","Endpoints supporting Criteria "],"summary":"Fetch languages","description":"Perform a filtered search for languages.","operationId":"readLanguages","requestBody":{"required":false,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Criteria"}]}}}},"responses":{"200":{"description":"Entity search result containing languages.","content":{"application/json":{"schema":{"allOf":[{"properties":{"elements":{"type":"array","items":{"$ref":"#/components/schemas/Language"}}},"required":["elements"],"type":"object"},{"$ref":"#/components/schemas/EntitySearchResult"}]}}}}},"security":[{"ApiKey":[]}]}},"/context":{"get":{"tags":["System & Context"],"summary":"Fetch the current context","description":"Fetches the current context. This includes for example the `customerGroup`, `currency`, `taxRules` and many more.","operationId":"readContext","responses":{"200":{"description":"Returns the current context.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SalesChannelContext"}}}}},"security":[{"ApiKey":[]}]},"patch":{"tags":["System & Context"],"summary":"Modify the current context","description":"Used for switching the context. A typical example would be changing the language or changing the currency.","operationId":"updateContext","requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"currencyId":{"description":"Currency","type":"string","pattern":"^[0-9a-f]{32}$"},"languageId":{"description":"Language","type":"string","pattern":"^[0-9a-f]{32}$"},"billingAddressId":{"description":"Billing Address","type":"string","pattern":"^[0-9a-f]{32}$"},"shippingAddressId":{"description":"Shipping Address","type":"string","pattern":"^[0-9a-f]{32}$"},"paymentMethodId":{"description":"Payment Method","type":"string","pattern":"^[0-9a-f]{32}$"},"shippingMethodId":{"description":"Shipping Method","type":"string","pattern":"^[0-9a-f]{32}$"},"countryId":{"description":"Country","type":"string","pattern":"^[0-9a-f]{32}$"},"countryStateId":{"description":"Country State","type":"string","pattern":"^[0-9a-f]{32}$"}},"type":"object"}}}},"responses":{"200":{"$ref":"#/components/responses/ContextTokenResponse"}},"security":[{"ApiKey":[]}]}},"/customer-group-registration/config/{customerGroupId}":{"get":{"tags":["Login & Registration"],"summary":"Fetch registration settings for customer group","operationId":"getCustomerGroupRegistrationInfo","parameters":[{"name":"customerGroupId","in":"path","description":"Customer group id","required":true,"schema":{"type":"string","pattern":"^[0-9a-f]{32}$"}}],"responses":{"200":{"description":"Returns the customer group including registration settings.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerGroup"}}}}},"security":[{"ApiKey":[]}]}},"/search":{"post":{"tags":["Product"],"summary":"Search for products","description":"Performs a search for products which can be used to display a product listing.","operationId":"searchPage","requestBody":{"content":{"application/json":{"schema":{"allOf":[{"required":["search"],"properties":{"search":{"description":"Using the search parameter, the server performs a text search on all records based on their data model and weighting as defined in the entity definition using the SearchRanking flag.","type":"string"}},"type":"object"},{"$ref":"#/components/schemas/ProductListingCriteria"},{"$ref":"#/components/schemas/ProductListingFlags"}]}}}},"responses":{"200":{"description":"Returns a product listing containing all products and additional fields to display a listing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductListingResult"}}}}},"security":[{"ApiKey":[]}]}},"/handle-payment":{"post":{"tags":["Payment & Shipping"],"summary":"Initiate a payment for an order","description":"This generic endpoint is should be called to initiate a payment flow after an order has been created. The details of the payment flow can differ depending on the payment integration and might require calling additional operations or the setup of webhooks.\n\nThe endpoint internally calls the payment handler of the payment method currently set for the order.","operationId":"handlePaymentMethod","requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["orderId"],"properties":{"orderId":{"description":"Identifier of an order","type":"string","pattern":"^[0-9a-f]{32}$"},"finishUrl":{"description":"URL to which the client should be redirected after successful payment","type":"string"},"errorUrl":{"description":"URL to which the client should be redirected after erroneous payment","type":"string"}},"type":"object"}}}},"responses":{"200":{"description":"Redirect to external payment provider","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"redirectUrl":{"type":"string","nullable":true}},"required":["redirectUrl"]}}}}},"security":[{"ApiKey":[]}]}},"/currency":{"post":{"tags":["System & Context","Endpoints supporting Criteria "],"summary":"Fetch currencies","description":"Perform a filtered search for currencies.","operationId":"readCurrency","requestBody":{"required":false,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Criteria"}]}}}},"responses":{"200":{"description":"Entity search result containing currencies.","content":{"application/json":{"schema":{"allOf":[{"properties":{"elements":{"type":"array","items":{"$ref":"#/components/schemas/Currency"}}},"type":"object"},{"$ref":"#/components/schemas/EntitySearchResult"}]}}}}},"security":[{"ApiKey":[]}]}},"/document/download/{documentId}/{deepLinkCode}":{"post":{"tags":["Document","Endpoints supporting Criteria "],"summary":"Download generated document","description":"Returns blob file of a generated document to download.","operationId":"download","parameters":[{"name":"documentId","in":"path","required":true,"schema":{"type":"string","pattern":"^[0-9a-f]{32}$"}},{"name":"deepLinkCode","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Criteria"}]}}}},"responses":{"200":{"description":"Returns the document information and blob to download.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Document"}}}}},"security":[{"ApiKey":[],"ContextToken":[]}]}},"/sitemap":{"get":{"tags":["Sitemap & Routes"],"summary":"Fetch sitemaps","description":"Fetches a list of compressed sitemap files, which are often used by search engines.","operationId":"readSitemap","responses":{"200":{"description":"Returns a list of available sitemaps.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Sitemap"}}}}}},"security":[{"ApiKey":[]}]}},"/salutation":{"post":{"tags":["System & Context","Endpoints supporting Criteria "],"summary":"Fetch salutations","description":"Perform a filtered search for salutations.","operationId":"readSalutation","requestBody":{"required":false,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Criteria"}]}}}},"responses":{"200":{"description":"Entity search result containing salutations.","content":{"application/json":{"schema":{"allOf":[{"properties":{"elements":{"type":"array","items":{"$ref":"#/components/schemas/Salutation"}}},"type":"object"},{"$ref":"#/components/schemas/EntitySearchResult"}]}}}}},"security":[{"ApiKey":[]}]}},"/country-state/{countryId}":{"post":{"tags":["System & Context","Endpoints supporting Criteria "],"summary":"Fetch the states of a country","description":"Perform a filtered search the states for a country","operationId":"readCountryState","parameters":[{"name":"countryId","in":"path","required":true,"schema":{"type":"string","pattern":"^[0-9a-f]{32}$"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Criteria"}]}}}},"responses":{"200":{"description":"Entity search result containing countries.","content":{"application/json":{"schema":{"allOf":[{"properties":{"elements":{"type":"array","items":{"$ref":"#/components/schemas/CountryState"}}},"type":"object"},{"$ref":"#/components/schemas/EntitySearchResult"}]}}}}},"security":[{"ApiKey":[]}]}},"/search-suggest":{"post":{"tags":["Product"],"summary":"Search for products (suggest)","description":"Can be used to implement search previews or suggestion listings, that don’t require any interaction.","operationId":"searchSuggest","requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"required":["search"],"properties":{"search":{"description":"Using the search parameter, the server performs a text search on all records based on their data model and weighting as defined in the entity definition using the SearchRanking flag.","type":"string"}},"type":"object"},{"$ref":"#/components/schemas/ProductListingFlags"}]}}}},"responses":{"200":{"description":"Returns a product listing containing all products and additional fields.\n\nNote: Aggregations, currentFilters and availableSortings are empty in this response. If you need them to display a listing, use the /search route instead.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductListingResult"}}}}},"security":[{"ApiKey":[]}]}},"/script/{hook}":{"post":{"tags":["API","Script","App"],"summary":"Access point for different api logics which are provided by apps over script hooks","operationId":"postScriptStoreApiRoute","parameters":[{"name":"hook","in":"path","description":"Dynamic hook which used to build the hook name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returns different structures of results based on the called script."}},"security":[{"ApiKey":[]}]}},"/product/{productId}/cross-selling":{"post":{"tags":["Product"],"summary":"Fetch cross-selling groups of a product","description":"This route is used to load the cross sellings for a product. A product has several cross selling definitions in which several products are linked. The route returns the cross sellings together with the linked products","operationId":"readProductCrossSellings","parameters":[{"name":"productId","in":"path","description":"Product ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Found cross sellings","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CrossSellingElementCollection"}}}}},"security":[{"ApiKey":[]}]}},"/product/{productId}":{"post":{"tags":["Product"],"summary":"Fetch a single product","description":"This route is used to load a single product with the corresponding details. In addition to loading the data, the best variant of the product is determined when a parent id is passed.","operationId":"readProductDetail","parameters":[{"name":"productId","in":"path","description":"Product ID","required":true,"schema":{"type":"string","pattern":"^[0-9a-f]{32}$'"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Criteria"}]}}}},"responses":{"200":{"description":"Product information along with variant groups and options","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductDetailResponse"}}}}},"security":[{"ApiKey":[]}]}},"/product":{"post":{"tags":["Product","Endpoints supporting Criteria "],"summary":"Fetch a list of products","description":"List products that match the given criteria. For performance reasons a limit should always be set.","operationId":"readProduct","requestBody":{"required":false,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Criteria"}]}}}},"responses":{"200":{"description":"Entity search result containing products","content":{"application/json":{"schema":{"allOf":[{"properties":{"elements":{"type":"array","items":{"$ref":"#/components/schemas/Product"}}},"type":"object"},{"$ref":"#/components/schemas/EntitySearchResult"}]}}}}},"security":[{"ApiKey":[]}]}},"/product/{productId}/reviews":{"post":{"tags":["Product","Endpoints supporting Criteria "],"summary":"Fetch product reviews","description":"Perform a filtered search for product reviews.","operationId":"readProductReviews","parameters":[{"name":"productId","in":"path","description":"Identifier of the product.","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Criteria"}]}}}},"responses":{"200":{"description":"Entity search result containing product reviews","content":{"application/json":{"schema":{"allOf":[{"properties":{"elements":{"type":"array","items":{"$ref":"#/components/schemas/ProductReview"}}},"type":"object"},{"$ref":"#/components/schemas/EntitySearchResult"}]}}}}},"security":[{"ApiKey":[]}]}},"/product/{productId}/review":{"post":{"tags":["Product"],"summary":"Save a product review","description":"Saves a review for a product. Reviews have to be activated in the settings.","operationId":"saveProductReview","parameters":[{"name":"productId","in":"path","description":"Identifier of the product which is reviewed.","required":true,"schema":{"type":"string","pattern":"^[0-9a-f]{32}$"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["title","content","points"],"properties":{"name":{"description":"The name of the review author. If not set, the first name of the customer is chosen.","type":"string"},"email":{"description":"The email address of the review author. If not set, the email of the customer is chosen.","type":"string"},"title":{"description":"The title of the review.","type":"string"},"content":{"description":"The content of review.","type":"string"},"points":{"description":"The review rating for the product.","type":"number","format":"double"}},"type":"object"}}}},"responses":{"200":{"description":"Success response indicating the review was saved successfuly."}},"security":[{"ApiKey":[],"ContextToken":[]}]}},"/product/{productId}/find-variant":{"post":{"tags":["Product"],"summary":"Search for a matching variant by product options.","description":"Performs a search for product variants and returns the best matching variant.","operationId":"searchProductVariantIds","parameters":[{"name":"productId","in":"path","description":"Product ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["options"],"properties":{"options":{"description":"The options parameter for the variant to find.","type":"array","items":{"type":"string"}},"switchedGroup":{"description":"The id of the option group that has been switched.","type":"string"}},"type":"object"}}}},"responses":{"200":{"description":"Returns an FoundCombination struct containing the ids matching the search.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FindProductVariantRouteResponse"}}}}},"security":[{"ApiKey":[]}]}},"/payment-method":{"post":{"tags":["Payment Method","Endpoints supporting Criteria "],"summary":"Loads all available payment methods","operationId":"readPaymentMethod","requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Criteria"},{"properties":{"onlyAvailable":{"description":"List only available","type":"boolean"}},"type":"object"}]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"properties":{"total":{"description":"Total amount","type":"integer"},"aggregations":{"description":"aggregation result","type":"object"},"elements":{"type":"array","items":{"$ref":"#/components/schemas/PaymentMethod"}}},"type":"object"}}}}},"security":[{"ApiKey":[]}]}},"/checkout/cart":{"get":{"tags":["Cart"],"summary":"Fetch or create a cart","description":"Used to fetch the current cart or for creating a new one.","operationId":"readCart","responses":{"200":{"description":"Cart","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Cart"}}}}},"security":[{"ApiKey":[]}]},"delete":{"tags":["Cart"],"summary":"Delete a cart","description":"This route deletes the cart of the customer.","operationId":"deleteCart","responses":{"204":{"description":"Successfully deleted the cart","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}}},"security":[{"ApiKey":[]}]}},"/checkout/cart/line-item":{"post":{"tags":["Cart"],"summary":"Add items to the cart","description":"This route adds items to the cart. An item can be a product or promotion for example. They are referenced by the `referencedId`-parameter.\n\nExample: [Working with the cart - Guide](https://developer.shopware.com/docs/guides/integrations-api/store-api-guide/work-with-the-cart#adding-new-items-to-the-cart)","operationId":"addLineItem","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CartItems"}}}},"responses":{"200":{"description":"The updated cart.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Cart"}}}}},"security":[{"ApiKey":[]}]},"delete":{"tags":["Cart"],"summary":"Remove items from the cart","description":"DEPRECATED: use removeLineItem instead. This route removes items from the cart and recalculates it.\n\nExample: [Working with the cart - Guide](https://developer.shopware.com/docs/guides/integrations-api/store-api-guide/work-with-the-cart#deleting-items-in-the-cart)","operationId":"removeLineItemDeprecated","deprecated":true,"parameters":[{"name":"ids","in":"query","description":"A list of product identifiers.","required":true,"schema":{"type":"array","items":{"type":"string","pattern":"^[0-9a-f]{32}$"}}}],"responses":{"200":{"description":"The updated cart.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Cart"}}}}},"security":[{"ApiKey":[]}]},"patch":{"tags":["Cart"],"summary":"Update items in the cart","description":"This route updates items in the cart. A typical example is updating the quantity of an item.\n\nExample: [Working with the cart - Guide](https://developer.shopware.com/docs/guides/integrations-api/store-api-guide/work-with-the-cart#updating-items-in-the-cart)","operationId":"updateLineItem","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CartItems"}}}},"responses":{"200":{"description":"The updated cart.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Cart"}}}}},"security":[{"ApiKey":[]}]}},"/checkout/cart/line-item/delete":{"post":{"tags":["Cart"],"summary":"Remove items from the cart","description":"This route removes items from the cart and recalculates it.\n\nExample: [Working with the cart - Guide](https://developer.shopware.com/docs/guides/integrations-api/store-api-guide/work-with-the-cart#deleting-items-in-the-cart)","operationId":"removeLineItem","requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["ids"],"properties":{"ids":{"description":"A list of product identifiers.","type":"array","minItems":1,"items":{"type":"string","pattern":"^[0-9a-f]{32}$"}}},"type":"object"}}}},"responses":{"200":{"description":"The updated cart.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Cart"}}}}},"security":[{"ApiKey":[]}]}},"/checkout/order":{"post":{"tags":["Order"],"summary":"Create an order from a cart","description":"Creates a new order from the current cart and deletes the cart.\n\nIf you are using the [prepared payment flow](https://developer.shopware.com/docs/concepts/commerce/checkout-concept/payments#2.1-prepare-payment-optional), this endpoint also receives additional transaction details. The exact name of the parameters depends on the implementation of the corresponding *payment handler*.","operationId":"createOrder","requestBody":{"description":"Contains additional metadata which is stored together with the order. It can also contain payment transaction details.","content":{"application/json":{"schema":{"properties":{"customerComment":{"description":"Adds a comment from the customer to the order.","type":"string"},"affiliateCode":{"description":"The affiliate code can be used to track which referrer the customer came through. An example could be `Price-comparison-company-XY`.","type":"string"},"campaignCode":{"description":"The campaign code is used to track which action the customer came from. An example could be `Summer-Deals`","type":"string"}},"type":"object"}}}},"responses":{"200":{"description":"Order","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Order"}}}}},"security":[{"ApiKey":[],"ContextToken":[]}]}},"/newsletter/confirm":{"post":{"tags":["Newsletter"],"summary":"Confirm a newsletter registration","description":"You have to use the hash from the link sent out via email to confirm the user registration.","operationId":"confirmNewsletter","requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["hash","em"],"properties":{"hash":{"description":"Hash parameter from link the in the confirmation mail","type":"string"},"em":{"description":"Email hash parameter from the link in the confirmation mail","type":"string"}},"type":"object"}}}},"responses":{"200":{"description":"The newsletter confirmation was successful."}},"security":[{"ApiKey":[]}]}},"/newsletter/subscribe":{"post":{"tags":["Newsletter"],"summary":"Create or remove a newsletter subscription","description":"This route is used to create/remove/confirm a newsletter subscription.\n\nThe `option` property controls what should happen:\n* `direct`: The subscription is directly active and does not need a confirmation.\n* `subscribe`: An email will be send to the provided email addrees containing a link to the /newsletter/confirm route.\nThe subscription is only successful, if the /newsletter/confirm route is called with the generated hashes.\n* `unsubscribe`: The email address will be removed from the newsletter subscriptions.\n* `confirmSubscribe`: Confirmes the newsletter subscription for the provided email address.","operationId":"subscribeToNewsletter","requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["email","option","storefrontUrl"],"properties":{"email":{"description":"Email address that will receive the confirmation and the newsletter.","type":"string"},"option":{"description":"Defines what should be done.","type":"string"},"storefrontUrl":{"description":"Url of the storefront of the shop. This will be used for generating the link to the /newsletter/confirm inside the confirm email.","type":"string"},"salutationId":{"description":"Identifier of the salutation.","type":"string","pattern":"^[0-9a-f]{32}$"},"firstName":{"description":"First name","type":"string"},"lastName":{"description":"Last name","type":"string"},"street":{"description":"Street","type":"string"},"city":{"description":"City","type":"string"},"zipCode":{"description":"Zip code","type":"string"},"tags":{"description":"Zip code","type":"string"},"languageId":{"description":"Identifier of the language.","type":"string","pattern":"^[0-9a-f]{32}$"},"customFields":{"description":"Custom field data that should be added to the subscription.","type":"string"}},"type":"object"}}}},"responses":{"200":{"description":"Success"}},"security":[{"ApiKey":[]}]}},"/newsletter/unsubscribe":{"post":{"tags":["Newsletter"],"summary":"Remove a newsletter subscription","description":"Removes a newsletter recipient from the mailing lists.","operationId":"unsubscribeToNewsletter","requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["email"],"properties":{"email":{"description":"Email address that should be removed from the mailing lists.","type":"string"}},"type":"object"}}}},"responses":{"200":{"description":"Unsubscribing was successful."}},"security":[{"ApiKey":[]}]}},"/shipping-method":{"post":{"tags":["Payment & Shipping","Endpoints supporting Criteria "],"summary":"Fetch shipping methods","description":"Perform a filtered search for shipping methods.","operationId":"readShippingMethod","parameters":[{"name":"onlyAvailable","in":"query","description":"List only available shipping methods. This filters shipping methods methods which can not be used in the actual context because of their availability rule.","schema":{"type":"boolean"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Criteria"}]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"properties":{"total":{"description":"Total amount","type":"integer"},"aggregations":{"description":"aggregation result","type":"object"},"elements":{"type":"array","items":{"$ref":"#/components/schemas/ShippingMethod"}}},"type":"object"}}}}},"security":[{"ApiKey":[]}]}}},"tags":[{"name":"Experimental","description":"Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.","externalDocs":{"description":"Find out more","url":"https://github.com/shopware/platform/blob/trunk/adr/2023-05-10-experimental-features.md"}}]} \ No newline at end of file From d424ee90b889a5e78759bf297d40979c1552f98c Mon Sep 17 00:00:00 2001 From: Lukas Heinze Date: Wed, 7 Aug 2024 15:10:38 +0200 Subject: [PATCH 2/9] SW6 added logout guest function, refactored login and register response handling because contextToken is no longer responded --- src/commons/utils/types/HblIUseCustomer.ts | 3 +- .../shopware/composables/useCustomer.ts | 59 +++++++++++-------- .../customer/CustomerGuestNavigation.vue | 4 +- 3 files changed, 38 insertions(+), 28 deletions(-) diff --git a/src/commons/utils/types/HblIUseCustomer.ts b/src/commons/utils/types/HblIUseCustomer.ts index 1105045a..5f953fa3 100644 --- a/src/commons/utils/types/HblIUseCustomer.ts +++ b/src/commons/utils/types/HblIUseCustomer.ts @@ -7,8 +7,9 @@ export interface HblIUseCustomer { loading: Ref, error: Ref, getCustomer(): Promise, - login(username: string, password: string): Promise, + login(username: string, password: string): Promise, logout(): void, + logoutGuest(): void, updateShippingAddress (shippingAddress: HblCustomerShippingAddress): Promise, updateBillingAddress (billingAddress: HblCustomerBillingAddress): Promise, register(formData: HblRegisterCustomerForm): Promise, diff --git a/src/platforms/shopware/composables/useCustomer.ts b/src/platforms/shopware/composables/useCustomer.ts index 6006629e..87311d52 100644 --- a/src/platforms/shopware/composables/useCustomer.ts +++ b/src/platforms/shopware/composables/useCustomer.ts @@ -87,7 +87,7 @@ export const useCustomer = defineStore('use-customer', (): HblIUseCustomer => { } } - async function login (username: string, password: string): Promise { + async function login (username: string, password: string): Promise { loading.value = true error.value = false @@ -99,21 +99,17 @@ export const useCustomer = defineStore('use-customer', (): HblIUseCustomer => { await getCart() } - const response = await LoginRegistrationShopware.loginCustomer({ username, password }) + await LoginRegistrationShopware.loginCustomer({ username, password }) loading.value = false - if (response.contextToken !== undefined) { - await setSessionToken(response.contextToken) - await getSession() - await getWishlist() - return response.contextToken - } + await getSession() + await getWishlist() - throw new Error('Something went wrong please try again') + return } catch (e) { const error = e as any - if (error.body[0]?.detail != null) { + if (error.body?.[0]?.detail != null) { showNotification(error.body[0]?.detail, 'error', true) } else { showNotification(error, 'error', true) @@ -130,22 +126,17 @@ export const useCustomer = defineStore('use-customer', (): HblIUseCustomer => { error.value = false try { - const response = await LoginRegistrationShopware.logoutCustomer() + await LoginRegistrationShopware.logoutCustomer() loading.value = false - if (response.contextToken !== undefined) { - customer.value = null - await setSessionToken(response.contextToken) - await getSession() - - await getCart() - clearWishlist() - - await navigateToI18n('/customer/login') - return - } + customer.value = null + await setSessionToken(null) + await getSession() + await getCart() + clearWishlist() - throw new Error('Something went wrong please try again') + await navigateToI18n('/customer/login') + return } catch (e) { const error = e as any @@ -161,6 +152,18 @@ export const useCustomer = defineStore('use-customer', (): HblIUseCustomer => { } } + async function logoutGuest (): Promise { + customer.value = null + await setSessionToken(null) + await getSession() + + await getCart() + clearWishlist() + + await navigateToI18n('/customer/login') + return + } + async function register (formData: HblRegisterCustomerForm): Promise { loading.value = true error.value = false @@ -346,7 +349,7 @@ export const useCustomer = defineStore('use-customer', (): HblIUseCustomer => { try { const response = await OrderShopware.readOrder({ limit: 10, - 'total-count-mode': 2, + 'total-count-mode': 'next-pages', ...(params?.page != null && { page: params?.page }), associations: { deliveries: { @@ -382,15 +385,20 @@ export const useCustomer = defineStore('use-customer', (): HblIUseCustomer => { associations: { salutation: {} } - } + }, + stateMachineState: {} }, ...(filter != null && { filter }) }) const mappedData = { + // @ts-ignore limit: response.orders?.limit, + // @ts-ignore page: response.orders?.page, + // @ts-ignore total: response.orders?.total, + // @ts-ignore data: params?.id != null ? hblMapOrder(response.orders?.elements[0]) : hblMapOrders(response.orders?.elements) } @@ -624,6 +632,7 @@ export const useCustomer = defineStore('use-customer', (): HblIUseCustomer => { getCustomer, login, logout, + logoutGuest, register, registerConfirm, updateShippingAddress, diff --git a/src/theme/components/customer/CustomerGuestNavigation.vue b/src/theme/components/customer/CustomerGuestNavigation.vue index 257f2262..43fc4727 100644 --- a/src/theme/components/customer/CustomerGuestNavigation.vue +++ b/src/theme/components/customer/CustomerGuestNavigation.vue @@ -1,7 +1,7 @@