@shopbite-de/storefront 1.10.1 → 1.12.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/api-types/storeApiSchema.json +3205 -645
- package/api-types/storeApiTypes.d.ts +1537 -202
- package/app/components/Category/Breadcrumb.vue +74 -0
- package/app/components/Category/Header.vue +20 -38
- package/app/components/Category/Listing.vue +7 -6
- package/app/components/Hero.vue +2 -1
- package/app/components/Navigation/DesktopLeft2.vue +16 -16
- package/app/components/Navigation/MobileTop2.vue +31 -11
- package/app/components/SalesChannelSwitch.vue +50 -24
- package/app/components/User/RegistrationForm.vue +1 -3
- package/app/composables/useCategorySeo.ts +0 -55
- package/app/layouts/listing2.vue +1 -1
- package/app/pages/c/[...all].vue +1 -1
- package/app/pages/menu/[...all].vue +1 -1
- package/app/pages/speisekarte/[...all].vue +52 -0
- package/content/index.yml +3 -3
- package/content/navigation.yml +3 -3
- package/node.dockerfile +1 -1
- package/nuxt.config.ts +0 -1
- package/package.json +2 -2
- package/public/category-placeholder.webp +0 -0
- package/test/e2e/simple-checkout-as-recurring-customer.test.ts +1 -1
- package/test/unit/useCategorySeo.spec.ts +1 -15
- package/app/pages/speisekarte.vue +0 -57
- package/server/api/shopware/sales-channels.get.ts +0 -79
- package/test/nuxt/SalesChannelSwitch.test.ts +0 -201
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* This file is auto-generated. Do not make direct changes to the file.
|
|
3
3
|
* Instead override it in your shopware.d.ts file.
|
|
4
4
|
*
|
|
5
|
-
* Shopware API version: 6.7.
|
|
5
|
+
* Shopware API version: 6.7.7.1
|
|
6
6
|
*
|
|
7
7
|
*/
|
|
8
8
|
type GenericRecord =
|
|
@@ -17,6 +17,8 @@ type GenericRecord =
|
|
|
17
17
|
export type components = {
|
|
18
18
|
schemas: Schemas;
|
|
19
19
|
parameters: {
|
|
20
|
+
CompressedCriteria: string;
|
|
21
|
+
CompressedNoneFieldsCriteria: string;
|
|
20
22
|
accept: string;
|
|
21
23
|
contentType: string;
|
|
22
24
|
criteriaAggregations: components["schemas"]["Aggregation"][];
|
|
@@ -44,6 +46,8 @@ export type components = {
|
|
|
44
46
|
criteriaSort: components["schemas"]["Sort"][];
|
|
45
47
|
criteriaTerm: string;
|
|
46
48
|
criteriaTotalCountMode: components["schemas"]["TotalCountMode"];
|
|
49
|
+
noAggregations: string | null;
|
|
50
|
+
onlyAggregations: string | null;
|
|
47
51
|
};
|
|
48
52
|
};
|
|
49
53
|
export type Schemas = {
|
|
@@ -461,7 +465,9 @@ export type Schemas = {
|
|
|
461
465
|
variantId?: string | null;
|
|
462
466
|
};
|
|
463
467
|
Category: {
|
|
468
|
+
/** When boolean value is `true`, the category is listed for selection. */
|
|
464
469
|
active?: boolean;
|
|
470
|
+
/** Unique identity of the category under which the new category is to be created. */
|
|
465
471
|
afterCategoryId?: string;
|
|
466
472
|
afterCategoryVersionId?: string;
|
|
467
473
|
/** @enum {string} */
|
|
@@ -473,6 +479,7 @@ export type Schemas = {
|
|
|
473
479
|
children: components["schemas"]["Category"][];
|
|
474
480
|
/** CMS page layout for the category */
|
|
475
481
|
cmsPage?: components["schemas"]["CmsPage"];
|
|
482
|
+
/** Unique identity of CMS page. */
|
|
476
483
|
cmsPageId?: string;
|
|
477
484
|
/** Runtime field, cannot be used as part of the criteria. */
|
|
478
485
|
cmsPageIdSwitched?: boolean;
|
|
@@ -482,25 +489,33 @@ export type Schemas = {
|
|
|
482
489
|
customEntityTypeId?: string;
|
|
483
490
|
customFields?: GenericRecord;
|
|
484
491
|
description?: string;
|
|
492
|
+
/** Shows nested categories on a product category page. */
|
|
485
493
|
displayNestedProducts?: boolean;
|
|
486
494
|
externalLink?: string;
|
|
487
495
|
id: string;
|
|
488
496
|
internalLink?: string;
|
|
489
497
|
keywords?: string;
|
|
490
|
-
/**
|
|
498
|
+
/**
|
|
499
|
+
* Format: int64
|
|
500
|
+
* An integer value that denotes the level of nesting of a particular category located in an hierarchical category tree.
|
|
501
|
+
*/
|
|
491
502
|
readonly level?: number;
|
|
492
503
|
linkNewTab?: boolean;
|
|
493
504
|
linkType?: string;
|
|
494
505
|
/** Category image or banner */
|
|
495
506
|
media?: components["schemas"]["Media"];
|
|
507
|
+
/** Unique identity of media added to identify category. */
|
|
496
508
|
mediaId?: string;
|
|
497
509
|
metaDescription?: string;
|
|
498
510
|
metaTitle?: string;
|
|
499
511
|
name: string;
|
|
512
|
+
/** Unique identity of category. */
|
|
500
513
|
parent?: components["schemas"]["Category"];
|
|
501
514
|
parentId?: string;
|
|
502
515
|
parentVersionId?: string;
|
|
516
|
+
/** A relative URL to the category. */
|
|
503
517
|
readonly path?: string;
|
|
518
|
+
/** Type of product assignment: Dynamic product group as or `product_stream` or Manual assignment as `product`. */
|
|
504
519
|
productAssignmentType?: string;
|
|
505
520
|
/** Runtime field, cannot be used as part of the criteria. */
|
|
506
521
|
seoUrl?: string;
|
|
@@ -532,11 +547,15 @@ export type Schemas = {
|
|
|
532
547
|
type: string;
|
|
533
548
|
versionId: string;
|
|
534
549
|
};
|
|
535
|
-
/**
|
|
550
|
+
/**
|
|
551
|
+
* Type of categories like `page`, `folder`, `link`.
|
|
552
|
+
* @enum {string}
|
|
553
|
+
*/
|
|
536
554
|
type: "page" | "link";
|
|
537
555
|
/** Format: date-time */
|
|
538
556
|
readonly updatedAt?: string;
|
|
539
557
|
versionId?: string;
|
|
558
|
+
/** Displays categories on category page when true. */
|
|
540
559
|
visible?: boolean;
|
|
541
560
|
/**
|
|
542
561
|
* Format: int64
|
|
@@ -545,12 +564,15 @@ export type Schemas = {
|
|
|
545
564
|
visibleChildCount?: number;
|
|
546
565
|
};
|
|
547
566
|
CategoryJsonApi: components["schemas"]["resource"] & {
|
|
567
|
+
/** When boolean value is `true`, the category is listed for selection. */
|
|
548
568
|
active?: boolean;
|
|
569
|
+
/** Unique identity of the category under which the new category is to be created. */
|
|
549
570
|
afterCategoryId?: string;
|
|
550
571
|
afterCategoryVersionId?: string;
|
|
551
572
|
readonly breadcrumb?: GenericRecord[];
|
|
552
573
|
/** Format: int64 */
|
|
553
574
|
readonly childCount?: number;
|
|
575
|
+
/** Unique identity of CMS page. */
|
|
554
576
|
cmsPageId?: string;
|
|
555
577
|
/** Runtime field, cannot be used as part of the criteria. */
|
|
556
578
|
cmsPageIdSwitched?: boolean;
|
|
@@ -560,22 +582,29 @@ export type Schemas = {
|
|
|
560
582
|
customEntityTypeId?: string;
|
|
561
583
|
customFields?: GenericRecord;
|
|
562
584
|
description?: string;
|
|
585
|
+
/** Shows nested categories on a product category page. */
|
|
563
586
|
displayNestedProducts?: boolean;
|
|
564
587
|
externalLink?: string;
|
|
565
588
|
id: string;
|
|
566
589
|
internalLink?: string;
|
|
567
590
|
keywords?: string;
|
|
568
|
-
/**
|
|
591
|
+
/**
|
|
592
|
+
* Format: int64
|
|
593
|
+
* An integer value that denotes the level of nesting of a particular category located in an hierarchical category tree.
|
|
594
|
+
*/
|
|
569
595
|
readonly level?: number;
|
|
570
596
|
linkNewTab?: boolean;
|
|
571
597
|
linkType?: string;
|
|
598
|
+
/** Unique identity of media added to identify category. */
|
|
572
599
|
mediaId?: string;
|
|
573
600
|
metaDescription?: string;
|
|
574
601
|
metaTitle?: string;
|
|
575
602
|
name: string;
|
|
576
603
|
parentId?: string;
|
|
577
604
|
parentVersionId?: string;
|
|
605
|
+
/** A relative URL to the category. */
|
|
578
606
|
readonly path?: string;
|
|
607
|
+
/** Type of product assignment: Dynamic product group as or `product_stream` or Manual assignment as `product`. */
|
|
579
608
|
productAssignmentType?: string;
|
|
580
609
|
relationships?: {
|
|
581
610
|
/** Child categories within this category for hierarchical navigation */
|
|
@@ -626,6 +655,7 @@ export type Schemas = {
|
|
|
626
655
|
related?: string;
|
|
627
656
|
};
|
|
628
657
|
};
|
|
658
|
+
/** Unique identity of category. */
|
|
629
659
|
parent?: {
|
|
630
660
|
data?: {
|
|
631
661
|
/** @example d0e45878043844ffc41aac437e86b602 */
|
|
@@ -699,10 +729,12 @@ export type Schemas = {
|
|
|
699
729
|
type: string;
|
|
700
730
|
versionId: string;
|
|
701
731
|
};
|
|
732
|
+
/** Type of categories like `page`, `folder`, `link`. */
|
|
702
733
|
type?: string;
|
|
703
734
|
/** Format: date-time */
|
|
704
735
|
readonly updatedAt?: string;
|
|
705
736
|
versionId?: string;
|
|
737
|
+
/** Displays categories on category page when true. */
|
|
706
738
|
visible?: boolean;
|
|
707
739
|
/**
|
|
708
740
|
* Format: int64
|
|
@@ -713,26 +745,41 @@ export type Schemas = {
|
|
|
713
745
|
CmsBlock: {
|
|
714
746
|
/** @enum {string} */
|
|
715
747
|
apiAlias: "cms_block";
|
|
748
|
+
/** Defines the background color of an element. */
|
|
716
749
|
backgroundColor?: string;
|
|
717
750
|
backgroundMedia?: components["schemas"]["Media"];
|
|
751
|
+
/** Unique identity of background media. */
|
|
718
752
|
backgroundMediaId?: string;
|
|
753
|
+
/** Background media mode accept values `cover`, `auto`, `contain`. */
|
|
719
754
|
backgroundMediaMode?: string;
|
|
720
755
|
cmsSectionVersionId?: string;
|
|
721
756
|
/** Format: date-time */
|
|
722
757
|
readonly createdAt?: string;
|
|
758
|
+
/** One or more CSS classes added and separated by spaces. */
|
|
723
759
|
cssClass?: string;
|
|
724
760
|
customFields?: GenericRecord;
|
|
725
761
|
id: string;
|
|
762
|
+
/** Defines for the margin area on the bottom of an element. */
|
|
726
763
|
marginBottom?: string;
|
|
764
|
+
/** Defines for the margin area on the left of an element. */
|
|
727
765
|
marginLeft?: string;
|
|
766
|
+
/** Defines the margin area on the right of an element. */
|
|
728
767
|
marginRight?: string;
|
|
768
|
+
/** Defines the margin area on the top of an element. */
|
|
729
769
|
marginTop?: string;
|
|
770
|
+
/** Unique name of the CMS Block. */
|
|
730
771
|
name?: string;
|
|
731
|
-
/**
|
|
772
|
+
/**
|
|
773
|
+
* Format: int64
|
|
774
|
+
* Order of the block indicated by number like 0, 1, 2,...
|
|
775
|
+
*/
|
|
732
776
|
position: number;
|
|
777
|
+
/** Unique identity of section. */
|
|
733
778
|
sectionId: string;
|
|
779
|
+
/** Position of the section. It can either be `main` or `sidebar`. */
|
|
734
780
|
sectionPosition?: string;
|
|
735
781
|
slots: components["schemas"]["CmsSlot"][];
|
|
782
|
+
/** Type of block can be 'image`, `text`, 'product-listing`, `image-two-column`, etc. */
|
|
736
783
|
type: string;
|
|
737
784
|
/** Format: date-time */
|
|
738
785
|
readonly updatedAt?: string;
|
|
@@ -751,8 +798,10 @@ export type Schemas = {
|
|
|
751
798
|
};
|
|
752
799
|
/** Format: date-time */
|
|
753
800
|
readonly createdAt?: string;
|
|
801
|
+
/** One or more CSS classes added and separated by spaces. */
|
|
754
802
|
cssClass?: string;
|
|
755
803
|
customFields?: GenericRecord;
|
|
804
|
+
/** This field will be implemented in the future. */
|
|
756
805
|
entity?: string;
|
|
757
806
|
id: string;
|
|
758
807
|
/** Landing pages using this CMS layout */
|
|
@@ -760,6 +809,7 @@ export type Schemas = {
|
|
|
760
809
|
name?: string;
|
|
761
810
|
/** Preview image for the CMS page in admin panel and page selection */
|
|
762
811
|
previewMedia?: components["schemas"]["Media"];
|
|
812
|
+
/** Unique identity of media to be previewed. */
|
|
763
813
|
previewMediaId?: string;
|
|
764
814
|
/** Content sections within the CMS page (layout blocks containing slots) */
|
|
765
815
|
sections: components["schemas"]["CmsSection"][];
|
|
@@ -771,6 +821,7 @@ export type Schemas = {
|
|
|
771
821
|
type: string;
|
|
772
822
|
versionId: string;
|
|
773
823
|
};
|
|
824
|
+
/** CMS page types can be `landingpage`, `page`, `product_list`, `product_detail`. */
|
|
774
825
|
type: string;
|
|
775
826
|
/** Format: date-time */
|
|
776
827
|
readonly updatedAt?: string;
|
|
@@ -779,25 +830,39 @@ export type Schemas = {
|
|
|
779
830
|
CmsSection: {
|
|
780
831
|
/** @enum {string} */
|
|
781
832
|
apiAlias: "cms_section";
|
|
833
|
+
/** Background color of CMS page. */
|
|
782
834
|
backgroundColor?: string;
|
|
783
835
|
backgroundMedia?: components["schemas"]["Media"];
|
|
836
|
+
/** Unique identity of CMS section's background media. */
|
|
784
837
|
backgroundMediaId?: string;
|
|
838
|
+
/** Background media mode can be `cover`, `auto` or `contain`. */
|
|
785
839
|
backgroundMediaMode?: string;
|
|
786
840
|
blocks: components["schemas"]["CmsBlock"][];
|
|
787
841
|
cmsPageVersionId?: string;
|
|
788
842
|
/** Format: date-time */
|
|
789
843
|
readonly createdAt?: string;
|
|
844
|
+
/** One or more CSS classes added and separated by spaces. */
|
|
790
845
|
cssClass?: string;
|
|
791
846
|
customFields?: GenericRecord;
|
|
792
847
|
id: string;
|
|
848
|
+
/** Hides the sidebar on mobile viewports. It can hold values such as 'mobile', 'wrap', any other string or be unset. */
|
|
793
849
|
mobileBehavior?: string;
|
|
850
|
+
/** Name of the CMS section defined. */
|
|
794
851
|
name?: string;
|
|
795
852
|
page?: components["schemas"]["CmsPage"];
|
|
853
|
+
/** Unique identity of page where CMS section is defined. */
|
|
796
854
|
pageId: string;
|
|
797
|
-
/**
|
|
855
|
+
/**
|
|
856
|
+
* Format: int64
|
|
857
|
+
* Position of occurrence of each section denoted by numerical values 0, 1, 2...
|
|
858
|
+
*/
|
|
798
859
|
position: number;
|
|
860
|
+
/** Sizing mode can be `boxed` or `full_width`. */
|
|
799
861
|
sizingMode?: string;
|
|
800
|
-
/**
|
|
862
|
+
/**
|
|
863
|
+
* Types of sections can be `sidebar` or `fullwidth`.
|
|
864
|
+
* @enum {string}
|
|
865
|
+
*/
|
|
801
866
|
type: "default" | "sidebar";
|
|
802
867
|
/** Format: date-time */
|
|
803
868
|
readonly updatedAt?: string;
|
|
@@ -811,6 +876,7 @@ export type Schemas = {
|
|
|
811
876
|
/** @enum {string} */
|
|
812
877
|
apiAlias: "cms_slot";
|
|
813
878
|
block?: components["schemas"]["CmsBlock"];
|
|
879
|
+
/** Unique identity of CMS block where slot is defined. */
|
|
814
880
|
blockId: string;
|
|
815
881
|
cmsBlockVersionId?: string;
|
|
816
882
|
config?: GenericRecord;
|
|
@@ -821,6 +887,7 @@ export type Schemas = {
|
|
|
821
887
|
fieldConfig?: GenericRecord;
|
|
822
888
|
id: string;
|
|
823
889
|
locked?: boolean;
|
|
890
|
+
/** Key-value pair to configure which element to be shown in which slot. */
|
|
824
891
|
slot: string;
|
|
825
892
|
translated: {
|
|
826
893
|
blockId: string;
|
|
@@ -829,6 +896,7 @@ export type Schemas = {
|
|
|
829
896
|
type: string;
|
|
830
897
|
versionId: string;
|
|
831
898
|
};
|
|
899
|
+
/** It indicates the types of content that can be defined within the slot which includes `image`, `text`, `form`, `product-listing`, `category-navigation`, `product-box`, `buy-box`, `sidebar-filter`, etc. */
|
|
832
900
|
type: string;
|
|
833
901
|
/** Format: date-time */
|
|
834
902
|
readonly updatedAt?: string;
|
|
@@ -890,13 +958,24 @@ export type Schemas = {
|
|
|
890
958
|
* @example f86b6a872cb83dbd22d838ceda1aa3d4
|
|
891
959
|
*/
|
|
892
960
|
hash: string;
|
|
961
|
+
/**
|
|
962
|
+
* Format: uuid
|
|
963
|
+
* The language ID for which the cookie configuration was generated. Used to store hashes per language.
|
|
964
|
+
* @example 2fbb5fe2e29a4d70aa5854ce7ce3e20b
|
|
965
|
+
*/
|
|
966
|
+
languageId: string;
|
|
893
967
|
};
|
|
894
968
|
Country: {
|
|
969
|
+
/** When boolean value is `true`, the country is available for selection in the storefront. */
|
|
895
970
|
active?: boolean;
|
|
896
971
|
addressFormat: GenericRecord;
|
|
972
|
+
/** Wildcard formatted zip codes to allow easy searching in the frontend based on initial constants, for example - 24****, 1856**. */
|
|
897
973
|
advancedPostalCodePattern?: string;
|
|
974
|
+
/** Verify for advanced postal code pattern. */
|
|
898
975
|
checkAdvancedPostalCodePattern?: boolean;
|
|
976
|
+
/** Verify for valid postal code pattern. */
|
|
899
977
|
checkPostalCodePattern?: boolean;
|
|
978
|
+
/** Verify if VAT ID is valid or not. */
|
|
900
979
|
checkVatIdPattern?: boolean;
|
|
901
980
|
companyTax?: {
|
|
902
981
|
/** Format: float */
|
|
@@ -913,17 +992,27 @@ export type Schemas = {
|
|
|
913
992
|
enabled: boolean;
|
|
914
993
|
};
|
|
915
994
|
customFields?: GenericRecord;
|
|
995
|
+
/** Default pattern of postal or zip code. */
|
|
916
996
|
defaultPostalCodePattern?: string;
|
|
997
|
+
/** The country's state is displayed in the address when boolean value is `true`. */
|
|
917
998
|
displayStateInRegistration?: boolean;
|
|
999
|
+
/** State details in the address are force included when boolean value is `true`. */
|
|
918
1000
|
forceStateInRegistration?: boolean;
|
|
919
1001
|
id: string;
|
|
920
1002
|
isEu?: boolean;
|
|
1003
|
+
/** Internationally recognized two-letter country codes. For example, DE, IN, NO, etc. */
|
|
921
1004
|
iso?: string;
|
|
1005
|
+
/** Internationally recognized three-letter country codes. For example, DEU, IND, NOR, etc. */
|
|
922
1006
|
iso3?: string;
|
|
923
1007
|
name: string;
|
|
924
|
-
/**
|
|
1008
|
+
/**
|
|
1009
|
+
* Format: int64
|
|
1010
|
+
* Numerical value that indicates the order in which the defined countries must be displayed in the frontend.
|
|
1011
|
+
*/
|
|
925
1012
|
position?: number;
|
|
1013
|
+
/** The postal code is made mandatory specification in the address, when boolean value is `true`. */
|
|
926
1014
|
postalCodeRequired?: boolean;
|
|
1015
|
+
/** The shipping availability for a country is enabled when boolean value is `true`. */
|
|
927
1016
|
shippingAvailable?: boolean;
|
|
928
1017
|
/** States/provinces/regions within the country */
|
|
929
1018
|
states?: components["schemas"]["CountryState"][];
|
|
@@ -937,15 +1026,22 @@ export type Schemas = {
|
|
|
937
1026
|
};
|
|
938
1027
|
/** Format: date-time */
|
|
939
1028
|
readonly updatedAt?: string;
|
|
1029
|
+
/** Unique VAT ID with country code and numbers, for example - GB999 9999 */
|
|
940
1030
|
vatIdPattern?: string;
|
|
1031
|
+
/** Set to true, if VAT ID is to be made mandatory. */
|
|
941
1032
|
vatIdRequired?: boolean;
|
|
942
1033
|
};
|
|
943
1034
|
CountryJsonApi: components["schemas"]["resource"] & {
|
|
1035
|
+
/** When boolean value is `true`, the country is available for selection in the storefront. */
|
|
944
1036
|
active?: boolean;
|
|
945
1037
|
addressFormat: GenericRecord;
|
|
1038
|
+
/** Wildcard formatted zip codes to allow easy searching in the frontend based on initial constants, for example - 24****, 1856**. */
|
|
946
1039
|
advancedPostalCodePattern?: string;
|
|
1040
|
+
/** Verify for advanced postal code pattern. */
|
|
947
1041
|
checkAdvancedPostalCodePattern?: boolean;
|
|
1042
|
+
/** Verify for valid postal code pattern. */
|
|
948
1043
|
checkPostalCodePattern?: boolean;
|
|
1044
|
+
/** Verify if VAT ID is valid or not. */
|
|
949
1045
|
checkVatIdPattern?: boolean;
|
|
950
1046
|
companyTax?: {
|
|
951
1047
|
/** Format: float */
|
|
@@ -962,16 +1058,25 @@ export type Schemas = {
|
|
|
962
1058
|
enabled: boolean;
|
|
963
1059
|
};
|
|
964
1060
|
customFields?: GenericRecord;
|
|
1061
|
+
/** Default pattern of postal or zip code. */
|
|
965
1062
|
defaultPostalCodePattern?: string;
|
|
1063
|
+
/** The country's state is displayed in the address when boolean value is `true`. */
|
|
966
1064
|
displayStateInRegistration?: boolean;
|
|
1065
|
+
/** State details in the address are force included when boolean value is `true`. */
|
|
967
1066
|
forceStateInRegistration?: boolean;
|
|
968
1067
|
id: string;
|
|
969
1068
|
isEu?: boolean;
|
|
1069
|
+
/** Internationally recognized two-letter country codes. For example, DE, IN, NO, etc. */
|
|
970
1070
|
iso?: string;
|
|
1071
|
+
/** Internationally recognized three-letter country codes. For example, DEU, IND, NOR, etc. */
|
|
971
1072
|
iso3?: string;
|
|
972
1073
|
name: string;
|
|
973
|
-
/**
|
|
1074
|
+
/**
|
|
1075
|
+
* Format: int64
|
|
1076
|
+
* Numerical value that indicates the order in which the defined countries must be displayed in the frontend.
|
|
1077
|
+
*/
|
|
974
1078
|
position?: number;
|
|
1079
|
+
/** The postal code is made mandatory specification in the address, when boolean value is `true`. */
|
|
975
1080
|
postalCodeRequired?: boolean;
|
|
976
1081
|
relationships?: {
|
|
977
1082
|
/** States/provinces/regions within the country */
|
|
@@ -991,6 +1096,7 @@ export type Schemas = {
|
|
|
991
1096
|
};
|
|
992
1097
|
};
|
|
993
1098
|
};
|
|
1099
|
+
/** The shipping availability for a country is enabled when boolean value is `true`. */
|
|
994
1100
|
shippingAvailable?: boolean;
|
|
995
1101
|
translated: {
|
|
996
1102
|
advancedPostalCodePattern: string;
|
|
@@ -1002,19 +1108,27 @@ export type Schemas = {
|
|
|
1002
1108
|
};
|
|
1003
1109
|
/** Format: date-time */
|
|
1004
1110
|
readonly updatedAt?: string;
|
|
1111
|
+
/** Unique VAT ID with country code and numbers, for example - GB999 9999 */
|
|
1005
1112
|
vatIdPattern?: string;
|
|
1113
|
+
/** Set to true, if VAT ID is to be made mandatory. */
|
|
1006
1114
|
vatIdRequired?: boolean;
|
|
1007
1115
|
};
|
|
1008
1116
|
CountryState: {
|
|
1117
|
+
/** When boolean value is `true`, the country's state is available for selection in the storefront. */
|
|
1009
1118
|
active?: boolean;
|
|
1119
|
+
/** Unique identity of the country. */
|
|
1010
1120
|
countryId: string;
|
|
1011
1121
|
/** Format: date-time */
|
|
1012
1122
|
readonly createdAt?: string;
|
|
1013
1123
|
customFields?: GenericRecord;
|
|
1014
1124
|
id: string;
|
|
1015
1125
|
name: string;
|
|
1016
|
-
/**
|
|
1126
|
+
/**
|
|
1127
|
+
* Format: int64
|
|
1128
|
+
* Numerical value that indicates the order in which the defined states must be displayed in the frontend.
|
|
1129
|
+
*/
|
|
1017
1130
|
position?: number;
|
|
1131
|
+
/** An abbreviation for the country's state. */
|
|
1018
1132
|
shortCode: string;
|
|
1019
1133
|
translated: {
|
|
1020
1134
|
countryId: string;
|
|
@@ -1025,15 +1139,21 @@ export type Schemas = {
|
|
|
1025
1139
|
readonly updatedAt?: string;
|
|
1026
1140
|
};
|
|
1027
1141
|
CountryStateJsonApi: components["schemas"]["resource"] & {
|
|
1142
|
+
/** When boolean value is `true`, the country's state is available for selection in the storefront. */
|
|
1028
1143
|
active?: boolean;
|
|
1144
|
+
/** Unique identity of the country. */
|
|
1029
1145
|
countryId: string;
|
|
1030
1146
|
/** Format: date-time */
|
|
1031
1147
|
readonly createdAt?: string;
|
|
1032
1148
|
customFields?: GenericRecord;
|
|
1033
1149
|
id: string;
|
|
1034
1150
|
name: string;
|
|
1035
|
-
/**
|
|
1151
|
+
/**
|
|
1152
|
+
* Format: int64
|
|
1153
|
+
* Numerical value that indicates the order in which the defined states must be displayed in the frontend.
|
|
1154
|
+
*/
|
|
1036
1155
|
position?: number;
|
|
1156
|
+
/** An abbreviation for the country's state. */
|
|
1037
1157
|
shortCode: string;
|
|
1038
1158
|
translated: {
|
|
1039
1159
|
countryId: string;
|
|
@@ -1095,9 +1215,13 @@ export type Schemas = {
|
|
|
1095
1215
|
/** Format: date-time */
|
|
1096
1216
|
readonly createdAt?: string;
|
|
1097
1217
|
customFields?: GenericRecord;
|
|
1098
|
-
/**
|
|
1218
|
+
/**
|
|
1219
|
+
* Format: float
|
|
1220
|
+
* Currency exchange rate.
|
|
1221
|
+
*/
|
|
1099
1222
|
factor: number;
|
|
1100
1223
|
id: string;
|
|
1224
|
+
/** Standard international three digit code to represent currency. For example, USD. */
|
|
1101
1225
|
isoCode: string;
|
|
1102
1226
|
/** Runtime field, cannot be used as part of the criteria. */
|
|
1103
1227
|
isSystemDefault?: boolean;
|
|
@@ -1109,11 +1233,18 @@ export type Schemas = {
|
|
|
1109
1233
|
roundForNet: boolean;
|
|
1110
1234
|
};
|
|
1111
1235
|
name: string;
|
|
1112
|
-
/**
|
|
1236
|
+
/**
|
|
1237
|
+
* Format: int64
|
|
1238
|
+
* The order of the tabs for multiple currencies defined.
|
|
1239
|
+
*/
|
|
1113
1240
|
position?: number;
|
|
1114
1241
|
shortName: string;
|
|
1242
|
+
/** A currency symbol is a graphical representation used as shorthand for a currency's name, for example US Dollar - $ */
|
|
1115
1243
|
symbol: string;
|
|
1116
|
-
/**
|
|
1244
|
+
/**
|
|
1245
|
+
* Format: float
|
|
1246
|
+
* The value from which the tax must be exempted.
|
|
1247
|
+
*/
|
|
1117
1248
|
taxFreeFrom?: number;
|
|
1118
1249
|
totalRounding: {
|
|
1119
1250
|
/** Format: int64 */
|
|
@@ -1142,9 +1273,13 @@ export type Schemas = {
|
|
|
1142
1273
|
/** Format: date-time */
|
|
1143
1274
|
readonly createdAt?: string;
|
|
1144
1275
|
customFields?: GenericRecord;
|
|
1145
|
-
/**
|
|
1276
|
+
/**
|
|
1277
|
+
* Format: float
|
|
1278
|
+
* Currency exchange rate.
|
|
1279
|
+
*/
|
|
1146
1280
|
factor: number;
|
|
1147
1281
|
id: string;
|
|
1282
|
+
/** Standard international three digit code to represent currency. For example, USD. */
|
|
1148
1283
|
isoCode: string;
|
|
1149
1284
|
/** Runtime field, cannot be used as part of the criteria. */
|
|
1150
1285
|
isSystemDefault?: boolean;
|
|
@@ -1156,11 +1291,18 @@ export type Schemas = {
|
|
|
1156
1291
|
roundForNet: boolean;
|
|
1157
1292
|
};
|
|
1158
1293
|
name: string;
|
|
1159
|
-
/**
|
|
1294
|
+
/**
|
|
1295
|
+
* Format: int64
|
|
1296
|
+
* The order of the tabs for multiple currencies defined.
|
|
1297
|
+
*/
|
|
1160
1298
|
position?: number;
|
|
1161
1299
|
shortName: string;
|
|
1300
|
+
/** A currency symbol is a graphical representation used as shorthand for a currency's name, for example US Dollar - $ */
|
|
1162
1301
|
symbol: string;
|
|
1163
|
-
/**
|
|
1302
|
+
/**
|
|
1303
|
+
* Format: float
|
|
1304
|
+
* The value from which the tax must be exempted.
|
|
1305
|
+
*/
|
|
1164
1306
|
taxFreeFrom?: number;
|
|
1165
1307
|
totalRounding: {
|
|
1166
1308
|
/** Format: int64 */
|
|
@@ -1207,6 +1349,7 @@ export type Schemas = {
|
|
|
1207
1349
|
readonly updatedAt?: string;
|
|
1208
1350
|
};
|
|
1209
1351
|
Customer: {
|
|
1352
|
+
/** To keep the status of the customer active, the boolean value is set to `true`. */
|
|
1210
1353
|
active?: boolean;
|
|
1211
1354
|
/** Currently active billing address in the session */
|
|
1212
1355
|
activeBillingAddress: components["schemas"]["CustomerAddress"];
|
|
@@ -1214,61 +1357,103 @@ export type Schemas = {
|
|
|
1214
1357
|
activeShippingAddress: components["schemas"]["CustomerAddress"];
|
|
1215
1358
|
/** All addresses saved for the customer */
|
|
1216
1359
|
addresses?: components["schemas"]["CustomerAddress"][];
|
|
1360
|
+
/** An affiliate code is an identification option with which website operators can mark outgoing links. */
|
|
1217
1361
|
affiliateCode?: string;
|
|
1218
1362
|
/** @enum {string} */
|
|
1219
1363
|
apiAlias: "customer";
|
|
1364
|
+
/** To capture customer's birthday details. */
|
|
1220
1365
|
birthday?: string;
|
|
1366
|
+
/** A campaign code is the globally unique identifier for a campaign. */
|
|
1221
1367
|
campaignCode?: string;
|
|
1222
1368
|
/** Format: date-time */
|
|
1223
1369
|
readonly createdAt?: string;
|
|
1224
1370
|
createdById?: string;
|
|
1371
|
+
/** Unique number assigned to identity a customer. */
|
|
1225
1372
|
customerNumber: string;
|
|
1226
1373
|
customFields?: GenericRecord;
|
|
1227
1374
|
/** Default billing address for the customer */
|
|
1228
1375
|
defaultBillingAddress?: components["schemas"]["CustomerAddress"];
|
|
1376
|
+
/** Unique identity of default billing address. */
|
|
1229
1377
|
defaultBillingAddressId: string;
|
|
1230
1378
|
/** Default shipping address for the customer */
|
|
1231
1379
|
defaultShippingAddress?: components["schemas"]["CustomerAddress"];
|
|
1380
|
+
/** Unique identity of default shipping address. */
|
|
1232
1381
|
defaultShippingAddressId: string;
|
|
1233
|
-
/**
|
|
1382
|
+
/**
|
|
1383
|
+
* Format: date-time
|
|
1384
|
+
* Date and time when the double opt-in email was confirmed.
|
|
1385
|
+
*/
|
|
1234
1386
|
doubleOptInConfirmDate?: string;
|
|
1235
|
-
/**
|
|
1387
|
+
/**
|
|
1388
|
+
* Format: date-time
|
|
1389
|
+
* Date and time when the double opt-in email was sent.
|
|
1390
|
+
*/
|
|
1236
1391
|
doubleOptInEmailSentDate?: string;
|
|
1392
|
+
/** Set to `true` to allow user subscriptions to an email marketing list. */
|
|
1237
1393
|
doubleOptInRegistration?: boolean;
|
|
1394
|
+
/** Email ID of the customer. */
|
|
1238
1395
|
email: string;
|
|
1239
|
-
/**
|
|
1396
|
+
/**
|
|
1397
|
+
* Format: date-time
|
|
1398
|
+
* To capture date and time of customer's first login.
|
|
1399
|
+
*/
|
|
1240
1400
|
firstLogin?: string;
|
|
1401
|
+
/** First name of the customer. */
|
|
1241
1402
|
firstName: string;
|
|
1242
1403
|
/** Customer group determining pricing and permissions */
|
|
1243
1404
|
group?: components["schemas"]["CustomerGroup"];
|
|
1405
|
+
/** Unique identity of customer group. */
|
|
1244
1406
|
groupId: string;
|
|
1407
|
+
/** Boolean value is `true` if it is to be a guest account. */
|
|
1245
1408
|
guest?: boolean;
|
|
1409
|
+
/** Password hash for customer recovery. */
|
|
1246
1410
|
hash?: string;
|
|
1247
1411
|
id: string;
|
|
1248
1412
|
/** Preferred language for customer communication */
|
|
1249
1413
|
language?: components["schemas"]["Language"];
|
|
1414
|
+
/** Unique identity of language. */
|
|
1250
1415
|
languageId: string;
|
|
1251
|
-
/**
|
|
1416
|
+
/**
|
|
1417
|
+
* Format: date-time
|
|
1418
|
+
* To capture date and time of customer's last login.
|
|
1419
|
+
*/
|
|
1252
1420
|
lastLogin?: string;
|
|
1421
|
+
/** Last name of the customer. */
|
|
1253
1422
|
lastName: string;
|
|
1254
|
-
/**
|
|
1423
|
+
/**
|
|
1424
|
+
* Format: date-time
|
|
1425
|
+
* Captures last order date.
|
|
1426
|
+
*/
|
|
1255
1427
|
readonly lastOrderDate?: string;
|
|
1256
1428
|
/** Last used payment method by the customer */
|
|
1257
1429
|
lastPaymentMethod?: components["schemas"]["PaymentMethod"];
|
|
1430
|
+
/** Unique identity of previous payment method. */
|
|
1258
1431
|
lastPaymentMethodId?: string;
|
|
1259
|
-
/**
|
|
1432
|
+
/**
|
|
1433
|
+
* Format: int64
|
|
1434
|
+
* Captures the number of orders placed.
|
|
1435
|
+
*/
|
|
1260
1436
|
readonly orderCount?: number;
|
|
1261
|
-
/**
|
|
1437
|
+
/**
|
|
1438
|
+
* Format: float
|
|
1439
|
+
* Sum of total amount to be paid.
|
|
1440
|
+
*/
|
|
1262
1441
|
readonly orderTotalAmount?: number;
|
|
1263
|
-
/**
|
|
1442
|
+
/**
|
|
1443
|
+
* Format: int64
|
|
1444
|
+
* Number of reviews the customer has given.
|
|
1445
|
+
*/
|
|
1264
1446
|
readonly reviewCount?: number;
|
|
1447
|
+
/** Unique identity of sales channel. */
|
|
1265
1448
|
salesChannelId: string;
|
|
1266
1449
|
/** Customer salutation (e.g., Mr., Mrs., Ms.) */
|
|
1267
1450
|
salutation?: components["schemas"]["Salutation"];
|
|
1451
|
+
/** Unique identity of salutation. */
|
|
1268
1452
|
salutationId?: string;
|
|
1269
1453
|
readonly tagIds?: string[];
|
|
1270
1454
|
/** Tags assigned to the customer for organization and segmentation */
|
|
1271
1455
|
tags?: components["schemas"]["Tag"][];
|
|
1456
|
+
/** Titles or honorifics like Mr, Mrs, etc. */
|
|
1272
1457
|
title?: string;
|
|
1273
1458
|
/** Format: date-time */
|
|
1274
1459
|
readonly updatedAt?: string;
|
|
@@ -1286,31 +1471,50 @@ export type Schemas = {
|
|
|
1286
1471
|
}
|
|
1287
1472
|
);
|
|
1288
1473
|
CustomerAddress: {
|
|
1474
|
+
/** Additional customer's address information. */
|
|
1289
1475
|
additionalAddressLine1?: string;
|
|
1476
|
+
/** Additional customer's address information. */
|
|
1290
1477
|
additionalAddressLine2?: string;
|
|
1478
|
+
/** Name of customer's city. */
|
|
1291
1479
|
city: string;
|
|
1480
|
+
/** Name of customer's company. */
|
|
1292
1481
|
company?: string;
|
|
1293
1482
|
country?: components["schemas"]["Country"];
|
|
1483
|
+
/** Unique identity of country. */
|
|
1294
1484
|
countryId: string;
|
|
1295
1485
|
countryState?: components["schemas"]["CountryState"];
|
|
1486
|
+
/** Unique identity of country's state. */
|
|
1296
1487
|
countryStateId?: string;
|
|
1297
1488
|
/** Format: date-time */
|
|
1298
1489
|
readonly createdAt?: string;
|
|
1490
|
+
/** Unique identity of customer. */
|
|
1299
1491
|
customerId: string;
|
|
1300
1492
|
customFields?: GenericRecord;
|
|
1493
|
+
/** Name of customer's department. */
|
|
1301
1494
|
department?: string;
|
|
1495
|
+
/** First name of the customer. */
|
|
1302
1496
|
firstName: string;
|
|
1303
1497
|
/** Runtime field, cannot be used as part of the criteria. */
|
|
1304
1498
|
hash?: string;
|
|
1305
1499
|
id: string;
|
|
1500
|
+
/** Added since version: 6.7.7.0. Runtime field, cannot be used as part of the criteria. */
|
|
1501
|
+
isDefaultBillingAddress?: boolean;
|
|
1502
|
+
/** Added since version: 6.7.7.0. Runtime field, cannot be used as part of the criteria. */
|
|
1503
|
+
isDefaultShippingAddress?: boolean;
|
|
1504
|
+
/** Last name of the customer. */
|
|
1306
1505
|
lastName: string;
|
|
1506
|
+
/** Customer's phone number. */
|
|
1307
1507
|
phoneNumber?: string;
|
|
1308
1508
|
salutation?: components["schemas"]["Salutation"];
|
|
1509
|
+
/** Unique identity of salutation. */
|
|
1309
1510
|
salutationId?: string;
|
|
1511
|
+
/** Name of customer's street. */
|
|
1310
1512
|
street: string;
|
|
1513
|
+
/** Titles given to customer like Dr. , Prof., etc */
|
|
1311
1514
|
title?: string;
|
|
1312
1515
|
/** Format: date-time */
|
|
1313
1516
|
readonly updatedAt?: string;
|
|
1517
|
+
/** Postal or zip code of customer's address. */
|
|
1314
1518
|
zipcode?: string;
|
|
1315
1519
|
};
|
|
1316
1520
|
CustomerAddressBody: {
|
|
@@ -1333,6 +1537,97 @@ export type Schemas = {
|
|
|
1333
1537
|
title?: string;
|
|
1334
1538
|
zipcode?: string;
|
|
1335
1539
|
};
|
|
1540
|
+
CustomerAddressJsonApi: components["schemas"]["resource"] & {
|
|
1541
|
+
/** Additional customer's address information. */
|
|
1542
|
+
additionalAddressLine1?: string;
|
|
1543
|
+
/** Additional customer's address information. */
|
|
1544
|
+
additionalAddressLine2?: string;
|
|
1545
|
+
/** Name of customer's city. */
|
|
1546
|
+
city: string;
|
|
1547
|
+
/** Name of customer's company. */
|
|
1548
|
+
company?: string;
|
|
1549
|
+
/** Unique identity of country. */
|
|
1550
|
+
countryId: string;
|
|
1551
|
+
/** Unique identity of country's state. */
|
|
1552
|
+
countryStateId?: string;
|
|
1553
|
+
/** Format: date-time */
|
|
1554
|
+
readonly createdAt?: string;
|
|
1555
|
+
/** Unique identity of customer. */
|
|
1556
|
+
customerId: string;
|
|
1557
|
+
customFields?: GenericRecord;
|
|
1558
|
+
/** Name of customer's department. */
|
|
1559
|
+
department?: string;
|
|
1560
|
+
/** First name of the customer. */
|
|
1561
|
+
firstName: string;
|
|
1562
|
+
/** Runtime field, cannot be used as part of the criteria. */
|
|
1563
|
+
hash?: string;
|
|
1564
|
+
id: string;
|
|
1565
|
+
/** Added since version: 6.7.7.0. Runtime field, cannot be used as part of the criteria. */
|
|
1566
|
+
isDefaultBillingAddress?: boolean;
|
|
1567
|
+
/** Added since version: 6.7.7.0. Runtime field, cannot be used as part of the criteria. */
|
|
1568
|
+
isDefaultShippingAddress?: boolean;
|
|
1569
|
+
/** Last name of the customer. */
|
|
1570
|
+
lastName: string;
|
|
1571
|
+
/** Customer's phone number. */
|
|
1572
|
+
phoneNumber?: string;
|
|
1573
|
+
relationships?: {
|
|
1574
|
+
country?: {
|
|
1575
|
+
data?: {
|
|
1576
|
+
/** @example e909c2d7067ea37437cf97fe11d91bd0 */
|
|
1577
|
+
id?: string;
|
|
1578
|
+
/** @example country */
|
|
1579
|
+
type?: string;
|
|
1580
|
+
};
|
|
1581
|
+
links?: {
|
|
1582
|
+
/**
|
|
1583
|
+
* Format: uri-reference
|
|
1584
|
+
* @example /customer-address/1b4b031005f93d02d887e7d66efb653b/country
|
|
1585
|
+
*/
|
|
1586
|
+
related?: string;
|
|
1587
|
+
};
|
|
1588
|
+
};
|
|
1589
|
+
countryState?: {
|
|
1590
|
+
data?: {
|
|
1591
|
+
/** @example cb6a9764567191fb74fe28d8d6a4819d */
|
|
1592
|
+
id?: string;
|
|
1593
|
+
/** @example country_state */
|
|
1594
|
+
type?: string;
|
|
1595
|
+
};
|
|
1596
|
+
links?: {
|
|
1597
|
+
/**
|
|
1598
|
+
* Format: uri-reference
|
|
1599
|
+
* @example /customer-address/1b4b031005f93d02d887e7d66efb653b/countryState
|
|
1600
|
+
*/
|
|
1601
|
+
related?: string;
|
|
1602
|
+
};
|
|
1603
|
+
};
|
|
1604
|
+
salutation?: {
|
|
1605
|
+
data?: {
|
|
1606
|
+
/** @example 7a6efb02514153b5aa9a8f40c6f8bcc3 */
|
|
1607
|
+
id?: string;
|
|
1608
|
+
/** @example salutation */
|
|
1609
|
+
type?: string;
|
|
1610
|
+
};
|
|
1611
|
+
links?: {
|
|
1612
|
+
/**
|
|
1613
|
+
* Format: uri-reference
|
|
1614
|
+
* @example /customer-address/1b4b031005f93d02d887e7d66efb653b/salutation
|
|
1615
|
+
*/
|
|
1616
|
+
related?: string;
|
|
1617
|
+
};
|
|
1618
|
+
};
|
|
1619
|
+
};
|
|
1620
|
+
/** Unique identity of salutation. */
|
|
1621
|
+
salutationId?: string;
|
|
1622
|
+
/** Name of customer's street. */
|
|
1623
|
+
street: string;
|
|
1624
|
+
/** Titles given to customer like Dr. , Prof., etc */
|
|
1625
|
+
title?: string;
|
|
1626
|
+
/** Format: date-time */
|
|
1627
|
+
readonly updatedAt?: string;
|
|
1628
|
+
/** Postal or zip code of customer's address. */
|
|
1629
|
+
zipcode?: string;
|
|
1630
|
+
};
|
|
1336
1631
|
CustomerAddressRead: {
|
|
1337
1632
|
country: components["schemas"]["Country"];
|
|
1338
1633
|
countryState?: components["schemas"]["CountryState"] | null;
|
|
@@ -1347,9 +1642,11 @@ export type Schemas = {
|
|
|
1347
1642
|
/** Format: date-time */
|
|
1348
1643
|
readonly createdAt?: string;
|
|
1349
1644
|
customFields?: GenericRecord;
|
|
1645
|
+
/** If boolean value is `true` gross value is displayed else, net value will be displayed to the customer. */
|
|
1350
1646
|
displayGross?: boolean;
|
|
1351
1647
|
id: string;
|
|
1352
1648
|
name: string;
|
|
1649
|
+
/** To enable the registration of partner customer group. */
|
|
1353
1650
|
registrationActive?: boolean;
|
|
1354
1651
|
registrationIntroduction?: string;
|
|
1355
1652
|
registrationOnlyCompanyRegistration?: boolean;
|
|
@@ -1380,6 +1677,7 @@ export type Schemas = {
|
|
|
1380
1677
|
CustomerWishlist: {
|
|
1381
1678
|
/** Format: date-time */
|
|
1382
1679
|
readonly createdAt?: string;
|
|
1680
|
+
/** Unique identity of the customer. */
|
|
1383
1681
|
customerId: string;
|
|
1384
1682
|
customFields?: GenericRecord;
|
|
1385
1683
|
id: string;
|
|
@@ -1391,6 +1689,7 @@ export type Schemas = {
|
|
|
1391
1689
|
/** Format: date-time */
|
|
1392
1690
|
readonly createdAt?: string;
|
|
1393
1691
|
id: string;
|
|
1692
|
+
/** Unique identity of the product. */
|
|
1394
1693
|
productId: string;
|
|
1395
1694
|
productVersionId?: string;
|
|
1396
1695
|
/** Format: date-time */
|
|
@@ -1401,15 +1700,22 @@ export type Schemas = {
|
|
|
1401
1700
|
readonly createdAt?: string;
|
|
1402
1701
|
customFields?: GenericRecord;
|
|
1403
1702
|
id: string;
|
|
1404
|
-
/**
|
|
1703
|
+
/**
|
|
1704
|
+
* Format: int64
|
|
1705
|
+
* Maximum delivery time taken.
|
|
1706
|
+
*/
|
|
1405
1707
|
max: number;
|
|
1406
|
-
/**
|
|
1708
|
+
/**
|
|
1709
|
+
* Format: int64
|
|
1710
|
+
* Minimum delivery time taken.
|
|
1711
|
+
*/
|
|
1407
1712
|
min: number;
|
|
1408
1713
|
name: string;
|
|
1409
1714
|
translated: {
|
|
1410
1715
|
name: string;
|
|
1411
1716
|
unit: string;
|
|
1412
1717
|
};
|
|
1718
|
+
/** Unit in which the delivery time is defined. For example, days or hours. */
|
|
1413
1719
|
unit: string;
|
|
1414
1720
|
/** Format: date-time */
|
|
1415
1721
|
readonly updatedAt?: string;
|
|
@@ -1448,14 +1754,22 @@ export type Schemas = {
|
|
|
1448
1754
|
/** Format: date-time */
|
|
1449
1755
|
readonly createdAt?: string;
|
|
1450
1756
|
customFields?: GenericRecord;
|
|
1757
|
+
/** Unique number associated with every document. */
|
|
1451
1758
|
documentNumber?: string;
|
|
1759
|
+
/** Unique identity of the document type. */
|
|
1452
1760
|
documentTypeId: string;
|
|
1761
|
+
/** A prefix name added to the file name separated by an underscore. */
|
|
1453
1762
|
filenamePrefix?: string;
|
|
1763
|
+
/** A suffix name added to the file name separated by an underscore. */
|
|
1454
1764
|
filenameSuffix?: string;
|
|
1765
|
+
/** When set to `true`, the document can be used across all sales channels. */
|
|
1455
1766
|
global?: boolean;
|
|
1456
1767
|
id: string;
|
|
1768
|
+
/** Logo in the document at the top-right corner. */
|
|
1457
1769
|
logo?: components["schemas"]["Media"];
|
|
1770
|
+
/** Unique identity of the company logo. */
|
|
1458
1771
|
logoId?: string;
|
|
1772
|
+
/** Name of the document. */
|
|
1459
1773
|
name: string;
|
|
1460
1774
|
/** Format: date-time */
|
|
1461
1775
|
readonly updatedAt?: string;
|
|
@@ -1463,9 +1777,12 @@ export type Schemas = {
|
|
|
1463
1777
|
DocumentBaseConfigSalesChannel: {
|
|
1464
1778
|
/** Format: date-time */
|
|
1465
1779
|
readonly createdAt?: string;
|
|
1780
|
+
/** Unique identity of document's base config. */
|
|
1466
1781
|
documentBaseConfigId: string;
|
|
1782
|
+
/** Unique identity of document type. */
|
|
1467
1783
|
documentTypeId?: string;
|
|
1468
1784
|
id: string;
|
|
1785
|
+
/** Unique identity of sales channel. */
|
|
1469
1786
|
salesChannelId?: string;
|
|
1470
1787
|
/** Format: date-time */
|
|
1471
1788
|
readonly updatedAt?: string;
|
|
@@ -1476,6 +1793,7 @@ export type Schemas = {
|
|
|
1476
1793
|
customFields?: GenericRecord;
|
|
1477
1794
|
id: string;
|
|
1478
1795
|
name: string;
|
|
1796
|
+
/** Technical name of document type. */
|
|
1479
1797
|
technicalName: string;
|
|
1480
1798
|
translated: {
|
|
1481
1799
|
name: string;
|
|
@@ -1484,6 +1802,23 @@ export type Schemas = {
|
|
|
1484
1802
|
/** Format: date-time */
|
|
1485
1803
|
readonly updatedAt?: string;
|
|
1486
1804
|
};
|
|
1805
|
+
Domain: {
|
|
1806
|
+
apiAlias?: string;
|
|
1807
|
+
/** Format: date-time */
|
|
1808
|
+
createdAt?: string;
|
|
1809
|
+
/** Format: uuid */
|
|
1810
|
+
currencyId?: string;
|
|
1811
|
+
/** Format: uuid */
|
|
1812
|
+
id?: string;
|
|
1813
|
+
/** Format: uuid */
|
|
1814
|
+
languageId?: string;
|
|
1815
|
+
/** Format: uuid */
|
|
1816
|
+
snippetSetId?: string | null;
|
|
1817
|
+
translated: [];
|
|
1818
|
+
/** Format: date-time */
|
|
1819
|
+
updatedAt?: string | null;
|
|
1820
|
+
url?: string;
|
|
1821
|
+
};
|
|
1487
1822
|
EntitySearchResult: {
|
|
1488
1823
|
/** Contains aggregated data. A simple example is the determination of the average price from a product search query. */
|
|
1489
1824
|
aggregations?: GenericRecord[];
|
|
@@ -1693,12 +2028,16 @@ export type Schemas = {
|
|
|
1693
2028
|
id: string;
|
|
1694
2029
|
/** Locale defining regional settings (date, time, number formats) */
|
|
1695
2030
|
locale?: components["schemas"]["Locale"];
|
|
2031
|
+
/** Unique identity of locale. */
|
|
1696
2032
|
localeId: string;
|
|
2033
|
+
/** Name of the language. */
|
|
1697
2034
|
name: string;
|
|
2035
|
+
/** Unique identity of language. */
|
|
1698
2036
|
parent?: components["schemas"]["Language"];
|
|
1699
2037
|
parentId?: string;
|
|
1700
2038
|
/** Locale used for translating content */
|
|
1701
2039
|
translationCode?: components["schemas"]["Locale"];
|
|
2040
|
+
/** Unique identity of translation code. */
|
|
1702
2041
|
translationCodeId?: string;
|
|
1703
2042
|
/** Format: date-time */
|
|
1704
2043
|
readonly updatedAt?: string;
|
|
@@ -1709,7 +2048,9 @@ export type Schemas = {
|
|
|
1709
2048
|
readonly createdAt?: string;
|
|
1710
2049
|
customFields?: GenericRecord;
|
|
1711
2050
|
id: string;
|
|
2051
|
+
/** Unique identity of locale. */
|
|
1712
2052
|
localeId: string;
|
|
2053
|
+
/** Name of the language. */
|
|
1713
2054
|
name: string;
|
|
1714
2055
|
parentId?: string;
|
|
1715
2056
|
relationships?: {
|
|
@@ -1745,6 +2086,7 @@ export type Schemas = {
|
|
|
1745
2086
|
related?: string;
|
|
1746
2087
|
};
|
|
1747
2088
|
};
|
|
2089
|
+
/** Unique identity of language. */
|
|
1748
2090
|
parent?: {
|
|
1749
2091
|
data?: {
|
|
1750
2092
|
/** @example d0e45878043844ffc41aac437e86b602 */
|
|
@@ -1777,6 +2119,7 @@ export type Schemas = {
|
|
|
1777
2119
|
};
|
|
1778
2120
|
};
|
|
1779
2121
|
};
|
|
2122
|
+
/** Unique identity of translation code. */
|
|
1780
2123
|
translationCodeId?: string;
|
|
1781
2124
|
/** Format: date-time */
|
|
1782
2125
|
readonly updatedAt?: string;
|
|
@@ -1831,6 +2174,7 @@ export type Schemas = {
|
|
|
1831
2174
|
referencedId?: string;
|
|
1832
2175
|
removable?: boolean;
|
|
1833
2176
|
stackable?: boolean;
|
|
2177
|
+
/** @deprecated */
|
|
1834
2178
|
states: ("is-physical" | "is-download")[];
|
|
1835
2179
|
type: components["schemas"]["LineItemType"];
|
|
1836
2180
|
uniqueIdentifier?: string;
|
|
@@ -1851,6 +2195,7 @@ export type Schemas = {
|
|
|
1851
2195
|
price?: number;
|
|
1852
2196
|
};
|
|
1853
2197
|
Locale: {
|
|
2198
|
+
/** Code given to the locale. For example: en-CA. */
|
|
1854
2199
|
code: string;
|
|
1855
2200
|
/** Format: date-time */
|
|
1856
2201
|
readonly createdAt?: string;
|
|
@@ -1929,6 +2274,7 @@ export type Schemas = {
|
|
|
1929
2274
|
customFields?: GenericRecord;
|
|
1930
2275
|
id: string;
|
|
1931
2276
|
name: string;
|
|
2277
|
+
/** Technical name of mail template. */
|
|
1932
2278
|
technicalName: string;
|
|
1933
2279
|
translated: {
|
|
1934
2280
|
name: string;
|
|
@@ -1938,25 +2284,31 @@ export type Schemas = {
|
|
|
1938
2284
|
readonly updatedAt?: string;
|
|
1939
2285
|
};
|
|
1940
2286
|
MainCategory: {
|
|
2287
|
+
/** Unique identity of the category. */
|
|
1941
2288
|
categoryId: string;
|
|
1942
2289
|
categoryVersionId?: string;
|
|
1943
2290
|
/** Format: date-time */
|
|
1944
2291
|
readonly createdAt?: string;
|
|
1945
2292
|
id: string;
|
|
2293
|
+
/** Unique identity of the product. */
|
|
1946
2294
|
productId: string;
|
|
1947
2295
|
productVersionId?: string;
|
|
2296
|
+
/** Unique identity of the sales channel. */
|
|
1948
2297
|
salesChannelId: string;
|
|
1949
2298
|
/** Format: date-time */
|
|
1950
2299
|
readonly updatedAt?: string;
|
|
1951
2300
|
};
|
|
1952
2301
|
MainCategoryJsonApi: components["schemas"]["resource"] & {
|
|
2302
|
+
/** Unique identity of the category. */
|
|
1953
2303
|
categoryId: string;
|
|
1954
2304
|
categoryVersionId?: string;
|
|
1955
2305
|
/** Format: date-time */
|
|
1956
2306
|
readonly createdAt?: string;
|
|
1957
2307
|
id: string;
|
|
2308
|
+
/** Unique identity of the product. */
|
|
1958
2309
|
productId: string;
|
|
1959
2310
|
productVersionId?: string;
|
|
2311
|
+
/** Unique identity of the sales channel. */
|
|
1960
2312
|
salesChannelId: string;
|
|
1961
2313
|
/** Format: date-time */
|
|
1962
2314
|
readonly updatedAt?: string;
|
|
@@ -2025,9 +2377,14 @@ export type Schemas = {
|
|
|
2025
2377
|
/** Format: date-time */
|
|
2026
2378
|
readonly createdAt?: string;
|
|
2027
2379
|
customFields?: GenericRecord;
|
|
2380
|
+
/** Type of file indication. For example: jpeg, png. */
|
|
2028
2381
|
fileExtension: string;
|
|
2382
|
+
/** Name of the media file uploaded. */
|
|
2029
2383
|
fileName: string;
|
|
2030
|
-
/**
|
|
2384
|
+
/**
|
|
2385
|
+
* Format: int64
|
|
2386
|
+
* Size of the file media file uploaded.
|
|
2387
|
+
*/
|
|
2031
2388
|
readonly fileSize?: number;
|
|
2032
2389
|
/** Runtime field, cannot be used as part of the criteria. */
|
|
2033
2390
|
hasFile: boolean;
|
|
@@ -2038,8 +2395,10 @@ export type Schemas = {
|
|
|
2038
2395
|
/** Format: int64 */
|
|
2039
2396
|
width?: number;
|
|
2040
2397
|
};
|
|
2398
|
+
/** A string sent along with a file indicating the type of the file. For example: image/jpeg. */
|
|
2041
2399
|
mimeType?: string;
|
|
2042
2400
|
path: string;
|
|
2401
|
+
/** When `true`, the media display is kept private. */
|
|
2043
2402
|
private: boolean;
|
|
2044
2403
|
/** Generated thumbnail images in various sizes */
|
|
2045
2404
|
thumbnails?: components["schemas"]["MediaThumbnail"][];
|
|
@@ -2056,7 +2415,10 @@ export type Schemas = {
|
|
|
2056
2415
|
};
|
|
2057
2416
|
/** Format: date-time */
|
|
2058
2417
|
readonly updatedAt?: string;
|
|
2059
|
-
/**
|
|
2418
|
+
/**
|
|
2419
|
+
* Format: date-time
|
|
2420
|
+
* Date and time at which media was added.
|
|
2421
|
+
*/
|
|
2060
2422
|
readonly uploadedAt?: string;
|
|
2061
2423
|
/** Runtime field, cannot be used as part of the criteria. */
|
|
2062
2424
|
url: string;
|
|
@@ -2093,31 +2455,59 @@ export type Schemas = {
|
|
|
2093
2455
|
/** Format: date-time */
|
|
2094
2456
|
readonly createdAt?: string;
|
|
2095
2457
|
customFields?: GenericRecord;
|
|
2096
|
-
/**
|
|
2458
|
+
/**
|
|
2459
|
+
* Format: int64
|
|
2460
|
+
* Height of the thumbnail.
|
|
2461
|
+
*/
|
|
2097
2462
|
readonly height: number;
|
|
2098
2463
|
id: string;
|
|
2464
|
+
/** Unique identity of media. */
|
|
2099
2465
|
mediaId: string;
|
|
2100
2466
|
mediaThumbnailSizeId?: string;
|
|
2101
2467
|
path?: string;
|
|
2102
2468
|
/** Format: date-time */
|
|
2103
2469
|
readonly updatedAt?: string;
|
|
2104
|
-
/** Runtime field, cannot be used as part of the criteria. */
|
|
2470
|
+
/** Public url of media thumbnail. Runtime field, cannot be used as part of the criteria. */
|
|
2105
2471
|
url: string;
|
|
2106
|
-
/**
|
|
2472
|
+
/**
|
|
2473
|
+
* Format: int64
|
|
2474
|
+
* Width of the thumbnail.
|
|
2475
|
+
*/
|
|
2107
2476
|
readonly width: number;
|
|
2108
2477
|
};
|
|
2109
2478
|
MediaThumbnailSize: {
|
|
2110
2479
|
/** Format: date-time */
|
|
2111
2480
|
readonly createdAt?: string;
|
|
2112
2481
|
customFields?: GenericRecord;
|
|
2113
|
-
/**
|
|
2482
|
+
/**
|
|
2483
|
+
* Format: int64
|
|
2484
|
+
* Height of the thumbnail.
|
|
2485
|
+
*/
|
|
2114
2486
|
height: number;
|
|
2115
2487
|
id: string;
|
|
2116
2488
|
/** Format: date-time */
|
|
2117
2489
|
readonly updatedAt?: string;
|
|
2118
|
-
/**
|
|
2490
|
+
/**
|
|
2491
|
+
* Format: int64
|
|
2492
|
+
* Width of the thumbnail.
|
|
2493
|
+
*/
|
|
2119
2494
|
width: number;
|
|
2120
2495
|
};
|
|
2496
|
+
MultiChannelGroup: {
|
|
2497
|
+
apiAlias?: string;
|
|
2498
|
+
/** Format: date-time */
|
|
2499
|
+
createdAt?: string;
|
|
2500
|
+
/** Format: uuid */
|
|
2501
|
+
id?: string;
|
|
2502
|
+
name?: string;
|
|
2503
|
+
salesChannels?: components["schemas"]["SalesChannel"][];
|
|
2504
|
+
translated: [];
|
|
2505
|
+
/** Format: date-time */
|
|
2506
|
+
updatedAt?: string | null;
|
|
2507
|
+
};
|
|
2508
|
+
MultiChannelGroupStruct: {
|
|
2509
|
+
multiChannelGroup?: components["schemas"]["MultiChannelGroup"][];
|
|
2510
|
+
};
|
|
2121
2511
|
MultiNotFilter: {
|
|
2122
2512
|
/** @enum {string} */
|
|
2123
2513
|
operator: "and" | "or" | "nor" | "nand";
|
|
@@ -2217,26 +2607,42 @@ export type Schemas = {
|
|
|
2217
2607
|
Order: {
|
|
2218
2608
|
/** All addresses associated with the order (billing and shipping) */
|
|
2219
2609
|
addresses?: components["schemas"]["OrderAddress"][];
|
|
2610
|
+
/** An affiliate code is an identification option with which website operators can mark outgoing links. */
|
|
2220
2611
|
affiliateCode?: string;
|
|
2221
|
-
/**
|
|
2612
|
+
/**
|
|
2613
|
+
* Format: float
|
|
2614
|
+
* Net price of the order.
|
|
2615
|
+
*/
|
|
2222
2616
|
readonly amountNet?: number;
|
|
2223
|
-
/**
|
|
2617
|
+
/**
|
|
2618
|
+
* Format: float
|
|
2619
|
+
* Gross price of the order.
|
|
2620
|
+
*/
|
|
2224
2621
|
readonly amountTotal?: number;
|
|
2225
2622
|
/** Billing address for the order */
|
|
2226
2623
|
billingAddress?: components["schemas"]["OrderAddress"];
|
|
2624
|
+
/** Unique identity of the billing address. */
|
|
2227
2625
|
billingAddressId: string;
|
|
2228
2626
|
billingAddressVersionId?: string;
|
|
2627
|
+
/** A campaign code is the globally unique identifier for a campaign. */
|
|
2229
2628
|
campaignCode?: string;
|
|
2230
2629
|
/** Format: date-time */
|
|
2231
2630
|
readonly createdAt?: string;
|
|
2631
|
+
/** Unique identity of createdBy. */
|
|
2232
2632
|
createdById?: string;
|
|
2233
2633
|
/** Currency used for the order */
|
|
2234
2634
|
currency?: components["schemas"]["Currency"];
|
|
2235
|
-
/**
|
|
2635
|
+
/**
|
|
2636
|
+
* Format: float
|
|
2637
|
+
* Rate at which currency is exchanged.
|
|
2638
|
+
*/
|
|
2236
2639
|
currencyFactor: number;
|
|
2640
|
+
/** Unique identity of the currency. */
|
|
2237
2641
|
currencyId: string;
|
|
2642
|
+
/** Comments given by comments. */
|
|
2238
2643
|
customerComment?: string;
|
|
2239
2644
|
customFields?: GenericRecord;
|
|
2645
|
+
/** It is a generated special code linked to email. It is used to access orders placed by guest customers. */
|
|
2240
2646
|
deepLinkCode?: string;
|
|
2241
2647
|
/** Delivery information including shipping address and tracking */
|
|
2242
2648
|
deliveries?: components["schemas"]["OrderDelivery"][];
|
|
@@ -2245,16 +2651,25 @@ export type Schemas = {
|
|
|
2245
2651
|
id: string;
|
|
2246
2652
|
/** Language used when placing the order */
|
|
2247
2653
|
language?: components["schemas"]["Language"];
|
|
2654
|
+
/** Unique identity of the language. */
|
|
2248
2655
|
languageId: string;
|
|
2249
2656
|
/** Order line items (products, discounts, fees) */
|
|
2250
2657
|
lineItems?: components["schemas"]["OrderLineItem"][];
|
|
2251
2658
|
/** Customer information associated with the order */
|
|
2252
2659
|
orderCustomer?: components["schemas"]["OrderCustomer"];
|
|
2660
|
+
/** Date when the order was placed. */
|
|
2253
2661
|
readonly orderDate: string;
|
|
2254
|
-
/**
|
|
2662
|
+
/**
|
|
2663
|
+
* Format: date-time
|
|
2664
|
+
* Timestamp when the order was placed.
|
|
2665
|
+
*/
|
|
2255
2666
|
orderDateTime: string;
|
|
2667
|
+
/** Unique number associated with every order. */
|
|
2256
2668
|
orderNumber?: string;
|
|
2257
|
-
/**
|
|
2669
|
+
/**
|
|
2670
|
+
* Format: float
|
|
2671
|
+
* Price of each line item in the cart multiplied by its quantity excluding charges like shipping cost, rules, taxes etc.
|
|
2672
|
+
*/
|
|
2258
2673
|
readonly positionPrice?: number;
|
|
2259
2674
|
price: components["schemas"]["CalculatedPrice"];
|
|
2260
2675
|
/** Primary delivery information for the order */
|
|
@@ -2265,6 +2680,7 @@ export type Schemas = {
|
|
|
2265
2680
|
primaryOrderTransaction?: components["schemas"]["OrderTransaction"];
|
|
2266
2681
|
primaryOrderTransactionId?: string;
|
|
2267
2682
|
primaryOrderTransactionVersionId?: string;
|
|
2683
|
+
/** Unique identity of the sales channel. */
|
|
2268
2684
|
salesChannelId: string;
|
|
2269
2685
|
shippingCosts?: {
|
|
2270
2686
|
calculatedTaxes?: GenericRecord;
|
|
@@ -2289,62 +2705,89 @@ export type Schemas = {
|
|
|
2289
2705
|
/** Format: float */
|
|
2290
2706
|
unitPrice: number;
|
|
2291
2707
|
};
|
|
2292
|
-
/**
|
|
2708
|
+
/**
|
|
2709
|
+
* Format: float
|
|
2710
|
+
* Total shipping cost of the ordered product.
|
|
2711
|
+
*/
|
|
2293
2712
|
readonly shippingTotal?: number;
|
|
2713
|
+
/** Source of orders either via normal order placement or subscriptions. */
|
|
2294
2714
|
source?: string;
|
|
2295
2715
|
/** Current order state (e.g., open, in_progress, completed, cancelled) */
|
|
2296
2716
|
stateMachineState: components["schemas"]["StateMachineState"];
|
|
2297
2717
|
/** Tags assigned to the order for organization and filtering */
|
|
2298
2718
|
tags?: components["schemas"]["Tag"][];
|
|
2299
2719
|
taxCalculationType?: string;
|
|
2720
|
+
/** TaxStatus takes `Free`, `Net` or `Gross` as values. */
|
|
2300
2721
|
readonly taxStatus?: string;
|
|
2301
2722
|
/** Payment transactions for the order */
|
|
2302
2723
|
transactions?: components["schemas"]["OrderTransaction"][];
|
|
2303
2724
|
/** Format: date-time */
|
|
2304
2725
|
readonly updatedAt?: string;
|
|
2726
|
+
/** Unique identity of updatedBy. */
|
|
2305
2727
|
updatedById?: string;
|
|
2306
2728
|
versionId?: string;
|
|
2307
2729
|
};
|
|
2308
2730
|
OrderAddress: {
|
|
2731
|
+
/** Additional address input if necessary. */
|
|
2309
2732
|
additionalAddressLine1?: string;
|
|
2733
|
+
/** Additional address input if necessary. */
|
|
2310
2734
|
additionalAddressLine2?: string;
|
|
2735
|
+
/** Name of the city. */
|
|
2311
2736
|
city: string;
|
|
2737
|
+
/** Name of the company. */
|
|
2312
2738
|
company?: string;
|
|
2313
2739
|
country?: components["schemas"]["Country"];
|
|
2740
|
+
/** Unique identity of country. */
|
|
2314
2741
|
countryId: string;
|
|
2315
2742
|
countryState?: components["schemas"]["CountryState"];
|
|
2743
|
+
/** Unique identity of state. */
|
|
2316
2744
|
countryStateId?: string;
|
|
2317
2745
|
/** Format: date-time */
|
|
2318
2746
|
readonly createdAt?: string;
|
|
2319
2747
|
customFields?: GenericRecord;
|
|
2748
|
+
/** Name of the department. */
|
|
2320
2749
|
department?: string;
|
|
2750
|
+
/** First name of the customer. */
|
|
2321
2751
|
firstName: string;
|
|
2322
2752
|
/** Runtime field, cannot be used as part of the criteria. */
|
|
2323
2753
|
hash?: string;
|
|
2324
2754
|
id: string;
|
|
2755
|
+
/** Last name of the customer. */
|
|
2325
2756
|
lastName: string;
|
|
2757
|
+
/** Phone number of the customer. */
|
|
2326
2758
|
phoneNumber?: string;
|
|
2327
2759
|
salutation?: components["schemas"]["Salutation"];
|
|
2760
|
+
/** Street address */
|
|
2328
2761
|
street: string;
|
|
2762
|
+
/** Title name given to customer like DR. , Prof., etc. */
|
|
2329
2763
|
title?: string;
|
|
2330
2764
|
/** Format: date-time */
|
|
2331
2765
|
readonly updatedAt?: string;
|
|
2766
|
+
/** Unique identity of VAT. */
|
|
2332
2767
|
vatId?: string;
|
|
2333
2768
|
versionId?: string;
|
|
2769
|
+
/** Zip code of the country. */
|
|
2334
2770
|
zipcode?: string;
|
|
2335
2771
|
};
|
|
2336
2772
|
OrderCustomer: {
|
|
2773
|
+
/** Name of the company. */
|
|
2337
2774
|
company?: string;
|
|
2338
2775
|
/** Format: date-time */
|
|
2339
2776
|
readonly createdAt?: string;
|
|
2777
|
+
/** Unique number assigned to the customer. */
|
|
2340
2778
|
customerNumber?: string;
|
|
2341
2779
|
customFields?: GenericRecord;
|
|
2780
|
+
/** Email address of the customer. */
|
|
2342
2781
|
email: string;
|
|
2782
|
+
/** First name of the customer. */
|
|
2343
2783
|
firstName: string;
|
|
2344
2784
|
id: string;
|
|
2785
|
+
/** Last name of the customer. */
|
|
2345
2786
|
lastName: string;
|
|
2346
2787
|
salutation?: components["schemas"]["Salutation"];
|
|
2788
|
+
/** Unique identity of salutation. */
|
|
2347
2789
|
salutationId?: string;
|
|
2790
|
+
/** Title name given to the customer like Dr, prof. etc. */
|
|
2348
2791
|
title?: string;
|
|
2349
2792
|
/** Format: date-time */
|
|
2350
2793
|
readonly updatedAt?: string;
|
|
@@ -2356,6 +2799,7 @@ export type Schemas = {
|
|
|
2356
2799
|
readonly createdAt?: string;
|
|
2357
2800
|
customFields?: GenericRecord;
|
|
2358
2801
|
id: string;
|
|
2802
|
+
/** Unique identity of order. */
|
|
2359
2803
|
orderId: string;
|
|
2360
2804
|
orderVersionId?: string;
|
|
2361
2805
|
/** Line items included in this delivery */
|
|
@@ -2383,17 +2827,26 @@ export type Schemas = {
|
|
|
2383
2827
|
/** Format: float */
|
|
2384
2828
|
unitPrice: number;
|
|
2385
2829
|
};
|
|
2386
|
-
/**
|
|
2830
|
+
/**
|
|
2831
|
+
* Format: date-time
|
|
2832
|
+
* Date and time of earliest delivery of products.
|
|
2833
|
+
*/
|
|
2387
2834
|
shippingDateEarliest: string;
|
|
2388
|
-
/**
|
|
2835
|
+
/**
|
|
2836
|
+
* Format: date-time
|
|
2837
|
+
* Date and time of latest delivery of products.
|
|
2838
|
+
*/
|
|
2389
2839
|
shippingDateLatest: string;
|
|
2390
2840
|
/** Shipping method used for this delivery */
|
|
2391
2841
|
shippingMethod?: components["schemas"]["ShippingMethod"];
|
|
2842
|
+
/** Unique identity of shipping method. */
|
|
2392
2843
|
shippingMethodId: string;
|
|
2393
2844
|
/** Shipping address for this delivery */
|
|
2394
2845
|
shippingOrderAddress?: components["schemas"]["OrderAddress"];
|
|
2846
|
+
/** Unique identity of order's shipping address. */
|
|
2395
2847
|
shippingOrderAddressId: string;
|
|
2396
2848
|
shippingOrderAddressVersionId?: string;
|
|
2849
|
+
/** Unique identity of state. */
|
|
2397
2850
|
stateId: string;
|
|
2398
2851
|
/** Current delivery state (e.g., open, shipped, delivered, cancelled) */
|
|
2399
2852
|
stateMachineState?: components["schemas"]["StateMachineState"];
|
|
@@ -2407,8 +2860,10 @@ export type Schemas = {
|
|
|
2407
2860
|
readonly createdAt?: string;
|
|
2408
2861
|
customFields?: GenericRecord;
|
|
2409
2862
|
id: string;
|
|
2863
|
+
/** Unique identity of order delivery. */
|
|
2410
2864
|
orderDeliveryId: string;
|
|
2411
2865
|
orderDeliveryVersionId?: string;
|
|
2866
|
+
/** Unique identity of line items in an order. */
|
|
2412
2867
|
orderLineItemId: string;
|
|
2413
2868
|
orderLineItemVersionId?: string;
|
|
2414
2869
|
price?: {
|
|
@@ -2434,11 +2889,20 @@ export type Schemas = {
|
|
|
2434
2889
|
/** Format: float */
|
|
2435
2890
|
unitPrice: number;
|
|
2436
2891
|
};
|
|
2437
|
-
/**
|
|
2892
|
+
/**
|
|
2893
|
+
* Format: int64
|
|
2894
|
+
* Number of items of each product.
|
|
2895
|
+
*/
|
|
2438
2896
|
quantity?: number;
|
|
2439
|
-
/**
|
|
2897
|
+
/**
|
|
2898
|
+
* Format: float
|
|
2899
|
+
* Cost of product based on quantity.
|
|
2900
|
+
*/
|
|
2440
2901
|
totalPrice?: number;
|
|
2441
|
-
/**
|
|
2902
|
+
/**
|
|
2903
|
+
* Format: float
|
|
2904
|
+
* Price of product per item (where, quantity=1).
|
|
2905
|
+
*/
|
|
2442
2906
|
unitPrice?: number;
|
|
2443
2907
|
/** Format: date-time */
|
|
2444
2908
|
readonly updatedAt?: string;
|
|
@@ -2450,20 +2914,26 @@ export type Schemas = {
|
|
|
2450
2914
|
children: components["schemas"]["OrderLineItem"][];
|
|
2451
2915
|
/** Line item image or thumbnail */
|
|
2452
2916
|
cover?: components["schemas"]["Media"];
|
|
2917
|
+
/** Unique identity of cover image. */
|
|
2453
2918
|
coverId?: string;
|
|
2454
2919
|
/** Format: date-time */
|
|
2455
2920
|
readonly createdAt?: string;
|
|
2456
2921
|
customFields?: GenericRecord;
|
|
2922
|
+
/** Description of line items in an order. */
|
|
2457
2923
|
description?: string;
|
|
2458
2924
|
/** Digital downloads associated with this line item */
|
|
2459
2925
|
downloads?: components["schemas"]["OrderLineItemDownload"][];
|
|
2460
2926
|
extensions?: GenericRecord;
|
|
2927
|
+
/** When set to true, it indicates the line item is physical else it is virtual. */
|
|
2461
2928
|
good?: boolean;
|
|
2462
2929
|
id: string;
|
|
2930
|
+
/** It is a unique identity of an item in cart before its converted to an order. */
|
|
2463
2931
|
identifier: string;
|
|
2932
|
+
/** It is a typical product name given to the line item. */
|
|
2464
2933
|
label: string;
|
|
2465
2934
|
/** Delivery positions for this line item */
|
|
2466
2935
|
orderDeliveryPositions?: components["schemas"]["OrderDeliveryPosition"][];
|
|
2936
|
+
/** Unique identity of order. */
|
|
2467
2937
|
orderId: string;
|
|
2468
2938
|
orderVersionId?: string;
|
|
2469
2939
|
parent?: components["schemas"]["OrderLineItem"];
|
|
@@ -2483,6 +2953,7 @@ export type Schemas = {
|
|
|
2483
2953
|
options?: components["schemas"]["PropertyGroupOption"][];
|
|
2484
2954
|
parentId?: string;
|
|
2485
2955
|
productNumber?: string;
|
|
2956
|
+
productType?: components["schemas"]["Product"]["type"];
|
|
2486
2957
|
readonly propertyIds?: string[];
|
|
2487
2958
|
purchasePrices?: string;
|
|
2488
2959
|
/** Format: date-time */
|
|
@@ -2493,21 +2964,36 @@ export type Schemas = {
|
|
|
2493
2964
|
readonly tagIds?: string[];
|
|
2494
2965
|
taxId?: string;
|
|
2495
2966
|
};
|
|
2496
|
-
/**
|
|
2967
|
+
/**
|
|
2968
|
+
* Format: int64
|
|
2969
|
+
* Position of line items placed in an order.
|
|
2970
|
+
*/
|
|
2497
2971
|
position?: number;
|
|
2498
2972
|
priceDefinition?: components["schemas"]["CartPriceQuantity"];
|
|
2499
2973
|
/** Referenced product if this is a product line item */
|
|
2500
2974
|
product?: components["schemas"]["Product"];
|
|
2975
|
+
/** Unique identity of product. */
|
|
2501
2976
|
productId?: string;
|
|
2502
2977
|
productVersionId?: string;
|
|
2978
|
+
/** Unique identity of product. */
|
|
2503
2979
|
promotionId?: string;
|
|
2504
|
-
/**
|
|
2980
|
+
/**
|
|
2981
|
+
* Format: int64
|
|
2982
|
+
* Number of items of product.
|
|
2983
|
+
*/
|
|
2505
2984
|
quantity: number;
|
|
2985
|
+
/** Unique identity of type of entity. */
|
|
2506
2986
|
referencedId?: string;
|
|
2987
|
+
/** Allows the line item to be removable from the cart when set to true. */
|
|
2507
2988
|
removable?: boolean;
|
|
2989
|
+
/** Allows to change the quantity of the line item when set to true. */
|
|
2508
2990
|
stackable?: boolean;
|
|
2991
|
+
/** @deprecated */
|
|
2509
2992
|
states: string[];
|
|
2510
|
-
/**
|
|
2993
|
+
/**
|
|
2994
|
+
* Format: float
|
|
2995
|
+
* Cost of product based on quantity.
|
|
2996
|
+
*/
|
|
2511
2997
|
totalPrice?: number;
|
|
2512
2998
|
translated: {
|
|
2513
2999
|
coverId: string;
|
|
@@ -2525,27 +3011,37 @@ export type Schemas = {
|
|
|
2525
3011
|
type: string;
|
|
2526
3012
|
versionId: string;
|
|
2527
3013
|
};
|
|
3014
|
+
/** Type refers to the entity type of an item whether it is product or promotion for instance. */
|
|
2528
3015
|
type?: string;
|
|
2529
|
-
/**
|
|
3016
|
+
/**
|
|
3017
|
+
* Format: float
|
|
3018
|
+
* Price of product per item (where, quantity=1).
|
|
3019
|
+
*/
|
|
2530
3020
|
unitPrice?: number;
|
|
2531
3021
|
/** Format: date-time */
|
|
2532
3022
|
readonly updatedAt?: string;
|
|
2533
3023
|
versionId?: string;
|
|
2534
3024
|
};
|
|
2535
3025
|
OrderLineItemDownload: {
|
|
3026
|
+
/** When boolean value is `true`, the digital product is allowed to download. */
|
|
2536
3027
|
accessGranted: boolean;
|
|
2537
3028
|
/** Format: date-time */
|
|
2538
3029
|
readonly createdAt?: string;
|
|
2539
3030
|
customFields?: GenericRecord;
|
|
2540
3031
|
id: string;
|
|
2541
3032
|
media: components["schemas"]["Media"];
|
|
3033
|
+
/** Unique identity of media. */
|
|
2542
3034
|
mediaId: string;
|
|
2543
3035
|
orderLineItem?: components["schemas"]["OrderLineItem"];
|
|
3036
|
+
/** Unique identity of Order line item. */
|
|
2544
3037
|
orderLineItemId: string;
|
|
2545
3038
|
orderLineItemVersionId?: string;
|
|
2546
|
-
/**
|
|
2547
|
-
|
|
2548
|
-
|
|
3039
|
+
/**
|
|
3040
|
+
* Format: int64
|
|
3041
|
+
* The order of downloaded digital products displayed in the storefront by mentioning numerical values like 1,2,3, etc.
|
|
3042
|
+
*/
|
|
3043
|
+
position: number;
|
|
3044
|
+
/** Format: date-time */
|
|
2549
3045
|
readonly updatedAt?: string;
|
|
2550
3046
|
versionId?: string;
|
|
2551
3047
|
};
|
|
@@ -2596,11 +3092,14 @@ export type Schemas = {
|
|
|
2596
3092
|
readonly createdAt?: string;
|
|
2597
3093
|
customFields?: GenericRecord;
|
|
2598
3094
|
id: string;
|
|
3095
|
+
/** Unique identity of an order. */
|
|
2599
3096
|
orderId: string;
|
|
2600
3097
|
orderVersionId?: string;
|
|
2601
3098
|
/** Payment method used for this transaction */
|
|
2602
3099
|
paymentMethod?: components["schemas"]["PaymentMethod"];
|
|
3100
|
+
/** Unique identity of payment method. */
|
|
2603
3101
|
paymentMethodId: string;
|
|
3102
|
+
/** Unique identity of state. */
|
|
2604
3103
|
stateId: string;
|
|
2605
3104
|
/** Current payment transaction state (e.g., open, paid, cancelled) */
|
|
2606
3105
|
stateMachineState?: components["schemas"]["StateMachineState"];
|
|
@@ -2636,11 +3135,14 @@ export type Schemas = {
|
|
|
2636
3135
|
/** Format: date-time */
|
|
2637
3136
|
readonly createdAt?: string;
|
|
2638
3137
|
customFields?: GenericRecord;
|
|
3138
|
+
/** External payment provider token. */
|
|
2639
3139
|
externalReference?: string;
|
|
2640
3140
|
id: string;
|
|
3141
|
+
/** Unique identity of order transaction. */
|
|
2641
3142
|
orderTransactionId: string;
|
|
2642
3143
|
orderTransactionVersionId?: string;
|
|
2643
3144
|
refunds?: components["schemas"]["OrderTransactionCaptureRefund"][];
|
|
3145
|
+
/** Unique identity of order state. */
|
|
2644
3146
|
stateId: string;
|
|
2645
3147
|
stateMachineState?: components["schemas"]["StateMachineState"];
|
|
2646
3148
|
transaction?: components["schemas"]["OrderTransaction"];
|
|
@@ -2672,15 +3174,19 @@ export type Schemas = {
|
|
|
2672
3174
|
/** Format: float */
|
|
2673
3175
|
unitPrice: number;
|
|
2674
3176
|
};
|
|
3177
|
+
/** Unique identity of order transaction capture. */
|
|
2675
3178
|
captureId: string;
|
|
2676
3179
|
captureVersionId?: string;
|
|
2677
3180
|
/** Format: date-time */
|
|
2678
3181
|
readonly createdAt?: string;
|
|
2679
3182
|
customFields?: GenericRecord;
|
|
3183
|
+
/** External payment provider token. */
|
|
2680
3184
|
externalReference?: string;
|
|
2681
3185
|
id: string;
|
|
2682
3186
|
positions?: components["schemas"]["OrderTransactionCaptureRefundPosition"][];
|
|
3187
|
+
/** Reason for refunding the amount for an order. */
|
|
2683
3188
|
reason?: string;
|
|
3189
|
+
/** Unique identity of order state. */
|
|
2684
3190
|
stateId: string;
|
|
2685
3191
|
stateMachineState?: components["schemas"]["StateMachineState"];
|
|
2686
3192
|
transactionCapture?: components["schemas"]["OrderTransactionCapture"];
|
|
@@ -2715,15 +3221,22 @@ export type Schemas = {
|
|
|
2715
3221
|
/** Format: date-time */
|
|
2716
3222
|
readonly createdAt?: string;
|
|
2717
3223
|
customFields?: GenericRecord;
|
|
3224
|
+
/** External payment provider token. */
|
|
2718
3225
|
externalReference?: string;
|
|
2719
3226
|
id: string;
|
|
2720
3227
|
orderLineItem?: components["schemas"]["OrderLineItem"];
|
|
3228
|
+
/** Unique identity of order line item. */
|
|
2721
3229
|
orderLineItemId: string;
|
|
2722
3230
|
orderLineItemVersionId?: string;
|
|
2723
3231
|
orderTransactionCaptureRefund?: components["schemas"]["OrderTransactionCaptureRefund"];
|
|
2724
|
-
/**
|
|
3232
|
+
/**
|
|
3233
|
+
* Format: int64
|
|
3234
|
+
* Quantity of line item to be refunded.
|
|
3235
|
+
*/
|
|
2725
3236
|
quantity?: number;
|
|
3237
|
+
/** Reason for refunding the amount for an order. */
|
|
2726
3238
|
reason?: string;
|
|
3239
|
+
/** Unique identity of order transaction capture refund. */
|
|
2727
3240
|
refundId: string;
|
|
2728
3241
|
refundVersionId?: string;
|
|
2729
3242
|
/** Format: date-time */
|
|
@@ -2731,7 +3244,9 @@ export type Schemas = {
|
|
|
2731
3244
|
versionId?: string;
|
|
2732
3245
|
};
|
|
2733
3246
|
PaymentMethod: {
|
|
3247
|
+
/** When boolean value is `true`, the payment methods are available for selection in the storefront. */
|
|
2734
3248
|
active?: boolean;
|
|
3249
|
+
/** When set to true, customers are redirected to the payment options page to choose a new payment method on order failure. */
|
|
2735
3250
|
afterOrderEnabled?: boolean;
|
|
2736
3251
|
/** Format: date-time */
|
|
2737
3252
|
readonly createdAt?: string;
|
|
@@ -2741,9 +3256,13 @@ export type Schemas = {
|
|
|
2741
3256
|
id: string;
|
|
2742
3257
|
/** Payment method logo or icon image */
|
|
2743
3258
|
media?: components["schemas"]["Media"];
|
|
3259
|
+
/** Unique identity of media. */
|
|
2744
3260
|
mediaId?: string;
|
|
2745
3261
|
name: string;
|
|
2746
|
-
/**
|
|
3262
|
+
/**
|
|
3263
|
+
* Format: int64
|
|
3264
|
+
* The order of the tabs of your defined payment methods in the storefront by entering numerical values like 1,2,3, etc.
|
|
3265
|
+
*/
|
|
2747
3266
|
position?: number;
|
|
2748
3267
|
/** Runtime field, cannot be used as part of the criteria. */
|
|
2749
3268
|
shortName?: string;
|
|
@@ -2760,7 +3279,9 @@ export type Schemas = {
|
|
|
2760
3279
|
readonly updatedAt?: string;
|
|
2761
3280
|
};
|
|
2762
3281
|
PaymentMethodJsonApi: components["schemas"]["resource"] & {
|
|
3282
|
+
/** When boolean value is `true`, the payment methods are available for selection in the storefront. */
|
|
2763
3283
|
active?: boolean;
|
|
3284
|
+
/** When set to true, customers are redirected to the payment options page to choose a new payment method on order failure. */
|
|
2764
3285
|
afterOrderEnabled?: boolean;
|
|
2765
3286
|
/** Format: date-time */
|
|
2766
3287
|
readonly createdAt?: string;
|
|
@@ -2768,9 +3289,13 @@ export type Schemas = {
|
|
|
2768
3289
|
description?: string;
|
|
2769
3290
|
readonly distinguishableName?: string;
|
|
2770
3291
|
id: string;
|
|
3292
|
+
/** Unique identity of media. */
|
|
2771
3293
|
mediaId?: string;
|
|
2772
3294
|
name: string;
|
|
2773
|
-
/**
|
|
3295
|
+
/**
|
|
3296
|
+
* Format: int64
|
|
3297
|
+
* The order of the tabs of your defined payment methods in the storefront by entering numerical values like 1,2,3, etc.
|
|
3298
|
+
*/
|
|
2774
3299
|
position?: number;
|
|
2775
3300
|
relationships?: {
|
|
2776
3301
|
/** Payment method logo or icon image */
|
|
@@ -2830,11 +3355,16 @@ export type Schemas = {
|
|
|
2830
3355
|
};
|
|
2831
3356
|
};
|
|
2832
3357
|
Product: {
|
|
3358
|
+
/** When boolean value is `true`, the products are available for selection in the storefront for purchase. */
|
|
2833
3359
|
active?: boolean;
|
|
2834
3360
|
/** @enum {string} */
|
|
2835
3361
|
apiAlias: "product";
|
|
3362
|
+
/** Indicates weather the product is available or not. */
|
|
2836
3363
|
readonly available?: boolean;
|
|
2837
|
-
/**
|
|
3364
|
+
/**
|
|
3365
|
+
* Format: int64
|
|
3366
|
+
* Indicates the number of products still available. This value results from the stock minus the open orders.
|
|
3367
|
+
*/
|
|
2838
3368
|
readonly availableStock?: number;
|
|
2839
3369
|
calculatedCheapestPrice?: {
|
|
2840
3370
|
/** @enum {string} */
|
|
@@ -2859,6 +3389,7 @@ export type Schemas = {
|
|
|
2859
3389
|
calculatedPrices: components["schemas"]["CalculatedPrice"][];
|
|
2860
3390
|
/** Canonical product reference for variant consolidation and SEO purposes */
|
|
2861
3391
|
canonicalProduct?: components["schemas"]["Product"];
|
|
3392
|
+
/** Unique identity of canonical product. */
|
|
2862
3393
|
canonicalProductId?: string;
|
|
2863
3394
|
canonicalProductVersionId?: string;
|
|
2864
3395
|
/** Categories this product is assigned to */
|
|
@@ -2873,12 +3404,14 @@ export type Schemas = {
|
|
|
2873
3404
|
children?: components["schemas"]["Product"][];
|
|
2874
3405
|
/** Custom CMS page layout for the product detail page */
|
|
2875
3406
|
cmsPage?: components["schemas"]["CmsPage"];
|
|
3407
|
+
/** Unique identity of CMS page. */
|
|
2876
3408
|
cmsPageId?: string;
|
|
2877
3409
|
cmsPageVersionId?: string;
|
|
2878
3410
|
/** Variant configurator settings defining available options for product variants */
|
|
2879
3411
|
configuratorSettings?: components["schemas"]["ProductConfiguratorSetting"][];
|
|
2880
3412
|
/** Main product image displayed in listings and detail pages */
|
|
2881
3413
|
cover?: components["schemas"]["ProductMedia"];
|
|
3414
|
+
/** Unique identity of a ProductMedia item used as product cover. */
|
|
2882
3415
|
coverId?: string;
|
|
2883
3416
|
/** Format: date-time */
|
|
2884
3417
|
readonly createdAt?: string;
|
|
@@ -2887,36 +3420,55 @@ export type Schemas = {
|
|
|
2887
3420
|
customFields?: GenericRecord;
|
|
2888
3421
|
/** Estimated delivery time for the product */
|
|
2889
3422
|
deliveryTime?: components["schemas"]["DeliveryTime"];
|
|
3423
|
+
/** Unique identity of delivery time. */
|
|
2890
3424
|
deliveryTimeId?: string;
|
|
2891
3425
|
description?: string;
|
|
3426
|
+
/** Runtime field, cannot be used as part of the criteria. */
|
|
2892
3427
|
readonly displayGroup?: string;
|
|
2893
3428
|
/** Downloadable files associated with the product (e.g., manuals, digital content) */
|
|
2894
3429
|
downloads?: components["schemas"]["ProductDownload"][];
|
|
3430
|
+
/** Indicates EAN of the product. */
|
|
2895
3431
|
ean?: string;
|
|
2896
|
-
/**
|
|
3432
|
+
/**
|
|
3433
|
+
* Format: float
|
|
3434
|
+
* The height of the product.
|
|
3435
|
+
*/
|
|
2897
3436
|
height?: number;
|
|
2898
3437
|
id: string;
|
|
3438
|
+
/** When the value is set to true, the product is hidden when sold out. */
|
|
2899
3439
|
isCloseout?: boolean;
|
|
2900
3440
|
/** Runtime field, cannot be used as part of the criteria. */
|
|
2901
3441
|
isNew?: boolean;
|
|
2902
3442
|
keywords?: string;
|
|
2903
|
-
/**
|
|
3443
|
+
/**
|
|
3444
|
+
* Format: float
|
|
3445
|
+
* The length of the product.
|
|
3446
|
+
*/
|
|
2904
3447
|
length?: number;
|
|
2905
3448
|
/** Primary category assignments per sales channel for SEO and navigation */
|
|
2906
3449
|
mainCategories?: components["schemas"]["MainCategory"][];
|
|
2907
3450
|
/** Product manufacturer or brand information */
|
|
2908
3451
|
manufacturer?: components["schemas"]["ProductManufacturer"];
|
|
3452
|
+
/** Unique identity of the manufacturer. */
|
|
2909
3453
|
manufacturerId?: string;
|
|
3454
|
+
/** Unique number that describes the manufacturer. */
|
|
2910
3455
|
manufacturerNumber?: string;
|
|
3456
|
+
/** Indicates weather the product is top seller or not. */
|
|
2911
3457
|
markAsTopseller?: boolean;
|
|
2912
|
-
/**
|
|
3458
|
+
/**
|
|
3459
|
+
* Format: int64
|
|
3460
|
+
* Maximum number of items that can be purchased.
|
|
3461
|
+
*/
|
|
2913
3462
|
maxPurchase?: number;
|
|
2914
3463
|
measurements?: components["schemas"]["ProductMeasurements"];
|
|
2915
3464
|
/** Product images and media gallery */
|
|
2916
3465
|
media?: components["schemas"]["ProductMedia"][];
|
|
2917
3466
|
metaDescription?: string;
|
|
2918
3467
|
metaTitle?: string;
|
|
2919
|
-
/**
|
|
3468
|
+
/**
|
|
3469
|
+
* Format: int64
|
|
3470
|
+
* Minimum number of items that can be purchased.
|
|
3471
|
+
*/
|
|
2920
3472
|
minPurchase?: number;
|
|
2921
3473
|
name: string;
|
|
2922
3474
|
readonly optionIds?: string[];
|
|
@@ -2924,39 +3476,67 @@ export type Schemas = {
|
|
|
2924
3476
|
options?: components["schemas"]["PropertyGroupOption"][];
|
|
2925
3477
|
packUnit?: string;
|
|
2926
3478
|
packUnitPlural?: string;
|
|
3479
|
+
/** Unique identity of the product. */
|
|
2927
3480
|
parent?: components["schemas"]["Product"];
|
|
2928
3481
|
parentId?: string;
|
|
2929
3482
|
parentVersionId?: string;
|
|
2930
3483
|
productManufacturerVersionId?: string;
|
|
2931
3484
|
productMediaVersionId?: string;
|
|
3485
|
+
/** Unique number assigned to individual products. Define rules for automatic assignment of every product creation as per your number range. */
|
|
2932
3486
|
productNumber: string;
|
|
2933
3487
|
/** Customer reviews and ratings for the product */
|
|
2934
3488
|
productReviews?: components["schemas"]["ProductReview"][];
|
|
2935
3489
|
/** Product properties and characteristics for filtering */
|
|
2936
3490
|
properties?: components["schemas"]["PropertyGroupOption"][];
|
|
2937
3491
|
readonly propertyIds?: string[];
|
|
2938
|
-
/**
|
|
3492
|
+
/**
|
|
3493
|
+
* Format: int64
|
|
3494
|
+
* Specifies the scales in which the item is to be offered. For example, a scale of 2 means that your customers can purchase 2, 4, 6 products, etc., but not 1, 3 or 5.
|
|
3495
|
+
*/
|
|
2939
3496
|
purchaseSteps?: number;
|
|
2940
|
-
/**
|
|
3497
|
+
/**
|
|
3498
|
+
* Format: float
|
|
3499
|
+
* Quantity of the item purchased. For example, 500ml, 2kg, etc.
|
|
3500
|
+
*/
|
|
2941
3501
|
purchaseUnit?: number;
|
|
2942
|
-
/**
|
|
3502
|
+
/**
|
|
3503
|
+
* Format: float
|
|
3504
|
+
* Average of all the ratings.
|
|
3505
|
+
*/
|
|
2943
3506
|
readonly ratingAverage?: number;
|
|
2944
|
-
/**
|
|
3507
|
+
/**
|
|
3508
|
+
* Format: float
|
|
3509
|
+
* Price of purchased item calculated as per the reference unit. Say, you bought 500ml of milk and the price is calculated in reference to 1000ml.
|
|
3510
|
+
*/
|
|
2945
3511
|
referenceUnit?: number;
|
|
2946
|
-
/**
|
|
3512
|
+
/**
|
|
3513
|
+
* Format: date-time
|
|
3514
|
+
* The release date of a product or product model. This can be used to distinguish the exact variant of a product.
|
|
3515
|
+
*/
|
|
2947
3516
|
releaseDate?: string;
|
|
2948
|
-
/**
|
|
3517
|
+
/**
|
|
3518
|
+
* Format: int64
|
|
3519
|
+
* The restock time in days indicates how long it will take until a sold out item is back in stock.
|
|
3520
|
+
*/
|
|
2949
3521
|
restockTime?: number;
|
|
2950
|
-
/**
|
|
3522
|
+
/**
|
|
3523
|
+
* Format: int64
|
|
3524
|
+
* Frequency of the product sales.
|
|
3525
|
+
*/
|
|
2951
3526
|
readonly sales?: number;
|
|
2952
3527
|
/** Main category used for SEO URL generation in the current sales channel */
|
|
2953
3528
|
seoCategory: components["schemas"]["Category"];
|
|
2954
3529
|
/** SEO-friendly URLs for the product across different sales channels */
|
|
2955
3530
|
seoUrls?: components["schemas"]["SeoUrl"][];
|
|
3531
|
+
/** Indicates weather the shipping price is free or not. */
|
|
2956
3532
|
shippingFree?: boolean;
|
|
2957
3533
|
sortedProperties?: GenericRecord;
|
|
3534
|
+
/** @deprecated */
|
|
2958
3535
|
readonly states?: string[];
|
|
2959
|
-
/**
|
|
3536
|
+
/**
|
|
3537
|
+
* Format: int64
|
|
3538
|
+
* Indicates the number of products available.
|
|
3539
|
+
*/
|
|
2960
3540
|
stock: number;
|
|
2961
3541
|
readonly streamIds?: string[];
|
|
2962
3542
|
/** Dynamic product streams this product belongs to based on defined filters */
|
|
@@ -2966,6 +3546,7 @@ export type Schemas = {
|
|
|
2966
3546
|
tags?: components["schemas"]["Tag"][];
|
|
2967
3547
|
/** Tax configuration (rate and calculation rules) */
|
|
2968
3548
|
tax?: components["schemas"]["Tax"];
|
|
3549
|
+
/** Unique identity of tax. */
|
|
2969
3550
|
taxId: string;
|
|
2970
3551
|
translated: {
|
|
2971
3552
|
canonicalProductId: string;
|
|
@@ -2992,11 +3573,18 @@ export type Schemas = {
|
|
|
2992
3573
|
productNumber: string;
|
|
2993
3574
|
releaseDate: string;
|
|
2994
3575
|
taxId: string;
|
|
3576
|
+
type: string;
|
|
2995
3577
|
unitId: string;
|
|
2996
3578
|
versionId: string;
|
|
2997
3579
|
};
|
|
3580
|
+
/**
|
|
3581
|
+
* The type of the product, e.g., physical or digital.
|
|
3582
|
+
* @enum {string}
|
|
3583
|
+
*/
|
|
3584
|
+
type: "physical" | "digital";
|
|
2998
3585
|
/** Product unit of measure (e.g., piece, liter, kg) */
|
|
2999
3586
|
unit?: components["schemas"]["Unit"];
|
|
3587
|
+
/** Unique identity of the unit. */
|
|
3000
3588
|
unitId?: string;
|
|
3001
3589
|
/** Format: date-time */
|
|
3002
3590
|
readonly updatedAt?: string;
|
|
@@ -3004,9 +3592,15 @@ export type Schemas = {
|
|
|
3004
3592
|
displayParent?: boolean;
|
|
3005
3593
|
} | null;
|
|
3006
3594
|
versionId?: string;
|
|
3007
|
-
/**
|
|
3595
|
+
/**
|
|
3596
|
+
* Format: float
|
|
3597
|
+
* The weight of the product.
|
|
3598
|
+
*/
|
|
3008
3599
|
weight?: number;
|
|
3009
|
-
/**
|
|
3600
|
+
/**
|
|
3601
|
+
* Format: float
|
|
3602
|
+
* The width of the product.
|
|
3603
|
+
*/
|
|
3010
3604
|
width?: number;
|
|
3011
3605
|
};
|
|
3012
3606
|
ProductConfiguratorSetting: {
|
|
@@ -3015,11 +3609,17 @@ export type Schemas = {
|
|
|
3015
3609
|
customFields?: GenericRecord;
|
|
3016
3610
|
id: string;
|
|
3017
3611
|
media?: components["schemas"]["Media"];
|
|
3612
|
+
/** Unique identity of media. */
|
|
3018
3613
|
mediaId?: string;
|
|
3019
3614
|
option?: components["schemas"]["PropertyGroupOption"];
|
|
3615
|
+
/** Unique identity of option. */
|
|
3020
3616
|
optionId: string;
|
|
3021
|
-
/**
|
|
3617
|
+
/**
|
|
3618
|
+
* Format: int64
|
|
3619
|
+
* The order of the tabs of your defined product configuration settings in the storefront by entering numerical values like 1,2,3, etc.
|
|
3620
|
+
*/
|
|
3022
3621
|
position?: number;
|
|
3622
|
+
/** Unique identity of product. */
|
|
3023
3623
|
productId: string;
|
|
3024
3624
|
productVersionId?: string;
|
|
3025
3625
|
/** Format: date-time */
|
|
@@ -3027,16 +3627,25 @@ export type Schemas = {
|
|
|
3027
3627
|
versionId?: string;
|
|
3028
3628
|
};
|
|
3029
3629
|
ProductCrossSelling: {
|
|
3630
|
+
/** When set to active, the cross-selling feature is enabled. */
|
|
3030
3631
|
active?: boolean;
|
|
3031
3632
|
/** Format: date-time */
|
|
3032
3633
|
readonly createdAt?: string;
|
|
3033
3634
|
id: string;
|
|
3034
|
-
/**
|
|
3635
|
+
/**
|
|
3636
|
+
* Format: int64
|
|
3637
|
+
* The maximum number of products to be displayed in cross-selling on the item detail page of your item.
|
|
3638
|
+
*/
|
|
3035
3639
|
limit?: number;
|
|
3036
3640
|
name: string;
|
|
3037
|
-
/**
|
|
3641
|
+
/**
|
|
3642
|
+
* Format: int64
|
|
3643
|
+
* The order of the tabs of your defined cross-selling actions in the storefront by entering numerical values like 1,2,3, etc.
|
|
3644
|
+
*/
|
|
3038
3645
|
position?: number;
|
|
3646
|
+
/** To sort the display of products by name, price or publication (descending, ascending) date. */
|
|
3039
3647
|
sortBy?: string;
|
|
3648
|
+
/** To sort the display of products by ascending or descending order. */
|
|
3040
3649
|
sortDirection?: string;
|
|
3041
3650
|
translated: {
|
|
3042
3651
|
name: string;
|
|
@@ -3044,6 +3653,7 @@ export type Schemas = {
|
|
|
3044
3653
|
sortDirection: string;
|
|
3045
3654
|
type: string;
|
|
3046
3655
|
};
|
|
3656
|
+
/** Type of product assignment for cross-selling. It can either be Dynamic product group or Manual assignment. */
|
|
3047
3657
|
type?: string;
|
|
3048
3658
|
/** Format: date-time */
|
|
3049
3659
|
readonly updatedAt?: string;
|
|
@@ -3066,10 +3676,15 @@ export type Schemas = {
|
|
|
3066
3676
|
customFields?: GenericRecord;
|
|
3067
3677
|
id: string;
|
|
3068
3678
|
media?: components["schemas"]["Media"];
|
|
3679
|
+
/** Unique identity of media. */
|
|
3069
3680
|
mediaId: string;
|
|
3070
|
-
/**
|
|
3681
|
+
/**
|
|
3682
|
+
* Format: int64
|
|
3683
|
+
* The order in which the digital products are downloaded, like 1,2,3, etc.to adjust their order of display.
|
|
3684
|
+
*/
|
|
3071
3685
|
position?: number;
|
|
3072
3686
|
product?: components["schemas"]["Product"];
|
|
3687
|
+
/** Unique identity of Product. */
|
|
3073
3688
|
productId: string;
|
|
3074
3689
|
productVersionId?: string;
|
|
3075
3690
|
/** Format: date-time */
|
|
@@ -3091,9 +3706,14 @@ export type Schemas = {
|
|
|
3091
3706
|
readonly updatedAt?: string;
|
|
3092
3707
|
};
|
|
3093
3708
|
ProductJsonApi: components["schemas"]["resource"] & {
|
|
3709
|
+
/** When boolean value is `true`, the products are available for selection in the storefront for purchase. */
|
|
3094
3710
|
active?: boolean;
|
|
3711
|
+
/** Indicates weather the product is available or not. */
|
|
3095
3712
|
readonly available?: boolean;
|
|
3096
|
-
/**
|
|
3713
|
+
/**
|
|
3714
|
+
* Format: int64
|
|
3715
|
+
* Indicates the number of products still available. This value results from the stock minus the open orders.
|
|
3716
|
+
*/
|
|
3097
3717
|
readonly availableStock?: number;
|
|
3098
3718
|
calculatedCheapestPrice?: GenericRecord;
|
|
3099
3719
|
/**
|
|
@@ -3103,40 +3723,62 @@ export type Schemas = {
|
|
|
3103
3723
|
calculatedMaxPurchase?: number;
|
|
3104
3724
|
calculatedPrice?: GenericRecord;
|
|
3105
3725
|
calculatedPrices?: GenericRecord[];
|
|
3726
|
+
/** Unique identity of canonical product. */
|
|
3106
3727
|
canonicalProductId?: string;
|
|
3107
3728
|
canonicalProductVersionId?: string;
|
|
3108
3729
|
readonly categoryIds?: string[];
|
|
3109
3730
|
readonly categoryTree?: string[];
|
|
3110
3731
|
/** Format: int64 */
|
|
3111
3732
|
readonly childCount?: number;
|
|
3733
|
+
/** Unique identity of CMS page. */
|
|
3112
3734
|
cmsPageId?: string;
|
|
3113
3735
|
cmsPageVersionId?: string;
|
|
3736
|
+
/** Unique identity of a ProductMedia item used as product cover. */
|
|
3114
3737
|
coverId?: string;
|
|
3115
3738
|
/** Format: date-time */
|
|
3116
3739
|
readonly createdAt?: string;
|
|
3117
3740
|
customFields?: GenericRecord;
|
|
3741
|
+
/** Unique identity of delivery time. */
|
|
3118
3742
|
deliveryTimeId?: string;
|
|
3119
3743
|
description?: string;
|
|
3744
|
+
/** Runtime field, cannot be used as part of the criteria. */
|
|
3120
3745
|
readonly displayGroup?: string;
|
|
3746
|
+
/** Indicates EAN of the product. */
|
|
3121
3747
|
ean?: string;
|
|
3122
|
-
/**
|
|
3748
|
+
/**
|
|
3749
|
+
* Format: float
|
|
3750
|
+
* The height of the product.
|
|
3751
|
+
*/
|
|
3123
3752
|
height?: number;
|
|
3124
3753
|
id: string;
|
|
3754
|
+
/** When the value is set to true, the product is hidden when sold out. */
|
|
3125
3755
|
isCloseout?: boolean;
|
|
3126
3756
|
/** Runtime field, cannot be used as part of the criteria. */
|
|
3127
3757
|
isNew?: boolean;
|
|
3128
3758
|
keywords?: string;
|
|
3129
|
-
/**
|
|
3759
|
+
/**
|
|
3760
|
+
* Format: float
|
|
3761
|
+
* The length of the product.
|
|
3762
|
+
*/
|
|
3130
3763
|
length?: number;
|
|
3764
|
+
/** Unique identity of the manufacturer. */
|
|
3131
3765
|
manufacturerId?: string;
|
|
3766
|
+
/** Unique number that describes the manufacturer. */
|
|
3132
3767
|
manufacturerNumber?: string;
|
|
3768
|
+
/** Indicates weather the product is top seller or not. */
|
|
3133
3769
|
markAsTopseller?: boolean;
|
|
3134
|
-
/**
|
|
3770
|
+
/**
|
|
3771
|
+
* Format: int64
|
|
3772
|
+
* Maximum number of items that can be purchased.
|
|
3773
|
+
*/
|
|
3135
3774
|
maxPurchase?: number;
|
|
3136
3775
|
measurements?: GenericRecord;
|
|
3137
3776
|
metaDescription?: string;
|
|
3138
3777
|
metaTitle?: string;
|
|
3139
|
-
/**
|
|
3778
|
+
/**
|
|
3779
|
+
* Format: int64
|
|
3780
|
+
* Minimum number of items that can be purchased.
|
|
3781
|
+
*/
|
|
3140
3782
|
minPurchase?: number;
|
|
3141
3783
|
name: string;
|
|
3142
3784
|
readonly optionIds?: string[];
|
|
@@ -3146,15 +3788,28 @@ export type Schemas = {
|
|
|
3146
3788
|
parentVersionId?: string;
|
|
3147
3789
|
productManufacturerVersionId?: string;
|
|
3148
3790
|
productMediaVersionId?: string;
|
|
3791
|
+
/** Unique number assigned to individual products. Define rules for automatic assignment of every product creation as per your number range. */
|
|
3149
3792
|
productNumber: string;
|
|
3150
3793
|
readonly propertyIds?: string[];
|
|
3151
|
-
/**
|
|
3794
|
+
/**
|
|
3795
|
+
* Format: int64
|
|
3796
|
+
* Specifies the scales in which the item is to be offered. For example, a scale of 2 means that your customers can purchase 2, 4, 6 products, etc., but not 1, 3 or 5.
|
|
3797
|
+
*/
|
|
3152
3798
|
purchaseSteps?: number;
|
|
3153
|
-
/**
|
|
3799
|
+
/**
|
|
3800
|
+
* Format: float
|
|
3801
|
+
* Quantity of the item purchased. For example, 500ml, 2kg, etc.
|
|
3802
|
+
*/
|
|
3154
3803
|
purchaseUnit?: number;
|
|
3155
|
-
/**
|
|
3804
|
+
/**
|
|
3805
|
+
* Format: float
|
|
3806
|
+
* Average of all the ratings.
|
|
3807
|
+
*/
|
|
3156
3808
|
readonly ratingAverage?: number;
|
|
3157
|
-
/**
|
|
3809
|
+
/**
|
|
3810
|
+
* Format: float
|
|
3811
|
+
* Price of purchased item calculated as per the reference unit. Say, you bought 500ml of milk and the price is calculated in reference to 1000ml.
|
|
3812
|
+
*/
|
|
3158
3813
|
referenceUnit?: number;
|
|
3159
3814
|
relationships?: {
|
|
3160
3815
|
/** Canonical product reference for variant consolidation and SEO purposes */
|
|
@@ -3381,6 +4036,7 @@ export type Schemas = {
|
|
|
3381
4036
|
related?: string;
|
|
3382
4037
|
};
|
|
3383
4038
|
};
|
|
4039
|
+
/** Unique identity of the product. */
|
|
3384
4040
|
parent?: {
|
|
3385
4041
|
data?: {
|
|
3386
4042
|
/** @example d0e45878043844ffc41aac437e86b602 */
|
|
@@ -3525,19 +4181,34 @@ export type Schemas = {
|
|
|
3525
4181
|
};
|
|
3526
4182
|
};
|
|
3527
4183
|
};
|
|
3528
|
-
/**
|
|
4184
|
+
/**
|
|
4185
|
+
* Format: date-time
|
|
4186
|
+
* The release date of a product or product model. This can be used to distinguish the exact variant of a product.
|
|
4187
|
+
*/
|
|
3529
4188
|
releaseDate?: string;
|
|
3530
|
-
/**
|
|
4189
|
+
/**
|
|
4190
|
+
* Format: int64
|
|
4191
|
+
* The restock time in days indicates how long it will take until a sold out item is back in stock.
|
|
4192
|
+
*/
|
|
3531
4193
|
restockTime?: number;
|
|
3532
|
-
/**
|
|
4194
|
+
/**
|
|
4195
|
+
* Format: int64
|
|
4196
|
+
* Frequency of the product sales.
|
|
4197
|
+
*/
|
|
3533
4198
|
readonly sales?: number;
|
|
4199
|
+
/** Indicates weather the shipping price is free or not. */
|
|
3534
4200
|
shippingFree?: boolean;
|
|
3535
4201
|
sortedProperties?: GenericRecord;
|
|
4202
|
+
/** @deprecated */
|
|
3536
4203
|
readonly states?: string[];
|
|
3537
|
-
/**
|
|
4204
|
+
/**
|
|
4205
|
+
* Format: int64
|
|
4206
|
+
* Indicates the number of products available.
|
|
4207
|
+
*/
|
|
3538
4208
|
stock: number;
|
|
3539
4209
|
readonly streamIds?: string[];
|
|
3540
4210
|
readonly tagIds?: string[];
|
|
4211
|
+
/** Unique identity of tax. */
|
|
3541
4212
|
taxId: string;
|
|
3542
4213
|
translated: {
|
|
3543
4214
|
canonicalProductId: string;
|
|
@@ -3564,16 +4235,26 @@ export type Schemas = {
|
|
|
3564
4235
|
productNumber: string;
|
|
3565
4236
|
releaseDate: string;
|
|
3566
4237
|
taxId: string;
|
|
4238
|
+
type: string;
|
|
3567
4239
|
unitId: string;
|
|
3568
4240
|
versionId: string;
|
|
3569
4241
|
};
|
|
4242
|
+
/** The type of the product, e.g., physical or digital. */
|
|
4243
|
+
type?: string;
|
|
4244
|
+
/** Unique identity of the unit. */
|
|
3570
4245
|
unitId?: string;
|
|
3571
4246
|
/** Format: date-time */
|
|
3572
4247
|
readonly updatedAt?: string;
|
|
3573
4248
|
versionId?: string;
|
|
3574
|
-
/**
|
|
4249
|
+
/**
|
|
4250
|
+
* Format: float
|
|
4251
|
+
* The weight of the product.
|
|
4252
|
+
*/
|
|
3575
4253
|
weight?: number;
|
|
3576
|
-
/**
|
|
4254
|
+
/**
|
|
4255
|
+
* Format: float
|
|
4256
|
+
* The width of the product.
|
|
4257
|
+
*/
|
|
3577
4258
|
width?: number;
|
|
3578
4259
|
} & {
|
|
3579
4260
|
options: {
|
|
@@ -3587,7 +4268,9 @@ export type Schemas = {
|
|
|
3587
4268
|
};
|
|
3588
4269
|
ProductKeywordDictionary: {
|
|
3589
4270
|
id?: string;
|
|
4271
|
+
/** The keywords that help to search the product. */
|
|
3590
4272
|
keyword: string;
|
|
4273
|
+
/** Unique identity of the language. */
|
|
3591
4274
|
languageId: string;
|
|
3592
4275
|
};
|
|
3593
4276
|
ProductListingCriteria: components["schemas"]["Criteria"] & {
|
|
@@ -3701,6 +4384,7 @@ export type Schemas = {
|
|
|
3701
4384
|
id: string;
|
|
3702
4385
|
link?: string;
|
|
3703
4386
|
media?: components["schemas"]["Media"];
|
|
4387
|
+
/** Unique identity of the media. */
|
|
3704
4388
|
mediaId?: string;
|
|
3705
4389
|
name: string;
|
|
3706
4390
|
translated: {
|
|
@@ -3754,9 +4438,14 @@ export type Schemas = {
|
|
|
3754
4438
|
customFields?: GenericRecord;
|
|
3755
4439
|
id: string;
|
|
3756
4440
|
media: components["schemas"]["Media"];
|
|
4441
|
+
/** Unique identity of the media. */
|
|
3757
4442
|
mediaId: string;
|
|
3758
|
-
/**
|
|
4443
|
+
/**
|
|
4444
|
+
* Format: int64
|
|
4445
|
+
* The order of the images to be displayed for a product.
|
|
4446
|
+
*/
|
|
3759
4447
|
position?: number;
|
|
4448
|
+
/** Unique identity of the product. */
|
|
3760
4449
|
productId: string;
|
|
3761
4450
|
productVersionId?: string;
|
|
3762
4451
|
/** Format: date-time */
|
|
@@ -3771,20 +4460,31 @@ export type Schemas = {
|
|
|
3771
4460
|
readonly updatedAt?: string;
|
|
3772
4461
|
};
|
|
3773
4462
|
ProductReview: {
|
|
4463
|
+
/** Detailed review about the product. */
|
|
3774
4464
|
comment?: string;
|
|
4465
|
+
/** Short description or subject of the project review. */
|
|
3775
4466
|
content: string;
|
|
3776
4467
|
/** Format: date-time */
|
|
3777
4468
|
readonly createdAt?: string;
|
|
3778
4469
|
customFields?: GenericRecord;
|
|
4470
|
+
/** External user name. */
|
|
3779
4471
|
externalUser?: string;
|
|
3780
4472
|
id: string;
|
|
4473
|
+
/** Unique identity of the language. */
|
|
3781
4474
|
languageId: string;
|
|
3782
|
-
/**
|
|
4475
|
+
/**
|
|
4476
|
+
* Format: float
|
|
4477
|
+
* A floating point number given to rate a product.
|
|
4478
|
+
*/
|
|
3783
4479
|
points?: number;
|
|
4480
|
+
/** Unique identity of the product. */
|
|
3784
4481
|
productId: string;
|
|
3785
4482
|
productVersionId?: string;
|
|
4483
|
+
/** Unique identity of the sales channel. */
|
|
3786
4484
|
salesChannelId: string;
|
|
4485
|
+
/** When status is set, the rating is made visible. */
|
|
3787
4486
|
status?: boolean;
|
|
4487
|
+
/** Title of product review. */
|
|
3788
4488
|
title: string;
|
|
3789
4489
|
/** Format: date-time */
|
|
3790
4490
|
readonly updatedAt?: string;
|
|
@@ -3901,13 +4601,16 @@ export type Schemas = {
|
|
|
3901
4601
|
readonly createdAt?: string;
|
|
3902
4602
|
customFields?: GenericRecord;
|
|
3903
4603
|
description?: string;
|
|
4604
|
+
/** Property groups can be displayed in the form of text, image, dropdown or color. */
|
|
3904
4605
|
displayType?: string;
|
|
4606
|
+
/** When set to true, the property will be displayed in the product filter of product lists. */
|
|
3905
4607
|
filterable?: boolean;
|
|
3906
4608
|
id: string;
|
|
3907
4609
|
name: string;
|
|
3908
4610
|
options?: components["schemas"]["PropertyGroupOption"][];
|
|
3909
4611
|
/** Format: int64 */
|
|
3910
4612
|
position?: number;
|
|
4613
|
+
/** Sorting the property group by name or position. */
|
|
3911
4614
|
sortingType?: string;
|
|
3912
4615
|
translated: {
|
|
3913
4616
|
description: string;
|
|
@@ -3917,9 +4620,11 @@ export type Schemas = {
|
|
|
3917
4620
|
};
|
|
3918
4621
|
/** Format: date-time */
|
|
3919
4622
|
readonly updatedAt?: string;
|
|
4623
|
+
/** When set to true, the property groups are displayed on product detail page. */
|
|
3920
4624
|
visibleOnProductDetailPage?: boolean;
|
|
3921
4625
|
};
|
|
3922
4626
|
PropertyGroupOption: {
|
|
4627
|
+
/** Property group options can be displayed in the form of color. For example: #98e3f5ff. */
|
|
3923
4628
|
colorHexCode?: string;
|
|
3924
4629
|
/** Runtime field, cannot be used as part of the criteria. */
|
|
3925
4630
|
combinable?: boolean;
|
|
@@ -3927,9 +4632,11 @@ export type Schemas = {
|
|
|
3927
4632
|
readonly createdAt?: string;
|
|
3928
4633
|
customFields?: GenericRecord;
|
|
3929
4634
|
group: components["schemas"]["PropertyGroup"];
|
|
4635
|
+
/** Unique identity of property group. */
|
|
3930
4636
|
groupId: string;
|
|
3931
4637
|
id: string;
|
|
3932
4638
|
media?: components["schemas"]["Media"];
|
|
4639
|
+
/** Unique identity of media. */
|
|
3933
4640
|
mediaId?: string;
|
|
3934
4641
|
name: string;
|
|
3935
4642
|
option: string;
|
|
@@ -3986,8 +4693,10 @@ export type Schemas = {
|
|
|
3986
4693
|
/** Format: date-time */
|
|
3987
4694
|
readonly createdAt?: string;
|
|
3988
4695
|
customFields?: GenericRecord;
|
|
4696
|
+
/** Description of the rule. */
|
|
3989
4697
|
description?: string;
|
|
3990
4698
|
id?: string;
|
|
4699
|
+
/** Name of the rule defined. */
|
|
3991
4700
|
name: string;
|
|
3992
4701
|
/** Format: date-time */
|
|
3993
4702
|
readonly updatedAt?: string;
|
|
@@ -4000,74 +4709,77 @@ export type Schemas = {
|
|
|
4000
4709
|
readonly updatedAt?: string;
|
|
4001
4710
|
};
|
|
4002
4711
|
SalesChannel: {
|
|
4712
|
+
/** When boolean value is `true`, the sales channel is enabled. */
|
|
4003
4713
|
active?: boolean;
|
|
4714
|
+
apiAlias?: string;
|
|
4004
4715
|
configuration?: GenericRecord;
|
|
4005
4716
|
/** Default country for the sales channel */
|
|
4006
4717
|
country?: components["schemas"]["Country"];
|
|
4718
|
+
/** Unique identity of country. */
|
|
4007
4719
|
countryId: string;
|
|
4008
4720
|
/** Format: date-time */
|
|
4009
4721
|
readonly createdAt?: string;
|
|
4010
4722
|
/** Default currency for the sales channel */
|
|
4011
4723
|
currency?: components["schemas"]["Currency"];
|
|
4724
|
+
/** Unique identity of currency used. */
|
|
4012
4725
|
currencyId: string;
|
|
4726
|
+
/** Unique identity of customer group. */
|
|
4013
4727
|
customerGroupId: string;
|
|
4014
4728
|
customFields?: GenericRecord;
|
|
4015
4729
|
/** Domain URLs configured for the sales channel */
|
|
4016
|
-
domains?: components["schemas"]["
|
|
4730
|
+
domains?: components["schemas"]["Domain"][];
|
|
4017
4731
|
/** Root category for footer navigation */
|
|
4018
4732
|
footerCategory?: components["schemas"]["Category"];
|
|
4733
|
+
/** Unique identity of footer category. */
|
|
4019
4734
|
footerCategoryId?: string;
|
|
4020
4735
|
footerCategoryVersionId?: string;
|
|
4736
|
+
/** When set to true, the sales channel pages are available in different languages. */
|
|
4021
4737
|
hreflangActive?: boolean;
|
|
4022
4738
|
hreflangDefaultDomain?: components["schemas"]["SalesChannelDomain"];
|
|
4739
|
+
/** Unique identity of hreflangDefaultDomain. */
|
|
4023
4740
|
hreflangDefaultDomainId?: string;
|
|
4741
|
+
/** Format: uuid */
|
|
4024
4742
|
id: string;
|
|
4025
4743
|
/** Default language for the sales channel */
|
|
4026
4744
|
language?: components["schemas"]["Language"];
|
|
4745
|
+
/** Unique identity of language used. */
|
|
4027
4746
|
languageId: string;
|
|
4747
|
+
/** Unique identity of mail header and footer. */
|
|
4028
4748
|
mailHeaderFooterId?: string;
|
|
4749
|
+
/** When `true`, it indicates that the sales channel is undergoing maintenance, and shopping is temporarily unavailable during this period. */
|
|
4029
4750
|
maintenance?: boolean;
|
|
4030
4751
|
measurementUnits?: components["schemas"]["MeasurementUnits"];
|
|
4031
4752
|
name: string;
|
|
4032
4753
|
/** Root category for navigation menu */
|
|
4033
4754
|
navigationCategory?: components["schemas"]["Category"];
|
|
4034
|
-
/**
|
|
4755
|
+
/**
|
|
4756
|
+
* Format: int64
|
|
4757
|
+
* It determines the number of levels of subcategories in the storefront category menu.
|
|
4758
|
+
*/
|
|
4035
4759
|
navigationCategoryDepth?: number;
|
|
4760
|
+
/** Unique identity of navigation category. */
|
|
4036
4761
|
navigationCategoryId: string;
|
|
4037
4762
|
navigationCategoryVersionId?: string;
|
|
4038
4763
|
/** Default payment method for the sales channel */
|
|
4039
4764
|
paymentMethod?: components["schemas"]["PaymentMethod"];
|
|
4765
|
+
/** Unique identity of payment method used. */
|
|
4040
4766
|
paymentMethodId: string;
|
|
4041
4767
|
/** Root category for service pages */
|
|
4042
4768
|
serviceCategory?: components["schemas"]["Category"];
|
|
4769
|
+
/** Unique identity of service category. */
|
|
4043
4770
|
serviceCategoryId?: string;
|
|
4044
4771
|
serviceCategoryVersionId?: string;
|
|
4045
4772
|
/** Default shipping method for the sales channel */
|
|
4046
4773
|
shippingMethod?: components["schemas"]["ShippingMethod"];
|
|
4774
|
+
/** Unique identity of shipping method. */
|
|
4047
4775
|
shippingMethodId: string;
|
|
4776
|
+
/** A short name for sales channel. */
|
|
4048
4777
|
shortName?: string;
|
|
4778
|
+
/** Tax calculation types are `horizontal` and `vertical`. */
|
|
4049
4779
|
taxCalculationType?: string;
|
|
4050
|
-
translated:
|
|
4051
|
-
countryId: string;
|
|
4052
|
-
currencyId: string;
|
|
4053
|
-
customerGroupId: string;
|
|
4054
|
-
footerCategoryId: string;
|
|
4055
|
-
footerCategoryVersionId: string;
|
|
4056
|
-
hreflangDefaultDomainId: string;
|
|
4057
|
-
languageId: string;
|
|
4058
|
-
mailHeaderFooterId: string;
|
|
4059
|
-
name: string;
|
|
4060
|
-
navigationCategoryId: string;
|
|
4061
|
-
navigationCategoryVersionId: string;
|
|
4062
|
-
paymentMethodId: string;
|
|
4063
|
-
serviceCategoryId: string;
|
|
4064
|
-
serviceCategoryVersionId: string;
|
|
4065
|
-
shippingMethodId: string;
|
|
4066
|
-
shortName: string;
|
|
4067
|
-
taxCalculationType: string;
|
|
4068
|
-
};
|
|
4780
|
+
translated: [];
|
|
4069
4781
|
/** Format: date-time */
|
|
4070
|
-
readonly updatedAt?: string;
|
|
4782
|
+
readonly updatedAt?: string | null;
|
|
4071
4783
|
};
|
|
4072
4784
|
SalesChannelAnalytics: {
|
|
4073
4785
|
/** Format: date-time */
|
|
@@ -4153,18 +4865,24 @@ export type Schemas = {
|
|
|
4153
4865
|
/** Format: date-time */
|
|
4154
4866
|
readonly createdAt?: string;
|
|
4155
4867
|
currency?: components["schemas"]["Currency"];
|
|
4868
|
+
/** Unique identity of currency. */
|
|
4156
4869
|
currencyId: string;
|
|
4157
4870
|
customFields?: GenericRecord;
|
|
4871
|
+
/** This is used to toggle the language configurations, say between DE and DE-DE for instance. */
|
|
4158
4872
|
hreflangUseOnlyLocale?: boolean;
|
|
4159
4873
|
id: string;
|
|
4160
4874
|
language?: components["schemas"]["Language"];
|
|
4875
|
+
/** Unique identity of language used. */
|
|
4161
4876
|
languageId: string;
|
|
4162
4877
|
measurementUnits?: components["schemas"]["MeasurementUnits"];
|
|
4163
4878
|
salesChannelDefaultHreflang?: components["schemas"]["SalesChannel"];
|
|
4879
|
+
/** Unique identity of sales channel. */
|
|
4164
4880
|
salesChannelId: string;
|
|
4881
|
+
/** Unique identity of snippet set. */
|
|
4165
4882
|
snippetSetId: string;
|
|
4166
4883
|
/** Format: date-time */
|
|
4167
4884
|
readonly updatedAt?: string;
|
|
4885
|
+
/** URL of the sales channel domain. */
|
|
4168
4886
|
url: string;
|
|
4169
4887
|
};
|
|
4170
4888
|
SalesChannelType: {
|
|
@@ -4181,6 +4899,7 @@ export type Schemas = {
|
|
|
4181
4899
|
displayName: string;
|
|
4182
4900
|
id: string;
|
|
4183
4901
|
letterName: string;
|
|
4902
|
+
/** Technical name given to salutation. For example: mr */
|
|
4184
4903
|
salutationKey: string;
|
|
4185
4904
|
translated: {
|
|
4186
4905
|
displayName: string;
|
|
@@ -4197,6 +4916,7 @@ export type Schemas = {
|
|
|
4197
4916
|
displayName: string;
|
|
4198
4917
|
id: string;
|
|
4199
4918
|
letterName: string;
|
|
4919
|
+
/** Technical name given to salutation. For example: mr */
|
|
4200
4920
|
salutationKey: string;
|
|
4201
4921
|
translated: {
|
|
4202
4922
|
displayName: string;
|
|
@@ -4226,19 +4946,30 @@ export type Schemas = {
|
|
|
4226
4946
|
customFields?: GenericRecord;
|
|
4227
4947
|
/** Runtime field, cannot be used as part of the criteria. */
|
|
4228
4948
|
error?: string;
|
|
4949
|
+
/** The key that references to product or category entity ID. */
|
|
4229
4950
|
foreignKey: string;
|
|
4230
4951
|
id: string;
|
|
4952
|
+
/** When set to true, search redirects to the main URL. */
|
|
4231
4953
|
isCanonical?: boolean;
|
|
4954
|
+
/** When set to true, the URL is deleted and cannot be used any more but it is still available on table and can be restored later. */
|
|
4232
4955
|
isDeleted?: boolean;
|
|
4956
|
+
/** When boolean value is `true`, the seo url is changed. */
|
|
4233
4957
|
isModified?: boolean;
|
|
4958
|
+
/** Unique identity of language. */
|
|
4234
4959
|
languageId: string;
|
|
4960
|
+
/** Path to product URL. For example: \\"/detail/bbf36734504741c79a3bbe3795b91564\\" */
|
|
4235
4961
|
pathInfo: string;
|
|
4236
|
-
/**
|
|
4962
|
+
/**
|
|
4963
|
+
* A destination routeName that has been registered somewhere in the app's router. For example: \\"frontend.detail.page\\"
|
|
4964
|
+
* @enum {string}
|
|
4965
|
+
*/
|
|
4237
4966
|
routeName:
|
|
4238
4967
|
| "frontend.navigation.page"
|
|
4239
4968
|
| "frontend.landing.page"
|
|
4240
4969
|
| "frontend.detail.page";
|
|
4970
|
+
/** Unique identity of sales channel. */
|
|
4241
4971
|
salesChannelId?: string;
|
|
4972
|
+
/** Seo path to product. For example: \\"Pepper-white-ground-pearl/SW10098\\" */
|
|
4242
4973
|
seoPathInfo: string;
|
|
4243
4974
|
/** Format: date-time */
|
|
4244
4975
|
readonly updatedAt?: string;
|
|
@@ -4251,15 +4982,24 @@ export type Schemas = {
|
|
|
4251
4982
|
customFields?: GenericRecord;
|
|
4252
4983
|
/** Runtime field, cannot be used as part of the criteria. */
|
|
4253
4984
|
error?: string;
|
|
4985
|
+
/** The key that references to product or category entity ID. */
|
|
4254
4986
|
foreignKey: string;
|
|
4255
4987
|
id: string;
|
|
4988
|
+
/** When set to true, search redirects to the main URL. */
|
|
4256
4989
|
isCanonical?: boolean;
|
|
4990
|
+
/** When set to true, the URL is deleted and cannot be used any more but it is still available on table and can be restored later. */
|
|
4257
4991
|
isDeleted?: boolean;
|
|
4992
|
+
/** When boolean value is `true`, the seo url is changed. */
|
|
4258
4993
|
isModified?: boolean;
|
|
4994
|
+
/** Unique identity of language. */
|
|
4259
4995
|
languageId: string;
|
|
4996
|
+
/** Path to product URL. For example: \\"/detail/bbf36734504741c79a3bbe3795b91564\\" */
|
|
4260
4997
|
pathInfo: string;
|
|
4998
|
+
/** A destination routeName that has been registered somewhere in the app's router. For example: \\"frontend.detail.page\\" */
|
|
4261
4999
|
routeName: string;
|
|
5000
|
+
/** Unique identity of sales channel. */
|
|
4262
5001
|
salesChannelId?: string;
|
|
5002
|
+
/** Seo path to product. For example: \\"Pepper-white-ground-pearl/SW10098\\" */
|
|
4263
5003
|
seoPathInfo: string;
|
|
4264
5004
|
/** Format: date-time */
|
|
4265
5005
|
readonly updatedAt?: string;
|
|
@@ -4271,12 +5011,15 @@ export type Schemas = {
|
|
|
4271
5011
|
readonly createdAt?: string;
|
|
4272
5012
|
customFields?: GenericRecord;
|
|
4273
5013
|
id?: string;
|
|
5014
|
+
/** Created SEO URL template can be made usable by setting `isValid` to true. */
|
|
4274
5015
|
isValid?: boolean;
|
|
5016
|
+
/** Unique identity of sales channel. */
|
|
4275
5017
|
salesChannelId?: string;
|
|
4276
5018
|
/** Format: date-time */
|
|
4277
5019
|
readonly updatedAt?: string;
|
|
4278
5020
|
};
|
|
4279
5021
|
ShippingMethod: {
|
|
5022
|
+
/** When boolean value is `true`, the shipping methods are available for selection in the storefront. */
|
|
4280
5023
|
active?: boolean;
|
|
4281
5024
|
/** Rule defining when this shipping method is available */
|
|
4282
5025
|
availabilityRule?: components["schemas"]["Rule"];
|
|
@@ -4285,14 +5028,19 @@ export type Schemas = {
|
|
|
4285
5028
|
customFields?: GenericRecord;
|
|
4286
5029
|
/** Estimated delivery time information */
|
|
4287
5030
|
deliveryTime?: components["schemas"]["DeliveryTime"];
|
|
5031
|
+
/** Unique identity of deliveryTime. */
|
|
4288
5032
|
deliveryTimeId: string;
|
|
4289
5033
|
description?: string;
|
|
4290
5034
|
id: string;
|
|
4291
5035
|
/** Shipping method logo or carrier image */
|
|
4292
5036
|
media?: components["schemas"]["Media"];
|
|
5037
|
+
/** Unique identity of media. */
|
|
4293
5038
|
mediaId?: string;
|
|
4294
5039
|
name: string;
|
|
4295
|
-
/**
|
|
5040
|
+
/**
|
|
5041
|
+
* Format: int64
|
|
5042
|
+
* The order of the tabs of your defined shipping methods in the storefront by entering numerical values like 1,2,3, etc.
|
|
5043
|
+
*/
|
|
4296
5044
|
position?: number;
|
|
4297
5045
|
/** Shipping prices based on weight, volume, or cart value */
|
|
4298
5046
|
prices?: components["schemas"]["ShippingMethodPrice"][];
|
|
@@ -4300,6 +5048,7 @@ export type Schemas = {
|
|
|
4300
5048
|
tags?: components["schemas"]["Tag"][];
|
|
4301
5049
|
/** Tax configuration for shipping costs */
|
|
4302
5050
|
tax?: components["schemas"]["Tax"];
|
|
5051
|
+
/** Refers `Free`, `Net` or `Gross` type of taxes. */
|
|
4303
5052
|
taxType?: string;
|
|
4304
5053
|
technicalName: string;
|
|
4305
5054
|
trackingUrl?: string;
|
|
@@ -4316,16 +5065,22 @@ export type Schemas = {
|
|
|
4316
5065
|
readonly updatedAt?: string;
|
|
4317
5066
|
};
|
|
4318
5067
|
ShippingMethodJsonApi: components["schemas"]["resource"] & {
|
|
5068
|
+
/** When boolean value is `true`, the shipping methods are available for selection in the storefront. */
|
|
4319
5069
|
active?: boolean;
|
|
4320
5070
|
/** Format: date-time */
|
|
4321
5071
|
readonly createdAt?: string;
|
|
4322
5072
|
customFields?: GenericRecord;
|
|
5073
|
+
/** Unique identity of deliveryTime. */
|
|
4323
5074
|
deliveryTimeId: string;
|
|
4324
5075
|
description?: string;
|
|
4325
5076
|
id: string;
|
|
5077
|
+
/** Unique identity of media. */
|
|
4326
5078
|
mediaId?: string;
|
|
4327
5079
|
name: string;
|
|
4328
|
-
/**
|
|
5080
|
+
/**
|
|
5081
|
+
* Format: int64
|
|
5082
|
+
* The order of the tabs of your defined shipping methods in the storefront by entering numerical values like 1,2,3, etc.
|
|
5083
|
+
*/
|
|
4329
5084
|
position?: number;
|
|
4330
5085
|
relationships?: {
|
|
4331
5086
|
/** Rule defining when this shipping method is available */
|
|
@@ -4425,6 +5180,7 @@ export type Schemas = {
|
|
|
4425
5180
|
};
|
|
4426
5181
|
};
|
|
4427
5182
|
};
|
|
5183
|
+
/** Refers `Free`, `Net` or `Gross` type of taxes. */
|
|
4428
5184
|
taxType?: string;
|
|
4429
5185
|
technicalName: string;
|
|
4430
5186
|
trackingUrl?: string;
|
|
@@ -4560,19 +5316,31 @@ export type Schemas = {
|
|
|
4560
5316
|
}[];
|
|
4561
5317
|
}[];
|
|
4562
5318
|
ShippingMethodPrice: {
|
|
4563
|
-
/**
|
|
5319
|
+
/**
|
|
5320
|
+
* Format: int64
|
|
5321
|
+
* Shipping price calculated based on quantity, price, weight or volume of items.
|
|
5322
|
+
*/
|
|
4564
5323
|
calculation?: number;
|
|
5324
|
+
/** Unique identity of rule calculation. */
|
|
4565
5325
|
calculationRuleId?: string;
|
|
4566
5326
|
/** Format: date-time */
|
|
4567
5327
|
readonly createdAt?: string;
|
|
4568
5328
|
currencyPrice?: components["schemas"]["Price"][];
|
|
4569
5329
|
customFields?: GenericRecord;
|
|
4570
5330
|
id: string;
|
|
4571
|
-
/**
|
|
5331
|
+
/**
|
|
5332
|
+
* Format: float
|
|
5333
|
+
* Ending range of quantity of an item.
|
|
5334
|
+
*/
|
|
4572
5335
|
quantityEnd?: number;
|
|
4573
|
-
/**
|
|
5336
|
+
/**
|
|
5337
|
+
* Format: float
|
|
5338
|
+
* Starting range of quantity of an item.
|
|
5339
|
+
*/
|
|
4574
5340
|
quantityStart?: number;
|
|
5341
|
+
/** Unique identity of rule. */
|
|
4575
5342
|
ruleId?: string;
|
|
5343
|
+
/** Unique identity of shipping method. */
|
|
4576
5344
|
shippingMethodId: string;
|
|
4577
5345
|
/** Format: date-time */
|
|
4578
5346
|
readonly updatedAt?: string;
|
|
@@ -4607,6 +5375,14 @@ export type Schemas = {
|
|
|
4607
5375
|
/** Format: date-time */
|
|
4608
5376
|
readonly updatedAt?: string;
|
|
4609
5377
|
};
|
|
5378
|
+
ShopbiteMultiChannelGroup: {
|
|
5379
|
+
/** Format: date-time */
|
|
5380
|
+
readonly createdAt?: string;
|
|
5381
|
+
id: string;
|
|
5382
|
+
name: string;
|
|
5383
|
+
/** Format: date-time */
|
|
5384
|
+
readonly updatedAt?: string;
|
|
5385
|
+
};
|
|
4610
5386
|
SimpleFilter: {
|
|
4611
5387
|
field: string;
|
|
4612
5388
|
/** @enum {string} */
|
|
@@ -4623,10 +5399,13 @@ export type Schemas = {
|
|
|
4623
5399
|
readonly createdAt?: string;
|
|
4624
5400
|
customFields?: GenericRecord;
|
|
4625
5401
|
id?: string;
|
|
5402
|
+
/** Unique identity od snippet set. */
|
|
4626
5403
|
setId: string;
|
|
5404
|
+
/** Reference to the snippet in the template. */
|
|
4627
5405
|
translationKey: string;
|
|
4628
5406
|
/** Format: date-time */
|
|
4629
5407
|
readonly updatedAt?: string;
|
|
5408
|
+
/** Value of the key. */
|
|
4630
5409
|
value: string;
|
|
4631
5410
|
};
|
|
4632
5411
|
SnippetSet: {
|
|
@@ -4634,7 +5413,9 @@ export type Schemas = {
|
|
|
4634
5413
|
readonly createdAt?: string;
|
|
4635
5414
|
customFields?: GenericRecord;
|
|
4636
5415
|
id?: string;
|
|
5416
|
+
/** ISO nomenclature used to classify languages. */
|
|
4637
5417
|
iso: string;
|
|
5418
|
+
/** Name of snippet set. */
|
|
4638
5419
|
name: string;
|
|
4639
5420
|
snippets?: components["schemas"]["Snippet"][];
|
|
4640
5421
|
/** Format: date-time */
|
|
@@ -4671,6 +5452,7 @@ export type Schemas = {
|
|
|
4671
5452
|
customFields?: GenericRecord;
|
|
4672
5453
|
id?: string;
|
|
4673
5454
|
name: string;
|
|
5455
|
+
/** Technical name of StateMachineState. */
|
|
4674
5456
|
technicalName: string;
|
|
4675
5457
|
translated: {
|
|
4676
5458
|
name: string;
|
|
@@ -4703,6 +5485,7 @@ export type Schemas = {
|
|
|
4703
5485
|
identifier?: string;
|
|
4704
5486
|
};
|
|
4705
5487
|
SystemConfig: {
|
|
5488
|
+
/** Config key for shop configurations. */
|
|
4706
5489
|
configurationKey: string;
|
|
4707
5490
|
configurationValue: {
|
|
4708
5491
|
_value?: GenericRecord;
|
|
@@ -4711,6 +5494,7 @@ export type Schemas = {
|
|
|
4711
5494
|
readonly createdAt?: string;
|
|
4712
5495
|
id: string;
|
|
4713
5496
|
salesChannel?: components["schemas"]["SalesChannel"];
|
|
5497
|
+
/** Unique identity of sales channel. */
|
|
4714
5498
|
salesChannelId?: string;
|
|
4715
5499
|
/** Format: date-time */
|
|
4716
5500
|
readonly updatedAt?: string;
|
|
@@ -4728,27 +5512,37 @@ export type Schemas = {
|
|
|
4728
5512
|
readonly createdAt?: string;
|
|
4729
5513
|
customFields?: GenericRecord;
|
|
4730
5514
|
id: string;
|
|
5515
|
+
/** Name defined for a Tax. */
|
|
4731
5516
|
name: string;
|
|
4732
5517
|
/**
|
|
4733
5518
|
* Format: int64
|
|
4734
|
-
* Added since version: 6.4.0.0.
|
|
5519
|
+
* The order of the tabs of your defined taxes in the storefront by entering numerical values like 1,2,3, etc. Added since version: 6.4.0.0.
|
|
4735
5520
|
*/
|
|
4736
5521
|
position?: number;
|
|
4737
|
-
/**
|
|
5522
|
+
/**
|
|
5523
|
+
* Format: float
|
|
5524
|
+
* Rate of tax.
|
|
5525
|
+
*/
|
|
4738
5526
|
taxRate: number;
|
|
4739
5527
|
/** Format: date-time */
|
|
4740
5528
|
readonly updatedAt?: string;
|
|
4741
5529
|
};
|
|
4742
5530
|
TaxProvider: {
|
|
5531
|
+
/** When boolean value is `true`, the tax providers are available for selection in the storefront. */
|
|
4743
5532
|
active?: boolean;
|
|
5533
|
+
/** Unique identity of app. */
|
|
4744
5534
|
appId?: string;
|
|
4745
5535
|
/** Format: date-time */
|
|
4746
5536
|
readonly createdAt?: string;
|
|
4747
5537
|
customFields?: GenericRecord;
|
|
4748
5538
|
id: string;
|
|
4749
5539
|
name: string;
|
|
4750
|
-
/**
|
|
5540
|
+
/**
|
|
5541
|
+
* Format: int64
|
|
5542
|
+
* A numerical value to prioritize one of the tax providers from the list.
|
|
5543
|
+
*/
|
|
4751
5544
|
priority: number;
|
|
5545
|
+
/** External URL makes request to get tax info. */
|
|
4752
5546
|
processUrl?: string;
|
|
4753
5547
|
translated: {
|
|
4754
5548
|
appId: string;
|
|
@@ -5443,6 +6237,8 @@ export type operations = {
|
|
|
5443
6237
|
"sw-language-id"?: string;
|
|
5444
6238
|
};
|
|
5445
6239
|
query?: {
|
|
6240
|
+
/** Compressed and encoded criteria object. Format: base64url(gzip(json_encode(criteria))). This parameter allows passing complex criteria as a single encoded string instead of multiple query parameters. The criteria object should be JSON-encoded, then gzipped, and finally base64url-encoded. The criteria object structure is defined in the Criteria schema (see #/components/schemas/Criteria). */
|
|
6241
|
+
_criteria?: components["parameters"]["CompressedCriteria"];
|
|
5446
6242
|
"aggregations[]"?: components["parameters"]["criteriaAggregations"];
|
|
5447
6243
|
associations?: components["parameters"]["criteriaAssociations"];
|
|
5448
6244
|
/** Specify the fields that should be excluded from the response for the given entities. Object key needs to be the entity name, and the list of fields needs to be the value. Note that the exclude fields will only be stripped on the API-Level, consider using the `fields` parameter for performance reasons. */
|
|
@@ -5519,8 +6315,6 @@ export type operations = {
|
|
|
5519
6315
|
limit?: number;
|
|
5520
6316
|
/** Filter by manufacturers. List of manufacturer identifiers separated by a `|`. */
|
|
5521
6317
|
manufacturer?: string;
|
|
5522
|
-
/** 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. */
|
|
5523
|
-
"manufacturer-filter"?: boolean;
|
|
5524
6318
|
/** Filters by a maximum product price. Has to be higher than the `min-price` filter. */
|
|
5525
6319
|
"max-price"?: number;
|
|
5526
6320
|
/** Filters by a minimum product price. Has to be lower than the `max-price` filter. */
|
|
@@ -5533,26 +6327,16 @@ export type operations = {
|
|
|
5533
6327
|
page?: components["parameters"]["criteriaPage"];
|
|
5534
6328
|
/** 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) */
|
|
5535
6329
|
"post-filter[]"?: components["parameters"]["criteriaPostFilter"];
|
|
5536
|
-
/** 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. */
|
|
5537
|
-
"price-filter"?: boolean;
|
|
5538
6330
|
/** Filters products by their properties. List of property identifiers separated by a `|`. */
|
|
5539
6331
|
properties?: string;
|
|
5540
|
-
/** 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. */
|
|
5541
|
-
"property-filter"?: boolean;
|
|
5542
|
-
/** 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. */
|
|
5543
|
-
"property-whitelist"?: string;
|
|
5544
6332
|
/** The query string to search for */
|
|
5545
6333
|
query?: components["parameters"]["criteriaQuery"];
|
|
5546
6334
|
/** Filter products with a minimum average rating. */
|
|
5547
6335
|
rating?: number;
|
|
5548
|
-
/** 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. */
|
|
5549
|
-
"rating-filter"?: boolean;
|
|
5550
6336
|
/** 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. */
|
|
5551
6337
|
"reduce-aggregations"?: string | null;
|
|
5552
6338
|
/** Filters products that are marked as shipping-free. */
|
|
5553
6339
|
"shipping-free"?: boolean;
|
|
5554
|
-
/** 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. */
|
|
5555
|
-
"shipping-free-filter"?: boolean;
|
|
5556
6340
|
/** Resolves only the given slot identifiers. The identifiers have to be seperated by a '|' character */
|
|
5557
6341
|
slots?: string;
|
|
5558
6342
|
/** Sorting in the search result. */
|
|
@@ -5758,8 +6542,6 @@ export type operations = {
|
|
|
5758
6542
|
limit?: number;
|
|
5759
6543
|
/** Filter by manufacturers. List of manufacturer identifiers separated by a `|`. */
|
|
5760
6544
|
manufacturer?: string;
|
|
5761
|
-
/** 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. */
|
|
5762
|
-
"manufacturer-filter"?: boolean;
|
|
5763
6545
|
/** Filters by a maximum product price. Has to be higher than the `min-price` filter. */
|
|
5764
6546
|
"max-price"?: number;
|
|
5765
6547
|
/** Filters by a minimum product price. Has to be lower than the `max-price` filter. */
|
|
@@ -5772,26 +6554,16 @@ export type operations = {
|
|
|
5772
6554
|
page?: components["parameters"]["criteriaPage"];
|
|
5773
6555
|
/** 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) */
|
|
5774
6556
|
"post-filter[]"?: components["parameters"]["criteriaPostFilter"];
|
|
5775
|
-
/** 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. */
|
|
5776
|
-
"price-filter"?: boolean;
|
|
5777
6557
|
/** Filters products by their properties. List of property identifiers separated by a `|`. */
|
|
5778
6558
|
properties?: string;
|
|
5779
|
-
/** 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. */
|
|
5780
|
-
"property-filter"?: boolean;
|
|
5781
|
-
/** 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. */
|
|
5782
|
-
"property-whitelist"?: string;
|
|
5783
6559
|
/** The query string to search for */
|
|
5784
6560
|
query?: components["parameters"]["criteriaQuery"];
|
|
5785
6561
|
/** Filter products with a minimum average rating. */
|
|
5786
6562
|
rating?: number;
|
|
5787
|
-
/** 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. */
|
|
5788
|
-
"rating-filter"?: boolean;
|
|
5789
6563
|
/** 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. */
|
|
5790
6564
|
"reduce-aggregations"?: string | null;
|
|
5791
6565
|
/** Filters products that are marked as shipping-free. */
|
|
5792
6566
|
"shipping-free"?: boolean;
|
|
5793
|
-
/** 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. */
|
|
5794
|
-
"shipping-free-filter"?: boolean;
|
|
5795
6567
|
/** Resolves only the given slot identifiers. The identifiers have to be seperated by a `|` character. */
|
|
5796
6568
|
slots?: string;
|
|
5797
6569
|
/** Sorting in the search result. */
|
|
@@ -5935,6 +6707,8 @@ export type operations = {
|
|
|
5935
6707
|
"sw-language-id"?: string;
|
|
5936
6708
|
};
|
|
5937
6709
|
query?: {
|
|
6710
|
+
/** Compressed and encoded criteria object. Format: base64url(gzip(json_encode(criteria))). This parameter allows passing complex criteria as a single encoded string instead of multiple query parameters. The criteria object should be JSON-encoded, then gzipped, and finally base64url-encoded. The criteria object structure is defined in the Criteria schema (see #/components/schemas/Criteria). */
|
|
6711
|
+
_criteria?: components["parameters"]["CompressedCriteria"];
|
|
5938
6712
|
"aggregations[]"?: components["parameters"]["criteriaAggregations"];
|
|
5939
6713
|
associations?: components["parameters"]["criteriaAssociations"];
|
|
5940
6714
|
/** Specify the fields that should be excluded from the response for the given entities. Object key needs to be the entity name, and the list of fields needs to be the value. Note that the exclude fields will only be stripped on the API-Level, consider using the `fields` parameter for performance reasons. */
|
|
@@ -5991,6 +6765,8 @@ export type operations = {
|
|
|
5991
6765
|
"sw-language-id"?: string;
|
|
5992
6766
|
};
|
|
5993
6767
|
query?: {
|
|
6768
|
+
/** Compressed and encoded criteria object. Format: base64url(gzip(json_encode(criteria))). This parameter allows passing complex criteria as a single encoded string instead of multiple query parameters. The criteria object should be JSON-encoded, then gzipped, and finally base64url-encoded. The criteria object structure is defined in the Criteria schema (see #/components/schemas/Criteria). */
|
|
6769
|
+
_criteria?: components["parameters"]["CompressedCriteria"];
|
|
5994
6770
|
"aggregations[]"?: components["parameters"]["criteriaAggregations"];
|
|
5995
6771
|
associations?: components["parameters"]["criteriaAssociations"];
|
|
5996
6772
|
/** Specify the fields that should be excluded from the response for the given entities. Object key needs to be the entity name, and the list of fields needs to be the value. Note that the exclude fields will only be stripped on the API-Level, consider using the `fields` parameter for performance reasons. */
|
|
@@ -6053,6 +6829,8 @@ export type operations = {
|
|
|
6053
6829
|
"sw-language-id"?: string;
|
|
6054
6830
|
};
|
|
6055
6831
|
query?: {
|
|
6832
|
+
/** Compressed and encoded criteria object. Format: base64url(gzip(json_encode(criteria))). This parameter allows passing complex criteria as a single encoded string instead of multiple query parameters. The criteria object should be JSON-encoded, then gzipped, and finally base64url-encoded. The criteria object structure is defined in the NoneFieldsCriteria schema (see #/components/schemas/NoneFieldsCriteria). */
|
|
6833
|
+
_criteria?: components["parameters"]["CompressedNoneFieldsCriteria"];
|
|
6056
6834
|
"aggregations[]"?: components["parameters"]["criteriaAggregations"];
|
|
6057
6835
|
associations?: components["parameters"]["criteriaAssociations"];
|
|
6058
6836
|
/** Specify the fields that should be excluded from the response for the given entities. Object key needs to be the entity name, and the list of fields needs to be the value. Note that the exclude fields will only be stripped on the API-Level, consider using the `fields` parameter for performance reasons. */
|
|
@@ -6152,62 +6930,262 @@ export type operations = {
|
|
|
6152
6930
|
response: components["schemas"]["SuccessResponse"];
|
|
6153
6931
|
responseCode: 200;
|
|
6154
6932
|
};
|
|
6155
|
-
"
|
|
6156
|
-
|
|
6157
|
-
|
|
6158
|
-
|
|
6159
|
-
|
|
6160
|
-
|
|
6161
|
-
|
|
6162
|
-
|
|
6163
|
-
|
|
6164
|
-
|
|
6165
|
-
|
|
6166
|
-
|
|
6167
|
-
|
|
6168
|
-
|
|
6169
|
-
|
|
6170
|
-
|
|
6171
|
-
|
|
6172
|
-
|
|
6173
|
-
|
|
6174
|
-
|
|
6175
|
-
|
|
6176
|
-
|
|
6177
|
-
|
|
6178
|
-
|
|
6179
|
-
|
|
6180
|
-
|
|
6181
|
-
|
|
6182
|
-
|
|
6183
|
-
|
|
6184
|
-
|
|
6185
|
-
|
|
6186
|
-
|
|
6187
|
-
|
|
6188
|
-
|
|
6189
|
-
|
|
6190
|
-
|
|
6191
|
-
|
|
6192
|
-
|
|
6193
|
-
|
|
6194
|
-
|
|
6195
|
-
|
|
6196
|
-
|
|
6197
|
-
|
|
6198
|
-
|
|
6199
|
-
|
|
6200
|
-
|
|
6201
|
-
|
|
6202
|
-
|
|
6203
|
-
|
|
6204
|
-
|
|
6205
|
-
|
|
6206
|
-
|
|
6207
|
-
|
|
6208
|
-
|
|
6209
|
-
|
|
6210
|
-
|
|
6933
|
+
"downloadGet get /document/download/{documentId}/{deepLinkCode}":
|
|
6934
|
+
| {
|
|
6935
|
+
contentType?: "application/json";
|
|
6936
|
+
accept: "application/pdf";
|
|
6937
|
+
headers?: {
|
|
6938
|
+
/** If a document is rendered on the fly the provided language id is added to fallback languages while the order language has priority. It does not change already generated documents. */
|
|
6939
|
+
"sw-language-id"?: string;
|
|
6940
|
+
};
|
|
6941
|
+
query?: {
|
|
6942
|
+
/** Required for guest orders to verify the user; ignored for orders with logged-in user. */
|
|
6943
|
+
email?: string;
|
|
6944
|
+
/** Required for guest orders to verify the user; ignored for orders with logged-in user. */
|
|
6945
|
+
zipcode?: string;
|
|
6946
|
+
};
|
|
6947
|
+
pathParams: {
|
|
6948
|
+
deepLinkCode: string;
|
|
6949
|
+
documentId: string;
|
|
6950
|
+
};
|
|
6951
|
+
response: Blob;
|
|
6952
|
+
responseCode: 200;
|
|
6953
|
+
}
|
|
6954
|
+
| {
|
|
6955
|
+
contentType?: "application/json";
|
|
6956
|
+
accept: "application/xml";
|
|
6957
|
+
headers?: {
|
|
6958
|
+
/** If a document is rendered on the fly the provided language id is added to fallback languages while the order language has priority. It does not change already generated documents. */
|
|
6959
|
+
"sw-language-id"?: string;
|
|
6960
|
+
};
|
|
6961
|
+
query?: {
|
|
6962
|
+
/** Required for guest orders to verify the user; ignored for orders with logged-in user. */
|
|
6963
|
+
email?: string;
|
|
6964
|
+
/** Required for guest orders to verify the user; ignored for orders with logged-in user. */
|
|
6965
|
+
zipcode?: string;
|
|
6966
|
+
};
|
|
6967
|
+
pathParams: {
|
|
6968
|
+
deepLinkCode: string;
|
|
6969
|
+
documentId: string;
|
|
6970
|
+
};
|
|
6971
|
+
response: string;
|
|
6972
|
+
responseCode: 200;
|
|
6973
|
+
}
|
|
6974
|
+
| {
|
|
6975
|
+
contentType?: "application/json";
|
|
6976
|
+
accept: "text/html";
|
|
6977
|
+
headers?: {
|
|
6978
|
+
/** If a document is rendered on the fly the provided language id is added to fallback languages while the order language has priority. It does not change already generated documents. */
|
|
6979
|
+
"sw-language-id"?: string;
|
|
6980
|
+
};
|
|
6981
|
+
query?: {
|
|
6982
|
+
/** Required for guest orders to verify the user; ignored for orders with logged-in user. */
|
|
6983
|
+
email?: string;
|
|
6984
|
+
/** Required for guest orders to verify the user; ignored for orders with logged-in user. */
|
|
6985
|
+
zipcode?: string;
|
|
6986
|
+
};
|
|
6987
|
+
pathParams: {
|
|
6988
|
+
deepLinkCode: string;
|
|
6989
|
+
documentId: string;
|
|
6990
|
+
};
|
|
6991
|
+
response: string;
|
|
6992
|
+
responseCode: 200;
|
|
6993
|
+
}
|
|
6994
|
+
| {
|
|
6995
|
+
contentType?: "application/json";
|
|
6996
|
+
accept?: "application/json";
|
|
6997
|
+
headers?: {
|
|
6998
|
+
/** If a document is rendered on the fly the provided language id is added to fallback languages while the order language has priority. It does not change already generated documents. */
|
|
6999
|
+
"sw-language-id"?: string;
|
|
7000
|
+
};
|
|
7001
|
+
query?: {
|
|
7002
|
+
/** Required for guest orders to verify the user; ignored for orders with logged-in user. */
|
|
7003
|
+
email?: string;
|
|
7004
|
+
/** Required for guest orders to verify the user; ignored for orders with logged-in user. */
|
|
7005
|
+
zipcode?: string;
|
|
7006
|
+
};
|
|
7007
|
+
pathParams: {
|
|
7008
|
+
deepLinkCode: string;
|
|
7009
|
+
documentId: string;
|
|
7010
|
+
};
|
|
7011
|
+
response: never;
|
|
7012
|
+
responseCode: 204;
|
|
7013
|
+
};
|
|
7014
|
+
"download post /document/download/{documentId}/{deepLinkCode}":
|
|
7015
|
+
| {
|
|
7016
|
+
contentType?: "application/json";
|
|
7017
|
+
accept: "application/pdf";
|
|
7018
|
+
headers?: {
|
|
7019
|
+
/** If a document is rendered on the fly the provided language id is added to fallback languages while the order language has priority. It does not change already generated documents. */
|
|
7020
|
+
"sw-language-id"?: string;
|
|
7021
|
+
};
|
|
7022
|
+
pathParams: {
|
|
7023
|
+
deepLinkCode: string;
|
|
7024
|
+
documentId: string;
|
|
7025
|
+
};
|
|
7026
|
+
body?: {
|
|
7027
|
+
email?: string;
|
|
7028
|
+
zipcode?: string;
|
|
7029
|
+
};
|
|
7030
|
+
response: Blob;
|
|
7031
|
+
responseCode: 200;
|
|
7032
|
+
}
|
|
7033
|
+
| {
|
|
7034
|
+
contentType?: "application/json";
|
|
7035
|
+
accept: "application/xml";
|
|
7036
|
+
headers?: {
|
|
7037
|
+
/** If a document is rendered on the fly the provided language id is added to fallback languages while the order language has priority. It does not change already generated documents. */
|
|
7038
|
+
"sw-language-id"?: string;
|
|
7039
|
+
};
|
|
7040
|
+
pathParams: {
|
|
7041
|
+
deepLinkCode: string;
|
|
7042
|
+
documentId: string;
|
|
7043
|
+
};
|
|
7044
|
+
body?: {
|
|
7045
|
+
email?: string;
|
|
7046
|
+
zipcode?: string;
|
|
7047
|
+
};
|
|
7048
|
+
response: string;
|
|
7049
|
+
responseCode: 200;
|
|
7050
|
+
}
|
|
7051
|
+
| {
|
|
7052
|
+
contentType?: "application/json";
|
|
7053
|
+
accept: "text/html";
|
|
7054
|
+
headers?: {
|
|
7055
|
+
/** If a document is rendered on the fly the provided language id is added to fallback languages while the order language has priority. It does not change already generated documents. */
|
|
7056
|
+
"sw-language-id"?: string;
|
|
7057
|
+
};
|
|
7058
|
+
pathParams: {
|
|
7059
|
+
deepLinkCode: string;
|
|
7060
|
+
documentId: string;
|
|
7061
|
+
};
|
|
7062
|
+
body?: {
|
|
7063
|
+
email?: string;
|
|
7064
|
+
zipcode?: string;
|
|
7065
|
+
};
|
|
7066
|
+
response: string;
|
|
7067
|
+
responseCode: 200;
|
|
7068
|
+
}
|
|
7069
|
+
| {
|
|
7070
|
+
contentType?: "application/json";
|
|
7071
|
+
accept?: "application/json";
|
|
7072
|
+
headers?: {
|
|
7073
|
+
/** If a document is rendered on the fly the provided language id is added to fallback languages while the order language has priority. It does not change already generated documents. */
|
|
7074
|
+
"sw-language-id"?: string;
|
|
7075
|
+
};
|
|
7076
|
+
pathParams: {
|
|
7077
|
+
deepLinkCode: string;
|
|
7078
|
+
documentId: string;
|
|
7079
|
+
};
|
|
7080
|
+
body?: {
|
|
7081
|
+
email?: string;
|
|
7082
|
+
zipcode?: string;
|
|
7083
|
+
};
|
|
7084
|
+
response: never;
|
|
7085
|
+
responseCode: 204;
|
|
7086
|
+
};
|
|
7087
|
+
"handlePaymentMethodGet get /handle-payment": {
|
|
7088
|
+
contentType?: "application/json";
|
|
7089
|
+
accept?: "application/json";
|
|
7090
|
+
query: {
|
|
7091
|
+
/** URL to which the client should be redirected after erroneous payment */
|
|
7092
|
+
errorUrl?: string;
|
|
7093
|
+
/** URL to which the client should be redirected after successful payment */
|
|
7094
|
+
finishUrl?: string;
|
|
7095
|
+
/** Identifier of an order */
|
|
7096
|
+
orderId: string;
|
|
7097
|
+
};
|
|
7098
|
+
response: {
|
|
7099
|
+
redirectUrl: string;
|
|
7100
|
+
};
|
|
7101
|
+
responseCode: 200;
|
|
7102
|
+
};
|
|
7103
|
+
"handlePaymentMethod post /handle-payment": {
|
|
7104
|
+
contentType?: "application/json";
|
|
7105
|
+
accept?: "application/json";
|
|
7106
|
+
body: {
|
|
7107
|
+
/** URL to which the client should be redirected after erroneous payment */
|
|
7108
|
+
errorUrl?: string;
|
|
7109
|
+
/** URL to which the client should be redirected after successful payment */
|
|
7110
|
+
finishUrl?: string;
|
|
7111
|
+
/** Identifier of an order */
|
|
7112
|
+
orderId: string;
|
|
7113
|
+
};
|
|
7114
|
+
response: {
|
|
7115
|
+
redirectUrl: string;
|
|
7116
|
+
};
|
|
7117
|
+
responseCode: 200;
|
|
7118
|
+
};
|
|
7119
|
+
"readLandingPageGet get /landing-page/{landingPageId}": {
|
|
7120
|
+
contentType?: "application/json";
|
|
7121
|
+
accept?: "application/json";
|
|
7122
|
+
headers?: {
|
|
7123
|
+
/** Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version. */
|
|
7124
|
+
"sw-include-search-info"?: "0" | "1";
|
|
7125
|
+
/** Instructs Shopware to return the response in the given language. */
|
|
7126
|
+
"sw-language-id"?: string;
|
|
7127
|
+
};
|
|
7128
|
+
query?: {
|
|
7129
|
+
"aggregations[]"?: components["parameters"]["criteriaAggregations"];
|
|
7130
|
+
associations?: components["parameters"]["criteriaAssociations"];
|
|
7131
|
+
/** Specify the fields that should be excluded from the response for the given entities. Object key needs to be the entity name, and the list of fields needs to be the value. Note that the exclude fields will only be stripped on the API-Level, consider using the `fields` parameter for performance reasons. */
|
|
7132
|
+
excludes?: components["parameters"]["criteriaExcludes"];
|
|
7133
|
+
/** Fields which should be returned in the search result. */
|
|
7134
|
+
"fields[]"?: components["parameters"]["criteriaFields"];
|
|
7135
|
+
/** 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) */
|
|
7136
|
+
"filter[]"?: components["parameters"]["criteriaFilter"];
|
|
7137
|
+
/** Perform groupings over certain fields */
|
|
7138
|
+
"grouping[]"?: components["parameters"]["criteriaGrouping"];
|
|
7139
|
+
/** List of ids to search for */
|
|
7140
|
+
"ids[]"?: components["parameters"]["criteriaIds"];
|
|
7141
|
+
/** Specify the fields that should be returned for the given entities. Object key needs to be the entity name, and the list of fields needs to be the value. Fields will not be included, if they are also specified in the excludes. Note that the include fields will only be stripped on the API-Level, consider using the `fields` parameter for performance reasons. */
|
|
7142
|
+
includes?: components["parameters"]["criteriaIncludes"];
|
|
7143
|
+
/** 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. */
|
|
7144
|
+
limit?: number;
|
|
7145
|
+
/** Filter by manufacturers. List of manufacturer identifiers separated by a `|`. */
|
|
7146
|
+
manufacturer?: string;
|
|
7147
|
+
/** Filters by a maximum product price. Has to be higher than the `min-price` filter. */
|
|
7148
|
+
"max-price"?: number;
|
|
7149
|
+
/** Filters by a minimum product price. Has to be lower than the `max-price` filter. */
|
|
7150
|
+
"min-price"?: number;
|
|
7151
|
+
/** 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. */
|
|
7152
|
+
order?: string;
|
|
7153
|
+
/** Search result page */
|
|
7154
|
+
p?: number;
|
|
7155
|
+
/** Search result page */
|
|
7156
|
+
page?: components["parameters"]["criteriaPage"];
|
|
7157
|
+
/** 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) */
|
|
7158
|
+
"post-filter[]"?: components["parameters"]["criteriaPostFilter"];
|
|
7159
|
+
/** Filters products by their properties. List of property identifiers separated by a `|`. */
|
|
7160
|
+
properties?: string;
|
|
7161
|
+
/** The query string to search for */
|
|
7162
|
+
query?: components["parameters"]["criteriaQuery"];
|
|
7163
|
+
/** Filter products with a minimum average rating. */
|
|
7164
|
+
rating?: number;
|
|
7165
|
+
/** 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. */
|
|
7166
|
+
"reduce-aggregations"?: string | null;
|
|
7167
|
+
/** Filters products that are marked as shipping-free. */
|
|
7168
|
+
"shipping-free"?: boolean;
|
|
7169
|
+
/** Sorting in the search result. */
|
|
7170
|
+
"sort[]"?: components["parameters"]["criteriaSort"];
|
|
7171
|
+
/** Search term */
|
|
7172
|
+
term?: components["parameters"]["criteriaTerm"];
|
|
7173
|
+
"total-count-mode"?: components["parameters"]["criteriaTotalCountMode"];
|
|
7174
|
+
};
|
|
7175
|
+
pathParams: {
|
|
7176
|
+
/** Identifier of the landing page. */
|
|
7177
|
+
landingPageId: string;
|
|
7178
|
+
};
|
|
7179
|
+
response: components["schemas"]["LandingPage"];
|
|
7180
|
+
responseCode: 200;
|
|
7181
|
+
};
|
|
7182
|
+
"readLandingPage post /landing-page/{landingPageId}": {
|
|
7183
|
+
contentType?: "application/json";
|
|
7184
|
+
accept?: "application/json";
|
|
7185
|
+
headers?: {
|
|
7186
|
+
/** Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version. */
|
|
7187
|
+
"sw-include-search-info"?: "0" | "1";
|
|
7188
|
+
/** Instructs Shopware to return the response in the given language. */
|
|
6211
7189
|
"sw-language-id"?: string;
|
|
6212
7190
|
};
|
|
6213
7191
|
pathParams: {
|
|
@@ -6230,6 +7208,8 @@ export type operations = {
|
|
|
6230
7208
|
"sw-language-id"?: string;
|
|
6231
7209
|
};
|
|
6232
7210
|
query?: {
|
|
7211
|
+
/** Compressed and encoded criteria object. Format: base64url(gzip(json_encode(criteria))). This parameter allows passing complex criteria as a single encoded string instead of multiple query parameters. The criteria object should be JSON-encoded, then gzipped, and finally base64url-encoded. The criteria object structure is defined in the Criteria schema (see #/components/schemas/Criteria). */
|
|
7212
|
+
_criteria?: components["parameters"]["CompressedCriteria"];
|
|
6233
7213
|
"aggregations[]"?: components["parameters"]["criteriaAggregations"];
|
|
6234
7214
|
associations?: components["parameters"]["criteriaAssociations"];
|
|
6235
7215
|
/** Specify the fields that should be excluded from the response for the given entities. Object key needs to be the entity name, and the list of fields needs to be the value. Note that the exclude fields will only be stripped on the API-Level, consider using the `fields` parameter for performance reasons. */
|
|
@@ -6278,6 +7258,16 @@ export type operations = {
|
|
|
6278
7258
|
} & components["schemas"]["EntitySearchResult"];
|
|
6279
7259
|
responseCode: 200;
|
|
6280
7260
|
};
|
|
7261
|
+
"readMediaGet get /media": {
|
|
7262
|
+
contentType?: "application/json";
|
|
7263
|
+
accept?: "application/json";
|
|
7264
|
+
query: {
|
|
7265
|
+
/** Identifier (UUID) of the media entity to be fetched. */
|
|
7266
|
+
"ids[]": string[];
|
|
7267
|
+
};
|
|
7268
|
+
response: components["schemas"]["Media"][];
|
|
7269
|
+
responseCode: 200;
|
|
7270
|
+
};
|
|
6281
7271
|
"readMedia post /media": {
|
|
6282
7272
|
contentType?: "application/json";
|
|
6283
7273
|
accept?: "application/json";
|
|
@@ -6298,6 +7288,8 @@ export type operations = {
|
|
|
6298
7288
|
"sw-language-id"?: string;
|
|
6299
7289
|
};
|
|
6300
7290
|
query?: {
|
|
7291
|
+
/** Compressed and encoded criteria object. Format: base64url(gzip(json_encode(criteria))). This parameter allows passing complex criteria as a single encoded string instead of multiple query parameters. The criteria object should be JSON-encoded, then gzipped, and finally base64url-encoded. The criteria object structure is defined in the NoneFieldsCriteria schema (see #/components/schemas/NoneFieldsCriteria). */
|
|
7292
|
+
_criteria?: components["parameters"]["CompressedNoneFieldsCriteria"];
|
|
6301
7293
|
"aggregations[]"?: components["parameters"]["criteriaAggregations"];
|
|
6302
7294
|
associations?: components["parameters"]["criteriaAssociations"];
|
|
6303
7295
|
/** Return the categories as a tree or as a flat list. */
|
|
@@ -6505,6 +7497,8 @@ export type operations = {
|
|
|
6505
7497
|
"sw-language-id"?: string;
|
|
6506
7498
|
};
|
|
6507
7499
|
query?: {
|
|
7500
|
+
/** Compressed and encoded criteria object. Format: base64url(gzip(json_encode(criteria))). This parameter allows passing complex criteria as a single encoded string instead of multiple query parameters. The criteria object should be JSON-encoded, then gzipped, and finally base64url-encoded. The criteria object structure is defined in the Criteria schema (see #/components/schemas/Criteria). */
|
|
7501
|
+
_criteria?: components["parameters"]["CompressedCriteria"];
|
|
6508
7502
|
"aggregations[]"?: components["parameters"]["criteriaAggregations"];
|
|
6509
7503
|
associations?: components["parameters"]["criteriaAssociations"];
|
|
6510
7504
|
/** Specify the fields that should be excluded from the response for the given entities. Object key needs to be the entity name, and the list of fields needs to be the value. Note that the exclude fields will only be stripped on the API-Level, consider using the `fields` parameter for performance reasons. */
|
|
@@ -6575,6 +7569,8 @@ export type operations = {
|
|
|
6575
7569
|
"sw-language-id"?: string;
|
|
6576
7570
|
};
|
|
6577
7571
|
query?: {
|
|
7572
|
+
/** Compressed and encoded criteria object. Format: base64url(gzip(json_encode(criteria))). This parameter allows passing complex criteria as a single encoded string instead of multiple query parameters. The criteria object should be JSON-encoded, then gzipped, and finally base64url-encoded. The criteria object structure is defined in the Criteria schema (see #/components/schemas/Criteria). */
|
|
7573
|
+
_criteria?: components["parameters"]["CompressedCriteria"];
|
|
6578
7574
|
"aggregations[]"?: components["parameters"]["criteriaAggregations"];
|
|
6579
7575
|
associations?: components["parameters"]["criteriaAssociations"];
|
|
6580
7576
|
/** Specify the fields that should be excluded from the response for the given entities. Object key needs to be the entity name, and the list of fields needs to be the value. Note that the exclude fields will only be stripped on the API-Level, consider using the `fields` parameter for performance reasons. */
|
|
@@ -6635,6 +7631,73 @@ export type operations = {
|
|
|
6635
7631
|
response: never;
|
|
6636
7632
|
responseCode: 200;
|
|
6637
7633
|
};
|
|
7634
|
+
"readProductListingGet get /product-listing/{categoryId}": {
|
|
7635
|
+
contentType?: "application/json";
|
|
7636
|
+
accept?: "application/json";
|
|
7637
|
+
headers?: {
|
|
7638
|
+
/** Determines if the response must contain a SeoUrl entity for a product entity */
|
|
7639
|
+
"sw-include-seo-urls"?: boolean;
|
|
7640
|
+
/** Instructs Shopware to return the response in the given language. */
|
|
7641
|
+
"sw-language-id"?: string;
|
|
7642
|
+
};
|
|
7643
|
+
query?: {
|
|
7644
|
+
"aggregations[]"?: components["parameters"]["criteriaAggregations"];
|
|
7645
|
+
associations?: components["parameters"]["criteriaAssociations"];
|
|
7646
|
+
/** Specify the fields that should be excluded from the response for the given entities. Object key needs to be the entity name, and the list of fields needs to be the value. Note that the exclude fields will only be stripped on the API-Level, consider using the `fields` parameter for performance reasons. */
|
|
7647
|
+
excludes?: components["parameters"]["criteriaExcludes"];
|
|
7648
|
+
/** Fields which should be returned in the search result. */
|
|
7649
|
+
"fields[]"?: components["parameters"]["criteriaFields"];
|
|
7650
|
+
/** 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) */
|
|
7651
|
+
"filter[]"?: components["parameters"]["criteriaFilter"];
|
|
7652
|
+
/** Perform groupings over certain fields */
|
|
7653
|
+
"grouping[]"?: components["parameters"]["criteriaGrouping"];
|
|
7654
|
+
/** List of ids to search for */
|
|
7655
|
+
"ids[]"?: components["parameters"]["criteriaIds"];
|
|
7656
|
+
/** Specify the fields that should be returned for the given entities. Object key needs to be the entity name, and the list of fields needs to be the value. Fields will not be included, if they are also specified in the excludes. Note that the include fields will only be stripped on the API-Level, consider using the `fields` parameter for performance reasons. */
|
|
7657
|
+
includes?: components["parameters"]["criteriaIncludes"];
|
|
7658
|
+
/** 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. */
|
|
7659
|
+
limit?: number;
|
|
7660
|
+
/** Filter by manufacturers. List of manufacturer identifiers separated by a `|`. */
|
|
7661
|
+
manufacturer?: string;
|
|
7662
|
+
/** Filters by a maximum product price. Has to be higher than the `min-price` filter. */
|
|
7663
|
+
"max-price"?: number;
|
|
7664
|
+
/** Filters by a minimum product price. Has to be lower than the `max-price` filter. */
|
|
7665
|
+
"min-price"?: number;
|
|
7666
|
+
/** Resets all aggregations in the criteria. This parameter is a flag, the value has no effect. */
|
|
7667
|
+
"no-aggregations"?: components["parameters"]["noAggregations"];
|
|
7668
|
+
/** 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. */
|
|
7669
|
+
"only-aggregations"?: components["parameters"]["onlyAggregations"];
|
|
7670
|
+
/** 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. */
|
|
7671
|
+
order?: string;
|
|
7672
|
+
/** Search result page */
|
|
7673
|
+
p?: number;
|
|
7674
|
+
/** Search result page */
|
|
7675
|
+
page?: components["parameters"]["criteriaPage"];
|
|
7676
|
+
/** 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) */
|
|
7677
|
+
"post-filter[]"?: components["parameters"]["criteriaPostFilter"];
|
|
7678
|
+
/** Filters products by their properties. List of property identifiers separated by a `|`. */
|
|
7679
|
+
properties?: string;
|
|
7680
|
+
/** The query string to search for */
|
|
7681
|
+
query?: components["parameters"]["criteriaQuery"];
|
|
7682
|
+
/** Filter products with a minimum average rating. */
|
|
7683
|
+
rating?: number;
|
|
7684
|
+
/** 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. */
|
|
7685
|
+
"reduce-aggregations"?: string | null;
|
|
7686
|
+
/** Filters products that are marked as shipping-free. */
|
|
7687
|
+
"shipping-free"?: boolean;
|
|
7688
|
+
/** Sorting in the search result. */
|
|
7689
|
+
"sort[]"?: components["parameters"]["criteriaSort"];
|
|
7690
|
+
/** Search term */
|
|
7691
|
+
term?: components["parameters"]["criteriaTerm"];
|
|
7692
|
+
"total-count-mode"?: components["parameters"]["criteriaTotalCountMode"];
|
|
7693
|
+
};
|
|
7694
|
+
pathParams: {
|
|
7695
|
+
/** Identifier of a category. */
|
|
7696
|
+
categoryId: string;
|
|
7697
|
+
};
|
|
7698
|
+
response: components["schemas"]["ProductListingResult"];
|
|
7699
|
+
responseCode: 200;
|
|
7700
|
+
};
|
|
6638
7701
|
"readProductListing post /product-listing/{categoryId}": {
|
|
6639
7702
|
contentType?: "application/json";
|
|
6640
7703
|
accept?: "application/json";
|
|
@@ -6659,6 +7722,55 @@ export type operations = {
|
|
|
6659
7722
|
response: components["schemas"]["ProductListingResult"];
|
|
6660
7723
|
responseCode: 200;
|
|
6661
7724
|
};
|
|
7725
|
+
"readProductDetailGet get /product/{productId}": {
|
|
7726
|
+
contentType?: "application/json";
|
|
7727
|
+
accept?: "application/json";
|
|
7728
|
+
headers?: {
|
|
7729
|
+
/** Instructs Shopware to try and resolve SEO URLs for the given navigation item */
|
|
7730
|
+
"sw-include-seo-urls"?: boolean;
|
|
7731
|
+
/** Instructs Shopware to return the response in the given language. */
|
|
7732
|
+
"sw-language-id"?: string;
|
|
7733
|
+
};
|
|
7734
|
+
query?: {
|
|
7735
|
+
/** Compressed and encoded criteria object. Format: base64url(gzip(json_encode(criteria))). This parameter allows passing complex criteria as a single encoded string instead of multiple query parameters. The criteria object should be JSON-encoded, then gzipped, and finally base64url-encoded. The criteria object structure is defined in the NoneFieldsCriteria schema (see #/components/schemas/NoneFieldsCriteria). */
|
|
7736
|
+
_criteria?: components["parameters"]["CompressedNoneFieldsCriteria"];
|
|
7737
|
+
"aggregations[]"?: components["parameters"]["criteriaAggregations"];
|
|
7738
|
+
associations?: components["parameters"]["criteriaAssociations"];
|
|
7739
|
+
/** Specify the fields that should be excluded from the response for the given entities. Object key needs to be the entity name, and the list of fields needs to be the value. Note that the exclude fields will only be stripped on the API-Level, consider using the `fields` parameter for performance reasons. */
|
|
7740
|
+
excludes?: components["parameters"]["criteriaExcludes"];
|
|
7741
|
+
/** 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) */
|
|
7742
|
+
"filter[]"?: components["parameters"]["criteriaFilter"];
|
|
7743
|
+
/** Perform groupings over certain fields */
|
|
7744
|
+
"grouping[]"?: components["parameters"]["criteriaGrouping"];
|
|
7745
|
+
/** List of ids to search for */
|
|
7746
|
+
"ids[]"?: components["parameters"]["criteriaIds"];
|
|
7747
|
+
/** Specify the fields that should be returned for the given entities. Object key needs to be the entity name, and the list of fields needs to be the value. Fields will not be included, if they are also specified in the excludes. Note that the include fields will only be stripped on the API-Level, consider using the `fields` parameter for performance reasons. */
|
|
7748
|
+
includes?: components["parameters"]["criteriaIncludes"];
|
|
7749
|
+
/** Number of items per result page */
|
|
7750
|
+
limit?: components["parameters"]["criteriaLimit"];
|
|
7751
|
+
/** Search result page */
|
|
7752
|
+
page?: components["parameters"]["criteriaPage"];
|
|
7753
|
+
/** 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) */
|
|
7754
|
+
"post-filter[]"?: components["parameters"]["criteriaPostFilter"];
|
|
7755
|
+
/** The query string to search for */
|
|
7756
|
+
query?: components["parameters"]["criteriaQuery"];
|
|
7757
|
+
/** Instructs Shopware to skip loading the CMS page data */
|
|
7758
|
+
skipCmsPage?: boolean;
|
|
7759
|
+
/** Instructs Shopware to skip loading the configurator data */
|
|
7760
|
+
skipConfigurator?: boolean;
|
|
7761
|
+
/** Sorting in the search result. */
|
|
7762
|
+
"sort[]"?: components["parameters"]["criteriaSort"];
|
|
7763
|
+
/** Search term */
|
|
7764
|
+
term?: components["parameters"]["criteriaTerm"];
|
|
7765
|
+
"total-count-mode"?: components["parameters"]["criteriaTotalCountMode"];
|
|
7766
|
+
};
|
|
7767
|
+
pathParams: {
|
|
7768
|
+
/** Product ID */
|
|
7769
|
+
productId: string;
|
|
7770
|
+
};
|
|
7771
|
+
response: components["schemas"]["ProductDetailResponse"];
|
|
7772
|
+
responseCode: 200;
|
|
7773
|
+
};
|
|
6662
7774
|
"readProductDetail post /product/{productId}": {
|
|
6663
7775
|
contentType?: "application/json";
|
|
6664
7776
|
accept?: "application/json";
|
|
@@ -6684,6 +7796,22 @@ export type operations = {
|
|
|
6684
7796
|
response: components["schemas"]["ProductDetailResponse"];
|
|
6685
7797
|
responseCode: 200;
|
|
6686
7798
|
};
|
|
7799
|
+
"readProductCrossSellingsGet get /product/{productId}/cross-selling": {
|
|
7800
|
+
contentType?: "application/json";
|
|
7801
|
+
accept?: "application/json";
|
|
7802
|
+
headers?: {
|
|
7803
|
+
/** Instructs Shopware to try and resolve SEO URLs for the given navigation item */
|
|
7804
|
+
"sw-include-seo-urls"?: boolean;
|
|
7805
|
+
/** Instructs Shopware to return the response in the given language. */
|
|
7806
|
+
"sw-language-id"?: string;
|
|
7807
|
+
};
|
|
7808
|
+
pathParams: {
|
|
7809
|
+
/** Product ID */
|
|
7810
|
+
productId: string;
|
|
7811
|
+
};
|
|
7812
|
+
response: components["schemas"]["CrossSellingElementCollection"];
|
|
7813
|
+
responseCode: 200;
|
|
7814
|
+
};
|
|
6687
7815
|
"readProductCrossSellings post /product/{productId}/cross-selling": {
|
|
6688
7816
|
contentType?: "application/json";
|
|
6689
7817
|
accept?: "application/json";
|
|
@@ -6700,6 +7828,26 @@ export type operations = {
|
|
|
6700
7828
|
response: components["schemas"]["CrossSellingElementCollection"];
|
|
6701
7829
|
responseCode: 200;
|
|
6702
7830
|
};
|
|
7831
|
+
"searchProductVariantIdsGet get /product/{productId}/find-variant": {
|
|
7832
|
+
contentType?: "application/json";
|
|
7833
|
+
accept?: "application/json";
|
|
7834
|
+
headers?: {
|
|
7835
|
+
/** Instructs Shopware to return the response in the given language. */
|
|
7836
|
+
"sw-language-id"?: string;
|
|
7837
|
+
};
|
|
7838
|
+
query: {
|
|
7839
|
+
/** The options parameter for the variant to find. Array of option IDs. */
|
|
7840
|
+
"options[]": string[];
|
|
7841
|
+
/** The id of the option group that has been switched. */
|
|
7842
|
+
switchedGroup?: string;
|
|
7843
|
+
};
|
|
7844
|
+
pathParams: {
|
|
7845
|
+
/** Product ID */
|
|
7846
|
+
productId: string;
|
|
7847
|
+
};
|
|
7848
|
+
response: components["schemas"]["FindProductVariantRouteResponse"];
|
|
7849
|
+
responseCode: 200;
|
|
7850
|
+
};
|
|
6703
7851
|
"searchProductVariantIds post /product/{productId}/find-variant": {
|
|
6704
7852
|
contentType?: "application/json";
|
|
6705
7853
|
accept?: "application/json";
|
|
@@ -6752,6 +7900,53 @@ export type operations = {
|
|
|
6752
7900
|
response: never;
|
|
6753
7901
|
responseCode: 200;
|
|
6754
7902
|
};
|
|
7903
|
+
"readProductReviewsGet get /product/{productId}/reviews": {
|
|
7904
|
+
contentType?: "application/json";
|
|
7905
|
+
accept?: "application/json";
|
|
7906
|
+
headers?: {
|
|
7907
|
+
/** Instructs Shopware to return the response in the given language. */
|
|
7908
|
+
"sw-language-id"?: string;
|
|
7909
|
+
};
|
|
7910
|
+
query?: {
|
|
7911
|
+
/** Compressed and encoded criteria object. Format: base64url(gzip(json_encode(criteria))). This parameter allows passing complex criteria as a single encoded string instead of multiple query parameters. The criteria object should be JSON-encoded, then gzipped, and finally base64url-encoded. The criteria object structure is defined in the Criteria schema (see #/components/schemas/Criteria). */
|
|
7912
|
+
_criteria?: components["parameters"]["CompressedCriteria"];
|
|
7913
|
+
"aggregations[]"?: components["parameters"]["criteriaAggregations"];
|
|
7914
|
+
associations?: components["parameters"]["criteriaAssociations"];
|
|
7915
|
+
/** Specify the fields that should be excluded from the response for the given entities. Object key needs to be the entity name, and the list of fields needs to be the value. Note that the exclude fields will only be stripped on the API-Level, consider using the `fields` parameter for performance reasons. */
|
|
7916
|
+
excludes?: components["parameters"]["criteriaExcludes"];
|
|
7917
|
+
/** Fields which should be returned in the search result. */
|
|
7918
|
+
"fields[]"?: components["parameters"]["criteriaFields"];
|
|
7919
|
+
/** 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) */
|
|
7920
|
+
"filter[]"?: components["parameters"]["criteriaFilter"];
|
|
7921
|
+
/** Perform groupings over certain fields */
|
|
7922
|
+
"grouping[]"?: components["parameters"]["criteriaGrouping"];
|
|
7923
|
+
/** List of ids to search for */
|
|
7924
|
+
"ids[]"?: components["parameters"]["criteriaIds"];
|
|
7925
|
+
/** Specify the fields that should be returned for the given entities. Object key needs to be the entity name, and the list of fields needs to be the value. Fields will not be included, if they are also specified in the excludes. Note that the include fields will only be stripped on the API-Level, consider using the `fields` parameter for performance reasons. */
|
|
7926
|
+
includes?: components["parameters"]["criteriaIncludes"];
|
|
7927
|
+
/** Number of items per result page */
|
|
7928
|
+
limit?: components["parameters"]["criteriaLimit"];
|
|
7929
|
+
/** Search result page */
|
|
7930
|
+
page?: components["parameters"]["criteriaPage"];
|
|
7931
|
+
/** 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) */
|
|
7932
|
+
"post-filter[]"?: components["parameters"]["criteriaPostFilter"];
|
|
7933
|
+
/** The query string to search for */
|
|
7934
|
+
query?: components["parameters"]["criteriaQuery"];
|
|
7935
|
+
/** Sorting in the search result. */
|
|
7936
|
+
"sort[]"?: components["parameters"]["criteriaSort"];
|
|
7937
|
+
/** Search term */
|
|
7938
|
+
term?: components["parameters"]["criteriaTerm"];
|
|
7939
|
+
"total-count-mode"?: components["parameters"]["criteriaTotalCountMode"];
|
|
7940
|
+
};
|
|
7941
|
+
pathParams: {
|
|
7942
|
+
/** Identifier of the product. */
|
|
7943
|
+
productId: string;
|
|
7944
|
+
};
|
|
7945
|
+
response: {
|
|
7946
|
+
elements?: components["schemas"]["ProductReview"][];
|
|
7947
|
+
} & components["schemas"]["EntitySearchResult"];
|
|
7948
|
+
responseCode: 200;
|
|
7949
|
+
};
|
|
6755
7950
|
"readProductReviews post /product/{productId}/reviews": {
|
|
6756
7951
|
contentType?: "application/json";
|
|
6757
7952
|
accept?: "application/json";
|
|
@@ -6779,6 +7974,8 @@ export type operations = {
|
|
|
6779
7974
|
"sw-language-id"?: string;
|
|
6780
7975
|
};
|
|
6781
7976
|
query?: {
|
|
7977
|
+
/** Compressed and encoded criteria object. Format: base64url(gzip(json_encode(criteria))). This parameter allows passing complex criteria as a single encoded string instead of multiple query parameters. The criteria object should be JSON-encoded, then gzipped, and finally base64url-encoded. The criteria object structure is defined in the Criteria schema (see #/components/schemas/Criteria). */
|
|
7978
|
+
_criteria?: components["parameters"]["CompressedCriteria"];
|
|
6782
7979
|
"aggregations[]"?: components["parameters"]["criteriaAggregations"];
|
|
6783
7980
|
associations?: components["parameters"]["criteriaAssociations"];
|
|
6784
7981
|
/** Specify the fields that should be excluded from the response for the given entities. Object key needs to be the entity name, and the list of fields needs to be the value. Note that the exclude fields will only be stripped on the API-Level, consider using the `fields` parameter for performance reasons. */
|
|
@@ -6897,6 +8094,71 @@ export type operations = {
|
|
|
6897
8094
|
response: never;
|
|
6898
8095
|
responseCode: 204;
|
|
6899
8096
|
};
|
|
8097
|
+
"searchPageGet get /search": {
|
|
8098
|
+
contentType?: "application/json";
|
|
8099
|
+
accept?: "application/json";
|
|
8100
|
+
headers?: {
|
|
8101
|
+
/** Instructs Shopware to try and resolve SEO URLs for the given navigation item */
|
|
8102
|
+
"sw-include-seo-urls"?: boolean;
|
|
8103
|
+
/** Instructs Shopware to return the response in the given language. */
|
|
8104
|
+
"sw-language-id"?: string;
|
|
8105
|
+
};
|
|
8106
|
+
query?: {
|
|
8107
|
+
"aggregations[]"?: components["parameters"]["criteriaAggregations"];
|
|
8108
|
+
associations?: components["parameters"]["criteriaAssociations"];
|
|
8109
|
+
/** Specify the fields that should be excluded from the response for the given entities. Object key needs to be the entity name, and the list of fields needs to be the value. Note that the exclude fields will only be stripped on the API-Level, consider using the `fields` parameter for performance reasons. */
|
|
8110
|
+
excludes?: components["parameters"]["criteriaExcludes"];
|
|
8111
|
+
/** Fields which should be returned in the search result. */
|
|
8112
|
+
"fields[]"?: components["parameters"]["criteriaFields"];
|
|
8113
|
+
/** 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) */
|
|
8114
|
+
"filter[]"?: components["parameters"]["criteriaFilter"];
|
|
8115
|
+
/** Perform groupings over certain fields */
|
|
8116
|
+
"grouping[]"?: components["parameters"]["criteriaGrouping"];
|
|
8117
|
+
/** List of ids to search for */
|
|
8118
|
+
"ids[]"?: components["parameters"]["criteriaIds"];
|
|
8119
|
+
/** Specify the fields that should be returned for the given entities. Object key needs to be the entity name, and the list of fields needs to be the value. Fields will not be included, if they are also specified in the excludes. Note that the include fields will only be stripped on the API-Level, consider using the `fields` parameter for performance reasons. */
|
|
8120
|
+
includes?: components["parameters"]["criteriaIncludes"];
|
|
8121
|
+
/** 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. */
|
|
8122
|
+
limit?: number;
|
|
8123
|
+
/** Filter by manufacturers. List of manufacturer identifiers separated by a `|`. */
|
|
8124
|
+
manufacturer?: string;
|
|
8125
|
+
/** Filters by a maximum product price. Has to be higher than the `min-price` filter. */
|
|
8126
|
+
"max-price"?: number;
|
|
8127
|
+
/** Filters by a minimum product price. Has to be lower than the `max-price` filter. */
|
|
8128
|
+
"min-price"?: number;
|
|
8129
|
+
/** Resets all aggregations in the criteria. This parameter is a flag, the value has no effect. */
|
|
8130
|
+
"no-aggregations"?: components["parameters"]["noAggregations"];
|
|
8131
|
+
/** 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. */
|
|
8132
|
+
"only-aggregations"?: components["parameters"]["onlyAggregations"];
|
|
8133
|
+
/** 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. */
|
|
8134
|
+
order?: string;
|
|
8135
|
+
/** Search result page */
|
|
8136
|
+
p?: number;
|
|
8137
|
+
/** Search result page */
|
|
8138
|
+
page?: components["parameters"]["criteriaPage"];
|
|
8139
|
+
/** 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) */
|
|
8140
|
+
"post-filter[]"?: components["parameters"]["criteriaPostFilter"];
|
|
8141
|
+
/** Filters products by their properties. List of property identifiers separated by a `|`. */
|
|
8142
|
+
properties?: string;
|
|
8143
|
+
/** The query string to search for */
|
|
8144
|
+
query?: components["parameters"]["criteriaQuery"];
|
|
8145
|
+
/** Filter products with a minimum average rating. */
|
|
8146
|
+
rating?: number;
|
|
8147
|
+
/** 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. */
|
|
8148
|
+
"reduce-aggregations"?: string | null;
|
|
8149
|
+
/** 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. */
|
|
8150
|
+
search?: string;
|
|
8151
|
+
/** Filters products that are marked as shipping-free. */
|
|
8152
|
+
"shipping-free"?: boolean;
|
|
8153
|
+
/** Sorting in the search result. */
|
|
8154
|
+
"sort[]"?: components["parameters"]["criteriaSort"];
|
|
8155
|
+
/** Search term */
|
|
8156
|
+
term?: components["parameters"]["criteriaTerm"];
|
|
8157
|
+
"total-count-mode"?: components["parameters"]["criteriaTotalCountMode"];
|
|
8158
|
+
};
|
|
8159
|
+
response: components["schemas"]["ProductListingResult"];
|
|
8160
|
+
responseCode: 200;
|
|
8161
|
+
};
|
|
6900
8162
|
"searchPage post /search": {
|
|
6901
8163
|
contentType?: "application/json";
|
|
6902
8164
|
accept?: "application/json";
|
|
@@ -6920,6 +8182,69 @@ export type operations = {
|
|
|
6920
8182
|
response: components["schemas"]["ProductListingResult"];
|
|
6921
8183
|
responseCode: 200;
|
|
6922
8184
|
};
|
|
8185
|
+
"searchSuggestGet get /search-suggest": {
|
|
8186
|
+
contentType?: "application/json";
|
|
8187
|
+
accept?: "application/json";
|
|
8188
|
+
headers?: {
|
|
8189
|
+
/** Instructs Shopware to return the response in the given language. */
|
|
8190
|
+
"sw-language-id"?: string;
|
|
8191
|
+
};
|
|
8192
|
+
query: {
|
|
8193
|
+
"aggregations[]"?: components["parameters"]["criteriaAggregations"];
|
|
8194
|
+
associations?: components["parameters"]["criteriaAssociations"];
|
|
8195
|
+
/** Specify the fields that should be excluded from the response for the given entities. Object key needs to be the entity name, and the list of fields needs to be the value. Note that the exclude fields will only be stripped on the API-Level, consider using the `fields` parameter for performance reasons. */
|
|
8196
|
+
excludes?: components["parameters"]["criteriaExcludes"];
|
|
8197
|
+
/** Fields which should be returned in the search result. */
|
|
8198
|
+
"fields[]"?: components["parameters"]["criteriaFields"];
|
|
8199
|
+
/** 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) */
|
|
8200
|
+
"filter[]"?: components["parameters"]["criteriaFilter"];
|
|
8201
|
+
/** Perform groupings over certain fields */
|
|
8202
|
+
"grouping[]"?: components["parameters"]["criteriaGrouping"];
|
|
8203
|
+
/** List of ids to search for */
|
|
8204
|
+
"ids[]"?: components["parameters"]["criteriaIds"];
|
|
8205
|
+
/** Specify the fields that should be returned for the given entities. Object key needs to be the entity name, and the list of fields needs to be the value. Fields will not be included, if they are also specified in the excludes. Note that the include fields will only be stripped on the API-Level, consider using the `fields` parameter for performance reasons. */
|
|
8206
|
+
includes?: components["parameters"]["criteriaIncludes"];
|
|
8207
|
+
/** 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. */
|
|
8208
|
+
limit?: number;
|
|
8209
|
+
/** Filter by manufacturers. List of manufacturer identifiers separated by a `|`. */
|
|
8210
|
+
manufacturer?: string;
|
|
8211
|
+
/** Filters by a maximum product price. Has to be higher than the `min-price` filter. */
|
|
8212
|
+
"max-price"?: number;
|
|
8213
|
+
/** Filters by a minimum product price. Has to be lower than the `max-price` filter. */
|
|
8214
|
+
"min-price"?: number;
|
|
8215
|
+
/** Resets all aggregations in the criteria. This parameter is a flag, the value has no effect. */
|
|
8216
|
+
"no-aggregations"?: components["parameters"]["noAggregations"];
|
|
8217
|
+
/** 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. */
|
|
8218
|
+
"only-aggregations"?: components["parameters"]["onlyAggregations"];
|
|
8219
|
+
/** 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. */
|
|
8220
|
+
order?: string;
|
|
8221
|
+
/** Search result page */
|
|
8222
|
+
p?: number;
|
|
8223
|
+
/** Search result page */
|
|
8224
|
+
page?: components["parameters"]["criteriaPage"];
|
|
8225
|
+
/** 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) */
|
|
8226
|
+
"post-filter[]"?: components["parameters"]["criteriaPostFilter"];
|
|
8227
|
+
/** Filters products by their properties. List of property identifiers separated by a `|`. */
|
|
8228
|
+
properties?: string;
|
|
8229
|
+
/** The query string to search for */
|
|
8230
|
+
query?: components["parameters"]["criteriaQuery"];
|
|
8231
|
+
/** Filter products with a minimum average rating. */
|
|
8232
|
+
rating?: number;
|
|
8233
|
+
/** 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. */
|
|
8234
|
+
"reduce-aggregations"?: string | null;
|
|
8235
|
+
/** 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. */
|
|
8236
|
+
search: string;
|
|
8237
|
+
/** Filters products that are marked as shipping-free. */
|
|
8238
|
+
"shipping-free"?: boolean;
|
|
8239
|
+
/** Sorting in the search result. */
|
|
8240
|
+
"sort[]"?: components["parameters"]["criteriaSort"];
|
|
8241
|
+
/** Search term */
|
|
8242
|
+
term?: components["parameters"]["criteriaTerm"];
|
|
8243
|
+
"total-count-mode"?: components["parameters"]["criteriaTotalCountMode"];
|
|
8244
|
+
};
|
|
8245
|
+
response: components["schemas"]["ProductListingResult"];
|
|
8246
|
+
responseCode: 200;
|
|
8247
|
+
};
|
|
6923
8248
|
"searchSuggest post /search-suggest": {
|
|
6924
8249
|
contentType?: "application/json";
|
|
6925
8250
|
accept?: "application/json";
|
|
@@ -6949,6 +8274,8 @@ export type operations = {
|
|
|
6949
8274
|
"sw-language-id"?: string;
|
|
6950
8275
|
};
|
|
6951
8276
|
query?: {
|
|
8277
|
+
/** Compressed and encoded criteria object. Format: base64url(gzip(json_encode(criteria))). This parameter allows passing complex criteria as a single encoded string instead of multiple query parameters. The criteria object should be JSON-encoded, then gzipped, and finally base64url-encoded. The criteria object structure is defined in the Criteria schema (see #/components/schemas/Criteria). */
|
|
8278
|
+
_criteria?: components["parameters"]["CompressedCriteria"];
|
|
6952
8279
|
"aggregations[]"?: components["parameters"]["criteriaAggregations"];
|
|
6953
8280
|
associations?: components["parameters"]["criteriaAssociations"];
|
|
6954
8281
|
/** Specify the fields that should be excluded from the response for the given entities. Object key needs to be the entity name, and the list of fields needs to be the value. Note that the exclude fields will only be stripped on the API-Level, consider using the `fields` parameter for performance reasons. */
|
|
@@ -7005,6 +8332,8 @@ export type operations = {
|
|
|
7005
8332
|
"sw-language-id"?: string;
|
|
7006
8333
|
};
|
|
7007
8334
|
query?: {
|
|
8335
|
+
/** Compressed and encoded criteria object. Format: base64url(gzip(json_encode(criteria))). This parameter allows passing complex criteria as a single encoded string instead of multiple query parameters. The criteria object should be JSON-encoded, then gzipped, and finally base64url-encoded. The criteria object structure is defined in the Criteria schema (see #/components/schemas/Criteria). */
|
|
8336
|
+
_criteria?: components["parameters"]["CompressedCriteria"];
|
|
7008
8337
|
"aggregations[]"?: components["parameters"]["criteriaAggregations"];
|
|
7009
8338
|
associations?: components["parameters"]["criteriaAssociations"];
|
|
7010
8339
|
/** Specify the fields that should be excluded from the response for the given entities. Object key needs to be the entity name, and the list of fields needs to be the value. Note that the exclude fields will only be stripped on the API-Level, consider using the `fields` parameter for performance reasons. */
|
|
@@ -7083,6 +8412,12 @@ export type operations = {
|
|
|
7083
8412
|
response: components["schemas"]["HolidayStruct"];
|
|
7084
8413
|
responseCode: 200;
|
|
7085
8414
|
};
|
|
8415
|
+
"shopbite.multi-channel-group.get get /shopbite/multi-channel-group": {
|
|
8416
|
+
contentType?: "application/json";
|
|
8417
|
+
accept?: "application/json";
|
|
8418
|
+
response: components["schemas"]["MultiChannelGroupStruct"];
|
|
8419
|
+
responseCode: 200;
|
|
8420
|
+
};
|
|
7086
8421
|
"readSitemap get /sitemap": {
|
|
7087
8422
|
contentType?: "application/json";
|
|
7088
8423
|
accept?: "application/json";
|