@commercetools-frontend/application-shell 22.30.2 → 22.31.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.
Files changed (90) hide show
  1. package/dist/{application-entry-point-2365588d.esm.js → application-entry-point-44f059a0.esm.js} +3 -3
  2. package/dist/{application-entry-point-257a1cbc.cjs.prod.js → application-entry-point-654951a6.cjs.prod.js} +2 -2
  3. package/dist/{application-entry-point-a403a123.cjs.dev.js → application-entry-point-c2f77f23.cjs.dev.js} +3 -3
  4. package/dist/commercetools-frontend-application-shell.cjs.dev.js +11 -5
  5. package/dist/commercetools-frontend-application-shell.cjs.prod.js +11 -5
  6. package/dist/commercetools-frontend-application-shell.esm.js +5 -5
  7. package/dist/{custom-view-dev-host-2dbeffde.cjs.dev.js → custom-view-dev-host-1ef244b8.cjs.dev.js} +12 -16
  8. package/dist/{custom-view-dev-host-54b19a22.esm.js → custom-view-dev-host-83d6228b.esm.js} +12 -15
  9. package/dist/{custom-view-dev-host-55efb1ea.cjs.prod.js → custom-view-dev-host-9469b02c.cjs.prod.js} +12 -16
  10. package/dist/declarations/src/components/application-page-title/application-page-title.d.ts +16 -0
  11. package/dist/declarations/src/components/application-shell/application-shell.d.ts +17 -0
  12. package/dist/declarations/src/components/application-shell-authenticated/application-shell-authenticated.d.ts +4 -0
  13. package/dist/declarations/src/components/workspaces-navigation-button/index.d.ts +1 -0
  14. package/dist/declarations/src/components/workspaces-navigation-button/messages.d.ts +8 -0
  15. package/dist/declarations/src/components/workspaces-navigation-button/workspaces-navigation-button.d.ts +3 -0
  16. package/dist/declarations/src/configure-store.d.ts +3 -0
  17. package/dist/declarations/src/hooks/use-routes-creator/use-routes-creator.d.ts +3 -0
  18. package/dist/declarations/src/index.d.ts +16 -1
  19. package/dist/declarations/src/types/generated/ctp.d.ts +562 -0
  20. package/dist/declarations/src/types/generated/mc.d.ts +5 -0
  21. package/dist/declarations/src/types/generated/proxy.d.ts +3 -0
  22. package/dist/declarations/src/types/generated/settings.d.ts +22 -0
  23. package/dist/declarations/src/utils/get-mc-origin/get-mc-origin.d.ts +16 -0
  24. package/dist/{index-055ebc13.cjs.prod.js → index-91985d64.cjs.prod.js} +2 -2
  25. package/dist/{index-ca28cb0d.esm.js → index-9475648a.esm.js} +185 -154
  26. package/dist/{index-ca730730.cjs.dev.js → index-b1476d46.cjs.dev.js} +2 -2
  27. package/dist/{index-4e5248df.esm.js → index-b6081c20.esm.js} +2 -2
  28. package/dist/{index-8974720c.cjs.dev.js → index-bd1c5108.cjs.dev.js} +190 -153
  29. package/dist/{index-176564c3.cjs.prod.js → index-ff4b1f1e.cjs.prod.js} +175 -144
  30. package/dist/{navbar-e3ee2a76.esm.js → navbar-18ab9da8.esm.js} +80 -97
  31. package/dist/{navbar-ced649a9.cjs.prod.js → navbar-32ad8010.cjs.prod.js} +80 -98
  32. package/dist/{navbar-f981de75.cjs.dev.js → navbar-4068efee.cjs.dev.js} +80 -98
  33. package/dist/oidc-6c6599a2.cjs.dev.js +98 -0
  34. package/dist/oidc-8275c04f.esm.js +84 -0
  35. package/dist/{oidc-callback-b6c08a0a.cjs.prod.js → oidc-callback-365669c2.cjs.prod.js} +11 -12
  36. package/dist/{oidc-callback-394ce33e.cjs.dev.js → oidc-callback-910e1e1c.cjs.dev.js} +11 -12
  37. package/dist/{oidc-callback-96d0d22a.esm.js → oidc-callback-a622f3a5.esm.js} +11 -12
  38. package/dist/oidc-d02d4ab8.cjs.prod.js +98 -0
  39. package/dist/{project-container-d690330d.cjs.prod.js → project-container-4cc1a369.cjs.prod.js} +15 -17
  40. package/dist/{project-container-4c04ecd0.cjs.dev.js → project-container-ba49f3db.cjs.dev.js} +15 -17
  41. package/dist/{project-container-66355b01.esm.js → project-container-edb85c22.esm.js} +15 -17
  42. package/dist/{project-expired-e9d9a604.cjs.dev.js → project-expired-378bcfb0.cjs.dev.js} +8 -8
  43. package/dist/{project-expired-6f0e2ae2.cjs.prod.js → project-expired-59d50031.cjs.prod.js} +8 -8
  44. package/dist/{project-expired-4768f135.esm.js → project-expired-ef791516.esm.js} +8 -8
  45. package/dist/{project-not-found-dcc624b2.cjs.dev.js → project-not-found-543b8e4f.cjs.dev.js} +7 -7
  46. package/dist/{project-not-found-06f0f8b0.cjs.prod.js → project-not-found-a7faf93c.cjs.prod.js} +7 -7
  47. package/dist/{project-not-found-412af385.esm.js → project-not-found-bc7cea0c.esm.js} +7 -7
  48. package/dist/{project-not-initialized-dcb97eb4.esm.js → project-not-initialized-88376a4a.esm.js} +8 -8
  49. package/dist/{project-not-initialized-702e4e28.cjs.dev.js → project-not-initialized-a9c3afa0.cjs.dev.js} +8 -8
  50. package/dist/{project-not-initialized-610860be.cjs.prod.js → project-not-initialized-e9560ddb.cjs.prod.js} +8 -8
  51. package/dist/{project-suspended-ab653b2d.cjs.prod.js → project-suspended-0686fc53.cjs.prod.js} +7 -7
  52. package/dist/{project-suspended-40040cb1.cjs.dev.js → project-suspended-5cc4bc59.cjs.dev.js} +7 -7
  53. package/dist/{project-suspended-50e15143.esm.js → project-suspended-8fa0b06e.esm.js} +7 -7
  54. package/dist/{quick-access-438951ba.cjs.dev.js → quick-access-3479fec8.cjs.dev.js} +204 -133
  55. package/dist/{quick-access-8efb79f3.esm.js → quick-access-72e35fc8.esm.js} +204 -132
  56. package/dist/{quick-access-0d122c64.cjs.prod.js → quick-access-96ea968d.cjs.prod.js} +204 -133
  57. package/dist/{redirect-to-login-3ebce35d.cjs.dev.js → redirect-to-login-32ebe009.cjs.dev.js} +10 -13
  58. package/dist/{redirect-to-login-3c5a3f4a.cjs.prod.js → redirect-to-login-60a00442.cjs.prod.js} +10 -13
  59. package/dist/{redirect-to-login-af9860c8.esm.js → redirect-to-login-b69fb5ce.esm.js} +10 -13
  60. package/dist/{redirect-to-logout-7b30e94c.esm.js → redirect-to-logout-4ee944fa.esm.js} +9 -10
  61. package/dist/{redirect-to-logout-1fa97ad0.cjs.prod.js → redirect-to-logout-d017b04b.cjs.prod.js} +9 -10
  62. package/dist/{redirect-to-logout-78fabe18.cjs.dev.js → redirect-to-logout-edf8d35c.cjs.dev.js} +9 -10
  63. package/dist/{redirector-0a16c1d1.cjs.prod.js → redirector-01f35da8.cjs.prod.js} +3 -4
  64. package/dist/{redirector-d2fd2b5e.esm.js → redirector-76670a54.esm.js} +3 -4
  65. package/dist/{redirector-e58b9bc3.cjs.dev.js → redirector-98dfc5f0.cjs.dev.js} +3 -4
  66. package/dist/{requests-in-flight-loader-04924584.cjs.dev.js → requests-in-flight-loader-0a78e347.cjs.dev.js} +7 -7
  67. package/dist/{requests-in-flight-loader-ef8411a8.cjs.prod.js → requests-in-flight-loader-61257a90.cjs.prod.js} +7 -7
  68. package/dist/{requests-in-flight-loader-020da4f3.esm.js → requests-in-flight-loader-efda7302.esm.js} +7 -7
  69. package/dist/{service-page-project-switcher-893c4acc.cjs.prod.js → service-page-project-switcher-9310d282.cjs.prod.js} +1 -1
  70. package/dist/{service-page-project-switcher-550025cd.cjs.dev.js → service-page-project-switcher-ae1cd6fa.cjs.dev.js} +1 -1
  71. package/dist/{service-page-project-switcher-eec5d6be.esm.js → service-page-project-switcher-fb693a35.esm.js} +1 -1
  72. package/dist/{use-applications-menu-2fe3d465.cjs.dev.js → use-applications-menu-222b9106.cjs.prod.js} +40 -49
  73. package/dist/{use-applications-menu-0d3f4ffc.cjs.prod.js → use-applications-menu-302a0ac8.cjs.dev.js} +40 -49
  74. package/dist/{use-applications-menu-03759eab.esm.js → use-applications-menu-b583e9c3.esm.js} +38 -46
  75. package/dist/{user-settings-menu-bbc43c88.cjs.dev.js → user-settings-menu-7c17f227.cjs.dev.js} +22 -29
  76. package/dist/{user-settings-menu-3f86267c.cjs.prod.js → user-settings-menu-8bba9f50.cjs.prod.js} +22 -29
  77. package/dist/{user-settings-menu-36bea559.esm.js → user-settings-menu-ff4a6c63.esm.js} +22 -29
  78. package/dist/{version-tracker-7cce73f6.cjs.dev.js → version-tracker-54afa816.cjs.dev.js} +6 -6
  79. package/dist/{version-tracker-1ca99690.cjs.prod.js → version-tracker-5aea360a.cjs.prod.js} +6 -6
  80. package/dist/{version-tracker-610f66eb.esm.js → version-tracker-935e29c6.esm.js} +6 -6
  81. package/package.json +32 -31
  82. package/ssr/dist/commercetools-frontend-application-shell-ssr.cjs.dev.js +1 -2
  83. package/ssr/dist/commercetools-frontend-application-shell-ssr.cjs.prod.js +1 -2
  84. package/ssr/dist/commercetools-frontend-application-shell-ssr.esm.js +1 -2
  85. package/test-utils/dist/commercetools-frontend-application-shell-test-utils.cjs.dev.js +21 -26
  86. package/test-utils/dist/commercetools-frontend-application-shell-test-utils.cjs.prod.js +21 -26
  87. package/test-utils/dist/commercetools-frontend-application-shell-test-utils.esm.js +16 -20
  88. package/dist/oidc-63e926e1.cjs.dev.js +0 -115
  89. package/dist/oidc-cfa56c46.cjs.prod.js +0 -115
  90. package/dist/oidc-ff53dfd3.esm.js +0 -100
@@ -11,6 +11,7 @@ export type MakeOptional<T, K extends keyof T> = Omit<T, K> & {
11
11
  export type MakeMaybe<T, K extends keyof T> = Omit<T, K> & {
12
12
  [SubKey in K]: Maybe<T[SubKey]>;
13
13
  };
14
+ /** All built-in and custom scalars, mapped to their actual values */
14
15
  export type Scalars = {
15
16
  ID: string;
16
17
  String: string;
@@ -34,6 +35,7 @@ export type Scalars = {
34
35
  Time: string;
35
36
  YearMonth: string;
36
37
  };
38
+ /** API Clients can be used to obtain OAuth 2 access tokens. The secret is only shown once in the response of creating the API Client. */
37
39
  export type TApiClientWithSecret = {
38
40
  __typename?: 'APIClientWithSecret';
39
41
  accessTokenValiditySeconds?: Maybe<Scalars['Int']>;
@@ -46,6 +48,7 @@ export type TApiClientWithSecret = {
46
48
  scope: Scalars['String'];
47
49
  secret: Scalars['String'];
48
50
  };
51
+ /** API Clients can be used to obtain OAuth 2 access tokens */
49
52
  export type TApiClientWithoutSecret = {
50
53
  __typename?: 'APIClientWithoutSecret';
51
54
  accessTokenValiditySeconds?: Maybe<Scalars['Int']>;
@@ -89,6 +92,7 @@ export declare enum TActionType {
89
92
  Create = "Create",
90
93
  Update = "Update"
91
94
  }
95
+ /** A field to access the active cart. */
92
96
  export type TActiveCartInterface = {
93
97
  activeCart?: Maybe<TCart>;
94
98
  };
@@ -496,6 +500,7 @@ export type TAddTypeLocalizedEnumValue = {
496
500
  export type TAddZoneLocation = {
497
501
  location: TZoneLocation;
498
502
  };
503
+ /** An address represents a postal address. */
499
504
  export type TAddress = {
500
505
  __typename?: 'Address';
501
506
  additionalAddressInfo?: Maybe<Scalars['String']>;
@@ -583,7 +588,17 @@ export type TAddressInput = {
583
588
  title?: InputMaybe<Scalars['String']>;
584
589
  };
585
590
  export declare enum TAnonymousCartSignInMode {
591
+ /**
592
+ * `LineItem`s of the anonymous cart will be copied to the customer’s active cart that has been modified most recently.
593
+ *
594
+ * The `CartState` of the anonymous cart gets changed to `Merged` while the `CartState` of the customer’s cart remains `Active`.
595
+ *
596
+ * `CustomLineItems` and `CustomFields` of the anonymous cart will not be copied to the customers cart.
597
+ *
598
+ * If a `LineItem` in the anonymous cart matches an existing line item in the customer’s cart (same product ID and variant ID), the maximum quantity of both LineItems is used as the new quantity. In that case `CustomFields` on the `LineItem` of the anonymous cart will not be in the resulting `LineItem`.
599
+ */
586
600
  MergeWithExistingCustomerCart = "MergeWithExistingCustomerCart",
601
+ /** The anonymous cart is used as new active customer cart. No `LineItem`s get merged. */
587
602
  UseAsNewActiveCustomerCart = "UseAsNewActiveCustomerCart"
588
603
  }
589
604
  export type TApplied = TOrderEditResult & {
@@ -1042,9 +1057,13 @@ export type TAttribute = {
1042
1057
  name: Scalars['String'];
1043
1058
  };
1044
1059
  export declare enum TAttributeConstraint {
1060
+ /** A set of attributes, that have this constraint, should have different combinations in each variant */
1045
1061
  CombinationUnique = "CombinationUnique",
1062
+ /** No constraints are applied to the attribute */
1046
1063
  None = "None",
1064
+ /** Attribute value should be the same in all variants */
1047
1065
  SameForAll = "SameForAll",
1066
+ /** Attribute value should be different in each variant */
1048
1067
  Unique = "Unique"
1049
1068
  }
1050
1069
  export type TAttributeDefinition = {
@@ -1085,6 +1104,7 @@ export type TAttributeDefinitionResult = {
1085
1104
  results: Array<TAttributeDefinition>;
1086
1105
  total: Scalars['Int'];
1087
1106
  };
1107
+ /** (https://docs.commercetools.com/api/projects/productTypes#attributetype)[https://docs.commercetools.com/api/projects/productTypes#attributetype] */
1088
1108
  export type TAttributeDefinitionType = {
1089
1109
  name: Scalars['String'];
1090
1110
  };
@@ -1189,6 +1209,7 @@ export declare enum TAttributionSource {
1189
1209
  Export = "Export",
1190
1210
  Import = "Import"
1191
1211
  }
1212
+ /** AuthenticationMode values. */
1192
1213
  export declare enum TAuthenticationMode {
1193
1214
  ExternalAuth = "ExternalAuth",
1194
1215
  Password = "Password"
@@ -1256,6 +1277,7 @@ export type TBooleanType = TFieldType & {
1256
1277
  export type TBusinessUnit = TReferenceExpandable & TVersioned & {
1257
1278
  __typename?: 'BusinessUnit';
1258
1279
  addresses: Array<TAddress>;
1280
+ /** This field contains the BusinessUnits KeyReferences from the Company to the parent Division of this BusinessUnit in that order. */
1259
1281
  ancestors: Array<TBusinessUnit>;
1260
1282
  approvalRuleMode?: Maybe<TBusinessUnitApprovalRuleMode>;
1261
1283
  associateMode: TBusinessUnitAssociateMode;
@@ -1272,6 +1294,7 @@ export type TBusinessUnit = TReferenceExpandable & TVersioned & {
1272
1294
  defaultShippingAddressId?: Maybe<Scalars['String']>;
1273
1295
  id: Scalars['String'];
1274
1296
  inheritedAssociates?: Maybe<Array<TInheritedAssociate>>;
1297
+ /** This field contains the inherited stores from its parentUnit if storeMode is set to FromParent. */
1275
1298
  inheritedStores?: Maybe<Array<TInheritedStore>>;
1276
1299
  key: Scalars['String'];
1277
1300
  lastModifiedAt: Scalars['DateTime'];
@@ -1386,7 +1409,9 @@ export type TBusinessUnitBillingAddressRemoved = TMessagePayload & {
1386
1409
  };
1387
1410
  export type TBusinessUnitConfiguration = {
1388
1411
  __typename?: 'BusinessUnitConfiguration';
1412
+ /** BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta */
1389
1413
  myBusinessUnitAssociateRoleOnCreation?: Maybe<TAssociateRole>;
1414
+ /** BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta */
1390
1415
  myBusinessUnitAssociateRoleOnCreationRef?: Maybe<TKeyReference>;
1391
1416
  myBusinessUnitStatusOnCreation: TBusinessUnitConfigurationStatus;
1392
1417
  };
@@ -1452,14 +1477,18 @@ export type TBusinessUnitDraft = {
1452
1477
  approvalRuleMode?: InputMaybe<TBusinessUnitApprovalRuleMode>;
1453
1478
  associateMode?: InputMaybe<TBusinessUnitAssociateMode>;
1454
1479
  associates?: InputMaybe<Array<TAssociateDraft>>;
1480
+ /** The indices of the billing addresses in the `addresses` list. The `billingAddressIds` of the customer will be set to the IDs of that addresses. */
1455
1481
  billingAddresses?: InputMaybe<Array<Scalars['Int']>>;
1456
1482
  contactEmail?: InputMaybe<Scalars['String']>;
1457
1483
  custom?: InputMaybe<TCustomFieldsDraft>;
1484
+ /** The index of the address in the `addresses` list. The `defaultBillingAddressId` of the customer will be set to the ID of that address. */
1458
1485
  defaultBillingAddress?: InputMaybe<Scalars['Int']>;
1486
+ /** The index of the address in the `addresses` list. The `defaultShippingAddressId` of the customer will be set to the ID of that address. */
1459
1487
  defaultShippingAddress?: InputMaybe<Scalars['Int']>;
1460
1488
  key: Scalars['String'];
1461
1489
  name: Scalars['String'];
1462
1490
  parentUnit?: InputMaybe<TResourceIdentifierInput>;
1491
+ /** The indices of the shipping addresses in the `addresses` list. The `shippingAddressIds` of the `Customer` will be set to the IDs of that addresses. */
1463
1492
  shippingAddresses?: InputMaybe<Array<Scalars['Int']>>;
1464
1493
  storeMode?: InputMaybe<Scalars['String']>;
1465
1494
  stores?: InputMaybe<Array<TResourceIdentifierInput>>;
@@ -1486,12 +1515,14 @@ export type TBusinessUnitQueryResult = {
1486
1515
  results: Array<TBusinessUnit>;
1487
1516
  total: Scalars['Long'];
1488
1517
  };
1518
+ /** CLOSED BETA: This feature is subject to change and should not be used in production. https://docs.commercetools.com/api/contract#closed-beta */
1489
1519
  export type TBusinessUnitSearchConfiguration = {
1490
1520
  __typename?: 'BusinessUnitSearchConfiguration';
1491
1521
  lastModifiedAt: Scalars['DateTime'];
1492
1522
  lastModifiedBy?: Maybe<TInitiator>;
1493
1523
  status: TBusinessUnitSearchStatus;
1494
1524
  };
1525
+ /** CLOSED BETA: This feature is subject to change and should not be used in production. https://docs.commercetools.com/api/contract#closed-beta */
1495
1526
  export declare enum TBusinessUnitSearchStatus {
1496
1527
  Activated = "Activated",
1497
1528
  Deactivated = "Deactivated"
@@ -1579,6 +1610,7 @@ export type TBusinessUnitUpdateAction = {
1579
1610
  export type TCancelQuoteRequest = {
1580
1611
  dummy?: InputMaybe<Scalars['String']>;
1581
1612
  };
1613
+ /** A shopping cart holds product variants and can be ordered. Each cart either belongs to a registered customer or is an anonymous cart. */
1582
1614
  export type TCart = TReferenceExpandable & TVersioned & {
1583
1615
  __typename?: 'Cart';
1584
1616
  anonymousId?: Maybe<Scalars['String']>;
@@ -1630,6 +1662,7 @@ export type TCart = TReferenceExpandable & TVersioned & {
1630
1662
  totalPrice: TMoney;
1631
1663
  version: Scalars['Long'];
1632
1664
  };
1665
+ /** A shopping cart holds product variants and can be ordered. Each cart either belongs to a registered customer or is an anonymous cart. */
1633
1666
  export type TCart_LineItemsArgs = {
1634
1667
  id?: InputMaybe<Scalars['String']>;
1635
1668
  };
@@ -1648,6 +1681,13 @@ export type TCartCreated = TMessagePayload & {
1648
1681
  totalPrice: TMoney;
1649
1682
  type: Scalars['String'];
1650
1683
  };
1684
+ /**
1685
+ *
1686
+ * Cart discounts are recalculated every time LineItems or CustomLineItems are added or removed from the Cart or an order is created from the cart.
1687
+ *
1688
+ * The number of active cart discounts that do not require a discount code (isActive=true and requiresDiscountCode=false) is limited to 100.
1689
+ *
1690
+ */
1651
1691
  export type TCartDiscount = TReferenceExpandable & TVersioned & {
1652
1692
  __typename?: 'CartDiscount';
1653
1693
  cartPredicate: Scalars['String'];
@@ -1675,10 +1715,24 @@ export type TCartDiscount = TReferenceExpandable & TVersioned & {
1675
1715
  value: TCartDiscountValue;
1676
1716
  version: Scalars['Long'];
1677
1717
  };
1718
+ /**
1719
+ *
1720
+ * Cart discounts are recalculated every time LineItems or CustomLineItems are added or removed from the Cart or an order is created from the cart.
1721
+ *
1722
+ * The number of active cart discounts that do not require a discount code (isActive=true and requiresDiscountCode=false) is limited to 100.
1723
+ *
1724
+ */
1678
1725
  export type TCartDiscount_DescriptionArgs = {
1679
1726
  acceptLanguage?: InputMaybe<Array<Scalars['Locale']>>;
1680
1727
  locale?: InputMaybe<Scalars['Locale']>;
1681
1728
  };
1729
+ /**
1730
+ *
1731
+ * Cart discounts are recalculated every time LineItems or CustomLineItems are added or removed from the Cart or an order is created from the cart.
1732
+ *
1733
+ * The number of active cart discounts that do not require a discount code (isActive=true and requiresDiscountCode=false) is limited to 100.
1734
+ *
1735
+ */
1682
1736
  export type TCartDiscount_NameArgs = {
1683
1737
  acceptLanguage?: InputMaybe<Array<Scalars['Locale']>>;
1684
1738
  locale?: InputMaybe<Scalars['Locale']>;
@@ -1717,14 +1771,17 @@ export type TCartDiscountLimitsProjection = {
1717
1771
  __typename?: 'CartDiscountLimitsProjection';
1718
1772
  totalActiveWithoutDiscountCodes: TCartDiscountLimitWithCurrent;
1719
1773
  };
1774
+ /** Fields to access cartDiscounts. Includes direct access to a single cartDiscount and searching for cartDiscounts. */
1720
1775
  export type TCartDiscountQueryInterface = {
1721
1776
  cartDiscount?: Maybe<TCartDiscount>;
1722
1777
  cartDiscounts: TCartDiscountQueryResult;
1723
1778
  };
1779
+ /** Fields to access cartDiscounts. Includes direct access to a single cartDiscount and searching for cartDiscounts. */
1724
1780
  export type TCartDiscountQueryInterface_CartDiscountArgs = {
1725
1781
  id?: InputMaybe<Scalars['String']>;
1726
1782
  key?: InputMaybe<Scalars['String']>;
1727
1783
  };
1784
+ /** Fields to access cartDiscounts. Includes direct access to a single cartDiscount and searching for cartDiscounts. */
1728
1785
  export type TCartDiscountQueryInterface_CartDiscountsArgs = {
1729
1786
  limit?: InputMaybe<Scalars['Int']>;
1730
1787
  offset?: InputMaybe<Scalars['Int']>;
@@ -1799,8 +1856,10 @@ export type TCartDiscountValue = {
1799
1856
  type: Scalars['String'];
1800
1857
  };
1801
1858
  export type TCartDiscountValueBaseMoneyInput = {
1859
+ /** CurrencyCode and centAmount are deprecated. Please use `Money`(centPrecision) or `HighPrecisionMoney`(highPrecision). */
1802
1860
  centAmount?: InputMaybe<Scalars['Long']>;
1803
1861
  centPrecision?: InputMaybe<TMoneyInput>;
1862
+ /** CurrencyCode and centAmount are deprecated. Please use `Money`(centPrecision) or `HighPrecisionMoney`(highPrecision). */
1804
1863
  currencyCode?: InputMaybe<Scalars['Currency']>;
1805
1864
  highPrecision?: InputMaybe<THighPrecisionMoneyInput>;
1806
1865
  };
@@ -1851,17 +1910,23 @@ export type TCartLimitsProjection = {
1851
1910
  total: TCartLimitWithCurrent;
1852
1911
  };
1853
1912
  export declare enum TCartOrigin {
1913
+ /** The cart was created by the customer. This is the default value */
1854
1914
  Customer = "Customer",
1915
+ /** The cart was created by the merchant on behalf of the customer */
1855
1916
  Merchant = "Merchant",
1917
+ /** The cart was created by our platform and belongs to a Quote. */
1856
1918
  Quote = "Quote"
1857
1919
  }
1920
+ /** Fields to access carts. Includes direct access to a single cart and searching for carts. */
1858
1921
  export type TCartQueryInterface = {
1859
1922
  cart?: Maybe<TCart>;
1860
1923
  carts: TCartQueryResult;
1861
1924
  };
1925
+ /** Fields to access carts. Includes direct access to a single cart and searching for carts. */
1862
1926
  export type TCartQueryInterface_CartArgs = {
1863
1927
  id: Scalars['String'];
1864
1928
  };
1929
+ /** Fields to access carts. Includes direct access to a single cart and searching for carts. */
1865
1930
  export type TCartQueryInterface_CartsArgs = {
1866
1931
  limit?: InputMaybe<Scalars['Int']>;
1867
1932
  offset?: InputMaybe<Scalars['Int']>;
@@ -1884,9 +1949,13 @@ export type TCartScoreType = TShippingRateInputType & {
1884
1949
  type: Scalars['String'];
1885
1950
  };
1886
1951
  export declare enum TCartState {
1952
+ /** The cart can be updated and ordered. It is the default state. */
1887
1953
  Active = "Active",
1954
+ /** The cart is frozen. The cart is ready for checkout and a few update actions are not allowed. */
1888
1955
  Frozen = "Frozen",
1956
+ /** Anonymous cart whose content was merged into a customers cart on signin. No further operations on the cart are allowed. */
1889
1957
  Merged = "Merged",
1958
+ /** The cart was ordered. No further operations on the cart are allowed. */
1890
1959
  Ordered = "Ordered"
1891
1960
  }
1892
1961
  export type TCartUpdateAction = {
@@ -1982,7 +2051,9 @@ export type TCategory = TReferenceExpandable & TVersioned & {
1982
2051
  ancestors: Array<TCategory>;
1983
2052
  ancestorsRef: Array<TReference>;
1984
2053
  assets: Array<TAsset>;
2054
+ /** Number of direct child categories. */
1985
2055
  childCount: Scalars['Int'];
2056
+ /** Direct child categories. */
1986
2057
  children?: Maybe<Array<TCategory>>;
1987
2058
  createdAt: Scalars['DateTime'];
1988
2059
  createdBy?: Maybe<TInitiator>;
@@ -2007,6 +2078,7 @@ export type TCategory = TReferenceExpandable & TVersioned & {
2007
2078
  parentRef?: Maybe<TReference>;
2008
2079
  slug?: Maybe<Scalars['String']>;
2009
2080
  slugAllLocales: Array<TLocalizedString>;
2081
+ /** Number of staged products in the category subtree. */
2010
2082
  stagedProductCount: Scalars['Int'];
2011
2083
  version: Scalars['Long'];
2012
2084
  };
@@ -2085,6 +2157,7 @@ export type TCategorySearch = {
2085
2157
  ancestorsRef: Array<TReference>;
2086
2158
  assets: Array<TAsset>;
2087
2159
  childCount: Scalars['Int'];
2160
+ /** Direct child categories. */
2088
2161
  children: Array<TCategorySearch>;
2089
2162
  createdAt: Scalars['DateTime'];
2090
2163
  custom?: Maybe<TCustomFieldsType>;
@@ -2233,7 +2306,9 @@ export type TChangeCartDiscountValue = {
2233
2306
  value: TCartDiscountValueInput;
2234
2307
  };
2235
2308
  export type TChangeCartLineItemQuantity = {
2309
+ /** Only valid for the general Carts API. Ignored for the My Carts API. */
2236
2310
  externalPrice?: InputMaybe<TBaseMoneyInput>;
2311
+ /** Only valid for the general Carts API. Ignored for the My Carts API. */
2237
2312
  externalTotalPrice?: InputMaybe<TExternalLineItemTotalPriceDraft>;
2238
2313
  lineItemId?: InputMaybe<Scalars['String']>;
2239
2314
  lineItemKey?: InputMaybe<Scalars['String']>;
@@ -2409,6 +2484,7 @@ export type TChangeProductSlug = {
2409
2484
  slug: Array<TLocalizedStringItemInputType>;
2410
2485
  staged?: InputMaybe<Scalars['Boolean']>;
2411
2486
  };
2487
+ /** CLOSED BETA: This feature is subject to change and should not be used in production. https://docs.commercetools.com/api/contract#closed-beta */
2412
2488
  export type TChangeProjectSettingsBusinessUnitSearchStatus = {
2413
2489
  status: TBusinessUnitSearchStatus;
2414
2490
  };
@@ -2424,6 +2500,7 @@ export type TChangeProjectSettingsCountryTaxRateFallbackEnabled = {
2424
2500
  export type TChangeProjectSettingsCurrencies = {
2425
2501
  currencies: Array<Scalars['Currency']>;
2426
2502
  };
2503
+ /** CLOSED BETA: This feature is subject to change and should not be used in production. https://docs.commercetools.com/api/contract#closed-beta */
2427
2504
  export type TChangeProjectSettingsCustomerSearchStatus = {
2428
2505
  status: TCustomerSearchStatus;
2429
2506
  };
@@ -2447,6 +2524,7 @@ export type TChangeProjectSettingsOrderSearchStatus = {
2447
2524
  };
2448
2525
  export type TChangeProjectSettingsProductSearchIndexingEnabled = {
2449
2526
  enabled: Scalars['Boolean'];
2527
+ /** CLOSED BETA: This feature is subject to change and should not be used in production. https://docs.commercetools.com/api/contract#closed-beta */
2450
2528
  mode?: InputMaybe<TProductSearchIndexingMode>;
2451
2529
  };
2452
2530
  export type TChangeProjectSettingsShoppingListsConfiguration = {
@@ -2595,6 +2673,7 @@ export type TChangeStandalonePriceActive = {
2595
2673
  active: Scalars['Boolean'];
2596
2674
  };
2597
2675
  export type TChangeStandalonePriceValue = {
2676
+ /** default is `false` */
2598
2677
  staged?: InputMaybe<Scalars['Boolean']>;
2599
2678
  value: TBaseMoneyInput;
2600
2679
  };
@@ -2708,10 +2787,15 @@ export type TChannelReferenceIdentifier = {
2708
2787
  typeId: Scalars['String'];
2709
2788
  };
2710
2789
  export declare enum TChannelRole {
2790
+ /** Role tells that this channel can be used to track inventory entries.Channels with this role can be treated as warehouses */
2711
2791
  InventorySupply = "InventorySupply",
2792
+ /** Role tells that this channel can be used to track order export activities. */
2712
2793
  OrderExport = "OrderExport",
2794
+ /** Role tells that this channel can be used to track order import activities. */
2713
2795
  OrderImport = "OrderImport",
2796
+ /** This role can be combined with some other roles (e.g. with `InventorySupply`) to represent the fact that this particular channel is the primary/master channel among the channels of the same type. */
2714
2797
  Primary = "Primary",
2798
+ /** Role tells that this channel can be used to expose products to a specific distribution channel. It can be used by the cart to select a product price. */
2715
2799
  ProductDistribution = "ProductDistribution"
2716
2800
  }
2717
2801
  export type TChannelUpdateAction = {
@@ -2843,8 +2927,34 @@ export type TCreateZone = {
2843
2927
  export type TCustomField = {
2844
2928
  name: Scalars['String'];
2845
2929
  };
2930
+ /**
2931
+ * A key-value pair representing the field name and value of one single custom field.
2932
+ *
2933
+ * The value of this custom field consists of escaped JSON based on the FieldDefinition of the Type.
2934
+ *
2935
+ *
2936
+ * Examples for `value`:
2937
+ *
2938
+ * * FieldType `String`: `"\"This is a string\""`
2939
+ * * FieldType `DateTimeType`: `"\"2018-10-12T14:00:00.000Z\""`
2940
+ * * FieldType `Number`: `"4"`
2941
+ * * FieldType `Set` with an elementType of `String`: `"[\"This is a string\", \"This is another string\"]"`
2942
+ * * FieldType `Reference`: `"{\"id\": \"b911b62d-353a-4388-93ee-8d488d9af962\", \"typeId\": \"product\"}"`
2943
+ */
2846
2944
  export type TCustomFieldInput = {
2847
2945
  name: Scalars['String'];
2946
+ /**
2947
+ * The value of this custom field consists of escaped JSON based on the FieldDefinition of the Type.
2948
+ *
2949
+ *
2950
+ * Examples for `value`:
2951
+ *
2952
+ * * FieldType `String`: `"\"This is a string\""`
2953
+ * * FieldType `DateTimeType`: `"\"2018-10-12T14:00:00.000Z\""`
2954
+ * * FieldType `Number`: `"4"`
2955
+ * * FieldType `Set` with an elementType of `String`: `"[\"This is a string\", \"This is another string\"]"`
2956
+ * * FieldType `Reference`: `"{\"id\": \"b911b62d-353a-4388-93ee-8d488d9af962\", \"typeId\": \"product\"}"`
2957
+ */
2848
2958
  value: Scalars['String'];
2849
2959
  };
2850
2960
  export type TCustomFieldsCommand = {
@@ -2862,6 +2972,7 @@ export type TCustomFieldsDraft = {
2862
2972
  };
2863
2973
  export type TCustomFieldsType = {
2864
2974
  __typename?: 'CustomFieldsType';
2975
+ /** This field contains non-typed data. */
2865
2976
  customFieldsRaw?: Maybe<Array<TRawCustomField>>;
2866
2977
  type?: Maybe<TTypeDefinition>;
2867
2978
  typeRef: TReference;
@@ -2870,6 +2981,7 @@ export type TCustomFieldsType_CustomFieldsRawArgs = {
2870
2981
  excludeNames?: InputMaybe<Array<Scalars['String']>>;
2871
2982
  includeNames?: InputMaybe<Array<Scalars['String']>>;
2872
2983
  };
2984
+ /** A custom line item is a generic item that can be added to the cart but is not bound to a product. You can use it for discounts (negative money), vouchers, complex cart rules, additional services or fees. You control the lifecycle of this item. */
2873
2985
  export type TCustomLineItem = {
2874
2986
  __typename?: 'CustomLineItem';
2875
2987
  custom?: Maybe<TCustomFieldsType>;
@@ -2892,6 +3004,7 @@ export type TCustomLineItem = {
2892
3004
  taxedPricePortions: Array<TMethodTaxedPrice>;
2893
3005
  totalPrice: TMoney;
2894
3006
  };
3007
+ /** A custom line item is a generic item that can be added to the cart but is not bound to a product. You can use it for discounts (negative money), vouchers, complex cart rules, additional services or fees. You control the lifecycle of this item. */
2895
3008
  export type TCustomLineItem_NameArgs = {
2896
3009
  acceptLanguage?: InputMaybe<Array<Scalars['Locale']>>;
2897
3010
  locale?: InputMaybe<Scalars['Locale']>;
@@ -2940,7 +3053,9 @@ export type TCustomLineItemImportDraft = {
2940
3053
  taxRate?: InputMaybe<TTaxRateInput>;
2941
3054
  };
2942
3055
  export declare enum TCustomLineItemPriceMode {
3056
+ /** Cart discounts are deactivated for the custom line items with this price mode. */
2943
3057
  External = "External",
3058
+ /** This is the default mode. */
2944
3059
  Standard = "Standard"
2945
3060
  }
2946
3061
  export type TCustomLineItemReturnItem = TReturnItem & {
@@ -2989,9 +3104,29 @@ export type TCustomObject = TReferenceExpandable & TVersioned & {
2989
3104
  value: Scalars['Json'];
2990
3105
  version: Scalars['Long'];
2991
3106
  };
3107
+ /**
3108
+ * An input object used to create a new, or update an existing Custom Object.
3109
+ *
3110
+ * The value should be passed in a form of escaped JSON.
3111
+ *
3112
+ * Example for `value` field:
3113
+ *
3114
+ * ```
3115
+ * "{ \"stringField\": \"myVal\", \"numberField\": 123, \"boolField\": false, \"nestedObject\": { \"nestedObjectKey\": \"anotherValue\" }, \"dateField\": \"2018-10-12T14:00:00.000Z\" }"
3116
+ * ```
3117
+ */
2992
3118
  export type TCustomObjectDraft = {
2993
3119
  container: Scalars['String'];
2994
3120
  key: Scalars['String'];
3121
+ /**
3122
+ * The value should be passed in a form of escaped JSON.
3123
+ *
3124
+ * Example for `value` field:
3125
+ *
3126
+ * ```
3127
+ * "{ \"stringField\": \"myVal\", \"numberField\": 123, \"boolField\": false, \"nestedObject\": { \"nestedObjectKey\": \"anotherValue\" }, \"dateField\": \"2018-10-12T14:00:00.000Z\" }"
3128
+ * ```
3129
+ */
2995
3130
  value: Scalars['String'];
2996
3131
  version?: InputMaybe<Scalars['Long']>;
2997
3132
  };
@@ -3036,6 +3171,7 @@ export type TCustomSuggestTokenizerProductSearch = TSuggestTokenizerProductSearc
3036
3171
  inputs: Array<Scalars['String']>;
3037
3172
  type: Scalars['String'];
3038
3173
  };
3174
+ /** A customer is a person purchasing products. Carts, Orders and Reviews can be associated to a customer. */
3039
3175
  export type TCustomer = TReferenceExpandable & TVersioned & {
3040
3176
  __typename?: 'Customer';
3041
3177
  addresses: Array<TAddress>;
@@ -3047,6 +3183,7 @@ export type TCustomer = TReferenceExpandable & TVersioned & {
3047
3183
  createdBy?: Maybe<TInitiator>;
3048
3184
  custom?: Maybe<TCustomFieldsType>;
3049
3185
  customerGroup?: Maybe<TCustomerGroup>;
3186
+ /** CLOSED BETA: This feature is subject to change and should not be used in production. https://docs.commercetools.com/api/contract#closed-beta */
3050
3187
  customerGroupAssignments?: Maybe<Array<TCustomerGroupAssignment>>;
3051
3188
  customerGroupRef?: Maybe<TReference>;
3052
3189
  customerNumber?: Maybe<Scalars['String']>;
@@ -3076,9 +3213,11 @@ export type TCustomer = TReferenceExpandable & TVersioned & {
3076
3213
  vatId?: Maybe<Scalars['String']>;
3077
3214
  version: Scalars['Long'];
3078
3215
  };
3216
+ /** A field to access a customer's active cart. */
3079
3217
  export type TCustomerActiveCartInterface = {
3080
3218
  customerActiveCart?: Maybe<TCart>;
3081
3219
  };
3220
+ /** A field to access a customer's active cart. */
3082
3221
  export type TCustomerActiveCartInterface_CustomerActiveCartArgs = {
3083
3222
  customerId: Scalars['String'];
3084
3223
  };
@@ -3206,6 +3345,7 @@ export type TCustomerFirstNameSet = TMessagePayload & {
3206
3345
  firstName?: Maybe<Scalars['String']>;
3207
3346
  type: Scalars['String'];
3208
3347
  };
3348
+ /** A customer can be a member in a customer group (e.g. reseller, gold member). A customer group can be used in price calculations with special prices being assigned to certain customer groups. */
3209
3349
  export type TCustomerGroup = TReferenceExpandable & TVersioned & {
3210
3350
  __typename?: 'CustomerGroup';
3211
3351
  createdAt: Scalars['DateTime'];
@@ -3218,24 +3358,29 @@ export type TCustomerGroup = TReferenceExpandable & TVersioned & {
3218
3358
  name: Scalars['String'];
3219
3359
  version: Scalars['Long'];
3220
3360
  };
3361
+ /** CLOSED BETA: This feature is subject to change and should not be used in production. https://docs.commercetools.com/api/contract#closed-beta */
3221
3362
  export type TCustomerGroupAssignment = {
3222
3363
  __typename?: 'CustomerGroupAssignment';
3223
3364
  customerGroup?: Maybe<TCustomerGroup>;
3224
3365
  customerGroupRef?: Maybe<TReference>;
3225
3366
  };
3367
+ /** CLOSED BETA: This feature is subject to change and should not be used in production. https://docs.commercetools.com/api/contract#closed-beta */
3226
3368
  export type TCustomerGroupAssignmentAdded = TMessagePayload & {
3227
3369
  __typename?: 'CustomerGroupAssignmentAdded';
3228
3370
  customerGroupAssignment: TCustomerGroupAssignment;
3229
3371
  type: Scalars['String'];
3230
3372
  };
3373
+ /** CLOSED BETA: This feature is subject to change and should not be used in production. https://docs.commercetools.com/api/contract#closed-beta */
3231
3374
  export type TCustomerGroupAssignmentDraft = {
3232
3375
  customerGroup: TResourceIdentifierInput;
3233
3376
  };
3377
+ /** CLOSED BETA: This feature is subject to change and should not be used in production. https://docs.commercetools.com/api/contract#closed-beta */
3234
3378
  export type TCustomerGroupAssignmentRemoved = TMessagePayload & {
3235
3379
  __typename?: 'CustomerGroupAssignmentRemoved';
3236
3380
  customerGroupAssignment: TCustomerGroupAssignment;
3237
3381
  type: Scalars['String'];
3238
3382
  };
3383
+ /** CLOSED BETA: This feature is subject to change and should not be used in production. https://docs.commercetools.com/api/contract#closed-beta */
3239
3384
  export type TCustomerGroupAssignmentsSet = TMessagePayload & {
3240
3385
  __typename?: 'CustomerGroupAssignmentsSet';
3241
3386
  customerGroupAssignments: Array<TCustomerGroupAssignment>;
@@ -3347,16 +3492,19 @@ export type TCustomerPasswordUpdated = TMessagePayload & {
3347
3492
  reset: Scalars['Boolean'];
3348
3493
  type: Scalars['String'];
3349
3494
  };
3495
+ /** Fields to access customer accounts. Includes direct access to a single customer and searching for customers. */
3350
3496
  export type TCustomerQueryInterface = {
3351
3497
  customer?: Maybe<TCustomer>;
3352
3498
  customers: TCustomerQueryResult;
3353
3499
  };
3500
+ /** Fields to access customer accounts. Includes direct access to a single customer and searching for customers. */
3354
3501
  export type TCustomerQueryInterface_CustomerArgs = {
3355
3502
  emailToken?: InputMaybe<Scalars['String']>;
3356
3503
  id?: InputMaybe<Scalars['String']>;
3357
3504
  key?: InputMaybe<Scalars['String']>;
3358
3505
  passwordToken?: InputMaybe<Scalars['String']>;
3359
3506
  };
3507
+ /** Fields to access customer accounts. Includes direct access to a single customer and searching for customers. */
3360
3508
  export type TCustomerQueryInterface_CustomersArgs = {
3361
3509
  limit?: InputMaybe<Scalars['Int']>;
3362
3510
  offset?: InputMaybe<Scalars['Int']>;
@@ -3371,18 +3519,21 @@ export type TCustomerQueryResult = {
3371
3519
  results: Array<TCustomer>;
3372
3520
  total: Scalars['Long'];
3373
3521
  };
3522
+ /** CLOSED BETA: This feature is subject to change and should not be used in production. https://docs.commercetools.com/api/contract#closed-beta */
3374
3523
  export type TCustomerSearchConfiguration = {
3375
3524
  __typename?: 'CustomerSearchConfiguration';
3376
3525
  lastModifiedAt: Scalars['DateTime'];
3377
3526
  lastModifiedBy?: Maybe<TInitiator>;
3378
3527
  status: TCustomerSearchStatus;
3379
3528
  };
3529
+ /** CLOSED BETA: This feature is subject to change and should not be used in production. https://docs.commercetools.com/api/contract#closed-beta */
3380
3530
  export declare enum TCustomerSearchStatus {
3381
3531
  Activated = "Activated",
3382
3532
  Deactivated = "Deactivated"
3383
3533
  }
3384
3534
  export type TCustomerSignInDraft = {
3385
3535
  anonymousCart?: InputMaybe<TResourceIdentifierInput>;
3536
+ /** This field will be deprecated in favour of anonymousCart.id. */
3386
3537
  anonymousCartId?: InputMaybe<Scalars['String']>;
3387
3538
  anonymousCartSignInMode?: InputMaybe<TAnonymousCartSignInMode>;
3388
3539
  anonymousId?: InputMaybe<Scalars['String']>;
@@ -3403,11 +3554,14 @@ export type TCustomerSignMeInDraft = {
3403
3554
  };
3404
3555
  export type TCustomerSignMeUpDraft = {
3405
3556
  addresses?: InputMaybe<Array<TAddressInput>>;
3557
+ /** The indices of the billing addresses in the `addresses` list. The `billingAddressIds` of the customer will be set to the IDs of that addresses. */
3406
3558
  billingAddresses?: InputMaybe<Array<Scalars['Int']>>;
3407
3559
  companyName?: InputMaybe<Scalars['String']>;
3408
3560
  custom?: InputMaybe<TCustomFieldsDraft>;
3409
3561
  dateOfBirth?: InputMaybe<Scalars['Date']>;
3562
+ /** The index of the address in the `addresses` list. The `defaultBillingAddressId` of the customer will be set to the ID of that address. */
3410
3563
  defaultBillingAddress?: InputMaybe<Scalars['Int']>;
3564
+ /** The index of the address in the `addresses` list. The `defaultShippingAddressId` of the customer will be set to the ID of that address. */
3411
3565
  defaultShippingAddress?: InputMaybe<Scalars['Int']>;
3412
3566
  email: Scalars['String'];
3413
3567
  firstName?: InputMaybe<Scalars['String']>;
@@ -3417,6 +3571,7 @@ export type TCustomerSignMeUpDraft = {
3417
3571
  middleName?: InputMaybe<Scalars['String']>;
3418
3572
  password?: InputMaybe<Scalars['String']>;
3419
3573
  salutation?: InputMaybe<Scalars['String']>;
3574
+ /** The indices of the shipping addresses in the `addresses` list. The `shippingAddressIds` of the `Customer` will be set to the IDs of that addresses. */
3420
3575
  shippingAddresses?: InputMaybe<Array<Scalars['Int']>>;
3421
3576
  stores?: InputMaybe<Array<TResourceIdentifierInput>>;
3422
3577
  title?: InputMaybe<Scalars['String']>;
@@ -3425,17 +3580,22 @@ export type TCustomerSignMeUpDraft = {
3425
3580
  export type TCustomerSignUpDraft = {
3426
3581
  addresses?: InputMaybe<Array<TAddressInput>>;
3427
3582
  anonymousCart?: InputMaybe<TResourceIdentifierInput>;
3583
+ /** This field will be deprecated in favour of anonymousCart.id. */
3428
3584
  anonymousCartId?: InputMaybe<Scalars['String']>;
3429
3585
  anonymousId?: InputMaybe<Scalars['String']>;
3430
3586
  authenticationMode?: InputMaybe<TAuthenticationMode>;
3587
+ /** The indices of the billing addresses in the `addresses` list. The `billingAddressIds` of the customer will be set to the IDs of that addresses. */
3431
3588
  billingAddresses?: InputMaybe<Array<Scalars['Int']>>;
3432
3589
  companyName?: InputMaybe<Scalars['String']>;
3433
3590
  custom?: InputMaybe<TCustomFieldsDraft>;
3434
3591
  customerGroup?: InputMaybe<TResourceIdentifierInput>;
3592
+ /** CLOSED BETA: This feature is subject to change and should not be used in production. https://docs.commercetools.com/api/contract#closed-beta */
3435
3593
  customerGroupAssignments?: InputMaybe<Array<TCustomerGroupAssignmentDraft>>;
3436
3594
  customerNumber?: InputMaybe<Scalars['String']>;
3437
3595
  dateOfBirth?: InputMaybe<Scalars['Date']>;
3596
+ /** The index of the address in the `addresses` list. The `defaultBillingAddressId` of the customer will be set to the ID of that address. */
3438
3597
  defaultBillingAddress?: InputMaybe<Scalars['Int']>;
3598
+ /** The index of the address in the `addresses` list. The `defaultShippingAddressId` of the customer will be set to the ID of that address. */
3439
3599
  defaultShippingAddress?: InputMaybe<Scalars['Int']>;
3440
3600
  email: Scalars['String'];
3441
3601
  externalId?: InputMaybe<Scalars['String']>;
@@ -3447,6 +3607,7 @@ export type TCustomerSignUpDraft = {
3447
3607
  middleName?: InputMaybe<Scalars['String']>;
3448
3608
  password?: InputMaybe<Scalars['String']>;
3449
3609
  salutation?: InputMaybe<Scalars['String']>;
3610
+ /** The indices of the shipping addresses in the `addresses` list. The `shippingAddressIds` of the `Customer` will be set to the IDs of that addresses. */
3450
3611
  shippingAddresses?: InputMaybe<Array<Scalars['Int']>>;
3451
3612
  stores?: InputMaybe<Array<TResourceIdentifierInput>>;
3452
3613
  title?: InputMaybe<Scalars['String']>;
@@ -3460,6 +3621,7 @@ export type TCustomerTitleSet = TMessagePayload & {
3460
3621
  export type TCustomerUpdateAction = {
3461
3622
  addAddress?: InputMaybe<TAddCustomerAddress>;
3462
3623
  addBillingAddressId?: InputMaybe<TAddCustomerBillingAddressId>;
3624
+ /** CLOSED BETA: This feature is subject to change and should not be used in production. https://docs.commercetools.com/api/contract#closed-beta */
3463
3625
  addCustomerGroupAssignment?: InputMaybe<TAddCustomerGroupAssignment>;
3464
3626
  addShippingAddressId?: InputMaybe<TAddCustomerShippingAddressId>;
3465
3627
  addStore?: InputMaybe<TAddCustomerStore>;
@@ -3467,6 +3629,7 @@ export type TCustomerUpdateAction = {
3467
3629
  changeEmail?: InputMaybe<TChangeCustomerEmail>;
3468
3630
  removeAddress?: InputMaybe<TRemoveCustomerAddress>;
3469
3631
  removeBillingAddressId?: InputMaybe<TRemoveCustomerBillingAddressId>;
3632
+ /** CLOSED BETA: This feature is subject to change and should not be used in production. https://docs.commercetools.com/api/contract#closed-beta */
3470
3633
  removeCustomerGroupAssignment?: InputMaybe<TRemoveCustomerGroupAssignment>;
3471
3634
  removeShippingAddressId?: InputMaybe<TRemoveCustomerShippingAddressId>;
3472
3635
  removeStore?: InputMaybe<TRemoveCustomerStore>;
@@ -3477,6 +3640,7 @@ export type TCustomerUpdateAction = {
3477
3640
  setCustomField?: InputMaybe<TSetCustomerCustomField>;
3478
3641
  setCustomType?: InputMaybe<TSetCustomerCustomType>;
3479
3642
  setCustomerGroup?: InputMaybe<TSetCustomerGroup>;
3643
+ /** CLOSED BETA: This feature is subject to change and should not be used in production. https://docs.commercetools.com/api/contract#closed-beta */
3480
3644
  setCustomerGroupAssignments?: InputMaybe<TSetCustomerGroupAssignments>;
3481
3645
  setCustomerNumber?: InputMaybe<TSetCustomerNumber>;
3482
3646
  setDateOfBirth?: InputMaybe<TSetCustomerDateOfBirth>;
@@ -3624,8 +3788,10 @@ export type TDirectDiscountDraftOutput = {
3624
3788
  target?: Maybe<TCartDiscountTarget>;
3625
3789
  value: TCartDiscountValue;
3626
3790
  };
3791
+ /** With discount codes it is possible to give specific cart discounts to an eligible amount of users. They are defined by a string value which can be added to a cart so that specific cart discounts can be applied to the cart. */
3627
3792
  export type TDiscountCode = TReferenceExpandable & TVersioned & {
3628
3793
  __typename?: 'DiscountCode';
3794
+ /** How many times this discount code was applied (only applications that were part of a successful checkout are considered) */
3629
3795
  applicationCount: Scalars['Long'];
3630
3796
  applicationVersion?: Maybe<Scalars['Long']>;
3631
3797
  cartDiscountRefs: Array<TReference>;
@@ -3652,10 +3818,12 @@ export type TDiscountCode = TReferenceExpandable & TVersioned & {
3652
3818
  validUntil?: Maybe<Scalars['DateTime']>;
3653
3819
  version: Scalars['Long'];
3654
3820
  };
3821
+ /** With discount codes it is possible to give specific cart discounts to an eligible amount of users. They are defined by a string value which can be added to a cart so that specific cart discounts can be applied to the cart. */
3655
3822
  export type TDiscountCode_DescriptionArgs = {
3656
3823
  acceptLanguage?: InputMaybe<Array<Scalars['Locale']>>;
3657
3824
  locale?: InputMaybe<Scalars['Locale']>;
3658
3825
  };
3826
+ /** With discount codes it is possible to give specific cart discounts to an eligible amount of users. They are defined by a string value which can be added to a cart so that specific cart discounts can be applied to the cart. */
3659
3827
  export type TDiscountCode_NameArgs = {
3660
3828
  acceptLanguage?: InputMaybe<Array<Scalars['Locale']>>;
3661
3829
  locale?: InputMaybe<Scalars['Locale']>;
@@ -3705,11 +3873,17 @@ export type TDiscountCodeQueryResult = {
3705
3873
  total: Scalars['Long'];
3706
3874
  };
3707
3875
  export declare enum TDiscountCodeState {
3876
+ /** The discount code is active and none of the discounts were applied because the discount application was stopped by one discount that has the StackingMode of StopAfterThisDiscount defined */
3708
3877
  ApplicationStoppedByPreviousDiscount = "ApplicationStoppedByPreviousDiscount",
3878
+ /** The discount code is active and it contains at least one active and valid CartDiscount. But its cart predicate does not match the cart or none of the contained active discount’s cart predicates match the cart */
3709
3879
  DoesNotMatchCart = "DoesNotMatchCart",
3880
+ /** The discount code is active and it contains at least one active and valid CartDiscount. The discount code cartPredicate matches the cart and at least one of the contained active discount’s cart predicates matches the cart. */
3710
3881
  MatchesCart = "MatchesCart",
3882
+ /** maxApplications or maxApplicationsPerCustomer for discountCode has been reached. */
3711
3883
  MaxApplicationReached = "MaxApplicationReached",
3884
+ /** The discount code is not active or it does not contain any active cart discounts. */
3712
3885
  NotActive = "NotActive",
3886
+ /** The discount code is not valid or it does not contain any valid cart discounts. Validity is determined based on the validFrom and validUntil dates */
3713
3887
  NotValid = "NotValid"
3714
3888
  }
3715
3889
  export type TDiscountCodeUpdateAction = {
@@ -3953,6 +4127,7 @@ export type TFacetResultValue = {
3953
4127
  facet: Scalars['String'];
3954
4128
  value: TFacetResult;
3955
4129
  };
4130
+ /** Field definitions describe custom fields and allow you to define some meta-information associated with the field. */
3956
4131
  export type TFieldDefinition = {
3957
4132
  __typename?: 'FieldDefinition';
3958
4133
  inputHint: TTextInputHint;
@@ -3962,6 +4137,7 @@ export type TFieldDefinition = {
3962
4137
  required: Scalars['Boolean'];
3963
4138
  type: TFieldType;
3964
4139
  };
4140
+ /** Field definitions describe custom fields and allow you to define some meta-information associated with the field. */
3965
4141
  export type TFieldDefinition_LabelArgs = {
3966
4142
  acceptLanguage?: InputMaybe<Array<Scalars['Locale']>>;
3967
4143
  locale?: InputMaybe<Scalars['Locale']>;
@@ -4222,6 +4398,11 @@ export type TInStore = TCartDiscountQueryInterface & TCartQueryInterface & TCust
4222
4398
  customer?: Maybe<TCustomer>;
4223
4399
  customerActiveCart?: Maybe<TCart>;
4224
4400
  customers: TCustomerQueryResult;
4401
+ /**
4402
+ * This field can only be used with an access token created with the password flow or with an anonymous session.
4403
+ *
4404
+ * It gives access to the data that is specific to the customer or the anonymous session linked to the access token.
4405
+ */
4225
4406
  me: TInStoreMe;
4226
4407
  order?: Maybe<TOrder>;
4227
4408
  orders: TOrderQueryResult;
@@ -4355,12 +4536,19 @@ export type TInStore_StagedQuotesArgs = {
4355
4536
  export type TInStoreMe = TActiveCartInterface & TCartQueryInterface & TMeQueryInterface & TOrderQueryInterface & TShoppingListQueryInterface & {
4356
4537
  __typename?: 'InStoreMe';
4357
4538
  activeCart?: Maybe<TCart>;
4539
+ /** BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta */
4358
4540
  cart?: Maybe<TCart>;
4541
+ /** BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta */
4359
4542
  carts: TCartQueryResult;
4543
+ /** BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta */
4360
4544
  customer?: Maybe<TCustomer>;
4545
+ /** BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta */
4361
4546
  order?: Maybe<TOrder>;
4547
+ /** BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta */
4362
4548
  orders: TOrderQueryResult;
4549
+ /** BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta */
4363
4550
  shoppingList?: Maybe<TShoppingList>;
4551
+ /** BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta */
4364
4552
  shoppingLists: TShoppingListQueryResult;
4365
4553
  };
4366
4554
  export type TInStoreMe_CartArgs = {
@@ -4438,6 +4626,7 @@ export type TInterfaceInteractionsRawResult = {
4438
4626
  results: Array<TInterfaceInteractionsRaw>;
4439
4627
  total: Scalars['Int'];
4440
4628
  };
4629
+ /** Inventory allows you to track stock quantity per SKU and optionally per supply channel */
4441
4630
  export type TInventoryEntry = TReferenceExpandable & TVersioned & {
4442
4631
  __typename?: 'InventoryEntry';
4443
4632
  availableQuantity: Scalars['Long'];
@@ -4506,8 +4695,22 @@ export type TInventoryEntryUpdateAction = {
4506
4695
  setSupplyChannel?: InputMaybe<TSetInventoryEntrySupplyChannel>;
4507
4696
  };
4508
4697
  export declare enum TInventoryMode {
4698
+ /**
4699
+ * Adding items to cart and ordering is independent of inventory. No inventory checks or modifications.
4700
+ * This is the default mode for a new cart.
4701
+ */
4509
4702
  None = "None",
4703
+ /**
4704
+ * Creating an order will fail with an OutOfStock error if an unavailable line item exists. Line items in the cart
4705
+ * are only reserved for the duration of the ordering transaction.
4706
+ */
4510
4707
  ReserveOnOrder = "ReserveOnOrder",
4708
+ /**
4709
+ * Orders are tracked on inventory. That means, ordering a LineItem will decrement the available quantity on the
4710
+ * respective InventoryEntry. Creating an order will succeed even if the line item’s available quantity is zero or
4711
+ * negative. But creating an order will fail with an OutOfStock error if no matching inventory entry exists for a
4712
+ * line item.
4713
+ */
4511
4714
  TrackOnly = "TrackOnly"
4512
4715
  }
4513
4716
  export type TItemShippingAddressTargetDraft = {
@@ -4573,6 +4776,17 @@ export type TLimitWithCurrent = {
4573
4776
  current?: Maybe<Scalars['Long']>;
4574
4777
  limit?: Maybe<Scalars['Long']>;
4575
4778
  };
4779
+ /**
4780
+ * A line item is a snapshot of a product variant at the time it was added to the cart.
4781
+ *
4782
+ * Since a product variant may change at any time, the ProductVariant data is copied into the field variant.
4783
+ * The relation to the Product is kept but the line item will not automatically update if the product variant changes.
4784
+ * On the cart, the line item can be updated manually. The productSlug refers to the current version of the product.
4785
+ * It can be used to link to the product. If the product has been deleted, the line item remains but refers to a
4786
+ * non-existent product and the productSlug is left empty.
4787
+ *
4788
+ * Please also note that creating an order is impossible if the product or product variant a line item relates to has been deleted.
4789
+ */
4576
4790
  export type TLineItem = {
4577
4791
  __typename?: 'LineItem';
4578
4792
  addedAt?: Maybe<Scalars['DateTime']>;
@@ -4607,10 +4821,32 @@ export type TLineItem = {
4607
4821
  totalPrice?: Maybe<TMoney>;
4608
4822
  variant?: Maybe<TProductVariant>;
4609
4823
  };
4824
+ /**
4825
+ * A line item is a snapshot of a product variant at the time it was added to the cart.
4826
+ *
4827
+ * Since a product variant may change at any time, the ProductVariant data is copied into the field variant.
4828
+ * The relation to the Product is kept but the line item will not automatically update if the product variant changes.
4829
+ * On the cart, the line item can be updated manually. The productSlug refers to the current version of the product.
4830
+ * It can be used to link to the product. If the product has been deleted, the line item remains but refers to a
4831
+ * non-existent product and the productSlug is left empty.
4832
+ *
4833
+ * Please also note that creating an order is impossible if the product or product variant a line item relates to has been deleted.
4834
+ */
4610
4835
  export type TLineItem_NameArgs = {
4611
4836
  acceptLanguage?: InputMaybe<Array<Scalars['Locale']>>;
4612
4837
  locale?: InputMaybe<Scalars['Locale']>;
4613
4838
  };
4839
+ /**
4840
+ * A line item is a snapshot of a product variant at the time it was added to the cart.
4841
+ *
4842
+ * Since a product variant may change at any time, the ProductVariant data is copied into the field variant.
4843
+ * The relation to the Product is kept but the line item will not automatically update if the product variant changes.
4844
+ * On the cart, the line item can be updated manually. The productSlug refers to the current version of the product.
4845
+ * It can be used to link to the product. If the product has been deleted, the line item remains but refers to a
4846
+ * non-existent product and the productSlug is left empty.
4847
+ *
4848
+ * Please also note that creating an order is impossible if the product or product variant a line item relates to has been deleted.
4849
+ */
4614
4850
  export type TLineItem_ProductSlugArgs = {
4615
4851
  acceptLanguage?: InputMaybe<Array<Scalars['Locale']>>;
4616
4852
  locale?: InputMaybe<Scalars['Locale']>;
@@ -4664,12 +4900,26 @@ export type TLineItemImportDraft = {
4664
4900
  variant: TProductVariantImportDraft;
4665
4901
  };
4666
4902
  export declare enum TLineItemMode {
4903
+ /**
4904
+ * The line item was added automatically, because a discount has added a free gift to the cart.
4905
+ * The quantity can not be increased, and it won’t be merged when the same product variant is added.
4906
+ * If the gift is removed, an entry is added to the "refusedGifts" array and the discount won’t be applied again
4907
+ * to the cart. The price can not be changed externally.
4908
+ * All other updates, such as the ones related to custom fields, can be used.
4909
+ */
4667
4910
  GiftLineItem = "GiftLineItem",
4911
+ /**
4912
+ * The line item was added during cart creation or with the update action addLineItem. Its quantity can be
4913
+ * changed without restrictions.
4914
+ */
4668
4915
  Standard = "Standard"
4669
4916
  }
4670
4917
  export declare enum TLineItemPriceMode {
4918
+ /** The line item price was set externally. Cart discounts can apply to line items with this price mode. All update actions that change the quantity of a line item with this price mode require the externalPrice field to be given. */
4671
4919
  ExternalPrice = "ExternalPrice",
4920
+ /** The line item price with the total was set externally. */
4672
4921
  ExternalTotal = "ExternalTotal",
4922
+ /** The price is selected form the product variant. This is the default mode. */
4673
4923
  Platform = "Platform"
4674
4924
  }
4675
4925
  export type TLineItemReturnItem = TReturnItem & {
@@ -4824,20 +5074,35 @@ export type TLocation = {
4824
5074
  export type TMe = TActiveCartInterface & TCartQueryInterface & TMeQueryInterface & TOrderQueryInterface & TShoppingListQueryInterface & {
4825
5075
  __typename?: 'Me';
4826
5076
  activeCart?: Maybe<TCart>;
5077
+ /** BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta */
4827
5078
  businessUnit?: Maybe<TBusinessUnit>;
5079
+ /** BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta */
4828
5080
  businessUnits: TBusinessUnitQueryResult;
5081
+ /** BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta */
4829
5082
  cart?: Maybe<TCart>;
5083
+ /** BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta */
4830
5084
  carts: TCartQueryResult;
5085
+ /** BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta */
4831
5086
  customer?: Maybe<TCustomer>;
5087
+ /** BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta */
4832
5088
  order?: Maybe<TOrder>;
5089
+ /** BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta */
4833
5090
  orders: TOrderQueryResult;
5091
+ /** BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta */
4834
5092
  payment?: Maybe<TMyPayment>;
5093
+ /** BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta */
4835
5094
  payments: TMyPaymentQueryResult;
5095
+ /** BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta */
4836
5096
  quote?: Maybe<TQuote>;
5097
+ /** BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta */
4837
5098
  quoteRequest?: Maybe<TQuoteRequest>;
5099
+ /** BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta */
4838
5100
  quoteRequests: TQuoteRequestQueryResult;
5101
+ /** BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta */
4839
5102
  quotes: TQuoteQueryResult;
5103
+ /** BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta */
4840
5104
  shoppingList?: Maybe<TShoppingList>;
5105
+ /** BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta */
4841
5106
  shoppingLists: TShoppingListQueryResult;
4842
5107
  };
4843
5108
  export type TMe_BusinessUnitArgs = {
@@ -4908,6 +5173,7 @@ export type TMe_ShoppingListsArgs = {
4908
5173
  sort?: InputMaybe<Array<Scalars['String']>>;
4909
5174
  where?: InputMaybe<Scalars['String']>;
4910
5175
  };
5176
+ /** The me field gives access to the data that is specific to the customer or anonymous session linked to the access token. */
4911
5177
  export type TMeFieldInterface = {
4912
5178
  me: TMeQueryInterface;
4913
5179
  };
@@ -5019,6 +5285,7 @@ export type TMoney = TBaseMoney & {
5019
5285
  __typename?: 'Money';
5020
5286
  centAmount: Scalars['Long'];
5021
5287
  currencyCode: Scalars['Currency'];
5288
+ /** For the `Money` it equals to the default number of fraction digits used with the currency. */
5022
5289
  fractionDigits: Scalars['Int'];
5023
5290
  type: Scalars['String'];
5024
5291
  };
@@ -5105,11 +5372,16 @@ export type TMutation = {
5105
5372
  createExtension?: Maybe<TExtension>;
5106
5373
  createInventoryEntry?: Maybe<TInventoryEntry>;
5107
5374
  createMyBusinessUnit?: Maybe<TBusinessUnit>;
5375
+ /** BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta */
5108
5376
  createMyCart?: Maybe<TCart>;
5377
+ /** BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta */
5109
5378
  createMyOrderFromCart?: Maybe<TOrder>;
5379
+ /** BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta */
5110
5380
  createMyOrderFromQuote?: Maybe<TOrder>;
5381
+ /** BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta */
5111
5382
  createMyPayment?: Maybe<TMyPayment>;
5112
5383
  createMyQuoteRequest?: Maybe<TQuoteRequest>;
5384
+ /** BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta */
5113
5385
  createMyShoppingList?: Maybe<TShoppingList>;
5114
5386
  createOrUpdateCustomObject?: Maybe<TCustomObject>;
5115
5387
  createOrderEdit?: Maybe<TOrderEdit>;
@@ -5134,17 +5406,66 @@ export type TMutation = {
5134
5406
  createTaxCategory?: Maybe<TTaxCategory>;
5135
5407
  createTypeDefinition?: Maybe<TTypeDefinition>;
5136
5408
  createZone?: Maybe<TZone>;
5409
+ /** BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta */
5137
5410
  customerChangeMyPassword?: Maybe<TCustomer>;
5138
5411
  customerChangePassword?: Maybe<TCustomer>;
5412
+ /** Verifies customer's email using a token. */
5139
5413
  customerConfirmEmail?: Maybe<TCustomer>;
5414
+ /** BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta */
5140
5415
  customerConfirmMyEmail?: Maybe<TCustomer>;
5141
5416
  customerCreateEmailVerificationToken: TCustomerEmailToken;
5417
+ /** The token value is used to reset the password of the customer with the given email. The token is valid only for 10 minutes. */
5142
5418
  customerCreatePasswordResetToken?: Maybe<TCustomerPasswordToken>;
5419
+ /** BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta */
5143
5420
  customerResetMyPassword?: Maybe<TCustomer>;
5421
+ /**
5422
+ * The following workflow can be used to reset the customer’s password:
5423
+ *
5424
+ * 1. Create a password reset token and send it embedded in a link to the customer.
5425
+ * 2. When the customer clicks on the link, you may optionally retrieve customer by password token.
5426
+ * 3. When the customer entered new password, use reset customer’s password to reset the password.
5427
+ */
5144
5428
  customerResetPassword?: Maybe<TCustomer>;
5429
+ /**
5430
+ * Retrieves the authenticated customer (a customer that matches the given email/password pair).
5431
+ *
5432
+ * There may be carts and orders created before the sign in that should be assigned to the customer account. With the `anonymousCartId`, a single anonymous cart can be assigned. With the `anonymousId`, all orders and carts that have this `anonymousId` set will be assigned to the customer.
5433
+ * If both `anonymousCartId` and `anonymousId` are given, the anonymous cart must have the `anonymousId`.
5434
+ *
5435
+ * Additionally, there might also exist one or more active customer carts from an earlier session. On customer sign in there are several ways how to proceed with this cart and the cart referenced by the `anonymousCartId`.
5436
+ *
5437
+ * * If the customer does not have a cart yet, the anonymous cart becomes the customer's cart.
5438
+ * * If the customer already has one or more carts, the content of the anonymous cart will be copied to the customer's active cart that has been modified most recently.
5439
+ *
5440
+ * In this case the `CartState` of the anonymous cart gets changed to `Merged` while the customer's cart remains the `Active` cart.
5441
+ *
5442
+ * If a `LineItem` in the anonymous cart matches an existing line item, or a `CustomLineItem` matches an existing custom line item in the customer's cart, the maximum quantity of both line items is used as the new quantity.
5443
+ *
5444
+ * `ItemShippingDetails` are copied from the item with the highest quantity.
5445
+ *
5446
+ * If `itemShippingAddresses` are different in the two carts, the resulting cart contains the addresses of both the customer cart and the anonymous cart.
5447
+ *
5448
+ * Note, that it is not possible to merge carts that differ in their currency (set during creation of the cart).
5449
+ *
5450
+ * If a cart is is returned as part of the `CustomerSignInResult`, it has been recalculated (it will have up-to-date prices, taxes and discounts, and invalid line items have been removed).
5451
+ */
5145
5452
  customerSignIn: TCustomerSignInResult;
5453
+ /**
5454
+ * BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta
5455
+ *
5456
+ * Retrieves the authenticated customer (a customer that matches the given email/password pair).
5457
+ *
5458
+ * If used with an access token for Anonymous Sessions, all orders and carts belonging to the `anonymousId` will be assigned to the newly created customer.
5459
+ *
5460
+ * * If the customer does not have a cart yet, the anonymous cart that was modified most recently becomes the customer's cart.
5461
+ * * If the customer already has a cart, the most recently modified anonymous cart will be handled according to the `AnonymousCartSignInMode`.
5462
+ *
5463
+ * If a cart is is returned as part of the `CustomerSignInResult`, it has been recalculated (it will have up-to-date prices, taxes and discounts, and invalid line items have been removed).
5464
+ */
5146
5465
  customerSignMeIn: TCustomerSignInResult;
5466
+ /** BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta If used with an access token for Anonymous Sessions, all orders and carts belonging to the anonymousId will be assigned to the newly created customer. */
5147
5467
  customerSignMeUp: TCustomerSignInResult;
5468
+ /** Creates a customer. If an anonymous cart is given then the cart is assigned to the created customer and the version number of the Cart will increase. If the id of an anonymous session is given, all carts and orders will be assigned to the created customer. */
5148
5469
  customerSignUp: TCustomerSignInResult;
5149
5470
  deleteApiClient?: Maybe<TApiClientWithoutSecret>;
5150
5471
  deleteAssociateRole?: Maybe<TAssociateRole>;
@@ -5160,9 +5481,12 @@ export type TMutation = {
5160
5481
  deleteDiscountCode?: Maybe<TDiscountCode>;
5161
5482
  deleteExtension?: Maybe<TExtension>;
5162
5483
  deleteInventoryEntry?: Maybe<TInventoryEntry>;
5484
+ /** BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta */
5163
5485
  deleteMyCart?: Maybe<TCart>;
5486
+ /** BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta */
5164
5487
  deleteMyCustomer?: Maybe<TCustomer>;
5165
5488
  deleteMyPayment?: Maybe<TMyPayment>;
5489
+ /** BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta */
5166
5490
  deleteMyShoppingList?: Maybe<TShoppingList>;
5167
5491
  deleteOrder?: Maybe<TOrder>;
5168
5492
  deleteOrderEdit?: Maybe<TOrderEdit>;
@@ -5187,7 +5511,9 @@ export type TMutation = {
5187
5511
  deleteZone?: Maybe<TZone>;
5188
5512
  importOrder?: Maybe<TOrder>;
5189
5513
  replicateCart?: Maybe<TCart>;
5514
+ /** BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta */
5190
5515
  replicateMyCart?: Maybe<TCart>;
5516
+ /** BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta Signs up a new customer and associates it with the business unit. */
5191
5517
  signUpInMyBusinessUnit: TCustomerSignInResult;
5192
5518
  updateApprovalFlow?: Maybe<TApprovalFlow>;
5193
5519
  updateApprovalRule?: Maybe<TApprovalRule>;
@@ -5204,11 +5530,14 @@ export type TMutation = {
5204
5530
  updateExtension?: Maybe<TExtension>;
5205
5531
  updateInventoryEntry?: Maybe<TInventoryEntry>;
5206
5532
  updateMyBusinessUnit?: Maybe<TBusinessUnit>;
5533
+ /** BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta */
5207
5534
  updateMyCart?: Maybe<TCart>;
5535
+ /** BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta */
5208
5536
  updateMyCustomer?: Maybe<TCustomer>;
5209
5537
  updateMyPayment?: Maybe<TMyPayment>;
5210
5538
  updateMyQuote?: Maybe<TQuote>;
5211
5539
  updateMyQuoteRequest?: Maybe<TQuoteRequest>;
5540
+ /** BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta */
5212
5541
  updateMyShoppingList?: Maybe<TShoppingList>;
5213
5542
  updateOrder?: Maybe<TOrder>;
5214
5543
  updateOrderEdit?: Maybe<TOrderEdit>;
@@ -5944,20 +6273,26 @@ export type TMutation_UpdateZoneArgs = {
5944
6273
  key?: InputMaybe<Scalars['String']>;
5945
6274
  version: Scalars['Long'];
5946
6275
  };
6276
+ /** BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta */
5947
6277
  export type TMyBusinessUnitDraft = {
5948
6278
  addresses?: InputMaybe<Array<TAddressInput>>;
6279
+ /** The indices of the billing addresses in the `addresses` list. The `billingAddressIds` of the customer will be set to the IDs of that addresses. */
5949
6280
  billingAddresses?: InputMaybe<Array<Scalars['Int']>>;
5950
6281
  contactEmail?: InputMaybe<Scalars['String']>;
5951
6282
  custom?: InputMaybe<TCustomFieldsDraft>;
6283
+ /** The index of the address in the `addresses` list. The `defaultBillingAddressId` of the customer will be set to the ID of that address. */
5952
6284
  defaultBillingAddress?: InputMaybe<Scalars['Int']>;
6285
+ /** The index of the address in the `addresses` list. The `defaultShippingAddressId` of the customer will be set to the ID of that address. */
5953
6286
  defaultShippingAddress?: InputMaybe<Scalars['Int']>;
5954
6287
  key: Scalars['String'];
5955
6288
  name: Scalars['String'];
5956
6289
  parentUnit?: InputMaybe<TResourceIdentifierInput>;
6290
+ /** The indices of the shipping addresses in the `addresses` list. The `shippingAddressIds` of the `Customer` will be set to the IDs of that addresses. */
5957
6291
  shippingAddresses?: InputMaybe<Array<Scalars['Int']>>;
5958
6292
  storeMode?: InputMaybe<Scalars['String']>;
5959
6293
  unitType: TBusinessUnitType;
5960
6294
  };
6295
+ /** BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta */
5961
6296
  export type TMyBusinessUnitUpdateAction = {
5962
6297
  addAddress?: InputMaybe<TAddMyBusinessUnitAddress>;
5963
6298
  addBillingAddressId?: InputMaybe<TAddMyBusinessUnitBillingAddressId>;
@@ -6075,6 +6410,10 @@ export type TMyLineItemDraft = {
6075
6410
  supplyChannel?: InputMaybe<TResourceIdentifierInput>;
6076
6411
  variantId?: InputMaybe<Scalars['Int']>;
6077
6412
  };
6413
+ /**
6414
+ * My Payments endpoint provides access to payments scoped to a specific user.
6415
+ * [documentation](https://docs.commercetools.com/api/projects/me-payments#mypayment)
6416
+ */
6078
6417
  export type TMyPayment = {
6079
6418
  __typename?: 'MyPayment';
6080
6419
  amountPlanned: TMoney;
@@ -6196,6 +6535,10 @@ export type TNumberType = TFieldType & {
6196
6535
  __typename?: 'NumberType';
6197
6536
  name: Scalars['String'];
6198
6537
  };
6538
+ /**
6539
+ * An order can be created from a cart, usually after a checkout process has been completed.
6540
+ * [documentation](https://docs.commercetools.com/api/projects/orders)
6541
+ */
6199
6542
  export type TOrder = TReferenceExpandable & TVersioned & {
6200
6543
  __typename?: 'Order';
6201
6544
  anonymousId?: Maybe<Scalars['String']>;
@@ -6221,6 +6564,7 @@ export type TOrder = TReferenceExpandable & TVersioned & {
6221
6564
  id: Scalars['String'];
6222
6565
  inventoryMode: TInventoryMode;
6223
6566
  itemShippingAddresses: Array<TAddress>;
6567
+ /** @deprecated An internal field that should not be used in customer logic */
6224
6568
  lastMessageSequenceNumber: Scalars['Long'];
6225
6569
  lastModifiedAt: Scalars['DateTime'];
6226
6570
  lastModifiedBy?: Maybe<TInitiator>;
@@ -6258,6 +6602,10 @@ export type TOrder = TReferenceExpandable & TVersioned & {
6258
6602
  totalPrice: TMoney;
6259
6603
  version: Scalars['Long'];
6260
6604
  };
6605
+ /**
6606
+ * An order can be created from a cart, usually after a checkout process has been completed.
6607
+ * [documentation](https://docs.commercetools.com/api/projects/orders)
6608
+ */
6261
6609
  export type TOrder_LineItemsArgs = {
6262
6610
  id?: InputMaybe<Scalars['String']>;
6263
6611
  };
@@ -6528,14 +6876,17 @@ export type TOrderPaymentStateChanged = TMessagePayload & TOrderMessagePayload &
6528
6876
  paymentState: TPaymentState;
6529
6877
  type: Scalars['String'];
6530
6878
  };
6879
+ /** Fields to access orders. Includes direct access to a single order and searching for orders. */
6531
6880
  export type TOrderQueryInterface = {
6532
6881
  order?: Maybe<TOrder>;
6533
6882
  orders: TOrderQueryResult;
6534
6883
  };
6884
+ /** Fields to access orders. Includes direct access to a single order and searching for orders. */
6535
6885
  export type TOrderQueryInterface_OrderArgs = {
6536
6886
  id?: InputMaybe<Scalars['String']>;
6537
6887
  orderNumber?: InputMaybe<Scalars['String']>;
6538
6888
  };
6889
+ /** Fields to access orders. Includes direct access to a single order and searching for orders. */
6539
6890
  export type TOrderQueryInterface_OrdersArgs = {
6540
6891
  limit?: InputMaybe<Scalars['Int']>;
6541
6892
  offset?: InputMaybe<Scalars['Int']>;
@@ -6778,6 +7129,10 @@ export type TParcelTrackingDataUpdated = TMessagePayload & TOrderMessagePayload
6778
7129
  trackingData?: Maybe<TTrackingData>;
6779
7130
  type: Scalars['String'];
6780
7131
  };
7132
+ /**
7133
+ * Payments hold information about the current state of receiving and/or refunding money.
7134
+ * [documentation](https://docs.commercetools.com/api/projects/payments)
7135
+ */
6781
7136
  export type TPayment = TVersioned & {
6782
7137
  __typename?: 'Payment';
6783
7138
  amountPlanned: TMoney;
@@ -6798,6 +7153,10 @@ export type TPayment = TVersioned & {
6798
7153
  transactions: Array<TTransaction>;
6799
7154
  version: Scalars['Long'];
6800
7155
  };
7156
+ /**
7157
+ * Payments hold information about the current state of receiving and/or refunding money.
7158
+ * [documentation](https://docs.commercetools.com/api/projects/payments)
7159
+ */
6801
7160
  export type TPayment_InterfaceInteractionsRawArgs = {
6802
7161
  limit?: InputMaybe<Scalars['Int']>;
6803
7162
  offset?: InputMaybe<Scalars['Int']>;
@@ -7011,8 +7370,14 @@ export type TPriceFunctionDraft = {
7011
7370
  currencyCode: Scalars['Currency'];
7012
7371
  function: Scalars['String'];
7013
7372
  };
7373
+ /**
7374
+ * This mode determines which type of Prices the system uses for
7375
+ * Product Price Selection as well as for LineItem Price selection
7376
+ */
7014
7377
  export declare enum TPriceMode {
7378
+ /** The system looks up prices from the `prices` field of the ProductVariant inside a Product. */
7015
7379
  Embedded = "Embedded",
7380
+ /** The system looks up prices from Standalone Prices, stored separately from Products. */
7016
7381
  Standalone = "Standalone"
7017
7382
  }
7018
7383
  export type TPriceSelectorInput = {
@@ -7072,8 +7437,34 @@ export type TProductAssignmentQueryResult = {
7072
7437
  results: Array<TProductAssignment>;
7073
7438
  total: Scalars['Long'];
7074
7439
  };
7440
+ /**
7441
+ * An input object used to define a ProductAttribute.
7442
+ *
7443
+ * The value should be passed in a form of escaped JSON.
7444
+ *
7445
+ *
7446
+ * Examples for `value`:
7447
+ *
7448
+ * * FieldType `String`: `"\"This is a string\""`
7449
+ * * FieldType `DateTimeType`: `"\"2018-10-12T14:00:00.000Z\""`
7450
+ * * FieldType `Number`: `"4"`
7451
+ * * FieldType `Set` with an elementType of `String`: `"[\"This is a string\", \"This is another string\"]"`
7452
+ * * FieldType `Reference`: `"{\"id\": \"b911b62d-353a-4388-93ee-8d488d9af962\", \"typeId\": \"product\"}"`
7453
+ */
7075
7454
  export type TProductAttributeInput = {
7076
7455
  name: Scalars['String'];
7456
+ /**
7457
+ * The value should be passed in a form of escaped JSON.
7458
+ *
7459
+ *
7460
+ * Examples for `value`:
7461
+ *
7462
+ * * FieldType `String`: `"\"This is a string\""`
7463
+ * * FieldType `DateTimeType`: `"\"2018-10-12T14:00:00.000Z\""`
7464
+ * * FieldType `Number`: `"4"`
7465
+ * * FieldType `Set` with an elementType of `String`: `"[\"This is a string\", \"This is another string\"]"`
7466
+ * * FieldType `Reference`: `"{\"id\": \"b911b62d-353a-4388-93ee-8d488d9af962\", \"typeId\": \"product\"}"`
7467
+ */
7077
7468
  value: Scalars['String'];
7078
7469
  };
7079
7470
  export type TProductCatalogData = {
@@ -7166,6 +7557,21 @@ export type TProductDeleted = TMessagePayload & {
7166
7557
  removedImageUrls: Scalars['Set'];
7167
7558
  type: Scalars['String'];
7168
7559
  };
7560
+ /**
7561
+ *
7562
+ * A product price can be discounted in two ways:
7563
+ *
7564
+ * * with a relative or an absolute product discount, which will be automatically applied to all prices in a product that match a discount predicate.
7565
+ * A relative discount reduces the matching price by a fraction (for example 10 % off). An absolute discount reduces the matching price by a fixed amount (for example 10€ off). If more than one product discount matches a price, the discount sort order determines which one will be applied.
7566
+ * * with an external product discount, which can then be used to explicitly set a discounted value on a particular product price.
7567
+ *
7568
+ * The discounted price is stored in the discounted field of the Product Price.
7569
+ *
7570
+ * Note that when a discount is created, updated or removed it can take up to 15 minutes to update all the prices with the discounts.
7571
+ *
7572
+ * The maximum number of ProductDiscounts that can be active at the same time is **200**.
7573
+ *
7574
+ */
7169
7575
  export type TProductDiscount = TReferenceExpandable & TVersioned & {
7170
7576
  __typename?: 'ProductDiscount';
7171
7577
  createdAt: Scalars['DateTime'];
@@ -7188,10 +7594,40 @@ export type TProductDiscount = TReferenceExpandable & TVersioned & {
7188
7594
  value: TProductDiscountValue;
7189
7595
  version: Scalars['Long'];
7190
7596
  };
7597
+ /**
7598
+ *
7599
+ * A product price can be discounted in two ways:
7600
+ *
7601
+ * * with a relative or an absolute product discount, which will be automatically applied to all prices in a product that match a discount predicate.
7602
+ * A relative discount reduces the matching price by a fraction (for example 10 % off). An absolute discount reduces the matching price by a fixed amount (for example 10€ off). If more than one product discount matches a price, the discount sort order determines which one will be applied.
7603
+ * * with an external product discount, which can then be used to explicitly set a discounted value on a particular product price.
7604
+ *
7605
+ * The discounted price is stored in the discounted field of the Product Price.
7606
+ *
7607
+ * Note that when a discount is created, updated or removed it can take up to 15 minutes to update all the prices with the discounts.
7608
+ *
7609
+ * The maximum number of ProductDiscounts that can be active at the same time is **200**.
7610
+ *
7611
+ */
7191
7612
  export type TProductDiscount_DescriptionArgs = {
7192
7613
  acceptLanguage?: InputMaybe<Array<Scalars['Locale']>>;
7193
7614
  locale?: InputMaybe<Scalars['Locale']>;
7194
7615
  };
7616
+ /**
7617
+ *
7618
+ * A product price can be discounted in two ways:
7619
+ *
7620
+ * * with a relative or an absolute product discount, which will be automatically applied to all prices in a product that match a discount predicate.
7621
+ * A relative discount reduces the matching price by a fraction (for example 10 % off). An absolute discount reduces the matching price by a fixed amount (for example 10€ off). If more than one product discount matches a price, the discount sort order determines which one will be applied.
7622
+ * * with an external product discount, which can then be used to explicitly set a discounted value on a particular product price.
7623
+ *
7624
+ * The discounted price is stored in the discounted field of the Product Price.
7625
+ *
7626
+ * Note that when a discount is created, updated or removed it can take up to 15 minutes to update all the prices with the discounts.
7627
+ *
7628
+ * The maximum number of ProductDiscounts that can be active at the same time is **200**.
7629
+ *
7630
+ */
7195
7631
  export type TProductDiscount_NameArgs = {
7196
7632
  acceptLanguage?: InputMaybe<Array<Scalars['Locale']>>;
7197
7633
  locale?: InputMaybe<Scalars['Locale']>;
@@ -7569,6 +8005,7 @@ export type TProductRevertedStagedChanges = TMessagePayload & {
7569
8005
  removedImageUrls: Scalars['Set'];
7570
8006
  type: Scalars['String'];
7571
8007
  };
8008
+ /** CLOSED BETA: This feature is subject to change and should not be used in production. https://docs.commercetools.com/api/contract#closed-beta */
7572
8009
  export declare enum TProductSearchIndexingMode {
7573
8010
  ProductProjectionsSearch = "ProductProjectionsSearch",
7574
8011
  ProductsSearch = "ProductsSearch"
@@ -7581,12 +8018,14 @@ export type TProductSearchPriceTier = {
7581
8018
  export type TProductSearchVariant = {
7582
8019
  __typename?: 'ProductSearchVariant';
7583
8020
  assets: Array<TAsset>;
8021
+ /** This field contains raw attributes data */
7584
8022
  attributesRaw: Array<TRawProductSearchAttribute>;
7585
8023
  availability?: Maybe<TProductSearchVariantAvailabilityWithChannels>;
7586
8024
  id: Scalars['Int'];
7587
8025
  images: Array<TImageProductSearch>;
7588
8026
  isMatchingVariant?: Maybe<Scalars['Boolean']>;
7589
8027
  key?: Maybe<Scalars['String']>;
8028
+ /** Returns a single price based on the price selection rules. */
7590
8029
  price?: Maybe<TProductPriceSearch>;
7591
8030
  prices?: Maybe<Array<TProductPriceSearch>>;
7592
8031
  scopedPrice?: Maybe<TScopedPrice>;
@@ -7604,6 +8043,7 @@ export type TProductSearchVariant_PriceArgs = {
7604
8043
  customerGroupId?: InputMaybe<Scalars['String']>;
7605
8044
  date?: InputMaybe<Scalars['DateTime']>;
7606
8045
  };
8046
+ /** Product variant availabilities */
7607
8047
  export type TProductSearchVariantAvailabilitiesResult = {
7608
8048
  __typename?: 'ProductSearchVariantAvailabilitiesResult';
7609
8049
  limit?: Maybe<Scalars['Int']>;
@@ -7611,6 +8051,7 @@ export type TProductSearchVariantAvailabilitiesResult = {
7611
8051
  results: Array<TProductSearchVariantAvailabilityWithChannel>;
7612
8052
  total: Scalars['Int'];
7613
8053
  };
8054
+ /** Product variant availability */
7614
8055
  export type TProductSearchVariantAvailability = {
7615
8056
  __typename?: 'ProductSearchVariantAvailability';
7616
8057
  availableQuantity?: Maybe<Scalars['Long']>;
@@ -7672,7 +8113,9 @@ export type TProductSelectionDeleted = TMessagePayload & {
7672
8113
  type: Scalars['String'];
7673
8114
  };
7674
8115
  export declare enum TProductSelectionMode {
8116
+ /** Mode of Product Selection used to include a specific list of individual Products */
7675
8117
  Individual = "Individual",
8118
+ /** Mode of Product Selection used to exclude a specific list of individual Products */
7676
8119
  IndividualExclusion = "IndividualExclusion"
7677
8120
  }
7678
8121
  export type TProductSelectionProductAdded = TMessagePayload & {
@@ -7695,9 +8138,11 @@ export type TProductSelectionProductRemoved = TMessagePayload & {
7695
8138
  productRef: TReference;
7696
8139
  type: Scalars['String'];
7697
8140
  };
8141
+ /** Fields to access product selection assignments. */
7698
8142
  export type TProductSelectionQueryInterface = {
7699
8143
  productSelectionAssignments: TProductAssignmentQueryResult;
7700
8144
  };
8145
+ /** Fields to access product selection assignments. */
7701
8146
  export type TProductSelectionQueryInterface_ProductSelectionAssignmentsArgs = {
7702
8147
  limit?: InputMaybe<Scalars['Int']>;
7703
8148
  offset?: InputMaybe<Scalars['Int']>;
@@ -8109,11 +8554,13 @@ export type TProductUpdateAction = {
8109
8554
  export type TProductVariant = {
8110
8555
  __typename?: 'ProductVariant';
8111
8556
  assets: Array<TAsset>;
8557
+ /** This field contains raw attributes data */
8112
8558
  attributesRaw: Array<TRawProductAttribute>;
8113
8559
  availability?: Maybe<TProductVariantAvailabilityWithChannels>;
8114
8560
  id: Scalars['Int'];
8115
8561
  images: Array<TImage>;
8116
8562
  key?: Maybe<Scalars['String']>;
8563
+ /** Returns a single price based on the price selection rules. */
8117
8564
  price?: Maybe<TProductPrice>;
8118
8565
  prices?: Maybe<Array<TProductPrice>>;
8119
8566
  sku?: Maybe<Scalars['String']>;
@@ -8135,6 +8582,7 @@ export type TProductVariantAdded = TMessagePayload & {
8135
8582
  type: Scalars['String'];
8136
8583
  variant: TProductVariant;
8137
8584
  };
8585
+ /** Product variant availabilities */
8138
8586
  export type TProductVariantAvailabilitiesResult = {
8139
8587
  __typename?: 'ProductVariantAvailabilitiesResult';
8140
8588
  limit?: Maybe<Scalars['Int']>;
@@ -8142,6 +8590,7 @@ export type TProductVariantAvailabilitiesResult = {
8142
8590
  results: Array<TProductVariantAvailabilityWithChannel>;
8143
8591
  total: Scalars['Int'];
8144
8592
  };
8593
+ /** Product variant availability */
8145
8594
  export type TProductVariantAvailability = {
8146
8595
  __typename?: 'ProductVariantAvailability';
8147
8596
  availableQuantity?: Maybe<Scalars['Long']>;
@@ -8214,16 +8663,19 @@ export type TProductVariantSelectionIncludeOnly = TProductVariantSelection & {
8214
8663
  skus: Array<Scalars['String']>;
8215
8664
  type: Scalars['String'];
8216
8665
  };
8666
+ /** CLOSED BETA: This feature is subject to change and should not be used in production. https://docs.commercetools.com/api/contract#closed-beta */
8217
8667
  export type TProductsSearchConfiguration = {
8218
8668
  __typename?: 'ProductsSearchConfiguration';
8219
8669
  lastModifiedAt: Scalars['DateTime'];
8220
8670
  lastModifiedBy?: Maybe<TInitiator>;
8221
8671
  status: TProductsSearchStatus;
8222
8672
  };
8673
+ /** CLOSED BETA: This feature is subject to change and should not be used in production. https://docs.commercetools.com/api/contract#closed-beta */
8223
8674
  export declare enum TProductsSearchStatus {
8224
8675
  Activated = "Activated",
8225
8676
  Deactivated = "Deactivated"
8226
8677
  }
8678
+ /** Contains information about the limits of your project. */
8227
8679
  export type TProjectCustomLimitsProjection = {
8228
8680
  __typename?: 'ProjectCustomLimitsProjection';
8229
8681
  attributeGroups: TAttributeGroupLimitsProjection;
@@ -8248,6 +8700,7 @@ export type TProjectCustomLimitsProjection = {
8248
8700
  taxCategories: TTaxCategoryLimitsProjection;
8249
8701
  zones: TZoneLimitsProjection;
8250
8702
  };
8703
+ /** Project contains information about project. */
8251
8704
  export type TProjectProjection = {
8252
8705
  __typename?: 'ProjectProjection';
8253
8706
  businessUnits?: Maybe<TBusinessUnitConfiguration>;
@@ -8270,11 +8723,13 @@ export type TProjectProjection = {
8270
8723
  version: Scalars['Long'];
8271
8724
  };
8272
8725
  export type TProjectSettingsUpdateAction = {
8726
+ /** CLOSED BETA: This feature is subject to change and should not be used in production. https://docs.commercetools.com/api/contract#closed-beta */
8273
8727
  changeBusinessUnitSearchStatus?: InputMaybe<TChangeProjectSettingsBusinessUnitSearchStatus>;
8274
8728
  changeCartsConfiguration?: InputMaybe<TChangeProjectSettingsCartsConfiguration>;
8275
8729
  changeCountries?: InputMaybe<TChangeProjectSettingsCountries>;
8276
8730
  changeCountryTaxRateFallbackEnabled?: InputMaybe<TChangeProjectSettingsCountryTaxRateFallbackEnabled>;
8277
8731
  changeCurrencies?: InputMaybe<TChangeProjectSettingsCurrencies>;
8732
+ /** CLOSED BETA: This feature is subject to change and should not be used in production. https://docs.commercetools.com/api/contract#closed-beta */
8278
8733
  changeCustomerSearchStatus?: InputMaybe<TChangeProjectSettingsCustomerSearchStatus>;
8279
8734
  changeLanguages?: InputMaybe<TChangeProjectSettingsLanguages>;
8280
8735
  changeMessagesConfiguration?: InputMaybe<TChangeProjectSettingsMessagesConfiguration>;
@@ -8283,9 +8738,11 @@ export type TProjectSettingsUpdateAction = {
8283
8738
  changeName?: InputMaybe<TChangeProjectSettingsName>;
8284
8739
  changeOrderSearchStatus?: InputMaybe<TChangeProjectSettingsOrderSearchStatus>;
8285
8740
  changeProductSearchIndexingEnabled?: InputMaybe<TChangeProjectSettingsProductSearchIndexingEnabled>;
8741
+ /** CLOSED BETA: This feature is subject to change and should not be used in production. https://docs.commercetools.com/api/contract#closed-beta */
8286
8742
  changeProjectSettingsProductSearchIndexingEnabled?: InputMaybe<TChangeProjectSettingsProductSearchIndexingEnabled>;
8287
8743
  changeShoppingListsConfiguration?: InputMaybe<TChangeProjectSettingsShoppingListsConfiguration>;
8288
8744
  setExternalOAuth?: InputMaybe<TSetProjectSettingsExternalOAuth>;
8745
+ /** BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta */
8289
8746
  setMyBusinessUnitAssociateRoleOnCreation?: InputMaybe<TSetProjectSettingsMyBusinessUnitAssociateRoleOnCreation>;
8290
8747
  setShippingRateInputType?: InputMaybe<TSetProjectSettingsShippingRateInputType>;
8291
8748
  };
@@ -8293,7 +8750,9 @@ export type TPublishProduct = {
8293
8750
  scope?: InputMaybe<TPublishScope>;
8294
8751
  };
8295
8752
  export declare enum TPublishScope {
8753
+ /** Publishes the complete staged projection */
8296
8754
  All = "All",
8755
+ /** Publishes only prices on the staged projection */
8297
8756
  Prices = "Prices"
8298
8757
  }
8299
8758
  export type TPublishTailoring = {
@@ -8309,6 +8768,7 @@ export type TQuery = TCartQueryInterface & TCustomerActiveCartInterface & TCusto
8309
8768
  __typename?: 'Query';
8310
8769
  apiClient?: Maybe<TApiClientWithoutSecret>;
8311
8770
  apiClients: TApiClientWithoutSecretQueryResult;
8771
+ /** This field gives access to the resources (such as carts) as an associate of a given business unit. */
8312
8772
  asAssociate: TAsAssociate;
8313
8773
  associateRole?: Maybe<TAssociateRole>;
8314
8774
  associateRoles: TAssociateRoleQueryResult;
@@ -8322,7 +8782,9 @@ export type TQuery = TCartQueryInterface & TCustomerActiveCartInterface & TCusto
8322
8782
  carts: TCartQueryResult;
8323
8783
  categories: TCategoryQueryResult;
8324
8784
  category?: Maybe<TCategory>;
8785
+ /** Autocomplete the categories based on category fields like name, description, etc. */
8325
8786
  categoryAutocomplete: TCategorySearchResult;
8787
+ /** Search the categories using full-text search, filtering and sorting */
8326
8788
  categorySearch: TCategorySearchResult;
8327
8789
  channel?: Maybe<TChannel>;
8328
8790
  channels: TChannelQueryResult;
@@ -8337,11 +8799,18 @@ export type TQuery = TCartQueryInterface & TCustomerActiveCartInterface & TCusto
8337
8799
  discountCodes: TDiscountCodeQueryResult;
8338
8800
  extension?: Maybe<TExtension>;
8339
8801
  extensions: TExtensionQueryResult;
8802
+ /** This field gives access to the resources (such as carts) that are inside the given store. */
8340
8803
  inStore: TInStore;
8804
+ /** This field gives access to the resources (such as carts) that are inside one of the given stores. */
8341
8805
  inStores: TInStore;
8342
8806
  inventoryEntries: TInventoryEntryQueryResult;
8343
8807
  inventoryEntry?: Maybe<TInventoryEntry>;
8344
8808
  limits: TProjectCustomLimitsProjection;
8809
+ /**
8810
+ * This field can only be used with an access token created with the password flow or with an anonymous session.
8811
+ *
8812
+ * It gives access to the data that is specific to the customer or the anonymous session linked to the access token.
8813
+ */
8345
8814
  me: TMe;
8346
8815
  message?: Maybe<TMessage>;
8347
8816
  messages: TMessageQueryResult;
@@ -8379,7 +8848,15 @@ export type TQuery = TCartQueryInterface & TCustomerActiveCartInterface & TCusto
8379
8848
  shoppingLists: TShoppingListQueryResult;
8380
8849
  stagedQuote?: Maybe<TStagedQuote>;
8381
8850
  stagedQuotes: TStagedQuoteQueryResult;
8851
+ /**
8852
+ * StandalonePrices are managed and queried through the StandalonePrices API
8853
+ * and associated to a ProductVariant through the sku field.
8854
+ */
8382
8855
  standalonePrice?: Maybe<TStandalonePrice>;
8856
+ /**
8857
+ * StandalonePrices are managed and queried through the StandalonePrices API
8858
+ * and associated to a ProductVariant through the sku field.
8859
+ */
8383
8860
  standalonePrices: TStandalonePriceQueryResult;
8384
8861
  state?: Maybe<TState>;
8385
8862
  states: TStateQueryResult;
@@ -8853,6 +9330,7 @@ export type TQuote = TVersioned & {
8853
9330
  customerGroup?: Maybe<TCustomerGroup>;
8854
9331
  customerGroupRef?: Maybe<TReference>;
8855
9332
  customerRef?: Maybe<TReference>;
9333
+ /** BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta */
8856
9334
  directDiscounts: Array<TDirectDiscount>;
8857
9335
  id: Scalars['String'];
8858
9336
  inventoryMode: TInventoryMode;
@@ -8912,14 +9390,17 @@ export type TQuoteDraft = {
8912
9390
  stagedQuoteVersion?: InputMaybe<Scalars['Long']>;
8913
9391
  state?: InputMaybe<TReferenceInput>;
8914
9392
  };
9393
+ /** Fields to access Quotes. */
8915
9394
  export type TQuoteQueryInterface = {
8916
9395
  quote?: Maybe<TQuote>;
8917
9396
  quotes: TQuoteQueryResult;
8918
9397
  };
9398
+ /** Fields to access Quotes. */
8919
9399
  export type TQuoteQueryInterface_QuoteArgs = {
8920
9400
  id?: InputMaybe<Scalars['String']>;
8921
9401
  key?: InputMaybe<Scalars['String']>;
8922
9402
  };
9403
+ /** Fields to access Quotes. */
8923
9404
  export type TQuoteQueryInterface_QuotesArgs = {
8924
9405
  limit?: InputMaybe<Scalars['Int']>;
8925
9406
  offset?: InputMaybe<Scalars['Int']>;
@@ -8955,6 +9436,7 @@ export type TQuoteRequest = TVersioned & {
8955
9436
  customerGroup?: Maybe<TCustomerGroup>;
8956
9437
  customerGroupRef?: Maybe<TReference>;
8957
9438
  customerRef?: Maybe<TReference>;
9439
+ /** BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta */
8958
9440
  directDiscounts: Array<TDirectDiscount>;
8959
9441
  id: Scalars['String'];
8960
9442
  inventoryMode: TInventoryMode;
@@ -9009,14 +9491,17 @@ export type TQuoteRequestDraft = {
9009
9491
  purchaseOrderNumber?: InputMaybe<Scalars['String']>;
9010
9492
  state?: InputMaybe<TReferenceInput>;
9011
9493
  };
9494
+ /** Fields to access QuoteRequests. */
9012
9495
  export type TQuoteRequestQueryInterface = {
9013
9496
  quoteRequest?: Maybe<TQuoteRequest>;
9014
9497
  quoteRequests: TQuoteRequestQueryResult;
9015
9498
  };
9499
+ /** Fields to access QuoteRequests. */
9016
9500
  export type TQuoteRequestQueryInterface_QuoteRequestArgs = {
9017
9501
  id?: InputMaybe<Scalars['String']>;
9018
9502
  key?: InputMaybe<Scalars['String']>;
9019
9503
  };
9504
+ /** Fields to access QuoteRequests. */
9020
9505
  export type TQuoteRequestQueryInterface_QuoteRequestsArgs = {
9021
9506
  limit?: InputMaybe<Scalars['Int']>;
9022
9507
  offset?: InputMaybe<Scalars['Int']>;
@@ -9148,7 +9633,9 @@ export type TRangeFilterInput = {
9148
9633
  export type TRawCustomField = {
9149
9634
  __typename?: 'RawCustomField';
9150
9635
  name: Scalars['String'];
9636
+ /** BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta */
9151
9637
  referencedResource?: Maybe<TReferenceExpandable>;
9638
+ /** BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta */
9152
9639
  referencedResourceSet: Array<TReferenceExpandable>;
9153
9640
  value: Scalars['Json'];
9154
9641
  };
@@ -9156,14 +9643,18 @@ export type TRawProductAttribute = {
9156
9643
  __typename?: 'RawProductAttribute';
9157
9644
  attributeDefinition?: Maybe<TAttributeDefinition>;
9158
9645
  name: Scalars['String'];
9646
+ /** BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta */
9159
9647
  referencedResource?: Maybe<TReferenceExpandable>;
9648
+ /** BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta */
9160
9649
  referencedResourceSet: Array<TReferenceExpandable>;
9161
9650
  value: Scalars['Json'];
9162
9651
  };
9163
9652
  export type TRawProductSearchAttribute = {
9164
9653
  __typename?: 'RawProductSearchAttribute';
9165
9654
  name: Scalars['String'];
9655
+ /** BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta */
9166
9656
  referencedResource?: Maybe<TReferenceExpandable>;
9657
+ /** BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta */
9167
9658
  referencedResourceSet: Array<TReferenceExpandable>;
9168
9659
  value: Scalars['Json'];
9169
9660
  };
@@ -9508,6 +9999,7 @@ export type TResourceIdentifierInput = {
9508
9999
  key?: InputMaybe<Scalars['String']>;
9509
10000
  typeId?: InputMaybe<Scalars['String']>;
9510
10001
  };
10002
+ /** Stores information about returns connected to this order. */
9511
10003
  export type TReturnInfo = {
9512
10004
  __typename?: 'ReturnInfo';
9513
10005
  items: Array<TReturnItem>;
@@ -9681,8 +10173,11 @@ export type TReviewUpdateAction = {
9681
10173
  transitionState?: InputMaybe<TTransitionReviewState>;
9682
10174
  };
9683
10175
  export declare enum TRoundingMode {
10176
+ /** [Round half down](https://en.wikipedia.org/wiki/Rounding#Round_half_down) */
9684
10177
  HalfDown = "HalfDown",
10178
+ /** [Round half to even](https://en.wikipedia.org/wiki/Rounding#Round_half_to_even). Default rounding mode as used in IEEE 754 computing functions and operators. */
9685
10179
  HalfEven = "HalfEven",
10180
+ /** [Round half up](https://en.wikipedia.org/wiki/Rounding#Round_half_up) */
9686
10181
  HalfUp = "HalfUp"
9687
10182
  }
9688
10183
  export type TRuleApprover = {
@@ -9780,10 +10275,13 @@ export type TSearchFilterModelInput = {
9780
10275
  };
9781
10276
  export type TSearchIndexingConfiguration = {
9782
10277
  __typename?: 'SearchIndexingConfiguration';
10278
+ /** CLOSED BETA: This feature is subject to change and should not be used in production. https://docs.commercetools.com/api/contract#closed-beta */
9783
10279
  businessUnits?: Maybe<TBusinessUnitSearchConfiguration>;
10280
+ /** CLOSED BETA: This feature is subject to change and should not be used in production. https://docs.commercetools.com/api/contract#closed-beta */
9784
10281
  customers?: Maybe<TCustomerSearchConfiguration>;
9785
10282
  orders?: Maybe<TOrderSearchConfiguration>;
9786
10283
  products?: Maybe<TSearchIndexingConfigurationValues>;
10284
+ /** CLOSED BETA: This feature is subject to change and should not be used in production. https://docs.commercetools.com/api/contract#closed-beta */
9787
10285
  productsSearch?: Maybe<TProductsSearchConfiguration>;
9788
10286
  };
9789
10287
  export type TSearchIndexingConfigurationValues = {
@@ -9833,6 +10331,7 @@ export type TSearchLimitsProjection = {
9833
10331
  __typename?: 'SearchLimitsProjection';
9834
10332
  maxTextSize: TLimit;
9835
10333
  };
10334
+ /** In order to decide which of the matching items will actually be discounted */
9836
10335
  export declare enum TSelectionMode {
9837
10336
  Cheapest = "Cheapest",
9838
10337
  MostExpensive = "MostExpensive"
@@ -10992,6 +11491,7 @@ export type TSetProductVariantKey = {
10992
11491
  export type TSetProjectSettingsExternalOAuth = {
10993
11492
  externalOAuth?: InputMaybe<TExternalOAuthDraft>;
10994
11493
  };
11494
+ /** BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta */
10995
11495
  export type TSetProjectSettingsMyBusinessUnitAssociateRoleOnCreation = {
10996
11496
  associateRole?: InputMaybe<TResourceIdentifierInput>;
10997
11497
  };
@@ -12008,6 +12508,7 @@ export type TShippingMethod_LocalizedNameArgs = {
12008
12508
  export type TShippingMethodDraft = {
12009
12509
  active?: InputMaybe<Scalars['Boolean']>;
12010
12510
  custom?: InputMaybe<TCustomFieldsDraft>;
12511
+ /** The usage of parameter 'description' is deprecated in favor of using 'localizedDescription' */
12011
12512
  description?: InputMaybe<Scalars['String']>;
12012
12513
  isDefault: Scalars['Boolean'];
12013
12514
  key?: InputMaybe<Scalars['String']>;
@@ -12036,7 +12537,9 @@ export type TShippingMethodQueryResult = {
12036
12537
  total: Scalars['Long'];
12037
12538
  };
12038
12539
  export declare enum TShippingMethodState {
12540
+ /** The ShippingMethod predicate does not match the cart. Ordering this cart will fail with error ShippingMethodDoesNotMatchCart */
12039
12541
  DoesNotMatchCart = "DoesNotMatchCart",
12542
+ /** Either there is no predicate defined for the ShippingMethod or the given predicate matches the cart */
12040
12543
  MatchesCart = "MatchesCart"
12041
12544
  }
12042
12545
  export type TShippingMethodTargetDraft = {
@@ -12063,22 +12566,28 @@ export type TShippingMethodUpdateAction = {
12063
12566
  removeZone?: InputMaybe<TRemoveShippingMethodZone>;
12064
12567
  setCustomField?: InputMaybe<TSetShippingMethodCustomField>;
12065
12568
  setCustomType?: InputMaybe<TSetShippingMethodCustomType>;
12569
+ /** This action is deprecated in favor of using 'setLocalizedDescription' */
12066
12570
  setDescription?: InputMaybe<TSetShippingMethodDescription>;
12067
12571
  setKey?: InputMaybe<TSetShippingMethodKey>;
12068
12572
  setLocalizedDescription?: InputMaybe<TSetShippingMethodLocalizedDescription>;
12069
12573
  setLocalizedName?: InputMaybe<TSetShippingMethodLocalizedName>;
12070
12574
  setPredicate?: InputMaybe<TSetShippingMethodPredicate>;
12071
12575
  };
12576
+ /** A field to retrieve available shipping methods for a cart. */
12072
12577
  export type TShippingMethodsByCartInterface = {
12073
12578
  shippingMethodsByCart: Array<TShippingMethod>;
12074
12579
  };
12580
+ /** A field to retrieve available shipping methods for a cart. */
12075
12581
  export type TShippingMethodsByCartInterface_ShippingMethodsByCartArgs = {
12076
12582
  id: Scalars['String'];
12077
12583
  };
12078
12584
  export declare enum TShippingMode {
12585
+ /** Allows multiple shipping methods for the cart with their respective shipping addresses */
12079
12586
  Multiple = "Multiple",
12587
+ /** Allows only one shipping method and shipping address for the cart */
12080
12588
  Single = "Single"
12081
12589
  }
12590
+ /** Shipping Rate */
12082
12591
  export type TShippingRate = {
12083
12592
  __typename?: 'ShippingRate';
12084
12593
  freeAbove?: Maybe<TMoney>;
@@ -12274,14 +12783,17 @@ export type TShoppingListLineItemDraft = {
12274
12783
  sku?: InputMaybe<Scalars['String']>;
12275
12784
  variantId?: InputMaybe<Scalars['Int']>;
12276
12785
  };
12786
+ /** Fields to access shopping lists. Includes direct access to a single list and searching for shopping lists. */
12277
12787
  export type TShoppingListQueryInterface = {
12278
12788
  shoppingList?: Maybe<TShoppingList>;
12279
12789
  shoppingLists: TShoppingListQueryResult;
12280
12790
  };
12791
+ /** Fields to access shopping lists. Includes direct access to a single list and searching for shopping lists. */
12281
12792
  export type TShoppingListQueryInterface_ShoppingListArgs = {
12282
12793
  id?: InputMaybe<Scalars['String']>;
12283
12794
  key?: InputMaybe<Scalars['String']>;
12284
12795
  };
12796
+ /** Fields to access shopping lists. Includes direct access to a single list and searching for shopping lists. */
12285
12797
  export type TShoppingListQueryInterface_ShoppingListsArgs = {
12286
12798
  limit?: InputMaybe<Scalars['Int']>;
12287
12799
  offset?: InputMaybe<Scalars['Int']>;
@@ -12341,8 +12853,11 @@ export type TSimpleAttributeTypeDraft = {
12341
12853
  export type TSimpleFieldTypeDraft = {
12342
12854
  dummy?: InputMaybe<Scalars['String']>;
12343
12855
  };
12856
+ /** Describes how this discount interacts with other discounts */
12344
12857
  export declare enum TStackingMode {
12858
+ /** Default. Continue applying other matching discounts after applying this one. */
12345
12859
  Stacking = "Stacking",
12860
+ /** Don’t apply any more matching discounts after this one. */
12346
12861
  StopAfterThisDiscount = "StopAfterThisDiscount"
12347
12862
  }
12348
12863
  export type TStagedOrderUpdateAction = {
@@ -12539,6 +13054,10 @@ export type TStagedStandalonePrice = {
12539
13054
  discounted?: Maybe<TDiscountedProductPriceValue>;
12540
13055
  value: TBaseMoney;
12541
13056
  };
13057
+ /**
13058
+ * StandalonePrices are managed and queried through the StandalonePrices API
13059
+ * and associated to a ProductVariant through the sku field.
13060
+ */
12542
13061
  export type TStandalonePrice = TVersioned & {
12543
13062
  __typename?: 'StandalonePrice';
12544
13063
  active: Scalars['Boolean'];
@@ -12678,6 +13197,7 @@ export type TStandalonePriceValueChanged = TMessagePayload & {
12678
13197
  type: Scalars['String'];
12679
13198
  value: TBaseMoney;
12680
13199
  };
13200
+ /** [State](https://docs.commercetools.com/api/projects/states) */
12681
13201
  export type TState = TReferenceExpandable & TVersioned & {
12682
13202
  __typename?: 'State';
12683
13203
  builtIn: Scalars['Boolean'];
@@ -12698,10 +13218,12 @@ export type TState = TReferenceExpandable & TVersioned & {
12698
13218
  type: TStateType;
12699
13219
  version: Scalars['Long'];
12700
13220
  };
13221
+ /** [State](https://docs.commercetools.com/api/projects/states) */
12701
13222
  export type TState_DescriptionArgs = {
12702
13223
  acceptLanguage?: InputMaybe<Array<Scalars['Locale']>>;
12703
13224
  locale?: InputMaybe<Scalars['Locale']>;
12704
13225
  };
13226
+ /** [State](https://docs.commercetools.com/api/projects/states) */
12705
13227
  export type TState_NameArgs = {
12706
13228
  acceptLanguage?: InputMaybe<Array<Scalars['Locale']>>;
12707
13229
  locale?: InputMaybe<Scalars['Locale']>;
@@ -12748,6 +13270,7 @@ export type TStateUpdateAction = {
12748
13270
  setRoles?: InputMaybe<TSetStateRoles>;
12749
13271
  setTransitions?: InputMaybe<TSetStateTransitions>;
12750
13272
  };
13273
+ /** Stores allow defining different contexts for a project. */
12751
13274
  export type TStore = TReferenceExpandable & TVersioned & {
12752
13275
  __typename?: 'Store';
12753
13276
  countries?: Maybe<Array<TStoreCountry>>;
@@ -12768,6 +13291,7 @@ export type TStore = TReferenceExpandable & TVersioned & {
12768
13291
  supplyChannelsRef: Array<TReference>;
12769
13292
  version: Scalars['Long'];
12770
13293
  };
13294
+ /** Stores allow defining different contexts for a project. */
12771
13295
  export type TStore_NameArgs = {
12772
13296
  acceptLanguage?: InputMaybe<Array<Scalars['Locale']>>;
12773
13297
  locale?: InputMaybe<Scalars['Locale']>;
@@ -12956,6 +13480,7 @@ export type TSuggestion = {
12956
13480
  __typename?: 'Suggestion';
12957
13481
  text: Scalars['String'];
12958
13482
  };
13483
+ /** Stores information about order synchronization activities (like export or import). */
12959
13484
  export type TSyncInfo = {
12960
13485
  __typename?: 'SyncInfo';
12961
13486
  channel?: Maybe<TChannel>;
@@ -12969,9 +13494,18 @@ export type TTargetReferenceInput = {
12969
13494
  typeId: Scalars['String'];
12970
13495
  };
12971
13496
  export declare enum TTaxCalculationMode {
13497
+ /**
13498
+ * Default. This calculation mode calculates the taxes after the unit price is multiplied with the quantity.
13499
+ * E.g. `($1.08 * 3 = $3.24) * 1.19 = $3.8556 -> $3.86 rounded`
13500
+ */
12972
13501
  LineItemLevel = "LineItemLevel",
13502
+ /**
13503
+ * This calculation mode calculates the taxes on the unit price before multiplying with the quantity.
13504
+ * E.g. `($1.08 * 1.19 = $1.2852 -> $1.29 rounded) * 3 = $3.87`
13505
+ */
12973
13506
  UnitPriceLevel = "UnitPriceLevel"
12974
13507
  }
13508
+ /** Tax Categories define how products are to be taxed in different countries. */
12975
13509
  export type TTaxCategory = TReferenceExpandable & TVersioned & {
12976
13510
  __typename?: 'TaxCategory';
12977
13511
  createdAt: Scalars['DateTime'];
@@ -13035,11 +13569,32 @@ export type TTaxCategoryUpdateAction = {
13035
13569
  setKey?: InputMaybe<TSetTaxCategoryKey>;
13036
13570
  };
13037
13571
  export declare enum TTaxMode {
13572
+ /** No taxes are added to the cart. */
13038
13573
  Disabled = "Disabled",
13574
+ /**
13575
+ * The tax rates are set externally per ExternalTaxRateDraft. A cart with this tax mode can only be ordered if all
13576
+ * line items, all custom line items and the shipping method have an external tax rate set. The totalNet and
13577
+ * totalGross as well as the taxPortions fields are calculated according to the taxRoundingMode.
13578
+ */
13039
13579
  External = "External",
13580
+ /**
13581
+ * The tax amounts and the tax rates as well as the tax portions are set externally per ExternalTaxAmountDraft.
13582
+ * A cart with this tax mode can only be ordered if the cart itself and all line items, all custom line items and
13583
+ * the shipping method have an external tax amount and rate set
13584
+ */
13040
13585
  ExternalAmount = "ExternalAmount",
13586
+ /**
13587
+ * The tax rates are selected from the TaxCategories based on the cart shipping address.
13588
+ * The totalNet and totalGross as well as the taxPortions fields are calculated according to the
13589
+ * taxRoundingMode.
13590
+ */
13041
13591
  Platform = "Platform"
13042
13592
  }
13593
+ /**
13594
+ * Represents the portions that sum up to the totalGross field of a TaxedPrice. The portions are calculated
13595
+ * from the TaxRates. If a tax rate has SubRates, they are used and can be identified by name. Tax portions
13596
+ * from line items that have the same rate and name will be accumulated to the same tax portion.
13597
+ */
13043
13598
  export type TTaxPortion = {
13044
13599
  __typename?: 'TaxPortion';
13045
13600
  amount: TMoney;
@@ -13125,6 +13680,7 @@ export type TTextAttributeDefinitionType = TAttributeDefinitionType & {
13125
13680
  __typename?: 'TextAttributeDefinitionType';
13126
13681
  name: Scalars['String'];
13127
13682
  };
13683
+ /** UI hint telling what kind of edit control should be displayed for a text attribute. */
13128
13684
  export declare enum TTextInputHint {
13129
13685
  MultiLine = "MultiLine",
13130
13686
  SingleLine = "SingleLine"
@@ -13327,6 +13883,7 @@ export type TTriggerInput = {
13327
13883
  condition?: InputMaybe<Scalars['String']>;
13328
13884
  resourceTypeId: Scalars['String'];
13329
13885
  };
13886
+ /** Types allow you to define additional project-specific fields on resources and data types, so-called Custom Fields. */
13330
13887
  export type TTypeDefinition = TReferenceExpandable & TVersioned & {
13331
13888
  __typename?: 'TypeDefinition';
13332
13889
  createdAt: Scalars['DateTime'];
@@ -13343,14 +13900,17 @@ export type TTypeDefinition = TReferenceExpandable & TVersioned & {
13343
13900
  resourceTypeIds: Array<Scalars['String']>;
13344
13901
  version: Scalars['Long'];
13345
13902
  };
13903
+ /** Types allow you to define additional project-specific fields on resources and data types, so-called Custom Fields. */
13346
13904
  export type TTypeDefinition_DescriptionArgs = {
13347
13905
  acceptLanguage?: InputMaybe<Array<Scalars['Locale']>>;
13348
13906
  locale?: InputMaybe<Scalars['Locale']>;
13349
13907
  };
13908
+ /** Types allow you to define additional project-specific fields on resources and data types, so-called Custom Fields. */
13350
13909
  export type TTypeDefinition_FieldDefinitionsArgs = {
13351
13910
  excludeNames?: InputMaybe<Array<Scalars['String']>>;
13352
13911
  includeNames?: InputMaybe<Array<Scalars['String']>>;
13353
13912
  };
13913
+ /** Types allow you to define additional project-specific fields on resources and data types, so-called Custom Fields. */
13354
13914
  export type TTypeDefinition_NameArgs = {
13355
13915
  acceptLanguage?: InputMaybe<Array<Scalars['Locale']>>;
13356
13916
  locale?: InputMaybe<Scalars['Locale']>;
@@ -13450,6 +14010,7 @@ export type TValueFilterInput = {
13450
14010
  path: Scalars['String'];
13451
14011
  values: Array<Scalars['String']>;
13452
14012
  };
14013
+ /** Versioned object have an ID and version and modification. Every update of this object changes it's version. */
13453
14014
  export type TVersioned = {
13454
14015
  createdAt: Scalars['DateTime'];
13455
14016
  createdBy?: Maybe<TInitiator>;
@@ -13469,6 +14030,7 @@ export type TWhitespaceSuggestTokenizerProductSearch = TSuggestTokenizerProductS
13469
14030
  __typename?: 'WhitespaceSuggestTokenizerProductSearch';
13470
14031
  type: Scalars['String'];
13471
14032
  };
14033
+ /** Zones allow defining ShippingRates for specific Locations. */
13472
14034
  export type TZone = TReferenceExpandable & TVersioned & {
13473
14035
  __typename?: 'Zone';
13474
14036
  createdAt: Scalars['DateTime'];