@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,4973 +0,0 @@
1
- ---
2
- title: "Types"
3
- generated: true
4
- ---
5
-
6
-
7
-
8
- ## AddFulfillmentToOrderResult {#addfulfillmenttoorderresult}
9
-
10
- <GraphQLDoc
11
- type="union"
12
- typeName="AddFulfillmentToOrderResult"
13
- typeLinks={{
14
- Fulfillment: '/reference/graphql-api/admin/object-types#fulfillment',
15
- EmptyOrderLineSelectionError: '/reference/graphql-api/admin/object-types#emptyorderlineselectionerror',
16
- ItemsAlreadyFulfilledError: '/reference/graphql-api/admin/object-types#itemsalreadyfulfillederror',
17
- InsufficientStockOnHandError: '/reference/graphql-api/admin/object-types#insufficientstockonhanderror',
18
- InvalidFulfillmentHandlerError: '/reference/graphql-api/admin/object-types#invalidfulfillmenthandlererror',
19
- FulfillmentStateTransitionError: '/reference/graphql-api/admin/object-types#fulfillmentstatetransitionerror',
20
- CreateFulfillmentError: '/reference/graphql-api/admin/object-types#createfulfillmenterror',
21
- }}
22
- >
23
- {`union AddFulfillmentToOrderResult = Fulfillment | EmptyOrderLineSelectionError | ItemsAlreadyFulfilledError | InsufficientStockOnHandError | InvalidFulfillmentHandlerError | FulfillmentStateTransitionError | CreateFulfillmentError`}
24
- </GraphQLDoc>
25
-
26
- ## AddManualPaymentToOrderResult {#addmanualpaymenttoorderresult}
27
-
28
- <GraphQLDoc
29
- type="union"
30
- typeName="AddManualPaymentToOrderResult"
31
- typeLinks={{
32
- Order: '/reference/graphql-api/admin/object-types#order',
33
- ManualPaymentStateError: '/reference/graphql-api/admin/object-types#manualpaymentstateerror',
34
- }}
35
- >
36
- {`union AddManualPaymentToOrderResult = Order | ManualPaymentStateError`}
37
- </GraphQLDoc>
38
-
39
- ## Address {#address}
40
-
41
- <GraphQLDoc
42
- type="type"
43
- typeName="Address"
44
- typeLinks={{
45
- ID: '/reference/graphql-api/admin/object-types#id',
46
- DateTime: '/reference/graphql-api/admin/object-types#datetime',
47
- String: '/reference/graphql-api/admin/object-types#string',
48
- Country: '/reference/graphql-api/admin/object-types#country',
49
- Boolean: '/reference/graphql-api/admin/object-types#boolean',
50
- JSON: '/reference/graphql-api/admin/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/admin/object-types#string',
79
- AdjustmentType: '/reference/graphql-api/admin/enums#adjustmenttype',
80
- Money: '/reference/graphql-api/admin/object-types#money',
81
- JSON: '/reference/graphql-api/admin/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
- ## Administrator {#administrator}
94
-
95
- <GraphQLDoc
96
- type="type"
97
- typeName="Administrator"
98
- typeLinks={{
99
- ID: '/reference/graphql-api/admin/object-types#id',
100
- DateTime: '/reference/graphql-api/admin/object-types#datetime',
101
- String: '/reference/graphql-api/admin/object-types#string',
102
- User: '/reference/graphql-api/admin/object-types#user',
103
- JSON: '/reference/graphql-api/admin/object-types#json',
104
- }}
105
- >
106
- {`type Administrator {
107
- id: ID!
108
- createdAt: DateTime!
109
- updatedAt: DateTime!
110
- firstName: String!
111
- lastName: String!
112
- emailAddress: String!
113
- user: User!
114
- customFields: JSON
115
- }`}
116
- </GraphQLDoc>
117
-
118
- ## AdministratorList {#administratorlist}
119
-
120
- <GraphQLDoc
121
- type="type"
122
- typeName="AdministratorList"
123
- typeLinks={{
124
- Administrator: '/reference/graphql-api/admin/object-types#administrator',
125
- Int: '/reference/graphql-api/admin/object-types#int',
126
- }}
127
- >
128
- {`type AdministratorList {
129
- items: [Administrator!]!
130
- totalItems: Int!
131
- }`}
132
- </GraphQLDoc>
133
-
134
- ## Allocation {#allocation}
135
-
136
- <GraphQLDoc
137
- type="type"
138
- typeName="Allocation"
139
- typeLinks={{
140
- ID: '/reference/graphql-api/admin/object-types#id',
141
- DateTime: '/reference/graphql-api/admin/object-types#datetime',
142
- ProductVariant: '/reference/graphql-api/admin/object-types#productvariant',
143
- StockMovementType: '/reference/graphql-api/admin/enums#stockmovementtype',
144
- Int: '/reference/graphql-api/admin/object-types#int',
145
- OrderLine: '/reference/graphql-api/admin/object-types#orderline',
146
- JSON: '/reference/graphql-api/admin/object-types#json',
147
- }}
148
- >
149
- {`type Allocation {
150
- id: ID!
151
- createdAt: DateTime!
152
- updatedAt: DateTime!
153
- productVariant: ProductVariant!
154
- type: StockMovementType!
155
- quantity: Int!
156
- orderLine: OrderLine!
157
- customFields: JSON
158
- }`}
159
- </GraphQLDoc>
160
-
161
- ## AlreadyRefundedError {#alreadyrefundederror}
162
-
163
- <GraphQLDoc
164
- type="type"
165
- typeName="AlreadyRefundedError"
166
- typeLinks={{
167
- ErrorCode: '/reference/graphql-api/admin/enums#errorcode',
168
- String: '/reference/graphql-api/admin/object-types#string',
169
- ID: '/reference/graphql-api/admin/object-types#id',
170
- }}
171
- >
172
- {`"""Returned if an attempting to refund an OrderItem which has already been refunded"""
173
- type AlreadyRefundedError {
174
- errorCode: ErrorCode!
175
- message: String!
176
- refundId: ID!
177
- }`}
178
- </GraphQLDoc>
179
-
180
- ## ApplyCouponCodeResult {#applycouponcoderesult}
181
-
182
- <GraphQLDoc
183
- type="union"
184
- typeName="ApplyCouponCodeResult"
185
- typeLinks={{
186
- Order: '/reference/graphql-api/admin/object-types#order',
187
- CouponCodeExpiredError: '/reference/graphql-api/admin/object-types#couponcodeexpirederror',
188
- CouponCodeInvalidError: '/reference/graphql-api/admin/object-types#couponcodeinvaliderror',
189
- CouponCodeLimitError: '/reference/graphql-api/admin/object-types#couponcodelimiterror',
190
- }}
191
- >
192
- {`union ApplyCouponCodeResult = Order | CouponCodeExpiredError | CouponCodeInvalidError | CouponCodeLimitError`}
193
- </GraphQLDoc>
194
-
195
- ## Asset {#asset}
196
-
197
- <GraphQLDoc
198
- type="type"
199
- typeName="Asset"
200
- typeLinks={{
201
- ID: '/reference/graphql-api/admin/object-types#id',
202
- DateTime: '/reference/graphql-api/admin/object-types#datetime',
203
- String: '/reference/graphql-api/admin/object-types#string',
204
- AssetType: '/reference/graphql-api/admin/enums#assettype',
205
- Int: '/reference/graphql-api/admin/object-types#int',
206
- Coordinate: '/reference/graphql-api/admin/object-types#coordinate',
207
- Tag: '/reference/graphql-api/admin/object-types#tag',
208
- JSON: '/reference/graphql-api/admin/object-types#json',
209
- }}
210
- >
211
- {`type Asset {
212
- id: ID!
213
- createdAt: DateTime!
214
- updatedAt: DateTime!
215
- name: String!
216
- type: AssetType!
217
- fileSize: Int!
218
- mimeType: String!
219
- width: Int!
220
- height: Int!
221
- source: String!
222
- preview: String!
223
- focalPoint: Coordinate
224
- tags: [Tag!]!
225
- customFields: JSON
226
- }`}
227
- </GraphQLDoc>
228
-
229
- ## AssetList {#assetlist}
230
-
231
- <GraphQLDoc
232
- type="type"
233
- typeName="AssetList"
234
- typeLinks={{
235
- Asset: '/reference/graphql-api/admin/object-types#asset',
236
- Int: '/reference/graphql-api/admin/object-types#int',
237
- }}
238
- >
239
- {`type AssetList {
240
- items: [Asset!]!
241
- totalItems: Int!
242
- }`}
243
- </GraphQLDoc>
244
-
245
- ## AuthenticationMethod {#authenticationmethod}
246
-
247
- <GraphQLDoc
248
- type="type"
249
- typeName="AuthenticationMethod"
250
- typeLinks={{
251
- ID: '/reference/graphql-api/admin/object-types#id',
252
- DateTime: '/reference/graphql-api/admin/object-types#datetime',
253
- String: '/reference/graphql-api/admin/object-types#string',
254
- }}
255
- >
256
- {`type AuthenticationMethod {
257
- id: ID!
258
- createdAt: DateTime!
259
- updatedAt: DateTime!
260
- strategy: String!
261
- }`}
262
- </GraphQLDoc>
263
-
264
- ## AuthenticationResult {#authenticationresult}
265
-
266
- <GraphQLDoc
267
- type="union"
268
- typeName="AuthenticationResult"
269
- typeLinks={{
270
- CurrentUser: '/reference/graphql-api/admin/object-types#currentuser',
271
- InvalidCredentialsError: '/reference/graphql-api/admin/object-types#invalidcredentialserror',
272
- }}
273
- >
274
- {`union AuthenticationResult = CurrentUser | InvalidCredentialsError`}
275
- </GraphQLDoc>
276
-
277
- ## Boolean {#boolean}
278
-
279
- <GraphQLDoc
280
- type="scalar"
281
- typeName="Boolean"
282
- typeLinks={{}}
283
- >
284
- {`"""The \`Boolean\` scalar type represents \`true\` or \`false\`."""
285
- scalar Boolean`}
286
- </GraphQLDoc>
287
-
288
- ## BooleanCustomFieldConfig {#booleancustomfieldconfig}
289
-
290
- <GraphQLDoc
291
- type="type"
292
- typeName="BooleanCustomFieldConfig"
293
- typeLinks={{
294
- String: '/reference/graphql-api/admin/object-types#string',
295
- Boolean: '/reference/graphql-api/admin/object-types#boolean',
296
- LocalizedString: '/reference/graphql-api/admin/object-types#localizedstring',
297
- Permission: '/reference/graphql-api/admin/enums#permission',
298
- JSON: '/reference/graphql-api/admin/object-types#json',
299
- }}
300
- >
301
- {`type BooleanCustomFieldConfig {
302
- name: String!
303
- type: String!
304
- list: Boolean!
305
- label: [LocalizedString!]
306
- description: [LocalizedString!]
307
- readonly: Boolean
308
- internal: Boolean
309
- nullable: Boolean
310
- requiresPermission: [Permission!]
311
- deprecated: Boolean
312
- deprecationReason: String
313
- ui: JSON
314
- }`}
315
- </GraphQLDoc>
316
-
317
- ## BooleanStructFieldConfig {#booleanstructfieldconfig}
318
-
319
- <GraphQLDoc
320
- type="type"
321
- typeName="BooleanStructFieldConfig"
322
- typeLinks={{
323
- String: '/reference/graphql-api/admin/object-types#string',
324
- Boolean: '/reference/graphql-api/admin/object-types#boolean',
325
- LocalizedString: '/reference/graphql-api/admin/object-types#localizedstring',
326
- JSON: '/reference/graphql-api/admin/object-types#json',
327
- }}
328
- >
329
- {`type BooleanStructFieldConfig {
330
- name: String!
331
- type: String!
332
- list: Boolean!
333
- label: [LocalizedString!]
334
- description: [LocalizedString!]
335
- ui: JSON
336
- }`}
337
- </GraphQLDoc>
338
-
339
- ## CancelActiveOrderError {#cancelactiveordererror}
340
-
341
- <GraphQLDoc
342
- type="type"
343
- typeName="CancelActiveOrderError"
344
- typeLinks={{
345
- ErrorCode: '/reference/graphql-api/admin/enums#errorcode',
346
- String: '/reference/graphql-api/admin/object-types#string',
347
- }}
348
- >
349
- {`"""Returned if an attempting to cancel lines from an Order which is still active"""
350
- type CancelActiveOrderError {
351
- errorCode: ErrorCode!
352
- message: String!
353
- orderState: String!
354
- }`}
355
- </GraphQLDoc>
356
-
357
- ## CancelOrderResult {#cancelorderresult}
358
-
359
- <GraphQLDoc
360
- type="union"
361
- typeName="CancelOrderResult"
362
- typeLinks={{
363
- Order: '/reference/graphql-api/admin/object-types#order',
364
- EmptyOrderLineSelectionError: '/reference/graphql-api/admin/object-types#emptyorderlineselectionerror',
365
- QuantityTooGreatError: '/reference/graphql-api/admin/object-types#quantitytoogreaterror',
366
- MultipleOrderError: '/reference/graphql-api/admin/object-types#multipleordererror',
367
- CancelActiveOrderError: '/reference/graphql-api/admin/object-types#cancelactiveordererror',
368
- OrderStateTransitionError: '/reference/graphql-api/admin/object-types#orderstatetransitionerror',
369
- }}
370
- >
371
- {`union CancelOrderResult = Order | EmptyOrderLineSelectionError | QuantityTooGreatError | MultipleOrderError | CancelActiveOrderError | OrderStateTransitionError`}
372
- </GraphQLDoc>
373
-
374
- ## CancelPaymentError {#cancelpaymenterror}
375
-
376
- <GraphQLDoc
377
- type="type"
378
- typeName="CancelPaymentError"
379
- typeLinks={{
380
- ErrorCode: '/reference/graphql-api/admin/enums#errorcode',
381
- String: '/reference/graphql-api/admin/object-types#string',
382
- }}
383
- >
384
- {`"""Returned if the Payment cancellation fails"""
385
- type CancelPaymentError {
386
- errorCode: ErrorCode!
387
- message: String!
388
- paymentErrorMessage: String!
389
- }`}
390
- </GraphQLDoc>
391
-
392
- ## CancelPaymentResult {#cancelpaymentresult}
393
-
394
- <GraphQLDoc
395
- type="union"
396
- typeName="CancelPaymentResult"
397
- typeLinks={{
398
- Payment: '/reference/graphql-api/admin/object-types#payment',
399
- CancelPaymentError: '/reference/graphql-api/admin/object-types#cancelpaymenterror',
400
- PaymentStateTransitionError: '/reference/graphql-api/admin/object-types#paymentstatetransitionerror',
401
- }}
402
- >
403
- {`union CancelPaymentResult = Payment | CancelPaymentError | PaymentStateTransitionError`}
404
- </GraphQLDoc>
405
-
406
- ## Cancellation {#cancellation}
407
-
408
- <GraphQLDoc
409
- type="type"
410
- typeName="Cancellation"
411
- typeLinks={{
412
- ID: '/reference/graphql-api/admin/object-types#id',
413
- DateTime: '/reference/graphql-api/admin/object-types#datetime',
414
- ProductVariant: '/reference/graphql-api/admin/object-types#productvariant',
415
- StockMovementType: '/reference/graphql-api/admin/enums#stockmovementtype',
416
- Int: '/reference/graphql-api/admin/object-types#int',
417
- OrderLine: '/reference/graphql-api/admin/object-types#orderline',
418
- JSON: '/reference/graphql-api/admin/object-types#json',
419
- }}
420
- >
421
- {`type Cancellation {
422
- id: ID!
423
- createdAt: DateTime!
424
- updatedAt: DateTime!
425
- productVariant: ProductVariant!
426
- type: StockMovementType!
427
- quantity: Int!
428
- orderLine: OrderLine!
429
- customFields: JSON
430
- }`}
431
- </GraphQLDoc>
432
-
433
- ## Channel {#channel}
434
-
435
- <GraphQLDoc
436
- type="type"
437
- typeName="Channel"
438
- typeLinks={{
439
- ID: '/reference/graphql-api/admin/object-types#id',
440
- DateTime: '/reference/graphql-api/admin/object-types#datetime',
441
- String: '/reference/graphql-api/admin/object-types#string',
442
- Zone: '/reference/graphql-api/admin/object-types#zone',
443
- LanguageCode: '/reference/graphql-api/admin/enums#languagecode',
444
- CurrencyCode: '/reference/graphql-api/admin/enums#currencycode',
445
- Boolean: '/reference/graphql-api/admin/object-types#boolean',
446
- Int: '/reference/graphql-api/admin/object-types#int',
447
- Seller: '/reference/graphql-api/admin/object-types#seller',
448
- JSON: '/reference/graphql-api/admin/object-types#json',
449
- }}
450
- >
451
- {`type Channel {
452
- id: ID!
453
- createdAt: DateTime!
454
- updatedAt: DateTime!
455
- code: String!
456
- token: String!
457
- defaultTaxZone: Zone
458
- defaultShippingZone: Zone
459
- defaultLanguageCode: LanguageCode!
460
- availableLanguageCodes: [LanguageCode!]
461
- currencyCode: CurrencyCode!
462
- defaultCurrencyCode: CurrencyCode!
463
- availableCurrencyCodes: [CurrencyCode!]!
464
- """Not yet used - will be implemented in a future release."""
465
- trackInventory: Boolean
466
- """Not yet used - will be implemented in a future release."""
467
- outOfStockThreshold: Int
468
- pricesIncludeTax: Boolean!
469
- seller: Seller
470
- customFields: JSON
471
- }`}
472
- </GraphQLDoc>
473
-
474
- ## ChannelDefaultLanguageError {#channeldefaultlanguageerror}
475
-
476
- <GraphQLDoc
477
- type="type"
478
- typeName="ChannelDefaultLanguageError"
479
- typeLinks={{
480
- ErrorCode: '/reference/graphql-api/admin/enums#errorcode',
481
- String: '/reference/graphql-api/admin/object-types#string',
482
- }}
483
- >
484
- {`"""
485
- Returned when the default LanguageCode of a Channel is no longer found in the \`availableLanguages\`
486
- of the GlobalSettings
487
- """
488
- type ChannelDefaultLanguageError {
489
- errorCode: ErrorCode!
490
- message: String!
491
- language: String!
492
- channelCode: String!
493
- }`}
494
- </GraphQLDoc>
495
-
496
- ## ChannelList {#channellist}
497
-
498
- <GraphQLDoc
499
- type="type"
500
- typeName="ChannelList"
501
- typeLinks={{
502
- Channel: '/reference/graphql-api/admin/object-types#channel',
503
- Int: '/reference/graphql-api/admin/object-types#int',
504
- }}
505
- >
506
- {`type ChannelList {
507
- items: [Channel!]!
508
- totalItems: Int!
509
- }`}
510
- </GraphQLDoc>
511
-
512
- ## Collection {#collection}
513
-
514
- <GraphQLDoc
515
- type="type"
516
- typeName="Collection"
517
- typeLinks={{
518
- Boolean: '/reference/graphql-api/admin/object-types#boolean',
519
- ID: '/reference/graphql-api/admin/object-types#id',
520
- DateTime: '/reference/graphql-api/admin/object-types#datetime',
521
- LanguageCode: '/reference/graphql-api/admin/enums#languagecode',
522
- String: '/reference/graphql-api/admin/object-types#string',
523
- CollectionBreadcrumb: '/reference/graphql-api/admin/object-types#collectionbreadcrumb',
524
- Int: '/reference/graphql-api/admin/object-types#int',
525
- Asset: '/reference/graphql-api/admin/object-types#asset',
526
- Collection: '/reference/graphql-api/admin/object-types#collection',
527
- ConfigurableOperation: '/reference/graphql-api/admin/object-types#configurableoperation',
528
- CollectionTranslation: '/reference/graphql-api/admin/object-types#collectiontranslation',
529
- ProductVariantList: '/reference/graphql-api/admin/object-types#productvariantlist',
530
- ProductVariantListOptions: '/reference/graphql-api/admin/input-types#productvariantlistoptions',
531
- JSON: '/reference/graphql-api/admin/object-types#json',
532
- }}
533
- >
534
- {`type Collection {
535
- isPrivate: Boolean!
536
- inheritFilters: Boolean!
537
- id: ID!
538
- createdAt: DateTime!
539
- updatedAt: DateTime!
540
- languageCode: LanguageCode
541
- name: String!
542
- slug: String!
543
- breadcrumbs: [CollectionBreadcrumb!]!
544
- position: Int!
545
- description: String!
546
- featuredAsset: Asset
547
- assets: [Asset!]!
548
- parent: Collection
549
- parentId: ID!
550
- children: [Collection!]
551
- filters: [ConfigurableOperation!]!
552
- translations: [CollectionTranslation!]!
553
- productVariants(options: ProductVariantListOptions): ProductVariantList!
554
- customFields: JSON
555
- }`}
556
- </GraphQLDoc>
557
-
558
- ## CollectionBreadcrumb {#collectionbreadcrumb}
559
-
560
- <GraphQLDoc
561
- type="type"
562
- typeName="CollectionBreadcrumb"
563
- typeLinks={{
564
- ID: '/reference/graphql-api/admin/object-types#id',
565
- String: '/reference/graphql-api/admin/object-types#string',
566
- }}
567
- >
568
- {`type CollectionBreadcrumb {
569
- id: ID!
570
- name: String!
571
- slug: String!
572
- }`}
573
- </GraphQLDoc>
574
-
575
- ## CollectionList {#collectionlist}
576
-
577
- <GraphQLDoc
578
- type="type"
579
- typeName="CollectionList"
580
- typeLinks={{
581
- Collection: '/reference/graphql-api/admin/object-types#collection',
582
- Int: '/reference/graphql-api/admin/object-types#int',
583
- }}
584
- >
585
- {`type CollectionList {
586
- items: [Collection!]!
587
- totalItems: Int!
588
- }`}
589
- </GraphQLDoc>
590
-
591
- ## CollectionResult {#collectionresult}
592
-
593
- <GraphQLDoc
594
- type="type"
595
- typeName="CollectionResult"
596
- typeLinks={{
597
- Collection: '/reference/graphql-api/admin/object-types#collection',
598
- Int: '/reference/graphql-api/admin/object-types#int',
599
- }}
600
- >
601
- {`"""
602
- Which Collections are present in the products returned
603
- by the search, and in what quantity.
604
- """
605
- type CollectionResult {
606
- collection: Collection!
607
- count: Int!
608
- }`}
609
- </GraphQLDoc>
610
-
611
- ## CollectionTranslation {#collectiontranslation}
612
-
613
- <GraphQLDoc
614
- type="type"
615
- typeName="CollectionTranslation"
616
- typeLinks={{
617
- ID: '/reference/graphql-api/admin/object-types#id',
618
- DateTime: '/reference/graphql-api/admin/object-types#datetime',
619
- LanguageCode: '/reference/graphql-api/admin/enums#languagecode',
620
- String: '/reference/graphql-api/admin/object-types#string',
621
- }}
622
- >
623
- {`type CollectionTranslation {
624
- id: ID!
625
- createdAt: DateTime!
626
- updatedAt: DateTime!
627
- languageCode: LanguageCode!
628
- name: String!
629
- slug: String!
630
- description: String!
631
- }`}
632
- </GraphQLDoc>
633
-
634
- ## ConfigArg {#configarg}
635
-
636
- <GraphQLDoc
637
- type="type"
638
- typeName="ConfigArg"
639
- typeLinks={{
640
- String: '/reference/graphql-api/admin/object-types#string',
641
- }}
642
- >
643
- {`type ConfigArg {
644
- name: String!
645
- value: String!
646
- }`}
647
- </GraphQLDoc>
648
-
649
- ## ConfigArgDefinition {#configargdefinition}
650
-
651
- <GraphQLDoc
652
- type="type"
653
- typeName="ConfigArgDefinition"
654
- typeLinks={{
655
- String: '/reference/graphql-api/admin/object-types#string',
656
- Boolean: '/reference/graphql-api/admin/object-types#boolean',
657
- JSON: '/reference/graphql-api/admin/object-types#json',
658
- }}
659
- >
660
- {`type ConfigArgDefinition {
661
- name: String!
662
- type: String!
663
- list: Boolean!
664
- required: Boolean!
665
- defaultValue: JSON
666
- label: String
667
- description: String
668
- ui: JSON
669
- }`}
670
- </GraphQLDoc>
671
-
672
- ## ConfigurableOperation {#configurableoperation}
673
-
674
- <GraphQLDoc
675
- type="type"
676
- typeName="ConfigurableOperation"
677
- typeLinks={{
678
- String: '/reference/graphql-api/admin/object-types#string',
679
- ConfigArg: '/reference/graphql-api/admin/object-types#configarg',
680
- }}
681
- >
682
- {`type ConfigurableOperation {
683
- code: String!
684
- args: [ConfigArg!]!
685
- }`}
686
- </GraphQLDoc>
687
-
688
- ## ConfigurableOperationDefinition {#configurableoperationdefinition}
689
-
690
- <GraphQLDoc
691
- type="type"
692
- typeName="ConfigurableOperationDefinition"
693
- typeLinks={{
694
- String: '/reference/graphql-api/admin/object-types#string',
695
- ConfigArgDefinition: '/reference/graphql-api/admin/object-types#configargdefinition',
696
- }}
697
- >
698
- {`type ConfigurableOperationDefinition {
699
- code: String!
700
- args: [ConfigArgDefinition!]!
701
- description: String!
702
- }`}
703
- </GraphQLDoc>
704
-
705
- ## Coordinate {#coordinate}
706
-
707
- <GraphQLDoc
708
- type="type"
709
- typeName="Coordinate"
710
- typeLinks={{
711
- Float: '/reference/graphql-api/admin/object-types#float',
712
- }}
713
- >
714
- {`type Coordinate {
715
- x: Float!
716
- y: Float!
717
- }`}
718
- </GraphQLDoc>
719
-
720
- ## Country {#country}
721
-
722
- <GraphQLDoc
723
- type="type"
724
- typeName="Country"
725
- typeLinks={{
726
- ID: '/reference/graphql-api/admin/object-types#id',
727
- DateTime: '/reference/graphql-api/admin/object-types#datetime',
728
- LanguageCode: '/reference/graphql-api/admin/enums#languagecode',
729
- String: '/reference/graphql-api/admin/object-types#string',
730
- Boolean: '/reference/graphql-api/admin/object-types#boolean',
731
- Region: '/reference/graphql-api/admin/object-types#region',
732
- RegionTranslation: '/reference/graphql-api/admin/object-types#regiontranslation',
733
- JSON: '/reference/graphql-api/admin/object-types#json',
734
- }}
735
- >
736
- {`"""
737
- A Country of the world which your shop operates in.
738
-
739
- 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
740
- \`UpdateAddressInput\` and \`CreateAddressInput\` to specify the country.
741
- """
742
- type Country {
743
- id: ID!
744
- createdAt: DateTime!
745
- updatedAt: DateTime!
746
- languageCode: LanguageCode!
747
- code: String!
748
- type: String!
749
- name: String!
750
- enabled: Boolean!
751
- parent: Region
752
- parentId: ID
753
- translations: [RegionTranslation!]!
754
- customFields: JSON
755
- }`}
756
- </GraphQLDoc>
757
-
758
- ## CountryList {#countrylist}
759
-
760
- <GraphQLDoc
761
- type="type"
762
- typeName="CountryList"
763
- typeLinks={{
764
- Country: '/reference/graphql-api/admin/object-types#country',
765
- Int: '/reference/graphql-api/admin/object-types#int',
766
- }}
767
- >
768
- {`type CountryList {
769
- items: [Country!]!
770
- totalItems: Int!
771
- }`}
772
- </GraphQLDoc>
773
-
774
- ## CouponCodeExpiredError {#couponcodeexpirederror}
775
-
776
- <GraphQLDoc
777
- type="type"
778
- typeName="CouponCodeExpiredError"
779
- typeLinks={{
780
- ErrorCode: '/reference/graphql-api/admin/enums#errorcode',
781
- String: '/reference/graphql-api/admin/object-types#string',
782
- }}
783
- >
784
- {`"""Returned if the provided coupon code is invalid"""
785
- type CouponCodeExpiredError {
786
- errorCode: ErrorCode!
787
- message: String!
788
- couponCode: String!
789
- }`}
790
- </GraphQLDoc>
791
-
792
- ## CouponCodeInvalidError {#couponcodeinvaliderror}
793
-
794
- <GraphQLDoc
795
- type="type"
796
- typeName="CouponCodeInvalidError"
797
- typeLinks={{
798
- ErrorCode: '/reference/graphql-api/admin/enums#errorcode',
799
- String: '/reference/graphql-api/admin/object-types#string',
800
- }}
801
- >
802
- {`"""Returned if the provided coupon code is invalid"""
803
- type CouponCodeInvalidError {
804
- errorCode: ErrorCode!
805
- message: String!
806
- couponCode: String!
807
- }`}
808
- </GraphQLDoc>
809
-
810
- ## CouponCodeLimitError {#couponcodelimiterror}
811
-
812
- <GraphQLDoc
813
- type="type"
814
- typeName="CouponCodeLimitError"
815
- typeLinks={{
816
- ErrorCode: '/reference/graphql-api/admin/enums#errorcode',
817
- String: '/reference/graphql-api/admin/object-types#string',
818
- Int: '/reference/graphql-api/admin/object-types#int',
819
- }}
820
- >
821
- {`"""Returned if the provided coupon code is invalid"""
822
- type CouponCodeLimitError {
823
- errorCode: ErrorCode!
824
- message: String!
825
- couponCode: String!
826
- limit: Int!
827
- }`}
828
- </GraphQLDoc>
829
-
830
- ## CreateAssetResult {#createassetresult}
831
-
832
- <GraphQLDoc
833
- type="union"
834
- typeName="CreateAssetResult"
835
- typeLinks={{
836
- Asset: '/reference/graphql-api/admin/object-types#asset',
837
- MimeTypeError: '/reference/graphql-api/admin/object-types#mimetypeerror',
838
- }}
839
- >
840
- {`union CreateAssetResult = Asset | MimeTypeError`}
841
- </GraphQLDoc>
842
-
843
- ## CreateChannelResult {#createchannelresult}
844
-
845
- <GraphQLDoc
846
- type="union"
847
- typeName="CreateChannelResult"
848
- typeLinks={{
849
- Channel: '/reference/graphql-api/admin/object-types#channel',
850
- LanguageNotAvailableError: '/reference/graphql-api/admin/object-types#languagenotavailableerror',
851
- }}
852
- >
853
- {`union CreateChannelResult = Channel | LanguageNotAvailableError`}
854
- </GraphQLDoc>
855
-
856
- ## CreateCustomerResult {#createcustomerresult}
857
-
858
- <GraphQLDoc
859
- type="union"
860
- typeName="CreateCustomerResult"
861
- typeLinks={{
862
- Customer: '/reference/graphql-api/admin/object-types#customer',
863
- EmailAddressConflictError: '/reference/graphql-api/admin/object-types#emailaddressconflicterror',
864
- }}
865
- >
866
- {`union CreateCustomerResult = Customer | EmailAddressConflictError`}
867
- </GraphQLDoc>
868
-
869
- ## CreateFulfillmentError {#createfulfillmenterror}
870
-
871
- <GraphQLDoc
872
- type="type"
873
- typeName="CreateFulfillmentError"
874
- typeLinks={{
875
- ErrorCode: '/reference/graphql-api/admin/enums#errorcode',
876
- String: '/reference/graphql-api/admin/object-types#string',
877
- }}
878
- >
879
- {`"""Returned if an error is thrown in a FulfillmentHandler's createFulfillment method"""
880
- type CreateFulfillmentError {
881
- errorCode: ErrorCode!
882
- message: String!
883
- fulfillmentHandlerError: String!
884
- }`}
885
- </GraphQLDoc>
886
-
887
- ## CreatePromotionResult {#createpromotionresult}
888
-
889
- <GraphQLDoc
890
- type="union"
891
- typeName="CreatePromotionResult"
892
- typeLinks={{
893
- Promotion: '/reference/graphql-api/admin/object-types#promotion',
894
- MissingConditionsError: '/reference/graphql-api/admin/object-types#missingconditionserror',
895
- }}
896
- >
897
- {`union CreatePromotionResult = Promotion | MissingConditionsError`}
898
- </GraphQLDoc>
899
-
900
- ## CurrentUser {#currentuser}
901
-
902
- <GraphQLDoc
903
- type="type"
904
- typeName="CurrentUser"
905
- typeLinks={{
906
- ID: '/reference/graphql-api/admin/object-types#id',
907
- String: '/reference/graphql-api/admin/object-types#string',
908
- CurrentUserChannel: '/reference/graphql-api/admin/object-types#currentuserchannel',
909
- }}
910
- >
911
- {`type CurrentUser {
912
- id: ID!
913
- identifier: String!
914
- channels: [CurrentUserChannel!]!
915
- }`}
916
- </GraphQLDoc>
917
-
918
- ## CurrentUserChannel {#currentuserchannel}
919
-
920
- <GraphQLDoc
921
- type="type"
922
- typeName="CurrentUserChannel"
923
- typeLinks={{
924
- ID: '/reference/graphql-api/admin/object-types#id',
925
- String: '/reference/graphql-api/admin/object-types#string',
926
- Permission: '/reference/graphql-api/admin/enums#permission',
927
- }}
928
- >
929
- {`type CurrentUserChannel {
930
- id: ID!
931
- token: String!
932
- code: String!
933
- permissions: [Permission!]!
934
- }`}
935
- </GraphQLDoc>
936
-
937
- ## CustomFieldConfig {#customfieldconfig}
938
-
939
- <GraphQLDoc
940
- type="union"
941
- typeName="CustomFieldConfig"
942
- typeLinks={{
943
- StringCustomFieldConfig: '/reference/graphql-api/admin/object-types#stringcustomfieldconfig',
944
- LocaleStringCustomFieldConfig: '/reference/graphql-api/admin/object-types#localestringcustomfieldconfig',
945
- IntCustomFieldConfig: '/reference/graphql-api/admin/object-types#intcustomfieldconfig',
946
- FloatCustomFieldConfig: '/reference/graphql-api/admin/object-types#floatcustomfieldconfig',
947
- BooleanCustomFieldConfig: '/reference/graphql-api/admin/object-types#booleancustomfieldconfig',
948
- DateTimeCustomFieldConfig: '/reference/graphql-api/admin/object-types#datetimecustomfieldconfig',
949
- RelationCustomFieldConfig: '/reference/graphql-api/admin/object-types#relationcustomfieldconfig',
950
- TextCustomFieldConfig: '/reference/graphql-api/admin/object-types#textcustomfieldconfig',
951
- LocaleTextCustomFieldConfig: '/reference/graphql-api/admin/object-types#localetextcustomfieldconfig',
952
- StructCustomFieldConfig: '/reference/graphql-api/admin/object-types#structcustomfieldconfig',
953
- }}
954
- >
955
- {`union CustomFieldConfig = StringCustomFieldConfig | LocaleStringCustomFieldConfig | IntCustomFieldConfig | FloatCustomFieldConfig | BooleanCustomFieldConfig | DateTimeCustomFieldConfig | RelationCustomFieldConfig | TextCustomFieldConfig | LocaleTextCustomFieldConfig | StructCustomFieldConfig`}
956
- </GraphQLDoc>
957
-
958
- ## CustomFields {#customfields}
959
-
960
- <GraphQLDoc
961
- type="type"
962
- typeName="CustomFields"
963
- typeLinks={{
964
- CustomFieldConfig: '/reference/graphql-api/admin/object-types#customfieldconfig',
965
- }}
966
- >
967
- {`"""
968
- This type is deprecated in v2.2 in favor of the EntityCustomFields type,
969
- which allows custom fields to be defined on user-supplied entities.
970
- """
971
- type CustomFields {
972
- Address: [CustomFieldConfig!]!
973
- Administrator: [CustomFieldConfig!]!
974
- Asset: [CustomFieldConfig!]!
975
- Channel: [CustomFieldConfig!]!
976
- Collection: [CustomFieldConfig!]!
977
- Customer: [CustomFieldConfig!]!
978
- CustomerGroup: [CustomFieldConfig!]!
979
- Facet: [CustomFieldConfig!]!
980
- FacetValue: [CustomFieldConfig!]!
981
- Fulfillment: [CustomFieldConfig!]!
982
- GlobalSettings: [CustomFieldConfig!]!
983
- HistoryEntry: [CustomFieldConfig!]!
984
- Order: [CustomFieldConfig!]!
985
- OrderLine: [CustomFieldConfig!]!
986
- Payment: [CustomFieldConfig!]!
987
- PaymentMethod: [CustomFieldConfig!]!
988
- Product: [CustomFieldConfig!]!
989
- ProductOption: [CustomFieldConfig!]!
990
- ProductOptionGroup: [CustomFieldConfig!]!
991
- ProductVariant: [CustomFieldConfig!]!
992
- ProductVariantPrice: [CustomFieldConfig!]!
993
- Promotion: [CustomFieldConfig!]!
994
- Refund: [CustomFieldConfig!]!
995
- Region: [CustomFieldConfig!]!
996
- Seller: [CustomFieldConfig!]!
997
- Session: [CustomFieldConfig!]!
998
- ShippingLine: [CustomFieldConfig!]!
999
- ShippingMethod: [CustomFieldConfig!]!
1000
- StockLevel: [CustomFieldConfig!]!
1001
- StockLocation: [CustomFieldConfig!]!
1002
- StockMovement: [CustomFieldConfig!]!
1003
- TaxCategory: [CustomFieldConfig!]!
1004
- TaxRate: [CustomFieldConfig!]!
1005
- User: [CustomFieldConfig!]!
1006
- Zone: [CustomFieldConfig!]!
1007
- }`}
1008
- </GraphQLDoc>
1009
-
1010
- ## Customer {#customer}
1011
-
1012
- <GraphQLDoc
1013
- type="type"
1014
- typeName="Customer"
1015
- typeLinks={{
1016
- CustomerGroup: '/reference/graphql-api/admin/object-types#customergroup',
1017
- HistoryEntryList: '/reference/graphql-api/admin/object-types#historyentrylist',
1018
- HistoryEntryListOptions: '/reference/graphql-api/admin/input-types#historyentrylistoptions',
1019
- ID: '/reference/graphql-api/admin/object-types#id',
1020
- DateTime: '/reference/graphql-api/admin/object-types#datetime',
1021
- String: '/reference/graphql-api/admin/object-types#string',
1022
- Address: '/reference/graphql-api/admin/object-types#address',
1023
- OrderList: '/reference/graphql-api/admin/object-types#orderlist',
1024
- OrderListOptions: '/reference/graphql-api/admin/input-types#orderlistoptions',
1025
- User: '/reference/graphql-api/admin/object-types#user',
1026
- JSON: '/reference/graphql-api/admin/object-types#json',
1027
- }}
1028
- >
1029
- {`type Customer {
1030
- groups: [CustomerGroup!]!
1031
- history(options: HistoryEntryListOptions): HistoryEntryList!
1032
- id: ID!
1033
- createdAt: DateTime!
1034
- updatedAt: DateTime!
1035
- title: String
1036
- firstName: String!
1037
- lastName: String!
1038
- phoneNumber: String
1039
- emailAddress: String!
1040
- addresses: [Address!]
1041
- orders(options: OrderListOptions): OrderList!
1042
- user: User
1043
- customFields: JSON
1044
- }`}
1045
- </GraphQLDoc>
1046
-
1047
- ## CustomerGroup {#customergroup}
1048
-
1049
- <GraphQLDoc
1050
- type="type"
1051
- typeName="CustomerGroup"
1052
- typeLinks={{
1053
- ID: '/reference/graphql-api/admin/object-types#id',
1054
- DateTime: '/reference/graphql-api/admin/object-types#datetime',
1055
- String: '/reference/graphql-api/admin/object-types#string',
1056
- CustomerList: '/reference/graphql-api/admin/object-types#customerlist',
1057
- CustomerListOptions: '/reference/graphql-api/admin/input-types#customerlistoptions',
1058
- JSON: '/reference/graphql-api/admin/object-types#json',
1059
- }}
1060
- >
1061
- {`type CustomerGroup {
1062
- id: ID!
1063
- createdAt: DateTime!
1064
- updatedAt: DateTime!
1065
- name: String!
1066
- customers(options: CustomerListOptions): CustomerList!
1067
- customFields: JSON
1068
- }`}
1069
- </GraphQLDoc>
1070
-
1071
- ## CustomerGroupList {#customergrouplist}
1072
-
1073
- <GraphQLDoc
1074
- type="type"
1075
- typeName="CustomerGroupList"
1076
- typeLinks={{
1077
- CustomerGroup: '/reference/graphql-api/admin/object-types#customergroup',
1078
- Int: '/reference/graphql-api/admin/object-types#int',
1079
- }}
1080
- >
1081
- {`type CustomerGroupList {
1082
- items: [CustomerGroup!]!
1083
- totalItems: Int!
1084
- }`}
1085
- </GraphQLDoc>
1086
-
1087
- ## CustomerList {#customerlist}
1088
-
1089
- <GraphQLDoc
1090
- type="type"
1091
- typeName="CustomerList"
1092
- typeLinks={{
1093
- Customer: '/reference/graphql-api/admin/object-types#customer',
1094
- Int: '/reference/graphql-api/admin/object-types#int',
1095
- }}
1096
- >
1097
- {`type CustomerList {
1098
- items: [Customer!]!
1099
- totalItems: Int!
1100
- }`}
1101
- </GraphQLDoc>
1102
-
1103
- ## DateTime {#datetime}
1104
-
1105
- <GraphQLDoc
1106
- type="scalar"
1107
- typeName="DateTime"
1108
- typeLinks={{}}
1109
- >
1110
- {`"""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."""
1111
- scalar DateTime`}
1112
- </GraphQLDoc>
1113
-
1114
- ## DateTimeCustomFieldConfig {#datetimecustomfieldconfig}
1115
-
1116
- <GraphQLDoc
1117
- type="type"
1118
- typeName="DateTimeCustomFieldConfig"
1119
- typeLinks={{
1120
- String: '/reference/graphql-api/admin/object-types#string',
1121
- Boolean: '/reference/graphql-api/admin/object-types#boolean',
1122
- LocalizedString: '/reference/graphql-api/admin/object-types#localizedstring',
1123
- Permission: '/reference/graphql-api/admin/enums#permission',
1124
- Int: '/reference/graphql-api/admin/object-types#int',
1125
- JSON: '/reference/graphql-api/admin/object-types#json',
1126
- }}
1127
- >
1128
- {`"""
1129
- Expects the same validation formats as the \`<input type="datetime-local">\` HTML element.
1130
- See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/datetime-local#Additional_attributes
1131
- """
1132
- type DateTimeCustomFieldConfig {
1133
- name: String!
1134
- type: String!
1135
- list: Boolean!
1136
- label: [LocalizedString!]
1137
- description: [LocalizedString!]
1138
- readonly: Boolean
1139
- internal: Boolean
1140
- nullable: Boolean
1141
- requiresPermission: [Permission!]
1142
- deprecated: Boolean
1143
- deprecationReason: String
1144
- min: String
1145
- max: String
1146
- step: Int
1147
- ui: JSON
1148
- }`}
1149
- </GraphQLDoc>
1150
-
1151
- ## DateTimeStructFieldConfig {#datetimestructfieldconfig}
1152
-
1153
- <GraphQLDoc
1154
- type="type"
1155
- typeName="DateTimeStructFieldConfig"
1156
- typeLinks={{
1157
- String: '/reference/graphql-api/admin/object-types#string',
1158
- Boolean: '/reference/graphql-api/admin/object-types#boolean',
1159
- LocalizedString: '/reference/graphql-api/admin/object-types#localizedstring',
1160
- Int: '/reference/graphql-api/admin/object-types#int',
1161
- JSON: '/reference/graphql-api/admin/object-types#json',
1162
- }}
1163
- >
1164
- {`"""
1165
- Expects the same validation formats as the \`<input type="datetime-local">\` HTML element.
1166
- See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/datetime-local#Additional_attributes
1167
- """
1168
- type DateTimeStructFieldConfig {
1169
- name: String!
1170
- type: String!
1171
- list: Boolean!
1172
- label: [LocalizedString!]
1173
- description: [LocalizedString!]
1174
- min: String
1175
- max: String
1176
- step: Int
1177
- ui: JSON
1178
- }`}
1179
- </GraphQLDoc>
1180
-
1181
- ## DeletionResponse {#deletionresponse}
1182
-
1183
- <GraphQLDoc
1184
- type="type"
1185
- typeName="DeletionResponse"
1186
- typeLinks={{
1187
- DeletionResult: '/reference/graphql-api/admin/enums#deletionresult',
1188
- String: '/reference/graphql-api/admin/object-types#string',
1189
- }}
1190
- >
1191
- {`type DeletionResponse {
1192
- result: DeletionResult!
1193
- message: String
1194
- }`}
1195
- </GraphQLDoc>
1196
-
1197
- ## Discount {#discount}
1198
-
1199
- <GraphQLDoc
1200
- type="type"
1201
- typeName="Discount"
1202
- typeLinks={{
1203
- String: '/reference/graphql-api/admin/object-types#string',
1204
- AdjustmentType: '/reference/graphql-api/admin/enums#adjustmenttype',
1205
- Money: '/reference/graphql-api/admin/object-types#money',
1206
- }}
1207
- >
1208
- {`type Discount {
1209
- adjustmentSource: String!
1210
- type: AdjustmentType!
1211
- description: String!
1212
- amount: Money!
1213
- amountWithTax: Money!
1214
- }`}
1215
- </GraphQLDoc>
1216
-
1217
- ## DuplicateEntityError {#duplicateentityerror}
1218
-
1219
- <GraphQLDoc
1220
- type="type"
1221
- typeName="DuplicateEntityError"
1222
- typeLinks={{
1223
- ErrorCode: '/reference/graphql-api/admin/enums#errorcode',
1224
- String: '/reference/graphql-api/admin/object-types#string',
1225
- }}
1226
- >
1227
- {`type DuplicateEntityError {
1228
- errorCode: ErrorCode!
1229
- message: String!
1230
- duplicationError: String!
1231
- }`}
1232
- </GraphQLDoc>
1233
-
1234
- ## DuplicateEntityResult {#duplicateentityresult}
1235
-
1236
- <GraphQLDoc
1237
- type="union"
1238
- typeName="DuplicateEntityResult"
1239
- typeLinks={{
1240
- DuplicateEntitySuccess: '/reference/graphql-api/admin/object-types#duplicateentitysuccess',
1241
- DuplicateEntityError: '/reference/graphql-api/admin/object-types#duplicateentityerror',
1242
- }}
1243
- >
1244
- {`union DuplicateEntityResult = DuplicateEntitySuccess | DuplicateEntityError`}
1245
- </GraphQLDoc>
1246
-
1247
- ## DuplicateEntitySuccess {#duplicateentitysuccess}
1248
-
1249
- <GraphQLDoc
1250
- type="type"
1251
- typeName="DuplicateEntitySuccess"
1252
- typeLinks={{
1253
- ID: '/reference/graphql-api/admin/object-types#id',
1254
- }}
1255
- >
1256
- {`type DuplicateEntitySuccess {
1257
- newEntityId: ID!
1258
- }`}
1259
- </GraphQLDoc>
1260
-
1261
- ## EmailAddressConflictError {#emailaddressconflicterror}
1262
-
1263
- <GraphQLDoc
1264
- type="type"
1265
- typeName="EmailAddressConflictError"
1266
- typeLinks={{
1267
- ErrorCode: '/reference/graphql-api/admin/enums#errorcode',
1268
- String: '/reference/graphql-api/admin/object-types#string',
1269
- }}
1270
- >
1271
- {`"""Returned when attempting to create a Customer with an email address already registered to an existing User."""
1272
- type EmailAddressConflictError {
1273
- errorCode: ErrorCode!
1274
- message: String!
1275
- }`}
1276
- </GraphQLDoc>
1277
-
1278
- ## EmptyOrderLineSelectionError {#emptyorderlineselectionerror}
1279
-
1280
- <GraphQLDoc
1281
- type="type"
1282
- typeName="EmptyOrderLineSelectionError"
1283
- typeLinks={{
1284
- ErrorCode: '/reference/graphql-api/admin/enums#errorcode',
1285
- String: '/reference/graphql-api/admin/object-types#string',
1286
- }}
1287
- >
1288
- {`"""Returned if no OrderLines have been specified for the operation"""
1289
- type EmptyOrderLineSelectionError {
1290
- errorCode: ErrorCode!
1291
- message: String!
1292
- }`}
1293
- </GraphQLDoc>
1294
-
1295
- ## EntityCustomFields {#entitycustomfields}
1296
-
1297
- <GraphQLDoc
1298
- type="type"
1299
- typeName="EntityCustomFields"
1300
- typeLinks={{
1301
- String: '/reference/graphql-api/admin/object-types#string',
1302
- CustomFieldConfig: '/reference/graphql-api/admin/object-types#customfieldconfig',
1303
- }}
1304
- >
1305
- {`type EntityCustomFields {
1306
- entityName: String!
1307
- customFields: [CustomFieldConfig!]!
1308
- }`}
1309
- </GraphQLDoc>
1310
-
1311
- ## EntityDuplicatorDefinition {#entityduplicatordefinition}
1312
-
1313
- <GraphQLDoc
1314
- type="type"
1315
- typeName="EntityDuplicatorDefinition"
1316
- typeLinks={{
1317
- String: '/reference/graphql-api/admin/object-types#string',
1318
- ConfigArgDefinition: '/reference/graphql-api/admin/object-types#configargdefinition',
1319
- Permission: '/reference/graphql-api/admin/enums#permission',
1320
- }}
1321
- >
1322
- {`type EntityDuplicatorDefinition {
1323
- code: String!
1324
- args: [ConfigArgDefinition!]!
1325
- description: String!
1326
- forEntities: [String!]!
1327
- requiresPermission: [Permission!]!
1328
- }`}
1329
- </GraphQLDoc>
1330
-
1331
- ## Facet {#facet}
1332
-
1333
- <GraphQLDoc
1334
- type="type"
1335
- typeName="Facet"
1336
- typeLinks={{
1337
- Boolean: '/reference/graphql-api/admin/object-types#boolean',
1338
- ID: '/reference/graphql-api/admin/object-types#id',
1339
- DateTime: '/reference/graphql-api/admin/object-types#datetime',
1340
- LanguageCode: '/reference/graphql-api/admin/enums#languagecode',
1341
- String: '/reference/graphql-api/admin/object-types#string',
1342
- FacetValue: '/reference/graphql-api/admin/object-types#facetvalue',
1343
- FacetValueList: '/reference/graphql-api/admin/object-types#facetvaluelist',
1344
- FacetValueListOptions: '/reference/graphql-api/admin/input-types#facetvaluelistoptions',
1345
- FacetTranslation: '/reference/graphql-api/admin/object-types#facettranslation',
1346
- JSON: '/reference/graphql-api/admin/object-types#json',
1347
- }}
1348
- >
1349
- {`type Facet {
1350
- isPrivate: Boolean!
1351
- id: ID!
1352
- createdAt: DateTime!
1353
- updatedAt: DateTime!
1354
- languageCode: LanguageCode!
1355
- name: String!
1356
- code: String!
1357
- values: [FacetValue!]!
1358
- """Returns a paginated, sortable, filterable list of the Facet's values. Added in v2.1.0."""
1359
- valueList(options: FacetValueListOptions): FacetValueList!
1360
- translations: [FacetTranslation!]!
1361
- customFields: JSON
1362
- }`}
1363
- </GraphQLDoc>
1364
-
1365
- ## FacetInUseError {#facetinuseerror}
1366
-
1367
- <GraphQLDoc
1368
- type="type"
1369
- typeName="FacetInUseError"
1370
- typeLinks={{
1371
- ErrorCode: '/reference/graphql-api/admin/enums#errorcode',
1372
- String: '/reference/graphql-api/admin/object-types#string',
1373
- Int: '/reference/graphql-api/admin/object-types#int',
1374
- }}
1375
- >
1376
- {`type FacetInUseError {
1377
- errorCode: ErrorCode!
1378
- message: String!
1379
- facetCode: String!
1380
- productCount: Int!
1381
- variantCount: Int!
1382
- }`}
1383
- </GraphQLDoc>
1384
-
1385
- ## FacetList {#facetlist}
1386
-
1387
- <GraphQLDoc
1388
- type="type"
1389
- typeName="FacetList"
1390
- typeLinks={{
1391
- Facet: '/reference/graphql-api/admin/object-types#facet',
1392
- Int: '/reference/graphql-api/admin/object-types#int',
1393
- }}
1394
- >
1395
- {`type FacetList {
1396
- items: [Facet!]!
1397
- totalItems: Int!
1398
- }`}
1399
- </GraphQLDoc>
1400
-
1401
- ## FacetTranslation {#facettranslation}
1402
-
1403
- <GraphQLDoc
1404
- type="type"
1405
- typeName="FacetTranslation"
1406
- typeLinks={{
1407
- ID: '/reference/graphql-api/admin/object-types#id',
1408
- DateTime: '/reference/graphql-api/admin/object-types#datetime',
1409
- LanguageCode: '/reference/graphql-api/admin/enums#languagecode',
1410
- String: '/reference/graphql-api/admin/object-types#string',
1411
- }}
1412
- >
1413
- {`type FacetTranslation {
1414
- id: ID!
1415
- createdAt: DateTime!
1416
- updatedAt: DateTime!
1417
- languageCode: LanguageCode!
1418
- name: String!
1419
- }`}
1420
- </GraphQLDoc>
1421
-
1422
- ## FacetValue {#facetvalue}
1423
-
1424
- <GraphQLDoc
1425
- type="type"
1426
- typeName="FacetValue"
1427
- typeLinks={{
1428
- ID: '/reference/graphql-api/admin/object-types#id',
1429
- DateTime: '/reference/graphql-api/admin/object-types#datetime',
1430
- LanguageCode: '/reference/graphql-api/admin/enums#languagecode',
1431
- Facet: '/reference/graphql-api/admin/object-types#facet',
1432
- String: '/reference/graphql-api/admin/object-types#string',
1433
- FacetValueTranslation: '/reference/graphql-api/admin/object-types#facetvaluetranslation',
1434
- JSON: '/reference/graphql-api/admin/object-types#json',
1435
- }}
1436
- >
1437
- {`type FacetValue {
1438
- id: ID!
1439
- createdAt: DateTime!
1440
- updatedAt: DateTime!
1441
- languageCode: LanguageCode!
1442
- facet: Facet!
1443
- facetId: ID!
1444
- name: String!
1445
- code: String!
1446
- translations: [FacetValueTranslation!]!
1447
- customFields: JSON
1448
- }`}
1449
- </GraphQLDoc>
1450
-
1451
- ## FacetValueList {#facetvaluelist}
1452
-
1453
- <GraphQLDoc
1454
- type="type"
1455
- typeName="FacetValueList"
1456
- typeLinks={{
1457
- FacetValue: '/reference/graphql-api/admin/object-types#facetvalue',
1458
- Int: '/reference/graphql-api/admin/object-types#int',
1459
- }}
1460
- >
1461
- {`type FacetValueList {
1462
- items: [FacetValue!]!
1463
- totalItems: Int!
1464
- }`}
1465
- </GraphQLDoc>
1466
-
1467
- ## FacetValueResult {#facetvalueresult}
1468
-
1469
- <GraphQLDoc
1470
- type="type"
1471
- typeName="FacetValueResult"
1472
- typeLinks={{
1473
- FacetValue: '/reference/graphql-api/admin/object-types#facetvalue',
1474
- Int: '/reference/graphql-api/admin/object-types#int',
1475
- }}
1476
- >
1477
- {`"""
1478
- Which FacetValues are present in the products returned
1479
- by the search, and in what quantity.
1480
- """
1481
- type FacetValueResult {
1482
- facetValue: FacetValue!
1483
- count: Int!
1484
- }`}
1485
- </GraphQLDoc>
1486
-
1487
- ## FacetValueTranslation {#facetvaluetranslation}
1488
-
1489
- <GraphQLDoc
1490
- type="type"
1491
- typeName="FacetValueTranslation"
1492
- typeLinks={{
1493
- ID: '/reference/graphql-api/admin/object-types#id',
1494
- DateTime: '/reference/graphql-api/admin/object-types#datetime',
1495
- LanguageCode: '/reference/graphql-api/admin/enums#languagecode',
1496
- String: '/reference/graphql-api/admin/object-types#string',
1497
- }}
1498
- >
1499
- {`type FacetValueTranslation {
1500
- id: ID!
1501
- createdAt: DateTime!
1502
- updatedAt: DateTime!
1503
- languageCode: LanguageCode!
1504
- name: String!
1505
- }`}
1506
- </GraphQLDoc>
1507
-
1508
- ## Float {#float}
1509
-
1510
- <GraphQLDoc
1511
- type="scalar"
1512
- typeName="Float"
1513
- typeLinks={{}}
1514
- >
1515
- {`"""The \`Float\` scalar type represents signed double-precision fractional values as specified by [IEEE 754](https://en.wikipedia.org/wiki/IEEE_floating_point)."""
1516
- scalar Float`}
1517
- </GraphQLDoc>
1518
-
1519
- ## FloatCustomFieldConfig {#floatcustomfieldconfig}
1520
-
1521
- <GraphQLDoc
1522
- type="type"
1523
- typeName="FloatCustomFieldConfig"
1524
- typeLinks={{
1525
- String: '/reference/graphql-api/admin/object-types#string',
1526
- Boolean: '/reference/graphql-api/admin/object-types#boolean',
1527
- LocalizedString: '/reference/graphql-api/admin/object-types#localizedstring',
1528
- Permission: '/reference/graphql-api/admin/enums#permission',
1529
- Float: '/reference/graphql-api/admin/object-types#float',
1530
- JSON: '/reference/graphql-api/admin/object-types#json',
1531
- }}
1532
- >
1533
- {`type FloatCustomFieldConfig {
1534
- name: String!
1535
- type: String!
1536
- list: Boolean!
1537
- label: [LocalizedString!]
1538
- description: [LocalizedString!]
1539
- readonly: Boolean
1540
- internal: Boolean
1541
- nullable: Boolean
1542
- requiresPermission: [Permission!]
1543
- deprecated: Boolean
1544
- deprecationReason: String
1545
- min: Float
1546
- max: Float
1547
- step: Float
1548
- ui: JSON
1549
- }`}
1550
- </GraphQLDoc>
1551
-
1552
- ## FloatStructFieldConfig {#floatstructfieldconfig}
1553
-
1554
- <GraphQLDoc
1555
- type="type"
1556
- typeName="FloatStructFieldConfig"
1557
- typeLinks={{
1558
- String: '/reference/graphql-api/admin/object-types#string',
1559
- Boolean: '/reference/graphql-api/admin/object-types#boolean',
1560
- LocalizedString: '/reference/graphql-api/admin/object-types#localizedstring',
1561
- Float: '/reference/graphql-api/admin/object-types#float',
1562
- JSON: '/reference/graphql-api/admin/object-types#json',
1563
- }}
1564
- >
1565
- {`type FloatStructFieldConfig {
1566
- name: String!
1567
- type: String!
1568
- list: Boolean!
1569
- label: [LocalizedString!]
1570
- description: [LocalizedString!]
1571
- min: Float
1572
- max: Float
1573
- step: Float
1574
- ui: JSON
1575
- }`}
1576
- </GraphQLDoc>
1577
-
1578
- ## Fulfillment {#fulfillment}
1579
-
1580
- <GraphQLDoc
1581
- type="type"
1582
- typeName="Fulfillment"
1583
- typeLinks={{
1584
- String: '/reference/graphql-api/admin/object-types#string',
1585
- ID: '/reference/graphql-api/admin/object-types#id',
1586
- DateTime: '/reference/graphql-api/admin/object-types#datetime',
1587
- FulfillmentLine: '/reference/graphql-api/admin/object-types#fulfillmentline',
1588
- JSON: '/reference/graphql-api/admin/object-types#json',
1589
- }}
1590
- >
1591
- {`type Fulfillment {
1592
- nextStates: [String!]!
1593
- id: ID!
1594
- createdAt: DateTime!
1595
- updatedAt: DateTime!
1596
- lines: [FulfillmentLine!]!
1597
- summary: [FulfillmentLine!]!
1598
- state: String!
1599
- method: String!
1600
- trackingCode: String
1601
- customFields: JSON
1602
- }`}
1603
- </GraphQLDoc>
1604
-
1605
- ## FulfillmentLine {#fulfillmentline}
1606
-
1607
- <GraphQLDoc
1608
- type="type"
1609
- typeName="FulfillmentLine"
1610
- typeLinks={{
1611
- OrderLine: '/reference/graphql-api/admin/object-types#orderline',
1612
- ID: '/reference/graphql-api/admin/object-types#id',
1613
- Int: '/reference/graphql-api/admin/object-types#int',
1614
- Fulfillment: '/reference/graphql-api/admin/object-types#fulfillment',
1615
- }}
1616
- >
1617
- {`type FulfillmentLine {
1618
- orderLine: OrderLine!
1619
- orderLineId: ID!
1620
- quantity: Int!
1621
- fulfillment: Fulfillment!
1622
- fulfillmentId: ID!
1623
- }`}
1624
- </GraphQLDoc>
1625
-
1626
- ## FulfillmentStateTransitionError {#fulfillmentstatetransitionerror}
1627
-
1628
- <GraphQLDoc
1629
- type="type"
1630
- typeName="FulfillmentStateTransitionError"
1631
- typeLinks={{
1632
- ErrorCode: '/reference/graphql-api/admin/enums#errorcode',
1633
- String: '/reference/graphql-api/admin/object-types#string',
1634
- }}
1635
- >
1636
- {`"""Returned when there is an error in transitioning the Fulfillment state"""
1637
- type FulfillmentStateTransitionError {
1638
- errorCode: ErrorCode!
1639
- message: String!
1640
- transitionError: String!
1641
- fromState: String!
1642
- toState: String!
1643
- }`}
1644
- </GraphQLDoc>
1645
-
1646
- ## GlobalSettings {#globalsettings}
1647
-
1648
- <GraphQLDoc
1649
- type="type"
1650
- typeName="GlobalSettings"
1651
- typeLinks={{
1652
- ID: '/reference/graphql-api/admin/object-types#id',
1653
- DateTime: '/reference/graphql-api/admin/object-types#datetime',
1654
- LanguageCode: '/reference/graphql-api/admin/enums#languagecode',
1655
- Boolean: '/reference/graphql-api/admin/object-types#boolean',
1656
- Int: '/reference/graphql-api/admin/object-types#int',
1657
- ServerConfig: '/reference/graphql-api/admin/object-types#serverconfig',
1658
- JSON: '/reference/graphql-api/admin/object-types#json',
1659
- }}
1660
- >
1661
- {`type GlobalSettings {
1662
- id: ID!
1663
- createdAt: DateTime!
1664
- updatedAt: DateTime!
1665
- availableLanguages: [LanguageCode!]!
1666
- trackInventory: Boolean!
1667
- outOfStockThreshold: Int!
1668
- serverConfig: ServerConfig!
1669
- customFields: JSON
1670
- }`}
1671
- </GraphQLDoc>
1672
-
1673
- ## GuestCheckoutError {#guestcheckouterror}
1674
-
1675
- <GraphQLDoc
1676
- type="type"
1677
- typeName="GuestCheckoutError"
1678
- typeLinks={{
1679
- ErrorCode: '/reference/graphql-api/admin/enums#errorcode',
1680
- String: '/reference/graphql-api/admin/object-types#string',
1681
- }}
1682
- >
1683
- {`"""Returned when attempting to set the Customer on a guest checkout when the configured GuestCheckoutStrategy does not allow it."""
1684
- type GuestCheckoutError {
1685
- errorCode: ErrorCode!
1686
- message: String!
1687
- errorDetail: String!
1688
- }`}
1689
- </GraphQLDoc>
1690
-
1691
- ## HistoryEntry {#historyentry}
1692
-
1693
- <GraphQLDoc
1694
- type="type"
1695
- typeName="HistoryEntry"
1696
- typeLinks={{
1697
- Boolean: '/reference/graphql-api/admin/object-types#boolean',
1698
- Administrator: '/reference/graphql-api/admin/object-types#administrator',
1699
- ID: '/reference/graphql-api/admin/object-types#id',
1700
- DateTime: '/reference/graphql-api/admin/object-types#datetime',
1701
- HistoryEntryType: '/reference/graphql-api/admin/enums#historyentrytype',
1702
- JSON: '/reference/graphql-api/admin/object-types#json',
1703
- }}
1704
- >
1705
- {`type HistoryEntry {
1706
- isPublic: Boolean!
1707
- administrator: Administrator
1708
- id: ID!
1709
- createdAt: DateTime!
1710
- updatedAt: DateTime!
1711
- type: HistoryEntryType!
1712
- data: JSON!
1713
- customFields: JSON
1714
- }`}
1715
- </GraphQLDoc>
1716
-
1717
- ## HistoryEntryList {#historyentrylist}
1718
-
1719
- <GraphQLDoc
1720
- type="type"
1721
- typeName="HistoryEntryList"
1722
- typeLinks={{
1723
- HistoryEntry: '/reference/graphql-api/admin/object-types#historyentry',
1724
- Int: '/reference/graphql-api/admin/object-types#int',
1725
- }}
1726
- >
1727
- {`type HistoryEntryList {
1728
- items: [HistoryEntry!]!
1729
- totalItems: Int!
1730
- }`}
1731
- </GraphQLDoc>
1732
-
1733
- ## ID {#id}
1734
-
1735
- <GraphQLDoc
1736
- type="scalar"
1737
- typeName="ID"
1738
- typeLinks={{}}
1739
- >
1740
- {`"""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."""
1741
- scalar ID`}
1742
- </GraphQLDoc>
1743
-
1744
- ## ImportInfo {#importinfo}
1745
-
1746
- <GraphQLDoc
1747
- type="type"
1748
- typeName="ImportInfo"
1749
- typeLinks={{
1750
- String: '/reference/graphql-api/admin/object-types#string',
1751
- Int: '/reference/graphql-api/admin/object-types#int',
1752
- }}
1753
- >
1754
- {`type ImportInfo {
1755
- errors: [String!]
1756
- processed: Int!
1757
- imported: Int!
1758
- }`}
1759
- </GraphQLDoc>
1760
-
1761
- ## IneligibleShippingMethodError {#ineligibleshippingmethoderror}
1762
-
1763
- <GraphQLDoc
1764
- type="type"
1765
- typeName="IneligibleShippingMethodError"
1766
- typeLinks={{
1767
- ErrorCode: '/reference/graphql-api/admin/enums#errorcode',
1768
- String: '/reference/graphql-api/admin/object-types#string',
1769
- }}
1770
- >
1771
- {`"""Returned when attempting to set a ShippingMethod for which the Order is not eligible"""
1772
- type IneligibleShippingMethodError {
1773
- errorCode: ErrorCode!
1774
- message: String!
1775
- }`}
1776
- </GraphQLDoc>
1777
-
1778
- ## InsufficientStockError {#insufficientstockerror}
1779
-
1780
- <GraphQLDoc
1781
- type="type"
1782
- typeName="InsufficientStockError"
1783
- typeLinks={{
1784
- ErrorCode: '/reference/graphql-api/admin/enums#errorcode',
1785
- String: '/reference/graphql-api/admin/object-types#string',
1786
- Int: '/reference/graphql-api/admin/object-types#int',
1787
- Order: '/reference/graphql-api/admin/object-types#order',
1788
- }}
1789
- >
1790
- {`"""Returned when attempting to add more items to the Order than are available"""
1791
- type InsufficientStockError {
1792
- errorCode: ErrorCode!
1793
- message: String!
1794
- quantityAvailable: Int!
1795
- order: Order!
1796
- }`}
1797
- </GraphQLDoc>
1798
-
1799
- ## InsufficientStockOnHandError {#insufficientstockonhanderror}
1800
-
1801
- <GraphQLDoc
1802
- type="type"
1803
- typeName="InsufficientStockOnHandError"
1804
- typeLinks={{
1805
- ErrorCode: '/reference/graphql-api/admin/enums#errorcode',
1806
- String: '/reference/graphql-api/admin/object-types#string',
1807
- ID: '/reference/graphql-api/admin/object-types#id',
1808
- Int: '/reference/graphql-api/admin/object-types#int',
1809
- }}
1810
- >
1811
- {`"""
1812
- Returned if attempting to create a Fulfillment when there is insufficient
1813
- stockOnHand of a ProductVariant to satisfy the requested quantity.
1814
- """
1815
- type InsufficientStockOnHandError {
1816
- errorCode: ErrorCode!
1817
- message: String!
1818
- productVariantId: ID!
1819
- productVariantName: String!
1820
- stockOnHand: Int!
1821
- }`}
1822
- </GraphQLDoc>
1823
-
1824
- ## Int {#int}
1825
-
1826
- <GraphQLDoc
1827
- type="scalar"
1828
- typeName="Int"
1829
- typeLinks={{}}
1830
- >
1831
- {`"""The \`Int\` scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1."""
1832
- scalar Int`}
1833
- </GraphQLDoc>
1834
-
1835
- ## IntCustomFieldConfig {#intcustomfieldconfig}
1836
-
1837
- <GraphQLDoc
1838
- type="type"
1839
- typeName="IntCustomFieldConfig"
1840
- typeLinks={{
1841
- String: '/reference/graphql-api/admin/object-types#string',
1842
- Boolean: '/reference/graphql-api/admin/object-types#boolean',
1843
- LocalizedString: '/reference/graphql-api/admin/object-types#localizedstring',
1844
- Permission: '/reference/graphql-api/admin/enums#permission',
1845
- Int: '/reference/graphql-api/admin/object-types#int',
1846
- JSON: '/reference/graphql-api/admin/object-types#json',
1847
- }}
1848
- >
1849
- {`type IntCustomFieldConfig {
1850
- name: String!
1851
- type: String!
1852
- list: Boolean!
1853
- label: [LocalizedString!]
1854
- description: [LocalizedString!]
1855
- readonly: Boolean
1856
- internal: Boolean
1857
- nullable: Boolean
1858
- requiresPermission: [Permission!]
1859
- deprecated: Boolean
1860
- deprecationReason: String
1861
- min: Int
1862
- max: Int
1863
- step: Int
1864
- ui: JSON
1865
- }`}
1866
- </GraphQLDoc>
1867
-
1868
- ## IntStructFieldConfig {#intstructfieldconfig}
1869
-
1870
- <GraphQLDoc
1871
- type="type"
1872
- typeName="IntStructFieldConfig"
1873
- typeLinks={{
1874
- String: '/reference/graphql-api/admin/object-types#string',
1875
- Boolean: '/reference/graphql-api/admin/object-types#boolean',
1876
- LocalizedString: '/reference/graphql-api/admin/object-types#localizedstring',
1877
- Int: '/reference/graphql-api/admin/object-types#int',
1878
- JSON: '/reference/graphql-api/admin/object-types#json',
1879
- }}
1880
- >
1881
- {`type IntStructFieldConfig {
1882
- name: String!
1883
- type: String!
1884
- list: Boolean!
1885
- label: [LocalizedString!]
1886
- description: [LocalizedString!]
1887
- min: Int
1888
- max: Int
1889
- step: Int
1890
- ui: JSON
1891
- }`}
1892
- </GraphQLDoc>
1893
-
1894
- ## InvalidCredentialsError {#invalidcredentialserror}
1895
-
1896
- <GraphQLDoc
1897
- type="type"
1898
- typeName="InvalidCredentialsError"
1899
- typeLinks={{
1900
- ErrorCode: '/reference/graphql-api/admin/enums#errorcode',
1901
- String: '/reference/graphql-api/admin/object-types#string',
1902
- }}
1903
- >
1904
- {`"""Returned if the user authentication credentials are not valid"""
1905
- type InvalidCredentialsError {
1906
- errorCode: ErrorCode!
1907
- message: String!
1908
- authenticationError: String!
1909
- }`}
1910
- </GraphQLDoc>
1911
-
1912
- ## InvalidFulfillmentHandlerError {#invalidfulfillmenthandlererror}
1913
-
1914
- <GraphQLDoc
1915
- type="type"
1916
- typeName="InvalidFulfillmentHandlerError"
1917
- typeLinks={{
1918
- ErrorCode: '/reference/graphql-api/admin/enums#errorcode',
1919
- String: '/reference/graphql-api/admin/object-types#string',
1920
- }}
1921
- >
1922
- {`"""Returned if the specified FulfillmentHandler code is not valid"""
1923
- type InvalidFulfillmentHandlerError {
1924
- errorCode: ErrorCode!
1925
- message: String!
1926
- }`}
1927
- </GraphQLDoc>
1928
-
1929
- ## ItemsAlreadyFulfilledError {#itemsalreadyfulfillederror}
1930
-
1931
- <GraphQLDoc
1932
- type="type"
1933
- typeName="ItemsAlreadyFulfilledError"
1934
- typeLinks={{
1935
- ErrorCode: '/reference/graphql-api/admin/enums#errorcode',
1936
- String: '/reference/graphql-api/admin/object-types#string',
1937
- }}
1938
- >
1939
- {`"""Returned if the specified items are already part of a Fulfillment"""
1940
- type ItemsAlreadyFulfilledError {
1941
- errorCode: ErrorCode!
1942
- message: String!
1943
- }`}
1944
- </GraphQLDoc>
1945
-
1946
- ## JSON {#json}
1947
-
1948
- <GraphQLDoc
1949
- type="scalar"
1950
- typeName="JSON"
1951
- typeLinks={{}}
1952
- >
1953
- {`"""The \`JSON\` scalar type represents JSON values as specified by [ECMA-404](http://www.ecma-international.org/publications/files/ECMA-ST/ECMA-404.pdf)."""
1954
- scalar JSON`}
1955
- </GraphQLDoc>
1956
-
1957
- ## Job {#job}
1958
-
1959
- <GraphQLDoc
1960
- type="type"
1961
- typeName="Job"
1962
- typeLinks={{
1963
- ID: '/reference/graphql-api/admin/object-types#id',
1964
- DateTime: '/reference/graphql-api/admin/object-types#datetime',
1965
- String: '/reference/graphql-api/admin/object-types#string',
1966
- JobState: '/reference/graphql-api/admin/enums#jobstate',
1967
- Float: '/reference/graphql-api/admin/object-types#float',
1968
- JSON: '/reference/graphql-api/admin/object-types#json',
1969
- Boolean: '/reference/graphql-api/admin/object-types#boolean',
1970
- Int: '/reference/graphql-api/admin/object-types#int',
1971
- }}
1972
- >
1973
- {`type Job {
1974
- id: ID!
1975
- createdAt: DateTime!
1976
- startedAt: DateTime
1977
- settledAt: DateTime
1978
- queueName: String!
1979
- state: JobState!
1980
- progress: Float!
1981
- data: JSON
1982
- result: JSON
1983
- error: JSON
1984
- isSettled: Boolean!
1985
- duration: Int!
1986
- retries: Int!
1987
- attempts: Int!
1988
- }`}
1989
- </GraphQLDoc>
1990
-
1991
- ## JobBufferSize {#jobbuffersize}
1992
-
1993
- <GraphQLDoc
1994
- type="type"
1995
- typeName="JobBufferSize"
1996
- typeLinks={{
1997
- String: '/reference/graphql-api/admin/object-types#string',
1998
- Int: '/reference/graphql-api/admin/object-types#int',
1999
- }}
2000
- >
2001
- {`type JobBufferSize {
2002
- bufferId: String!
2003
- size: Int!
2004
- }`}
2005
- </GraphQLDoc>
2006
-
2007
- ## JobList {#joblist}
2008
-
2009
- <GraphQLDoc
2010
- type="type"
2011
- typeName="JobList"
2012
- typeLinks={{
2013
- Job: '/reference/graphql-api/admin/object-types#job',
2014
- Int: '/reference/graphql-api/admin/object-types#int',
2015
- }}
2016
- >
2017
- {`type JobList {
2018
- items: [Job!]!
2019
- totalItems: Int!
2020
- }`}
2021
- </GraphQLDoc>
2022
-
2023
- ## JobQueue {#jobqueue}
2024
-
2025
- <GraphQLDoc
2026
- type="type"
2027
- typeName="JobQueue"
2028
- typeLinks={{
2029
- String: '/reference/graphql-api/admin/object-types#string',
2030
- Boolean: '/reference/graphql-api/admin/object-types#boolean',
2031
- }}
2032
- >
2033
- {`type JobQueue {
2034
- name: String!
2035
- running: Boolean!
2036
- }`}
2037
- </GraphQLDoc>
2038
-
2039
- ## LanguageNotAvailableError {#languagenotavailableerror}
2040
-
2041
- <GraphQLDoc
2042
- type="type"
2043
- typeName="LanguageNotAvailableError"
2044
- typeLinks={{
2045
- ErrorCode: '/reference/graphql-api/admin/enums#errorcode',
2046
- String: '/reference/graphql-api/admin/object-types#string',
2047
- }}
2048
- >
2049
- {`"""Returned if attempting to set a Channel's defaultLanguageCode to a language which is not enabled in GlobalSettings"""
2050
- type LanguageNotAvailableError {
2051
- errorCode: ErrorCode!
2052
- message: String!
2053
- languageCode: String!
2054
- }`}
2055
- </GraphQLDoc>
2056
-
2057
- ## LocaleStringCustomFieldConfig {#localestringcustomfieldconfig}
2058
-
2059
- <GraphQLDoc
2060
- type="type"
2061
- typeName="LocaleStringCustomFieldConfig"
2062
- typeLinks={{
2063
- String: '/reference/graphql-api/admin/object-types#string',
2064
- Boolean: '/reference/graphql-api/admin/object-types#boolean',
2065
- Int: '/reference/graphql-api/admin/object-types#int',
2066
- LocalizedString: '/reference/graphql-api/admin/object-types#localizedstring',
2067
- Permission: '/reference/graphql-api/admin/enums#permission',
2068
- JSON: '/reference/graphql-api/admin/object-types#json',
2069
- }}
2070
- >
2071
- {`type LocaleStringCustomFieldConfig {
2072
- name: String!
2073
- type: String!
2074
- list: Boolean!
2075
- length: Int
2076
- label: [LocalizedString!]
2077
- description: [LocalizedString!]
2078
- readonly: Boolean
2079
- internal: Boolean
2080
- nullable: Boolean
2081
- requiresPermission: [Permission!]
2082
- deprecated: Boolean
2083
- deprecationReason: String
2084
- pattern: String
2085
- ui: JSON
2086
- }`}
2087
- </GraphQLDoc>
2088
-
2089
- ## LocaleTextCustomFieldConfig {#localetextcustomfieldconfig}
2090
-
2091
- <GraphQLDoc
2092
- type="type"
2093
- typeName="LocaleTextCustomFieldConfig"
2094
- typeLinks={{
2095
- String: '/reference/graphql-api/admin/object-types#string',
2096
- Boolean: '/reference/graphql-api/admin/object-types#boolean',
2097
- LocalizedString: '/reference/graphql-api/admin/object-types#localizedstring',
2098
- Permission: '/reference/graphql-api/admin/enums#permission',
2099
- JSON: '/reference/graphql-api/admin/object-types#json',
2100
- }}
2101
- >
2102
- {`type LocaleTextCustomFieldConfig {
2103
- name: String!
2104
- type: String!
2105
- list: Boolean!
2106
- label: [LocalizedString!]
2107
- description: [LocalizedString!]
2108
- readonly: Boolean
2109
- internal: Boolean
2110
- nullable: Boolean
2111
- requiresPermission: [Permission!]
2112
- deprecated: Boolean
2113
- deprecationReason: String
2114
- ui: JSON
2115
- }`}
2116
- </GraphQLDoc>
2117
-
2118
- ## LocalizedString {#localizedstring}
2119
-
2120
- <GraphQLDoc
2121
- type="type"
2122
- typeName="LocalizedString"
2123
- typeLinks={{
2124
- LanguageCode: '/reference/graphql-api/admin/enums#languagecode',
2125
- String: '/reference/graphql-api/admin/object-types#string',
2126
- }}
2127
- >
2128
- {`type LocalizedString {
2129
- languageCode: LanguageCode!
2130
- value: String!
2131
- }`}
2132
- </GraphQLDoc>
2133
-
2134
- ## ManualPaymentStateError {#manualpaymentstateerror}
2135
-
2136
- <GraphQLDoc
2137
- type="type"
2138
- typeName="ManualPaymentStateError"
2139
- typeLinks={{
2140
- ErrorCode: '/reference/graphql-api/admin/enums#errorcode',
2141
- String: '/reference/graphql-api/admin/object-types#string',
2142
- }}
2143
- >
2144
- {`"""
2145
- Returned when a call to addManualPaymentToOrder is made but the Order
2146
- is not in the required state.
2147
- """
2148
- type ManualPaymentStateError {
2149
- errorCode: ErrorCode!
2150
- message: String!
2151
- }`}
2152
- </GraphQLDoc>
2153
-
2154
- ## MetricSummary {#metricsummary}
2155
-
2156
- <GraphQLDoc
2157
- type="type"
2158
- typeName="MetricSummary"
2159
- typeLinks={{
2160
- MetricInterval: '/reference/graphql-api/admin/enums#metricinterval',
2161
- MetricType: '/reference/graphql-api/admin/enums#metrictype',
2162
- String: '/reference/graphql-api/admin/object-types#string',
2163
- MetricSummaryEntry: '/reference/graphql-api/admin/object-types#metricsummaryentry',
2164
- }}
2165
- >
2166
- {`type MetricSummary {
2167
- interval: MetricInterval!
2168
- type: MetricType!
2169
- title: String!
2170
- entries: [MetricSummaryEntry!]!
2171
- }`}
2172
- </GraphQLDoc>
2173
-
2174
- ## MetricSummaryEntry {#metricsummaryentry}
2175
-
2176
- <GraphQLDoc
2177
- type="type"
2178
- typeName="MetricSummaryEntry"
2179
- typeLinks={{
2180
- String: '/reference/graphql-api/admin/object-types#string',
2181
- Float: '/reference/graphql-api/admin/object-types#float',
2182
- }}
2183
- >
2184
- {`type MetricSummaryEntry {
2185
- label: String!
2186
- value: Float!
2187
- }`}
2188
- </GraphQLDoc>
2189
-
2190
- ## MimeTypeError {#mimetypeerror}
2191
-
2192
- <GraphQLDoc
2193
- type="type"
2194
- typeName="MimeTypeError"
2195
- typeLinks={{
2196
- ErrorCode: '/reference/graphql-api/admin/enums#errorcode',
2197
- String: '/reference/graphql-api/admin/object-types#string',
2198
- }}
2199
- >
2200
- {`type MimeTypeError {
2201
- errorCode: ErrorCode!
2202
- message: String!
2203
- fileName: String!
2204
- mimeType: String!
2205
- }`}
2206
- </GraphQLDoc>
2207
-
2208
- ## MissingConditionsError {#missingconditionserror}
2209
-
2210
- <GraphQLDoc
2211
- type="type"
2212
- typeName="MissingConditionsError"
2213
- typeLinks={{
2214
- ErrorCode: '/reference/graphql-api/admin/enums#errorcode',
2215
- String: '/reference/graphql-api/admin/object-types#string',
2216
- }}
2217
- >
2218
- {`"""Returned if a PromotionCondition has neither a couponCode nor any conditions set"""
2219
- type MissingConditionsError {
2220
- errorCode: ErrorCode!
2221
- message: String!
2222
- }`}
2223
- </GraphQLDoc>
2224
-
2225
- ## ModifyOrderResult {#modifyorderresult}
2226
-
2227
- <GraphQLDoc
2228
- type="union"
2229
- typeName="ModifyOrderResult"
2230
- typeLinks={{
2231
- Order: '/reference/graphql-api/admin/object-types#order',
2232
- NoChangesSpecifiedError: '/reference/graphql-api/admin/object-types#nochangesspecifiederror',
2233
- OrderModificationStateError: '/reference/graphql-api/admin/object-types#ordermodificationstateerror',
2234
- PaymentMethodMissingError: '/reference/graphql-api/admin/object-types#paymentmethodmissingerror',
2235
- RefundPaymentIdMissingError: '/reference/graphql-api/admin/object-types#refundpaymentidmissingerror',
2236
- OrderLimitError: '/reference/graphql-api/admin/object-types#orderlimiterror',
2237
- NegativeQuantityError: '/reference/graphql-api/admin/object-types#negativequantityerror',
2238
- InsufficientStockError: '/reference/graphql-api/admin/object-types#insufficientstockerror',
2239
- CouponCodeExpiredError: '/reference/graphql-api/admin/object-types#couponcodeexpirederror',
2240
- CouponCodeInvalidError: '/reference/graphql-api/admin/object-types#couponcodeinvaliderror',
2241
- CouponCodeLimitError: '/reference/graphql-api/admin/object-types#couponcodelimiterror',
2242
- IneligibleShippingMethodError: '/reference/graphql-api/admin/object-types#ineligibleshippingmethoderror',
2243
- }}
2244
- >
2245
- {`union ModifyOrderResult = Order | NoChangesSpecifiedError | OrderModificationStateError | PaymentMethodMissingError | RefundPaymentIdMissingError | OrderLimitError | NegativeQuantityError | InsufficientStockError | CouponCodeExpiredError | CouponCodeInvalidError | CouponCodeLimitError | IneligibleShippingMethodError`}
2246
- </GraphQLDoc>
2247
-
2248
- ## Money {#money}
2249
-
2250
- <GraphQLDoc
2251
- type="scalar"
2252
- typeName="Money"
2253
- typeLinks={{}}
2254
- >
2255
- {`"""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)."""
2256
- scalar Money`}
2257
- </GraphQLDoc>
2258
-
2259
- ## MultipleOrderError {#multipleordererror}
2260
-
2261
- <GraphQLDoc
2262
- type="type"
2263
- typeName="MultipleOrderError"
2264
- typeLinks={{
2265
- ErrorCode: '/reference/graphql-api/admin/enums#errorcode',
2266
- String: '/reference/graphql-api/admin/object-types#string',
2267
- }}
2268
- >
2269
- {`"""Returned if an operation has specified OrderLines from multiple Orders"""
2270
- type MultipleOrderError {
2271
- errorCode: ErrorCode!
2272
- message: String!
2273
- }`}
2274
- </GraphQLDoc>
2275
-
2276
- ## NativeAuthStrategyError {#nativeauthstrategyerror}
2277
-
2278
- <GraphQLDoc
2279
- type="type"
2280
- typeName="NativeAuthStrategyError"
2281
- typeLinks={{
2282
- ErrorCode: '/reference/graphql-api/admin/enums#errorcode',
2283
- String: '/reference/graphql-api/admin/object-types#string',
2284
- }}
2285
- >
2286
- {`"""Returned when attempting an operation that relies on the NativeAuthStrategy, if that strategy is not configured."""
2287
- type NativeAuthStrategyError {
2288
- errorCode: ErrorCode!
2289
- message: String!
2290
- }`}
2291
- </GraphQLDoc>
2292
-
2293
- ## NativeAuthenticationResult {#nativeauthenticationresult}
2294
-
2295
- <GraphQLDoc
2296
- type="union"
2297
- typeName="NativeAuthenticationResult"
2298
- typeLinks={{
2299
- CurrentUser: '/reference/graphql-api/admin/object-types#currentuser',
2300
- InvalidCredentialsError: '/reference/graphql-api/admin/object-types#invalidcredentialserror',
2301
- NativeAuthStrategyError: '/reference/graphql-api/admin/object-types#nativeauthstrategyerror',
2302
- }}
2303
- >
2304
- {`union NativeAuthenticationResult = CurrentUser | InvalidCredentialsError | NativeAuthStrategyError`}
2305
- </GraphQLDoc>
2306
-
2307
- ## NegativeQuantityError {#negativequantityerror}
2308
-
2309
- <GraphQLDoc
2310
- type="type"
2311
- typeName="NegativeQuantityError"
2312
- typeLinks={{
2313
- ErrorCode: '/reference/graphql-api/admin/enums#errorcode',
2314
- String: '/reference/graphql-api/admin/object-types#string',
2315
- }}
2316
- >
2317
- {`"""Returned when attempting to set a negative OrderLine quantity."""
2318
- type NegativeQuantityError {
2319
- errorCode: ErrorCode!
2320
- message: String!
2321
- }`}
2322
- </GraphQLDoc>
2323
-
2324
- ## NoActiveOrderError {#noactiveordererror}
2325
-
2326
- <GraphQLDoc
2327
- type="type"
2328
- typeName="NoActiveOrderError"
2329
- typeLinks={{
2330
- ErrorCode: '/reference/graphql-api/admin/enums#errorcode',
2331
- String: '/reference/graphql-api/admin/object-types#string',
2332
- }}
2333
- >
2334
- {`"""
2335
- Returned when invoking a mutation which depends on there being an active Order on the
2336
- current session.
2337
- """
2338
- type NoActiveOrderError {
2339
- errorCode: ErrorCode!
2340
- message: String!
2341
- }`}
2342
- </GraphQLDoc>
2343
-
2344
- ## NoChangesSpecifiedError {#nochangesspecifiederror}
2345
-
2346
- <GraphQLDoc
2347
- type="type"
2348
- typeName="NoChangesSpecifiedError"
2349
- typeLinks={{
2350
- ErrorCode: '/reference/graphql-api/admin/enums#errorcode',
2351
- String: '/reference/graphql-api/admin/object-types#string',
2352
- }}
2353
- >
2354
- {`"""Returned when a call to modifyOrder fails to specify any changes"""
2355
- type NoChangesSpecifiedError {
2356
- errorCode: ErrorCode!
2357
- message: String!
2358
- }`}
2359
- </GraphQLDoc>
2360
-
2361
- ## NothingToRefundError {#nothingtorefunderror}
2362
-
2363
- <GraphQLDoc
2364
- type="type"
2365
- typeName="NothingToRefundError"
2366
- typeLinks={{
2367
- ErrorCode: '/reference/graphql-api/admin/enums#errorcode',
2368
- String: '/reference/graphql-api/admin/object-types#string',
2369
- }}
2370
- >
2371
- {`"""Returned if an attempting to refund an Order but neither items nor shipping refund was specified"""
2372
- type NothingToRefundError {
2373
- errorCode: ErrorCode!
2374
- message: String!
2375
- }`}
2376
- </GraphQLDoc>
2377
-
2378
- ## Order {#order}
2379
-
2380
- <GraphQLDoc
2381
- type="type"
2382
- typeName="Order"
2383
- typeLinks={{
2384
- String: '/reference/graphql-api/admin/object-types#string',
2385
- OrderModification: '/reference/graphql-api/admin/object-types#ordermodification',
2386
- Order: '/reference/graphql-api/admin/object-types#order',
2387
- ID: '/reference/graphql-api/admin/object-types#id',
2388
- Channel: '/reference/graphql-api/admin/object-types#channel',
2389
- DateTime: '/reference/graphql-api/admin/object-types#datetime',
2390
- OrderType: '/reference/graphql-api/admin/enums#ordertype',
2391
- Boolean: '/reference/graphql-api/admin/object-types#boolean',
2392
- Customer: '/reference/graphql-api/admin/object-types#customer',
2393
- OrderAddress: '/reference/graphql-api/admin/object-types#orderaddress',
2394
- OrderLine: '/reference/graphql-api/admin/object-types#orderline',
2395
- Surcharge: '/reference/graphql-api/admin/object-types#surcharge',
2396
- Discount: '/reference/graphql-api/admin/object-types#discount',
2397
- Promotion: '/reference/graphql-api/admin/object-types#promotion',
2398
- Payment: '/reference/graphql-api/admin/object-types#payment',
2399
- Fulfillment: '/reference/graphql-api/admin/object-types#fulfillment',
2400
- Int: '/reference/graphql-api/admin/object-types#int',
2401
- Money: '/reference/graphql-api/admin/object-types#money',
2402
- CurrencyCode: '/reference/graphql-api/admin/enums#currencycode',
2403
- ShippingLine: '/reference/graphql-api/admin/object-types#shippingline',
2404
- OrderTaxSummary: '/reference/graphql-api/admin/object-types#ordertaxsummary',
2405
- HistoryEntryList: '/reference/graphql-api/admin/object-types#historyentrylist',
2406
- HistoryEntryListOptions: '/reference/graphql-api/admin/input-types#historyentrylistoptions',
2407
- JSON: '/reference/graphql-api/admin/object-types#json',
2408
- }}
2409
- >
2410
- {`type Order {
2411
- nextStates: [String!]!
2412
- modifications: [OrderModification!]!
2413
- sellerOrders: [Order!]
2414
- aggregateOrder: Order
2415
- aggregateOrderId: ID
2416
- channels: [Channel!]!
2417
- id: ID!
2418
- createdAt: DateTime!
2419
- updatedAt: DateTime!
2420
- type: OrderType!
2421
- """
2422
- The date & time that the Order was placed, i.e. the Customer
2423
- completed the checkout and the Order is no longer "active"
2424
- """
2425
- orderPlacedAt: DateTime
2426
- """A unique code for the Order"""
2427
- code: String!
2428
- state: String!
2429
- """An order is active as long as the payment process has not been completed"""
2430
- active: Boolean!
2431
- customer: Customer
2432
- shippingAddress: OrderAddress
2433
- billingAddress: OrderAddress
2434
- lines: [OrderLine!]!
2435
- """
2436
- Surcharges are arbitrary modifications to the Order total which are neither
2437
- ProductVariants nor discounts resulting from applied Promotions. For example,
2438
- one-off discounts based on customer interaction, or surcharges based on payment
2439
- methods.
2440
- """
2441
- surcharges: [Surcharge!]!
2442
- discounts: [Discount!]!
2443
- """An array of all coupon codes applied to the Order"""
2444
- couponCodes: [String!]!
2445
- """Promotions applied to the order. Only gets populated after the payment process has completed."""
2446
- promotions: [Promotion!]!
2447
- payments: [Payment!]
2448
- fulfillments: [Fulfillment!]
2449
- totalQuantity: Int!
2450
- """
2451
- The subTotal is the total of all OrderLines in the Order. This figure also includes any Order-level
2452
- discounts which have been prorated (proportionally distributed) amongst the items of each OrderLine.
2453
- To get a total of all OrderLines which does not account for prorated discounts, use the
2454
- sum of \`OrderLine.discountedLinePrice\` values.
2455
- """
2456
- subTotal: Money!
2457
- """Same as subTotal, but inclusive of tax"""
2458
- subTotalWithTax: Money!
2459
- currencyCode: CurrencyCode!
2460
- shippingLines: [ShippingLine!]!
2461
- shipping: Money!
2462
- shippingWithTax: Money!
2463
- """Equal to subTotal plus shipping"""
2464
- total: Money!
2465
- """The final payable amount. Equal to subTotalWithTax plus shippingWithTax"""
2466
- totalWithTax: Money!
2467
- """A summary of the taxes being applied to this Order"""
2468
- taxSummary: [OrderTaxSummary!]!
2469
- history(options: HistoryEntryListOptions): HistoryEntryList!
2470
- customFields: JSON
2471
- }`}
2472
- </GraphQLDoc>
2473
-
2474
- ## OrderAddress {#orderaddress}
2475
-
2476
- <GraphQLDoc
2477
- type="type"
2478
- typeName="OrderAddress"
2479
- typeLinks={{
2480
- String: '/reference/graphql-api/admin/object-types#string',
2481
- JSON: '/reference/graphql-api/admin/object-types#json',
2482
- }}
2483
- >
2484
- {`type OrderAddress {
2485
- fullName: String
2486
- company: String
2487
- streetLine1: String
2488
- streetLine2: String
2489
- city: String
2490
- province: String
2491
- postalCode: String
2492
- country: String
2493
- countryCode: String
2494
- phoneNumber: String
2495
- customFields: JSON
2496
- }`}
2497
- </GraphQLDoc>
2498
-
2499
- ## OrderInterceptorError {#orderinterceptorerror}
2500
-
2501
- <GraphQLDoc
2502
- type="type"
2503
- typeName="OrderInterceptorError"
2504
- typeLinks={{
2505
- ErrorCode: '/reference/graphql-api/admin/enums#errorcode',
2506
- String: '/reference/graphql-api/admin/object-types#string',
2507
- }}
2508
- >
2509
- {`"""Returned when an order operation is rejected by an OrderInterceptor method."""
2510
- type OrderInterceptorError {
2511
- errorCode: ErrorCode!
2512
- message: String!
2513
- interceptorError: String!
2514
- }`}
2515
- </GraphQLDoc>
2516
-
2517
- ## OrderLimitError {#orderlimiterror}
2518
-
2519
- <GraphQLDoc
2520
- type="type"
2521
- typeName="OrderLimitError"
2522
- typeLinks={{
2523
- ErrorCode: '/reference/graphql-api/admin/enums#errorcode',
2524
- String: '/reference/graphql-api/admin/object-types#string',
2525
- Int: '/reference/graphql-api/admin/object-types#int',
2526
- }}
2527
- >
2528
- {`"""Returned when the maximum order size limit has been reached."""
2529
- type OrderLimitError {
2530
- errorCode: ErrorCode!
2531
- message: String!
2532
- maxItems: Int!
2533
- }`}
2534
- </GraphQLDoc>
2535
-
2536
- ## OrderLine {#orderline}
2537
-
2538
- <GraphQLDoc
2539
- type="type"
2540
- typeName="OrderLine"
2541
- typeLinks={{
2542
- ID: '/reference/graphql-api/admin/object-types#id',
2543
- DateTime: '/reference/graphql-api/admin/object-types#datetime',
2544
- ProductVariant: '/reference/graphql-api/admin/object-types#productvariant',
2545
- Asset: '/reference/graphql-api/admin/object-types#asset',
2546
- Money: '/reference/graphql-api/admin/object-types#money',
2547
- Int: '/reference/graphql-api/admin/object-types#int',
2548
- Float: '/reference/graphql-api/admin/object-types#float',
2549
- Discount: '/reference/graphql-api/admin/object-types#discount',
2550
- TaxLine: '/reference/graphql-api/admin/object-types#taxline',
2551
- Order: '/reference/graphql-api/admin/object-types#order',
2552
- FulfillmentLine: '/reference/graphql-api/admin/object-types#fulfillmentline',
2553
- JSON: '/reference/graphql-api/admin/object-types#json',
2554
- }}
2555
- >
2556
- {`type OrderLine {
2557
- id: ID!
2558
- createdAt: DateTime!
2559
- updatedAt: DateTime!
2560
- productVariant: ProductVariant!
2561
- featuredAsset: Asset
2562
- """The price of a single unit, excluding tax and discounts"""
2563
- unitPrice: Money!
2564
- """The price of a single unit, including tax but excluding discounts"""
2565
- unitPriceWithTax: Money!
2566
- """Non-zero if the unitPrice has changed since it was initially added to Order"""
2567
- unitPriceChangeSinceAdded: Money!
2568
- """Non-zero if the unitPriceWithTax has changed since it was initially added to Order"""
2569
- unitPriceWithTaxChangeSinceAdded: Money!
2570
- """
2571
- The price of a single unit including discounts, excluding tax.
2572
-
2573
- If Order-level discounts have been applied, this will not be the
2574
- actual taxable unit price (see \`proratedUnitPrice\`), but is generally the
2575
- correct price to display to customers to avoid confusion
2576
- about the internal handling of distributed Order-level discounts.
2577
- """
2578
- discountedUnitPrice: Money!
2579
- """The price of a single unit including discounts and tax"""
2580
- discountedUnitPriceWithTax: Money!
2581
- """
2582
- The actual unit price, taking into account both item discounts _and_ prorated (proportionally-distributed)
2583
- Order-level discounts. This value is the true economic value of the OrderItem, and is used in tax
2584
- and refund calculations.
2585
- """
2586
- proratedUnitPrice: Money!
2587
- """The proratedUnitPrice including tax"""
2588
- proratedUnitPriceWithTax: Money!
2589
- """The quantity of items purchased"""
2590
- quantity: Int!
2591
- """The quantity at the time the Order was placed"""
2592
- orderPlacedQuantity: Int!
2593
- taxRate: Float!
2594
- """The total price of the line excluding tax and discounts."""
2595
- linePrice: Money!
2596
- """The total price of the line including tax but excluding discounts."""
2597
- linePriceWithTax: Money!
2598
- """The price of the line including discounts, excluding tax"""
2599
- discountedLinePrice: Money!
2600
- """The price of the line including discounts and tax"""
2601
- discountedLinePriceWithTax: Money!
2602
- """
2603
- The actual line price, taking into account both item discounts _and_ prorated (proportionally-distributed)
2604
- Order-level discounts. This value is the true economic value of the OrderLine, and is used in tax
2605
- and refund calculations.
2606
- """
2607
- proratedLinePrice: Money!
2608
- """The proratedLinePrice including tax"""
2609
- proratedLinePriceWithTax: Money!
2610
- """The total tax on this line"""
2611
- lineTax: Money!
2612
- discounts: [Discount!]!
2613
- taxLines: [TaxLine!]!
2614
- order: Order!
2615
- fulfillmentLines: [FulfillmentLine!]
2616
- customFields: JSON
2617
- }`}
2618
- </GraphQLDoc>
2619
-
2620
- ## OrderList {#orderlist}
2621
-
2622
- <GraphQLDoc
2623
- type="type"
2624
- typeName="OrderList"
2625
- typeLinks={{
2626
- Order: '/reference/graphql-api/admin/object-types#order',
2627
- Int: '/reference/graphql-api/admin/object-types#int',
2628
- }}
2629
- >
2630
- {`type OrderList {
2631
- items: [Order!]!
2632
- totalItems: Int!
2633
- }`}
2634
- </GraphQLDoc>
2635
-
2636
- ## OrderModification {#ordermodification}
2637
-
2638
- <GraphQLDoc
2639
- type="type"
2640
- typeName="OrderModification"
2641
- typeLinks={{
2642
- ID: '/reference/graphql-api/admin/object-types#id',
2643
- DateTime: '/reference/graphql-api/admin/object-types#datetime',
2644
- Money: '/reference/graphql-api/admin/object-types#money',
2645
- String: '/reference/graphql-api/admin/object-types#string',
2646
- OrderModificationLine: '/reference/graphql-api/admin/object-types#ordermodificationline',
2647
- Surcharge: '/reference/graphql-api/admin/object-types#surcharge',
2648
- Payment: '/reference/graphql-api/admin/object-types#payment',
2649
- Refund: '/reference/graphql-api/admin/object-types#refund',
2650
- Boolean: '/reference/graphql-api/admin/object-types#boolean',
2651
- }}
2652
- >
2653
- {`type OrderModification {
2654
- id: ID!
2655
- createdAt: DateTime!
2656
- updatedAt: DateTime!
2657
- priceChange: Money!
2658
- note: String!
2659
- lines: [OrderModificationLine!]!
2660
- surcharges: [Surcharge!]
2661
- payment: Payment
2662
- refund: Refund
2663
- isSettled: Boolean!
2664
- }`}
2665
- </GraphQLDoc>
2666
-
2667
- ## OrderModificationError {#ordermodificationerror}
2668
-
2669
- <GraphQLDoc
2670
- type="type"
2671
- typeName="OrderModificationError"
2672
- typeLinks={{
2673
- ErrorCode: '/reference/graphql-api/admin/enums#errorcode',
2674
- String: '/reference/graphql-api/admin/object-types#string',
2675
- }}
2676
- >
2677
- {`"""Returned when attempting to modify the contents of an Order that is not in the \`AddingItems\` state."""
2678
- type OrderModificationError {
2679
- errorCode: ErrorCode!
2680
- message: String!
2681
- }`}
2682
- </GraphQLDoc>
2683
-
2684
- ## OrderModificationLine {#ordermodificationline}
2685
-
2686
- <GraphQLDoc
2687
- type="type"
2688
- typeName="OrderModificationLine"
2689
- typeLinks={{
2690
- OrderLine: '/reference/graphql-api/admin/object-types#orderline',
2691
- ID: '/reference/graphql-api/admin/object-types#id',
2692
- Int: '/reference/graphql-api/admin/object-types#int',
2693
- OrderModification: '/reference/graphql-api/admin/object-types#ordermodification',
2694
- }}
2695
- >
2696
- {`type OrderModificationLine {
2697
- orderLine: OrderLine!
2698
- orderLineId: ID!
2699
- quantity: Int!
2700
- modification: OrderModification!
2701
- modificationId: ID!
2702
- }`}
2703
- </GraphQLDoc>
2704
-
2705
- ## OrderModificationStateError {#ordermodificationstateerror}
2706
-
2707
- <GraphQLDoc
2708
- type="type"
2709
- typeName="OrderModificationStateError"
2710
- typeLinks={{
2711
- ErrorCode: '/reference/graphql-api/admin/enums#errorcode',
2712
- String: '/reference/graphql-api/admin/object-types#string',
2713
- }}
2714
- >
2715
- {`"""Returned when attempting to modify the contents of an Order that is not in the \`Modifying\` state."""
2716
- type OrderModificationStateError {
2717
- errorCode: ErrorCode!
2718
- message: String!
2719
- }`}
2720
- </GraphQLDoc>
2721
-
2722
- ## OrderProcessState {#orderprocessstate}
2723
-
2724
- <GraphQLDoc
2725
- type="type"
2726
- typeName="OrderProcessState"
2727
- typeLinks={{
2728
- String: '/reference/graphql-api/admin/object-types#string',
2729
- }}
2730
- >
2731
- {`type OrderProcessState {
2732
- name: String!
2733
- to: [String!]!
2734
- }`}
2735
- </GraphQLDoc>
2736
-
2737
- ## OrderStateTransitionError {#orderstatetransitionerror}
2738
-
2739
- <GraphQLDoc
2740
- type="type"
2741
- typeName="OrderStateTransitionError"
2742
- typeLinks={{
2743
- ErrorCode: '/reference/graphql-api/admin/enums#errorcode',
2744
- String: '/reference/graphql-api/admin/object-types#string',
2745
- }}
2746
- >
2747
- {`"""Returned if there is an error in transitioning the Order state"""
2748
- type OrderStateTransitionError {
2749
- errorCode: ErrorCode!
2750
- message: String!
2751
- transitionError: String!
2752
- fromState: String!
2753
- toState: String!
2754
- }`}
2755
- </GraphQLDoc>
2756
-
2757
- ## OrderTaxSummary {#ordertaxsummary}
2758
-
2759
- <GraphQLDoc
2760
- type="type"
2761
- typeName="OrderTaxSummary"
2762
- typeLinks={{
2763
- String: '/reference/graphql-api/admin/object-types#string',
2764
- Float: '/reference/graphql-api/admin/object-types#float',
2765
- Money: '/reference/graphql-api/admin/object-types#money',
2766
- }}
2767
- >
2768
- {`"""
2769
- A summary of the taxes being applied to this order, grouped
2770
- by taxRate.
2771
- """
2772
- type OrderTaxSummary {
2773
- """A description of this tax"""
2774
- description: String!
2775
- """The taxRate as a percentage"""
2776
- taxRate: Float!
2777
- """The total net price of OrderLines to which this taxRate applies"""
2778
- taxBase: Money!
2779
- """The total tax being applied to the Order at this taxRate"""
2780
- taxTotal: Money!
2781
- }`}
2782
- </GraphQLDoc>
2783
-
2784
- ## Payment {#payment}
2785
-
2786
- <GraphQLDoc
2787
- type="type"
2788
- typeName="Payment"
2789
- typeLinks={{
2790
- String: '/reference/graphql-api/admin/object-types#string',
2791
- ID: '/reference/graphql-api/admin/object-types#id',
2792
- DateTime: '/reference/graphql-api/admin/object-types#datetime',
2793
- Money: '/reference/graphql-api/admin/object-types#money',
2794
- Refund: '/reference/graphql-api/admin/object-types#refund',
2795
- JSON: '/reference/graphql-api/admin/object-types#json',
2796
- }}
2797
- >
2798
- {`type Payment {
2799
- nextStates: [String!]!
2800
- id: ID!
2801
- createdAt: DateTime!
2802
- updatedAt: DateTime!
2803
- method: String!
2804
- amount: Money!
2805
- state: String!
2806
- transactionId: String
2807
- errorMessage: String
2808
- refunds: [Refund!]!
2809
- metadata: JSON
2810
- customFields: JSON
2811
- }`}
2812
- </GraphQLDoc>
2813
-
2814
- ## PaymentMethod {#paymentmethod}
2815
-
2816
- <GraphQLDoc
2817
- type="type"
2818
- typeName="PaymentMethod"
2819
- typeLinks={{
2820
- ID: '/reference/graphql-api/admin/object-types#id',
2821
- DateTime: '/reference/graphql-api/admin/object-types#datetime',
2822
- String: '/reference/graphql-api/admin/object-types#string',
2823
- Boolean: '/reference/graphql-api/admin/object-types#boolean',
2824
- ConfigurableOperation: '/reference/graphql-api/admin/object-types#configurableoperation',
2825
- PaymentMethodTranslation: '/reference/graphql-api/admin/object-types#paymentmethodtranslation',
2826
- JSON: '/reference/graphql-api/admin/object-types#json',
2827
- }}
2828
- >
2829
- {`type PaymentMethod {
2830
- id: ID!
2831
- createdAt: DateTime!
2832
- updatedAt: DateTime!
2833
- name: String!
2834
- code: String!
2835
- description: String!
2836
- enabled: Boolean!
2837
- checker: ConfigurableOperation
2838
- handler: ConfigurableOperation!
2839
- translations: [PaymentMethodTranslation!]!
2840
- customFields: JSON
2841
- }`}
2842
- </GraphQLDoc>
2843
-
2844
- ## PaymentMethodList {#paymentmethodlist}
2845
-
2846
- <GraphQLDoc
2847
- type="type"
2848
- typeName="PaymentMethodList"
2849
- typeLinks={{
2850
- PaymentMethod: '/reference/graphql-api/admin/object-types#paymentmethod',
2851
- Int: '/reference/graphql-api/admin/object-types#int',
2852
- }}
2853
- >
2854
- {`type PaymentMethodList {
2855
- items: [PaymentMethod!]!
2856
- totalItems: Int!
2857
- }`}
2858
- </GraphQLDoc>
2859
-
2860
- ## PaymentMethodMissingError {#paymentmethodmissingerror}
2861
-
2862
- <GraphQLDoc
2863
- type="type"
2864
- typeName="PaymentMethodMissingError"
2865
- typeLinks={{
2866
- ErrorCode: '/reference/graphql-api/admin/enums#errorcode',
2867
- String: '/reference/graphql-api/admin/object-types#string',
2868
- }}
2869
- >
2870
- {`"""
2871
- Returned when a call to modifyOrder fails to include a paymentMethod even
2872
- though the price has increased as a result of the changes.
2873
- """
2874
- type PaymentMethodMissingError {
2875
- errorCode: ErrorCode!
2876
- message: String!
2877
- }`}
2878
- </GraphQLDoc>
2879
-
2880
- ## PaymentMethodQuote {#paymentmethodquote}
2881
-
2882
- <GraphQLDoc
2883
- type="type"
2884
- typeName="PaymentMethodQuote"
2885
- typeLinks={{
2886
- ID: '/reference/graphql-api/admin/object-types#id',
2887
- String: '/reference/graphql-api/admin/object-types#string',
2888
- Boolean: '/reference/graphql-api/admin/object-types#boolean',
2889
- JSON: '/reference/graphql-api/admin/object-types#json',
2890
- }}
2891
- >
2892
- {`type PaymentMethodQuote {
2893
- id: ID!
2894
- code: String!
2895
- name: String!
2896
- description: String!
2897
- isEligible: Boolean!
2898
- eligibilityMessage: String
2899
- customFields: JSON
2900
- }`}
2901
- </GraphQLDoc>
2902
-
2903
- ## PaymentMethodTranslation {#paymentmethodtranslation}
2904
-
2905
- <GraphQLDoc
2906
- type="type"
2907
- typeName="PaymentMethodTranslation"
2908
- typeLinks={{
2909
- ID: '/reference/graphql-api/admin/object-types#id',
2910
- DateTime: '/reference/graphql-api/admin/object-types#datetime',
2911
- LanguageCode: '/reference/graphql-api/admin/enums#languagecode',
2912
- String: '/reference/graphql-api/admin/object-types#string',
2913
- }}
2914
- >
2915
- {`type PaymentMethodTranslation {
2916
- id: ID!
2917
- createdAt: DateTime!
2918
- updatedAt: DateTime!
2919
- languageCode: LanguageCode!
2920
- name: String!
2921
- description: String!
2922
- }`}
2923
- </GraphQLDoc>
2924
-
2925
- ## PaymentOrderMismatchError {#paymentordermismatcherror}
2926
-
2927
- <GraphQLDoc
2928
- type="type"
2929
- typeName="PaymentOrderMismatchError"
2930
- typeLinks={{
2931
- ErrorCode: '/reference/graphql-api/admin/enums#errorcode',
2932
- String: '/reference/graphql-api/admin/object-types#string',
2933
- }}
2934
- >
2935
- {`"""Returned if an attempting to refund a Payment against OrderLines from a different Order"""
2936
- type PaymentOrderMismatchError {
2937
- errorCode: ErrorCode!
2938
- message: String!
2939
- }`}
2940
- </GraphQLDoc>
2941
-
2942
- ## PaymentStateTransitionError {#paymentstatetransitionerror}
2943
-
2944
- <GraphQLDoc
2945
- type="type"
2946
- typeName="PaymentStateTransitionError"
2947
- typeLinks={{
2948
- ErrorCode: '/reference/graphql-api/admin/enums#errorcode',
2949
- String: '/reference/graphql-api/admin/object-types#string',
2950
- }}
2951
- >
2952
- {`"""Returned when there is an error in transitioning the Payment state"""
2953
- type PaymentStateTransitionError {
2954
- errorCode: ErrorCode!
2955
- message: String!
2956
- transitionError: String!
2957
- fromState: String!
2958
- toState: String!
2959
- }`}
2960
- </GraphQLDoc>
2961
-
2962
- ## PermissionDefinition {#permissiondefinition}
2963
-
2964
- <GraphQLDoc
2965
- type="type"
2966
- typeName="PermissionDefinition"
2967
- typeLinks={{
2968
- String: '/reference/graphql-api/admin/object-types#string',
2969
- Boolean: '/reference/graphql-api/admin/object-types#boolean',
2970
- }}
2971
- >
2972
- {`type PermissionDefinition {
2973
- name: String!
2974
- description: String!
2975
- assignable: Boolean!
2976
- }`}
2977
- </GraphQLDoc>
2978
-
2979
- ## PriceRange {#pricerange}
2980
-
2981
- <GraphQLDoc
2982
- type="type"
2983
- typeName="PriceRange"
2984
- typeLinks={{
2985
- Money: '/reference/graphql-api/admin/object-types#money',
2986
- }}
2987
- >
2988
- {`"""The price range where the result has more than one price"""
2989
- type PriceRange {
2990
- min: Money!
2991
- max: Money!
2992
- }`}
2993
- </GraphQLDoc>
2994
-
2995
- ## Product {#product}
2996
-
2997
- <GraphQLDoc
2998
- type="type"
2999
- typeName="Product"
3000
- typeLinks={{
3001
- Channel: '/reference/graphql-api/admin/object-types#channel',
3002
- ID: '/reference/graphql-api/admin/object-types#id',
3003
- DateTime: '/reference/graphql-api/admin/object-types#datetime',
3004
- LanguageCode: '/reference/graphql-api/admin/enums#languagecode',
3005
- String: '/reference/graphql-api/admin/object-types#string',
3006
- Boolean: '/reference/graphql-api/admin/object-types#boolean',
3007
- Asset: '/reference/graphql-api/admin/object-types#asset',
3008
- ProductVariant: '/reference/graphql-api/admin/object-types#productvariant',
3009
- ProductVariantList: '/reference/graphql-api/admin/object-types#productvariantlist',
3010
- ProductVariantListOptions: '/reference/graphql-api/admin/input-types#productvariantlistoptions',
3011
- ProductOptionGroup: '/reference/graphql-api/admin/object-types#productoptiongroup',
3012
- FacetValue: '/reference/graphql-api/admin/object-types#facetvalue',
3013
- ProductTranslation: '/reference/graphql-api/admin/object-types#producttranslation',
3014
- Collection: '/reference/graphql-api/admin/object-types#collection',
3015
- JSON: '/reference/graphql-api/admin/object-types#json',
3016
- }}
3017
- >
3018
- {`type Product {
3019
- channels: [Channel!]!
3020
- id: ID!
3021
- createdAt: DateTime!
3022
- updatedAt: DateTime!
3023
- languageCode: LanguageCode!
3024
- name: String!
3025
- slug: String!
3026
- description: String!
3027
- enabled: Boolean!
3028
- featuredAsset: Asset
3029
- assets: [Asset!]!
3030
- """Returns all ProductVariants"""
3031
- variants: [ProductVariant!]!
3032
- """Returns a paginated, sortable, filterable list of ProductVariants"""
3033
- variantList(options: ProductVariantListOptions): ProductVariantList!
3034
- optionGroups: [ProductOptionGroup!]!
3035
- facetValues: [FacetValue!]!
3036
- translations: [ProductTranslation!]!
3037
- collections: [Collection!]!
3038
- customFields: JSON
3039
- }`}
3040
- </GraphQLDoc>
3041
-
3042
- ## ProductList {#productlist}
3043
-
3044
- <GraphQLDoc
3045
- type="type"
3046
- typeName="ProductList"
3047
- typeLinks={{
3048
- Product: '/reference/graphql-api/admin/object-types#product',
3049
- Int: '/reference/graphql-api/admin/object-types#int',
3050
- }}
3051
- >
3052
- {`type ProductList {
3053
- items: [Product!]!
3054
- totalItems: Int!
3055
- }`}
3056
- </GraphQLDoc>
3057
-
3058
- ## ProductOption {#productoption}
3059
-
3060
- <GraphQLDoc
3061
- type="type"
3062
- typeName="ProductOption"
3063
- typeLinks={{
3064
- ID: '/reference/graphql-api/admin/object-types#id',
3065
- DateTime: '/reference/graphql-api/admin/object-types#datetime',
3066
- LanguageCode: '/reference/graphql-api/admin/enums#languagecode',
3067
- String: '/reference/graphql-api/admin/object-types#string',
3068
- ProductOptionGroup: '/reference/graphql-api/admin/object-types#productoptiongroup',
3069
- ProductOptionTranslation: '/reference/graphql-api/admin/object-types#productoptiontranslation',
3070
- JSON: '/reference/graphql-api/admin/object-types#json',
3071
- }}
3072
- >
3073
- {`type ProductOption {
3074
- id: ID!
3075
- createdAt: DateTime!
3076
- updatedAt: DateTime!
3077
- languageCode: LanguageCode!
3078
- code: String!
3079
- name: String!
3080
- groupId: ID!
3081
- group: ProductOptionGroup!
3082
- translations: [ProductOptionTranslation!]!
3083
- customFields: JSON
3084
- }`}
3085
- </GraphQLDoc>
3086
-
3087
- ## ProductOptionGroup {#productoptiongroup}
3088
-
3089
- <GraphQLDoc
3090
- type="type"
3091
- typeName="ProductOptionGroup"
3092
- typeLinks={{
3093
- ID: '/reference/graphql-api/admin/object-types#id',
3094
- DateTime: '/reference/graphql-api/admin/object-types#datetime',
3095
- LanguageCode: '/reference/graphql-api/admin/enums#languagecode',
3096
- String: '/reference/graphql-api/admin/object-types#string',
3097
- ProductOption: '/reference/graphql-api/admin/object-types#productoption',
3098
- ProductOptionGroupTranslation: '/reference/graphql-api/admin/object-types#productoptiongrouptranslation',
3099
- JSON: '/reference/graphql-api/admin/object-types#json',
3100
- }}
3101
- >
3102
- {`type ProductOptionGroup {
3103
- id: ID!
3104
- createdAt: DateTime!
3105
- updatedAt: DateTime!
3106
- languageCode: LanguageCode!
3107
- code: String!
3108
- name: String!
3109
- options: [ProductOption!]!
3110
- translations: [ProductOptionGroupTranslation!]!
3111
- customFields: JSON
3112
- }`}
3113
- </GraphQLDoc>
3114
-
3115
- ## ProductOptionGroupTranslation {#productoptiongrouptranslation}
3116
-
3117
- <GraphQLDoc
3118
- type="type"
3119
- typeName="ProductOptionGroupTranslation"
3120
- typeLinks={{
3121
- ID: '/reference/graphql-api/admin/object-types#id',
3122
- DateTime: '/reference/graphql-api/admin/object-types#datetime',
3123
- LanguageCode: '/reference/graphql-api/admin/enums#languagecode',
3124
- String: '/reference/graphql-api/admin/object-types#string',
3125
- }}
3126
- >
3127
- {`type ProductOptionGroupTranslation {
3128
- id: ID!
3129
- createdAt: DateTime!
3130
- updatedAt: DateTime!
3131
- languageCode: LanguageCode!
3132
- name: String!
3133
- }`}
3134
- </GraphQLDoc>
3135
-
3136
- ## ProductOptionInUseError {#productoptioninuseerror}
3137
-
3138
- <GraphQLDoc
3139
- type="type"
3140
- typeName="ProductOptionInUseError"
3141
- typeLinks={{
3142
- ErrorCode: '/reference/graphql-api/admin/enums#errorcode',
3143
- String: '/reference/graphql-api/admin/object-types#string',
3144
- Int: '/reference/graphql-api/admin/object-types#int',
3145
- }}
3146
- >
3147
- {`type ProductOptionInUseError {
3148
- errorCode: ErrorCode!
3149
- message: String!
3150
- optionGroupCode: String!
3151
- productVariantCount: Int!
3152
- }`}
3153
- </GraphQLDoc>
3154
-
3155
- ## ProductOptionList {#productoptionlist}
3156
-
3157
- <GraphQLDoc
3158
- type="type"
3159
- typeName="ProductOptionList"
3160
- typeLinks={{
3161
- Int: '/reference/graphql-api/admin/object-types#int',
3162
- ProductOption: '/reference/graphql-api/admin/object-types#productoption',
3163
- }}
3164
- >
3165
- {`type ProductOptionList {
3166
- totalItems: Int!
3167
- items: [ProductOption!]!
3168
- }`}
3169
- </GraphQLDoc>
3170
-
3171
- ## ProductOptionTranslation {#productoptiontranslation}
3172
-
3173
- <GraphQLDoc
3174
- type="type"
3175
- typeName="ProductOptionTranslation"
3176
- typeLinks={{
3177
- ID: '/reference/graphql-api/admin/object-types#id',
3178
- DateTime: '/reference/graphql-api/admin/object-types#datetime',
3179
- LanguageCode: '/reference/graphql-api/admin/enums#languagecode',
3180
- String: '/reference/graphql-api/admin/object-types#string',
3181
- }}
3182
- >
3183
- {`type ProductOptionTranslation {
3184
- id: ID!
3185
- createdAt: DateTime!
3186
- updatedAt: DateTime!
3187
- languageCode: LanguageCode!
3188
- name: String!
3189
- }`}
3190
- </GraphQLDoc>
3191
-
3192
- ## ProductTranslation {#producttranslation}
3193
-
3194
- <GraphQLDoc
3195
- type="type"
3196
- typeName="ProductTranslation"
3197
- typeLinks={{
3198
- ID: '/reference/graphql-api/admin/object-types#id',
3199
- DateTime: '/reference/graphql-api/admin/object-types#datetime',
3200
- LanguageCode: '/reference/graphql-api/admin/enums#languagecode',
3201
- String: '/reference/graphql-api/admin/object-types#string',
3202
- }}
3203
- >
3204
- {`type ProductTranslation {
3205
- id: ID!
3206
- createdAt: DateTime!
3207
- updatedAt: DateTime!
3208
- languageCode: LanguageCode!
3209
- name: String!
3210
- slug: String!
3211
- description: String!
3212
- }`}
3213
- </GraphQLDoc>
3214
-
3215
- ## ProductVariant {#productvariant}
3216
-
3217
- <GraphQLDoc
3218
- type="type"
3219
- typeName="ProductVariant"
3220
- typeLinks={{
3221
- Boolean: '/reference/graphql-api/admin/object-types#boolean',
3222
- GlobalFlag: '/reference/graphql-api/admin/enums#globalflag',
3223
- Int: '/reference/graphql-api/admin/object-types#int',
3224
- ProductVariantPrice: '/reference/graphql-api/admin/object-types#productvariantprice',
3225
- StockLevel: '/reference/graphql-api/admin/object-types#stocklevel',
3226
- StockMovementList: '/reference/graphql-api/admin/object-types#stockmovementlist',
3227
- StockMovementListOptions: '/reference/graphql-api/admin/input-types#stockmovementlistoptions',
3228
- Channel: '/reference/graphql-api/admin/object-types#channel',
3229
- ID: '/reference/graphql-api/admin/object-types#id',
3230
- Product: '/reference/graphql-api/admin/object-types#product',
3231
- DateTime: '/reference/graphql-api/admin/object-types#datetime',
3232
- LanguageCode: '/reference/graphql-api/admin/enums#languagecode',
3233
- String: '/reference/graphql-api/admin/object-types#string',
3234
- Asset: '/reference/graphql-api/admin/object-types#asset',
3235
- Money: '/reference/graphql-api/admin/object-types#money',
3236
- CurrencyCode: '/reference/graphql-api/admin/enums#currencycode',
3237
- TaxRate: '/reference/graphql-api/admin/object-types#taxrate',
3238
- TaxCategory: '/reference/graphql-api/admin/object-types#taxcategory',
3239
- ProductOption: '/reference/graphql-api/admin/object-types#productoption',
3240
- FacetValue: '/reference/graphql-api/admin/object-types#facetvalue',
3241
- ProductVariantTranslation: '/reference/graphql-api/admin/object-types#productvarianttranslation',
3242
- JSON: '/reference/graphql-api/admin/object-types#json',
3243
- }}
3244
- >
3245
- {`type ProductVariant {
3246
- enabled: Boolean!
3247
- trackInventory: GlobalFlag!
3248
- stockOnHand: Int!
3249
- stockAllocated: Int!
3250
- outOfStockThreshold: Int!
3251
- useGlobalOutOfStockThreshold: Boolean!
3252
- prices: [ProductVariantPrice!]!
3253
- stockLevels: [StockLevel!]!
3254
- stockMovements(options: StockMovementListOptions): StockMovementList!
3255
- channels: [Channel!]!
3256
- id: ID!
3257
- product: Product!
3258
- productId: ID!
3259
- createdAt: DateTime!
3260
- updatedAt: DateTime!
3261
- languageCode: LanguageCode!
3262
- sku: String!
3263
- name: String!
3264
- featuredAsset: Asset
3265
- assets: [Asset!]!
3266
- price: Money!
3267
- currencyCode: CurrencyCode!
3268
- priceWithTax: Money!
3269
- stockLevel: String!
3270
- taxRateApplied: TaxRate!
3271
- taxCategory: TaxCategory!
3272
- options: [ProductOption!]!
3273
- facetValues: [FacetValue!]!
3274
- translations: [ProductVariantTranslation!]!
3275
- customFields: JSON
3276
- }`}
3277
- </GraphQLDoc>
3278
-
3279
- ## ProductVariantList {#productvariantlist}
3280
-
3281
- <GraphQLDoc
3282
- type="type"
3283
- typeName="ProductVariantList"
3284
- typeLinks={{
3285
- ProductVariant: '/reference/graphql-api/admin/object-types#productvariant',
3286
- Int: '/reference/graphql-api/admin/object-types#int',
3287
- }}
3288
- >
3289
- {`type ProductVariantList {
3290
- items: [ProductVariant!]!
3291
- totalItems: Int!
3292
- }`}
3293
- </GraphQLDoc>
3294
-
3295
- ## ProductVariantPrice {#productvariantprice}
3296
-
3297
- <GraphQLDoc
3298
- type="type"
3299
- typeName="ProductVariantPrice"
3300
- typeLinks={{
3301
- CurrencyCode: '/reference/graphql-api/admin/enums#currencycode',
3302
- Money: '/reference/graphql-api/admin/object-types#money',
3303
- JSON: '/reference/graphql-api/admin/object-types#json',
3304
- }}
3305
- >
3306
- {`type ProductVariantPrice {
3307
- currencyCode: CurrencyCode!
3308
- price: Money!
3309
- customFields: JSON
3310
- }`}
3311
- </GraphQLDoc>
3312
-
3313
- ## ProductVariantTranslation {#productvarianttranslation}
3314
-
3315
- <GraphQLDoc
3316
- type="type"
3317
- typeName="ProductVariantTranslation"
3318
- typeLinks={{
3319
- ID: '/reference/graphql-api/admin/object-types#id',
3320
- DateTime: '/reference/graphql-api/admin/object-types#datetime',
3321
- LanguageCode: '/reference/graphql-api/admin/enums#languagecode',
3322
- String: '/reference/graphql-api/admin/object-types#string',
3323
- }}
3324
- >
3325
- {`type ProductVariantTranslation {
3326
- id: ID!
3327
- createdAt: DateTime!
3328
- updatedAt: DateTime!
3329
- languageCode: LanguageCode!
3330
- name: String!
3331
- }`}
3332
- </GraphQLDoc>
3333
-
3334
- ## Promotion {#promotion}
3335
-
3336
- <GraphQLDoc
3337
- type="type"
3338
- typeName="Promotion"
3339
- typeLinks={{
3340
- ID: '/reference/graphql-api/admin/object-types#id',
3341
- DateTime: '/reference/graphql-api/admin/object-types#datetime',
3342
- String: '/reference/graphql-api/admin/object-types#string',
3343
- Int: '/reference/graphql-api/admin/object-types#int',
3344
- Boolean: '/reference/graphql-api/admin/object-types#boolean',
3345
- ConfigurableOperation: '/reference/graphql-api/admin/object-types#configurableoperation',
3346
- PromotionTranslation: '/reference/graphql-api/admin/object-types#promotiontranslation',
3347
- JSON: '/reference/graphql-api/admin/object-types#json',
3348
- }}
3349
- >
3350
- {`type Promotion {
3351
- id: ID!
3352
- createdAt: DateTime!
3353
- updatedAt: DateTime!
3354
- startsAt: DateTime
3355
- endsAt: DateTime
3356
- couponCode: String
3357
- perCustomerUsageLimit: Int
3358
- usageLimit: Int
3359
- name: String!
3360
- description: String!
3361
- enabled: Boolean!
3362
- conditions: [ConfigurableOperation!]!
3363
- actions: [ConfigurableOperation!]!
3364
- translations: [PromotionTranslation!]!
3365
- customFields: JSON
3366
- }`}
3367
- </GraphQLDoc>
3368
-
3369
- ## PromotionList {#promotionlist}
3370
-
3371
- <GraphQLDoc
3372
- type="type"
3373
- typeName="PromotionList"
3374
- typeLinks={{
3375
- Promotion: '/reference/graphql-api/admin/object-types#promotion',
3376
- Int: '/reference/graphql-api/admin/object-types#int',
3377
- }}
3378
- >
3379
- {`type PromotionList {
3380
- items: [Promotion!]!
3381
- totalItems: Int!
3382
- }`}
3383
- </GraphQLDoc>
3384
-
3385
- ## PromotionTranslation {#promotiontranslation}
3386
-
3387
- <GraphQLDoc
3388
- type="type"
3389
- typeName="PromotionTranslation"
3390
- typeLinks={{
3391
- ID: '/reference/graphql-api/admin/object-types#id',
3392
- DateTime: '/reference/graphql-api/admin/object-types#datetime',
3393
- LanguageCode: '/reference/graphql-api/admin/enums#languagecode',
3394
- String: '/reference/graphql-api/admin/object-types#string',
3395
- }}
3396
- >
3397
- {`type PromotionTranslation {
3398
- id: ID!
3399
- createdAt: DateTime!
3400
- updatedAt: DateTime!
3401
- languageCode: LanguageCode!
3402
- name: String!
3403
- description: String!
3404
- }`}
3405
- </GraphQLDoc>
3406
-
3407
- ## Province {#province}
3408
-
3409
- <GraphQLDoc
3410
- type="type"
3411
- typeName="Province"
3412
- typeLinks={{
3413
- ID: '/reference/graphql-api/admin/object-types#id',
3414
- DateTime: '/reference/graphql-api/admin/object-types#datetime',
3415
- LanguageCode: '/reference/graphql-api/admin/enums#languagecode',
3416
- String: '/reference/graphql-api/admin/object-types#string',
3417
- Boolean: '/reference/graphql-api/admin/object-types#boolean',
3418
- Region: '/reference/graphql-api/admin/object-types#region',
3419
- RegionTranslation: '/reference/graphql-api/admin/object-types#regiontranslation',
3420
- JSON: '/reference/graphql-api/admin/object-types#json',
3421
- }}
3422
- >
3423
- {`type Province {
3424
- id: ID!
3425
- createdAt: DateTime!
3426
- updatedAt: DateTime!
3427
- languageCode: LanguageCode!
3428
- code: String!
3429
- type: String!
3430
- name: String!
3431
- enabled: Boolean!
3432
- parent: Region
3433
- parentId: ID
3434
- translations: [RegionTranslation!]!
3435
- customFields: JSON
3436
- }`}
3437
- </GraphQLDoc>
3438
-
3439
- ## ProvinceList {#provincelist}
3440
-
3441
- <GraphQLDoc
3442
- type="type"
3443
- typeName="ProvinceList"
3444
- typeLinks={{
3445
- Province: '/reference/graphql-api/admin/object-types#province',
3446
- Int: '/reference/graphql-api/admin/object-types#int',
3447
- }}
3448
- >
3449
- {`type ProvinceList {
3450
- items: [Province!]!
3451
- totalItems: Int!
3452
- }`}
3453
- </GraphQLDoc>
3454
-
3455
- ## QuantityTooGreatError {#quantitytoogreaterror}
3456
-
3457
- <GraphQLDoc
3458
- type="type"
3459
- typeName="QuantityTooGreatError"
3460
- typeLinks={{
3461
- ErrorCode: '/reference/graphql-api/admin/enums#errorcode',
3462
- String: '/reference/graphql-api/admin/object-types#string',
3463
- }}
3464
- >
3465
- {`"""Returned if the specified quantity of an OrderLine is greater than the number of items in that line"""
3466
- type QuantityTooGreatError {
3467
- errorCode: ErrorCode!
3468
- message: String!
3469
- }`}
3470
- </GraphQLDoc>
3471
-
3472
- ## Refund {#refund}
3473
-
3474
- <GraphQLDoc
3475
- type="type"
3476
- typeName="Refund"
3477
- typeLinks={{
3478
- ID: '/reference/graphql-api/admin/object-types#id',
3479
- DateTime: '/reference/graphql-api/admin/object-types#datetime',
3480
- Money: '/reference/graphql-api/admin/object-types#money',
3481
- String: '/reference/graphql-api/admin/object-types#string',
3482
- RefundLine: '/reference/graphql-api/admin/object-types#refundline',
3483
- JSON: '/reference/graphql-api/admin/object-types#json',
3484
- }}
3485
- >
3486
- {`type Refund {
3487
- id: ID!
3488
- createdAt: DateTime!
3489
- updatedAt: DateTime!
3490
- items: Money!
3491
- shipping: Money!
3492
- adjustment: Money!
3493
- total: Money!
3494
- method: String
3495
- state: String!
3496
- transactionId: String
3497
- reason: String
3498
- lines: [RefundLine!]!
3499
- paymentId: ID!
3500
- metadata: JSON
3501
- customFields: JSON
3502
- }`}
3503
- </GraphQLDoc>
3504
-
3505
- ## RefundAmountError {#refundamounterror}
3506
-
3507
- <GraphQLDoc
3508
- type="type"
3509
- typeName="RefundAmountError"
3510
- typeLinks={{
3511
- ErrorCode: '/reference/graphql-api/admin/enums#errorcode',
3512
- String: '/reference/graphql-api/admin/object-types#string',
3513
- Int: '/reference/graphql-api/admin/object-types#int',
3514
- }}
3515
- >
3516
- {`"""Returned if \`amount\` is greater than the maximum un-refunded amount of the Payment"""
3517
- type RefundAmountError {
3518
- errorCode: ErrorCode!
3519
- message: String!
3520
- maximumRefundable: Int!
3521
- }`}
3522
- </GraphQLDoc>
3523
-
3524
- ## RefundLine {#refundline}
3525
-
3526
- <GraphQLDoc
3527
- type="type"
3528
- typeName="RefundLine"
3529
- typeLinks={{
3530
- OrderLine: '/reference/graphql-api/admin/object-types#orderline',
3531
- ID: '/reference/graphql-api/admin/object-types#id',
3532
- Int: '/reference/graphql-api/admin/object-types#int',
3533
- Refund: '/reference/graphql-api/admin/object-types#refund',
3534
- }}
3535
- >
3536
- {`type RefundLine {
3537
- orderLine: OrderLine!
3538
- orderLineId: ID!
3539
- quantity: Int!
3540
- refund: Refund!
3541
- refundId: ID!
3542
- }`}
3543
- </GraphQLDoc>
3544
-
3545
- ## RefundOrderResult {#refundorderresult}
3546
-
3547
- <GraphQLDoc
3548
- type="union"
3549
- typeName="RefundOrderResult"
3550
- typeLinks={{
3551
- Refund: '/reference/graphql-api/admin/object-types#refund',
3552
- QuantityTooGreatError: '/reference/graphql-api/admin/object-types#quantitytoogreaterror',
3553
- NothingToRefundError: '/reference/graphql-api/admin/object-types#nothingtorefunderror',
3554
- OrderStateTransitionError: '/reference/graphql-api/admin/object-types#orderstatetransitionerror',
3555
- MultipleOrderError: '/reference/graphql-api/admin/object-types#multipleordererror',
3556
- PaymentOrderMismatchError: '/reference/graphql-api/admin/object-types#paymentordermismatcherror',
3557
- RefundOrderStateError: '/reference/graphql-api/admin/object-types#refundorderstateerror',
3558
- AlreadyRefundedError: '/reference/graphql-api/admin/object-types#alreadyrefundederror',
3559
- RefundStateTransitionError: '/reference/graphql-api/admin/object-types#refundstatetransitionerror',
3560
- RefundAmountError: '/reference/graphql-api/admin/object-types#refundamounterror',
3561
- }}
3562
- >
3563
- {`union RefundOrderResult = Refund | QuantityTooGreatError | NothingToRefundError | OrderStateTransitionError | MultipleOrderError | PaymentOrderMismatchError | RefundOrderStateError | AlreadyRefundedError | RefundStateTransitionError | RefundAmountError`}
3564
- </GraphQLDoc>
3565
-
3566
- ## RefundOrderStateError {#refundorderstateerror}
3567
-
3568
- <GraphQLDoc
3569
- type="type"
3570
- typeName="RefundOrderStateError"
3571
- typeLinks={{
3572
- ErrorCode: '/reference/graphql-api/admin/enums#errorcode',
3573
- String: '/reference/graphql-api/admin/object-types#string',
3574
- }}
3575
- >
3576
- {`"""Returned if an attempting to refund an Order which is not in the expected state"""
3577
- type RefundOrderStateError {
3578
- errorCode: ErrorCode!
3579
- message: String!
3580
- orderState: String!
3581
- }`}
3582
- </GraphQLDoc>
3583
-
3584
- ## RefundPaymentIdMissingError {#refundpaymentidmissingerror}
3585
-
3586
- <GraphQLDoc
3587
- type="type"
3588
- typeName="RefundPaymentIdMissingError"
3589
- typeLinks={{
3590
- ErrorCode: '/reference/graphql-api/admin/enums#errorcode',
3591
- String: '/reference/graphql-api/admin/object-types#string',
3592
- }}
3593
- >
3594
- {`"""
3595
- Returned when a call to modifyOrder fails to include a refundPaymentId even
3596
- though the price has decreased as a result of the changes.
3597
- """
3598
- type RefundPaymentIdMissingError {
3599
- errorCode: ErrorCode!
3600
- message: String!
3601
- }`}
3602
- </GraphQLDoc>
3603
-
3604
- ## RefundStateTransitionError {#refundstatetransitionerror}
3605
-
3606
- <GraphQLDoc
3607
- type="type"
3608
- typeName="RefundStateTransitionError"
3609
- typeLinks={{
3610
- ErrorCode: '/reference/graphql-api/admin/enums#errorcode',
3611
- String: '/reference/graphql-api/admin/object-types#string',
3612
- }}
3613
- >
3614
- {`"""Returned when there is an error in transitioning the Refund state"""
3615
- type RefundStateTransitionError {
3616
- errorCode: ErrorCode!
3617
- message: String!
3618
- transitionError: String!
3619
- fromState: String!
3620
- toState: String!
3621
- }`}
3622
- </GraphQLDoc>
3623
-
3624
- ## RegionTranslation {#regiontranslation}
3625
-
3626
- <GraphQLDoc
3627
- type="type"
3628
- typeName="RegionTranslation"
3629
- typeLinks={{
3630
- ID: '/reference/graphql-api/admin/object-types#id',
3631
- DateTime: '/reference/graphql-api/admin/object-types#datetime',
3632
- LanguageCode: '/reference/graphql-api/admin/enums#languagecode',
3633
- String: '/reference/graphql-api/admin/object-types#string',
3634
- }}
3635
- >
3636
- {`type RegionTranslation {
3637
- id: ID!
3638
- createdAt: DateTime!
3639
- updatedAt: DateTime!
3640
- languageCode: LanguageCode!
3641
- name: String!
3642
- }`}
3643
- </GraphQLDoc>
3644
-
3645
- ## RelationCustomFieldConfig {#relationcustomfieldconfig}
3646
-
3647
- <GraphQLDoc
3648
- type="type"
3649
- typeName="RelationCustomFieldConfig"
3650
- typeLinks={{
3651
- String: '/reference/graphql-api/admin/object-types#string',
3652
- Boolean: '/reference/graphql-api/admin/object-types#boolean',
3653
- LocalizedString: '/reference/graphql-api/admin/object-types#localizedstring',
3654
- Permission: '/reference/graphql-api/admin/enums#permission',
3655
- JSON: '/reference/graphql-api/admin/object-types#json',
3656
- }}
3657
- >
3658
- {`type RelationCustomFieldConfig {
3659
- name: String!
3660
- type: String!
3661
- list: Boolean!
3662
- label: [LocalizedString!]
3663
- description: [LocalizedString!]
3664
- readonly: Boolean
3665
- internal: Boolean
3666
- nullable: Boolean
3667
- requiresPermission: [Permission!]
3668
- deprecated: Boolean
3669
- deprecationReason: String
3670
- entity: String!
3671
- scalarFields: [String!]!
3672
- ui: JSON
3673
- }`}
3674
- </GraphQLDoc>
3675
-
3676
- ## Release {#release}
3677
-
3678
- <GraphQLDoc
3679
- type="type"
3680
- typeName="Release"
3681
- typeLinks={{
3682
- ID: '/reference/graphql-api/admin/object-types#id',
3683
- DateTime: '/reference/graphql-api/admin/object-types#datetime',
3684
- ProductVariant: '/reference/graphql-api/admin/object-types#productvariant',
3685
- StockMovementType: '/reference/graphql-api/admin/enums#stockmovementtype',
3686
- Int: '/reference/graphql-api/admin/object-types#int',
3687
- JSON: '/reference/graphql-api/admin/object-types#json',
3688
- }}
3689
- >
3690
- {`type Release {
3691
- id: ID!
3692
- createdAt: DateTime!
3693
- updatedAt: DateTime!
3694
- productVariant: ProductVariant!
3695
- type: StockMovementType!
3696
- quantity: Int!
3697
- customFields: JSON
3698
- }`}
3699
- </GraphQLDoc>
3700
-
3701
- ## RemoveFacetFromChannelResult {#removefacetfromchannelresult}
3702
-
3703
- <GraphQLDoc
3704
- type="union"
3705
- typeName="RemoveFacetFromChannelResult"
3706
- typeLinks={{
3707
- Facet: '/reference/graphql-api/admin/object-types#facet',
3708
- FacetInUseError: '/reference/graphql-api/admin/object-types#facetinuseerror',
3709
- }}
3710
- >
3711
- {`union RemoveFacetFromChannelResult = Facet | FacetInUseError`}
3712
- </GraphQLDoc>
3713
-
3714
- ## RemoveOptionGroupFromProductResult {#removeoptiongroupfromproductresult}
3715
-
3716
- <GraphQLDoc
3717
- type="union"
3718
- typeName="RemoveOptionGroupFromProductResult"
3719
- typeLinks={{
3720
- Product: '/reference/graphql-api/admin/object-types#product',
3721
- ProductOptionInUseError: '/reference/graphql-api/admin/object-types#productoptioninuseerror',
3722
- }}
3723
- >
3724
- {`union RemoveOptionGroupFromProductResult = Product | ProductOptionInUseError`}
3725
- </GraphQLDoc>
3726
-
3727
- ## RemoveOrderItemsResult {#removeorderitemsresult}
3728
-
3729
- <GraphQLDoc
3730
- type="union"
3731
- typeName="RemoveOrderItemsResult"
3732
- typeLinks={{
3733
- Order: '/reference/graphql-api/admin/object-types#order',
3734
- OrderModificationError: '/reference/graphql-api/admin/object-types#ordermodificationerror',
3735
- OrderInterceptorError: '/reference/graphql-api/admin/object-types#orderinterceptorerror',
3736
- }}
3737
- >
3738
- {`union RemoveOrderItemsResult = Order | OrderModificationError | OrderInterceptorError`}
3739
- </GraphQLDoc>
3740
-
3741
- ## Return {#return}
3742
-
3743
- <GraphQLDoc
3744
- type="type"
3745
- typeName="Return"
3746
- typeLinks={{
3747
- ID: '/reference/graphql-api/admin/object-types#id',
3748
- DateTime: '/reference/graphql-api/admin/object-types#datetime',
3749
- ProductVariant: '/reference/graphql-api/admin/object-types#productvariant',
3750
- StockMovementType: '/reference/graphql-api/admin/enums#stockmovementtype',
3751
- Int: '/reference/graphql-api/admin/object-types#int',
3752
- JSON: '/reference/graphql-api/admin/object-types#json',
3753
- }}
3754
- >
3755
- {`type Return {
3756
- id: ID!
3757
- createdAt: DateTime!
3758
- updatedAt: DateTime!
3759
- productVariant: ProductVariant!
3760
- type: StockMovementType!
3761
- quantity: Int!
3762
- customFields: JSON
3763
- }`}
3764
- </GraphQLDoc>
3765
-
3766
- ## Role {#role}
3767
-
3768
- <GraphQLDoc
3769
- type="type"
3770
- typeName="Role"
3771
- typeLinks={{
3772
- ID: '/reference/graphql-api/admin/object-types#id',
3773
- DateTime: '/reference/graphql-api/admin/object-types#datetime',
3774
- String: '/reference/graphql-api/admin/object-types#string',
3775
- Permission: '/reference/graphql-api/admin/enums#permission',
3776
- Channel: '/reference/graphql-api/admin/object-types#channel',
3777
- }}
3778
- >
3779
- {`type Role {
3780
- id: ID!
3781
- createdAt: DateTime!
3782
- updatedAt: DateTime!
3783
- code: String!
3784
- description: String!
3785
- permissions: [Permission!]!
3786
- channels: [Channel!]!
3787
- }`}
3788
- </GraphQLDoc>
3789
-
3790
- ## RoleList {#rolelist}
3791
-
3792
- <GraphQLDoc
3793
- type="type"
3794
- typeName="RoleList"
3795
- typeLinks={{
3796
- Role: '/reference/graphql-api/admin/object-types#role',
3797
- Int: '/reference/graphql-api/admin/object-types#int',
3798
- }}
3799
- >
3800
- {`type RoleList {
3801
- items: [Role!]!
3802
- totalItems: Int!
3803
- }`}
3804
- </GraphQLDoc>
3805
-
3806
- ## Sale {#sale}
3807
-
3808
- <GraphQLDoc
3809
- type="type"
3810
- typeName="Sale"
3811
- typeLinks={{
3812
- ID: '/reference/graphql-api/admin/object-types#id',
3813
- DateTime: '/reference/graphql-api/admin/object-types#datetime',
3814
- ProductVariant: '/reference/graphql-api/admin/object-types#productvariant',
3815
- StockMovementType: '/reference/graphql-api/admin/enums#stockmovementtype',
3816
- Int: '/reference/graphql-api/admin/object-types#int',
3817
- JSON: '/reference/graphql-api/admin/object-types#json',
3818
- }}
3819
- >
3820
- {`type Sale {
3821
- id: ID!
3822
- createdAt: DateTime!
3823
- updatedAt: DateTime!
3824
- productVariant: ProductVariant!
3825
- type: StockMovementType!
3826
- quantity: Int!
3827
- customFields: JSON
3828
- }`}
3829
- </GraphQLDoc>
3830
-
3831
- ## ScheduledTask {#scheduledtask}
3832
-
3833
- <GraphQLDoc
3834
- type="type"
3835
- typeName="ScheduledTask"
3836
- typeLinks={{
3837
- String: '/reference/graphql-api/admin/object-types#string',
3838
- DateTime: '/reference/graphql-api/admin/object-types#datetime',
3839
- Boolean: '/reference/graphql-api/admin/object-types#boolean',
3840
- JSON: '/reference/graphql-api/admin/object-types#json',
3841
- }}
3842
- >
3843
- {`type ScheduledTask {
3844
- id: String!
3845
- description: String!
3846
- schedule: String!
3847
- scheduleDescription: String!
3848
- lastExecutedAt: DateTime
3849
- nextExecutionAt: DateTime
3850
- isRunning: Boolean!
3851
- lastResult: JSON
3852
- enabled: Boolean!
3853
- }`}
3854
- </GraphQLDoc>
3855
-
3856
- ## SearchReindexResponse {#searchreindexresponse}
3857
-
3858
- <GraphQLDoc
3859
- type="type"
3860
- typeName="SearchReindexResponse"
3861
- typeLinks={{
3862
- Boolean: '/reference/graphql-api/admin/object-types#boolean',
3863
- }}
3864
- >
3865
- {`type SearchReindexResponse {
3866
- success: Boolean!
3867
- }`}
3868
- </GraphQLDoc>
3869
-
3870
- ## SearchResponse {#searchresponse}
3871
-
3872
- <GraphQLDoc
3873
- type="type"
3874
- typeName="SearchResponse"
3875
- typeLinks={{
3876
- SearchResult: '/reference/graphql-api/admin/object-types#searchresult',
3877
- Int: '/reference/graphql-api/admin/object-types#int',
3878
- FacetValueResult: '/reference/graphql-api/admin/object-types#facetvalueresult',
3879
- CollectionResult: '/reference/graphql-api/admin/object-types#collectionresult',
3880
- }}
3881
- >
3882
- {`type SearchResponse {
3883
- items: [SearchResult!]!
3884
- totalItems: Int!
3885
- facetValues: [FacetValueResult!]!
3886
- collections: [CollectionResult!]!
3887
- }`}
3888
- </GraphQLDoc>
3889
-
3890
- ## SearchResult {#searchresult}
3891
-
3892
- <GraphQLDoc
3893
- type="type"
3894
- typeName="SearchResult"
3895
- typeLinks={{
3896
- Boolean: '/reference/graphql-api/admin/object-types#boolean',
3897
- ID: '/reference/graphql-api/admin/object-types#id',
3898
- String: '/reference/graphql-api/admin/object-types#string',
3899
- SearchResultAsset: '/reference/graphql-api/admin/object-types#searchresultasset',
3900
- SearchResultPrice: '/reference/graphql-api/admin/object-types#searchresultprice',
3901
- CurrencyCode: '/reference/graphql-api/admin/enums#currencycode',
3902
- Float: '/reference/graphql-api/admin/object-types#float',
3903
- }}
3904
- >
3905
- {`type SearchResult {
3906
- enabled: Boolean!
3907
- """An array of ids of the Channels in which this result appears"""
3908
- channelIds: [ID!]!
3909
- sku: String!
3910
- slug: String!
3911
- productId: ID!
3912
- productName: String!
3913
- productAsset: SearchResultAsset
3914
- productVariantId: ID!
3915
- productVariantName: String!
3916
- productVariantAsset: SearchResultAsset
3917
- price: SearchResultPrice!
3918
- priceWithTax: SearchResultPrice!
3919
- currencyCode: CurrencyCode!
3920
- description: String!
3921
- facetIds: [ID!]!
3922
- facetValueIds: [ID!]!
3923
- """An array of ids of the Collections in which this result appears"""
3924
- collectionIds: [ID!]!
3925
- """A relevance score for the result. Differs between database implementations"""
3926
- score: Float!
3927
- }`}
3928
- </GraphQLDoc>
3929
-
3930
- ## SearchResultAsset {#searchresultasset}
3931
-
3932
- <GraphQLDoc
3933
- type="type"
3934
- typeName="SearchResultAsset"
3935
- typeLinks={{
3936
- ID: '/reference/graphql-api/admin/object-types#id',
3937
- String: '/reference/graphql-api/admin/object-types#string',
3938
- Coordinate: '/reference/graphql-api/admin/object-types#coordinate',
3939
- }}
3940
- >
3941
- {`type SearchResultAsset {
3942
- id: ID!
3943
- preview: String!
3944
- focalPoint: Coordinate
3945
- }`}
3946
- </GraphQLDoc>
3947
-
3948
- ## SearchResultPrice {#searchresultprice}
3949
-
3950
- <GraphQLDoc
3951
- type="union"
3952
- typeName="SearchResultPrice"
3953
- typeLinks={{
3954
- PriceRange: '/reference/graphql-api/admin/object-types#pricerange',
3955
- SinglePrice: '/reference/graphql-api/admin/object-types#singleprice',
3956
- }}
3957
- >
3958
- {`"""The price of a search result product, either as a range or as a single price"""
3959
- union SearchResultPrice = PriceRange | SinglePrice`}
3960
- </GraphQLDoc>
3961
-
3962
- ## Seller {#seller}
3963
-
3964
- <GraphQLDoc
3965
- type="type"
3966
- typeName="Seller"
3967
- typeLinks={{
3968
- ID: '/reference/graphql-api/admin/object-types#id',
3969
- DateTime: '/reference/graphql-api/admin/object-types#datetime',
3970
- String: '/reference/graphql-api/admin/object-types#string',
3971
- JSON: '/reference/graphql-api/admin/object-types#json',
3972
- }}
3973
- >
3974
- {`type Seller {
3975
- id: ID!
3976
- createdAt: DateTime!
3977
- updatedAt: DateTime!
3978
- name: String!
3979
- customFields: JSON
3980
- }`}
3981
- </GraphQLDoc>
3982
-
3983
- ## SellerList {#sellerlist}
3984
-
3985
- <GraphQLDoc
3986
- type="type"
3987
- typeName="SellerList"
3988
- typeLinks={{
3989
- Seller: '/reference/graphql-api/admin/object-types#seller',
3990
- Int: '/reference/graphql-api/admin/object-types#int',
3991
- }}
3992
- >
3993
- {`type SellerList {
3994
- items: [Seller!]!
3995
- totalItems: Int!
3996
- }`}
3997
- </GraphQLDoc>
3998
-
3999
- ## ServerConfig {#serverconfig}
4000
-
4001
- <GraphQLDoc
4002
- type="type"
4003
- typeName="ServerConfig"
4004
- typeLinks={{
4005
- OrderProcessState: '/reference/graphql-api/admin/object-types#orderprocessstate',
4006
- String: '/reference/graphql-api/admin/object-types#string',
4007
- PermissionDefinition: '/reference/graphql-api/admin/object-types#permissiondefinition',
4008
- Int: '/reference/graphql-api/admin/object-types#int',
4009
- CustomFields: '/reference/graphql-api/admin/object-types#customfields',
4010
- EntityCustomFields: '/reference/graphql-api/admin/object-types#entitycustomfields',
4011
- }}
4012
- >
4013
- {`type ServerConfig {
4014
- orderProcess: [OrderProcessState!]!
4015
- permittedAssetTypes: [String!]!
4016
- permissions: [PermissionDefinition!]!
4017
- moneyStrategyPrecision: Int!
4018
- """
4019
- This field is deprecated in v2.2 in favor of the entityCustomFields field,
4020
- which allows custom fields to be defined on user-supplies entities.
4021
- """
4022
- customFieldConfig: CustomFields!
4023
- entityCustomFields: [EntityCustomFields!]!
4024
- }`}
4025
- </GraphQLDoc>
4026
-
4027
- ## SetCustomerForDraftOrderResult {#setcustomerfordraftorderresult}
4028
-
4029
- <GraphQLDoc
4030
- type="union"
4031
- typeName="SetCustomerForDraftOrderResult"
4032
- typeLinks={{
4033
- Order: '/reference/graphql-api/admin/object-types#order',
4034
- EmailAddressConflictError: '/reference/graphql-api/admin/object-types#emailaddressconflicterror',
4035
- }}
4036
- >
4037
- {`union SetCustomerForDraftOrderResult = Order | EmailAddressConflictError`}
4038
- </GraphQLDoc>
4039
-
4040
- ## SetOrderShippingMethodResult {#setordershippingmethodresult}
4041
-
4042
- <GraphQLDoc
4043
- type="union"
4044
- typeName="SetOrderShippingMethodResult"
4045
- typeLinks={{
4046
- Order: '/reference/graphql-api/admin/object-types#order',
4047
- OrderModificationError: '/reference/graphql-api/admin/object-types#ordermodificationerror',
4048
- IneligibleShippingMethodError: '/reference/graphql-api/admin/object-types#ineligibleshippingmethoderror',
4049
- NoActiveOrderError: '/reference/graphql-api/admin/object-types#noactiveordererror',
4050
- }}
4051
- >
4052
- {`union SetOrderShippingMethodResult = Order | OrderModificationError | IneligibleShippingMethodError | NoActiveOrderError`}
4053
- </GraphQLDoc>
4054
-
4055
- ## SetSettingsStoreValueResult {#setsettingsstorevalueresult}
4056
-
4057
- <GraphQLDoc
4058
- type="type"
4059
- typeName="SetSettingsStoreValueResult"
4060
- typeLinks={{
4061
- String: '/reference/graphql-api/admin/object-types#string',
4062
- Boolean: '/reference/graphql-api/admin/object-types#boolean',
4063
- }}
4064
- >
4065
- {`type SetSettingsStoreValueResult {
4066
- key: String!
4067
- result: Boolean!
4068
- error: String
4069
- }`}
4070
- </GraphQLDoc>
4071
-
4072
- ## SettlePaymentError {#settlepaymenterror}
4073
-
4074
- <GraphQLDoc
4075
- type="type"
4076
- typeName="SettlePaymentError"
4077
- typeLinks={{
4078
- ErrorCode: '/reference/graphql-api/admin/enums#errorcode',
4079
- String: '/reference/graphql-api/admin/object-types#string',
4080
- }}
4081
- >
4082
- {`"""Returned if the Payment settlement fails"""
4083
- type SettlePaymentError {
4084
- errorCode: ErrorCode!
4085
- message: String!
4086
- paymentErrorMessage: String!
4087
- }`}
4088
- </GraphQLDoc>
4089
-
4090
- ## SettlePaymentResult {#settlepaymentresult}
4091
-
4092
- <GraphQLDoc
4093
- type="union"
4094
- typeName="SettlePaymentResult"
4095
- typeLinks={{
4096
- Payment: '/reference/graphql-api/admin/object-types#payment',
4097
- SettlePaymentError: '/reference/graphql-api/admin/object-types#settlepaymenterror',
4098
- PaymentStateTransitionError: '/reference/graphql-api/admin/object-types#paymentstatetransitionerror',
4099
- OrderStateTransitionError: '/reference/graphql-api/admin/object-types#orderstatetransitionerror',
4100
- }}
4101
- >
4102
- {`union SettlePaymentResult = Payment | SettlePaymentError | PaymentStateTransitionError | OrderStateTransitionError`}
4103
- </GraphQLDoc>
4104
-
4105
- ## SettleRefundResult {#settlerefundresult}
4106
-
4107
- <GraphQLDoc
4108
- type="union"
4109
- typeName="SettleRefundResult"
4110
- typeLinks={{
4111
- Refund: '/reference/graphql-api/admin/object-types#refund',
4112
- RefundStateTransitionError: '/reference/graphql-api/admin/object-types#refundstatetransitionerror',
4113
- }}
4114
- >
4115
- {`union SettleRefundResult = Refund | RefundStateTransitionError`}
4116
- </GraphQLDoc>
4117
-
4118
- ## ShippingLine {#shippingline}
4119
-
4120
- <GraphQLDoc
4121
- type="type"
4122
- typeName="ShippingLine"
4123
- typeLinks={{
4124
- ID: '/reference/graphql-api/admin/object-types#id',
4125
- ShippingMethod: '/reference/graphql-api/admin/object-types#shippingmethod',
4126
- Money: '/reference/graphql-api/admin/object-types#money',
4127
- Discount: '/reference/graphql-api/admin/object-types#discount',
4128
- JSON: '/reference/graphql-api/admin/object-types#json',
4129
- }}
4130
- >
4131
- {`type ShippingLine {
4132
- id: ID!
4133
- shippingMethod: ShippingMethod!
4134
- price: Money!
4135
- priceWithTax: Money!
4136
- discountedPrice: Money!
4137
- discountedPriceWithTax: Money!
4138
- discounts: [Discount!]!
4139
- customFields: JSON
4140
- }`}
4141
- </GraphQLDoc>
4142
-
4143
- ## ShippingMethod {#shippingmethod}
4144
-
4145
- <GraphQLDoc
4146
- type="type"
4147
- typeName="ShippingMethod"
4148
- typeLinks={{
4149
- ID: '/reference/graphql-api/admin/object-types#id',
4150
- DateTime: '/reference/graphql-api/admin/object-types#datetime',
4151
- LanguageCode: '/reference/graphql-api/admin/enums#languagecode',
4152
- String: '/reference/graphql-api/admin/object-types#string',
4153
- ConfigurableOperation: '/reference/graphql-api/admin/object-types#configurableoperation',
4154
- ShippingMethodTranslation: '/reference/graphql-api/admin/object-types#shippingmethodtranslation',
4155
- JSON: '/reference/graphql-api/admin/object-types#json',
4156
- }}
4157
- >
4158
- {`type ShippingMethod {
4159
- id: ID!
4160
- createdAt: DateTime!
4161
- updatedAt: DateTime!
4162
- languageCode: LanguageCode!
4163
- code: String!
4164
- name: String!
4165
- description: String!
4166
- fulfillmentHandlerCode: String!
4167
- checker: ConfigurableOperation!
4168
- calculator: ConfigurableOperation!
4169
- translations: [ShippingMethodTranslation!]!
4170
- customFields: JSON
4171
- }`}
4172
- </GraphQLDoc>
4173
-
4174
- ## ShippingMethodList {#shippingmethodlist}
4175
-
4176
- <GraphQLDoc
4177
- type="type"
4178
- typeName="ShippingMethodList"
4179
- typeLinks={{
4180
- ShippingMethod: '/reference/graphql-api/admin/object-types#shippingmethod',
4181
- Int: '/reference/graphql-api/admin/object-types#int',
4182
- }}
4183
- >
4184
- {`type ShippingMethodList {
4185
- items: [ShippingMethod!]!
4186
- totalItems: Int!
4187
- }`}
4188
- </GraphQLDoc>
4189
-
4190
- ## ShippingMethodQuote {#shippingmethodquote}
4191
-
4192
- <GraphQLDoc
4193
- type="type"
4194
- typeName="ShippingMethodQuote"
4195
- typeLinks={{
4196
- ID: '/reference/graphql-api/admin/object-types#id',
4197
- Money: '/reference/graphql-api/admin/object-types#money',
4198
- String: '/reference/graphql-api/admin/object-types#string',
4199
- JSON: '/reference/graphql-api/admin/object-types#json',
4200
- }}
4201
- >
4202
- {`type ShippingMethodQuote {
4203
- id: ID!
4204
- price: Money!
4205
- priceWithTax: Money!
4206
- code: String!
4207
- name: String!
4208
- description: String!
4209
- """Any optional metadata returned by the ShippingCalculator in the ShippingCalculationResult"""
4210
- metadata: JSON
4211
- customFields: JSON
4212
- }`}
4213
- </GraphQLDoc>
4214
-
4215
- ## ShippingMethodTranslation {#shippingmethodtranslation}
4216
-
4217
- <GraphQLDoc
4218
- type="type"
4219
- typeName="ShippingMethodTranslation"
4220
- typeLinks={{
4221
- ID: '/reference/graphql-api/admin/object-types#id',
4222
- DateTime: '/reference/graphql-api/admin/object-types#datetime',
4223
- LanguageCode: '/reference/graphql-api/admin/enums#languagecode',
4224
- String: '/reference/graphql-api/admin/object-types#string',
4225
- }}
4226
- >
4227
- {`type ShippingMethodTranslation {
4228
- id: ID!
4229
- createdAt: DateTime!
4230
- updatedAt: DateTime!
4231
- languageCode: LanguageCode!
4232
- name: String!
4233
- description: String!
4234
- }`}
4235
- </GraphQLDoc>
4236
-
4237
- ## SinglePrice {#singleprice}
4238
-
4239
- <GraphQLDoc
4240
- type="type"
4241
- typeName="SinglePrice"
4242
- typeLinks={{
4243
- Money: '/reference/graphql-api/admin/object-types#money',
4244
- }}
4245
- >
4246
- {`"""The price value where the result has a single price"""
4247
- type SinglePrice {
4248
- value: Money!
4249
- }`}
4250
- </GraphQLDoc>
4251
-
4252
- ## StockAdjustment {#stockadjustment}
4253
-
4254
- <GraphQLDoc
4255
- type="type"
4256
- typeName="StockAdjustment"
4257
- typeLinks={{
4258
- ID: '/reference/graphql-api/admin/object-types#id',
4259
- DateTime: '/reference/graphql-api/admin/object-types#datetime',
4260
- ProductVariant: '/reference/graphql-api/admin/object-types#productvariant',
4261
- StockMovementType: '/reference/graphql-api/admin/enums#stockmovementtype',
4262
- Int: '/reference/graphql-api/admin/object-types#int',
4263
- JSON: '/reference/graphql-api/admin/object-types#json',
4264
- }}
4265
- >
4266
- {`type StockAdjustment {
4267
- id: ID!
4268
- createdAt: DateTime!
4269
- updatedAt: DateTime!
4270
- productVariant: ProductVariant!
4271
- type: StockMovementType!
4272
- quantity: Int!
4273
- customFields: JSON
4274
- }`}
4275
- </GraphQLDoc>
4276
-
4277
- ## StockLevel {#stocklevel}
4278
-
4279
- <GraphQLDoc
4280
- type="type"
4281
- typeName="StockLevel"
4282
- typeLinks={{
4283
- ID: '/reference/graphql-api/admin/object-types#id',
4284
- DateTime: '/reference/graphql-api/admin/object-types#datetime',
4285
- Int: '/reference/graphql-api/admin/object-types#int',
4286
- StockLocation: '/reference/graphql-api/admin/object-types#stocklocation',
4287
- JSON: '/reference/graphql-api/admin/object-types#json',
4288
- }}
4289
- >
4290
- {`type StockLevel {
4291
- id: ID!
4292
- createdAt: DateTime!
4293
- updatedAt: DateTime!
4294
- stockLocationId: ID!
4295
- stockOnHand: Int!
4296
- stockAllocated: Int!
4297
- stockLocation: StockLocation!
4298
- customFields: JSON
4299
- }`}
4300
- </GraphQLDoc>
4301
-
4302
- ## StockLocation {#stocklocation}
4303
-
4304
- <GraphQLDoc
4305
- type="type"
4306
- typeName="StockLocation"
4307
- typeLinks={{
4308
- ID: '/reference/graphql-api/admin/object-types#id',
4309
- DateTime: '/reference/graphql-api/admin/object-types#datetime',
4310
- String: '/reference/graphql-api/admin/object-types#string',
4311
- JSON: '/reference/graphql-api/admin/object-types#json',
4312
- }}
4313
- >
4314
- {`type StockLocation {
4315
- id: ID!
4316
- createdAt: DateTime!
4317
- updatedAt: DateTime!
4318
- name: String!
4319
- description: String!
4320
- customFields: JSON
4321
- }`}
4322
- </GraphQLDoc>
4323
-
4324
- ## StockLocationList {#stocklocationlist}
4325
-
4326
- <GraphQLDoc
4327
- type="type"
4328
- typeName="StockLocationList"
4329
- typeLinks={{
4330
- StockLocation: '/reference/graphql-api/admin/object-types#stocklocation',
4331
- Int: '/reference/graphql-api/admin/object-types#int',
4332
- }}
4333
- >
4334
- {`type StockLocationList {
4335
- items: [StockLocation!]!
4336
- totalItems: Int!
4337
- }`}
4338
- </GraphQLDoc>
4339
-
4340
- ## StockMovementItem {#stockmovementitem}
4341
-
4342
- <GraphQLDoc
4343
- type="union"
4344
- typeName="StockMovementItem"
4345
- typeLinks={{
4346
- StockAdjustment: '/reference/graphql-api/admin/object-types#stockadjustment',
4347
- Allocation: '/reference/graphql-api/admin/object-types#allocation',
4348
- Sale: '/reference/graphql-api/admin/object-types#sale',
4349
- Cancellation: '/reference/graphql-api/admin/object-types#cancellation',
4350
- Return: '/reference/graphql-api/admin/object-types#return',
4351
- Release: '/reference/graphql-api/admin/object-types#release',
4352
- }}
4353
- >
4354
- {`union StockMovementItem = StockAdjustment | Allocation | Sale | Cancellation | Return | Release`}
4355
- </GraphQLDoc>
4356
-
4357
- ## StockMovementList {#stockmovementlist}
4358
-
4359
- <GraphQLDoc
4360
- type="type"
4361
- typeName="StockMovementList"
4362
- typeLinks={{
4363
- StockMovementItem: '/reference/graphql-api/admin/object-types#stockmovementitem',
4364
- Int: '/reference/graphql-api/admin/object-types#int',
4365
- }}
4366
- >
4367
- {`type StockMovementList {
4368
- items: [StockMovementItem!]!
4369
- totalItems: Int!
4370
- }`}
4371
- </GraphQLDoc>
4372
-
4373
- ## String {#string}
4374
-
4375
- <GraphQLDoc
4376
- type="scalar"
4377
- typeName="String"
4378
- typeLinks={{}}
4379
- >
4380
- {`"""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."""
4381
- scalar String`}
4382
- </GraphQLDoc>
4383
-
4384
- ## StringCustomFieldConfig {#stringcustomfieldconfig}
4385
-
4386
- <GraphQLDoc
4387
- type="type"
4388
- typeName="StringCustomFieldConfig"
4389
- typeLinks={{
4390
- String: '/reference/graphql-api/admin/object-types#string',
4391
- Boolean: '/reference/graphql-api/admin/object-types#boolean',
4392
- Int: '/reference/graphql-api/admin/object-types#int',
4393
- LocalizedString: '/reference/graphql-api/admin/object-types#localizedstring',
4394
- Permission: '/reference/graphql-api/admin/enums#permission',
4395
- StringFieldOption: '/reference/graphql-api/admin/object-types#stringfieldoption',
4396
- JSON: '/reference/graphql-api/admin/object-types#json',
4397
- }}
4398
- >
4399
- {`type StringCustomFieldConfig {
4400
- name: String!
4401
- type: String!
4402
- list: Boolean!
4403
- length: Int
4404
- label: [LocalizedString!]
4405
- description: [LocalizedString!]
4406
- readonly: Boolean
4407
- internal: Boolean
4408
- nullable: Boolean
4409
- requiresPermission: [Permission!]
4410
- deprecated: Boolean
4411
- deprecationReason: String
4412
- pattern: String
4413
- options: [StringFieldOption!]
4414
- ui: JSON
4415
- }`}
4416
- </GraphQLDoc>
4417
-
4418
- ## StringFieldOption {#stringfieldoption}
4419
-
4420
- <GraphQLDoc
4421
- type="type"
4422
- typeName="StringFieldOption"
4423
- typeLinks={{
4424
- String: '/reference/graphql-api/admin/object-types#string',
4425
- LocalizedString: '/reference/graphql-api/admin/object-types#localizedstring',
4426
- }}
4427
- >
4428
- {`type StringFieldOption {
4429
- value: String!
4430
- label: [LocalizedString!]
4431
- }`}
4432
- </GraphQLDoc>
4433
-
4434
- ## StringStructFieldConfig {#stringstructfieldconfig}
4435
-
4436
- <GraphQLDoc
4437
- type="type"
4438
- typeName="StringStructFieldConfig"
4439
- typeLinks={{
4440
- String: '/reference/graphql-api/admin/object-types#string',
4441
- Boolean: '/reference/graphql-api/admin/object-types#boolean',
4442
- LocalizedString: '/reference/graphql-api/admin/object-types#localizedstring',
4443
- Int: '/reference/graphql-api/admin/object-types#int',
4444
- StringFieldOption: '/reference/graphql-api/admin/object-types#stringfieldoption',
4445
- JSON: '/reference/graphql-api/admin/object-types#json',
4446
- }}
4447
- >
4448
- {`type StringStructFieldConfig {
4449
- name: String!
4450
- type: String!
4451
- list: Boolean!
4452
- label: [LocalizedString!]
4453
- description: [LocalizedString!]
4454
- length: Int
4455
- pattern: String
4456
- options: [StringFieldOption!]
4457
- ui: JSON
4458
- }`}
4459
- </GraphQLDoc>
4460
-
4461
- ## StructCustomFieldConfig {#structcustomfieldconfig}
4462
-
4463
- <GraphQLDoc
4464
- type="type"
4465
- typeName="StructCustomFieldConfig"
4466
- typeLinks={{
4467
- String: '/reference/graphql-api/admin/object-types#string',
4468
- Boolean: '/reference/graphql-api/admin/object-types#boolean',
4469
- StructFieldConfig: '/reference/graphql-api/admin/object-types#structfieldconfig',
4470
- LocalizedString: '/reference/graphql-api/admin/object-types#localizedstring',
4471
- Permission: '/reference/graphql-api/admin/enums#permission',
4472
- JSON: '/reference/graphql-api/admin/object-types#json',
4473
- }}
4474
- >
4475
- {`type StructCustomFieldConfig {
4476
- name: String!
4477
- type: String!
4478
- list: Boolean!
4479
- fields: [StructFieldConfig!]!
4480
- label: [LocalizedString!]
4481
- description: [LocalizedString!]
4482
- readonly: Boolean
4483
- internal: Boolean
4484
- nullable: Boolean
4485
- requiresPermission: [Permission!]
4486
- deprecated: Boolean
4487
- deprecationReason: String
4488
- ui: JSON
4489
- }`}
4490
- </GraphQLDoc>
4491
-
4492
- ## StructFieldConfig {#structfieldconfig}
4493
-
4494
- <GraphQLDoc
4495
- type="union"
4496
- typeName="StructFieldConfig"
4497
- typeLinks={{
4498
- StringStructFieldConfig: '/reference/graphql-api/admin/object-types#stringstructfieldconfig',
4499
- IntStructFieldConfig: '/reference/graphql-api/admin/object-types#intstructfieldconfig',
4500
- FloatStructFieldConfig: '/reference/graphql-api/admin/object-types#floatstructfieldconfig',
4501
- BooleanStructFieldConfig: '/reference/graphql-api/admin/object-types#booleanstructfieldconfig',
4502
- DateTimeStructFieldConfig: '/reference/graphql-api/admin/object-types#datetimestructfieldconfig',
4503
- TextStructFieldConfig: '/reference/graphql-api/admin/object-types#textstructfieldconfig',
4504
- }}
4505
- >
4506
- {`union StructFieldConfig = StringStructFieldConfig | IntStructFieldConfig | FloatStructFieldConfig | BooleanStructFieldConfig | DateTimeStructFieldConfig | TextStructFieldConfig`}
4507
- </GraphQLDoc>
4508
-
4509
- ## Success {#success}
4510
-
4511
- <GraphQLDoc
4512
- type="type"
4513
- typeName="Success"
4514
- typeLinks={{
4515
- Boolean: '/reference/graphql-api/admin/object-types#boolean',
4516
- }}
4517
- >
4518
- {`"""Indicates that an operation succeeded, where we do not want to return any more specific information."""
4519
- type Success {
4520
- success: Boolean!
4521
- }`}
4522
- </GraphQLDoc>
4523
-
4524
- ## Surcharge {#surcharge}
4525
-
4526
- <GraphQLDoc
4527
- type="type"
4528
- typeName="Surcharge"
4529
- typeLinks={{
4530
- ID: '/reference/graphql-api/admin/object-types#id',
4531
- DateTime: '/reference/graphql-api/admin/object-types#datetime',
4532
- String: '/reference/graphql-api/admin/object-types#string',
4533
- TaxLine: '/reference/graphql-api/admin/object-types#taxline',
4534
- Money: '/reference/graphql-api/admin/object-types#money',
4535
- Float: '/reference/graphql-api/admin/object-types#float',
4536
- }}
4537
- >
4538
- {`type Surcharge {
4539
- id: ID!
4540
- createdAt: DateTime!
4541
- updatedAt: DateTime!
4542
- description: String!
4543
- sku: String
4544
- taxLines: [TaxLine!]!
4545
- price: Money!
4546
- priceWithTax: Money!
4547
- taxRate: Float!
4548
- }`}
4549
- </GraphQLDoc>
4550
-
4551
- ## Tag {#tag}
4552
-
4553
- <GraphQLDoc
4554
- type="type"
4555
- typeName="Tag"
4556
- typeLinks={{
4557
- ID: '/reference/graphql-api/admin/object-types#id',
4558
- DateTime: '/reference/graphql-api/admin/object-types#datetime',
4559
- String: '/reference/graphql-api/admin/object-types#string',
4560
- }}
4561
- >
4562
- {`type Tag {
4563
- id: ID!
4564
- createdAt: DateTime!
4565
- updatedAt: DateTime!
4566
- value: String!
4567
- }`}
4568
- </GraphQLDoc>
4569
-
4570
- ## TagList {#taglist}
4571
-
4572
- <GraphQLDoc
4573
- type="type"
4574
- typeName="TagList"
4575
- typeLinks={{
4576
- Tag: '/reference/graphql-api/admin/object-types#tag',
4577
- Int: '/reference/graphql-api/admin/object-types#int',
4578
- }}
4579
- >
4580
- {`type TagList {
4581
- items: [Tag!]!
4582
- totalItems: Int!
4583
- }`}
4584
- </GraphQLDoc>
4585
-
4586
- ## TaxCategory {#taxcategory}
4587
-
4588
- <GraphQLDoc
4589
- type="type"
4590
- typeName="TaxCategory"
4591
- typeLinks={{
4592
- ID: '/reference/graphql-api/admin/object-types#id',
4593
- DateTime: '/reference/graphql-api/admin/object-types#datetime',
4594
- String: '/reference/graphql-api/admin/object-types#string',
4595
- Boolean: '/reference/graphql-api/admin/object-types#boolean',
4596
- JSON: '/reference/graphql-api/admin/object-types#json',
4597
- }}
4598
- >
4599
- {`type TaxCategory {
4600
- id: ID!
4601
- createdAt: DateTime!
4602
- updatedAt: DateTime!
4603
- name: String!
4604
- isDefault: Boolean!
4605
- customFields: JSON
4606
- }`}
4607
- </GraphQLDoc>
4608
-
4609
- ## TaxCategoryList {#taxcategorylist}
4610
-
4611
- <GraphQLDoc
4612
- type="type"
4613
- typeName="TaxCategoryList"
4614
- typeLinks={{
4615
- TaxCategory: '/reference/graphql-api/admin/object-types#taxcategory',
4616
- Int: '/reference/graphql-api/admin/object-types#int',
4617
- }}
4618
- >
4619
- {`type TaxCategoryList {
4620
- items: [TaxCategory!]!
4621
- totalItems: Int!
4622
- }`}
4623
- </GraphQLDoc>
4624
-
4625
- ## TaxLine {#taxline}
4626
-
4627
- <GraphQLDoc
4628
- type="type"
4629
- typeName="TaxLine"
4630
- typeLinks={{
4631
- String: '/reference/graphql-api/admin/object-types#string',
4632
- Float: '/reference/graphql-api/admin/object-types#float',
4633
- }}
4634
- >
4635
- {`type TaxLine {
4636
- description: String!
4637
- taxRate: Float!
4638
- }`}
4639
- </GraphQLDoc>
4640
-
4641
- ## TaxRate {#taxrate}
4642
-
4643
- <GraphQLDoc
4644
- type="type"
4645
- typeName="TaxRate"
4646
- typeLinks={{
4647
- ID: '/reference/graphql-api/admin/object-types#id',
4648
- DateTime: '/reference/graphql-api/admin/object-types#datetime',
4649
- String: '/reference/graphql-api/admin/object-types#string',
4650
- Boolean: '/reference/graphql-api/admin/object-types#boolean',
4651
- Float: '/reference/graphql-api/admin/object-types#float',
4652
- TaxCategory: '/reference/graphql-api/admin/object-types#taxcategory',
4653
- Zone: '/reference/graphql-api/admin/object-types#zone',
4654
- CustomerGroup: '/reference/graphql-api/admin/object-types#customergroup',
4655
- JSON: '/reference/graphql-api/admin/object-types#json',
4656
- }}
4657
- >
4658
- {`type TaxRate {
4659
- id: ID!
4660
- createdAt: DateTime!
4661
- updatedAt: DateTime!
4662
- name: String!
4663
- enabled: Boolean!
4664
- value: Float!
4665
- category: TaxCategory!
4666
- zone: Zone!
4667
- customerGroup: CustomerGroup
4668
- customFields: JSON
4669
- }`}
4670
- </GraphQLDoc>
4671
-
4672
- ## TaxRateList {#taxratelist}
4673
-
4674
- <GraphQLDoc
4675
- type="type"
4676
- typeName="TaxRateList"
4677
- typeLinks={{
4678
- TaxRate: '/reference/graphql-api/admin/object-types#taxrate',
4679
- Int: '/reference/graphql-api/admin/object-types#int',
4680
- }}
4681
- >
4682
- {`type TaxRateList {
4683
- items: [TaxRate!]!
4684
- totalItems: Int!
4685
- }`}
4686
- </GraphQLDoc>
4687
-
4688
- ## TestShippingMethodQuote {#testshippingmethodquote}
4689
-
4690
- <GraphQLDoc
4691
- type="type"
4692
- typeName="TestShippingMethodQuote"
4693
- typeLinks={{
4694
- Money: '/reference/graphql-api/admin/object-types#money',
4695
- JSON: '/reference/graphql-api/admin/object-types#json',
4696
- }}
4697
- >
4698
- {`type TestShippingMethodQuote {
4699
- price: Money!
4700
- priceWithTax: Money!
4701
- metadata: JSON
4702
- }`}
4703
- </GraphQLDoc>
4704
-
4705
- ## TestShippingMethodResult {#testshippingmethodresult}
4706
-
4707
- <GraphQLDoc
4708
- type="type"
4709
- typeName="TestShippingMethodResult"
4710
- typeLinks={{
4711
- Boolean: '/reference/graphql-api/admin/object-types#boolean',
4712
- TestShippingMethodQuote: '/reference/graphql-api/admin/object-types#testshippingmethodquote',
4713
- }}
4714
- >
4715
- {`type TestShippingMethodResult {
4716
- eligible: Boolean!
4717
- quote: TestShippingMethodQuote
4718
- }`}
4719
- </GraphQLDoc>
4720
-
4721
- ## TextCustomFieldConfig {#textcustomfieldconfig}
4722
-
4723
- <GraphQLDoc
4724
- type="type"
4725
- typeName="TextCustomFieldConfig"
4726
- typeLinks={{
4727
- String: '/reference/graphql-api/admin/object-types#string',
4728
- Boolean: '/reference/graphql-api/admin/object-types#boolean',
4729
- LocalizedString: '/reference/graphql-api/admin/object-types#localizedstring',
4730
- Permission: '/reference/graphql-api/admin/enums#permission',
4731
- JSON: '/reference/graphql-api/admin/object-types#json',
4732
- }}
4733
- >
4734
- {`type TextCustomFieldConfig {
4735
- name: String!
4736
- type: String!
4737
- list: Boolean!
4738
- label: [LocalizedString!]
4739
- description: [LocalizedString!]
4740
- readonly: Boolean
4741
- internal: Boolean
4742
- nullable: Boolean
4743
- requiresPermission: [Permission!]
4744
- deprecated: Boolean
4745
- deprecationReason: String
4746
- ui: JSON
4747
- }`}
4748
- </GraphQLDoc>
4749
-
4750
- ## TextStructFieldConfig {#textstructfieldconfig}
4751
-
4752
- <GraphQLDoc
4753
- type="type"
4754
- typeName="TextStructFieldConfig"
4755
- typeLinks={{
4756
- String: '/reference/graphql-api/admin/object-types#string',
4757
- Boolean: '/reference/graphql-api/admin/object-types#boolean',
4758
- LocalizedString: '/reference/graphql-api/admin/object-types#localizedstring',
4759
- JSON: '/reference/graphql-api/admin/object-types#json',
4760
- }}
4761
- >
4762
- {`type TextStructFieldConfig {
4763
- name: String!
4764
- type: String!
4765
- list: Boolean!
4766
- label: [LocalizedString!]
4767
- description: [LocalizedString!]
4768
- ui: JSON
4769
- }`}
4770
- </GraphQLDoc>
4771
-
4772
- ## TransitionFulfillmentToStateResult {#transitionfulfillmenttostateresult}
4773
-
4774
- <GraphQLDoc
4775
- type="union"
4776
- typeName="TransitionFulfillmentToStateResult"
4777
- typeLinks={{
4778
- Fulfillment: '/reference/graphql-api/admin/object-types#fulfillment',
4779
- FulfillmentStateTransitionError: '/reference/graphql-api/admin/object-types#fulfillmentstatetransitionerror',
4780
- }}
4781
- >
4782
- {`union TransitionFulfillmentToStateResult = Fulfillment | FulfillmentStateTransitionError`}
4783
- </GraphQLDoc>
4784
-
4785
- ## TransitionOrderToStateResult {#transitionordertostateresult}
4786
-
4787
- <GraphQLDoc
4788
- type="union"
4789
- typeName="TransitionOrderToStateResult"
4790
- typeLinks={{
4791
- Order: '/reference/graphql-api/admin/object-types#order',
4792
- OrderStateTransitionError: '/reference/graphql-api/admin/object-types#orderstatetransitionerror',
4793
- }}
4794
- >
4795
- {`union TransitionOrderToStateResult = Order | OrderStateTransitionError`}
4796
- </GraphQLDoc>
4797
-
4798
- ## TransitionPaymentToStateResult {#transitionpaymenttostateresult}
4799
-
4800
- <GraphQLDoc
4801
- type="union"
4802
- typeName="TransitionPaymentToStateResult"
4803
- typeLinks={{
4804
- Payment: '/reference/graphql-api/admin/object-types#payment',
4805
- PaymentStateTransitionError: '/reference/graphql-api/admin/object-types#paymentstatetransitionerror',
4806
- }}
4807
- >
4808
- {`union TransitionPaymentToStateResult = Payment | PaymentStateTransitionError`}
4809
- </GraphQLDoc>
4810
-
4811
- ## UpdateChannelResult {#updatechannelresult}
4812
-
4813
- <GraphQLDoc
4814
- type="union"
4815
- typeName="UpdateChannelResult"
4816
- typeLinks={{
4817
- Channel: '/reference/graphql-api/admin/object-types#channel',
4818
- LanguageNotAvailableError: '/reference/graphql-api/admin/object-types#languagenotavailableerror',
4819
- }}
4820
- >
4821
- {`union UpdateChannelResult = Channel | LanguageNotAvailableError`}
4822
- </GraphQLDoc>
4823
-
4824
- ## UpdateCustomerResult {#updatecustomerresult}
4825
-
4826
- <GraphQLDoc
4827
- type="union"
4828
- typeName="UpdateCustomerResult"
4829
- typeLinks={{
4830
- Customer: '/reference/graphql-api/admin/object-types#customer',
4831
- EmailAddressConflictError: '/reference/graphql-api/admin/object-types#emailaddressconflicterror',
4832
- }}
4833
- >
4834
- {`union UpdateCustomerResult = Customer | EmailAddressConflictError`}
4835
- </GraphQLDoc>
4836
-
4837
- ## UpdateGlobalSettingsResult {#updateglobalsettingsresult}
4838
-
4839
- <GraphQLDoc
4840
- type="union"
4841
- typeName="UpdateGlobalSettingsResult"
4842
- typeLinks={{
4843
- GlobalSettings: '/reference/graphql-api/admin/object-types#globalsettings',
4844
- ChannelDefaultLanguageError: '/reference/graphql-api/admin/object-types#channeldefaultlanguageerror',
4845
- }}
4846
- >
4847
- {`union UpdateGlobalSettingsResult = GlobalSettings | ChannelDefaultLanguageError`}
4848
- </GraphQLDoc>
4849
-
4850
- ## UpdateOrderItemErrorResult {#updateorderitemerrorresult}
4851
-
4852
- <GraphQLDoc
4853
- type="union"
4854
- typeName="UpdateOrderItemErrorResult"
4855
- typeLinks={{
4856
- OrderModificationError: '/reference/graphql-api/admin/object-types#ordermodificationerror',
4857
- OrderLimitError: '/reference/graphql-api/admin/object-types#orderlimiterror',
4858
- NegativeQuantityError: '/reference/graphql-api/admin/object-types#negativequantityerror',
4859
- InsufficientStockError: '/reference/graphql-api/admin/object-types#insufficientstockerror',
4860
- OrderInterceptorError: '/reference/graphql-api/admin/object-types#orderinterceptorerror',
4861
- }}
4862
- >
4863
- {`"""Union type of all possible errors that can occur when adding or removing items from an Order."""
4864
- union UpdateOrderItemErrorResult = OrderModificationError | OrderLimitError | NegativeQuantityError | InsufficientStockError | OrderInterceptorError`}
4865
- </GraphQLDoc>
4866
-
4867
- ## UpdateOrderItemsResult {#updateorderitemsresult}
4868
-
4869
- <GraphQLDoc
4870
- type="union"
4871
- typeName="UpdateOrderItemsResult"
4872
- typeLinks={{
4873
- Order: '/reference/graphql-api/admin/object-types#order',
4874
- OrderModificationError: '/reference/graphql-api/admin/object-types#ordermodificationerror',
4875
- OrderLimitError: '/reference/graphql-api/admin/object-types#orderlimiterror',
4876
- NegativeQuantityError: '/reference/graphql-api/admin/object-types#negativequantityerror',
4877
- InsufficientStockError: '/reference/graphql-api/admin/object-types#insufficientstockerror',
4878
- OrderInterceptorError: '/reference/graphql-api/admin/object-types#orderinterceptorerror',
4879
- }}
4880
- >
4881
- {`union UpdateOrderItemsResult = Order | OrderModificationError | OrderLimitError | NegativeQuantityError | InsufficientStockError | OrderInterceptorError`}
4882
- </GraphQLDoc>
4883
-
4884
- ## UpdatePromotionResult {#updatepromotionresult}
4885
-
4886
- <GraphQLDoc
4887
- type="union"
4888
- typeName="UpdatePromotionResult"
4889
- typeLinks={{
4890
- Promotion: '/reference/graphql-api/admin/object-types#promotion',
4891
- MissingConditionsError: '/reference/graphql-api/admin/object-types#missingconditionserror',
4892
- }}
4893
- >
4894
- {`union UpdatePromotionResult = Promotion | MissingConditionsError`}
4895
- </GraphQLDoc>
4896
-
4897
- ## Upload {#upload}
4898
-
4899
- <GraphQLDoc
4900
- type="scalar"
4901
- typeName="Upload"
4902
- typeLinks={{}}
4903
- >
4904
- {`"""The \`Upload\` scalar type represents a file upload."""
4905
- scalar Upload`}
4906
- </GraphQLDoc>
4907
-
4908
- ## User {#user}
4909
-
4910
- <GraphQLDoc
4911
- type="type"
4912
- typeName="User"
4913
- typeLinks={{
4914
- ID: '/reference/graphql-api/admin/object-types#id',
4915
- DateTime: '/reference/graphql-api/admin/object-types#datetime',
4916
- String: '/reference/graphql-api/admin/object-types#string',
4917
- Boolean: '/reference/graphql-api/admin/object-types#boolean',
4918
- Role: '/reference/graphql-api/admin/object-types#role',
4919
- AuthenticationMethod: '/reference/graphql-api/admin/object-types#authenticationmethod',
4920
- JSON: '/reference/graphql-api/admin/object-types#json',
4921
- }}
4922
- >
4923
- {`type User {
4924
- id: ID!
4925
- createdAt: DateTime!
4926
- updatedAt: DateTime!
4927
- identifier: String!
4928
- verified: Boolean!
4929
- roles: [Role!]!
4930
- lastLogin: DateTime
4931
- authenticationMethods: [AuthenticationMethod!]!
4932
- customFields: JSON
4933
- }`}
4934
- </GraphQLDoc>
4935
-
4936
- ## Zone {#zone}
4937
-
4938
- <GraphQLDoc
4939
- type="type"
4940
- typeName="Zone"
4941
- typeLinks={{
4942
- ID: '/reference/graphql-api/admin/object-types#id',
4943
- DateTime: '/reference/graphql-api/admin/object-types#datetime',
4944
- String: '/reference/graphql-api/admin/object-types#string',
4945
- Region: '/reference/graphql-api/admin/object-types#region',
4946
- JSON: '/reference/graphql-api/admin/object-types#json',
4947
- }}
4948
- >
4949
- {`type Zone {
4950
- id: ID!
4951
- createdAt: DateTime!
4952
- updatedAt: DateTime!
4953
- name: String!
4954
- members: [Region!]!
4955
- customFields: JSON
4956
- }`}
4957
- </GraphQLDoc>
4958
-
4959
- ## ZoneList {#zonelist}
4960
-
4961
- <GraphQLDoc
4962
- type="type"
4963
- typeName="ZoneList"
4964
- typeLinks={{
4965
- Zone: '/reference/graphql-api/admin/object-types#zone',
4966
- Int: '/reference/graphql-api/admin/object-types#int',
4967
- }}
4968
- >
4969
- {`type ZoneList {
4970
- items: [Zone!]!
4971
- totalItems: Int!
4972
- }`}
4973
- </GraphQLDoc>