@vendure/docs 0.0.0-202601211100 → 0.0.0-202601211343

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 (236) hide show
  1. package/dist/manifest.js +2 -2
  2. package/dist/manifest.js.map +1 -1
  3. package/docs/reference/admin-ui-api/bulk-actions/bulk-action.mdx +1 -1
  4. package/docs/reference/admin-ui-api/components/asset-picker-dialog-component.mdx +1 -1
  5. package/docs/reference/admin-ui-api/components/currency-input-component.mdx +1 -1
  6. package/docs/reference/admin-ui-api/components/data-table-component.mdx +1 -1
  7. package/docs/reference/admin-ui-api/components/data-table2component.mdx +1 -1
  8. package/docs/reference/admin-ui-api/components/datetime-picker-component.mdx +1 -1
  9. package/docs/reference/admin-ui-api/components/facet-value-selector-component.mdx +1 -1
  10. package/docs/reference/admin-ui-api/components/object-tree-component.mdx +1 -1
  11. package/docs/reference/admin-ui-api/components/product-variant-selector-component.mdx +1 -1
  12. package/docs/reference/admin-ui-api/components/rich-text-editor-component.mdx +1 -1
  13. package/docs/reference/admin-ui-api/components/zone-selector-component.mdx +1 -1
  14. package/docs/reference/admin-ui-api/custom-history-entry-components/customer-history-entry-component.mdx +1 -1
  15. package/docs/reference/admin-ui-api/custom-history-entry-components/order-history-entry-component.mdx +1 -1
  16. package/docs/reference/admin-ui-api/custom-input-components/default-inputs.mdx +19 -19
  17. package/docs/reference/admin-ui-api/directives/if-multichannel-directive.mdx +1 -1
  18. package/docs/reference/admin-ui-api/directives/if-permissions-directive.mdx +1 -1
  19. package/docs/reference/admin-ui-api/list-detail-views/base-detail-component.mdx +1 -1
  20. package/docs/reference/admin-ui-api/list-detail-views/base-list-component.mdx +1 -1
  21. package/docs/reference/admin-ui-api/list-detail-views/typed-base-detail-component.mdx +1 -1
  22. package/docs/reference/admin-ui-api/list-detail-views/typed-base-list-component.mdx +2 -2
  23. package/docs/reference/admin-ui-api/pipes/asset-preview-pipe.mdx +1 -1
  24. package/docs/reference/admin-ui-api/pipes/duration-pipe.mdx +1 -1
  25. package/docs/reference/admin-ui-api/pipes/file-size-pipe.mdx +1 -1
  26. package/docs/reference/admin-ui-api/pipes/has-permission-pipe.mdx +1 -1
  27. package/docs/reference/admin-ui-api/pipes/locale-currency-name-pipe.mdx +2 -2
  28. package/docs/reference/admin-ui-api/pipes/locale-currency-pipe.mdx +2 -2
  29. package/docs/reference/admin-ui-api/pipes/locale-date-pipe.mdx +2 -2
  30. package/docs/reference/admin-ui-api/pipes/locale-language-name-pipe.mdx +2 -2
  31. package/docs/reference/admin-ui-api/pipes/locale-region-name-pipe.mdx +2 -2
  32. package/docs/reference/admin-ui-api/pipes/time-ago-pipe.mdx +1 -1
  33. package/docs/reference/admin-ui-api/ui-devkit/admin-ui-extension.mdx +1 -1
  34. package/docs/reference/core-plugins/admin-ui-plugin/index.mdx +1 -1
  35. package/docs/reference/core-plugins/asset-server-plugin/hashed-asset-naming-strategy.mdx +1 -1
  36. package/docs/reference/core-plugins/asset-server-plugin/image-transform-strategy.mdx +1 -1
  37. package/docs/reference/core-plugins/asset-server-plugin/index.mdx +1 -1
  38. package/docs/reference/core-plugins/asset-server-plugin/local-asset-storage-strategy.mdx +1 -1
  39. package/docs/reference/core-plugins/asset-server-plugin/preset-only-strategy.mdx +1 -1
  40. package/docs/reference/core-plugins/asset-server-plugin/s3asset-storage-strategy.mdx +1 -1
  41. package/docs/reference/core-plugins/asset-server-plugin/sharp-asset-preview-strategy.mdx +1 -1
  42. package/docs/reference/core-plugins/dashboard-plugin/index.mdx +1 -1
  43. package/docs/reference/core-plugins/elasticsearch-plugin/index.mdx +1 -1
  44. package/docs/reference/core-plugins/email-plugin/email-event-handler-with-async-data.mdx +1 -1
  45. package/docs/reference/core-plugins/email-plugin/email-generator.mdx +2 -2
  46. package/docs/reference/core-plugins/email-plugin/email-plugin-options.mdx +1 -1
  47. package/docs/reference/core-plugins/email-plugin/email-send-event.mdx +1 -1
  48. package/docs/reference/core-plugins/email-plugin/email-sender.mdx +2 -2
  49. package/docs/reference/core-plugins/email-plugin/index.mdx +1 -1
  50. package/docs/reference/core-plugins/email-plugin/template-loader.mdx +1 -1
  51. package/docs/reference/core-plugins/email-plugin/transport-options.mdx +2 -2
  52. package/docs/reference/core-plugins/graphiql-plugin/index.mdx +1 -1
  53. package/docs/reference/core-plugins/job-queue-plugin/bull-mqjob-queue-strategy.mdx +1 -1
  54. package/docs/reference/core-plugins/job-queue-plugin/pub-sub-job-queue-strategy.mdx +2 -2
  55. package/docs/reference/core-plugins/stellate-plugin/index.mdx +1 -1
  56. package/docs/reference/core-plugins/telemetry-plugin/otel-logger.mdx +1 -1
  57. package/docs/reference/dashboard/components/vendure-image.mdx +1 -1
  58. package/docs/reference/dashboard/page-layout/page.mdx +1 -1
  59. package/docs/reference/typescript-api/assets/asset-naming-strategy.mdx +1 -1
  60. package/docs/reference/typescript-api/assets/asset-preview-strategy.mdx +1 -1
  61. package/docs/reference/typescript-api/assets/asset-storage-strategy.mdx +1 -1
  62. package/docs/reference/typescript-api/assets/default-asset-naming-strategy.mdx +1 -1
  63. package/docs/reference/typescript-api/auth/authentication-strategy.mdx +1 -1
  64. package/docs/reference/typescript-api/auth/bcrypt-password-hashing-strategy.mdx +1 -1
  65. package/docs/reference/typescript-api/auth/default-password-validation-strategy.mdx +1 -1
  66. package/docs/reference/typescript-api/auth/default-session-cache-strategy.mdx +1 -1
  67. package/docs/reference/typescript-api/auth/default-verification-token-strategy.mdx +1 -1
  68. package/docs/reference/typescript-api/auth/in-memory-session-cache-strategy.mdx +1 -1
  69. package/docs/reference/typescript-api/auth/native-authentication-strategy.mdx +1 -1
  70. package/docs/reference/typescript-api/auth/noop-session-cache-strategy.mdx +1 -1
  71. package/docs/reference/typescript-api/auth/password-hashing-strategy.mdx +1 -1
  72. package/docs/reference/typescript-api/auth/password-validation-strategy.mdx +1 -1
  73. package/docs/reference/typescript-api/auth/permission-definition.mdx +2 -2
  74. package/docs/reference/typescript-api/auth/session-cache-strategy.mdx +1 -1
  75. package/docs/reference/typescript-api/auth/verification-token-strategy.mdx +1 -1
  76. package/docs/reference/typescript-api/cache/cache-strategy.mdx +1 -1
  77. package/docs/reference/typescript-api/cache/redis-cache-strategy.mdx +1 -1
  78. package/docs/reference/typescript-api/cache/sql-cache-strategy.mdx +1 -1
  79. package/docs/reference/typescript-api/common/i18n-service.mdx +1 -1
  80. package/docs/reference/typescript-api/configurable-operation-def/configurable-operation-def-options.mdx +1 -1
  81. package/docs/reference/typescript-api/configuration/collection-filter.mdx +1 -1
  82. package/docs/reference/typescript-api/configuration/default-slug-strategy.mdx +1 -1
  83. package/docs/reference/typescript-api/configuration/entity-duplicator.mdx +2 -2
  84. package/docs/reference/typescript-api/configuration/entity-id-strategy.mdx +3 -3
  85. package/docs/reference/typescript-api/configuration/product-variant-price-selection-strategy.mdx +2 -2
  86. package/docs/reference/typescript-api/configuration/product-variant-price-update-strategy.mdx +2 -2
  87. package/docs/reference/typescript-api/configuration/runtime-vendure-config.mdx +1 -1
  88. package/docs/reference/typescript-api/configuration/slug-strategy.mdx +1 -1
  89. package/docs/reference/typescript-api/data-access/calculated-property-subscriber.mdx +1 -1
  90. package/docs/reference/typescript-api/data-access/get-entity-or-throw-options.mdx +1 -1
  91. package/docs/reference/typescript-api/data-access/list-query-builder.mdx +1 -1
  92. package/docs/reference/typescript-api/default-search-plugin/index.mdx +1 -1
  93. package/docs/reference/typescript-api/default-search-plugin/mysql-search-strategy.mdx +1 -1
  94. package/docs/reference/typescript-api/default-search-plugin/postgres-search-strategy.mdx +1 -1
  95. package/docs/reference/typescript-api/default-search-plugin/search-strategy.mdx +1 -1
  96. package/docs/reference/typescript-api/default-search-plugin/sqlite-search-strategy.mdx +1 -1
  97. package/docs/reference/typescript-api/entities/address.mdx +2 -2
  98. package/docs/reference/typescript-api/entities/administrator.mdx +2 -2
  99. package/docs/reference/typescript-api/entities/anonymous-session.mdx +1 -1
  100. package/docs/reference/typescript-api/entities/asset.mdx +2 -2
  101. package/docs/reference/typescript-api/entities/authenticated-session.mdx +1 -1
  102. package/docs/reference/typescript-api/entities/authentication-method.mdx +3 -3
  103. package/docs/reference/typescript-api/entities/channel.mdx +1 -1
  104. package/docs/reference/typescript-api/entities/collection.mdx +2 -2
  105. package/docs/reference/typescript-api/entities/country.mdx +1 -1
  106. package/docs/reference/typescript-api/entities/customer-group.mdx +2 -2
  107. package/docs/reference/typescript-api/entities/customer-history-entry.mdx +1 -1
  108. package/docs/reference/typescript-api/entities/customer.mdx +2 -2
  109. package/docs/reference/typescript-api/entities/facet-value.mdx +2 -2
  110. package/docs/reference/typescript-api/entities/facet.mdx +2 -2
  111. package/docs/reference/typescript-api/entities/fulfillment.mdx +2 -2
  112. package/docs/reference/typescript-api/entities/global-settings.mdx +2 -2
  113. package/docs/reference/typescript-api/entities/history-entry.mdx +2 -2
  114. package/docs/reference/typescript-api/entities/order-history-entry.mdx +1 -1
  115. package/docs/reference/typescript-api/entities/order-line-reference.mdx +4 -4
  116. package/docs/reference/typescript-api/entities/order-line.mdx +2 -2
  117. package/docs/reference/typescript-api/entities/order-modification.mdx +1 -1
  118. package/docs/reference/typescript-api/entities/order.mdx +2 -2
  119. package/docs/reference/typescript-api/entities/orderable-asset.mdx +2 -2
  120. package/docs/reference/typescript-api/entities/payment-method.mdx +2 -2
  121. package/docs/reference/typescript-api/entities/payment.mdx +2 -2
  122. package/docs/reference/typescript-api/entities/product-option-group.mdx +2 -2
  123. package/docs/reference/typescript-api/entities/product-option.mdx +2 -2
  124. package/docs/reference/typescript-api/entities/product-variant-price.mdx +2 -2
  125. package/docs/reference/typescript-api/entities/product-variant.mdx +2 -2
  126. package/docs/reference/typescript-api/entities/product.mdx +2 -2
  127. package/docs/reference/typescript-api/entities/promotion.mdx +2 -2
  128. package/docs/reference/typescript-api/entities/province.mdx +1 -1
  129. package/docs/reference/typescript-api/entities/refund.mdx +2 -2
  130. package/docs/reference/typescript-api/entities/region.mdx +2 -2
  131. package/docs/reference/typescript-api/entities/role.mdx +2 -2
  132. package/docs/reference/typescript-api/entities/seller.mdx +2 -2
  133. package/docs/reference/typescript-api/entities/session.mdx +2 -2
  134. package/docs/reference/typescript-api/entities/settings-store-entry.mdx +1 -1
  135. package/docs/reference/typescript-api/entities/shipping-line.mdx +2 -2
  136. package/docs/reference/typescript-api/entities/shipping-method.mdx +2 -2
  137. package/docs/reference/typescript-api/entities/stock-level.mdx +2 -2
  138. package/docs/reference/typescript-api/entities/stock-location.mdx +2 -2
  139. package/docs/reference/typescript-api/entities/stock-movement.mdx +7 -7
  140. package/docs/reference/typescript-api/entities/surcharge.mdx +1 -1
  141. package/docs/reference/typescript-api/entities/tag.mdx +1 -1
  142. package/docs/reference/typescript-api/entities/tax-category.mdx +2 -2
  143. package/docs/reference/typescript-api/entities/tax-rate.mdx +2 -2
  144. package/docs/reference/typescript-api/entities/user.mdx +2 -2
  145. package/docs/reference/typescript-api/entities/zone.mdx +2 -2
  146. package/docs/reference/typescript-api/errors/error-handler-strategy.mdx +1 -1
  147. package/docs/reference/typescript-api/errors/error-types.mdx +7 -7
  148. package/docs/reference/typescript-api/errors/i18n-error.mdx +1 -1
  149. package/docs/reference/typescript-api/events/event-bus.mdx +1 -1
  150. package/docs/reference/typescript-api/events/event-types.mdx +59 -59
  151. package/docs/reference/typescript-api/events/vendure-entity-event.mdx +1 -1
  152. package/docs/reference/typescript-api/fulfillment/fulfillment-handler.mdx +2 -2
  153. package/docs/reference/typescript-api/fulfillment/fulfillment-process.mdx +1 -1
  154. package/docs/reference/typescript-api/health-check/health-check-strategy.mdx +1 -1
  155. package/docs/reference/typescript-api/health-check/http-health-check-strategy.mdx +1 -1
  156. package/docs/reference/typescript-api/health-check/type-ormhealth-check-strategy.mdx +1 -1
  157. package/docs/reference/typescript-api/import-export/asset-import-strategy.mdx +1 -1
  158. package/docs/reference/typescript-api/import-export/default-asset-import-strategy.mdx +1 -1
  159. package/docs/reference/typescript-api/job-queue/in-memory-job-buffer-storage-strategy.mdx +1 -1
  160. package/docs/reference/typescript-api/job-queue/in-memory-job-queue-strategy.mdx +2 -2
  161. package/docs/reference/typescript-api/job-queue/inspectable-job-queue-strategy.mdx +1 -1
  162. package/docs/reference/typescript-api/job-queue/job-buffer-storage-strategy.mdx +1 -1
  163. package/docs/reference/typescript-api/job-queue/job-queue-service.mdx +1 -1
  164. package/docs/reference/typescript-api/job-queue/job-queue-strategy.mdx +1 -1
  165. package/docs/reference/typescript-api/job-queue/polling-job-queue-strategy.mdx +1 -1
  166. package/docs/reference/typescript-api/job-queue/sql-job-queue-strategy.mdx +2 -2
  167. package/docs/reference/typescript-api/job-queue/subscribable-job.mdx +1 -1
  168. package/docs/reference/typescript-api/logger/default-logger.mdx +1 -1
  169. package/docs/reference/typescript-api/logger/index.mdx +1 -1
  170. package/docs/reference/typescript-api/money/big-int-money-strategy.mdx +1 -1
  171. package/docs/reference/typescript-api/money/default-money-strategy.mdx +1 -1
  172. package/docs/reference/typescript-api/money/money-strategy.mdx +1 -1
  173. package/docs/reference/typescript-api/orders/active-order-strategy.mdx +1 -1
  174. package/docs/reference/typescript-api/orders/changed-price-handling-strategy.mdx +1 -1
  175. package/docs/reference/typescript-api/orders/default-active-order-strategy.mdx +1 -1
  176. package/docs/reference/typescript-api/orders/default-guest-checkout-strategy.mdx +1 -1
  177. package/docs/reference/typescript-api/orders/default-order-item-price-calculation-strategy.mdx +1 -1
  178. package/docs/reference/typescript-api/orders/default-order-placed-strategy.mdx +1 -1
  179. package/docs/reference/typescript-api/orders/default-stock-allocation-strategy.mdx +1 -1
  180. package/docs/reference/typescript-api/orders/guest-checkout-strategy.mdx +1 -1
  181. package/docs/reference/typescript-api/orders/merge-strategies.mdx +4 -4
  182. package/docs/reference/typescript-api/orders/order-by-code-access-strategy.mdx +2 -2
  183. package/docs/reference/typescript-api/orders/order-code-strategy.mdx +2 -2
  184. package/docs/reference/typescript-api/orders/order-interceptor.mdx +1 -1
  185. package/docs/reference/typescript-api/orders/order-item-price-calculation-strategy.mdx +1 -1
  186. package/docs/reference/typescript-api/orders/order-merge-strategy.mdx +1 -1
  187. package/docs/reference/typescript-api/orders/order-placed-strategy.mdx +1 -1
  188. package/docs/reference/typescript-api/orders/order-process.mdx +1 -1
  189. package/docs/reference/typescript-api/orders/order-seller-strategy.mdx +2 -2
  190. package/docs/reference/typescript-api/orders/stock-allocation-strategy.mdx +1 -1
  191. package/docs/reference/typescript-api/payment/payment-method-config-options.mdx +1 -1
  192. package/docs/reference/typescript-api/payment/payment-method-eligibility-checker.mdx +2 -2
  193. package/docs/reference/typescript-api/payment/payment-method-handler.mdx +1 -1
  194. package/docs/reference/typescript-api/payment/payment-process.mdx +1 -1
  195. package/docs/reference/typescript-api/payment/refund-process.mdx +1 -1
  196. package/docs/reference/typescript-api/plugin/vendure-plugin-metadata.mdx +1 -1
  197. package/docs/reference/typescript-api/products-stock/default-product-variant-price-calculation-strategy.mdx +1 -1
  198. package/docs/reference/typescript-api/products-stock/default-stock-display-strategy.mdx +1 -1
  199. package/docs/reference/typescript-api/products-stock/default-stock-location-strategy.mdx +1 -1
  200. package/docs/reference/typescript-api/products-stock/multi-channel-stock-location-strategy.mdx +1 -1
  201. package/docs/reference/typescript-api/products-stock/product-variant-price-calculation-strategy.mdx +1 -1
  202. package/docs/reference/typescript-api/products-stock/stock-display-strategy.mdx +1 -1
  203. package/docs/reference/typescript-api/products-stock/stock-location-strategy.mdx +1 -1
  204. package/docs/reference/typescript-api/promotions/facet-value-checker.mdx +1 -1
  205. package/docs/reference/typescript-api/promotions/promotion-action.mdx +10 -10
  206. package/docs/reference/typescript-api/promotions/promotion-condition.mdx +2 -2
  207. package/docs/reference/typescript-api/scheduled-tasks/default-scheduler-strategy.mdx +1 -1
  208. package/docs/reference/typescript-api/scheduled-tasks/scheduler-service.mdx +1 -1
  209. package/docs/reference/typescript-api/scheduled-tasks/scheduler-strategy.mdx +1 -1
  210. package/docs/reference/typescript-api/services/asset-service.mdx +1 -1
  211. package/docs/reference/typescript-api/services/collection-service.mdx +1 -1
  212. package/docs/reference/typescript-api/services/session-service.mdx +1 -1
  213. package/docs/reference/typescript-api/services/settings-store-service.mdx +1 -1
  214. package/docs/reference/typescript-api/shipping/default-shipping-line-assignment-strategy.mdx +1 -1
  215. package/docs/reference/typescript-api/shipping/shipping-calculator.mdx +1 -1
  216. package/docs/reference/typescript-api/shipping/shipping-eligibility-checker-config.mdx +1 -1
  217. package/docs/reference/typescript-api/shipping/shipping-eligibility-checker.mdx +1 -1
  218. package/docs/reference/typescript-api/shipping/shipping-line-assignment-strategy.mdx +1 -1
  219. package/docs/reference/typescript-api/tax/address-based-tax-zone-strategy.mdx +1 -1
  220. package/docs/reference/typescript-api/tax/default-tax-line-calculation-strategy.mdx +1 -1
  221. package/docs/reference/typescript-api/tax/default-tax-zone-strategy.mdx +1 -1
  222. package/docs/reference/typescript-api/tax/tax-line-calculation-strategy.mdx +1 -1
  223. package/docs/reference/typescript-api/tax/tax-zone-strategy.mdx +1 -1
  224. package/docs/reference/typescript-api/telemetry/instrumentation-strategy.mdx +1 -1
  225. package/docs/reference/typescript-api/testing/testing-logger.mdx +1 -1
  226. package/package.json +1 -1
  227. package/docs/reference/graphql-api/admin/enums.mdx +0 -1139
  228. package/docs/reference/graphql-api/admin/input-types.mdx +0 -4708
  229. package/docs/reference/graphql-api/admin/mutations.mdx +0 -2750
  230. package/docs/reference/graphql-api/admin/object-types.mdx +0 -4973
  231. package/docs/reference/graphql-api/admin/queries.mdx +0 -1194
  232. package/docs/reference/graphql-api/shop/enums.mdx +0 -1063
  233. package/docs/reference/graphql-api/shop/input-types.mdx +0 -1113
  234. package/docs/reference/graphql-api/shop/mutations.mdx +0 -540
  235. package/docs/reference/graphql-api/shop/object-types.mdx +0 -3693
  236. package/docs/reference/graphql-api/shop/queries.mdx +0 -314
@@ -1,3693 +0,0 @@
1
- ---
2
- title: "Types"
3
- generated: true
4
- ---
5
-
6
-
7
-
8
- ## ActiveOrderResult {#activeorderresult}
9
-
10
- <GraphQLDoc
11
- type="union"
12
- typeName="ActiveOrderResult"
13
- typeLinks={{
14
- Order: '/reference/graphql-api/shop/object-types#order',
15
- NoActiveOrderError: '/reference/graphql-api/shop/object-types#noactiveordererror',
16
- }}
17
- >
18
- {`union ActiveOrderResult = Order | NoActiveOrderError`}
19
- </GraphQLDoc>
20
-
21
- ## AddPaymentToOrderResult {#addpaymenttoorderresult}
22
-
23
- <GraphQLDoc
24
- type="union"
25
- typeName="AddPaymentToOrderResult"
26
- typeLinks={{
27
- Order: '/reference/graphql-api/shop/object-types#order',
28
- OrderPaymentStateError: '/reference/graphql-api/shop/object-types#orderpaymentstateerror',
29
- IneligiblePaymentMethodError: '/reference/graphql-api/shop/object-types#ineligiblepaymentmethoderror',
30
- PaymentFailedError: '/reference/graphql-api/shop/object-types#paymentfailederror',
31
- PaymentDeclinedError: '/reference/graphql-api/shop/object-types#paymentdeclinederror',
32
- OrderStateTransitionError: '/reference/graphql-api/shop/object-types#orderstatetransitionerror',
33
- NoActiveOrderError: '/reference/graphql-api/shop/object-types#noactiveordererror',
34
- }}
35
- >
36
- {`union AddPaymentToOrderResult = Order | OrderPaymentStateError | IneligiblePaymentMethodError | PaymentFailedError | PaymentDeclinedError | OrderStateTransitionError | NoActiveOrderError`}
37
- </GraphQLDoc>
38
-
39
- ## Address {#address}
40
-
41
- <GraphQLDoc
42
- type="type"
43
- typeName="Address"
44
- typeLinks={{
45
- ID: '/reference/graphql-api/shop/object-types#id',
46
- DateTime: '/reference/graphql-api/shop/object-types#datetime',
47
- String: '/reference/graphql-api/shop/object-types#string',
48
- Country: '/reference/graphql-api/shop/object-types#country',
49
- Boolean: '/reference/graphql-api/shop/object-types#boolean',
50
- JSON: '/reference/graphql-api/shop/object-types#json',
51
- }}
52
- >
53
- {`type Address {
54
- id: ID!
55
- createdAt: DateTime!
56
- updatedAt: DateTime!
57
- fullName: String
58
- company: String
59
- streetLine1: String!
60
- streetLine2: String
61
- city: String
62
- province: String
63
- postalCode: String
64
- country: Country!
65
- phoneNumber: String
66
- defaultShippingAddress: Boolean
67
- defaultBillingAddress: Boolean
68
- customFields: JSON
69
- }`}
70
- </GraphQLDoc>
71
-
72
- ## Adjustment {#adjustment}
73
-
74
- <GraphQLDoc
75
- type="type"
76
- typeName="Adjustment"
77
- typeLinks={{
78
- String: '/reference/graphql-api/shop/object-types#string',
79
- AdjustmentType: '/reference/graphql-api/shop/enums#adjustmenttype',
80
- Money: '/reference/graphql-api/shop/object-types#money',
81
- JSON: '/reference/graphql-api/shop/object-types#json',
82
- }}
83
- >
84
- {`type Adjustment {
85
- adjustmentSource: String!
86
- type: AdjustmentType!
87
- description: String!
88
- amount: Money!
89
- data: JSON
90
- }`}
91
- </GraphQLDoc>
92
-
93
- ## AlreadyLoggedInError {#alreadyloggedinerror}
94
-
95
- <GraphQLDoc
96
- type="type"
97
- typeName="AlreadyLoggedInError"
98
- typeLinks={{
99
- ErrorCode: '/reference/graphql-api/shop/enums#errorcode',
100
- String: '/reference/graphql-api/shop/object-types#string',
101
- }}
102
- >
103
- {`"""Returned when attempting to set the Customer for an Order when already logged in."""
104
- type AlreadyLoggedInError {
105
- errorCode: ErrorCode!
106
- message: String!
107
- }`}
108
- </GraphQLDoc>
109
-
110
- ## ApplyCouponCodeResult {#applycouponcoderesult}
111
-
112
- <GraphQLDoc
113
- type="union"
114
- typeName="ApplyCouponCodeResult"
115
- typeLinks={{
116
- Order: '/reference/graphql-api/shop/object-types#order',
117
- CouponCodeExpiredError: '/reference/graphql-api/shop/object-types#couponcodeexpirederror',
118
- CouponCodeInvalidError: '/reference/graphql-api/shop/object-types#couponcodeinvaliderror',
119
- CouponCodeLimitError: '/reference/graphql-api/shop/object-types#couponcodelimiterror',
120
- }}
121
- >
122
- {`union ApplyCouponCodeResult = Order | CouponCodeExpiredError | CouponCodeInvalidError | CouponCodeLimitError`}
123
- </GraphQLDoc>
124
-
125
- ## Asset {#asset}
126
-
127
- <GraphQLDoc
128
- type="type"
129
- typeName="Asset"
130
- typeLinks={{
131
- ID: '/reference/graphql-api/shop/object-types#id',
132
- DateTime: '/reference/graphql-api/shop/object-types#datetime',
133
- String: '/reference/graphql-api/shop/object-types#string',
134
- AssetType: '/reference/graphql-api/shop/enums#assettype',
135
- Int: '/reference/graphql-api/shop/object-types#int',
136
- Coordinate: '/reference/graphql-api/shop/object-types#coordinate',
137
- Tag: '/reference/graphql-api/shop/object-types#tag',
138
- JSON: '/reference/graphql-api/shop/object-types#json',
139
- }}
140
- >
141
- {`type Asset {
142
- id: ID!
143
- createdAt: DateTime!
144
- updatedAt: DateTime!
145
- name: String!
146
- type: AssetType!
147
- fileSize: Int!
148
- mimeType: String!
149
- width: Int!
150
- height: Int!
151
- source: String!
152
- preview: String!
153
- focalPoint: Coordinate
154
- tags: [Tag!]!
155
- customFields: JSON
156
- }`}
157
- </GraphQLDoc>
158
-
159
- ## AssetList {#assetlist}
160
-
161
- <GraphQLDoc
162
- type="type"
163
- typeName="AssetList"
164
- typeLinks={{
165
- Asset: '/reference/graphql-api/shop/object-types#asset',
166
- Int: '/reference/graphql-api/shop/object-types#int',
167
- }}
168
- >
169
- {`type AssetList {
170
- items: [Asset!]!
171
- totalItems: Int!
172
- }`}
173
- </GraphQLDoc>
174
-
175
- ## AuthenticationMethod {#authenticationmethod}
176
-
177
- <GraphQLDoc
178
- type="type"
179
- typeName="AuthenticationMethod"
180
- typeLinks={{
181
- ID: '/reference/graphql-api/shop/object-types#id',
182
- DateTime: '/reference/graphql-api/shop/object-types#datetime',
183
- String: '/reference/graphql-api/shop/object-types#string',
184
- }}
185
- >
186
- {`type AuthenticationMethod {
187
- id: ID!
188
- createdAt: DateTime!
189
- updatedAt: DateTime!
190
- strategy: String!
191
- }`}
192
- </GraphQLDoc>
193
-
194
- ## AuthenticationResult {#authenticationresult}
195
-
196
- <GraphQLDoc
197
- type="union"
198
- typeName="AuthenticationResult"
199
- typeLinks={{
200
- CurrentUser: '/reference/graphql-api/shop/object-types#currentuser',
201
- InvalidCredentialsError: '/reference/graphql-api/shop/object-types#invalidcredentialserror',
202
- NotVerifiedError: '/reference/graphql-api/shop/object-types#notverifiederror',
203
- }}
204
- >
205
- {`union AuthenticationResult = CurrentUser | InvalidCredentialsError | NotVerifiedError`}
206
- </GraphQLDoc>
207
-
208
- ## Boolean {#boolean}
209
-
210
- <GraphQLDoc
211
- type="scalar"
212
- typeName="Boolean"
213
- typeLinks={{}}
214
- >
215
- {`"""The \`Boolean\` scalar type represents \`true\` or \`false\`."""
216
- scalar Boolean`}
217
- </GraphQLDoc>
218
-
219
- ## BooleanCustomFieldConfig {#booleancustomfieldconfig}
220
-
221
- <GraphQLDoc
222
- type="type"
223
- typeName="BooleanCustomFieldConfig"
224
- typeLinks={{
225
- String: '/reference/graphql-api/shop/object-types#string',
226
- Boolean: '/reference/graphql-api/shop/object-types#boolean',
227
- LocalizedString: '/reference/graphql-api/shop/object-types#localizedstring',
228
- Permission: '/reference/graphql-api/shop/enums#permission',
229
- JSON: '/reference/graphql-api/shop/object-types#json',
230
- }}
231
- >
232
- {`type BooleanCustomFieldConfig {
233
- name: String!
234
- type: String!
235
- list: Boolean!
236
- label: [LocalizedString!]
237
- description: [LocalizedString!]
238
- readonly: Boolean
239
- internal: Boolean
240
- nullable: Boolean
241
- requiresPermission: [Permission!]
242
- deprecated: Boolean
243
- deprecationReason: String
244
- ui: JSON
245
- }`}
246
- </GraphQLDoc>
247
-
248
- ## BooleanStructFieldConfig {#booleanstructfieldconfig}
249
-
250
- <GraphQLDoc
251
- type="type"
252
- typeName="BooleanStructFieldConfig"
253
- typeLinks={{
254
- String: '/reference/graphql-api/shop/object-types#string',
255
- Boolean: '/reference/graphql-api/shop/object-types#boolean',
256
- LocalizedString: '/reference/graphql-api/shop/object-types#localizedstring',
257
- JSON: '/reference/graphql-api/shop/object-types#json',
258
- }}
259
- >
260
- {`type BooleanStructFieldConfig {
261
- name: String!
262
- type: String!
263
- list: Boolean!
264
- label: [LocalizedString!]
265
- description: [LocalizedString!]
266
- ui: JSON
267
- }`}
268
- </GraphQLDoc>
269
-
270
- ## Channel {#channel}
271
-
272
- <GraphQLDoc
273
- type="type"
274
- typeName="Channel"
275
- typeLinks={{
276
- ID: '/reference/graphql-api/shop/object-types#id',
277
- DateTime: '/reference/graphql-api/shop/object-types#datetime',
278
- String: '/reference/graphql-api/shop/object-types#string',
279
- Zone: '/reference/graphql-api/shop/object-types#zone',
280
- LanguageCode: '/reference/graphql-api/shop/enums#languagecode',
281
- CurrencyCode: '/reference/graphql-api/shop/enums#currencycode',
282
- Boolean: '/reference/graphql-api/shop/object-types#boolean',
283
- Int: '/reference/graphql-api/shop/object-types#int',
284
- Seller: '/reference/graphql-api/shop/object-types#seller',
285
- JSON: '/reference/graphql-api/shop/object-types#json',
286
- }}
287
- >
288
- {`type Channel {
289
- id: ID!
290
- createdAt: DateTime!
291
- updatedAt: DateTime!
292
- code: String!
293
- token: String!
294
- defaultTaxZone: Zone
295
- defaultShippingZone: Zone
296
- defaultLanguageCode: LanguageCode!
297
- availableLanguageCodes: [LanguageCode!]
298
- currencyCode: CurrencyCode!
299
- defaultCurrencyCode: CurrencyCode!
300
- availableCurrencyCodes: [CurrencyCode!]!
301
- """Not yet used - will be implemented in a future release."""
302
- trackInventory: Boolean
303
- """Not yet used - will be implemented in a future release."""
304
- outOfStockThreshold: Int
305
- pricesIncludeTax: Boolean!
306
- seller: Seller
307
- customFields: JSON
308
- }`}
309
- </GraphQLDoc>
310
-
311
- ## Collection {#collection}
312
-
313
- <GraphQLDoc
314
- type="type"
315
- typeName="Collection"
316
- typeLinks={{
317
- ID: '/reference/graphql-api/shop/object-types#id',
318
- DateTime: '/reference/graphql-api/shop/object-types#datetime',
319
- LanguageCode: '/reference/graphql-api/shop/enums#languagecode',
320
- String: '/reference/graphql-api/shop/object-types#string',
321
- CollectionBreadcrumb: '/reference/graphql-api/shop/object-types#collectionbreadcrumb',
322
- Int: '/reference/graphql-api/shop/object-types#int',
323
- Asset: '/reference/graphql-api/shop/object-types#asset',
324
- Collection: '/reference/graphql-api/shop/object-types#collection',
325
- ConfigurableOperation: '/reference/graphql-api/shop/object-types#configurableoperation',
326
- CollectionTranslation: '/reference/graphql-api/shop/object-types#collectiontranslation',
327
- ProductVariantList: '/reference/graphql-api/shop/object-types#productvariantlist',
328
- ProductVariantListOptions: '/reference/graphql-api/shop/input-types#productvariantlistoptions',
329
- JSON: '/reference/graphql-api/shop/object-types#json',
330
- }}
331
- >
332
- {`type Collection {
333
- id: ID!
334
- createdAt: DateTime!
335
- updatedAt: DateTime!
336
- languageCode: LanguageCode
337
- name: String!
338
- slug: String!
339
- breadcrumbs: [CollectionBreadcrumb!]!
340
- position: Int!
341
- description: String!
342
- featuredAsset: Asset
343
- assets: [Asset!]!
344
- parent: Collection
345
- parentId: ID!
346
- children: [Collection!]
347
- filters: [ConfigurableOperation!]!
348
- translations: [CollectionTranslation!]!
349
- productVariants(options: ProductVariantListOptions): ProductVariantList!
350
- customFields: JSON
351
- }`}
352
- </GraphQLDoc>
353
-
354
- ## CollectionBreadcrumb {#collectionbreadcrumb}
355
-
356
- <GraphQLDoc
357
- type="type"
358
- typeName="CollectionBreadcrumb"
359
- typeLinks={{
360
- ID: '/reference/graphql-api/shop/object-types#id',
361
- String: '/reference/graphql-api/shop/object-types#string',
362
- }}
363
- >
364
- {`type CollectionBreadcrumb {
365
- id: ID!
366
- name: String!
367
- slug: String!
368
- }`}
369
- </GraphQLDoc>
370
-
371
- ## CollectionList {#collectionlist}
372
-
373
- <GraphQLDoc
374
- type="type"
375
- typeName="CollectionList"
376
- typeLinks={{
377
- Collection: '/reference/graphql-api/shop/object-types#collection',
378
- Int: '/reference/graphql-api/shop/object-types#int',
379
- }}
380
- >
381
- {`type CollectionList {
382
- items: [Collection!]!
383
- totalItems: Int!
384
- }`}
385
- </GraphQLDoc>
386
-
387
- ## CollectionResult {#collectionresult}
388
-
389
- <GraphQLDoc
390
- type="type"
391
- typeName="CollectionResult"
392
- typeLinks={{
393
- Collection: '/reference/graphql-api/shop/object-types#collection',
394
- Int: '/reference/graphql-api/shop/object-types#int',
395
- }}
396
- >
397
- {`"""
398
- Which Collections are present in the products returned
399
- by the search, and in what quantity.
400
- """
401
- type CollectionResult {
402
- collection: Collection!
403
- count: Int!
404
- }`}
405
- </GraphQLDoc>
406
-
407
- ## CollectionTranslation {#collectiontranslation}
408
-
409
- <GraphQLDoc
410
- type="type"
411
- typeName="CollectionTranslation"
412
- typeLinks={{
413
- ID: '/reference/graphql-api/shop/object-types#id',
414
- DateTime: '/reference/graphql-api/shop/object-types#datetime',
415
- LanguageCode: '/reference/graphql-api/shop/enums#languagecode',
416
- String: '/reference/graphql-api/shop/object-types#string',
417
- }}
418
- >
419
- {`type CollectionTranslation {
420
- id: ID!
421
- createdAt: DateTime!
422
- updatedAt: DateTime!
423
- languageCode: LanguageCode!
424
- name: String!
425
- slug: String!
426
- description: String!
427
- }`}
428
- </GraphQLDoc>
429
-
430
- ## ConfigArg {#configarg}
431
-
432
- <GraphQLDoc
433
- type="type"
434
- typeName="ConfigArg"
435
- typeLinks={{
436
- String: '/reference/graphql-api/shop/object-types#string',
437
- }}
438
- >
439
- {`type ConfigArg {
440
- name: String!
441
- value: String!
442
- }`}
443
- </GraphQLDoc>
444
-
445
- ## ConfigArgDefinition {#configargdefinition}
446
-
447
- <GraphQLDoc
448
- type="type"
449
- typeName="ConfigArgDefinition"
450
- typeLinks={{
451
- String: '/reference/graphql-api/shop/object-types#string',
452
- Boolean: '/reference/graphql-api/shop/object-types#boolean',
453
- JSON: '/reference/graphql-api/shop/object-types#json',
454
- }}
455
- >
456
- {`type ConfigArgDefinition {
457
- name: String!
458
- type: String!
459
- list: Boolean!
460
- required: Boolean!
461
- defaultValue: JSON
462
- label: String
463
- description: String
464
- ui: JSON
465
- }`}
466
- </GraphQLDoc>
467
-
468
- ## ConfigurableOperation {#configurableoperation}
469
-
470
- <GraphQLDoc
471
- type="type"
472
- typeName="ConfigurableOperation"
473
- typeLinks={{
474
- String: '/reference/graphql-api/shop/object-types#string',
475
- ConfigArg: '/reference/graphql-api/shop/object-types#configarg',
476
- }}
477
- >
478
- {`type ConfigurableOperation {
479
- code: String!
480
- args: [ConfigArg!]!
481
- }`}
482
- </GraphQLDoc>
483
-
484
- ## ConfigurableOperationDefinition {#configurableoperationdefinition}
485
-
486
- <GraphQLDoc
487
- type="type"
488
- typeName="ConfigurableOperationDefinition"
489
- typeLinks={{
490
- String: '/reference/graphql-api/shop/object-types#string',
491
- ConfigArgDefinition: '/reference/graphql-api/shop/object-types#configargdefinition',
492
- }}
493
- >
494
- {`type ConfigurableOperationDefinition {
495
- code: String!
496
- args: [ConfigArgDefinition!]!
497
- description: String!
498
- }`}
499
- </GraphQLDoc>
500
-
501
- ## Coordinate {#coordinate}
502
-
503
- <GraphQLDoc
504
- type="type"
505
- typeName="Coordinate"
506
- typeLinks={{
507
- Float: '/reference/graphql-api/shop/object-types#float',
508
- }}
509
- >
510
- {`type Coordinate {
511
- x: Float!
512
- y: Float!
513
- }`}
514
- </GraphQLDoc>
515
-
516
- ## Country {#country}
517
-
518
- <GraphQLDoc
519
- type="type"
520
- typeName="Country"
521
- typeLinks={{
522
- ID: '/reference/graphql-api/shop/object-types#id',
523
- DateTime: '/reference/graphql-api/shop/object-types#datetime',
524
- LanguageCode: '/reference/graphql-api/shop/enums#languagecode',
525
- String: '/reference/graphql-api/shop/object-types#string',
526
- Boolean: '/reference/graphql-api/shop/object-types#boolean',
527
- Region: '/reference/graphql-api/shop/object-types#region',
528
- RegionTranslation: '/reference/graphql-api/shop/object-types#regiontranslation',
529
- JSON: '/reference/graphql-api/shop/object-types#json',
530
- }}
531
- >
532
- {`"""
533
- A Country of the world which your shop operates in.
534
-
535
- The \`code\` field is typically a 2-character ISO code such as "GB", "US", "DE" etc. This code is used in certain inputs such as
536
- \`UpdateAddressInput\` and \`CreateAddressInput\` to specify the country.
537
- """
538
- type Country {
539
- id: ID!
540
- createdAt: DateTime!
541
- updatedAt: DateTime!
542
- languageCode: LanguageCode!
543
- code: String!
544
- type: String!
545
- name: String!
546
- enabled: Boolean!
547
- parent: Region
548
- parentId: ID
549
- translations: [RegionTranslation!]!
550
- customFields: JSON
551
- }`}
552
- </GraphQLDoc>
553
-
554
- ## CountryList {#countrylist}
555
-
556
- <GraphQLDoc
557
- type="type"
558
- typeName="CountryList"
559
- typeLinks={{
560
- Country: '/reference/graphql-api/shop/object-types#country',
561
- Int: '/reference/graphql-api/shop/object-types#int',
562
- }}
563
- >
564
- {`type CountryList {
565
- items: [Country!]!
566
- totalItems: Int!
567
- }`}
568
- </GraphQLDoc>
569
-
570
- ## CouponCodeExpiredError {#couponcodeexpirederror}
571
-
572
- <GraphQLDoc
573
- type="type"
574
- typeName="CouponCodeExpiredError"
575
- typeLinks={{
576
- ErrorCode: '/reference/graphql-api/shop/enums#errorcode',
577
- String: '/reference/graphql-api/shop/object-types#string',
578
- }}
579
- >
580
- {`"""Returned if the provided coupon code is invalid"""
581
- type CouponCodeExpiredError {
582
- errorCode: ErrorCode!
583
- message: String!
584
- couponCode: String!
585
- }`}
586
- </GraphQLDoc>
587
-
588
- ## CouponCodeInvalidError {#couponcodeinvaliderror}
589
-
590
- <GraphQLDoc
591
- type="type"
592
- typeName="CouponCodeInvalidError"
593
- typeLinks={{
594
- ErrorCode: '/reference/graphql-api/shop/enums#errorcode',
595
- String: '/reference/graphql-api/shop/object-types#string',
596
- }}
597
- >
598
- {`"""Returned if the provided coupon code is invalid"""
599
- type CouponCodeInvalidError {
600
- errorCode: ErrorCode!
601
- message: String!
602
- couponCode: String!
603
- }`}
604
- </GraphQLDoc>
605
-
606
- ## CouponCodeLimitError {#couponcodelimiterror}
607
-
608
- <GraphQLDoc
609
- type="type"
610
- typeName="CouponCodeLimitError"
611
- typeLinks={{
612
- ErrorCode: '/reference/graphql-api/shop/enums#errorcode',
613
- String: '/reference/graphql-api/shop/object-types#string',
614
- Int: '/reference/graphql-api/shop/object-types#int',
615
- }}
616
- >
617
- {`"""Returned if the provided coupon code is invalid"""
618
- type CouponCodeLimitError {
619
- errorCode: ErrorCode!
620
- message: String!
621
- couponCode: String!
622
- limit: Int!
623
- }`}
624
- </GraphQLDoc>
625
-
626
- ## CurrentUser {#currentuser}
627
-
628
- <GraphQLDoc
629
- type="type"
630
- typeName="CurrentUser"
631
- typeLinks={{
632
- ID: '/reference/graphql-api/shop/object-types#id',
633
- String: '/reference/graphql-api/shop/object-types#string',
634
- CurrentUserChannel: '/reference/graphql-api/shop/object-types#currentuserchannel',
635
- }}
636
- >
637
- {`type CurrentUser {
638
- id: ID!
639
- identifier: String!
640
- channels: [CurrentUserChannel!]!
641
- }`}
642
- </GraphQLDoc>
643
-
644
- ## CurrentUserChannel {#currentuserchannel}
645
-
646
- <GraphQLDoc
647
- type="type"
648
- typeName="CurrentUserChannel"
649
- typeLinks={{
650
- ID: '/reference/graphql-api/shop/object-types#id',
651
- String: '/reference/graphql-api/shop/object-types#string',
652
- Permission: '/reference/graphql-api/shop/enums#permission',
653
- }}
654
- >
655
- {`type CurrentUserChannel {
656
- id: ID!
657
- token: String!
658
- code: String!
659
- permissions: [Permission!]!
660
- }`}
661
- </GraphQLDoc>
662
-
663
- ## CustomFieldConfig {#customfieldconfig}
664
-
665
- <GraphQLDoc
666
- type="union"
667
- typeName="CustomFieldConfig"
668
- typeLinks={{
669
- StringCustomFieldConfig: '/reference/graphql-api/shop/object-types#stringcustomfieldconfig',
670
- LocaleStringCustomFieldConfig: '/reference/graphql-api/shop/object-types#localestringcustomfieldconfig',
671
- IntCustomFieldConfig: '/reference/graphql-api/shop/object-types#intcustomfieldconfig',
672
- FloatCustomFieldConfig: '/reference/graphql-api/shop/object-types#floatcustomfieldconfig',
673
- BooleanCustomFieldConfig: '/reference/graphql-api/shop/object-types#booleancustomfieldconfig',
674
- DateTimeCustomFieldConfig: '/reference/graphql-api/shop/object-types#datetimecustomfieldconfig',
675
- RelationCustomFieldConfig: '/reference/graphql-api/shop/object-types#relationcustomfieldconfig',
676
- TextCustomFieldConfig: '/reference/graphql-api/shop/object-types#textcustomfieldconfig',
677
- LocaleTextCustomFieldConfig: '/reference/graphql-api/shop/object-types#localetextcustomfieldconfig',
678
- StructCustomFieldConfig: '/reference/graphql-api/shop/object-types#structcustomfieldconfig',
679
- }}
680
- >
681
- {`union CustomFieldConfig = StringCustomFieldConfig | LocaleStringCustomFieldConfig | IntCustomFieldConfig | FloatCustomFieldConfig | BooleanCustomFieldConfig | DateTimeCustomFieldConfig | RelationCustomFieldConfig | TextCustomFieldConfig | LocaleTextCustomFieldConfig | StructCustomFieldConfig`}
682
- </GraphQLDoc>
683
-
684
- ## Customer {#customer}
685
-
686
- <GraphQLDoc
687
- type="type"
688
- typeName="Customer"
689
- typeLinks={{
690
- ID: '/reference/graphql-api/shop/object-types#id',
691
- DateTime: '/reference/graphql-api/shop/object-types#datetime',
692
- String: '/reference/graphql-api/shop/object-types#string',
693
- Address: '/reference/graphql-api/shop/object-types#address',
694
- OrderList: '/reference/graphql-api/shop/object-types#orderlist',
695
- OrderListOptions: '/reference/graphql-api/shop/input-types#orderlistoptions',
696
- User: '/reference/graphql-api/shop/object-types#user',
697
- JSON: '/reference/graphql-api/shop/object-types#json',
698
- }}
699
- >
700
- {`type Customer {
701
- id: ID!
702
- createdAt: DateTime!
703
- updatedAt: DateTime!
704
- title: String
705
- firstName: String!
706
- lastName: String!
707
- phoneNumber: String
708
- emailAddress: String!
709
- addresses: [Address!]
710
- orders(options: OrderListOptions): OrderList!
711
- user: User
712
- customFields: JSON
713
- }`}
714
- </GraphQLDoc>
715
-
716
- ## CustomerGroup {#customergroup}
717
-
718
- <GraphQLDoc
719
- type="type"
720
- typeName="CustomerGroup"
721
- typeLinks={{
722
- ID: '/reference/graphql-api/shop/object-types#id',
723
- DateTime: '/reference/graphql-api/shop/object-types#datetime',
724
- String: '/reference/graphql-api/shop/object-types#string',
725
- CustomerList: '/reference/graphql-api/shop/object-types#customerlist',
726
- CustomerListOptions: '/reference/graphql-api/shop/input-types#customerlistoptions',
727
- JSON: '/reference/graphql-api/shop/object-types#json',
728
- }}
729
- >
730
- {`type CustomerGroup {
731
- id: ID!
732
- createdAt: DateTime!
733
- updatedAt: DateTime!
734
- name: String!
735
- customers(options: CustomerListOptions): CustomerList!
736
- customFields: JSON
737
- }`}
738
- </GraphQLDoc>
739
-
740
- ## CustomerList {#customerlist}
741
-
742
- <GraphQLDoc
743
- type="type"
744
- typeName="CustomerList"
745
- typeLinks={{
746
- Customer: '/reference/graphql-api/shop/object-types#customer',
747
- Int: '/reference/graphql-api/shop/object-types#int',
748
- }}
749
- >
750
- {`type CustomerList {
751
- items: [Customer!]!
752
- totalItems: Int!
753
- }`}
754
- </GraphQLDoc>
755
-
756
- ## DateTime {#datetime}
757
-
758
- <GraphQLDoc
759
- type="scalar"
760
- typeName="DateTime"
761
- typeLinks={{}}
762
- >
763
- {`"""A date-time string at UTC, such as 2007-12-03T10:15:30Z, compliant with the \`date-time\` format outlined in section 5.6 of the RFC 3339 profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar."""
764
- scalar DateTime`}
765
- </GraphQLDoc>
766
-
767
- ## DateTimeCustomFieldConfig {#datetimecustomfieldconfig}
768
-
769
- <GraphQLDoc
770
- type="type"
771
- typeName="DateTimeCustomFieldConfig"
772
- typeLinks={{
773
- String: '/reference/graphql-api/shop/object-types#string',
774
- Boolean: '/reference/graphql-api/shop/object-types#boolean',
775
- LocalizedString: '/reference/graphql-api/shop/object-types#localizedstring',
776
- Permission: '/reference/graphql-api/shop/enums#permission',
777
- Int: '/reference/graphql-api/shop/object-types#int',
778
- JSON: '/reference/graphql-api/shop/object-types#json',
779
- }}
780
- >
781
- {`"""
782
- Expects the same validation formats as the \`<input type="datetime-local">\` HTML element.
783
- See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/datetime-local#Additional_attributes
784
- """
785
- type DateTimeCustomFieldConfig {
786
- name: String!
787
- type: String!
788
- list: Boolean!
789
- label: [LocalizedString!]
790
- description: [LocalizedString!]
791
- readonly: Boolean
792
- internal: Boolean
793
- nullable: Boolean
794
- requiresPermission: [Permission!]
795
- deprecated: Boolean
796
- deprecationReason: String
797
- min: String
798
- max: String
799
- step: Int
800
- ui: JSON
801
- }`}
802
- </GraphQLDoc>
803
-
804
- ## DateTimeStructFieldConfig {#datetimestructfieldconfig}
805
-
806
- <GraphQLDoc
807
- type="type"
808
- typeName="DateTimeStructFieldConfig"
809
- typeLinks={{
810
- String: '/reference/graphql-api/shop/object-types#string',
811
- Boolean: '/reference/graphql-api/shop/object-types#boolean',
812
- LocalizedString: '/reference/graphql-api/shop/object-types#localizedstring',
813
- Int: '/reference/graphql-api/shop/object-types#int',
814
- JSON: '/reference/graphql-api/shop/object-types#json',
815
- }}
816
- >
817
- {`"""
818
- Expects the same validation formats as the \`<input type="datetime-local">\` HTML element.
819
- See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/datetime-local#Additional_attributes
820
- """
821
- type DateTimeStructFieldConfig {
822
- name: String!
823
- type: String!
824
- list: Boolean!
825
- label: [LocalizedString!]
826
- description: [LocalizedString!]
827
- min: String
828
- max: String
829
- step: Int
830
- ui: JSON
831
- }`}
832
- </GraphQLDoc>
833
-
834
- ## DeletionResponse {#deletionresponse}
835
-
836
- <GraphQLDoc
837
- type="type"
838
- typeName="DeletionResponse"
839
- typeLinks={{
840
- DeletionResult: '/reference/graphql-api/shop/enums#deletionresult',
841
- String: '/reference/graphql-api/shop/object-types#string',
842
- }}
843
- >
844
- {`type DeletionResponse {
845
- result: DeletionResult!
846
- message: String
847
- }`}
848
- </GraphQLDoc>
849
-
850
- ## Discount {#discount}
851
-
852
- <GraphQLDoc
853
- type="type"
854
- typeName="Discount"
855
- typeLinks={{
856
- String: '/reference/graphql-api/shop/object-types#string',
857
- AdjustmentType: '/reference/graphql-api/shop/enums#adjustmenttype',
858
- Money: '/reference/graphql-api/shop/object-types#money',
859
- }}
860
- >
861
- {`type Discount {
862
- adjustmentSource: String!
863
- type: AdjustmentType!
864
- description: String!
865
- amount: Money!
866
- amountWithTax: Money!
867
- }`}
868
- </GraphQLDoc>
869
-
870
- ## EmailAddressConflictError {#emailaddressconflicterror}
871
-
872
- <GraphQLDoc
873
- type="type"
874
- typeName="EmailAddressConflictError"
875
- typeLinks={{
876
- ErrorCode: '/reference/graphql-api/shop/enums#errorcode',
877
- String: '/reference/graphql-api/shop/object-types#string',
878
- }}
879
- >
880
- {`"""Returned when attempting to create a Customer with an email address already registered to an existing User."""
881
- type EmailAddressConflictError {
882
- errorCode: ErrorCode!
883
- message: String!
884
- }`}
885
- </GraphQLDoc>
886
-
887
- ## Facet {#facet}
888
-
889
- <GraphQLDoc
890
- type="type"
891
- typeName="Facet"
892
- typeLinks={{
893
- ID: '/reference/graphql-api/shop/object-types#id',
894
- DateTime: '/reference/graphql-api/shop/object-types#datetime',
895
- LanguageCode: '/reference/graphql-api/shop/enums#languagecode',
896
- String: '/reference/graphql-api/shop/object-types#string',
897
- FacetValue: '/reference/graphql-api/shop/object-types#facetvalue',
898
- FacetValueList: '/reference/graphql-api/shop/object-types#facetvaluelist',
899
- FacetValueListOptions: '/reference/graphql-api/shop/input-types#facetvaluelistoptions',
900
- FacetTranslation: '/reference/graphql-api/shop/object-types#facettranslation',
901
- JSON: '/reference/graphql-api/shop/object-types#json',
902
- }}
903
- >
904
- {`type Facet {
905
- id: ID!
906
- createdAt: DateTime!
907
- updatedAt: DateTime!
908
- languageCode: LanguageCode!
909
- name: String!
910
- code: String!
911
- values: [FacetValue!]!
912
- """Returns a paginated, sortable, filterable list of the Facet's values. Added in v2.1.0."""
913
- valueList(options: FacetValueListOptions): FacetValueList!
914
- translations: [FacetTranslation!]!
915
- customFields: JSON
916
- }`}
917
- </GraphQLDoc>
918
-
919
- ## FacetList {#facetlist}
920
-
921
- <GraphQLDoc
922
- type="type"
923
- typeName="FacetList"
924
- typeLinks={{
925
- Facet: '/reference/graphql-api/shop/object-types#facet',
926
- Int: '/reference/graphql-api/shop/object-types#int',
927
- }}
928
- >
929
- {`type FacetList {
930
- items: [Facet!]!
931
- totalItems: Int!
932
- }`}
933
- </GraphQLDoc>
934
-
935
- ## FacetTranslation {#facettranslation}
936
-
937
- <GraphQLDoc
938
- type="type"
939
- typeName="FacetTranslation"
940
- typeLinks={{
941
- ID: '/reference/graphql-api/shop/object-types#id',
942
- DateTime: '/reference/graphql-api/shop/object-types#datetime',
943
- LanguageCode: '/reference/graphql-api/shop/enums#languagecode',
944
- String: '/reference/graphql-api/shop/object-types#string',
945
- }}
946
- >
947
- {`type FacetTranslation {
948
- id: ID!
949
- createdAt: DateTime!
950
- updatedAt: DateTime!
951
- languageCode: LanguageCode!
952
- name: String!
953
- }`}
954
- </GraphQLDoc>
955
-
956
- ## FacetValue {#facetvalue}
957
-
958
- <GraphQLDoc
959
- type="type"
960
- typeName="FacetValue"
961
- typeLinks={{
962
- ID: '/reference/graphql-api/shop/object-types#id',
963
- DateTime: '/reference/graphql-api/shop/object-types#datetime',
964
- LanguageCode: '/reference/graphql-api/shop/enums#languagecode',
965
- Facet: '/reference/graphql-api/shop/object-types#facet',
966
- String: '/reference/graphql-api/shop/object-types#string',
967
- FacetValueTranslation: '/reference/graphql-api/shop/object-types#facetvaluetranslation',
968
- JSON: '/reference/graphql-api/shop/object-types#json',
969
- }}
970
- >
971
- {`type FacetValue {
972
- id: ID!
973
- createdAt: DateTime!
974
- updatedAt: DateTime!
975
- languageCode: LanguageCode!
976
- facet: Facet!
977
- facetId: ID!
978
- name: String!
979
- code: String!
980
- translations: [FacetValueTranslation!]!
981
- customFields: JSON
982
- }`}
983
- </GraphQLDoc>
984
-
985
- ## FacetValueList {#facetvaluelist}
986
-
987
- <GraphQLDoc
988
- type="type"
989
- typeName="FacetValueList"
990
- typeLinks={{
991
- FacetValue: '/reference/graphql-api/shop/object-types#facetvalue',
992
- Int: '/reference/graphql-api/shop/object-types#int',
993
- }}
994
- >
995
- {`type FacetValueList {
996
- items: [FacetValue!]!
997
- totalItems: Int!
998
- }`}
999
- </GraphQLDoc>
1000
-
1001
- ## FacetValueResult {#facetvalueresult}
1002
-
1003
- <GraphQLDoc
1004
- type="type"
1005
- typeName="FacetValueResult"
1006
- typeLinks={{
1007
- FacetValue: '/reference/graphql-api/shop/object-types#facetvalue',
1008
- Int: '/reference/graphql-api/shop/object-types#int',
1009
- }}
1010
- >
1011
- {`"""
1012
- Which FacetValues are present in the products returned
1013
- by the search, and in what quantity.
1014
- """
1015
- type FacetValueResult {
1016
- facetValue: FacetValue!
1017
- count: Int!
1018
- }`}
1019
- </GraphQLDoc>
1020
-
1021
- ## FacetValueTranslation {#facetvaluetranslation}
1022
-
1023
- <GraphQLDoc
1024
- type="type"
1025
- typeName="FacetValueTranslation"
1026
- typeLinks={{
1027
- ID: '/reference/graphql-api/shop/object-types#id',
1028
- DateTime: '/reference/graphql-api/shop/object-types#datetime',
1029
- LanguageCode: '/reference/graphql-api/shop/enums#languagecode',
1030
- String: '/reference/graphql-api/shop/object-types#string',
1031
- }}
1032
- >
1033
- {`type FacetValueTranslation {
1034
- id: ID!
1035
- createdAt: DateTime!
1036
- updatedAt: DateTime!
1037
- languageCode: LanguageCode!
1038
- name: String!
1039
- }`}
1040
- </GraphQLDoc>
1041
-
1042
- ## Float {#float}
1043
-
1044
- <GraphQLDoc
1045
- type="scalar"
1046
- typeName="Float"
1047
- typeLinks={{}}
1048
- >
1049
- {`"""The \`Float\` scalar type represents signed double-precision fractional values as specified by [IEEE 754](https://en.wikipedia.org/wiki/IEEE_floating_point)."""
1050
- scalar Float`}
1051
- </GraphQLDoc>
1052
-
1053
- ## FloatCustomFieldConfig {#floatcustomfieldconfig}
1054
-
1055
- <GraphQLDoc
1056
- type="type"
1057
- typeName="FloatCustomFieldConfig"
1058
- typeLinks={{
1059
- String: '/reference/graphql-api/shop/object-types#string',
1060
- Boolean: '/reference/graphql-api/shop/object-types#boolean',
1061
- LocalizedString: '/reference/graphql-api/shop/object-types#localizedstring',
1062
- Permission: '/reference/graphql-api/shop/enums#permission',
1063
- Float: '/reference/graphql-api/shop/object-types#float',
1064
- JSON: '/reference/graphql-api/shop/object-types#json',
1065
- }}
1066
- >
1067
- {`type FloatCustomFieldConfig {
1068
- name: String!
1069
- type: String!
1070
- list: Boolean!
1071
- label: [LocalizedString!]
1072
- description: [LocalizedString!]
1073
- readonly: Boolean
1074
- internal: Boolean
1075
- nullable: Boolean
1076
- requiresPermission: [Permission!]
1077
- deprecated: Boolean
1078
- deprecationReason: String
1079
- min: Float
1080
- max: Float
1081
- step: Float
1082
- ui: JSON
1083
- }`}
1084
- </GraphQLDoc>
1085
-
1086
- ## FloatStructFieldConfig {#floatstructfieldconfig}
1087
-
1088
- <GraphQLDoc
1089
- type="type"
1090
- typeName="FloatStructFieldConfig"
1091
- typeLinks={{
1092
- String: '/reference/graphql-api/shop/object-types#string',
1093
- Boolean: '/reference/graphql-api/shop/object-types#boolean',
1094
- LocalizedString: '/reference/graphql-api/shop/object-types#localizedstring',
1095
- Float: '/reference/graphql-api/shop/object-types#float',
1096
- JSON: '/reference/graphql-api/shop/object-types#json',
1097
- }}
1098
- >
1099
- {`type FloatStructFieldConfig {
1100
- name: String!
1101
- type: String!
1102
- list: Boolean!
1103
- label: [LocalizedString!]
1104
- description: [LocalizedString!]
1105
- min: Float
1106
- max: Float
1107
- step: Float
1108
- ui: JSON
1109
- }`}
1110
- </GraphQLDoc>
1111
-
1112
- ## Fulfillment {#fulfillment}
1113
-
1114
- <GraphQLDoc
1115
- type="type"
1116
- typeName="Fulfillment"
1117
- typeLinks={{
1118
- ID: '/reference/graphql-api/shop/object-types#id',
1119
- DateTime: '/reference/graphql-api/shop/object-types#datetime',
1120
- FulfillmentLine: '/reference/graphql-api/shop/object-types#fulfillmentline',
1121
- String: '/reference/graphql-api/shop/object-types#string',
1122
- JSON: '/reference/graphql-api/shop/object-types#json',
1123
- }}
1124
- >
1125
- {`type Fulfillment {
1126
- id: ID!
1127
- createdAt: DateTime!
1128
- updatedAt: DateTime!
1129
- lines: [FulfillmentLine!]!
1130
- summary: [FulfillmentLine!]!
1131
- state: String!
1132
- method: String!
1133
- trackingCode: String
1134
- customFields: JSON
1135
- }`}
1136
- </GraphQLDoc>
1137
-
1138
- ## FulfillmentLine {#fulfillmentline}
1139
-
1140
- <GraphQLDoc
1141
- type="type"
1142
- typeName="FulfillmentLine"
1143
- typeLinks={{
1144
- OrderLine: '/reference/graphql-api/shop/object-types#orderline',
1145
- ID: '/reference/graphql-api/shop/object-types#id',
1146
- Int: '/reference/graphql-api/shop/object-types#int',
1147
- Fulfillment: '/reference/graphql-api/shop/object-types#fulfillment',
1148
- }}
1149
- >
1150
- {`type FulfillmentLine {
1151
- orderLine: OrderLine!
1152
- orderLineId: ID!
1153
- quantity: Int!
1154
- fulfillment: Fulfillment!
1155
- fulfillmentId: ID!
1156
- }`}
1157
- </GraphQLDoc>
1158
-
1159
- ## GuestCheckoutError {#guestcheckouterror}
1160
-
1161
- <GraphQLDoc
1162
- type="type"
1163
- typeName="GuestCheckoutError"
1164
- typeLinks={{
1165
- ErrorCode: '/reference/graphql-api/shop/enums#errorcode',
1166
- String: '/reference/graphql-api/shop/object-types#string',
1167
- }}
1168
- >
1169
- {`"""Returned when attempting to set the Customer on a guest checkout when the configured GuestCheckoutStrategy does not allow it."""
1170
- type GuestCheckoutError {
1171
- errorCode: ErrorCode!
1172
- message: String!
1173
- errorDetail: String!
1174
- }`}
1175
- </GraphQLDoc>
1176
-
1177
- ## HistoryEntry {#historyentry}
1178
-
1179
- <GraphQLDoc
1180
- type="type"
1181
- typeName="HistoryEntry"
1182
- typeLinks={{
1183
- ID: '/reference/graphql-api/shop/object-types#id',
1184
- DateTime: '/reference/graphql-api/shop/object-types#datetime',
1185
- HistoryEntryType: '/reference/graphql-api/shop/enums#historyentrytype',
1186
- JSON: '/reference/graphql-api/shop/object-types#json',
1187
- }}
1188
- >
1189
- {`type HistoryEntry {
1190
- id: ID!
1191
- createdAt: DateTime!
1192
- updatedAt: DateTime!
1193
- type: HistoryEntryType!
1194
- data: JSON!
1195
- customFields: JSON
1196
- }`}
1197
- </GraphQLDoc>
1198
-
1199
- ## HistoryEntryList {#historyentrylist}
1200
-
1201
- <GraphQLDoc
1202
- type="type"
1203
- typeName="HistoryEntryList"
1204
- typeLinks={{
1205
- HistoryEntry: '/reference/graphql-api/shop/object-types#historyentry',
1206
- Int: '/reference/graphql-api/shop/object-types#int',
1207
- }}
1208
- >
1209
- {`type HistoryEntryList {
1210
- items: [HistoryEntry!]!
1211
- totalItems: Int!
1212
- }`}
1213
- </GraphQLDoc>
1214
-
1215
- ## ID {#id}
1216
-
1217
- <GraphQLDoc
1218
- type="scalar"
1219
- typeName="ID"
1220
- typeLinks={{}}
1221
- >
1222
- {`"""The \`ID\` scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as \`"4"\`) or integer (such as \`4\`) input value will be accepted as an ID."""
1223
- scalar ID`}
1224
- </GraphQLDoc>
1225
-
1226
- ## IdentifierChangeTokenExpiredError {#identifierchangetokenexpirederror}
1227
-
1228
- <GraphQLDoc
1229
- type="type"
1230
- typeName="IdentifierChangeTokenExpiredError"
1231
- typeLinks={{
1232
- ErrorCode: '/reference/graphql-api/shop/enums#errorcode',
1233
- String: '/reference/graphql-api/shop/object-types#string',
1234
- }}
1235
- >
1236
- {`"""
1237
- Returned if the token used to change a Customer's email address is valid, but has
1238
- expired according to the \`verificationTokenDuration\` setting in the AuthOptions.
1239
- """
1240
- type IdentifierChangeTokenExpiredError {
1241
- errorCode: ErrorCode!
1242
- message: String!
1243
- }`}
1244
- </GraphQLDoc>
1245
-
1246
- ## IdentifierChangeTokenInvalidError {#identifierchangetokeninvaliderror}
1247
-
1248
- <GraphQLDoc
1249
- type="type"
1250
- typeName="IdentifierChangeTokenInvalidError"
1251
- typeLinks={{
1252
- ErrorCode: '/reference/graphql-api/shop/enums#errorcode',
1253
- String: '/reference/graphql-api/shop/object-types#string',
1254
- }}
1255
- >
1256
- {`"""
1257
- Returned if the token used to change a Customer's email address is either
1258
- invalid or does not match any expected tokens.
1259
- """
1260
- type IdentifierChangeTokenInvalidError {
1261
- errorCode: ErrorCode!
1262
- message: String!
1263
- }`}
1264
- </GraphQLDoc>
1265
-
1266
- ## IneligiblePaymentMethodError {#ineligiblepaymentmethoderror}
1267
-
1268
- <GraphQLDoc
1269
- type="type"
1270
- typeName="IneligiblePaymentMethodError"
1271
- typeLinks={{
1272
- ErrorCode: '/reference/graphql-api/shop/enums#errorcode',
1273
- String: '/reference/graphql-api/shop/object-types#string',
1274
- }}
1275
- >
1276
- {`"""Returned when attempting to add a Payment using a PaymentMethod for which the Order is not eligible."""
1277
- type IneligiblePaymentMethodError {
1278
- errorCode: ErrorCode!
1279
- message: String!
1280
- eligibilityCheckerMessage: String
1281
- }`}
1282
- </GraphQLDoc>
1283
-
1284
- ## IneligibleShippingMethodError {#ineligibleshippingmethoderror}
1285
-
1286
- <GraphQLDoc
1287
- type="type"
1288
- typeName="IneligibleShippingMethodError"
1289
- typeLinks={{
1290
- ErrorCode: '/reference/graphql-api/shop/enums#errorcode',
1291
- String: '/reference/graphql-api/shop/object-types#string',
1292
- }}
1293
- >
1294
- {`"""Returned when attempting to set a ShippingMethod for which the Order is not eligible"""
1295
- type IneligibleShippingMethodError {
1296
- errorCode: ErrorCode!
1297
- message: String!
1298
- }`}
1299
- </GraphQLDoc>
1300
-
1301
- ## InsufficientStockError {#insufficientstockerror}
1302
-
1303
- <GraphQLDoc
1304
- type="type"
1305
- typeName="InsufficientStockError"
1306
- typeLinks={{
1307
- ErrorCode: '/reference/graphql-api/shop/enums#errorcode',
1308
- String: '/reference/graphql-api/shop/object-types#string',
1309
- Int: '/reference/graphql-api/shop/object-types#int',
1310
- Order: '/reference/graphql-api/shop/object-types#order',
1311
- }}
1312
- >
1313
- {`"""Returned when attempting to add more items to the Order than are available"""
1314
- type InsufficientStockError {
1315
- errorCode: ErrorCode!
1316
- message: String!
1317
- quantityAvailable: Int!
1318
- order: Order!
1319
- }`}
1320
- </GraphQLDoc>
1321
-
1322
- ## Int {#int}
1323
-
1324
- <GraphQLDoc
1325
- type="scalar"
1326
- typeName="Int"
1327
- typeLinks={{}}
1328
- >
1329
- {`"""The \`Int\` scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1."""
1330
- scalar Int`}
1331
- </GraphQLDoc>
1332
-
1333
- ## IntCustomFieldConfig {#intcustomfieldconfig}
1334
-
1335
- <GraphQLDoc
1336
- type="type"
1337
- typeName="IntCustomFieldConfig"
1338
- typeLinks={{
1339
- String: '/reference/graphql-api/shop/object-types#string',
1340
- Boolean: '/reference/graphql-api/shop/object-types#boolean',
1341
- LocalizedString: '/reference/graphql-api/shop/object-types#localizedstring',
1342
- Permission: '/reference/graphql-api/shop/enums#permission',
1343
- Int: '/reference/graphql-api/shop/object-types#int',
1344
- JSON: '/reference/graphql-api/shop/object-types#json',
1345
- }}
1346
- >
1347
- {`type IntCustomFieldConfig {
1348
- name: String!
1349
- type: String!
1350
- list: Boolean!
1351
- label: [LocalizedString!]
1352
- description: [LocalizedString!]
1353
- readonly: Boolean
1354
- internal: Boolean
1355
- nullable: Boolean
1356
- requiresPermission: [Permission!]
1357
- deprecated: Boolean
1358
- deprecationReason: String
1359
- min: Int
1360
- max: Int
1361
- step: Int
1362
- ui: JSON
1363
- }`}
1364
- </GraphQLDoc>
1365
-
1366
- ## IntStructFieldConfig {#intstructfieldconfig}
1367
-
1368
- <GraphQLDoc
1369
- type="type"
1370
- typeName="IntStructFieldConfig"
1371
- typeLinks={{
1372
- String: '/reference/graphql-api/shop/object-types#string',
1373
- Boolean: '/reference/graphql-api/shop/object-types#boolean',
1374
- LocalizedString: '/reference/graphql-api/shop/object-types#localizedstring',
1375
- Int: '/reference/graphql-api/shop/object-types#int',
1376
- JSON: '/reference/graphql-api/shop/object-types#json',
1377
- }}
1378
- >
1379
- {`type IntStructFieldConfig {
1380
- name: String!
1381
- type: String!
1382
- list: Boolean!
1383
- label: [LocalizedString!]
1384
- description: [LocalizedString!]
1385
- min: Int
1386
- max: Int
1387
- step: Int
1388
- ui: JSON
1389
- }`}
1390
- </GraphQLDoc>
1391
-
1392
- ## InvalidCredentialsError {#invalidcredentialserror}
1393
-
1394
- <GraphQLDoc
1395
- type="type"
1396
- typeName="InvalidCredentialsError"
1397
- typeLinks={{
1398
- ErrorCode: '/reference/graphql-api/shop/enums#errorcode',
1399
- String: '/reference/graphql-api/shop/object-types#string',
1400
- }}
1401
- >
1402
- {`"""Returned if the user authentication credentials are not valid"""
1403
- type InvalidCredentialsError {
1404
- errorCode: ErrorCode!
1405
- message: String!
1406
- authenticationError: String!
1407
- }`}
1408
- </GraphQLDoc>
1409
-
1410
- ## JSON {#json}
1411
-
1412
- <GraphQLDoc
1413
- type="scalar"
1414
- typeName="JSON"
1415
- typeLinks={{}}
1416
- >
1417
- {`"""The \`JSON\` scalar type represents JSON values as specified by [ECMA-404](http://www.ecma-international.org/publications/files/ECMA-ST/ECMA-404.pdf)."""
1418
- scalar JSON`}
1419
- </GraphQLDoc>
1420
-
1421
- ## LocaleStringCustomFieldConfig {#localestringcustomfieldconfig}
1422
-
1423
- <GraphQLDoc
1424
- type="type"
1425
- typeName="LocaleStringCustomFieldConfig"
1426
- typeLinks={{
1427
- String: '/reference/graphql-api/shop/object-types#string',
1428
- Boolean: '/reference/graphql-api/shop/object-types#boolean',
1429
- Int: '/reference/graphql-api/shop/object-types#int',
1430
- LocalizedString: '/reference/graphql-api/shop/object-types#localizedstring',
1431
- Permission: '/reference/graphql-api/shop/enums#permission',
1432
- JSON: '/reference/graphql-api/shop/object-types#json',
1433
- }}
1434
- >
1435
- {`type LocaleStringCustomFieldConfig {
1436
- name: String!
1437
- type: String!
1438
- list: Boolean!
1439
- length: Int
1440
- label: [LocalizedString!]
1441
- description: [LocalizedString!]
1442
- readonly: Boolean
1443
- internal: Boolean
1444
- nullable: Boolean
1445
- requiresPermission: [Permission!]
1446
- deprecated: Boolean
1447
- deprecationReason: String
1448
- pattern: String
1449
- ui: JSON
1450
- }`}
1451
- </GraphQLDoc>
1452
-
1453
- ## LocaleTextCustomFieldConfig {#localetextcustomfieldconfig}
1454
-
1455
- <GraphQLDoc
1456
- type="type"
1457
- typeName="LocaleTextCustomFieldConfig"
1458
- typeLinks={{
1459
- String: '/reference/graphql-api/shop/object-types#string',
1460
- Boolean: '/reference/graphql-api/shop/object-types#boolean',
1461
- LocalizedString: '/reference/graphql-api/shop/object-types#localizedstring',
1462
- Permission: '/reference/graphql-api/shop/enums#permission',
1463
- JSON: '/reference/graphql-api/shop/object-types#json',
1464
- }}
1465
- >
1466
- {`type LocaleTextCustomFieldConfig {
1467
- name: String!
1468
- type: String!
1469
- list: Boolean!
1470
- label: [LocalizedString!]
1471
- description: [LocalizedString!]
1472
- readonly: Boolean
1473
- internal: Boolean
1474
- nullable: Boolean
1475
- requiresPermission: [Permission!]
1476
- deprecated: Boolean
1477
- deprecationReason: String
1478
- ui: JSON
1479
- }`}
1480
- </GraphQLDoc>
1481
-
1482
- ## LocalizedString {#localizedstring}
1483
-
1484
- <GraphQLDoc
1485
- type="type"
1486
- typeName="LocalizedString"
1487
- typeLinks={{
1488
- LanguageCode: '/reference/graphql-api/shop/enums#languagecode',
1489
- String: '/reference/graphql-api/shop/object-types#string',
1490
- }}
1491
- >
1492
- {`type LocalizedString {
1493
- languageCode: LanguageCode!
1494
- value: String!
1495
- }`}
1496
- </GraphQLDoc>
1497
-
1498
- ## MissingPasswordError {#missingpassworderror}
1499
-
1500
- <GraphQLDoc
1501
- type="type"
1502
- typeName="MissingPasswordError"
1503
- typeLinks={{
1504
- ErrorCode: '/reference/graphql-api/shop/enums#errorcode',
1505
- String: '/reference/graphql-api/shop/object-types#string',
1506
- }}
1507
- >
1508
- {`"""Returned when attempting to register or verify a customer account without a password, when one is required."""
1509
- type MissingPasswordError {
1510
- errorCode: ErrorCode!
1511
- message: String!
1512
- }`}
1513
- </GraphQLDoc>
1514
-
1515
- ## Money {#money}
1516
-
1517
- <GraphQLDoc
1518
- type="scalar"
1519
- typeName="Money"
1520
- typeLinks={{}}
1521
- >
1522
- {`"""The \`Money\` scalar type represents monetary values and supports signed double-precision fractional values as specified by [IEEE 754](https://en.wikipedia.org/wiki/IEEE_floating_point)."""
1523
- scalar Money`}
1524
- </GraphQLDoc>
1525
-
1526
- ## NativeAuthStrategyError {#nativeauthstrategyerror}
1527
-
1528
- <GraphQLDoc
1529
- type="type"
1530
- typeName="NativeAuthStrategyError"
1531
- typeLinks={{
1532
- ErrorCode: '/reference/graphql-api/shop/enums#errorcode',
1533
- String: '/reference/graphql-api/shop/object-types#string',
1534
- }}
1535
- >
1536
- {`"""Returned when attempting an operation that relies on the NativeAuthStrategy, if that strategy is not configured."""
1537
- type NativeAuthStrategyError {
1538
- errorCode: ErrorCode!
1539
- message: String!
1540
- }`}
1541
- </GraphQLDoc>
1542
-
1543
- ## NativeAuthenticationResult {#nativeauthenticationresult}
1544
-
1545
- <GraphQLDoc
1546
- type="union"
1547
- typeName="NativeAuthenticationResult"
1548
- typeLinks={{
1549
- CurrentUser: '/reference/graphql-api/shop/object-types#currentuser',
1550
- InvalidCredentialsError: '/reference/graphql-api/shop/object-types#invalidcredentialserror',
1551
- NotVerifiedError: '/reference/graphql-api/shop/object-types#notverifiederror',
1552
- NativeAuthStrategyError: '/reference/graphql-api/shop/object-types#nativeauthstrategyerror',
1553
- }}
1554
- >
1555
- {`union NativeAuthenticationResult = CurrentUser | InvalidCredentialsError | NotVerifiedError | NativeAuthStrategyError`}
1556
- </GraphQLDoc>
1557
-
1558
- ## NegativeQuantityError {#negativequantityerror}
1559
-
1560
- <GraphQLDoc
1561
- type="type"
1562
- typeName="NegativeQuantityError"
1563
- typeLinks={{
1564
- ErrorCode: '/reference/graphql-api/shop/enums#errorcode',
1565
- String: '/reference/graphql-api/shop/object-types#string',
1566
- }}
1567
- >
1568
- {`"""Returned when attempting to set a negative OrderLine quantity."""
1569
- type NegativeQuantityError {
1570
- errorCode: ErrorCode!
1571
- message: String!
1572
- }`}
1573
- </GraphQLDoc>
1574
-
1575
- ## NoActiveOrderError {#noactiveordererror}
1576
-
1577
- <GraphQLDoc
1578
- type="type"
1579
- typeName="NoActiveOrderError"
1580
- typeLinks={{
1581
- ErrorCode: '/reference/graphql-api/shop/enums#errorcode',
1582
- String: '/reference/graphql-api/shop/object-types#string',
1583
- }}
1584
- >
1585
- {`"""
1586
- Returned when invoking a mutation which depends on there being an active Order on the
1587
- current session.
1588
- """
1589
- type NoActiveOrderError {
1590
- errorCode: ErrorCode!
1591
- message: String!
1592
- }`}
1593
- </GraphQLDoc>
1594
-
1595
- ## NotVerifiedError {#notverifiederror}
1596
-
1597
- <GraphQLDoc
1598
- type="type"
1599
- typeName="NotVerifiedError"
1600
- typeLinks={{
1601
- ErrorCode: '/reference/graphql-api/shop/enums#errorcode',
1602
- String: '/reference/graphql-api/shop/object-types#string',
1603
- }}
1604
- >
1605
- {`"""
1606
- Returned if \`authOptions.requireVerification\` is set to \`true\` (which is the default)
1607
- and an unverified user attempts to authenticate.
1608
- """
1609
- type NotVerifiedError {
1610
- errorCode: ErrorCode!
1611
- message: String!
1612
- }`}
1613
- </GraphQLDoc>
1614
-
1615
- ## Order {#order}
1616
-
1617
- <GraphQLDoc
1618
- type="type"
1619
- typeName="Order"
1620
- typeLinks={{
1621
- ID: '/reference/graphql-api/shop/object-types#id',
1622
- DateTime: '/reference/graphql-api/shop/object-types#datetime',
1623
- OrderType: '/reference/graphql-api/shop/enums#ordertype',
1624
- String: '/reference/graphql-api/shop/object-types#string',
1625
- Boolean: '/reference/graphql-api/shop/object-types#boolean',
1626
- Customer: '/reference/graphql-api/shop/object-types#customer',
1627
- OrderAddress: '/reference/graphql-api/shop/object-types#orderaddress',
1628
- OrderLine: '/reference/graphql-api/shop/object-types#orderline',
1629
- Surcharge: '/reference/graphql-api/shop/object-types#surcharge',
1630
- Discount: '/reference/graphql-api/shop/object-types#discount',
1631
- Promotion: '/reference/graphql-api/shop/object-types#promotion',
1632
- Payment: '/reference/graphql-api/shop/object-types#payment',
1633
- Fulfillment: '/reference/graphql-api/shop/object-types#fulfillment',
1634
- Int: '/reference/graphql-api/shop/object-types#int',
1635
- Money: '/reference/graphql-api/shop/object-types#money',
1636
- CurrencyCode: '/reference/graphql-api/shop/enums#currencycode',
1637
- ShippingLine: '/reference/graphql-api/shop/object-types#shippingline',
1638
- OrderTaxSummary: '/reference/graphql-api/shop/object-types#ordertaxsummary',
1639
- HistoryEntryList: '/reference/graphql-api/shop/object-types#historyentrylist',
1640
- HistoryEntryListOptions: '/reference/graphql-api/shop/input-types#historyentrylistoptions',
1641
- JSON: '/reference/graphql-api/shop/object-types#json',
1642
- }}
1643
- >
1644
- {`type Order {
1645
- id: ID!
1646
- createdAt: DateTime!
1647
- updatedAt: DateTime!
1648
- type: OrderType!
1649
- """
1650
- The date & time that the Order was placed, i.e. the Customer
1651
- completed the checkout and the Order is no longer "active"
1652
- """
1653
- orderPlacedAt: DateTime
1654
- """A unique code for the Order"""
1655
- code: String!
1656
- state: String!
1657
- """An order is active as long as the payment process has not been completed"""
1658
- active: Boolean!
1659
- customer: Customer
1660
- shippingAddress: OrderAddress
1661
- billingAddress: OrderAddress
1662
- lines: [OrderLine!]!
1663
- """
1664
- Surcharges are arbitrary modifications to the Order total which are neither
1665
- ProductVariants nor discounts resulting from applied Promotions. For example,
1666
- one-off discounts based on customer interaction, or surcharges based on payment
1667
- methods.
1668
- """
1669
- surcharges: [Surcharge!]!
1670
- discounts: [Discount!]!
1671
- """An array of all coupon codes applied to the Order"""
1672
- couponCodes: [String!]!
1673
- """Promotions applied to the order. Only gets populated after the payment process has completed."""
1674
- promotions: [Promotion!]!
1675
- payments: [Payment!]
1676
- fulfillments: [Fulfillment!]
1677
- totalQuantity: Int!
1678
- """
1679
- The subTotal is the total of all OrderLines in the Order. This figure also includes any Order-level
1680
- discounts which have been prorated (proportionally distributed) amongst the items of each OrderLine.
1681
- To get a total of all OrderLines which does not account for prorated discounts, use the
1682
- sum of \`OrderLine.discountedLinePrice\` values.
1683
- """
1684
- subTotal: Money!
1685
- """Same as subTotal, but inclusive of tax"""
1686
- subTotalWithTax: Money!
1687
- currencyCode: CurrencyCode!
1688
- shippingLines: [ShippingLine!]!
1689
- shipping: Money!
1690
- shippingWithTax: Money!
1691
- """Equal to subTotal plus shipping"""
1692
- total: Money!
1693
- """The final payable amount. Equal to subTotalWithTax plus shippingWithTax"""
1694
- totalWithTax: Money!
1695
- """A summary of the taxes being applied to this Order"""
1696
- taxSummary: [OrderTaxSummary!]!
1697
- history(options: HistoryEntryListOptions): HistoryEntryList!
1698
- customFields: JSON
1699
- }`}
1700
- </GraphQLDoc>
1701
-
1702
- ## OrderAddress {#orderaddress}
1703
-
1704
- <GraphQLDoc
1705
- type="type"
1706
- typeName="OrderAddress"
1707
- typeLinks={{
1708
- String: '/reference/graphql-api/shop/object-types#string',
1709
- JSON: '/reference/graphql-api/shop/object-types#json',
1710
- }}
1711
- >
1712
- {`type OrderAddress {
1713
- fullName: String
1714
- company: String
1715
- streetLine1: String
1716
- streetLine2: String
1717
- city: String
1718
- province: String
1719
- postalCode: String
1720
- country: String
1721
- countryCode: String
1722
- phoneNumber: String
1723
- customFields: JSON
1724
- }`}
1725
- </GraphQLDoc>
1726
-
1727
- ## OrderInterceptorError {#orderinterceptorerror}
1728
-
1729
- <GraphQLDoc
1730
- type="type"
1731
- typeName="OrderInterceptorError"
1732
- typeLinks={{
1733
- ErrorCode: '/reference/graphql-api/shop/enums#errorcode',
1734
- String: '/reference/graphql-api/shop/object-types#string',
1735
- }}
1736
- >
1737
- {`"""Returned when an order operation is rejected by an OrderInterceptor method."""
1738
- type OrderInterceptorError {
1739
- errorCode: ErrorCode!
1740
- message: String!
1741
- interceptorError: String!
1742
- }`}
1743
- </GraphQLDoc>
1744
-
1745
- ## OrderLimitError {#orderlimiterror}
1746
-
1747
- <GraphQLDoc
1748
- type="type"
1749
- typeName="OrderLimitError"
1750
- typeLinks={{
1751
- ErrorCode: '/reference/graphql-api/shop/enums#errorcode',
1752
- String: '/reference/graphql-api/shop/object-types#string',
1753
- Int: '/reference/graphql-api/shop/object-types#int',
1754
- }}
1755
- >
1756
- {`"""Returned when the maximum order size limit has been reached."""
1757
- type OrderLimitError {
1758
- errorCode: ErrorCode!
1759
- message: String!
1760
- maxItems: Int!
1761
- }`}
1762
- </GraphQLDoc>
1763
-
1764
- ## OrderLine {#orderline}
1765
-
1766
- <GraphQLDoc
1767
- type="type"
1768
- typeName="OrderLine"
1769
- typeLinks={{
1770
- ID: '/reference/graphql-api/shop/object-types#id',
1771
- DateTime: '/reference/graphql-api/shop/object-types#datetime',
1772
- ProductVariant: '/reference/graphql-api/shop/object-types#productvariant',
1773
- Asset: '/reference/graphql-api/shop/object-types#asset',
1774
- Money: '/reference/graphql-api/shop/object-types#money',
1775
- Int: '/reference/graphql-api/shop/object-types#int',
1776
- Float: '/reference/graphql-api/shop/object-types#float',
1777
- Discount: '/reference/graphql-api/shop/object-types#discount',
1778
- TaxLine: '/reference/graphql-api/shop/object-types#taxline',
1779
- Order: '/reference/graphql-api/shop/object-types#order',
1780
- FulfillmentLine: '/reference/graphql-api/shop/object-types#fulfillmentline',
1781
- JSON: '/reference/graphql-api/shop/object-types#json',
1782
- }}
1783
- >
1784
- {`type OrderLine {
1785
- id: ID!
1786
- createdAt: DateTime!
1787
- updatedAt: DateTime!
1788
- productVariant: ProductVariant!
1789
- featuredAsset: Asset
1790
- """The price of a single unit, excluding tax and discounts"""
1791
- unitPrice: Money!
1792
- """The price of a single unit, including tax but excluding discounts"""
1793
- unitPriceWithTax: Money!
1794
- """Non-zero if the unitPrice has changed since it was initially added to Order"""
1795
- unitPriceChangeSinceAdded: Money!
1796
- """Non-zero if the unitPriceWithTax has changed since it was initially added to Order"""
1797
- unitPriceWithTaxChangeSinceAdded: Money!
1798
- """
1799
- The price of a single unit including discounts, excluding tax.
1800
-
1801
- If Order-level discounts have been applied, this will not be the
1802
- actual taxable unit price (see \`proratedUnitPrice\`), but is generally the
1803
- correct price to display to customers to avoid confusion
1804
- about the internal handling of distributed Order-level discounts.
1805
- """
1806
- discountedUnitPrice: Money!
1807
- """The price of a single unit including discounts and tax"""
1808
- discountedUnitPriceWithTax: Money!
1809
- """
1810
- The actual unit price, taking into account both item discounts _and_ prorated (proportionally-distributed)
1811
- Order-level discounts. This value is the true economic value of the OrderItem, and is used in tax
1812
- and refund calculations.
1813
- """
1814
- proratedUnitPrice: Money!
1815
- """The proratedUnitPrice including tax"""
1816
- proratedUnitPriceWithTax: Money!
1817
- """The quantity of items purchased"""
1818
- quantity: Int!
1819
- """The quantity at the time the Order was placed"""
1820
- orderPlacedQuantity: Int!
1821
- taxRate: Float!
1822
- """The total price of the line excluding tax and discounts."""
1823
- linePrice: Money!
1824
- """The total price of the line including tax but excluding discounts."""
1825
- linePriceWithTax: Money!
1826
- """The price of the line including discounts, excluding tax"""
1827
- discountedLinePrice: Money!
1828
- """The price of the line including discounts and tax"""
1829
- discountedLinePriceWithTax: Money!
1830
- """
1831
- The actual line price, taking into account both item discounts _and_ prorated (proportionally-distributed)
1832
- Order-level discounts. This value is the true economic value of the OrderLine, and is used in tax
1833
- and refund calculations.
1834
- """
1835
- proratedLinePrice: Money!
1836
- """The proratedLinePrice including tax"""
1837
- proratedLinePriceWithTax: Money!
1838
- """The total tax on this line"""
1839
- lineTax: Money!
1840
- discounts: [Discount!]!
1841
- taxLines: [TaxLine!]!
1842
- order: Order!
1843
- fulfillmentLines: [FulfillmentLine!]
1844
- customFields: JSON
1845
- }`}
1846
- </GraphQLDoc>
1847
-
1848
- ## OrderList {#orderlist}
1849
-
1850
- <GraphQLDoc
1851
- type="type"
1852
- typeName="OrderList"
1853
- typeLinks={{
1854
- Order: '/reference/graphql-api/shop/object-types#order',
1855
- Int: '/reference/graphql-api/shop/object-types#int',
1856
- }}
1857
- >
1858
- {`type OrderList {
1859
- items: [Order!]!
1860
- totalItems: Int!
1861
- }`}
1862
- </GraphQLDoc>
1863
-
1864
- ## OrderModificationError {#ordermodificationerror}
1865
-
1866
- <GraphQLDoc
1867
- type="type"
1868
- typeName="OrderModificationError"
1869
- typeLinks={{
1870
- ErrorCode: '/reference/graphql-api/shop/enums#errorcode',
1871
- String: '/reference/graphql-api/shop/object-types#string',
1872
- }}
1873
- >
1874
- {`"""Returned when attempting to modify the contents of an Order that is not in the \`AddingItems\` state."""
1875
- type OrderModificationError {
1876
- errorCode: ErrorCode!
1877
- message: String!
1878
- }`}
1879
- </GraphQLDoc>
1880
-
1881
- ## OrderPaymentStateError {#orderpaymentstateerror}
1882
-
1883
- <GraphQLDoc
1884
- type="type"
1885
- typeName="OrderPaymentStateError"
1886
- typeLinks={{
1887
- ErrorCode: '/reference/graphql-api/shop/enums#errorcode',
1888
- String: '/reference/graphql-api/shop/object-types#string',
1889
- }}
1890
- >
1891
- {`"""Returned when attempting to add a Payment to an Order that is not in the \`ArrangingPayment\` state."""
1892
- type OrderPaymentStateError {
1893
- errorCode: ErrorCode!
1894
- message: String!
1895
- }`}
1896
- </GraphQLDoc>
1897
-
1898
- ## OrderStateTransitionError {#orderstatetransitionerror}
1899
-
1900
- <GraphQLDoc
1901
- type="type"
1902
- typeName="OrderStateTransitionError"
1903
- typeLinks={{
1904
- ErrorCode: '/reference/graphql-api/shop/enums#errorcode',
1905
- String: '/reference/graphql-api/shop/object-types#string',
1906
- }}
1907
- >
1908
- {`"""Returned if there is an error in transitioning the Order state"""
1909
- type OrderStateTransitionError {
1910
- errorCode: ErrorCode!
1911
- message: String!
1912
- transitionError: String!
1913
- fromState: String!
1914
- toState: String!
1915
- }`}
1916
- </GraphQLDoc>
1917
-
1918
- ## OrderTaxSummary {#ordertaxsummary}
1919
-
1920
- <GraphQLDoc
1921
- type="type"
1922
- typeName="OrderTaxSummary"
1923
- typeLinks={{
1924
- String: '/reference/graphql-api/shop/object-types#string',
1925
- Float: '/reference/graphql-api/shop/object-types#float',
1926
- Money: '/reference/graphql-api/shop/object-types#money',
1927
- }}
1928
- >
1929
- {`"""
1930
- A summary of the taxes being applied to this order, grouped
1931
- by taxRate.
1932
- """
1933
- type OrderTaxSummary {
1934
- """A description of this tax"""
1935
- description: String!
1936
- """The taxRate as a percentage"""
1937
- taxRate: Float!
1938
- """The total net price of OrderLines to which this taxRate applies"""
1939
- taxBase: Money!
1940
- """The total tax being applied to the Order at this taxRate"""
1941
- taxTotal: Money!
1942
- }`}
1943
- </GraphQLDoc>
1944
-
1945
- ## PasswordAlreadySetError {#passwordalreadyseterror}
1946
-
1947
- <GraphQLDoc
1948
- type="type"
1949
- typeName="PasswordAlreadySetError"
1950
- typeLinks={{
1951
- ErrorCode: '/reference/graphql-api/shop/enums#errorcode',
1952
- String: '/reference/graphql-api/shop/object-types#string',
1953
- }}
1954
- >
1955
- {`"""Returned when attempting to verify a customer account with a password, when a password has already been set."""
1956
- type PasswordAlreadySetError {
1957
- errorCode: ErrorCode!
1958
- message: String!
1959
- }`}
1960
- </GraphQLDoc>
1961
-
1962
- ## PasswordResetTokenExpiredError {#passwordresettokenexpirederror}
1963
-
1964
- <GraphQLDoc
1965
- type="type"
1966
- typeName="PasswordResetTokenExpiredError"
1967
- typeLinks={{
1968
- ErrorCode: '/reference/graphql-api/shop/enums#errorcode',
1969
- String: '/reference/graphql-api/shop/object-types#string',
1970
- }}
1971
- >
1972
- {`"""
1973
- Returned if the token used to reset a Customer's password is valid, but has
1974
- expired according to the \`verificationTokenDuration\` setting in the AuthOptions.
1975
- """
1976
- type PasswordResetTokenExpiredError {
1977
- errorCode: ErrorCode!
1978
- message: String!
1979
- }`}
1980
- </GraphQLDoc>
1981
-
1982
- ## PasswordResetTokenInvalidError {#passwordresettokeninvaliderror}
1983
-
1984
- <GraphQLDoc
1985
- type="type"
1986
- typeName="PasswordResetTokenInvalidError"
1987
- typeLinks={{
1988
- ErrorCode: '/reference/graphql-api/shop/enums#errorcode',
1989
- String: '/reference/graphql-api/shop/object-types#string',
1990
- }}
1991
- >
1992
- {`"""
1993
- Returned if the token used to reset a Customer's password is either
1994
- invalid or does not match any expected tokens.
1995
- """
1996
- type PasswordResetTokenInvalidError {
1997
- errorCode: ErrorCode!
1998
- message: String!
1999
- }`}
2000
- </GraphQLDoc>
2001
-
2002
- ## PasswordValidationError {#passwordvalidationerror}
2003
-
2004
- <GraphQLDoc
2005
- type="type"
2006
- typeName="PasswordValidationError"
2007
- typeLinks={{
2008
- ErrorCode: '/reference/graphql-api/shop/enums#errorcode',
2009
- String: '/reference/graphql-api/shop/object-types#string',
2010
- }}
2011
- >
2012
- {`"""Returned when attempting to register or verify a customer account where the given password fails password validation."""
2013
- type PasswordValidationError {
2014
- errorCode: ErrorCode!
2015
- message: String!
2016
- validationErrorMessage: String!
2017
- }`}
2018
- </GraphQLDoc>
2019
-
2020
- ## Payment {#payment}
2021
-
2022
- <GraphQLDoc
2023
- type="type"
2024
- typeName="Payment"
2025
- typeLinks={{
2026
- ID: '/reference/graphql-api/shop/object-types#id',
2027
- DateTime: '/reference/graphql-api/shop/object-types#datetime',
2028
- String: '/reference/graphql-api/shop/object-types#string',
2029
- Money: '/reference/graphql-api/shop/object-types#money',
2030
- Refund: '/reference/graphql-api/shop/object-types#refund',
2031
- JSON: '/reference/graphql-api/shop/object-types#json',
2032
- }}
2033
- >
2034
- {`type Payment {
2035
- id: ID!
2036
- createdAt: DateTime!
2037
- updatedAt: DateTime!
2038
- method: String!
2039
- amount: Money!
2040
- state: String!
2041
- transactionId: String
2042
- errorMessage: String
2043
- refunds: [Refund!]!
2044
- metadata: JSON
2045
- customFields: JSON
2046
- }`}
2047
- </GraphQLDoc>
2048
-
2049
- ## PaymentDeclinedError {#paymentdeclinederror}
2050
-
2051
- <GraphQLDoc
2052
- type="type"
2053
- typeName="PaymentDeclinedError"
2054
- typeLinks={{
2055
- ErrorCode: '/reference/graphql-api/shop/enums#errorcode',
2056
- String: '/reference/graphql-api/shop/object-types#string',
2057
- }}
2058
- >
2059
- {`"""Returned when a Payment is declined by the payment provider."""
2060
- type PaymentDeclinedError {
2061
- errorCode: ErrorCode!
2062
- message: String!
2063
- paymentErrorMessage: String!
2064
- }`}
2065
- </GraphQLDoc>
2066
-
2067
- ## PaymentFailedError {#paymentfailederror}
2068
-
2069
- <GraphQLDoc
2070
- type="type"
2071
- typeName="PaymentFailedError"
2072
- typeLinks={{
2073
- ErrorCode: '/reference/graphql-api/shop/enums#errorcode',
2074
- String: '/reference/graphql-api/shop/object-types#string',
2075
- }}
2076
- >
2077
- {`"""Returned when a Payment fails due to an error."""
2078
- type PaymentFailedError {
2079
- errorCode: ErrorCode!
2080
- message: String!
2081
- paymentErrorMessage: String!
2082
- }`}
2083
- </GraphQLDoc>
2084
-
2085
- ## PaymentMethod {#paymentmethod}
2086
-
2087
- <GraphQLDoc
2088
- type="type"
2089
- typeName="PaymentMethod"
2090
- typeLinks={{
2091
- ID: '/reference/graphql-api/shop/object-types#id',
2092
- DateTime: '/reference/graphql-api/shop/object-types#datetime',
2093
- String: '/reference/graphql-api/shop/object-types#string',
2094
- Boolean: '/reference/graphql-api/shop/object-types#boolean',
2095
- ConfigurableOperation: '/reference/graphql-api/shop/object-types#configurableoperation',
2096
- PaymentMethodTranslation: '/reference/graphql-api/shop/object-types#paymentmethodtranslation',
2097
- JSON: '/reference/graphql-api/shop/object-types#json',
2098
- }}
2099
- >
2100
- {`type PaymentMethod {
2101
- id: ID!
2102
- createdAt: DateTime!
2103
- updatedAt: DateTime!
2104
- name: String!
2105
- code: String!
2106
- description: String!
2107
- enabled: Boolean!
2108
- checker: ConfigurableOperation
2109
- handler: ConfigurableOperation!
2110
- translations: [PaymentMethodTranslation!]!
2111
- customFields: JSON
2112
- }`}
2113
- </GraphQLDoc>
2114
-
2115
- ## PaymentMethodQuote {#paymentmethodquote}
2116
-
2117
- <GraphQLDoc
2118
- type="type"
2119
- typeName="PaymentMethodQuote"
2120
- typeLinks={{
2121
- ID: '/reference/graphql-api/shop/object-types#id',
2122
- String: '/reference/graphql-api/shop/object-types#string',
2123
- Boolean: '/reference/graphql-api/shop/object-types#boolean',
2124
- JSON: '/reference/graphql-api/shop/object-types#json',
2125
- }}
2126
- >
2127
- {`type PaymentMethodQuote {
2128
- id: ID!
2129
- code: String!
2130
- name: String!
2131
- description: String!
2132
- isEligible: Boolean!
2133
- eligibilityMessage: String
2134
- customFields: JSON
2135
- }`}
2136
- </GraphQLDoc>
2137
-
2138
- ## PaymentMethodTranslation {#paymentmethodtranslation}
2139
-
2140
- <GraphQLDoc
2141
- type="type"
2142
- typeName="PaymentMethodTranslation"
2143
- typeLinks={{
2144
- ID: '/reference/graphql-api/shop/object-types#id',
2145
- DateTime: '/reference/graphql-api/shop/object-types#datetime',
2146
- LanguageCode: '/reference/graphql-api/shop/enums#languagecode',
2147
- String: '/reference/graphql-api/shop/object-types#string',
2148
- }}
2149
- >
2150
- {`type PaymentMethodTranslation {
2151
- id: ID!
2152
- createdAt: DateTime!
2153
- updatedAt: DateTime!
2154
- languageCode: LanguageCode!
2155
- name: String!
2156
- description: String!
2157
- }`}
2158
- </GraphQLDoc>
2159
-
2160
- ## PriceRange {#pricerange}
2161
-
2162
- <GraphQLDoc
2163
- type="type"
2164
- typeName="PriceRange"
2165
- typeLinks={{
2166
- Money: '/reference/graphql-api/shop/object-types#money',
2167
- }}
2168
- >
2169
- {`"""The price range where the result has more than one price"""
2170
- type PriceRange {
2171
- min: Money!
2172
- max: Money!
2173
- }`}
2174
- </GraphQLDoc>
2175
-
2176
- ## Product {#product}
2177
-
2178
- <GraphQLDoc
2179
- type="type"
2180
- typeName="Product"
2181
- typeLinks={{
2182
- ID: '/reference/graphql-api/shop/object-types#id',
2183
- DateTime: '/reference/graphql-api/shop/object-types#datetime',
2184
- LanguageCode: '/reference/graphql-api/shop/enums#languagecode',
2185
- String: '/reference/graphql-api/shop/object-types#string',
2186
- Boolean: '/reference/graphql-api/shop/object-types#boolean',
2187
- Asset: '/reference/graphql-api/shop/object-types#asset',
2188
- ProductVariant: '/reference/graphql-api/shop/object-types#productvariant',
2189
- ProductVariantList: '/reference/graphql-api/shop/object-types#productvariantlist',
2190
- ProductVariantListOptions: '/reference/graphql-api/shop/input-types#productvariantlistoptions',
2191
- ProductOptionGroup: '/reference/graphql-api/shop/object-types#productoptiongroup',
2192
- FacetValue: '/reference/graphql-api/shop/object-types#facetvalue',
2193
- ProductTranslation: '/reference/graphql-api/shop/object-types#producttranslation',
2194
- Collection: '/reference/graphql-api/shop/object-types#collection',
2195
- JSON: '/reference/graphql-api/shop/object-types#json',
2196
- }}
2197
- >
2198
- {`type Product {
2199
- id: ID!
2200
- createdAt: DateTime!
2201
- updatedAt: DateTime!
2202
- languageCode: LanguageCode!
2203
- name: String!
2204
- slug: String!
2205
- description: String!
2206
- enabled: Boolean!
2207
- featuredAsset: Asset
2208
- assets: [Asset!]!
2209
- """Returns all ProductVariants"""
2210
- variants: [ProductVariant!]!
2211
- """Returns a paginated, sortable, filterable list of ProductVariants"""
2212
- variantList(options: ProductVariantListOptions): ProductVariantList!
2213
- optionGroups: [ProductOptionGroup!]!
2214
- facetValues: [FacetValue!]!
2215
- translations: [ProductTranslation!]!
2216
- collections: [Collection!]!
2217
- customFields: JSON
2218
- }`}
2219
- </GraphQLDoc>
2220
-
2221
- ## ProductList {#productlist}
2222
-
2223
- <GraphQLDoc
2224
- type="type"
2225
- typeName="ProductList"
2226
- typeLinks={{
2227
- Product: '/reference/graphql-api/shop/object-types#product',
2228
- Int: '/reference/graphql-api/shop/object-types#int',
2229
- }}
2230
- >
2231
- {`type ProductList {
2232
- items: [Product!]!
2233
- totalItems: Int!
2234
- }`}
2235
- </GraphQLDoc>
2236
-
2237
- ## ProductOption {#productoption}
2238
-
2239
- <GraphQLDoc
2240
- type="type"
2241
- typeName="ProductOption"
2242
- typeLinks={{
2243
- ID: '/reference/graphql-api/shop/object-types#id',
2244
- DateTime: '/reference/graphql-api/shop/object-types#datetime',
2245
- LanguageCode: '/reference/graphql-api/shop/enums#languagecode',
2246
- String: '/reference/graphql-api/shop/object-types#string',
2247
- ProductOptionGroup: '/reference/graphql-api/shop/object-types#productoptiongroup',
2248
- ProductOptionTranslation: '/reference/graphql-api/shop/object-types#productoptiontranslation',
2249
- JSON: '/reference/graphql-api/shop/object-types#json',
2250
- }}
2251
- >
2252
- {`type ProductOption {
2253
- id: ID!
2254
- createdAt: DateTime!
2255
- updatedAt: DateTime!
2256
- languageCode: LanguageCode!
2257
- code: String!
2258
- name: String!
2259
- groupId: ID!
2260
- group: ProductOptionGroup!
2261
- translations: [ProductOptionTranslation!]!
2262
- customFields: JSON
2263
- }`}
2264
- </GraphQLDoc>
2265
-
2266
- ## ProductOptionGroup {#productoptiongroup}
2267
-
2268
- <GraphQLDoc
2269
- type="type"
2270
- typeName="ProductOptionGroup"
2271
- typeLinks={{
2272
- ID: '/reference/graphql-api/shop/object-types#id',
2273
- DateTime: '/reference/graphql-api/shop/object-types#datetime',
2274
- LanguageCode: '/reference/graphql-api/shop/enums#languagecode',
2275
- String: '/reference/graphql-api/shop/object-types#string',
2276
- ProductOption: '/reference/graphql-api/shop/object-types#productoption',
2277
- ProductOptionGroupTranslation: '/reference/graphql-api/shop/object-types#productoptiongrouptranslation',
2278
- JSON: '/reference/graphql-api/shop/object-types#json',
2279
- }}
2280
- >
2281
- {`type ProductOptionGroup {
2282
- id: ID!
2283
- createdAt: DateTime!
2284
- updatedAt: DateTime!
2285
- languageCode: LanguageCode!
2286
- code: String!
2287
- name: String!
2288
- options: [ProductOption!]!
2289
- translations: [ProductOptionGroupTranslation!]!
2290
- customFields: JSON
2291
- }`}
2292
- </GraphQLDoc>
2293
-
2294
- ## ProductOptionGroupTranslation {#productoptiongrouptranslation}
2295
-
2296
- <GraphQLDoc
2297
- type="type"
2298
- typeName="ProductOptionGroupTranslation"
2299
- typeLinks={{
2300
- ID: '/reference/graphql-api/shop/object-types#id',
2301
- DateTime: '/reference/graphql-api/shop/object-types#datetime',
2302
- LanguageCode: '/reference/graphql-api/shop/enums#languagecode',
2303
- String: '/reference/graphql-api/shop/object-types#string',
2304
- }}
2305
- >
2306
- {`type ProductOptionGroupTranslation {
2307
- id: ID!
2308
- createdAt: DateTime!
2309
- updatedAt: DateTime!
2310
- languageCode: LanguageCode!
2311
- name: String!
2312
- }`}
2313
- </GraphQLDoc>
2314
-
2315
- ## ProductOptionTranslation {#productoptiontranslation}
2316
-
2317
- <GraphQLDoc
2318
- type="type"
2319
- typeName="ProductOptionTranslation"
2320
- typeLinks={{
2321
- ID: '/reference/graphql-api/shop/object-types#id',
2322
- DateTime: '/reference/graphql-api/shop/object-types#datetime',
2323
- LanguageCode: '/reference/graphql-api/shop/enums#languagecode',
2324
- String: '/reference/graphql-api/shop/object-types#string',
2325
- }}
2326
- >
2327
- {`type ProductOptionTranslation {
2328
- id: ID!
2329
- createdAt: DateTime!
2330
- updatedAt: DateTime!
2331
- languageCode: LanguageCode!
2332
- name: String!
2333
- }`}
2334
- </GraphQLDoc>
2335
-
2336
- ## ProductTranslation {#producttranslation}
2337
-
2338
- <GraphQLDoc
2339
- type="type"
2340
- typeName="ProductTranslation"
2341
- typeLinks={{
2342
- ID: '/reference/graphql-api/shop/object-types#id',
2343
- DateTime: '/reference/graphql-api/shop/object-types#datetime',
2344
- LanguageCode: '/reference/graphql-api/shop/enums#languagecode',
2345
- String: '/reference/graphql-api/shop/object-types#string',
2346
- }}
2347
- >
2348
- {`type ProductTranslation {
2349
- id: ID!
2350
- createdAt: DateTime!
2351
- updatedAt: DateTime!
2352
- languageCode: LanguageCode!
2353
- name: String!
2354
- slug: String!
2355
- description: String!
2356
- }`}
2357
- </GraphQLDoc>
2358
-
2359
- ## ProductVariant {#productvariant}
2360
-
2361
- <GraphQLDoc
2362
- type="type"
2363
- typeName="ProductVariant"
2364
- typeLinks={{
2365
- ID: '/reference/graphql-api/shop/object-types#id',
2366
- Product: '/reference/graphql-api/shop/object-types#product',
2367
- DateTime: '/reference/graphql-api/shop/object-types#datetime',
2368
- LanguageCode: '/reference/graphql-api/shop/enums#languagecode',
2369
- String: '/reference/graphql-api/shop/object-types#string',
2370
- Asset: '/reference/graphql-api/shop/object-types#asset',
2371
- Money: '/reference/graphql-api/shop/object-types#money',
2372
- CurrencyCode: '/reference/graphql-api/shop/enums#currencycode',
2373
- TaxRate: '/reference/graphql-api/shop/object-types#taxrate',
2374
- TaxCategory: '/reference/graphql-api/shop/object-types#taxcategory',
2375
- ProductOption: '/reference/graphql-api/shop/object-types#productoption',
2376
- FacetValue: '/reference/graphql-api/shop/object-types#facetvalue',
2377
- ProductVariantTranslation: '/reference/graphql-api/shop/object-types#productvarianttranslation',
2378
- JSON: '/reference/graphql-api/shop/object-types#json',
2379
- }}
2380
- >
2381
- {`type ProductVariant {
2382
- id: ID!
2383
- product: Product!
2384
- productId: ID!
2385
- createdAt: DateTime!
2386
- updatedAt: DateTime!
2387
- languageCode: LanguageCode!
2388
- sku: String!
2389
- name: String!
2390
- featuredAsset: Asset
2391
- assets: [Asset!]!
2392
- price: Money!
2393
- currencyCode: CurrencyCode!
2394
- priceWithTax: Money!
2395
- stockLevel: String!
2396
- taxRateApplied: TaxRate!
2397
- taxCategory: TaxCategory!
2398
- options: [ProductOption!]!
2399
- facetValues: [FacetValue!]!
2400
- translations: [ProductVariantTranslation!]!
2401
- customFields: JSON
2402
- }`}
2403
- </GraphQLDoc>
2404
-
2405
- ## ProductVariantList {#productvariantlist}
2406
-
2407
- <GraphQLDoc
2408
- type="type"
2409
- typeName="ProductVariantList"
2410
- typeLinks={{
2411
- ProductVariant: '/reference/graphql-api/shop/object-types#productvariant',
2412
- Int: '/reference/graphql-api/shop/object-types#int',
2413
- }}
2414
- >
2415
- {`type ProductVariantList {
2416
- items: [ProductVariant!]!
2417
- totalItems: Int!
2418
- }`}
2419
- </GraphQLDoc>
2420
-
2421
- ## ProductVariantTranslation {#productvarianttranslation}
2422
-
2423
- <GraphQLDoc
2424
- type="type"
2425
- typeName="ProductVariantTranslation"
2426
- typeLinks={{
2427
- ID: '/reference/graphql-api/shop/object-types#id',
2428
- DateTime: '/reference/graphql-api/shop/object-types#datetime',
2429
- LanguageCode: '/reference/graphql-api/shop/enums#languagecode',
2430
- String: '/reference/graphql-api/shop/object-types#string',
2431
- }}
2432
- >
2433
- {`type ProductVariantTranslation {
2434
- id: ID!
2435
- createdAt: DateTime!
2436
- updatedAt: DateTime!
2437
- languageCode: LanguageCode!
2438
- name: String!
2439
- }`}
2440
- </GraphQLDoc>
2441
-
2442
- ## Promotion {#promotion}
2443
-
2444
- <GraphQLDoc
2445
- type="type"
2446
- typeName="Promotion"
2447
- typeLinks={{
2448
- ID: '/reference/graphql-api/shop/object-types#id',
2449
- DateTime: '/reference/graphql-api/shop/object-types#datetime',
2450
- String: '/reference/graphql-api/shop/object-types#string',
2451
- Int: '/reference/graphql-api/shop/object-types#int',
2452
- Boolean: '/reference/graphql-api/shop/object-types#boolean',
2453
- ConfigurableOperation: '/reference/graphql-api/shop/object-types#configurableoperation',
2454
- PromotionTranslation: '/reference/graphql-api/shop/object-types#promotiontranslation',
2455
- JSON: '/reference/graphql-api/shop/object-types#json',
2456
- }}
2457
- >
2458
- {`type Promotion {
2459
- id: ID!
2460
- createdAt: DateTime!
2461
- updatedAt: DateTime!
2462
- startsAt: DateTime
2463
- endsAt: DateTime
2464
- couponCode: String
2465
- perCustomerUsageLimit: Int
2466
- usageLimit: Int
2467
- name: String!
2468
- description: String!
2469
- enabled: Boolean!
2470
- conditions: [ConfigurableOperation!]!
2471
- actions: [ConfigurableOperation!]!
2472
- translations: [PromotionTranslation!]!
2473
- customFields: JSON
2474
- }`}
2475
- </GraphQLDoc>
2476
-
2477
- ## PromotionList {#promotionlist}
2478
-
2479
- <GraphQLDoc
2480
- type="type"
2481
- typeName="PromotionList"
2482
- typeLinks={{
2483
- Promotion: '/reference/graphql-api/shop/object-types#promotion',
2484
- Int: '/reference/graphql-api/shop/object-types#int',
2485
- }}
2486
- >
2487
- {`type PromotionList {
2488
- items: [Promotion!]!
2489
- totalItems: Int!
2490
- }`}
2491
- </GraphQLDoc>
2492
-
2493
- ## PromotionTranslation {#promotiontranslation}
2494
-
2495
- <GraphQLDoc
2496
- type="type"
2497
- typeName="PromotionTranslation"
2498
- typeLinks={{
2499
- ID: '/reference/graphql-api/shop/object-types#id',
2500
- DateTime: '/reference/graphql-api/shop/object-types#datetime',
2501
- LanguageCode: '/reference/graphql-api/shop/enums#languagecode',
2502
- String: '/reference/graphql-api/shop/object-types#string',
2503
- }}
2504
- >
2505
- {`type PromotionTranslation {
2506
- id: ID!
2507
- createdAt: DateTime!
2508
- updatedAt: DateTime!
2509
- languageCode: LanguageCode!
2510
- name: String!
2511
- description: String!
2512
- }`}
2513
- </GraphQLDoc>
2514
-
2515
- ## Province {#province}
2516
-
2517
- <GraphQLDoc
2518
- type="type"
2519
- typeName="Province"
2520
- typeLinks={{
2521
- ID: '/reference/graphql-api/shop/object-types#id',
2522
- DateTime: '/reference/graphql-api/shop/object-types#datetime',
2523
- LanguageCode: '/reference/graphql-api/shop/enums#languagecode',
2524
- String: '/reference/graphql-api/shop/object-types#string',
2525
- Boolean: '/reference/graphql-api/shop/object-types#boolean',
2526
- Region: '/reference/graphql-api/shop/object-types#region',
2527
- RegionTranslation: '/reference/graphql-api/shop/object-types#regiontranslation',
2528
- JSON: '/reference/graphql-api/shop/object-types#json',
2529
- }}
2530
- >
2531
- {`type Province {
2532
- id: ID!
2533
- createdAt: DateTime!
2534
- updatedAt: DateTime!
2535
- languageCode: LanguageCode!
2536
- code: String!
2537
- type: String!
2538
- name: String!
2539
- enabled: Boolean!
2540
- parent: Region
2541
- parentId: ID
2542
- translations: [RegionTranslation!]!
2543
- customFields: JSON
2544
- }`}
2545
- </GraphQLDoc>
2546
-
2547
- ## ProvinceList {#provincelist}
2548
-
2549
- <GraphQLDoc
2550
- type="type"
2551
- typeName="ProvinceList"
2552
- typeLinks={{
2553
- Province: '/reference/graphql-api/shop/object-types#province',
2554
- Int: '/reference/graphql-api/shop/object-types#int',
2555
- }}
2556
- >
2557
- {`type ProvinceList {
2558
- items: [Province!]!
2559
- totalItems: Int!
2560
- }`}
2561
- </GraphQLDoc>
2562
-
2563
- ## PublicPaymentMethod {#publicpaymentmethod}
2564
-
2565
- <GraphQLDoc
2566
- type="type"
2567
- typeName="PublicPaymentMethod"
2568
- typeLinks={{
2569
- ID: '/reference/graphql-api/shop/object-types#id',
2570
- String: '/reference/graphql-api/shop/object-types#string',
2571
- PaymentMethodTranslation: '/reference/graphql-api/shop/object-types#paymentmethodtranslation',
2572
- JSON: '/reference/graphql-api/shop/object-types#json',
2573
- }}
2574
- >
2575
- {`type PublicPaymentMethod {
2576
- id: ID!
2577
- code: String!
2578
- name: String!
2579
- description: String
2580
- translations: [PaymentMethodTranslation!]!
2581
- customFields: JSON
2582
- }`}
2583
- </GraphQLDoc>
2584
-
2585
- ## PublicShippingMethod {#publicshippingmethod}
2586
-
2587
- <GraphQLDoc
2588
- type="type"
2589
- typeName="PublicShippingMethod"
2590
- typeLinks={{
2591
- ID: '/reference/graphql-api/shop/object-types#id',
2592
- String: '/reference/graphql-api/shop/object-types#string',
2593
- ShippingMethodTranslation: '/reference/graphql-api/shop/object-types#shippingmethodtranslation',
2594
- JSON: '/reference/graphql-api/shop/object-types#json',
2595
- }}
2596
- >
2597
- {`type PublicShippingMethod {
2598
- id: ID!
2599
- code: String!
2600
- name: String!
2601
- description: String
2602
- translations: [ShippingMethodTranslation!]!
2603
- customFields: JSON
2604
- }`}
2605
- </GraphQLDoc>
2606
-
2607
- ## RefreshCustomerVerificationResult {#refreshcustomerverificationresult}
2608
-
2609
- <GraphQLDoc
2610
- type="union"
2611
- typeName="RefreshCustomerVerificationResult"
2612
- typeLinks={{
2613
- Success: '/reference/graphql-api/shop/object-types#success',
2614
- NativeAuthStrategyError: '/reference/graphql-api/shop/object-types#nativeauthstrategyerror',
2615
- }}
2616
- >
2617
- {`union RefreshCustomerVerificationResult = Success | NativeAuthStrategyError`}
2618
- </GraphQLDoc>
2619
-
2620
- ## Refund {#refund}
2621
-
2622
- <GraphQLDoc
2623
- type="type"
2624
- typeName="Refund"
2625
- typeLinks={{
2626
- ID: '/reference/graphql-api/shop/object-types#id',
2627
- DateTime: '/reference/graphql-api/shop/object-types#datetime',
2628
- Money: '/reference/graphql-api/shop/object-types#money',
2629
- String: '/reference/graphql-api/shop/object-types#string',
2630
- RefundLine: '/reference/graphql-api/shop/object-types#refundline',
2631
- JSON: '/reference/graphql-api/shop/object-types#json',
2632
- }}
2633
- >
2634
- {`type Refund {
2635
- id: ID!
2636
- createdAt: DateTime!
2637
- updatedAt: DateTime!
2638
- items: Money!
2639
- shipping: Money!
2640
- adjustment: Money!
2641
- total: Money!
2642
- method: String
2643
- state: String!
2644
- transactionId: String
2645
- reason: String
2646
- lines: [RefundLine!]!
2647
- paymentId: ID!
2648
- metadata: JSON
2649
- customFields: JSON
2650
- }`}
2651
- </GraphQLDoc>
2652
-
2653
- ## RefundLine {#refundline}
2654
-
2655
- <GraphQLDoc
2656
- type="type"
2657
- typeName="RefundLine"
2658
- typeLinks={{
2659
- OrderLine: '/reference/graphql-api/shop/object-types#orderline',
2660
- ID: '/reference/graphql-api/shop/object-types#id',
2661
- Int: '/reference/graphql-api/shop/object-types#int',
2662
- Refund: '/reference/graphql-api/shop/object-types#refund',
2663
- }}
2664
- >
2665
- {`type RefundLine {
2666
- orderLine: OrderLine!
2667
- orderLineId: ID!
2668
- quantity: Int!
2669
- refund: Refund!
2670
- refundId: ID!
2671
- }`}
2672
- </GraphQLDoc>
2673
-
2674
- ## RegionTranslation {#regiontranslation}
2675
-
2676
- <GraphQLDoc
2677
- type="type"
2678
- typeName="RegionTranslation"
2679
- typeLinks={{
2680
- ID: '/reference/graphql-api/shop/object-types#id',
2681
- DateTime: '/reference/graphql-api/shop/object-types#datetime',
2682
- LanguageCode: '/reference/graphql-api/shop/enums#languagecode',
2683
- String: '/reference/graphql-api/shop/object-types#string',
2684
- }}
2685
- >
2686
- {`type RegionTranslation {
2687
- id: ID!
2688
- createdAt: DateTime!
2689
- updatedAt: DateTime!
2690
- languageCode: LanguageCode!
2691
- name: String!
2692
- }`}
2693
- </GraphQLDoc>
2694
-
2695
- ## RegisterCustomerAccountResult {#registercustomeraccountresult}
2696
-
2697
- <GraphQLDoc
2698
- type="union"
2699
- typeName="RegisterCustomerAccountResult"
2700
- typeLinks={{
2701
- Success: '/reference/graphql-api/shop/object-types#success',
2702
- MissingPasswordError: '/reference/graphql-api/shop/object-types#missingpassworderror',
2703
- PasswordValidationError: '/reference/graphql-api/shop/object-types#passwordvalidationerror',
2704
- NativeAuthStrategyError: '/reference/graphql-api/shop/object-types#nativeauthstrategyerror',
2705
- }}
2706
- >
2707
- {`union RegisterCustomerAccountResult = Success | MissingPasswordError | PasswordValidationError | NativeAuthStrategyError`}
2708
- </GraphQLDoc>
2709
-
2710
- ## RelationCustomFieldConfig {#relationcustomfieldconfig}
2711
-
2712
- <GraphQLDoc
2713
- type="type"
2714
- typeName="RelationCustomFieldConfig"
2715
- typeLinks={{
2716
- String: '/reference/graphql-api/shop/object-types#string',
2717
- Boolean: '/reference/graphql-api/shop/object-types#boolean',
2718
- LocalizedString: '/reference/graphql-api/shop/object-types#localizedstring',
2719
- Permission: '/reference/graphql-api/shop/enums#permission',
2720
- JSON: '/reference/graphql-api/shop/object-types#json',
2721
- }}
2722
- >
2723
- {`type RelationCustomFieldConfig {
2724
- name: String!
2725
- type: String!
2726
- list: Boolean!
2727
- label: [LocalizedString!]
2728
- description: [LocalizedString!]
2729
- readonly: Boolean
2730
- internal: Boolean
2731
- nullable: Boolean
2732
- requiresPermission: [Permission!]
2733
- deprecated: Boolean
2734
- deprecationReason: String
2735
- entity: String!
2736
- scalarFields: [String!]!
2737
- ui: JSON
2738
- }`}
2739
- </GraphQLDoc>
2740
-
2741
- ## RemoveOrderItemsResult {#removeorderitemsresult}
2742
-
2743
- <GraphQLDoc
2744
- type="union"
2745
- typeName="RemoveOrderItemsResult"
2746
- typeLinks={{
2747
- Order: '/reference/graphql-api/shop/object-types#order',
2748
- OrderModificationError: '/reference/graphql-api/shop/object-types#ordermodificationerror',
2749
- OrderInterceptorError: '/reference/graphql-api/shop/object-types#orderinterceptorerror',
2750
- }}
2751
- >
2752
- {`union RemoveOrderItemsResult = Order | OrderModificationError | OrderInterceptorError`}
2753
- </GraphQLDoc>
2754
-
2755
- ## RequestPasswordResetResult {#requestpasswordresetresult}
2756
-
2757
- <GraphQLDoc
2758
- type="union"
2759
- typeName="RequestPasswordResetResult"
2760
- typeLinks={{
2761
- Success: '/reference/graphql-api/shop/object-types#success',
2762
- NativeAuthStrategyError: '/reference/graphql-api/shop/object-types#nativeauthstrategyerror',
2763
- }}
2764
- >
2765
- {`union RequestPasswordResetResult = Success | NativeAuthStrategyError`}
2766
- </GraphQLDoc>
2767
-
2768
- ## RequestUpdateCustomerEmailAddressResult {#requestupdatecustomeremailaddressresult}
2769
-
2770
- <GraphQLDoc
2771
- type="union"
2772
- typeName="RequestUpdateCustomerEmailAddressResult"
2773
- typeLinks={{
2774
- Success: '/reference/graphql-api/shop/object-types#success',
2775
- InvalidCredentialsError: '/reference/graphql-api/shop/object-types#invalidcredentialserror',
2776
- EmailAddressConflictError: '/reference/graphql-api/shop/object-types#emailaddressconflicterror',
2777
- NativeAuthStrategyError: '/reference/graphql-api/shop/object-types#nativeauthstrategyerror',
2778
- }}
2779
- >
2780
- {`union RequestUpdateCustomerEmailAddressResult = Success | InvalidCredentialsError | EmailAddressConflictError | NativeAuthStrategyError`}
2781
- </GraphQLDoc>
2782
-
2783
- ## ResetPasswordResult {#resetpasswordresult}
2784
-
2785
- <GraphQLDoc
2786
- type="union"
2787
- typeName="ResetPasswordResult"
2788
- typeLinks={{
2789
- CurrentUser: '/reference/graphql-api/shop/object-types#currentuser',
2790
- PasswordResetTokenInvalidError: '/reference/graphql-api/shop/object-types#passwordresettokeninvaliderror',
2791
- PasswordResetTokenExpiredError: '/reference/graphql-api/shop/object-types#passwordresettokenexpirederror',
2792
- PasswordValidationError: '/reference/graphql-api/shop/object-types#passwordvalidationerror',
2793
- NativeAuthStrategyError: '/reference/graphql-api/shop/object-types#nativeauthstrategyerror',
2794
- NotVerifiedError: '/reference/graphql-api/shop/object-types#notverifiederror',
2795
- }}
2796
- >
2797
- {`union ResetPasswordResult = CurrentUser | PasswordResetTokenInvalidError | PasswordResetTokenExpiredError | PasswordValidationError | NativeAuthStrategyError | NotVerifiedError`}
2798
- </GraphQLDoc>
2799
-
2800
- ## Role {#role}
2801
-
2802
- <GraphQLDoc
2803
- type="type"
2804
- typeName="Role"
2805
- typeLinks={{
2806
- ID: '/reference/graphql-api/shop/object-types#id',
2807
- DateTime: '/reference/graphql-api/shop/object-types#datetime',
2808
- String: '/reference/graphql-api/shop/object-types#string',
2809
- Permission: '/reference/graphql-api/shop/enums#permission',
2810
- Channel: '/reference/graphql-api/shop/object-types#channel',
2811
- }}
2812
- >
2813
- {`type Role {
2814
- id: ID!
2815
- createdAt: DateTime!
2816
- updatedAt: DateTime!
2817
- code: String!
2818
- description: String!
2819
- permissions: [Permission!]!
2820
- channels: [Channel!]!
2821
- }`}
2822
- </GraphQLDoc>
2823
-
2824
- ## RoleList {#rolelist}
2825
-
2826
- <GraphQLDoc
2827
- type="type"
2828
- typeName="RoleList"
2829
- typeLinks={{
2830
- Role: '/reference/graphql-api/shop/object-types#role',
2831
- Int: '/reference/graphql-api/shop/object-types#int',
2832
- }}
2833
- >
2834
- {`type RoleList {
2835
- items: [Role!]!
2836
- totalItems: Int!
2837
- }`}
2838
- </GraphQLDoc>
2839
-
2840
- ## SearchReindexResponse {#searchreindexresponse}
2841
-
2842
- <GraphQLDoc
2843
- type="type"
2844
- typeName="SearchReindexResponse"
2845
- typeLinks={{
2846
- Boolean: '/reference/graphql-api/shop/object-types#boolean',
2847
- }}
2848
- >
2849
- {`type SearchReindexResponse {
2850
- success: Boolean!
2851
- }`}
2852
- </GraphQLDoc>
2853
-
2854
- ## SearchResponse {#searchresponse}
2855
-
2856
- <GraphQLDoc
2857
- type="type"
2858
- typeName="SearchResponse"
2859
- typeLinks={{
2860
- SearchResult: '/reference/graphql-api/shop/object-types#searchresult',
2861
- Int: '/reference/graphql-api/shop/object-types#int',
2862
- FacetValueResult: '/reference/graphql-api/shop/object-types#facetvalueresult',
2863
- CollectionResult: '/reference/graphql-api/shop/object-types#collectionresult',
2864
- }}
2865
- >
2866
- {`type SearchResponse {
2867
- items: [SearchResult!]!
2868
- totalItems: Int!
2869
- facetValues: [FacetValueResult!]!
2870
- collections: [CollectionResult!]!
2871
- }`}
2872
- </GraphQLDoc>
2873
-
2874
- ## SearchResult {#searchresult}
2875
-
2876
- <GraphQLDoc
2877
- type="type"
2878
- typeName="SearchResult"
2879
- typeLinks={{
2880
- String: '/reference/graphql-api/shop/object-types#string',
2881
- ID: '/reference/graphql-api/shop/object-types#id',
2882
- SearchResultAsset: '/reference/graphql-api/shop/object-types#searchresultasset',
2883
- SearchResultPrice: '/reference/graphql-api/shop/object-types#searchresultprice',
2884
- CurrencyCode: '/reference/graphql-api/shop/enums#currencycode',
2885
- Float: '/reference/graphql-api/shop/object-types#float',
2886
- }}
2887
- >
2888
- {`type SearchResult {
2889
- sku: String!
2890
- slug: String!
2891
- productId: ID!
2892
- productName: String!
2893
- productAsset: SearchResultAsset
2894
- productVariantId: ID!
2895
- productVariantName: String!
2896
- productVariantAsset: SearchResultAsset
2897
- price: SearchResultPrice!
2898
- priceWithTax: SearchResultPrice!
2899
- currencyCode: CurrencyCode!
2900
- description: String!
2901
- facetIds: [ID!]!
2902
- facetValueIds: [ID!]!
2903
- """An array of ids of the Collections in which this result appears"""
2904
- collectionIds: [ID!]!
2905
- """A relevance score for the result. Differs between database implementations"""
2906
- score: Float!
2907
- }`}
2908
- </GraphQLDoc>
2909
-
2910
- ## SearchResultAsset {#searchresultasset}
2911
-
2912
- <GraphQLDoc
2913
- type="type"
2914
- typeName="SearchResultAsset"
2915
- typeLinks={{
2916
- ID: '/reference/graphql-api/shop/object-types#id',
2917
- String: '/reference/graphql-api/shop/object-types#string',
2918
- Coordinate: '/reference/graphql-api/shop/object-types#coordinate',
2919
- }}
2920
- >
2921
- {`type SearchResultAsset {
2922
- id: ID!
2923
- preview: String!
2924
- focalPoint: Coordinate
2925
- }`}
2926
- </GraphQLDoc>
2927
-
2928
- ## SearchResultPrice {#searchresultprice}
2929
-
2930
- <GraphQLDoc
2931
- type="union"
2932
- typeName="SearchResultPrice"
2933
- typeLinks={{
2934
- PriceRange: '/reference/graphql-api/shop/object-types#pricerange',
2935
- SinglePrice: '/reference/graphql-api/shop/object-types#singleprice',
2936
- }}
2937
- >
2938
- {`"""The price of a search result product, either as a range or as a single price"""
2939
- union SearchResultPrice = PriceRange | SinglePrice`}
2940
- </GraphQLDoc>
2941
-
2942
- ## Seller {#seller}
2943
-
2944
- <GraphQLDoc
2945
- type="type"
2946
- typeName="Seller"
2947
- typeLinks={{
2948
- ID: '/reference/graphql-api/shop/object-types#id',
2949
- DateTime: '/reference/graphql-api/shop/object-types#datetime',
2950
- String: '/reference/graphql-api/shop/object-types#string',
2951
- JSON: '/reference/graphql-api/shop/object-types#json',
2952
- }}
2953
- >
2954
- {`type Seller {
2955
- id: ID!
2956
- createdAt: DateTime!
2957
- updatedAt: DateTime!
2958
- name: String!
2959
- customFields: JSON
2960
- }`}
2961
- </GraphQLDoc>
2962
-
2963
- ## SetCustomerForOrderResult {#setcustomerfororderresult}
2964
-
2965
- <GraphQLDoc
2966
- type="union"
2967
- typeName="SetCustomerForOrderResult"
2968
- typeLinks={{
2969
- Order: '/reference/graphql-api/shop/object-types#order',
2970
- AlreadyLoggedInError: '/reference/graphql-api/shop/object-types#alreadyloggedinerror',
2971
- EmailAddressConflictError: '/reference/graphql-api/shop/object-types#emailaddressconflicterror',
2972
- NoActiveOrderError: '/reference/graphql-api/shop/object-types#noactiveordererror',
2973
- GuestCheckoutError: '/reference/graphql-api/shop/object-types#guestcheckouterror',
2974
- }}
2975
- >
2976
- {`union SetCustomerForOrderResult = Order | AlreadyLoggedInError | EmailAddressConflictError | NoActiveOrderError | GuestCheckoutError`}
2977
- </GraphQLDoc>
2978
-
2979
- ## SetOrderShippingMethodResult {#setordershippingmethodresult}
2980
-
2981
- <GraphQLDoc
2982
- type="union"
2983
- typeName="SetOrderShippingMethodResult"
2984
- typeLinks={{
2985
- Order: '/reference/graphql-api/shop/object-types#order',
2986
- OrderModificationError: '/reference/graphql-api/shop/object-types#ordermodificationerror',
2987
- IneligibleShippingMethodError: '/reference/graphql-api/shop/object-types#ineligibleshippingmethoderror',
2988
- NoActiveOrderError: '/reference/graphql-api/shop/object-types#noactiveordererror',
2989
- }}
2990
- >
2991
- {`union SetOrderShippingMethodResult = Order | OrderModificationError | IneligibleShippingMethodError | NoActiveOrderError`}
2992
- </GraphQLDoc>
2993
-
2994
- ## ShippingLine {#shippingline}
2995
-
2996
- <GraphQLDoc
2997
- type="type"
2998
- typeName="ShippingLine"
2999
- typeLinks={{
3000
- ID: '/reference/graphql-api/shop/object-types#id',
3001
- ShippingMethod: '/reference/graphql-api/shop/object-types#shippingmethod',
3002
- Money: '/reference/graphql-api/shop/object-types#money',
3003
- Discount: '/reference/graphql-api/shop/object-types#discount',
3004
- JSON: '/reference/graphql-api/shop/object-types#json',
3005
- }}
3006
- >
3007
- {`type ShippingLine {
3008
- id: ID!
3009
- shippingMethod: ShippingMethod!
3010
- price: Money!
3011
- priceWithTax: Money!
3012
- discountedPrice: Money!
3013
- discountedPriceWithTax: Money!
3014
- discounts: [Discount!]!
3015
- customFields: JSON
3016
- }`}
3017
- </GraphQLDoc>
3018
-
3019
- ## ShippingMethod {#shippingmethod}
3020
-
3021
- <GraphQLDoc
3022
- type="type"
3023
- typeName="ShippingMethod"
3024
- typeLinks={{
3025
- ID: '/reference/graphql-api/shop/object-types#id',
3026
- DateTime: '/reference/graphql-api/shop/object-types#datetime',
3027
- LanguageCode: '/reference/graphql-api/shop/enums#languagecode',
3028
- String: '/reference/graphql-api/shop/object-types#string',
3029
- ConfigurableOperation: '/reference/graphql-api/shop/object-types#configurableoperation',
3030
- ShippingMethodTranslation: '/reference/graphql-api/shop/object-types#shippingmethodtranslation',
3031
- JSON: '/reference/graphql-api/shop/object-types#json',
3032
- }}
3033
- >
3034
- {`type ShippingMethod {
3035
- id: ID!
3036
- createdAt: DateTime!
3037
- updatedAt: DateTime!
3038
- languageCode: LanguageCode!
3039
- code: String!
3040
- name: String!
3041
- description: String!
3042
- fulfillmentHandlerCode: String!
3043
- checker: ConfigurableOperation!
3044
- calculator: ConfigurableOperation!
3045
- translations: [ShippingMethodTranslation!]!
3046
- customFields: JSON
3047
- }`}
3048
- </GraphQLDoc>
3049
-
3050
- ## ShippingMethodList {#shippingmethodlist}
3051
-
3052
- <GraphQLDoc
3053
- type="type"
3054
- typeName="ShippingMethodList"
3055
- typeLinks={{
3056
- ShippingMethod: '/reference/graphql-api/shop/object-types#shippingmethod',
3057
- Int: '/reference/graphql-api/shop/object-types#int',
3058
- }}
3059
- >
3060
- {`type ShippingMethodList {
3061
- items: [ShippingMethod!]!
3062
- totalItems: Int!
3063
- }`}
3064
- </GraphQLDoc>
3065
-
3066
- ## ShippingMethodQuote {#shippingmethodquote}
3067
-
3068
- <GraphQLDoc
3069
- type="type"
3070
- typeName="ShippingMethodQuote"
3071
- typeLinks={{
3072
- ID: '/reference/graphql-api/shop/object-types#id',
3073
- Money: '/reference/graphql-api/shop/object-types#money',
3074
- String: '/reference/graphql-api/shop/object-types#string',
3075
- JSON: '/reference/graphql-api/shop/object-types#json',
3076
- }}
3077
- >
3078
- {`type ShippingMethodQuote {
3079
- id: ID!
3080
- price: Money!
3081
- priceWithTax: Money!
3082
- code: String!
3083
- name: String!
3084
- description: String!
3085
- """Any optional metadata returned by the ShippingCalculator in the ShippingCalculationResult"""
3086
- metadata: JSON
3087
- customFields: JSON
3088
- }`}
3089
- </GraphQLDoc>
3090
-
3091
- ## ShippingMethodTranslation {#shippingmethodtranslation}
3092
-
3093
- <GraphQLDoc
3094
- type="type"
3095
- typeName="ShippingMethodTranslation"
3096
- typeLinks={{
3097
- ID: '/reference/graphql-api/shop/object-types#id',
3098
- DateTime: '/reference/graphql-api/shop/object-types#datetime',
3099
- LanguageCode: '/reference/graphql-api/shop/enums#languagecode',
3100
- String: '/reference/graphql-api/shop/object-types#string',
3101
- }}
3102
- >
3103
- {`type ShippingMethodTranslation {
3104
- id: ID!
3105
- createdAt: DateTime!
3106
- updatedAt: DateTime!
3107
- languageCode: LanguageCode!
3108
- name: String!
3109
- description: String!
3110
- }`}
3111
- </GraphQLDoc>
3112
-
3113
- ## SinglePrice {#singleprice}
3114
-
3115
- <GraphQLDoc
3116
- type="type"
3117
- typeName="SinglePrice"
3118
- typeLinks={{
3119
- Money: '/reference/graphql-api/shop/object-types#money',
3120
- }}
3121
- >
3122
- {`"""The price value where the result has a single price"""
3123
- type SinglePrice {
3124
- value: Money!
3125
- }`}
3126
- </GraphQLDoc>
3127
-
3128
- ## String {#string}
3129
-
3130
- <GraphQLDoc
3131
- type="scalar"
3132
- typeName="String"
3133
- typeLinks={{}}
3134
- >
3135
- {`"""The \`String\` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text."""
3136
- scalar String`}
3137
- </GraphQLDoc>
3138
-
3139
- ## StringCustomFieldConfig {#stringcustomfieldconfig}
3140
-
3141
- <GraphQLDoc
3142
- type="type"
3143
- typeName="StringCustomFieldConfig"
3144
- typeLinks={{
3145
- String: '/reference/graphql-api/shop/object-types#string',
3146
- Boolean: '/reference/graphql-api/shop/object-types#boolean',
3147
- Int: '/reference/graphql-api/shop/object-types#int',
3148
- LocalizedString: '/reference/graphql-api/shop/object-types#localizedstring',
3149
- Permission: '/reference/graphql-api/shop/enums#permission',
3150
- StringFieldOption: '/reference/graphql-api/shop/object-types#stringfieldoption',
3151
- JSON: '/reference/graphql-api/shop/object-types#json',
3152
- }}
3153
- >
3154
- {`type StringCustomFieldConfig {
3155
- name: String!
3156
- type: String!
3157
- list: Boolean!
3158
- length: Int
3159
- label: [LocalizedString!]
3160
- description: [LocalizedString!]
3161
- readonly: Boolean
3162
- internal: Boolean
3163
- nullable: Boolean
3164
- requiresPermission: [Permission!]
3165
- deprecated: Boolean
3166
- deprecationReason: String
3167
- pattern: String
3168
- options: [StringFieldOption!]
3169
- ui: JSON
3170
- }`}
3171
- </GraphQLDoc>
3172
-
3173
- ## StringFieldOption {#stringfieldoption}
3174
-
3175
- <GraphQLDoc
3176
- type="type"
3177
- typeName="StringFieldOption"
3178
- typeLinks={{
3179
- String: '/reference/graphql-api/shop/object-types#string',
3180
- LocalizedString: '/reference/graphql-api/shop/object-types#localizedstring',
3181
- }}
3182
- >
3183
- {`type StringFieldOption {
3184
- value: String!
3185
- label: [LocalizedString!]
3186
- }`}
3187
- </GraphQLDoc>
3188
-
3189
- ## StringStructFieldConfig {#stringstructfieldconfig}
3190
-
3191
- <GraphQLDoc
3192
- type="type"
3193
- typeName="StringStructFieldConfig"
3194
- typeLinks={{
3195
- String: '/reference/graphql-api/shop/object-types#string',
3196
- Boolean: '/reference/graphql-api/shop/object-types#boolean',
3197
- LocalizedString: '/reference/graphql-api/shop/object-types#localizedstring',
3198
- Int: '/reference/graphql-api/shop/object-types#int',
3199
- StringFieldOption: '/reference/graphql-api/shop/object-types#stringfieldoption',
3200
- JSON: '/reference/graphql-api/shop/object-types#json',
3201
- }}
3202
- >
3203
- {`type StringStructFieldConfig {
3204
- name: String!
3205
- type: String!
3206
- list: Boolean!
3207
- label: [LocalizedString!]
3208
- description: [LocalizedString!]
3209
- length: Int
3210
- pattern: String
3211
- options: [StringFieldOption!]
3212
- ui: JSON
3213
- }`}
3214
- </GraphQLDoc>
3215
-
3216
- ## StructCustomFieldConfig {#structcustomfieldconfig}
3217
-
3218
- <GraphQLDoc
3219
- type="type"
3220
- typeName="StructCustomFieldConfig"
3221
- typeLinks={{
3222
- String: '/reference/graphql-api/shop/object-types#string',
3223
- Boolean: '/reference/graphql-api/shop/object-types#boolean',
3224
- StructFieldConfig: '/reference/graphql-api/shop/object-types#structfieldconfig',
3225
- LocalizedString: '/reference/graphql-api/shop/object-types#localizedstring',
3226
- Permission: '/reference/graphql-api/shop/enums#permission',
3227
- JSON: '/reference/graphql-api/shop/object-types#json',
3228
- }}
3229
- >
3230
- {`type StructCustomFieldConfig {
3231
- name: String!
3232
- type: String!
3233
- list: Boolean!
3234
- fields: [StructFieldConfig!]!
3235
- label: [LocalizedString!]
3236
- description: [LocalizedString!]
3237
- readonly: Boolean
3238
- internal: Boolean
3239
- nullable: Boolean
3240
- requiresPermission: [Permission!]
3241
- deprecated: Boolean
3242
- deprecationReason: String
3243
- ui: JSON
3244
- }`}
3245
- </GraphQLDoc>
3246
-
3247
- ## StructFieldConfig {#structfieldconfig}
3248
-
3249
- <GraphQLDoc
3250
- type="union"
3251
- typeName="StructFieldConfig"
3252
- typeLinks={{
3253
- StringStructFieldConfig: '/reference/graphql-api/shop/object-types#stringstructfieldconfig',
3254
- IntStructFieldConfig: '/reference/graphql-api/shop/object-types#intstructfieldconfig',
3255
- FloatStructFieldConfig: '/reference/graphql-api/shop/object-types#floatstructfieldconfig',
3256
- BooleanStructFieldConfig: '/reference/graphql-api/shop/object-types#booleanstructfieldconfig',
3257
- DateTimeStructFieldConfig: '/reference/graphql-api/shop/object-types#datetimestructfieldconfig',
3258
- TextStructFieldConfig: '/reference/graphql-api/shop/object-types#textstructfieldconfig',
3259
- }}
3260
- >
3261
- {`union StructFieldConfig = StringStructFieldConfig | IntStructFieldConfig | FloatStructFieldConfig | BooleanStructFieldConfig | DateTimeStructFieldConfig | TextStructFieldConfig`}
3262
- </GraphQLDoc>
3263
-
3264
- ## Success {#success}
3265
-
3266
- <GraphQLDoc
3267
- type="type"
3268
- typeName="Success"
3269
- typeLinks={{
3270
- Boolean: '/reference/graphql-api/shop/object-types#boolean',
3271
- }}
3272
- >
3273
- {`"""Indicates that an operation succeeded, where we do not want to return any more specific information."""
3274
- type Success {
3275
- success: Boolean!
3276
- }`}
3277
- </GraphQLDoc>
3278
-
3279
- ## Surcharge {#surcharge}
3280
-
3281
- <GraphQLDoc
3282
- type="type"
3283
- typeName="Surcharge"
3284
- typeLinks={{
3285
- ID: '/reference/graphql-api/shop/object-types#id',
3286
- DateTime: '/reference/graphql-api/shop/object-types#datetime',
3287
- String: '/reference/graphql-api/shop/object-types#string',
3288
- TaxLine: '/reference/graphql-api/shop/object-types#taxline',
3289
- Money: '/reference/graphql-api/shop/object-types#money',
3290
- Float: '/reference/graphql-api/shop/object-types#float',
3291
- }}
3292
- >
3293
- {`type Surcharge {
3294
- id: ID!
3295
- createdAt: DateTime!
3296
- updatedAt: DateTime!
3297
- description: String!
3298
- sku: String
3299
- taxLines: [TaxLine!]!
3300
- price: Money!
3301
- priceWithTax: Money!
3302
- taxRate: Float!
3303
- }`}
3304
- </GraphQLDoc>
3305
-
3306
- ## Tag {#tag}
3307
-
3308
- <GraphQLDoc
3309
- type="type"
3310
- typeName="Tag"
3311
- typeLinks={{
3312
- ID: '/reference/graphql-api/shop/object-types#id',
3313
- DateTime: '/reference/graphql-api/shop/object-types#datetime',
3314
- String: '/reference/graphql-api/shop/object-types#string',
3315
- }}
3316
- >
3317
- {`type Tag {
3318
- id: ID!
3319
- createdAt: DateTime!
3320
- updatedAt: DateTime!
3321
- value: String!
3322
- }`}
3323
- </GraphQLDoc>
3324
-
3325
- ## TagList {#taglist}
3326
-
3327
- <GraphQLDoc
3328
- type="type"
3329
- typeName="TagList"
3330
- typeLinks={{
3331
- Tag: '/reference/graphql-api/shop/object-types#tag',
3332
- Int: '/reference/graphql-api/shop/object-types#int',
3333
- }}
3334
- >
3335
- {`type TagList {
3336
- items: [Tag!]!
3337
- totalItems: Int!
3338
- }`}
3339
- </GraphQLDoc>
3340
-
3341
- ## TaxCategory {#taxcategory}
3342
-
3343
- <GraphQLDoc
3344
- type="type"
3345
- typeName="TaxCategory"
3346
- typeLinks={{
3347
- ID: '/reference/graphql-api/shop/object-types#id',
3348
- DateTime: '/reference/graphql-api/shop/object-types#datetime',
3349
- String: '/reference/graphql-api/shop/object-types#string',
3350
- Boolean: '/reference/graphql-api/shop/object-types#boolean',
3351
- JSON: '/reference/graphql-api/shop/object-types#json',
3352
- }}
3353
- >
3354
- {`type TaxCategory {
3355
- id: ID!
3356
- createdAt: DateTime!
3357
- updatedAt: DateTime!
3358
- name: String!
3359
- isDefault: Boolean!
3360
- customFields: JSON
3361
- }`}
3362
- </GraphQLDoc>
3363
-
3364
- ## TaxLine {#taxline}
3365
-
3366
- <GraphQLDoc
3367
- type="type"
3368
- typeName="TaxLine"
3369
- typeLinks={{
3370
- String: '/reference/graphql-api/shop/object-types#string',
3371
- Float: '/reference/graphql-api/shop/object-types#float',
3372
- }}
3373
- >
3374
- {`type TaxLine {
3375
- description: String!
3376
- taxRate: Float!
3377
- }`}
3378
- </GraphQLDoc>
3379
-
3380
- ## TaxRate {#taxrate}
3381
-
3382
- <GraphQLDoc
3383
- type="type"
3384
- typeName="TaxRate"
3385
- typeLinks={{
3386
- ID: '/reference/graphql-api/shop/object-types#id',
3387
- DateTime: '/reference/graphql-api/shop/object-types#datetime',
3388
- String: '/reference/graphql-api/shop/object-types#string',
3389
- Boolean: '/reference/graphql-api/shop/object-types#boolean',
3390
- Float: '/reference/graphql-api/shop/object-types#float',
3391
- TaxCategory: '/reference/graphql-api/shop/object-types#taxcategory',
3392
- Zone: '/reference/graphql-api/shop/object-types#zone',
3393
- CustomerGroup: '/reference/graphql-api/shop/object-types#customergroup',
3394
- JSON: '/reference/graphql-api/shop/object-types#json',
3395
- }}
3396
- >
3397
- {`type TaxRate {
3398
- id: ID!
3399
- createdAt: DateTime!
3400
- updatedAt: DateTime!
3401
- name: String!
3402
- enabled: Boolean!
3403
- value: Float!
3404
- category: TaxCategory!
3405
- zone: Zone!
3406
- customerGroup: CustomerGroup
3407
- customFields: JSON
3408
- }`}
3409
- </GraphQLDoc>
3410
-
3411
- ## TaxRateList {#taxratelist}
3412
-
3413
- <GraphQLDoc
3414
- type="type"
3415
- typeName="TaxRateList"
3416
- typeLinks={{
3417
- TaxRate: '/reference/graphql-api/shop/object-types#taxrate',
3418
- Int: '/reference/graphql-api/shop/object-types#int',
3419
- }}
3420
- >
3421
- {`type TaxRateList {
3422
- items: [TaxRate!]!
3423
- totalItems: Int!
3424
- }`}
3425
- </GraphQLDoc>
3426
-
3427
- ## TextCustomFieldConfig {#textcustomfieldconfig}
3428
-
3429
- <GraphQLDoc
3430
- type="type"
3431
- typeName="TextCustomFieldConfig"
3432
- typeLinks={{
3433
- String: '/reference/graphql-api/shop/object-types#string',
3434
- Boolean: '/reference/graphql-api/shop/object-types#boolean',
3435
- LocalizedString: '/reference/graphql-api/shop/object-types#localizedstring',
3436
- Permission: '/reference/graphql-api/shop/enums#permission',
3437
- JSON: '/reference/graphql-api/shop/object-types#json',
3438
- }}
3439
- >
3440
- {`type TextCustomFieldConfig {
3441
- name: String!
3442
- type: String!
3443
- list: Boolean!
3444
- label: [LocalizedString!]
3445
- description: [LocalizedString!]
3446
- readonly: Boolean
3447
- internal: Boolean
3448
- nullable: Boolean
3449
- requiresPermission: [Permission!]
3450
- deprecated: Boolean
3451
- deprecationReason: String
3452
- ui: JSON
3453
- }`}
3454
- </GraphQLDoc>
3455
-
3456
- ## TextStructFieldConfig {#textstructfieldconfig}
3457
-
3458
- <GraphQLDoc
3459
- type="type"
3460
- typeName="TextStructFieldConfig"
3461
- typeLinks={{
3462
- String: '/reference/graphql-api/shop/object-types#string',
3463
- Boolean: '/reference/graphql-api/shop/object-types#boolean',
3464
- LocalizedString: '/reference/graphql-api/shop/object-types#localizedstring',
3465
- JSON: '/reference/graphql-api/shop/object-types#json',
3466
- }}
3467
- >
3468
- {`type TextStructFieldConfig {
3469
- name: String!
3470
- type: String!
3471
- list: Boolean!
3472
- label: [LocalizedString!]
3473
- description: [LocalizedString!]
3474
- ui: JSON
3475
- }`}
3476
- </GraphQLDoc>
3477
-
3478
- ## TransitionOrderToStateResult {#transitionordertostateresult}
3479
-
3480
- <GraphQLDoc
3481
- type="union"
3482
- typeName="TransitionOrderToStateResult"
3483
- typeLinks={{
3484
- Order: '/reference/graphql-api/shop/object-types#order',
3485
- OrderStateTransitionError: '/reference/graphql-api/shop/object-types#orderstatetransitionerror',
3486
- }}
3487
- >
3488
- {`union TransitionOrderToStateResult = Order | OrderStateTransitionError`}
3489
- </GraphQLDoc>
3490
-
3491
- ## UpdateCustomerEmailAddressResult {#updatecustomeremailaddressresult}
3492
-
3493
- <GraphQLDoc
3494
- type="union"
3495
- typeName="UpdateCustomerEmailAddressResult"
3496
- typeLinks={{
3497
- Success: '/reference/graphql-api/shop/object-types#success',
3498
- IdentifierChangeTokenInvalidError: '/reference/graphql-api/shop/object-types#identifierchangetokeninvaliderror',
3499
- IdentifierChangeTokenExpiredError: '/reference/graphql-api/shop/object-types#identifierchangetokenexpirederror',
3500
- NativeAuthStrategyError: '/reference/graphql-api/shop/object-types#nativeauthstrategyerror',
3501
- }}
3502
- >
3503
- {`union UpdateCustomerEmailAddressResult = Success | IdentifierChangeTokenInvalidError | IdentifierChangeTokenExpiredError | NativeAuthStrategyError`}
3504
- </GraphQLDoc>
3505
-
3506
- ## UpdateCustomerPasswordResult {#updatecustomerpasswordresult}
3507
-
3508
- <GraphQLDoc
3509
- type="union"
3510
- typeName="UpdateCustomerPasswordResult"
3511
- typeLinks={{
3512
- Success: '/reference/graphql-api/shop/object-types#success',
3513
- InvalidCredentialsError: '/reference/graphql-api/shop/object-types#invalidcredentialserror',
3514
- PasswordValidationError: '/reference/graphql-api/shop/object-types#passwordvalidationerror',
3515
- NativeAuthStrategyError: '/reference/graphql-api/shop/object-types#nativeauthstrategyerror',
3516
- }}
3517
- >
3518
- {`union UpdateCustomerPasswordResult = Success | InvalidCredentialsError | PasswordValidationError | NativeAuthStrategyError`}
3519
- </GraphQLDoc>
3520
-
3521
- ## UpdateMultipleOrderItemsResult {#updatemultipleorderitemsresult}
3522
-
3523
- <GraphQLDoc
3524
- type="type"
3525
- typeName="UpdateMultipleOrderItemsResult"
3526
- typeLinks={{
3527
- Order: '/reference/graphql-api/shop/object-types#order',
3528
- UpdateOrderItemErrorResult: '/reference/graphql-api/shop/object-types#updateorderitemerrorresult',
3529
- }}
3530
- >
3531
- {`"""
3532
- Returned when multiple items are added to an Order.
3533
- The errorResults array contains the errors that occurred for each item, if any.
3534
- """
3535
- type UpdateMultipleOrderItemsResult {
3536
- order: Order!
3537
- errorResults: [UpdateOrderItemErrorResult!]!
3538
- }`}
3539
- </GraphQLDoc>
3540
-
3541
- ## UpdateOrderItemErrorResult {#updateorderitemerrorresult}
3542
-
3543
- <GraphQLDoc
3544
- type="union"
3545
- typeName="UpdateOrderItemErrorResult"
3546
- typeLinks={{
3547
- OrderModificationError: '/reference/graphql-api/shop/object-types#ordermodificationerror',
3548
- OrderLimitError: '/reference/graphql-api/shop/object-types#orderlimiterror',
3549
- NegativeQuantityError: '/reference/graphql-api/shop/object-types#negativequantityerror',
3550
- InsufficientStockError: '/reference/graphql-api/shop/object-types#insufficientstockerror',
3551
- OrderInterceptorError: '/reference/graphql-api/shop/object-types#orderinterceptorerror',
3552
- }}
3553
- >
3554
- {`"""Union type of all possible errors that can occur when adding or removing items from an Order."""
3555
- union UpdateOrderItemErrorResult = OrderModificationError | OrderLimitError | NegativeQuantityError | InsufficientStockError | OrderInterceptorError`}
3556
- </GraphQLDoc>
3557
-
3558
- ## UpdateOrderItemsResult {#updateorderitemsresult}
3559
-
3560
- <GraphQLDoc
3561
- type="union"
3562
- typeName="UpdateOrderItemsResult"
3563
- typeLinks={{
3564
- Order: '/reference/graphql-api/shop/object-types#order',
3565
- OrderModificationError: '/reference/graphql-api/shop/object-types#ordermodificationerror',
3566
- OrderLimitError: '/reference/graphql-api/shop/object-types#orderlimiterror',
3567
- NegativeQuantityError: '/reference/graphql-api/shop/object-types#negativequantityerror',
3568
- InsufficientStockError: '/reference/graphql-api/shop/object-types#insufficientstockerror',
3569
- OrderInterceptorError: '/reference/graphql-api/shop/object-types#orderinterceptorerror',
3570
- }}
3571
- >
3572
- {`union UpdateOrderItemsResult = Order | OrderModificationError | OrderLimitError | NegativeQuantityError | InsufficientStockError | OrderInterceptorError`}
3573
- </GraphQLDoc>
3574
-
3575
- ## Upload {#upload}
3576
-
3577
- <GraphQLDoc
3578
- type="scalar"
3579
- typeName="Upload"
3580
- typeLinks={{}}
3581
- >
3582
- {`"""The \`Upload\` scalar type represents a file upload."""
3583
- scalar Upload`}
3584
- </GraphQLDoc>
3585
-
3586
- ## User {#user}
3587
-
3588
- <GraphQLDoc
3589
- type="type"
3590
- typeName="User"
3591
- typeLinks={{
3592
- ID: '/reference/graphql-api/shop/object-types#id',
3593
- DateTime: '/reference/graphql-api/shop/object-types#datetime',
3594
- String: '/reference/graphql-api/shop/object-types#string',
3595
- Boolean: '/reference/graphql-api/shop/object-types#boolean',
3596
- Role: '/reference/graphql-api/shop/object-types#role',
3597
- AuthenticationMethod: '/reference/graphql-api/shop/object-types#authenticationmethod',
3598
- JSON: '/reference/graphql-api/shop/object-types#json',
3599
- }}
3600
- >
3601
- {`type User {
3602
- id: ID!
3603
- createdAt: DateTime!
3604
- updatedAt: DateTime!
3605
- identifier: String!
3606
- verified: Boolean!
3607
- roles: [Role!]!
3608
- lastLogin: DateTime
3609
- authenticationMethods: [AuthenticationMethod!]!
3610
- customFields: JSON
3611
- }`}
3612
- </GraphQLDoc>
3613
-
3614
- ## VerificationTokenExpiredError {#verificationtokenexpirederror}
3615
-
3616
- <GraphQLDoc
3617
- type="type"
3618
- typeName="VerificationTokenExpiredError"
3619
- typeLinks={{
3620
- ErrorCode: '/reference/graphql-api/shop/enums#errorcode',
3621
- String: '/reference/graphql-api/shop/object-types#string',
3622
- }}
3623
- >
3624
- {`"""
3625
- Returned if the verification token (used to verify a Customer's email address) is valid, but has
3626
- expired according to the \`verificationTokenDuration\` setting in the AuthOptions.
3627
- """
3628
- type VerificationTokenExpiredError {
3629
- errorCode: ErrorCode!
3630
- message: String!
3631
- }`}
3632
- </GraphQLDoc>
3633
-
3634
- ## VerificationTokenInvalidError {#verificationtokeninvaliderror}
3635
-
3636
- <GraphQLDoc
3637
- type="type"
3638
- typeName="VerificationTokenInvalidError"
3639
- typeLinks={{
3640
- ErrorCode: '/reference/graphql-api/shop/enums#errorcode',
3641
- String: '/reference/graphql-api/shop/object-types#string',
3642
- }}
3643
- >
3644
- {`"""
3645
- Returned if the verification token (used to verify a Customer's email address) is either
3646
- invalid or does not match any expected tokens.
3647
- """
3648
- type VerificationTokenInvalidError {
3649
- errorCode: ErrorCode!
3650
- message: String!
3651
- }`}
3652
- </GraphQLDoc>
3653
-
3654
- ## VerifyCustomerAccountResult {#verifycustomeraccountresult}
3655
-
3656
- <GraphQLDoc
3657
- type="union"
3658
- typeName="VerifyCustomerAccountResult"
3659
- typeLinks={{
3660
- CurrentUser: '/reference/graphql-api/shop/object-types#currentuser',
3661
- VerificationTokenInvalidError: '/reference/graphql-api/shop/object-types#verificationtokeninvaliderror',
3662
- VerificationTokenExpiredError: '/reference/graphql-api/shop/object-types#verificationtokenexpirederror',
3663
- MissingPasswordError: '/reference/graphql-api/shop/object-types#missingpassworderror',
3664
- PasswordValidationError: '/reference/graphql-api/shop/object-types#passwordvalidationerror',
3665
- PasswordAlreadySetError: '/reference/graphql-api/shop/object-types#passwordalreadyseterror',
3666
- NativeAuthStrategyError: '/reference/graphql-api/shop/object-types#nativeauthstrategyerror',
3667
- }}
3668
- >
3669
- {`union VerifyCustomerAccountResult = CurrentUser | VerificationTokenInvalidError | VerificationTokenExpiredError | MissingPasswordError | PasswordValidationError | PasswordAlreadySetError | NativeAuthStrategyError`}
3670
- </GraphQLDoc>
3671
-
3672
- ## Zone {#zone}
3673
-
3674
- <GraphQLDoc
3675
- type="type"
3676
- typeName="Zone"
3677
- typeLinks={{
3678
- ID: '/reference/graphql-api/shop/object-types#id',
3679
- DateTime: '/reference/graphql-api/shop/object-types#datetime',
3680
- String: '/reference/graphql-api/shop/object-types#string',
3681
- Region: '/reference/graphql-api/shop/object-types#region',
3682
- JSON: '/reference/graphql-api/shop/object-types#json',
3683
- }}
3684
- >
3685
- {`type Zone {
3686
- id: ID!
3687
- createdAt: DateTime!
3688
- updatedAt: DateTime!
3689
- name: String!
3690
- members: [Region!]!
3691
- customFields: JSON
3692
- }`}
3693
- </GraphQLDoc>