@vendure/docs 0.0.0-202601211103 → 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.
- package/docs/reference/admin-ui-api/bulk-actions/bulk-action.mdx +1 -1
- package/docs/reference/admin-ui-api/components/asset-picker-dialog-component.mdx +1 -1
- package/docs/reference/admin-ui-api/components/currency-input-component.mdx +1 -1
- package/docs/reference/admin-ui-api/components/data-table-component.mdx +1 -1
- package/docs/reference/admin-ui-api/components/data-table2component.mdx +1 -1
- package/docs/reference/admin-ui-api/components/datetime-picker-component.mdx +1 -1
- package/docs/reference/admin-ui-api/components/facet-value-selector-component.mdx +1 -1
- package/docs/reference/admin-ui-api/components/object-tree-component.mdx +1 -1
- package/docs/reference/admin-ui-api/components/product-variant-selector-component.mdx +1 -1
- package/docs/reference/admin-ui-api/components/rich-text-editor-component.mdx +1 -1
- package/docs/reference/admin-ui-api/components/zone-selector-component.mdx +1 -1
- package/docs/reference/admin-ui-api/custom-history-entry-components/customer-history-entry-component.mdx +1 -1
- package/docs/reference/admin-ui-api/custom-history-entry-components/order-history-entry-component.mdx +1 -1
- package/docs/reference/admin-ui-api/custom-input-components/default-inputs.mdx +19 -19
- package/docs/reference/admin-ui-api/directives/if-multichannel-directive.mdx +1 -1
- package/docs/reference/admin-ui-api/directives/if-permissions-directive.mdx +1 -1
- package/docs/reference/admin-ui-api/list-detail-views/base-detail-component.mdx +1 -1
- package/docs/reference/admin-ui-api/list-detail-views/base-list-component.mdx +1 -1
- package/docs/reference/admin-ui-api/list-detail-views/typed-base-detail-component.mdx +1 -1
- package/docs/reference/admin-ui-api/list-detail-views/typed-base-list-component.mdx +2 -2
- package/docs/reference/admin-ui-api/pipes/asset-preview-pipe.mdx +1 -1
- package/docs/reference/admin-ui-api/pipes/duration-pipe.mdx +1 -1
- package/docs/reference/admin-ui-api/pipes/file-size-pipe.mdx +1 -1
- package/docs/reference/admin-ui-api/pipes/has-permission-pipe.mdx +1 -1
- package/docs/reference/admin-ui-api/pipes/locale-currency-name-pipe.mdx +2 -2
- package/docs/reference/admin-ui-api/pipes/locale-currency-pipe.mdx +2 -2
- package/docs/reference/admin-ui-api/pipes/locale-date-pipe.mdx +2 -2
- package/docs/reference/admin-ui-api/pipes/locale-language-name-pipe.mdx +2 -2
- package/docs/reference/admin-ui-api/pipes/locale-region-name-pipe.mdx +2 -2
- package/docs/reference/admin-ui-api/pipes/time-ago-pipe.mdx +1 -1
- package/docs/reference/admin-ui-api/ui-devkit/admin-ui-extension.mdx +1 -1
- package/docs/reference/core-plugins/admin-ui-plugin/index.mdx +1 -1
- package/docs/reference/core-plugins/asset-server-plugin/hashed-asset-naming-strategy.mdx +1 -1
- package/docs/reference/core-plugins/asset-server-plugin/image-transform-strategy.mdx +1 -1
- package/docs/reference/core-plugins/asset-server-plugin/index.mdx +1 -1
- package/docs/reference/core-plugins/asset-server-plugin/local-asset-storage-strategy.mdx +1 -1
- package/docs/reference/core-plugins/asset-server-plugin/preset-only-strategy.mdx +1 -1
- package/docs/reference/core-plugins/asset-server-plugin/s3asset-storage-strategy.mdx +1 -1
- package/docs/reference/core-plugins/asset-server-plugin/sharp-asset-preview-strategy.mdx +1 -1
- package/docs/reference/core-plugins/dashboard-plugin/index.mdx +1 -1
- package/docs/reference/core-plugins/elasticsearch-plugin/index.mdx +1 -1
- package/docs/reference/core-plugins/email-plugin/email-event-handler-with-async-data.mdx +1 -1
- package/docs/reference/core-plugins/email-plugin/email-generator.mdx +2 -2
- package/docs/reference/core-plugins/email-plugin/email-plugin-options.mdx +1 -1
- package/docs/reference/core-plugins/email-plugin/email-send-event.mdx +1 -1
- package/docs/reference/core-plugins/email-plugin/email-sender.mdx +2 -2
- package/docs/reference/core-plugins/email-plugin/index.mdx +1 -1
- package/docs/reference/core-plugins/email-plugin/template-loader.mdx +1 -1
- package/docs/reference/core-plugins/email-plugin/transport-options.mdx +2 -2
- package/docs/reference/core-plugins/graphiql-plugin/index.mdx +1 -1
- package/docs/reference/core-plugins/job-queue-plugin/bull-mqjob-queue-strategy.mdx +1 -1
- package/docs/reference/core-plugins/job-queue-plugin/pub-sub-job-queue-strategy.mdx +2 -2
- package/docs/reference/core-plugins/stellate-plugin/index.mdx +1 -1
- package/docs/reference/core-plugins/telemetry-plugin/otel-logger.mdx +1 -1
- package/docs/reference/dashboard/components/vendure-image.mdx +1 -1
- package/docs/reference/dashboard/page-layout/page.mdx +1 -1
- package/docs/reference/typescript-api/assets/asset-naming-strategy.mdx +1 -1
- package/docs/reference/typescript-api/assets/asset-preview-strategy.mdx +1 -1
- package/docs/reference/typescript-api/assets/asset-storage-strategy.mdx +1 -1
- package/docs/reference/typescript-api/assets/default-asset-naming-strategy.mdx +1 -1
- package/docs/reference/typescript-api/auth/authentication-strategy.mdx +1 -1
- package/docs/reference/typescript-api/auth/bcrypt-password-hashing-strategy.mdx +1 -1
- package/docs/reference/typescript-api/auth/default-password-validation-strategy.mdx +1 -1
- package/docs/reference/typescript-api/auth/default-session-cache-strategy.mdx +1 -1
- package/docs/reference/typescript-api/auth/default-verification-token-strategy.mdx +1 -1
- package/docs/reference/typescript-api/auth/in-memory-session-cache-strategy.mdx +1 -1
- package/docs/reference/typescript-api/auth/native-authentication-strategy.mdx +1 -1
- package/docs/reference/typescript-api/auth/noop-session-cache-strategy.mdx +1 -1
- package/docs/reference/typescript-api/auth/password-hashing-strategy.mdx +1 -1
- package/docs/reference/typescript-api/auth/password-validation-strategy.mdx +1 -1
- package/docs/reference/typescript-api/auth/permission-definition.mdx +2 -2
- package/docs/reference/typescript-api/auth/session-cache-strategy.mdx +1 -1
- package/docs/reference/typescript-api/auth/verification-token-strategy.mdx +1 -1
- package/docs/reference/typescript-api/cache/cache-strategy.mdx +1 -1
- package/docs/reference/typescript-api/cache/redis-cache-strategy.mdx +1 -1
- package/docs/reference/typescript-api/cache/sql-cache-strategy.mdx +1 -1
- package/docs/reference/typescript-api/common/i18n-service.mdx +1 -1
- package/docs/reference/typescript-api/configurable-operation-def/configurable-operation-def-options.mdx +1 -1
- package/docs/reference/typescript-api/configuration/collection-filter.mdx +1 -1
- package/docs/reference/typescript-api/configuration/default-slug-strategy.mdx +1 -1
- package/docs/reference/typescript-api/configuration/entity-duplicator.mdx +2 -2
- package/docs/reference/typescript-api/configuration/entity-id-strategy.mdx +3 -3
- package/docs/reference/typescript-api/configuration/product-variant-price-selection-strategy.mdx +2 -2
- package/docs/reference/typescript-api/configuration/product-variant-price-update-strategy.mdx +2 -2
- package/docs/reference/typescript-api/configuration/runtime-vendure-config.mdx +1 -1
- package/docs/reference/typescript-api/configuration/slug-strategy.mdx +1 -1
- package/docs/reference/typescript-api/data-access/calculated-property-subscriber.mdx +1 -1
- package/docs/reference/typescript-api/data-access/get-entity-or-throw-options.mdx +1 -1
- package/docs/reference/typescript-api/data-access/list-query-builder.mdx +1 -1
- package/docs/reference/typescript-api/default-search-plugin/index.mdx +1 -1
- package/docs/reference/typescript-api/default-search-plugin/mysql-search-strategy.mdx +1 -1
- package/docs/reference/typescript-api/default-search-plugin/postgres-search-strategy.mdx +1 -1
- package/docs/reference/typescript-api/default-search-plugin/search-strategy.mdx +1 -1
- package/docs/reference/typescript-api/default-search-plugin/sqlite-search-strategy.mdx +1 -1
- package/docs/reference/typescript-api/entities/address.mdx +2 -2
- package/docs/reference/typescript-api/entities/administrator.mdx +2 -2
- package/docs/reference/typescript-api/entities/anonymous-session.mdx +1 -1
- package/docs/reference/typescript-api/entities/asset.mdx +2 -2
- package/docs/reference/typescript-api/entities/authenticated-session.mdx +1 -1
- package/docs/reference/typescript-api/entities/authentication-method.mdx +3 -3
- package/docs/reference/typescript-api/entities/channel.mdx +1 -1
- package/docs/reference/typescript-api/entities/collection.mdx +2 -2
- package/docs/reference/typescript-api/entities/country.mdx +1 -1
- package/docs/reference/typescript-api/entities/customer-group.mdx +2 -2
- package/docs/reference/typescript-api/entities/customer-history-entry.mdx +1 -1
- package/docs/reference/typescript-api/entities/customer.mdx +2 -2
- package/docs/reference/typescript-api/entities/facet-value.mdx +2 -2
- package/docs/reference/typescript-api/entities/facet.mdx +2 -2
- package/docs/reference/typescript-api/entities/fulfillment.mdx +2 -2
- package/docs/reference/typescript-api/entities/global-settings.mdx +2 -2
- package/docs/reference/typescript-api/entities/history-entry.mdx +2 -2
- package/docs/reference/typescript-api/entities/order-history-entry.mdx +1 -1
- package/docs/reference/typescript-api/entities/order-line-reference.mdx +4 -4
- package/docs/reference/typescript-api/entities/order-line.mdx +2 -2
- package/docs/reference/typescript-api/entities/order-modification.mdx +1 -1
- package/docs/reference/typescript-api/entities/order.mdx +2 -2
- package/docs/reference/typescript-api/entities/orderable-asset.mdx +2 -2
- package/docs/reference/typescript-api/entities/payment-method.mdx +2 -2
- package/docs/reference/typescript-api/entities/payment.mdx +2 -2
- package/docs/reference/typescript-api/entities/product-option-group.mdx +2 -2
- package/docs/reference/typescript-api/entities/product-option.mdx +2 -2
- package/docs/reference/typescript-api/entities/product-variant-price.mdx +2 -2
- package/docs/reference/typescript-api/entities/product-variant.mdx +2 -2
- package/docs/reference/typescript-api/entities/product.mdx +2 -2
- package/docs/reference/typescript-api/entities/promotion.mdx +2 -2
- package/docs/reference/typescript-api/entities/province.mdx +1 -1
- package/docs/reference/typescript-api/entities/refund.mdx +2 -2
- package/docs/reference/typescript-api/entities/region.mdx +2 -2
- package/docs/reference/typescript-api/entities/role.mdx +2 -2
- package/docs/reference/typescript-api/entities/seller.mdx +2 -2
- package/docs/reference/typescript-api/entities/session.mdx +2 -2
- package/docs/reference/typescript-api/entities/settings-store-entry.mdx +1 -1
- package/docs/reference/typescript-api/entities/shipping-line.mdx +2 -2
- package/docs/reference/typescript-api/entities/shipping-method.mdx +2 -2
- package/docs/reference/typescript-api/entities/stock-level.mdx +2 -2
- package/docs/reference/typescript-api/entities/stock-location.mdx +2 -2
- package/docs/reference/typescript-api/entities/stock-movement.mdx +7 -7
- package/docs/reference/typescript-api/entities/surcharge.mdx +1 -1
- package/docs/reference/typescript-api/entities/tag.mdx +1 -1
- package/docs/reference/typescript-api/entities/tax-category.mdx +2 -2
- package/docs/reference/typescript-api/entities/tax-rate.mdx +2 -2
- package/docs/reference/typescript-api/entities/user.mdx +2 -2
- package/docs/reference/typescript-api/entities/zone.mdx +2 -2
- package/docs/reference/typescript-api/errors/error-handler-strategy.mdx +1 -1
- package/docs/reference/typescript-api/errors/error-types.mdx +7 -7
- package/docs/reference/typescript-api/errors/i18n-error.mdx +1 -1
- package/docs/reference/typescript-api/events/event-bus.mdx +1 -1
- package/docs/reference/typescript-api/events/event-types.mdx +59 -59
- package/docs/reference/typescript-api/events/vendure-entity-event.mdx +1 -1
- package/docs/reference/typescript-api/fulfillment/fulfillment-handler.mdx +2 -2
- package/docs/reference/typescript-api/fulfillment/fulfillment-process.mdx +1 -1
- package/docs/reference/typescript-api/health-check/health-check-strategy.mdx +1 -1
- package/docs/reference/typescript-api/health-check/http-health-check-strategy.mdx +1 -1
- package/docs/reference/typescript-api/health-check/type-ormhealth-check-strategy.mdx +1 -1
- package/docs/reference/typescript-api/import-export/asset-import-strategy.mdx +1 -1
- package/docs/reference/typescript-api/import-export/default-asset-import-strategy.mdx +1 -1
- package/docs/reference/typescript-api/job-queue/in-memory-job-buffer-storage-strategy.mdx +1 -1
- package/docs/reference/typescript-api/job-queue/in-memory-job-queue-strategy.mdx +2 -2
- package/docs/reference/typescript-api/job-queue/inspectable-job-queue-strategy.mdx +1 -1
- package/docs/reference/typescript-api/job-queue/job-buffer-storage-strategy.mdx +1 -1
- package/docs/reference/typescript-api/job-queue/job-queue-service.mdx +1 -1
- package/docs/reference/typescript-api/job-queue/job-queue-strategy.mdx +1 -1
- package/docs/reference/typescript-api/job-queue/polling-job-queue-strategy.mdx +1 -1
- package/docs/reference/typescript-api/job-queue/sql-job-queue-strategy.mdx +2 -2
- package/docs/reference/typescript-api/job-queue/subscribable-job.mdx +1 -1
- package/docs/reference/typescript-api/logger/default-logger.mdx +1 -1
- package/docs/reference/typescript-api/logger/index.mdx +1 -1
- package/docs/reference/typescript-api/money/big-int-money-strategy.mdx +1 -1
- package/docs/reference/typescript-api/money/default-money-strategy.mdx +1 -1
- package/docs/reference/typescript-api/money/money-strategy.mdx +1 -1
- package/docs/reference/typescript-api/orders/active-order-strategy.mdx +1 -1
- package/docs/reference/typescript-api/orders/changed-price-handling-strategy.mdx +1 -1
- package/docs/reference/typescript-api/orders/default-active-order-strategy.mdx +1 -1
- package/docs/reference/typescript-api/orders/default-guest-checkout-strategy.mdx +1 -1
- package/docs/reference/typescript-api/orders/default-order-item-price-calculation-strategy.mdx +1 -1
- package/docs/reference/typescript-api/orders/default-order-placed-strategy.mdx +1 -1
- package/docs/reference/typescript-api/orders/default-stock-allocation-strategy.mdx +1 -1
- package/docs/reference/typescript-api/orders/guest-checkout-strategy.mdx +1 -1
- package/docs/reference/typescript-api/orders/merge-strategies.mdx +4 -4
- package/docs/reference/typescript-api/orders/order-by-code-access-strategy.mdx +2 -2
- package/docs/reference/typescript-api/orders/order-code-strategy.mdx +2 -2
- package/docs/reference/typescript-api/orders/order-interceptor.mdx +1 -1
- package/docs/reference/typescript-api/orders/order-item-price-calculation-strategy.mdx +1 -1
- package/docs/reference/typescript-api/orders/order-merge-strategy.mdx +1 -1
- package/docs/reference/typescript-api/orders/order-placed-strategy.mdx +1 -1
- package/docs/reference/typescript-api/orders/order-process.mdx +1 -1
- package/docs/reference/typescript-api/orders/order-seller-strategy.mdx +2 -2
- package/docs/reference/typescript-api/orders/stock-allocation-strategy.mdx +1 -1
- package/docs/reference/typescript-api/payment/payment-method-config-options.mdx +1 -1
- package/docs/reference/typescript-api/payment/payment-method-eligibility-checker.mdx +2 -2
- package/docs/reference/typescript-api/payment/payment-method-handler.mdx +1 -1
- package/docs/reference/typescript-api/payment/payment-process.mdx +1 -1
- package/docs/reference/typescript-api/payment/refund-process.mdx +1 -1
- package/docs/reference/typescript-api/plugin/vendure-plugin-metadata.mdx +1 -1
- package/docs/reference/typescript-api/products-stock/default-product-variant-price-calculation-strategy.mdx +1 -1
- package/docs/reference/typescript-api/products-stock/default-stock-display-strategy.mdx +1 -1
- package/docs/reference/typescript-api/products-stock/default-stock-location-strategy.mdx +1 -1
- package/docs/reference/typescript-api/products-stock/multi-channel-stock-location-strategy.mdx +1 -1
- package/docs/reference/typescript-api/products-stock/product-variant-price-calculation-strategy.mdx +1 -1
- package/docs/reference/typescript-api/products-stock/stock-display-strategy.mdx +1 -1
- package/docs/reference/typescript-api/products-stock/stock-location-strategy.mdx +1 -1
- package/docs/reference/typescript-api/promotions/facet-value-checker.mdx +1 -1
- package/docs/reference/typescript-api/promotions/promotion-action.mdx +10 -10
- package/docs/reference/typescript-api/promotions/promotion-condition.mdx +2 -2
- package/docs/reference/typescript-api/scheduled-tasks/default-scheduler-strategy.mdx +1 -1
- package/docs/reference/typescript-api/scheduled-tasks/scheduler-service.mdx +1 -1
- package/docs/reference/typescript-api/scheduled-tasks/scheduler-strategy.mdx +1 -1
- package/docs/reference/typescript-api/services/asset-service.mdx +1 -1
- package/docs/reference/typescript-api/services/collection-service.mdx +1 -1
- package/docs/reference/typescript-api/services/session-service.mdx +1 -1
- package/docs/reference/typescript-api/services/settings-store-service.mdx +1 -1
- package/docs/reference/typescript-api/shipping/default-shipping-line-assignment-strategy.mdx +1 -1
- package/docs/reference/typescript-api/shipping/shipping-calculator.mdx +1 -1
- package/docs/reference/typescript-api/shipping/shipping-eligibility-checker-config.mdx +1 -1
- package/docs/reference/typescript-api/shipping/shipping-eligibility-checker.mdx +1 -1
- package/docs/reference/typescript-api/shipping/shipping-line-assignment-strategy.mdx +1 -1
- package/docs/reference/typescript-api/tax/address-based-tax-zone-strategy.mdx +1 -1
- package/docs/reference/typescript-api/tax/default-tax-line-calculation-strategy.mdx +1 -1
- package/docs/reference/typescript-api/tax/default-tax-zone-strategy.mdx +1 -1
- package/docs/reference/typescript-api/tax/tax-line-calculation-strategy.mdx +1 -1
- package/docs/reference/typescript-api/tax/tax-zone-strategy.mdx +1 -1
- package/docs/reference/typescript-api/telemetry/instrumentation-strategy.mdx +1 -1
- package/docs/reference/typescript-api/testing/testing-logger.mdx +1 -1
- package/package.json +1 -1
- package/docs/reference/graphql-api/admin/enums.mdx +0 -1139
- package/docs/reference/graphql-api/admin/input-types.mdx +0 -4708
- package/docs/reference/graphql-api/admin/mutations.mdx +0 -2750
- package/docs/reference/graphql-api/admin/object-types.mdx +0 -4973
- package/docs/reference/graphql-api/admin/queries.mdx +0 -1194
- package/docs/reference/graphql-api/shop/enums.mdx +0 -1063
- package/docs/reference/graphql-api/shop/input-types.mdx +0 -1113
- package/docs/reference/graphql-api/shop/mutations.mdx +0 -540
- package/docs/reference/graphql-api/shop/object-types.mdx +0 -3693
- package/docs/reference/graphql-api/shop/queries.mdx +0 -314
|
@@ -1,2750 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: "Mutations"
|
|
3
|
-
generated: true
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
## addCustomersToGroup {#addcustomerstogroup}
|
|
9
|
-
|
|
10
|
-
<GraphQLDoc
|
|
11
|
-
type="mutation"
|
|
12
|
-
typeName="addCustomersToGroup"
|
|
13
|
-
typeLinks={{
|
|
14
|
-
CustomerGroup: '/reference/graphql-api/admin/object-types#customergroup',
|
|
15
|
-
ID: '/reference/graphql-api/admin/object-types#id',
|
|
16
|
-
}}
|
|
17
|
-
>
|
|
18
|
-
{`"""Add Customers to a CustomerGroup"""
|
|
19
|
-
type Mutation {
|
|
20
|
-
addCustomersToGroup(customerGroupId: ID!, customerIds: [ID!]!): CustomerGroup!
|
|
21
|
-
}`}
|
|
22
|
-
</GraphQLDoc>
|
|
23
|
-
|
|
24
|
-
## addFulfillmentToOrder {#addfulfillmenttoorder}
|
|
25
|
-
|
|
26
|
-
<GraphQLDoc
|
|
27
|
-
type="mutation"
|
|
28
|
-
typeName="addFulfillmentToOrder"
|
|
29
|
-
typeLinks={{
|
|
30
|
-
AddFulfillmentToOrderResult: '/reference/graphql-api/admin/object-types#addfulfillmenttoorderresult',
|
|
31
|
-
FulfillOrderInput: '/reference/graphql-api/admin/input-types#fulfillorderinput',
|
|
32
|
-
}}
|
|
33
|
-
>
|
|
34
|
-
{`type Mutation {
|
|
35
|
-
addFulfillmentToOrder(input: FulfillOrderInput!): AddFulfillmentToOrderResult!
|
|
36
|
-
}`}
|
|
37
|
-
</GraphQLDoc>
|
|
38
|
-
|
|
39
|
-
## addItemToDraftOrder {#additemtodraftorder}
|
|
40
|
-
|
|
41
|
-
<GraphQLDoc
|
|
42
|
-
type="mutation"
|
|
43
|
-
typeName="addItemToDraftOrder"
|
|
44
|
-
typeLinks={{
|
|
45
|
-
UpdateOrderItemsResult: '/reference/graphql-api/admin/object-types#updateorderitemsresult',
|
|
46
|
-
ID: '/reference/graphql-api/admin/object-types#id',
|
|
47
|
-
AddItemToDraftOrderInput: '/reference/graphql-api/admin/input-types#additemtodraftorderinput',
|
|
48
|
-
}}
|
|
49
|
-
>
|
|
50
|
-
{`"""Adds an item to the draft Order."""
|
|
51
|
-
type Mutation {
|
|
52
|
-
addItemToDraftOrder(orderId: ID!, input: AddItemToDraftOrderInput!): UpdateOrderItemsResult!
|
|
53
|
-
}`}
|
|
54
|
-
</GraphQLDoc>
|
|
55
|
-
|
|
56
|
-
## addManualPaymentToOrder {#addmanualpaymenttoorder}
|
|
57
|
-
|
|
58
|
-
<GraphQLDoc
|
|
59
|
-
type="mutation"
|
|
60
|
-
typeName="addManualPaymentToOrder"
|
|
61
|
-
typeLinks={{
|
|
62
|
-
AddManualPaymentToOrderResult: '/reference/graphql-api/admin/object-types#addmanualpaymenttoorderresult',
|
|
63
|
-
ManualPaymentInput: '/reference/graphql-api/admin/input-types#manualpaymentinput',
|
|
64
|
-
}}
|
|
65
|
-
>
|
|
66
|
-
{`"""
|
|
67
|
-
Used to manually create a new Payment against an Order.
|
|
68
|
-
This can be used by an Administrator when an Order is in the ArrangingPayment state.
|
|
69
|
-
|
|
70
|
-
It is also used when a completed Order
|
|
71
|
-
has been modified (using \`modifyOrder\`) and the price has increased. The extra payment
|
|
72
|
-
can then be manually arranged by the administrator, and the details used to create a new
|
|
73
|
-
Payment.
|
|
74
|
-
"""
|
|
75
|
-
type Mutation {
|
|
76
|
-
addManualPaymentToOrder(input: ManualPaymentInput!): AddManualPaymentToOrderResult!
|
|
77
|
-
}`}
|
|
78
|
-
</GraphQLDoc>
|
|
79
|
-
|
|
80
|
-
## addMembersToZone {#addmemberstozone}
|
|
81
|
-
|
|
82
|
-
<GraphQLDoc
|
|
83
|
-
type="mutation"
|
|
84
|
-
typeName="addMembersToZone"
|
|
85
|
-
typeLinks={{
|
|
86
|
-
Zone: '/reference/graphql-api/admin/object-types#zone',
|
|
87
|
-
ID: '/reference/graphql-api/admin/object-types#id',
|
|
88
|
-
}}
|
|
89
|
-
>
|
|
90
|
-
{`"""Add members to a Zone"""
|
|
91
|
-
type Mutation {
|
|
92
|
-
addMembersToZone(zoneId: ID!, memberIds: [ID!]!): Zone!
|
|
93
|
-
}`}
|
|
94
|
-
</GraphQLDoc>
|
|
95
|
-
|
|
96
|
-
## addNoteToCustomer {#addnotetocustomer}
|
|
97
|
-
|
|
98
|
-
<GraphQLDoc
|
|
99
|
-
type="mutation"
|
|
100
|
-
typeName="addNoteToCustomer"
|
|
101
|
-
typeLinks={{
|
|
102
|
-
Customer: '/reference/graphql-api/admin/object-types#customer',
|
|
103
|
-
AddNoteToCustomerInput: '/reference/graphql-api/admin/input-types#addnotetocustomerinput',
|
|
104
|
-
}}
|
|
105
|
-
>
|
|
106
|
-
{`type Mutation {
|
|
107
|
-
addNoteToCustomer(input: AddNoteToCustomerInput!): Customer!
|
|
108
|
-
}`}
|
|
109
|
-
</GraphQLDoc>
|
|
110
|
-
|
|
111
|
-
## addNoteToOrder {#addnotetoorder}
|
|
112
|
-
|
|
113
|
-
<GraphQLDoc
|
|
114
|
-
type="mutation"
|
|
115
|
-
typeName="addNoteToOrder"
|
|
116
|
-
typeLinks={{
|
|
117
|
-
Order: '/reference/graphql-api/admin/object-types#order',
|
|
118
|
-
AddNoteToOrderInput: '/reference/graphql-api/admin/input-types#addnotetoorderinput',
|
|
119
|
-
}}
|
|
120
|
-
>
|
|
121
|
-
{`type Mutation {
|
|
122
|
-
addNoteToOrder(input: AddNoteToOrderInput!): Order!
|
|
123
|
-
}`}
|
|
124
|
-
</GraphQLDoc>
|
|
125
|
-
|
|
126
|
-
## addOptionGroupToProduct {#addoptiongrouptoproduct}
|
|
127
|
-
|
|
128
|
-
<GraphQLDoc
|
|
129
|
-
type="mutation"
|
|
130
|
-
typeName="addOptionGroupToProduct"
|
|
131
|
-
typeLinks={{
|
|
132
|
-
Product: '/reference/graphql-api/admin/object-types#product',
|
|
133
|
-
ID: '/reference/graphql-api/admin/object-types#id',
|
|
134
|
-
}}
|
|
135
|
-
>
|
|
136
|
-
{`"""Add an OptionGroup to a Product"""
|
|
137
|
-
type Mutation {
|
|
138
|
-
addOptionGroupToProduct(productId: ID!, optionGroupId: ID!): Product!
|
|
139
|
-
}`}
|
|
140
|
-
</GraphQLDoc>
|
|
141
|
-
|
|
142
|
-
## adjustDraftOrderLine {#adjustdraftorderline}
|
|
143
|
-
|
|
144
|
-
<GraphQLDoc
|
|
145
|
-
type="mutation"
|
|
146
|
-
typeName="adjustDraftOrderLine"
|
|
147
|
-
typeLinks={{
|
|
148
|
-
UpdateOrderItemsResult: '/reference/graphql-api/admin/object-types#updateorderitemsresult',
|
|
149
|
-
ID: '/reference/graphql-api/admin/object-types#id',
|
|
150
|
-
AdjustDraftOrderLineInput: '/reference/graphql-api/admin/input-types#adjustdraftorderlineinput',
|
|
151
|
-
}}
|
|
152
|
-
>
|
|
153
|
-
{`"""Adjusts a draft OrderLine. If custom fields are defined on the OrderLine entity, a third argument 'customFields' of type \`OrderLineCustomFieldsInput\` will be available."""
|
|
154
|
-
type Mutation {
|
|
155
|
-
adjustDraftOrderLine(orderId: ID!, input: AdjustDraftOrderLineInput!): UpdateOrderItemsResult!
|
|
156
|
-
}`}
|
|
157
|
-
</GraphQLDoc>
|
|
158
|
-
|
|
159
|
-
## applyCouponCodeToDraftOrder {#applycouponcodetodraftorder}
|
|
160
|
-
|
|
161
|
-
<GraphQLDoc
|
|
162
|
-
type="mutation"
|
|
163
|
-
typeName="applyCouponCodeToDraftOrder"
|
|
164
|
-
typeLinks={{
|
|
165
|
-
ApplyCouponCodeResult: '/reference/graphql-api/admin/object-types#applycouponcoderesult',
|
|
166
|
-
ID: '/reference/graphql-api/admin/object-types#id',
|
|
167
|
-
String: '/reference/graphql-api/admin/object-types#string',
|
|
168
|
-
}}
|
|
169
|
-
>
|
|
170
|
-
{`"""Applies the given coupon code to the draft Order"""
|
|
171
|
-
type Mutation {
|
|
172
|
-
applyCouponCodeToDraftOrder(orderId: ID!, couponCode: String!): ApplyCouponCodeResult!
|
|
173
|
-
}`}
|
|
174
|
-
</GraphQLDoc>
|
|
175
|
-
|
|
176
|
-
## assignAssetsToChannel {#assignassetstochannel}
|
|
177
|
-
|
|
178
|
-
<GraphQLDoc
|
|
179
|
-
type="mutation"
|
|
180
|
-
typeName="assignAssetsToChannel"
|
|
181
|
-
typeLinks={{
|
|
182
|
-
Asset: '/reference/graphql-api/admin/object-types#asset',
|
|
183
|
-
AssignAssetsToChannelInput: '/reference/graphql-api/admin/input-types#assignassetstochannelinput',
|
|
184
|
-
}}
|
|
185
|
-
>
|
|
186
|
-
{`"""Assign assets to channel"""
|
|
187
|
-
type Mutation {
|
|
188
|
-
assignAssetsToChannel(input: AssignAssetsToChannelInput!): [Asset!]!
|
|
189
|
-
}`}
|
|
190
|
-
</GraphQLDoc>
|
|
191
|
-
|
|
192
|
-
## assignCollectionsToChannel {#assigncollectionstochannel}
|
|
193
|
-
|
|
194
|
-
<GraphQLDoc
|
|
195
|
-
type="mutation"
|
|
196
|
-
typeName="assignCollectionsToChannel"
|
|
197
|
-
typeLinks={{
|
|
198
|
-
Collection: '/reference/graphql-api/admin/object-types#collection',
|
|
199
|
-
AssignCollectionsToChannelInput: '/reference/graphql-api/admin/input-types#assigncollectionstochannelinput',
|
|
200
|
-
}}
|
|
201
|
-
>
|
|
202
|
-
{`"""Assigns Collections to the specified Channel"""
|
|
203
|
-
type Mutation {
|
|
204
|
-
assignCollectionsToChannel(input: AssignCollectionsToChannelInput!): [Collection!]!
|
|
205
|
-
}`}
|
|
206
|
-
</GraphQLDoc>
|
|
207
|
-
|
|
208
|
-
## assignFacetsToChannel {#assignfacetstochannel}
|
|
209
|
-
|
|
210
|
-
<GraphQLDoc
|
|
211
|
-
type="mutation"
|
|
212
|
-
typeName="assignFacetsToChannel"
|
|
213
|
-
typeLinks={{
|
|
214
|
-
Facet: '/reference/graphql-api/admin/object-types#facet',
|
|
215
|
-
AssignFacetsToChannelInput: '/reference/graphql-api/admin/input-types#assignfacetstochannelinput',
|
|
216
|
-
}}
|
|
217
|
-
>
|
|
218
|
-
{`"""Assigns Facets to the specified Channel"""
|
|
219
|
-
type Mutation {
|
|
220
|
-
assignFacetsToChannel(input: AssignFacetsToChannelInput!): [Facet!]!
|
|
221
|
-
}`}
|
|
222
|
-
</GraphQLDoc>
|
|
223
|
-
|
|
224
|
-
## assignPaymentMethodsToChannel {#assignpaymentmethodstochannel}
|
|
225
|
-
|
|
226
|
-
<GraphQLDoc
|
|
227
|
-
type="mutation"
|
|
228
|
-
typeName="assignPaymentMethodsToChannel"
|
|
229
|
-
typeLinks={{
|
|
230
|
-
PaymentMethod: '/reference/graphql-api/admin/object-types#paymentmethod',
|
|
231
|
-
AssignPaymentMethodsToChannelInput: '/reference/graphql-api/admin/input-types#assignpaymentmethodstochannelinput',
|
|
232
|
-
}}
|
|
233
|
-
>
|
|
234
|
-
{`"""Assigns PaymentMethods to the specified Channel"""
|
|
235
|
-
type Mutation {
|
|
236
|
-
assignPaymentMethodsToChannel(input: AssignPaymentMethodsToChannelInput!): [PaymentMethod!]!
|
|
237
|
-
}`}
|
|
238
|
-
</GraphQLDoc>
|
|
239
|
-
|
|
240
|
-
## assignProductVariantsToChannel {#assignproductvariantstochannel}
|
|
241
|
-
|
|
242
|
-
<GraphQLDoc
|
|
243
|
-
type="mutation"
|
|
244
|
-
typeName="assignProductVariantsToChannel"
|
|
245
|
-
typeLinks={{
|
|
246
|
-
ProductVariant: '/reference/graphql-api/admin/object-types#productvariant',
|
|
247
|
-
AssignProductVariantsToChannelInput: '/reference/graphql-api/admin/input-types#assignproductvariantstochannelinput',
|
|
248
|
-
}}
|
|
249
|
-
>
|
|
250
|
-
{`"""Assigns ProductVariants to the specified Channel"""
|
|
251
|
-
type Mutation {
|
|
252
|
-
assignProductVariantsToChannel(input: AssignProductVariantsToChannelInput!): [ProductVariant!]!
|
|
253
|
-
}`}
|
|
254
|
-
</GraphQLDoc>
|
|
255
|
-
|
|
256
|
-
## assignProductsToChannel {#assignproductstochannel}
|
|
257
|
-
|
|
258
|
-
<GraphQLDoc
|
|
259
|
-
type="mutation"
|
|
260
|
-
typeName="assignProductsToChannel"
|
|
261
|
-
typeLinks={{
|
|
262
|
-
Product: '/reference/graphql-api/admin/object-types#product',
|
|
263
|
-
AssignProductsToChannelInput: '/reference/graphql-api/admin/input-types#assignproductstochannelinput',
|
|
264
|
-
}}
|
|
265
|
-
>
|
|
266
|
-
{`"""Assigns all ProductVariants of Product to the specified Channel"""
|
|
267
|
-
type Mutation {
|
|
268
|
-
assignProductsToChannel(input: AssignProductsToChannelInput!): [Product!]!
|
|
269
|
-
}`}
|
|
270
|
-
</GraphQLDoc>
|
|
271
|
-
|
|
272
|
-
## assignPromotionsToChannel {#assignpromotionstochannel}
|
|
273
|
-
|
|
274
|
-
<GraphQLDoc
|
|
275
|
-
type="mutation"
|
|
276
|
-
typeName="assignPromotionsToChannel"
|
|
277
|
-
typeLinks={{
|
|
278
|
-
Promotion: '/reference/graphql-api/admin/object-types#promotion',
|
|
279
|
-
AssignPromotionsToChannelInput: '/reference/graphql-api/admin/input-types#assignpromotionstochannelinput',
|
|
280
|
-
}}
|
|
281
|
-
>
|
|
282
|
-
{`"""Assigns Promotions to the specified Channel"""
|
|
283
|
-
type Mutation {
|
|
284
|
-
assignPromotionsToChannel(input: AssignPromotionsToChannelInput!): [Promotion!]!
|
|
285
|
-
}`}
|
|
286
|
-
</GraphQLDoc>
|
|
287
|
-
|
|
288
|
-
## assignRoleToAdministrator {#assignroletoadministrator}
|
|
289
|
-
|
|
290
|
-
<GraphQLDoc
|
|
291
|
-
type="mutation"
|
|
292
|
-
typeName="assignRoleToAdministrator"
|
|
293
|
-
typeLinks={{
|
|
294
|
-
Administrator: '/reference/graphql-api/admin/object-types#administrator',
|
|
295
|
-
ID: '/reference/graphql-api/admin/object-types#id',
|
|
296
|
-
}}
|
|
297
|
-
>
|
|
298
|
-
{`"""Assign a Role to an Administrator"""
|
|
299
|
-
type Mutation {
|
|
300
|
-
assignRoleToAdministrator(administratorId: ID!, roleId: ID!): Administrator!
|
|
301
|
-
}`}
|
|
302
|
-
</GraphQLDoc>
|
|
303
|
-
|
|
304
|
-
## assignShippingMethodsToChannel {#assignshippingmethodstochannel}
|
|
305
|
-
|
|
306
|
-
<GraphQLDoc
|
|
307
|
-
type="mutation"
|
|
308
|
-
typeName="assignShippingMethodsToChannel"
|
|
309
|
-
typeLinks={{
|
|
310
|
-
ShippingMethod: '/reference/graphql-api/admin/object-types#shippingmethod',
|
|
311
|
-
AssignShippingMethodsToChannelInput: '/reference/graphql-api/admin/input-types#assignshippingmethodstochannelinput',
|
|
312
|
-
}}
|
|
313
|
-
>
|
|
314
|
-
{`"""Assigns ShippingMethods to the specified Channel"""
|
|
315
|
-
type Mutation {
|
|
316
|
-
assignShippingMethodsToChannel(input: AssignShippingMethodsToChannelInput!): [ShippingMethod!]!
|
|
317
|
-
}`}
|
|
318
|
-
</GraphQLDoc>
|
|
319
|
-
|
|
320
|
-
## assignStockLocationsToChannel {#assignstocklocationstochannel}
|
|
321
|
-
|
|
322
|
-
<GraphQLDoc
|
|
323
|
-
type="mutation"
|
|
324
|
-
typeName="assignStockLocationsToChannel"
|
|
325
|
-
typeLinks={{
|
|
326
|
-
StockLocation: '/reference/graphql-api/admin/object-types#stocklocation',
|
|
327
|
-
AssignStockLocationsToChannelInput: '/reference/graphql-api/admin/input-types#assignstocklocationstochannelinput',
|
|
328
|
-
}}
|
|
329
|
-
>
|
|
330
|
-
{`"""Assigns StockLocations to the specified Channel"""
|
|
331
|
-
type Mutation {
|
|
332
|
-
assignStockLocationsToChannel(input: AssignStockLocationsToChannelInput!): [StockLocation!]!
|
|
333
|
-
}`}
|
|
334
|
-
</GraphQLDoc>
|
|
335
|
-
|
|
336
|
-
## authenticate {#authenticate}
|
|
337
|
-
|
|
338
|
-
<GraphQLDoc
|
|
339
|
-
type="mutation"
|
|
340
|
-
typeName="authenticate"
|
|
341
|
-
typeLinks={{
|
|
342
|
-
AuthenticationResult: '/reference/graphql-api/admin/object-types#authenticationresult',
|
|
343
|
-
AuthenticationInput: '/reference/graphql-api/admin/input-types#authenticationinput',
|
|
344
|
-
Boolean: '/reference/graphql-api/admin/object-types#boolean',
|
|
345
|
-
}}
|
|
346
|
-
>
|
|
347
|
-
{`"""Authenticates the user using a named authentication strategy"""
|
|
348
|
-
type Mutation {
|
|
349
|
-
authenticate(input: AuthenticationInput!, rememberMe: Boolean): AuthenticationResult!
|
|
350
|
-
}`}
|
|
351
|
-
</GraphQLDoc>
|
|
352
|
-
|
|
353
|
-
## cancelJob {#canceljob}
|
|
354
|
-
|
|
355
|
-
<GraphQLDoc
|
|
356
|
-
type="mutation"
|
|
357
|
-
typeName="cancelJob"
|
|
358
|
-
typeLinks={{
|
|
359
|
-
Job: '/reference/graphql-api/admin/object-types#job',
|
|
360
|
-
ID: '/reference/graphql-api/admin/object-types#id',
|
|
361
|
-
}}
|
|
362
|
-
>
|
|
363
|
-
{`type Mutation {
|
|
364
|
-
cancelJob(jobId: ID!): Job!
|
|
365
|
-
}`}
|
|
366
|
-
</GraphQLDoc>
|
|
367
|
-
|
|
368
|
-
## cancelOrder {#cancelorder}
|
|
369
|
-
|
|
370
|
-
<GraphQLDoc
|
|
371
|
-
type="mutation"
|
|
372
|
-
typeName="cancelOrder"
|
|
373
|
-
typeLinks={{
|
|
374
|
-
CancelOrderResult: '/reference/graphql-api/admin/object-types#cancelorderresult',
|
|
375
|
-
CancelOrderInput: '/reference/graphql-api/admin/input-types#cancelorderinput',
|
|
376
|
-
}}
|
|
377
|
-
>
|
|
378
|
-
{`type Mutation {
|
|
379
|
-
cancelOrder(input: CancelOrderInput!): CancelOrderResult!
|
|
380
|
-
}`}
|
|
381
|
-
</GraphQLDoc>
|
|
382
|
-
|
|
383
|
-
## cancelPayment {#cancelpayment}
|
|
384
|
-
|
|
385
|
-
<GraphQLDoc
|
|
386
|
-
type="mutation"
|
|
387
|
-
typeName="cancelPayment"
|
|
388
|
-
typeLinks={{
|
|
389
|
-
CancelPaymentResult: '/reference/graphql-api/admin/object-types#cancelpaymentresult',
|
|
390
|
-
ID: '/reference/graphql-api/admin/object-types#id',
|
|
391
|
-
}}
|
|
392
|
-
>
|
|
393
|
-
{`type Mutation {
|
|
394
|
-
cancelPayment(id: ID!): CancelPaymentResult!
|
|
395
|
-
}`}
|
|
396
|
-
</GraphQLDoc>
|
|
397
|
-
|
|
398
|
-
## createAdministrator {#createadministrator}
|
|
399
|
-
|
|
400
|
-
<GraphQLDoc
|
|
401
|
-
type="mutation"
|
|
402
|
-
typeName="createAdministrator"
|
|
403
|
-
typeLinks={{
|
|
404
|
-
Administrator: '/reference/graphql-api/admin/object-types#administrator',
|
|
405
|
-
CreateAdministratorInput: '/reference/graphql-api/admin/input-types#createadministratorinput',
|
|
406
|
-
}}
|
|
407
|
-
>
|
|
408
|
-
{`"""Create a new Administrator"""
|
|
409
|
-
type Mutation {
|
|
410
|
-
createAdministrator(input: CreateAdministratorInput!): Administrator!
|
|
411
|
-
}`}
|
|
412
|
-
</GraphQLDoc>
|
|
413
|
-
|
|
414
|
-
## createAssets {#createassets}
|
|
415
|
-
|
|
416
|
-
<GraphQLDoc
|
|
417
|
-
type="mutation"
|
|
418
|
-
typeName="createAssets"
|
|
419
|
-
typeLinks={{
|
|
420
|
-
CreateAssetResult: '/reference/graphql-api/admin/object-types#createassetresult',
|
|
421
|
-
CreateAssetInput: '/reference/graphql-api/admin/input-types#createassetinput',
|
|
422
|
-
}}
|
|
423
|
-
>
|
|
424
|
-
{`"""Create a new Asset"""
|
|
425
|
-
type Mutation {
|
|
426
|
-
createAssets(input: [CreateAssetInput!]!): [CreateAssetResult!]!
|
|
427
|
-
}`}
|
|
428
|
-
</GraphQLDoc>
|
|
429
|
-
|
|
430
|
-
## createChannel {#createchannel}
|
|
431
|
-
|
|
432
|
-
<GraphQLDoc
|
|
433
|
-
type="mutation"
|
|
434
|
-
typeName="createChannel"
|
|
435
|
-
typeLinks={{
|
|
436
|
-
CreateChannelResult: '/reference/graphql-api/admin/object-types#createchannelresult',
|
|
437
|
-
CreateChannelInput: '/reference/graphql-api/admin/input-types#createchannelinput',
|
|
438
|
-
}}
|
|
439
|
-
>
|
|
440
|
-
{`"""Create a new Channel"""
|
|
441
|
-
type Mutation {
|
|
442
|
-
createChannel(input: CreateChannelInput!): CreateChannelResult!
|
|
443
|
-
}`}
|
|
444
|
-
</GraphQLDoc>
|
|
445
|
-
|
|
446
|
-
## createCollection {#createcollection}
|
|
447
|
-
|
|
448
|
-
<GraphQLDoc
|
|
449
|
-
type="mutation"
|
|
450
|
-
typeName="createCollection"
|
|
451
|
-
typeLinks={{
|
|
452
|
-
Collection: '/reference/graphql-api/admin/object-types#collection',
|
|
453
|
-
CreateCollectionInput: '/reference/graphql-api/admin/input-types#createcollectioninput',
|
|
454
|
-
}}
|
|
455
|
-
>
|
|
456
|
-
{`"""Create a new Collection"""
|
|
457
|
-
type Mutation {
|
|
458
|
-
createCollection(input: CreateCollectionInput!): Collection!
|
|
459
|
-
}`}
|
|
460
|
-
</GraphQLDoc>
|
|
461
|
-
|
|
462
|
-
## createCountry {#createcountry}
|
|
463
|
-
|
|
464
|
-
<GraphQLDoc
|
|
465
|
-
type="mutation"
|
|
466
|
-
typeName="createCountry"
|
|
467
|
-
typeLinks={{
|
|
468
|
-
Country: '/reference/graphql-api/admin/object-types#country',
|
|
469
|
-
CreateCountryInput: '/reference/graphql-api/admin/input-types#createcountryinput',
|
|
470
|
-
}}
|
|
471
|
-
>
|
|
472
|
-
{`"""Create a new Country"""
|
|
473
|
-
type Mutation {
|
|
474
|
-
createCountry(input: CreateCountryInput!): Country!
|
|
475
|
-
}`}
|
|
476
|
-
</GraphQLDoc>
|
|
477
|
-
|
|
478
|
-
## createCustomer {#createcustomer}
|
|
479
|
-
|
|
480
|
-
<GraphQLDoc
|
|
481
|
-
type="mutation"
|
|
482
|
-
typeName="createCustomer"
|
|
483
|
-
typeLinks={{
|
|
484
|
-
CreateCustomerResult: '/reference/graphql-api/admin/object-types#createcustomerresult',
|
|
485
|
-
CreateCustomerInput: '/reference/graphql-api/admin/input-types#createcustomerinput',
|
|
486
|
-
String: '/reference/graphql-api/admin/object-types#string',
|
|
487
|
-
}}
|
|
488
|
-
>
|
|
489
|
-
{`"""Create a new Customer. If a password is provided, a new User will also be created an linked to the Customer."""
|
|
490
|
-
type Mutation {
|
|
491
|
-
createCustomer(input: CreateCustomerInput!, password: String): CreateCustomerResult!
|
|
492
|
-
}`}
|
|
493
|
-
</GraphQLDoc>
|
|
494
|
-
|
|
495
|
-
## createCustomerAddress {#createcustomeraddress}
|
|
496
|
-
|
|
497
|
-
<GraphQLDoc
|
|
498
|
-
type="mutation"
|
|
499
|
-
typeName="createCustomerAddress"
|
|
500
|
-
typeLinks={{
|
|
501
|
-
Address: '/reference/graphql-api/admin/object-types#address',
|
|
502
|
-
ID: '/reference/graphql-api/admin/object-types#id',
|
|
503
|
-
CreateAddressInput: '/reference/graphql-api/admin/input-types#createaddressinput',
|
|
504
|
-
}}
|
|
505
|
-
>
|
|
506
|
-
{`"""Create a new Address and associate it with the Customer specified by customerId"""
|
|
507
|
-
type Mutation {
|
|
508
|
-
createCustomerAddress(customerId: ID!, input: CreateAddressInput!): Address!
|
|
509
|
-
}`}
|
|
510
|
-
</GraphQLDoc>
|
|
511
|
-
|
|
512
|
-
## createCustomerGroup {#createcustomergroup}
|
|
513
|
-
|
|
514
|
-
<GraphQLDoc
|
|
515
|
-
type="mutation"
|
|
516
|
-
typeName="createCustomerGroup"
|
|
517
|
-
typeLinks={{
|
|
518
|
-
CustomerGroup: '/reference/graphql-api/admin/object-types#customergroup',
|
|
519
|
-
CreateCustomerGroupInput: '/reference/graphql-api/admin/input-types#createcustomergroupinput',
|
|
520
|
-
}}
|
|
521
|
-
>
|
|
522
|
-
{`"""Create a new CustomerGroup"""
|
|
523
|
-
type Mutation {
|
|
524
|
-
createCustomerGroup(input: CreateCustomerGroupInput!): CustomerGroup!
|
|
525
|
-
}`}
|
|
526
|
-
</GraphQLDoc>
|
|
527
|
-
|
|
528
|
-
## createDraftOrder {#createdraftorder}
|
|
529
|
-
|
|
530
|
-
<GraphQLDoc
|
|
531
|
-
type="mutation"
|
|
532
|
-
typeName="createDraftOrder"
|
|
533
|
-
typeLinks={{
|
|
534
|
-
Order: '/reference/graphql-api/admin/object-types#order',
|
|
535
|
-
}}
|
|
536
|
-
>
|
|
537
|
-
{`"""Creates a draft Order"""
|
|
538
|
-
type Mutation {
|
|
539
|
-
createDraftOrder: Order!
|
|
540
|
-
}`}
|
|
541
|
-
</GraphQLDoc>
|
|
542
|
-
|
|
543
|
-
## createFacet {#createfacet}
|
|
544
|
-
|
|
545
|
-
<GraphQLDoc
|
|
546
|
-
type="mutation"
|
|
547
|
-
typeName="createFacet"
|
|
548
|
-
typeLinks={{
|
|
549
|
-
Facet: '/reference/graphql-api/admin/object-types#facet',
|
|
550
|
-
CreateFacetInput: '/reference/graphql-api/admin/input-types#createfacetinput',
|
|
551
|
-
}}
|
|
552
|
-
>
|
|
553
|
-
{`"""Create a new Facet"""
|
|
554
|
-
type Mutation {
|
|
555
|
-
createFacet(input: CreateFacetInput!): Facet!
|
|
556
|
-
}`}
|
|
557
|
-
</GraphQLDoc>
|
|
558
|
-
|
|
559
|
-
## createFacetValue {#createfacetvalue}
|
|
560
|
-
|
|
561
|
-
<GraphQLDoc
|
|
562
|
-
type="mutation"
|
|
563
|
-
typeName="createFacetValue"
|
|
564
|
-
typeLinks={{
|
|
565
|
-
FacetValue: '/reference/graphql-api/admin/object-types#facetvalue',
|
|
566
|
-
CreateFacetValueInput: '/reference/graphql-api/admin/input-types#createfacetvalueinput',
|
|
567
|
-
}}
|
|
568
|
-
>
|
|
569
|
-
{`"""Create a single FacetValue"""
|
|
570
|
-
type Mutation {
|
|
571
|
-
createFacetValue(input: CreateFacetValueInput!): FacetValue!
|
|
572
|
-
}`}
|
|
573
|
-
</GraphQLDoc>
|
|
574
|
-
|
|
575
|
-
## createFacetValues {#createfacetvalues}
|
|
576
|
-
|
|
577
|
-
<GraphQLDoc
|
|
578
|
-
type="mutation"
|
|
579
|
-
typeName="createFacetValues"
|
|
580
|
-
typeLinks={{
|
|
581
|
-
FacetValue: '/reference/graphql-api/admin/object-types#facetvalue',
|
|
582
|
-
CreateFacetValueInput: '/reference/graphql-api/admin/input-types#createfacetvalueinput',
|
|
583
|
-
}}
|
|
584
|
-
>
|
|
585
|
-
{`"""Create one or more FacetValues"""
|
|
586
|
-
type Mutation {
|
|
587
|
-
createFacetValues(input: [CreateFacetValueInput!]!): [FacetValue!]!
|
|
588
|
-
}`}
|
|
589
|
-
</GraphQLDoc>
|
|
590
|
-
|
|
591
|
-
## createPaymentMethod {#createpaymentmethod}
|
|
592
|
-
|
|
593
|
-
<GraphQLDoc
|
|
594
|
-
type="mutation"
|
|
595
|
-
typeName="createPaymentMethod"
|
|
596
|
-
typeLinks={{
|
|
597
|
-
PaymentMethod: '/reference/graphql-api/admin/object-types#paymentmethod',
|
|
598
|
-
CreatePaymentMethodInput: '/reference/graphql-api/admin/input-types#createpaymentmethodinput',
|
|
599
|
-
}}
|
|
600
|
-
>
|
|
601
|
-
{`"""Create existing PaymentMethod"""
|
|
602
|
-
type Mutation {
|
|
603
|
-
createPaymentMethod(input: CreatePaymentMethodInput!): PaymentMethod!
|
|
604
|
-
}`}
|
|
605
|
-
</GraphQLDoc>
|
|
606
|
-
|
|
607
|
-
## createProduct {#createproduct}
|
|
608
|
-
|
|
609
|
-
<GraphQLDoc
|
|
610
|
-
type="mutation"
|
|
611
|
-
typeName="createProduct"
|
|
612
|
-
typeLinks={{
|
|
613
|
-
Product: '/reference/graphql-api/admin/object-types#product',
|
|
614
|
-
CreateProductInput: '/reference/graphql-api/admin/input-types#createproductinput',
|
|
615
|
-
}}
|
|
616
|
-
>
|
|
617
|
-
{`"""Create a new Product"""
|
|
618
|
-
type Mutation {
|
|
619
|
-
createProduct(input: CreateProductInput!): Product!
|
|
620
|
-
}`}
|
|
621
|
-
</GraphQLDoc>
|
|
622
|
-
|
|
623
|
-
## createProductOption {#createproductoption}
|
|
624
|
-
|
|
625
|
-
<GraphQLDoc
|
|
626
|
-
type="mutation"
|
|
627
|
-
typeName="createProductOption"
|
|
628
|
-
typeLinks={{
|
|
629
|
-
ProductOption: '/reference/graphql-api/admin/object-types#productoption',
|
|
630
|
-
CreateProductOptionInput: '/reference/graphql-api/admin/input-types#createproductoptioninput',
|
|
631
|
-
}}
|
|
632
|
-
>
|
|
633
|
-
{`"""Create a new ProductOption within a ProductOptionGroup"""
|
|
634
|
-
type Mutation {
|
|
635
|
-
createProductOption(input: CreateProductOptionInput!): ProductOption!
|
|
636
|
-
}`}
|
|
637
|
-
</GraphQLDoc>
|
|
638
|
-
|
|
639
|
-
## createProductOptionGroup {#createproductoptiongroup}
|
|
640
|
-
|
|
641
|
-
<GraphQLDoc
|
|
642
|
-
type="mutation"
|
|
643
|
-
typeName="createProductOptionGroup"
|
|
644
|
-
typeLinks={{
|
|
645
|
-
ProductOptionGroup: '/reference/graphql-api/admin/object-types#productoptiongroup',
|
|
646
|
-
CreateProductOptionGroupInput: '/reference/graphql-api/admin/input-types#createproductoptiongroupinput',
|
|
647
|
-
}}
|
|
648
|
-
>
|
|
649
|
-
{`"""Create a new ProductOptionGroup"""
|
|
650
|
-
type Mutation {
|
|
651
|
-
createProductOptionGroup(input: CreateProductOptionGroupInput!): ProductOptionGroup!
|
|
652
|
-
}`}
|
|
653
|
-
</GraphQLDoc>
|
|
654
|
-
|
|
655
|
-
## createProductVariants {#createproductvariants}
|
|
656
|
-
|
|
657
|
-
<GraphQLDoc
|
|
658
|
-
type="mutation"
|
|
659
|
-
typeName="createProductVariants"
|
|
660
|
-
typeLinks={{
|
|
661
|
-
ProductVariant: '/reference/graphql-api/admin/object-types#productvariant',
|
|
662
|
-
CreateProductVariantInput: '/reference/graphql-api/admin/input-types#createproductvariantinput',
|
|
663
|
-
}}
|
|
664
|
-
>
|
|
665
|
-
{`"""Create a set of ProductVariants based on the OptionGroups assigned to the given Product"""
|
|
666
|
-
type Mutation {
|
|
667
|
-
createProductVariants(input: [CreateProductVariantInput!]!): [ProductVariant]!
|
|
668
|
-
}`}
|
|
669
|
-
</GraphQLDoc>
|
|
670
|
-
|
|
671
|
-
## createPromotion {#createpromotion}
|
|
672
|
-
|
|
673
|
-
<GraphQLDoc
|
|
674
|
-
type="mutation"
|
|
675
|
-
typeName="createPromotion"
|
|
676
|
-
typeLinks={{
|
|
677
|
-
CreatePromotionResult: '/reference/graphql-api/admin/object-types#createpromotionresult',
|
|
678
|
-
CreatePromotionInput: '/reference/graphql-api/admin/input-types#createpromotioninput',
|
|
679
|
-
}}
|
|
680
|
-
>
|
|
681
|
-
{`type Mutation {
|
|
682
|
-
createPromotion(input: CreatePromotionInput!): CreatePromotionResult!
|
|
683
|
-
}`}
|
|
684
|
-
</GraphQLDoc>
|
|
685
|
-
|
|
686
|
-
## createProvince {#createprovince}
|
|
687
|
-
|
|
688
|
-
<GraphQLDoc
|
|
689
|
-
type="mutation"
|
|
690
|
-
typeName="createProvince"
|
|
691
|
-
typeLinks={{
|
|
692
|
-
Province: '/reference/graphql-api/admin/object-types#province',
|
|
693
|
-
CreateProvinceInput: '/reference/graphql-api/admin/input-types#createprovinceinput',
|
|
694
|
-
}}
|
|
695
|
-
>
|
|
696
|
-
{`"""Create a new Province"""
|
|
697
|
-
type Mutation {
|
|
698
|
-
createProvince(input: CreateProvinceInput!): Province!
|
|
699
|
-
}`}
|
|
700
|
-
</GraphQLDoc>
|
|
701
|
-
|
|
702
|
-
## createRole {#createrole}
|
|
703
|
-
|
|
704
|
-
<GraphQLDoc
|
|
705
|
-
type="mutation"
|
|
706
|
-
typeName="createRole"
|
|
707
|
-
typeLinks={{
|
|
708
|
-
Role: '/reference/graphql-api/admin/object-types#role',
|
|
709
|
-
CreateRoleInput: '/reference/graphql-api/admin/input-types#createroleinput',
|
|
710
|
-
}}
|
|
711
|
-
>
|
|
712
|
-
{`"""Create a new Role"""
|
|
713
|
-
type Mutation {
|
|
714
|
-
createRole(input: CreateRoleInput!): Role!
|
|
715
|
-
}`}
|
|
716
|
-
</GraphQLDoc>
|
|
717
|
-
|
|
718
|
-
## createSeller {#createseller}
|
|
719
|
-
|
|
720
|
-
<GraphQLDoc
|
|
721
|
-
type="mutation"
|
|
722
|
-
typeName="createSeller"
|
|
723
|
-
typeLinks={{
|
|
724
|
-
Seller: '/reference/graphql-api/admin/object-types#seller',
|
|
725
|
-
CreateSellerInput: '/reference/graphql-api/admin/input-types#createsellerinput',
|
|
726
|
-
}}
|
|
727
|
-
>
|
|
728
|
-
{`"""Create a new Seller"""
|
|
729
|
-
type Mutation {
|
|
730
|
-
createSeller(input: CreateSellerInput!): Seller!
|
|
731
|
-
}`}
|
|
732
|
-
</GraphQLDoc>
|
|
733
|
-
|
|
734
|
-
## createShippingMethod {#createshippingmethod}
|
|
735
|
-
|
|
736
|
-
<GraphQLDoc
|
|
737
|
-
type="mutation"
|
|
738
|
-
typeName="createShippingMethod"
|
|
739
|
-
typeLinks={{
|
|
740
|
-
ShippingMethod: '/reference/graphql-api/admin/object-types#shippingmethod',
|
|
741
|
-
CreateShippingMethodInput: '/reference/graphql-api/admin/input-types#createshippingmethodinput',
|
|
742
|
-
}}
|
|
743
|
-
>
|
|
744
|
-
{`"""Create a new ShippingMethod"""
|
|
745
|
-
type Mutation {
|
|
746
|
-
createShippingMethod(input: CreateShippingMethodInput!): ShippingMethod!
|
|
747
|
-
}`}
|
|
748
|
-
</GraphQLDoc>
|
|
749
|
-
|
|
750
|
-
## createStockLocation {#createstocklocation}
|
|
751
|
-
|
|
752
|
-
<GraphQLDoc
|
|
753
|
-
type="mutation"
|
|
754
|
-
typeName="createStockLocation"
|
|
755
|
-
typeLinks={{
|
|
756
|
-
StockLocation: '/reference/graphql-api/admin/object-types#stocklocation',
|
|
757
|
-
CreateStockLocationInput: '/reference/graphql-api/admin/input-types#createstocklocationinput',
|
|
758
|
-
}}
|
|
759
|
-
>
|
|
760
|
-
{`type Mutation {
|
|
761
|
-
createStockLocation(input: CreateStockLocationInput!): StockLocation!
|
|
762
|
-
}`}
|
|
763
|
-
</GraphQLDoc>
|
|
764
|
-
|
|
765
|
-
## createTag {#createtag}
|
|
766
|
-
|
|
767
|
-
<GraphQLDoc
|
|
768
|
-
type="mutation"
|
|
769
|
-
typeName="createTag"
|
|
770
|
-
typeLinks={{
|
|
771
|
-
Tag: '/reference/graphql-api/admin/object-types#tag',
|
|
772
|
-
CreateTagInput: '/reference/graphql-api/admin/input-types#createtaginput',
|
|
773
|
-
}}
|
|
774
|
-
>
|
|
775
|
-
{`"""Create a new Tag"""
|
|
776
|
-
type Mutation {
|
|
777
|
-
createTag(input: CreateTagInput!): Tag!
|
|
778
|
-
}`}
|
|
779
|
-
</GraphQLDoc>
|
|
780
|
-
|
|
781
|
-
## createTaxCategory {#createtaxcategory}
|
|
782
|
-
|
|
783
|
-
<GraphQLDoc
|
|
784
|
-
type="mutation"
|
|
785
|
-
typeName="createTaxCategory"
|
|
786
|
-
typeLinks={{
|
|
787
|
-
TaxCategory: '/reference/graphql-api/admin/object-types#taxcategory',
|
|
788
|
-
CreateTaxCategoryInput: '/reference/graphql-api/admin/input-types#createtaxcategoryinput',
|
|
789
|
-
}}
|
|
790
|
-
>
|
|
791
|
-
{`"""Create a new TaxCategory"""
|
|
792
|
-
type Mutation {
|
|
793
|
-
createTaxCategory(input: CreateTaxCategoryInput!): TaxCategory!
|
|
794
|
-
}`}
|
|
795
|
-
</GraphQLDoc>
|
|
796
|
-
|
|
797
|
-
## createTaxRate {#createtaxrate}
|
|
798
|
-
|
|
799
|
-
<GraphQLDoc
|
|
800
|
-
type="mutation"
|
|
801
|
-
typeName="createTaxRate"
|
|
802
|
-
typeLinks={{
|
|
803
|
-
TaxRate: '/reference/graphql-api/admin/object-types#taxrate',
|
|
804
|
-
CreateTaxRateInput: '/reference/graphql-api/admin/input-types#createtaxrateinput',
|
|
805
|
-
}}
|
|
806
|
-
>
|
|
807
|
-
{`"""Create a new TaxRate"""
|
|
808
|
-
type Mutation {
|
|
809
|
-
createTaxRate(input: CreateTaxRateInput!): TaxRate!
|
|
810
|
-
}`}
|
|
811
|
-
</GraphQLDoc>
|
|
812
|
-
|
|
813
|
-
## createZone {#createzone}
|
|
814
|
-
|
|
815
|
-
<GraphQLDoc
|
|
816
|
-
type="mutation"
|
|
817
|
-
typeName="createZone"
|
|
818
|
-
typeLinks={{
|
|
819
|
-
Zone: '/reference/graphql-api/admin/object-types#zone',
|
|
820
|
-
CreateZoneInput: '/reference/graphql-api/admin/input-types#createzoneinput',
|
|
821
|
-
}}
|
|
822
|
-
>
|
|
823
|
-
{`"""Create a new Zone"""
|
|
824
|
-
type Mutation {
|
|
825
|
-
createZone(input: CreateZoneInput!): Zone!
|
|
826
|
-
}`}
|
|
827
|
-
</GraphQLDoc>
|
|
828
|
-
|
|
829
|
-
## deleteAdministrator {#deleteadministrator}
|
|
830
|
-
|
|
831
|
-
<GraphQLDoc
|
|
832
|
-
type="mutation"
|
|
833
|
-
typeName="deleteAdministrator"
|
|
834
|
-
typeLinks={{
|
|
835
|
-
DeletionResponse: '/reference/graphql-api/admin/object-types#deletionresponse',
|
|
836
|
-
ID: '/reference/graphql-api/admin/object-types#id',
|
|
837
|
-
}}
|
|
838
|
-
>
|
|
839
|
-
{`"""Delete an Administrator"""
|
|
840
|
-
type Mutation {
|
|
841
|
-
deleteAdministrator(id: ID!): DeletionResponse!
|
|
842
|
-
}`}
|
|
843
|
-
</GraphQLDoc>
|
|
844
|
-
|
|
845
|
-
## deleteAdministrators {#deleteadministrators}
|
|
846
|
-
|
|
847
|
-
<GraphQLDoc
|
|
848
|
-
type="mutation"
|
|
849
|
-
typeName="deleteAdministrators"
|
|
850
|
-
typeLinks={{
|
|
851
|
-
DeletionResponse: '/reference/graphql-api/admin/object-types#deletionresponse',
|
|
852
|
-
ID: '/reference/graphql-api/admin/object-types#id',
|
|
853
|
-
}}
|
|
854
|
-
>
|
|
855
|
-
{`"""Delete multiple Administrators"""
|
|
856
|
-
type Mutation {
|
|
857
|
-
deleteAdministrators(ids: [ID!]!): [DeletionResponse!]!
|
|
858
|
-
}`}
|
|
859
|
-
</GraphQLDoc>
|
|
860
|
-
|
|
861
|
-
## deleteAsset {#deleteasset}
|
|
862
|
-
|
|
863
|
-
<GraphQLDoc
|
|
864
|
-
type="mutation"
|
|
865
|
-
typeName="deleteAsset"
|
|
866
|
-
typeLinks={{
|
|
867
|
-
DeletionResponse: '/reference/graphql-api/admin/object-types#deletionresponse',
|
|
868
|
-
DeleteAssetInput: '/reference/graphql-api/admin/input-types#deleteassetinput',
|
|
869
|
-
}}
|
|
870
|
-
>
|
|
871
|
-
{`"""Delete an Asset"""
|
|
872
|
-
type Mutation {
|
|
873
|
-
deleteAsset(input: DeleteAssetInput!): DeletionResponse!
|
|
874
|
-
}`}
|
|
875
|
-
</GraphQLDoc>
|
|
876
|
-
|
|
877
|
-
## deleteAssets {#deleteassets}
|
|
878
|
-
|
|
879
|
-
<GraphQLDoc
|
|
880
|
-
type="mutation"
|
|
881
|
-
typeName="deleteAssets"
|
|
882
|
-
typeLinks={{
|
|
883
|
-
DeletionResponse: '/reference/graphql-api/admin/object-types#deletionresponse',
|
|
884
|
-
DeleteAssetsInput: '/reference/graphql-api/admin/input-types#deleteassetsinput',
|
|
885
|
-
}}
|
|
886
|
-
>
|
|
887
|
-
{`"""Delete multiple Assets"""
|
|
888
|
-
type Mutation {
|
|
889
|
-
deleteAssets(input: DeleteAssetsInput!): DeletionResponse!
|
|
890
|
-
}`}
|
|
891
|
-
</GraphQLDoc>
|
|
892
|
-
|
|
893
|
-
## deleteChannel {#deletechannel}
|
|
894
|
-
|
|
895
|
-
<GraphQLDoc
|
|
896
|
-
type="mutation"
|
|
897
|
-
typeName="deleteChannel"
|
|
898
|
-
typeLinks={{
|
|
899
|
-
DeletionResponse: '/reference/graphql-api/admin/object-types#deletionresponse',
|
|
900
|
-
ID: '/reference/graphql-api/admin/object-types#id',
|
|
901
|
-
}}
|
|
902
|
-
>
|
|
903
|
-
{`"""Delete a Channel"""
|
|
904
|
-
type Mutation {
|
|
905
|
-
deleteChannel(id: ID!): DeletionResponse!
|
|
906
|
-
}`}
|
|
907
|
-
</GraphQLDoc>
|
|
908
|
-
|
|
909
|
-
## deleteChannels {#deletechannels}
|
|
910
|
-
|
|
911
|
-
<GraphQLDoc
|
|
912
|
-
type="mutation"
|
|
913
|
-
typeName="deleteChannels"
|
|
914
|
-
typeLinks={{
|
|
915
|
-
DeletionResponse: '/reference/graphql-api/admin/object-types#deletionresponse',
|
|
916
|
-
ID: '/reference/graphql-api/admin/object-types#id',
|
|
917
|
-
}}
|
|
918
|
-
>
|
|
919
|
-
{`"""Delete multiple Channels"""
|
|
920
|
-
type Mutation {
|
|
921
|
-
deleteChannels(ids: [ID!]!): [DeletionResponse!]!
|
|
922
|
-
}`}
|
|
923
|
-
</GraphQLDoc>
|
|
924
|
-
|
|
925
|
-
## deleteCollection {#deletecollection}
|
|
926
|
-
|
|
927
|
-
<GraphQLDoc
|
|
928
|
-
type="mutation"
|
|
929
|
-
typeName="deleteCollection"
|
|
930
|
-
typeLinks={{
|
|
931
|
-
DeletionResponse: '/reference/graphql-api/admin/object-types#deletionresponse',
|
|
932
|
-
ID: '/reference/graphql-api/admin/object-types#id',
|
|
933
|
-
}}
|
|
934
|
-
>
|
|
935
|
-
{`"""Delete a Collection and all of its descendants"""
|
|
936
|
-
type Mutation {
|
|
937
|
-
deleteCollection(id: ID!): DeletionResponse!
|
|
938
|
-
}`}
|
|
939
|
-
</GraphQLDoc>
|
|
940
|
-
|
|
941
|
-
## deleteCollections {#deletecollections}
|
|
942
|
-
|
|
943
|
-
<GraphQLDoc
|
|
944
|
-
type="mutation"
|
|
945
|
-
typeName="deleteCollections"
|
|
946
|
-
typeLinks={{
|
|
947
|
-
DeletionResponse: '/reference/graphql-api/admin/object-types#deletionresponse',
|
|
948
|
-
ID: '/reference/graphql-api/admin/object-types#id',
|
|
949
|
-
}}
|
|
950
|
-
>
|
|
951
|
-
{`"""Delete multiple Collections and all of their descendants"""
|
|
952
|
-
type Mutation {
|
|
953
|
-
deleteCollections(ids: [ID!]!): [DeletionResponse!]!
|
|
954
|
-
}`}
|
|
955
|
-
</GraphQLDoc>
|
|
956
|
-
|
|
957
|
-
## deleteCountries {#deletecountries}
|
|
958
|
-
|
|
959
|
-
<GraphQLDoc
|
|
960
|
-
type="mutation"
|
|
961
|
-
typeName="deleteCountries"
|
|
962
|
-
typeLinks={{
|
|
963
|
-
DeletionResponse: '/reference/graphql-api/admin/object-types#deletionresponse',
|
|
964
|
-
ID: '/reference/graphql-api/admin/object-types#id',
|
|
965
|
-
}}
|
|
966
|
-
>
|
|
967
|
-
{`"""Delete multiple Countries"""
|
|
968
|
-
type Mutation {
|
|
969
|
-
deleteCountries(ids: [ID!]!): [DeletionResponse!]!
|
|
970
|
-
}`}
|
|
971
|
-
</GraphQLDoc>
|
|
972
|
-
|
|
973
|
-
## deleteCountry {#deletecountry}
|
|
974
|
-
|
|
975
|
-
<GraphQLDoc
|
|
976
|
-
type="mutation"
|
|
977
|
-
typeName="deleteCountry"
|
|
978
|
-
typeLinks={{
|
|
979
|
-
DeletionResponse: '/reference/graphql-api/admin/object-types#deletionresponse',
|
|
980
|
-
ID: '/reference/graphql-api/admin/object-types#id',
|
|
981
|
-
}}
|
|
982
|
-
>
|
|
983
|
-
{`"""Delete a Country"""
|
|
984
|
-
type Mutation {
|
|
985
|
-
deleteCountry(id: ID!): DeletionResponse!
|
|
986
|
-
}`}
|
|
987
|
-
</GraphQLDoc>
|
|
988
|
-
|
|
989
|
-
## deleteCustomer {#deletecustomer}
|
|
990
|
-
|
|
991
|
-
<GraphQLDoc
|
|
992
|
-
type="mutation"
|
|
993
|
-
typeName="deleteCustomer"
|
|
994
|
-
typeLinks={{
|
|
995
|
-
DeletionResponse: '/reference/graphql-api/admin/object-types#deletionresponse',
|
|
996
|
-
ID: '/reference/graphql-api/admin/object-types#id',
|
|
997
|
-
}}
|
|
998
|
-
>
|
|
999
|
-
{`"""Delete a Customer"""
|
|
1000
|
-
type Mutation {
|
|
1001
|
-
deleteCustomer(id: ID!): DeletionResponse!
|
|
1002
|
-
}`}
|
|
1003
|
-
</GraphQLDoc>
|
|
1004
|
-
|
|
1005
|
-
## deleteCustomerAddress {#deletecustomeraddress}
|
|
1006
|
-
|
|
1007
|
-
<GraphQLDoc
|
|
1008
|
-
type="mutation"
|
|
1009
|
-
typeName="deleteCustomerAddress"
|
|
1010
|
-
typeLinks={{
|
|
1011
|
-
Success: '/reference/graphql-api/admin/object-types#success',
|
|
1012
|
-
ID: '/reference/graphql-api/admin/object-types#id',
|
|
1013
|
-
}}
|
|
1014
|
-
>
|
|
1015
|
-
{`"""Update an existing Address"""
|
|
1016
|
-
type Mutation {
|
|
1017
|
-
deleteCustomerAddress(id: ID!): Success!
|
|
1018
|
-
}`}
|
|
1019
|
-
</GraphQLDoc>
|
|
1020
|
-
|
|
1021
|
-
## deleteCustomerGroup {#deletecustomergroup}
|
|
1022
|
-
|
|
1023
|
-
<GraphQLDoc
|
|
1024
|
-
type="mutation"
|
|
1025
|
-
typeName="deleteCustomerGroup"
|
|
1026
|
-
typeLinks={{
|
|
1027
|
-
DeletionResponse: '/reference/graphql-api/admin/object-types#deletionresponse',
|
|
1028
|
-
ID: '/reference/graphql-api/admin/object-types#id',
|
|
1029
|
-
}}
|
|
1030
|
-
>
|
|
1031
|
-
{`"""Delete a CustomerGroup"""
|
|
1032
|
-
type Mutation {
|
|
1033
|
-
deleteCustomerGroup(id: ID!): DeletionResponse!
|
|
1034
|
-
}`}
|
|
1035
|
-
</GraphQLDoc>
|
|
1036
|
-
|
|
1037
|
-
## deleteCustomerGroups {#deletecustomergroups}
|
|
1038
|
-
|
|
1039
|
-
<GraphQLDoc
|
|
1040
|
-
type="mutation"
|
|
1041
|
-
typeName="deleteCustomerGroups"
|
|
1042
|
-
typeLinks={{
|
|
1043
|
-
DeletionResponse: '/reference/graphql-api/admin/object-types#deletionresponse',
|
|
1044
|
-
ID: '/reference/graphql-api/admin/object-types#id',
|
|
1045
|
-
}}
|
|
1046
|
-
>
|
|
1047
|
-
{`"""Delete multiple CustomerGroups"""
|
|
1048
|
-
type Mutation {
|
|
1049
|
-
deleteCustomerGroups(ids: [ID!]!): [DeletionResponse!]!
|
|
1050
|
-
}`}
|
|
1051
|
-
</GraphQLDoc>
|
|
1052
|
-
|
|
1053
|
-
## deleteCustomerNote {#deletecustomernote}
|
|
1054
|
-
|
|
1055
|
-
<GraphQLDoc
|
|
1056
|
-
type="mutation"
|
|
1057
|
-
typeName="deleteCustomerNote"
|
|
1058
|
-
typeLinks={{
|
|
1059
|
-
DeletionResponse: '/reference/graphql-api/admin/object-types#deletionresponse',
|
|
1060
|
-
ID: '/reference/graphql-api/admin/object-types#id',
|
|
1061
|
-
}}
|
|
1062
|
-
>
|
|
1063
|
-
{`type Mutation {
|
|
1064
|
-
deleteCustomerNote(id: ID!): DeletionResponse!
|
|
1065
|
-
}`}
|
|
1066
|
-
</GraphQLDoc>
|
|
1067
|
-
|
|
1068
|
-
## deleteCustomers {#deletecustomers}
|
|
1069
|
-
|
|
1070
|
-
<GraphQLDoc
|
|
1071
|
-
type="mutation"
|
|
1072
|
-
typeName="deleteCustomers"
|
|
1073
|
-
typeLinks={{
|
|
1074
|
-
DeletionResponse: '/reference/graphql-api/admin/object-types#deletionresponse',
|
|
1075
|
-
ID: '/reference/graphql-api/admin/object-types#id',
|
|
1076
|
-
}}
|
|
1077
|
-
>
|
|
1078
|
-
{`"""Deletes Customers"""
|
|
1079
|
-
type Mutation {
|
|
1080
|
-
deleteCustomers(ids: [ID!]!): [DeletionResponse!]!
|
|
1081
|
-
}`}
|
|
1082
|
-
</GraphQLDoc>
|
|
1083
|
-
|
|
1084
|
-
## deleteDraftOrder {#deletedraftorder}
|
|
1085
|
-
|
|
1086
|
-
<GraphQLDoc
|
|
1087
|
-
type="mutation"
|
|
1088
|
-
typeName="deleteDraftOrder"
|
|
1089
|
-
typeLinks={{
|
|
1090
|
-
DeletionResponse: '/reference/graphql-api/admin/object-types#deletionresponse',
|
|
1091
|
-
ID: '/reference/graphql-api/admin/object-types#id',
|
|
1092
|
-
}}
|
|
1093
|
-
>
|
|
1094
|
-
{`"""Deletes a draft Order"""
|
|
1095
|
-
type Mutation {
|
|
1096
|
-
deleteDraftOrder(orderId: ID!): DeletionResponse!
|
|
1097
|
-
}`}
|
|
1098
|
-
</GraphQLDoc>
|
|
1099
|
-
|
|
1100
|
-
## deleteFacet {#deletefacet}
|
|
1101
|
-
|
|
1102
|
-
<GraphQLDoc
|
|
1103
|
-
type="mutation"
|
|
1104
|
-
typeName="deleteFacet"
|
|
1105
|
-
typeLinks={{
|
|
1106
|
-
DeletionResponse: '/reference/graphql-api/admin/object-types#deletionresponse',
|
|
1107
|
-
ID: '/reference/graphql-api/admin/object-types#id',
|
|
1108
|
-
Boolean: '/reference/graphql-api/admin/object-types#boolean',
|
|
1109
|
-
}}
|
|
1110
|
-
>
|
|
1111
|
-
{`"""Delete an existing Facet"""
|
|
1112
|
-
type Mutation {
|
|
1113
|
-
deleteFacet(id: ID!, force: Boolean): DeletionResponse!
|
|
1114
|
-
}`}
|
|
1115
|
-
</GraphQLDoc>
|
|
1116
|
-
|
|
1117
|
-
## deleteFacetValues {#deletefacetvalues}
|
|
1118
|
-
|
|
1119
|
-
<GraphQLDoc
|
|
1120
|
-
type="mutation"
|
|
1121
|
-
typeName="deleteFacetValues"
|
|
1122
|
-
typeLinks={{
|
|
1123
|
-
DeletionResponse: '/reference/graphql-api/admin/object-types#deletionresponse',
|
|
1124
|
-
ID: '/reference/graphql-api/admin/object-types#id',
|
|
1125
|
-
Boolean: '/reference/graphql-api/admin/object-types#boolean',
|
|
1126
|
-
}}
|
|
1127
|
-
>
|
|
1128
|
-
{`"""Delete one or more FacetValues"""
|
|
1129
|
-
type Mutation {
|
|
1130
|
-
deleteFacetValues(ids: [ID!]!, force: Boolean): [DeletionResponse!]!
|
|
1131
|
-
}`}
|
|
1132
|
-
</GraphQLDoc>
|
|
1133
|
-
|
|
1134
|
-
## deleteFacets {#deletefacets}
|
|
1135
|
-
|
|
1136
|
-
<GraphQLDoc
|
|
1137
|
-
type="mutation"
|
|
1138
|
-
typeName="deleteFacets"
|
|
1139
|
-
typeLinks={{
|
|
1140
|
-
DeletionResponse: '/reference/graphql-api/admin/object-types#deletionresponse',
|
|
1141
|
-
ID: '/reference/graphql-api/admin/object-types#id',
|
|
1142
|
-
Boolean: '/reference/graphql-api/admin/object-types#boolean',
|
|
1143
|
-
}}
|
|
1144
|
-
>
|
|
1145
|
-
{`"""Delete multiple existing Facets"""
|
|
1146
|
-
type Mutation {
|
|
1147
|
-
deleteFacets(ids: [ID!]!, force: Boolean): [DeletionResponse!]!
|
|
1148
|
-
}`}
|
|
1149
|
-
</GraphQLDoc>
|
|
1150
|
-
|
|
1151
|
-
## deleteOrderNote {#deleteordernote}
|
|
1152
|
-
|
|
1153
|
-
<GraphQLDoc
|
|
1154
|
-
type="mutation"
|
|
1155
|
-
typeName="deleteOrderNote"
|
|
1156
|
-
typeLinks={{
|
|
1157
|
-
DeletionResponse: '/reference/graphql-api/admin/object-types#deletionresponse',
|
|
1158
|
-
ID: '/reference/graphql-api/admin/object-types#id',
|
|
1159
|
-
}}
|
|
1160
|
-
>
|
|
1161
|
-
{`type Mutation {
|
|
1162
|
-
deleteOrderNote(id: ID!): DeletionResponse!
|
|
1163
|
-
}`}
|
|
1164
|
-
</GraphQLDoc>
|
|
1165
|
-
|
|
1166
|
-
## deletePaymentMethod {#deletepaymentmethod}
|
|
1167
|
-
|
|
1168
|
-
<GraphQLDoc
|
|
1169
|
-
type="mutation"
|
|
1170
|
-
typeName="deletePaymentMethod"
|
|
1171
|
-
typeLinks={{
|
|
1172
|
-
DeletionResponse: '/reference/graphql-api/admin/object-types#deletionresponse',
|
|
1173
|
-
ID: '/reference/graphql-api/admin/object-types#id',
|
|
1174
|
-
Boolean: '/reference/graphql-api/admin/object-types#boolean',
|
|
1175
|
-
}}
|
|
1176
|
-
>
|
|
1177
|
-
{`"""Delete a PaymentMethod"""
|
|
1178
|
-
type Mutation {
|
|
1179
|
-
deletePaymentMethod(id: ID!, force: Boolean): DeletionResponse!
|
|
1180
|
-
}`}
|
|
1181
|
-
</GraphQLDoc>
|
|
1182
|
-
|
|
1183
|
-
## deletePaymentMethods {#deletepaymentmethods}
|
|
1184
|
-
|
|
1185
|
-
<GraphQLDoc
|
|
1186
|
-
type="mutation"
|
|
1187
|
-
typeName="deletePaymentMethods"
|
|
1188
|
-
typeLinks={{
|
|
1189
|
-
DeletionResponse: '/reference/graphql-api/admin/object-types#deletionresponse',
|
|
1190
|
-
ID: '/reference/graphql-api/admin/object-types#id',
|
|
1191
|
-
Boolean: '/reference/graphql-api/admin/object-types#boolean',
|
|
1192
|
-
}}
|
|
1193
|
-
>
|
|
1194
|
-
{`"""Delete multiple PaymentMethods"""
|
|
1195
|
-
type Mutation {
|
|
1196
|
-
deletePaymentMethods(ids: [ID!]!, force: Boolean): [DeletionResponse!]!
|
|
1197
|
-
}`}
|
|
1198
|
-
</GraphQLDoc>
|
|
1199
|
-
|
|
1200
|
-
## deleteProduct {#deleteproduct}
|
|
1201
|
-
|
|
1202
|
-
<GraphQLDoc
|
|
1203
|
-
type="mutation"
|
|
1204
|
-
typeName="deleteProduct"
|
|
1205
|
-
typeLinks={{
|
|
1206
|
-
DeletionResponse: '/reference/graphql-api/admin/object-types#deletionresponse',
|
|
1207
|
-
ID: '/reference/graphql-api/admin/object-types#id',
|
|
1208
|
-
}}
|
|
1209
|
-
>
|
|
1210
|
-
{`"""Delete a Product"""
|
|
1211
|
-
type Mutation {
|
|
1212
|
-
deleteProduct(id: ID!): DeletionResponse!
|
|
1213
|
-
}`}
|
|
1214
|
-
</GraphQLDoc>
|
|
1215
|
-
|
|
1216
|
-
## deleteProductOption {#deleteproductoption}
|
|
1217
|
-
|
|
1218
|
-
<GraphQLDoc
|
|
1219
|
-
type="mutation"
|
|
1220
|
-
typeName="deleteProductOption"
|
|
1221
|
-
typeLinks={{
|
|
1222
|
-
DeletionResponse: '/reference/graphql-api/admin/object-types#deletionresponse',
|
|
1223
|
-
ID: '/reference/graphql-api/admin/object-types#id',
|
|
1224
|
-
}}
|
|
1225
|
-
>
|
|
1226
|
-
{`"""Delete a ProductOption"""
|
|
1227
|
-
type Mutation {
|
|
1228
|
-
deleteProductOption(id: ID!): DeletionResponse!
|
|
1229
|
-
}`}
|
|
1230
|
-
</GraphQLDoc>
|
|
1231
|
-
|
|
1232
|
-
## deleteProductVariant {#deleteproductvariant}
|
|
1233
|
-
|
|
1234
|
-
<GraphQLDoc
|
|
1235
|
-
type="mutation"
|
|
1236
|
-
typeName="deleteProductVariant"
|
|
1237
|
-
typeLinks={{
|
|
1238
|
-
DeletionResponse: '/reference/graphql-api/admin/object-types#deletionresponse',
|
|
1239
|
-
ID: '/reference/graphql-api/admin/object-types#id',
|
|
1240
|
-
}}
|
|
1241
|
-
>
|
|
1242
|
-
{`"""Delete a ProductVariant"""
|
|
1243
|
-
type Mutation {
|
|
1244
|
-
deleteProductVariant(id: ID!): DeletionResponse!
|
|
1245
|
-
}`}
|
|
1246
|
-
</GraphQLDoc>
|
|
1247
|
-
|
|
1248
|
-
## deleteProductVariants {#deleteproductvariants}
|
|
1249
|
-
|
|
1250
|
-
<GraphQLDoc
|
|
1251
|
-
type="mutation"
|
|
1252
|
-
typeName="deleteProductVariants"
|
|
1253
|
-
typeLinks={{
|
|
1254
|
-
DeletionResponse: '/reference/graphql-api/admin/object-types#deletionresponse',
|
|
1255
|
-
ID: '/reference/graphql-api/admin/object-types#id',
|
|
1256
|
-
}}
|
|
1257
|
-
>
|
|
1258
|
-
{`"""Delete multiple ProductVariants"""
|
|
1259
|
-
type Mutation {
|
|
1260
|
-
deleteProductVariants(ids: [ID!]!): [DeletionResponse!]!
|
|
1261
|
-
}`}
|
|
1262
|
-
</GraphQLDoc>
|
|
1263
|
-
|
|
1264
|
-
## deleteProducts {#deleteproducts}
|
|
1265
|
-
|
|
1266
|
-
<GraphQLDoc
|
|
1267
|
-
type="mutation"
|
|
1268
|
-
typeName="deleteProducts"
|
|
1269
|
-
typeLinks={{
|
|
1270
|
-
DeletionResponse: '/reference/graphql-api/admin/object-types#deletionresponse',
|
|
1271
|
-
ID: '/reference/graphql-api/admin/object-types#id',
|
|
1272
|
-
}}
|
|
1273
|
-
>
|
|
1274
|
-
{`"""Delete multiple Products"""
|
|
1275
|
-
type Mutation {
|
|
1276
|
-
deleteProducts(ids: [ID!]!): [DeletionResponse!]!
|
|
1277
|
-
}`}
|
|
1278
|
-
</GraphQLDoc>
|
|
1279
|
-
|
|
1280
|
-
## deletePromotion {#deletepromotion}
|
|
1281
|
-
|
|
1282
|
-
<GraphQLDoc
|
|
1283
|
-
type="mutation"
|
|
1284
|
-
typeName="deletePromotion"
|
|
1285
|
-
typeLinks={{
|
|
1286
|
-
DeletionResponse: '/reference/graphql-api/admin/object-types#deletionresponse',
|
|
1287
|
-
ID: '/reference/graphql-api/admin/object-types#id',
|
|
1288
|
-
}}
|
|
1289
|
-
>
|
|
1290
|
-
{`type Mutation {
|
|
1291
|
-
deletePromotion(id: ID!): DeletionResponse!
|
|
1292
|
-
}`}
|
|
1293
|
-
</GraphQLDoc>
|
|
1294
|
-
|
|
1295
|
-
## deletePromotions {#deletepromotions}
|
|
1296
|
-
|
|
1297
|
-
<GraphQLDoc
|
|
1298
|
-
type="mutation"
|
|
1299
|
-
typeName="deletePromotions"
|
|
1300
|
-
typeLinks={{
|
|
1301
|
-
DeletionResponse: '/reference/graphql-api/admin/object-types#deletionresponse',
|
|
1302
|
-
ID: '/reference/graphql-api/admin/object-types#id',
|
|
1303
|
-
}}
|
|
1304
|
-
>
|
|
1305
|
-
{`type Mutation {
|
|
1306
|
-
deletePromotions(ids: [ID!]!): [DeletionResponse!]!
|
|
1307
|
-
}`}
|
|
1308
|
-
</GraphQLDoc>
|
|
1309
|
-
|
|
1310
|
-
## deleteProvince {#deleteprovince}
|
|
1311
|
-
|
|
1312
|
-
<GraphQLDoc
|
|
1313
|
-
type="mutation"
|
|
1314
|
-
typeName="deleteProvince"
|
|
1315
|
-
typeLinks={{
|
|
1316
|
-
DeletionResponse: '/reference/graphql-api/admin/object-types#deletionresponse',
|
|
1317
|
-
ID: '/reference/graphql-api/admin/object-types#id',
|
|
1318
|
-
}}
|
|
1319
|
-
>
|
|
1320
|
-
{`"""Delete a Province"""
|
|
1321
|
-
type Mutation {
|
|
1322
|
-
deleteProvince(id: ID!): DeletionResponse!
|
|
1323
|
-
}`}
|
|
1324
|
-
</GraphQLDoc>
|
|
1325
|
-
|
|
1326
|
-
## deleteRole {#deleterole}
|
|
1327
|
-
|
|
1328
|
-
<GraphQLDoc
|
|
1329
|
-
type="mutation"
|
|
1330
|
-
typeName="deleteRole"
|
|
1331
|
-
typeLinks={{
|
|
1332
|
-
DeletionResponse: '/reference/graphql-api/admin/object-types#deletionresponse',
|
|
1333
|
-
ID: '/reference/graphql-api/admin/object-types#id',
|
|
1334
|
-
}}
|
|
1335
|
-
>
|
|
1336
|
-
{`"""Delete an existing Role"""
|
|
1337
|
-
type Mutation {
|
|
1338
|
-
deleteRole(id: ID!): DeletionResponse!
|
|
1339
|
-
}`}
|
|
1340
|
-
</GraphQLDoc>
|
|
1341
|
-
|
|
1342
|
-
## deleteRoles {#deleteroles}
|
|
1343
|
-
|
|
1344
|
-
<GraphQLDoc
|
|
1345
|
-
type="mutation"
|
|
1346
|
-
typeName="deleteRoles"
|
|
1347
|
-
typeLinks={{
|
|
1348
|
-
DeletionResponse: '/reference/graphql-api/admin/object-types#deletionresponse',
|
|
1349
|
-
ID: '/reference/graphql-api/admin/object-types#id',
|
|
1350
|
-
}}
|
|
1351
|
-
>
|
|
1352
|
-
{`"""Delete multiple Roles"""
|
|
1353
|
-
type Mutation {
|
|
1354
|
-
deleteRoles(ids: [ID!]!): [DeletionResponse!]!
|
|
1355
|
-
}`}
|
|
1356
|
-
</GraphQLDoc>
|
|
1357
|
-
|
|
1358
|
-
## deleteSeller {#deleteseller}
|
|
1359
|
-
|
|
1360
|
-
<GraphQLDoc
|
|
1361
|
-
type="mutation"
|
|
1362
|
-
typeName="deleteSeller"
|
|
1363
|
-
typeLinks={{
|
|
1364
|
-
DeletionResponse: '/reference/graphql-api/admin/object-types#deletionresponse',
|
|
1365
|
-
ID: '/reference/graphql-api/admin/object-types#id',
|
|
1366
|
-
}}
|
|
1367
|
-
>
|
|
1368
|
-
{`"""Delete a Seller"""
|
|
1369
|
-
type Mutation {
|
|
1370
|
-
deleteSeller(id: ID!): DeletionResponse!
|
|
1371
|
-
}`}
|
|
1372
|
-
</GraphQLDoc>
|
|
1373
|
-
|
|
1374
|
-
## deleteSellers {#deletesellers}
|
|
1375
|
-
|
|
1376
|
-
<GraphQLDoc
|
|
1377
|
-
type="mutation"
|
|
1378
|
-
typeName="deleteSellers"
|
|
1379
|
-
typeLinks={{
|
|
1380
|
-
DeletionResponse: '/reference/graphql-api/admin/object-types#deletionresponse',
|
|
1381
|
-
ID: '/reference/graphql-api/admin/object-types#id',
|
|
1382
|
-
}}
|
|
1383
|
-
>
|
|
1384
|
-
{`"""Delete multiple Sellers"""
|
|
1385
|
-
type Mutation {
|
|
1386
|
-
deleteSellers(ids: [ID!]!): [DeletionResponse!]!
|
|
1387
|
-
}`}
|
|
1388
|
-
</GraphQLDoc>
|
|
1389
|
-
|
|
1390
|
-
## deleteShippingMethod {#deleteshippingmethod}
|
|
1391
|
-
|
|
1392
|
-
<GraphQLDoc
|
|
1393
|
-
type="mutation"
|
|
1394
|
-
typeName="deleteShippingMethod"
|
|
1395
|
-
typeLinks={{
|
|
1396
|
-
DeletionResponse: '/reference/graphql-api/admin/object-types#deletionresponse',
|
|
1397
|
-
ID: '/reference/graphql-api/admin/object-types#id',
|
|
1398
|
-
}}
|
|
1399
|
-
>
|
|
1400
|
-
{`"""Delete a ShippingMethod"""
|
|
1401
|
-
type Mutation {
|
|
1402
|
-
deleteShippingMethod(id: ID!): DeletionResponse!
|
|
1403
|
-
}`}
|
|
1404
|
-
</GraphQLDoc>
|
|
1405
|
-
|
|
1406
|
-
## deleteShippingMethods {#deleteshippingmethods}
|
|
1407
|
-
|
|
1408
|
-
<GraphQLDoc
|
|
1409
|
-
type="mutation"
|
|
1410
|
-
typeName="deleteShippingMethods"
|
|
1411
|
-
typeLinks={{
|
|
1412
|
-
DeletionResponse: '/reference/graphql-api/admin/object-types#deletionresponse',
|
|
1413
|
-
ID: '/reference/graphql-api/admin/object-types#id',
|
|
1414
|
-
}}
|
|
1415
|
-
>
|
|
1416
|
-
{`"""Delete multiple ShippingMethods"""
|
|
1417
|
-
type Mutation {
|
|
1418
|
-
deleteShippingMethods(ids: [ID!]!): [DeletionResponse!]!
|
|
1419
|
-
}`}
|
|
1420
|
-
</GraphQLDoc>
|
|
1421
|
-
|
|
1422
|
-
## deleteStockLocation {#deletestocklocation}
|
|
1423
|
-
|
|
1424
|
-
<GraphQLDoc
|
|
1425
|
-
type="mutation"
|
|
1426
|
-
typeName="deleteStockLocation"
|
|
1427
|
-
typeLinks={{
|
|
1428
|
-
DeletionResponse: '/reference/graphql-api/admin/object-types#deletionresponse',
|
|
1429
|
-
DeleteStockLocationInput: '/reference/graphql-api/admin/input-types#deletestocklocationinput',
|
|
1430
|
-
}}
|
|
1431
|
-
>
|
|
1432
|
-
{`type Mutation {
|
|
1433
|
-
deleteStockLocation(input: DeleteStockLocationInput!): DeletionResponse!
|
|
1434
|
-
}`}
|
|
1435
|
-
</GraphQLDoc>
|
|
1436
|
-
|
|
1437
|
-
## deleteStockLocations {#deletestocklocations}
|
|
1438
|
-
|
|
1439
|
-
<GraphQLDoc
|
|
1440
|
-
type="mutation"
|
|
1441
|
-
typeName="deleteStockLocations"
|
|
1442
|
-
typeLinks={{
|
|
1443
|
-
DeletionResponse: '/reference/graphql-api/admin/object-types#deletionresponse',
|
|
1444
|
-
DeleteStockLocationInput: '/reference/graphql-api/admin/input-types#deletestocklocationinput',
|
|
1445
|
-
}}
|
|
1446
|
-
>
|
|
1447
|
-
{`type Mutation {
|
|
1448
|
-
deleteStockLocations(input: [DeleteStockLocationInput!]!): [DeletionResponse!]!
|
|
1449
|
-
}`}
|
|
1450
|
-
</GraphQLDoc>
|
|
1451
|
-
|
|
1452
|
-
## deleteTag {#deletetag}
|
|
1453
|
-
|
|
1454
|
-
<GraphQLDoc
|
|
1455
|
-
type="mutation"
|
|
1456
|
-
typeName="deleteTag"
|
|
1457
|
-
typeLinks={{
|
|
1458
|
-
DeletionResponse: '/reference/graphql-api/admin/object-types#deletionresponse',
|
|
1459
|
-
ID: '/reference/graphql-api/admin/object-types#id',
|
|
1460
|
-
}}
|
|
1461
|
-
>
|
|
1462
|
-
{`"""Delete an existing Tag"""
|
|
1463
|
-
type Mutation {
|
|
1464
|
-
deleteTag(id: ID!): DeletionResponse!
|
|
1465
|
-
}`}
|
|
1466
|
-
</GraphQLDoc>
|
|
1467
|
-
|
|
1468
|
-
## deleteTaxCategories {#deletetaxcategories}
|
|
1469
|
-
|
|
1470
|
-
<GraphQLDoc
|
|
1471
|
-
type="mutation"
|
|
1472
|
-
typeName="deleteTaxCategories"
|
|
1473
|
-
typeLinks={{
|
|
1474
|
-
DeletionResponse: '/reference/graphql-api/admin/object-types#deletionresponse',
|
|
1475
|
-
ID: '/reference/graphql-api/admin/object-types#id',
|
|
1476
|
-
}}
|
|
1477
|
-
>
|
|
1478
|
-
{`"""Deletes multiple TaxCategories"""
|
|
1479
|
-
type Mutation {
|
|
1480
|
-
deleteTaxCategories(ids: [ID!]!): [DeletionResponse!]!
|
|
1481
|
-
}`}
|
|
1482
|
-
</GraphQLDoc>
|
|
1483
|
-
|
|
1484
|
-
## deleteTaxCategory {#deletetaxcategory}
|
|
1485
|
-
|
|
1486
|
-
<GraphQLDoc
|
|
1487
|
-
type="mutation"
|
|
1488
|
-
typeName="deleteTaxCategory"
|
|
1489
|
-
typeLinks={{
|
|
1490
|
-
DeletionResponse: '/reference/graphql-api/admin/object-types#deletionresponse',
|
|
1491
|
-
ID: '/reference/graphql-api/admin/object-types#id',
|
|
1492
|
-
}}
|
|
1493
|
-
>
|
|
1494
|
-
{`"""Deletes a TaxCategory"""
|
|
1495
|
-
type Mutation {
|
|
1496
|
-
deleteTaxCategory(id: ID!): DeletionResponse!
|
|
1497
|
-
}`}
|
|
1498
|
-
</GraphQLDoc>
|
|
1499
|
-
|
|
1500
|
-
## deleteTaxRate {#deletetaxrate}
|
|
1501
|
-
|
|
1502
|
-
<GraphQLDoc
|
|
1503
|
-
type="mutation"
|
|
1504
|
-
typeName="deleteTaxRate"
|
|
1505
|
-
typeLinks={{
|
|
1506
|
-
DeletionResponse: '/reference/graphql-api/admin/object-types#deletionresponse',
|
|
1507
|
-
ID: '/reference/graphql-api/admin/object-types#id',
|
|
1508
|
-
}}
|
|
1509
|
-
>
|
|
1510
|
-
{`"""Delete a TaxRate"""
|
|
1511
|
-
type Mutation {
|
|
1512
|
-
deleteTaxRate(id: ID!): DeletionResponse!
|
|
1513
|
-
}`}
|
|
1514
|
-
</GraphQLDoc>
|
|
1515
|
-
|
|
1516
|
-
## deleteTaxRates {#deletetaxrates}
|
|
1517
|
-
|
|
1518
|
-
<GraphQLDoc
|
|
1519
|
-
type="mutation"
|
|
1520
|
-
typeName="deleteTaxRates"
|
|
1521
|
-
typeLinks={{
|
|
1522
|
-
DeletionResponse: '/reference/graphql-api/admin/object-types#deletionresponse',
|
|
1523
|
-
ID: '/reference/graphql-api/admin/object-types#id',
|
|
1524
|
-
}}
|
|
1525
|
-
>
|
|
1526
|
-
{`"""Delete multiple TaxRates"""
|
|
1527
|
-
type Mutation {
|
|
1528
|
-
deleteTaxRates(ids: [ID!]!): [DeletionResponse!]!
|
|
1529
|
-
}`}
|
|
1530
|
-
</GraphQLDoc>
|
|
1531
|
-
|
|
1532
|
-
## deleteZone {#deletezone}
|
|
1533
|
-
|
|
1534
|
-
<GraphQLDoc
|
|
1535
|
-
type="mutation"
|
|
1536
|
-
typeName="deleteZone"
|
|
1537
|
-
typeLinks={{
|
|
1538
|
-
DeletionResponse: '/reference/graphql-api/admin/object-types#deletionresponse',
|
|
1539
|
-
ID: '/reference/graphql-api/admin/object-types#id',
|
|
1540
|
-
}}
|
|
1541
|
-
>
|
|
1542
|
-
{`"""Delete a Zone"""
|
|
1543
|
-
type Mutation {
|
|
1544
|
-
deleteZone(id: ID!): DeletionResponse!
|
|
1545
|
-
}`}
|
|
1546
|
-
</GraphQLDoc>
|
|
1547
|
-
|
|
1548
|
-
## deleteZones {#deletezones}
|
|
1549
|
-
|
|
1550
|
-
<GraphQLDoc
|
|
1551
|
-
type="mutation"
|
|
1552
|
-
typeName="deleteZones"
|
|
1553
|
-
typeLinks={{
|
|
1554
|
-
DeletionResponse: '/reference/graphql-api/admin/object-types#deletionresponse',
|
|
1555
|
-
ID: '/reference/graphql-api/admin/object-types#id',
|
|
1556
|
-
}}
|
|
1557
|
-
>
|
|
1558
|
-
{`"""Delete a Zone"""
|
|
1559
|
-
type Mutation {
|
|
1560
|
-
deleteZones(ids: [ID!]!): [DeletionResponse!]!
|
|
1561
|
-
}`}
|
|
1562
|
-
</GraphQLDoc>
|
|
1563
|
-
|
|
1564
|
-
## duplicateEntity {#duplicateentity}
|
|
1565
|
-
|
|
1566
|
-
<GraphQLDoc
|
|
1567
|
-
type="mutation"
|
|
1568
|
-
typeName="duplicateEntity"
|
|
1569
|
-
typeLinks={{
|
|
1570
|
-
DuplicateEntityResult: '/reference/graphql-api/admin/object-types#duplicateentityresult',
|
|
1571
|
-
DuplicateEntityInput: '/reference/graphql-api/admin/input-types#duplicateentityinput',
|
|
1572
|
-
}}
|
|
1573
|
-
>
|
|
1574
|
-
{`"""
|
|
1575
|
-
Duplicate an existing entity using a specific EntityDuplicator.
|
|
1576
|
-
Since v2.2.0.
|
|
1577
|
-
"""
|
|
1578
|
-
type Mutation {
|
|
1579
|
-
duplicateEntity(input: DuplicateEntityInput!): DuplicateEntityResult!
|
|
1580
|
-
}`}
|
|
1581
|
-
</GraphQLDoc>
|
|
1582
|
-
|
|
1583
|
-
## flushBufferedJobs {#flushbufferedjobs}
|
|
1584
|
-
|
|
1585
|
-
<GraphQLDoc
|
|
1586
|
-
type="mutation"
|
|
1587
|
-
typeName="flushBufferedJobs"
|
|
1588
|
-
typeLinks={{
|
|
1589
|
-
Success: '/reference/graphql-api/admin/object-types#success',
|
|
1590
|
-
String: '/reference/graphql-api/admin/object-types#string',
|
|
1591
|
-
}}
|
|
1592
|
-
>
|
|
1593
|
-
{`type Mutation {
|
|
1594
|
-
flushBufferedJobs(bufferIds: [String!]): Success!
|
|
1595
|
-
}`}
|
|
1596
|
-
</GraphQLDoc>
|
|
1597
|
-
|
|
1598
|
-
## importProducts {#importproducts}
|
|
1599
|
-
|
|
1600
|
-
<GraphQLDoc
|
|
1601
|
-
type="mutation"
|
|
1602
|
-
typeName="importProducts"
|
|
1603
|
-
typeLinks={{
|
|
1604
|
-
ImportInfo: '/reference/graphql-api/admin/object-types#importinfo',
|
|
1605
|
-
Upload: '/reference/graphql-api/admin/object-types#upload',
|
|
1606
|
-
}}
|
|
1607
|
-
>
|
|
1608
|
-
{`type Mutation {
|
|
1609
|
-
importProducts(csvFile: Upload!): ImportInfo
|
|
1610
|
-
}`}
|
|
1611
|
-
</GraphQLDoc>
|
|
1612
|
-
|
|
1613
|
-
## login {#login}
|
|
1614
|
-
|
|
1615
|
-
<GraphQLDoc
|
|
1616
|
-
type="mutation"
|
|
1617
|
-
typeName="login"
|
|
1618
|
-
typeLinks={{
|
|
1619
|
-
NativeAuthenticationResult: '/reference/graphql-api/admin/object-types#nativeauthenticationresult',
|
|
1620
|
-
String: '/reference/graphql-api/admin/object-types#string',
|
|
1621
|
-
Boolean: '/reference/graphql-api/admin/object-types#boolean',
|
|
1622
|
-
}}
|
|
1623
|
-
>
|
|
1624
|
-
{`"""
|
|
1625
|
-
Authenticates the user using the native authentication strategy. This mutation is an alias for authenticate({ native: { ... }})
|
|
1626
|
-
|
|
1627
|
-
The \`rememberMe\` option applies when using cookie-based sessions, and if \`true\` it will set the maxAge of the session cookie
|
|
1628
|
-
to 1 year.
|
|
1629
|
-
"""
|
|
1630
|
-
type Mutation {
|
|
1631
|
-
login(username: String!, password: String!, rememberMe: Boolean): NativeAuthenticationResult!
|
|
1632
|
-
}`}
|
|
1633
|
-
</GraphQLDoc>
|
|
1634
|
-
|
|
1635
|
-
## logout {#logout}
|
|
1636
|
-
|
|
1637
|
-
<GraphQLDoc
|
|
1638
|
-
type="mutation"
|
|
1639
|
-
typeName="logout"
|
|
1640
|
-
typeLinks={{
|
|
1641
|
-
Success: '/reference/graphql-api/admin/object-types#success',
|
|
1642
|
-
}}
|
|
1643
|
-
>
|
|
1644
|
-
{`type Mutation {
|
|
1645
|
-
logout: Success!
|
|
1646
|
-
}`}
|
|
1647
|
-
</GraphQLDoc>
|
|
1648
|
-
|
|
1649
|
-
## modifyOrder {#modifyorder}
|
|
1650
|
-
|
|
1651
|
-
<GraphQLDoc
|
|
1652
|
-
type="mutation"
|
|
1653
|
-
typeName="modifyOrder"
|
|
1654
|
-
typeLinks={{
|
|
1655
|
-
ModifyOrderResult: '/reference/graphql-api/admin/object-types#modifyorderresult',
|
|
1656
|
-
ModifyOrderInput: '/reference/graphql-api/admin/input-types#modifyorderinput',
|
|
1657
|
-
}}
|
|
1658
|
-
>
|
|
1659
|
-
{`"""
|
|
1660
|
-
Allows an Order to be modified after it has been completed by the Customer. The Order must first
|
|
1661
|
-
be in the \`Modifying\` state.
|
|
1662
|
-
"""
|
|
1663
|
-
type Mutation {
|
|
1664
|
-
modifyOrder(input: ModifyOrderInput!): ModifyOrderResult!
|
|
1665
|
-
}`}
|
|
1666
|
-
</GraphQLDoc>
|
|
1667
|
-
|
|
1668
|
-
## moveCollection {#movecollection}
|
|
1669
|
-
|
|
1670
|
-
<GraphQLDoc
|
|
1671
|
-
type="mutation"
|
|
1672
|
-
typeName="moveCollection"
|
|
1673
|
-
typeLinks={{
|
|
1674
|
-
Collection: '/reference/graphql-api/admin/object-types#collection',
|
|
1675
|
-
MoveCollectionInput: '/reference/graphql-api/admin/input-types#movecollectioninput',
|
|
1676
|
-
}}
|
|
1677
|
-
>
|
|
1678
|
-
{`"""Move a Collection to a different parent or index"""
|
|
1679
|
-
type Mutation {
|
|
1680
|
-
moveCollection(input: MoveCollectionInput!): Collection!
|
|
1681
|
-
}`}
|
|
1682
|
-
</GraphQLDoc>
|
|
1683
|
-
|
|
1684
|
-
## refundOrder {#refundorder}
|
|
1685
|
-
|
|
1686
|
-
<GraphQLDoc
|
|
1687
|
-
type="mutation"
|
|
1688
|
-
typeName="refundOrder"
|
|
1689
|
-
typeLinks={{
|
|
1690
|
-
RefundOrderResult: '/reference/graphql-api/admin/object-types#refundorderresult',
|
|
1691
|
-
RefundOrderInput: '/reference/graphql-api/admin/input-types#refundorderinput',
|
|
1692
|
-
}}
|
|
1693
|
-
>
|
|
1694
|
-
{`type Mutation {
|
|
1695
|
-
refundOrder(input: RefundOrderInput!): RefundOrderResult!
|
|
1696
|
-
}`}
|
|
1697
|
-
</GraphQLDoc>
|
|
1698
|
-
|
|
1699
|
-
## reindex {#reindex}
|
|
1700
|
-
|
|
1701
|
-
<GraphQLDoc
|
|
1702
|
-
type="mutation"
|
|
1703
|
-
typeName="reindex"
|
|
1704
|
-
typeLinks={{
|
|
1705
|
-
Job: '/reference/graphql-api/admin/object-types#job',
|
|
1706
|
-
}}
|
|
1707
|
-
>
|
|
1708
|
-
{`type Mutation {
|
|
1709
|
-
reindex: Job!
|
|
1710
|
-
}`}
|
|
1711
|
-
</GraphQLDoc>
|
|
1712
|
-
|
|
1713
|
-
## removeCollectionsFromChannel {#removecollectionsfromchannel}
|
|
1714
|
-
|
|
1715
|
-
<GraphQLDoc
|
|
1716
|
-
type="mutation"
|
|
1717
|
-
typeName="removeCollectionsFromChannel"
|
|
1718
|
-
typeLinks={{
|
|
1719
|
-
Collection: '/reference/graphql-api/admin/object-types#collection',
|
|
1720
|
-
RemoveCollectionsFromChannelInput: '/reference/graphql-api/admin/input-types#removecollectionsfromchannelinput',
|
|
1721
|
-
}}
|
|
1722
|
-
>
|
|
1723
|
-
{`"""Removes Collections from the specified Channel"""
|
|
1724
|
-
type Mutation {
|
|
1725
|
-
removeCollectionsFromChannel(input: RemoveCollectionsFromChannelInput!): [Collection!]!
|
|
1726
|
-
}`}
|
|
1727
|
-
</GraphQLDoc>
|
|
1728
|
-
|
|
1729
|
-
## removeCouponCodeFromDraftOrder {#removecouponcodefromdraftorder}
|
|
1730
|
-
|
|
1731
|
-
<GraphQLDoc
|
|
1732
|
-
type="mutation"
|
|
1733
|
-
typeName="removeCouponCodeFromDraftOrder"
|
|
1734
|
-
typeLinks={{
|
|
1735
|
-
Order: '/reference/graphql-api/admin/object-types#order',
|
|
1736
|
-
ID: '/reference/graphql-api/admin/object-types#id',
|
|
1737
|
-
String: '/reference/graphql-api/admin/object-types#string',
|
|
1738
|
-
}}
|
|
1739
|
-
>
|
|
1740
|
-
{`"""Removes the given coupon code from the draft Order"""
|
|
1741
|
-
type Mutation {
|
|
1742
|
-
removeCouponCodeFromDraftOrder(orderId: ID!, couponCode: String!): Order
|
|
1743
|
-
}`}
|
|
1744
|
-
</GraphQLDoc>
|
|
1745
|
-
|
|
1746
|
-
## removeCustomersFromGroup {#removecustomersfromgroup}
|
|
1747
|
-
|
|
1748
|
-
<GraphQLDoc
|
|
1749
|
-
type="mutation"
|
|
1750
|
-
typeName="removeCustomersFromGroup"
|
|
1751
|
-
typeLinks={{
|
|
1752
|
-
CustomerGroup: '/reference/graphql-api/admin/object-types#customergroup',
|
|
1753
|
-
ID: '/reference/graphql-api/admin/object-types#id',
|
|
1754
|
-
}}
|
|
1755
|
-
>
|
|
1756
|
-
{`"""Remove Customers from a CustomerGroup"""
|
|
1757
|
-
type Mutation {
|
|
1758
|
-
removeCustomersFromGroup(customerGroupId: ID!, customerIds: [ID!]!): CustomerGroup!
|
|
1759
|
-
}`}
|
|
1760
|
-
</GraphQLDoc>
|
|
1761
|
-
|
|
1762
|
-
## removeDraftOrderLine {#removedraftorderline}
|
|
1763
|
-
|
|
1764
|
-
<GraphQLDoc
|
|
1765
|
-
type="mutation"
|
|
1766
|
-
typeName="removeDraftOrderLine"
|
|
1767
|
-
typeLinks={{
|
|
1768
|
-
RemoveOrderItemsResult: '/reference/graphql-api/admin/object-types#removeorderitemsresult',
|
|
1769
|
-
ID: '/reference/graphql-api/admin/object-types#id',
|
|
1770
|
-
}}
|
|
1771
|
-
>
|
|
1772
|
-
{`"""Remove an OrderLine from the draft Order"""
|
|
1773
|
-
type Mutation {
|
|
1774
|
-
removeDraftOrderLine(orderId: ID!, orderLineId: ID!): RemoveOrderItemsResult!
|
|
1775
|
-
}`}
|
|
1776
|
-
</GraphQLDoc>
|
|
1777
|
-
|
|
1778
|
-
## removeFacetsFromChannel {#removefacetsfromchannel}
|
|
1779
|
-
|
|
1780
|
-
<GraphQLDoc
|
|
1781
|
-
type="mutation"
|
|
1782
|
-
typeName="removeFacetsFromChannel"
|
|
1783
|
-
typeLinks={{
|
|
1784
|
-
RemoveFacetFromChannelResult: '/reference/graphql-api/admin/object-types#removefacetfromchannelresult',
|
|
1785
|
-
RemoveFacetsFromChannelInput: '/reference/graphql-api/admin/input-types#removefacetsfromchannelinput',
|
|
1786
|
-
}}
|
|
1787
|
-
>
|
|
1788
|
-
{`"""Removes Facets from the specified Channel"""
|
|
1789
|
-
type Mutation {
|
|
1790
|
-
removeFacetsFromChannel(input: RemoveFacetsFromChannelInput!): [RemoveFacetFromChannelResult!]!
|
|
1791
|
-
}`}
|
|
1792
|
-
</GraphQLDoc>
|
|
1793
|
-
|
|
1794
|
-
## removeMembersFromZone {#removemembersfromzone}
|
|
1795
|
-
|
|
1796
|
-
<GraphQLDoc
|
|
1797
|
-
type="mutation"
|
|
1798
|
-
typeName="removeMembersFromZone"
|
|
1799
|
-
typeLinks={{
|
|
1800
|
-
Zone: '/reference/graphql-api/admin/object-types#zone',
|
|
1801
|
-
ID: '/reference/graphql-api/admin/object-types#id',
|
|
1802
|
-
}}
|
|
1803
|
-
>
|
|
1804
|
-
{`"""Remove members from a Zone"""
|
|
1805
|
-
type Mutation {
|
|
1806
|
-
removeMembersFromZone(zoneId: ID!, memberIds: [ID!]!): Zone!
|
|
1807
|
-
}`}
|
|
1808
|
-
</GraphQLDoc>
|
|
1809
|
-
|
|
1810
|
-
## removeOptionGroupFromProduct {#removeoptiongroupfromproduct}
|
|
1811
|
-
|
|
1812
|
-
<GraphQLDoc
|
|
1813
|
-
type="mutation"
|
|
1814
|
-
typeName="removeOptionGroupFromProduct"
|
|
1815
|
-
typeLinks={{
|
|
1816
|
-
RemoveOptionGroupFromProductResult: '/reference/graphql-api/admin/object-types#removeoptiongroupfromproductresult',
|
|
1817
|
-
ID: '/reference/graphql-api/admin/object-types#id',
|
|
1818
|
-
Boolean: '/reference/graphql-api/admin/object-types#boolean',
|
|
1819
|
-
}}
|
|
1820
|
-
>
|
|
1821
|
-
{`"""
|
|
1822
|
-
Remove an OptionGroup from a Product. If the OptionGroup is in use by any ProductVariants
|
|
1823
|
-
the mutation will return a ProductOptionInUseError, and the OptionGroup will not be removed.
|
|
1824
|
-
Setting the \`force\` argument to \`true\` will override this and remove the OptionGroup anyway,
|
|
1825
|
-
as well as removing any of the group's options from the Product's ProductVariants.
|
|
1826
|
-
"""
|
|
1827
|
-
type Mutation {
|
|
1828
|
-
removeOptionGroupFromProduct(productId: ID!, optionGroupId: ID!, force: Boolean): RemoveOptionGroupFromProductResult!
|
|
1829
|
-
}`}
|
|
1830
|
-
</GraphQLDoc>
|
|
1831
|
-
|
|
1832
|
-
## removePaymentMethodsFromChannel {#removepaymentmethodsfromchannel}
|
|
1833
|
-
|
|
1834
|
-
<GraphQLDoc
|
|
1835
|
-
type="mutation"
|
|
1836
|
-
typeName="removePaymentMethodsFromChannel"
|
|
1837
|
-
typeLinks={{
|
|
1838
|
-
PaymentMethod: '/reference/graphql-api/admin/object-types#paymentmethod',
|
|
1839
|
-
RemovePaymentMethodsFromChannelInput: '/reference/graphql-api/admin/input-types#removepaymentmethodsfromchannelinput',
|
|
1840
|
-
}}
|
|
1841
|
-
>
|
|
1842
|
-
{`"""Removes PaymentMethods from the specified Channel"""
|
|
1843
|
-
type Mutation {
|
|
1844
|
-
removePaymentMethodsFromChannel(input: RemovePaymentMethodsFromChannelInput!): [PaymentMethod!]!
|
|
1845
|
-
}`}
|
|
1846
|
-
</GraphQLDoc>
|
|
1847
|
-
|
|
1848
|
-
## removeProductVariantsFromChannel {#removeproductvariantsfromchannel}
|
|
1849
|
-
|
|
1850
|
-
<GraphQLDoc
|
|
1851
|
-
type="mutation"
|
|
1852
|
-
typeName="removeProductVariantsFromChannel"
|
|
1853
|
-
typeLinks={{
|
|
1854
|
-
ProductVariant: '/reference/graphql-api/admin/object-types#productvariant',
|
|
1855
|
-
RemoveProductVariantsFromChannelInput: '/reference/graphql-api/admin/input-types#removeproductvariantsfromchannelinput',
|
|
1856
|
-
}}
|
|
1857
|
-
>
|
|
1858
|
-
{`"""Removes ProductVariants from the specified Channel"""
|
|
1859
|
-
type Mutation {
|
|
1860
|
-
removeProductVariantsFromChannel(input: RemoveProductVariantsFromChannelInput!): [ProductVariant!]!
|
|
1861
|
-
}`}
|
|
1862
|
-
</GraphQLDoc>
|
|
1863
|
-
|
|
1864
|
-
## removeProductsFromChannel {#removeproductsfromchannel}
|
|
1865
|
-
|
|
1866
|
-
<GraphQLDoc
|
|
1867
|
-
type="mutation"
|
|
1868
|
-
typeName="removeProductsFromChannel"
|
|
1869
|
-
typeLinks={{
|
|
1870
|
-
Product: '/reference/graphql-api/admin/object-types#product',
|
|
1871
|
-
RemoveProductsFromChannelInput: '/reference/graphql-api/admin/input-types#removeproductsfromchannelinput',
|
|
1872
|
-
}}
|
|
1873
|
-
>
|
|
1874
|
-
{`"""Removes all ProductVariants of Product from the specified Channel"""
|
|
1875
|
-
type Mutation {
|
|
1876
|
-
removeProductsFromChannel(input: RemoveProductsFromChannelInput!): [Product!]!
|
|
1877
|
-
}`}
|
|
1878
|
-
</GraphQLDoc>
|
|
1879
|
-
|
|
1880
|
-
## removePromotionsFromChannel {#removepromotionsfromchannel}
|
|
1881
|
-
|
|
1882
|
-
<GraphQLDoc
|
|
1883
|
-
type="mutation"
|
|
1884
|
-
typeName="removePromotionsFromChannel"
|
|
1885
|
-
typeLinks={{
|
|
1886
|
-
Promotion: '/reference/graphql-api/admin/object-types#promotion',
|
|
1887
|
-
RemovePromotionsFromChannelInput: '/reference/graphql-api/admin/input-types#removepromotionsfromchannelinput',
|
|
1888
|
-
}}
|
|
1889
|
-
>
|
|
1890
|
-
{`"""Removes Promotions from the specified Channel"""
|
|
1891
|
-
type Mutation {
|
|
1892
|
-
removePromotionsFromChannel(input: RemovePromotionsFromChannelInput!): [Promotion!]!
|
|
1893
|
-
}`}
|
|
1894
|
-
</GraphQLDoc>
|
|
1895
|
-
|
|
1896
|
-
## removeSettledJobs {#removesettledjobs}
|
|
1897
|
-
|
|
1898
|
-
<GraphQLDoc
|
|
1899
|
-
type="mutation"
|
|
1900
|
-
typeName="removeSettledJobs"
|
|
1901
|
-
typeLinks={{
|
|
1902
|
-
Int: '/reference/graphql-api/admin/object-types#int',
|
|
1903
|
-
String: '/reference/graphql-api/admin/object-types#string',
|
|
1904
|
-
DateTime: '/reference/graphql-api/admin/object-types#datetime',
|
|
1905
|
-
}}
|
|
1906
|
-
>
|
|
1907
|
-
{`"""Remove all settled jobs in the given queues older than the given date. Returns the number of jobs deleted."""
|
|
1908
|
-
type Mutation {
|
|
1909
|
-
removeSettledJobs(queueNames: [String!], olderThan: DateTime): Int!
|
|
1910
|
-
}`}
|
|
1911
|
-
</GraphQLDoc>
|
|
1912
|
-
|
|
1913
|
-
## removeShippingMethodsFromChannel {#removeshippingmethodsfromchannel}
|
|
1914
|
-
|
|
1915
|
-
<GraphQLDoc
|
|
1916
|
-
type="mutation"
|
|
1917
|
-
typeName="removeShippingMethodsFromChannel"
|
|
1918
|
-
typeLinks={{
|
|
1919
|
-
ShippingMethod: '/reference/graphql-api/admin/object-types#shippingmethod',
|
|
1920
|
-
RemoveShippingMethodsFromChannelInput: '/reference/graphql-api/admin/input-types#removeshippingmethodsfromchannelinput',
|
|
1921
|
-
}}
|
|
1922
|
-
>
|
|
1923
|
-
{`"""Removes ShippingMethods from the specified Channel"""
|
|
1924
|
-
type Mutation {
|
|
1925
|
-
removeShippingMethodsFromChannel(input: RemoveShippingMethodsFromChannelInput!): [ShippingMethod!]!
|
|
1926
|
-
}`}
|
|
1927
|
-
</GraphQLDoc>
|
|
1928
|
-
|
|
1929
|
-
## removeStockLocationsFromChannel {#removestocklocationsfromchannel}
|
|
1930
|
-
|
|
1931
|
-
<GraphQLDoc
|
|
1932
|
-
type="mutation"
|
|
1933
|
-
typeName="removeStockLocationsFromChannel"
|
|
1934
|
-
typeLinks={{
|
|
1935
|
-
StockLocation: '/reference/graphql-api/admin/object-types#stocklocation',
|
|
1936
|
-
RemoveStockLocationsFromChannelInput: '/reference/graphql-api/admin/input-types#removestocklocationsfromchannelinput',
|
|
1937
|
-
}}
|
|
1938
|
-
>
|
|
1939
|
-
{`"""Removes StockLocations from the specified Channel"""
|
|
1940
|
-
type Mutation {
|
|
1941
|
-
removeStockLocationsFromChannel(input: RemoveStockLocationsFromChannelInput!): [StockLocation!]!
|
|
1942
|
-
}`}
|
|
1943
|
-
</GraphQLDoc>
|
|
1944
|
-
|
|
1945
|
-
## runPendingSearchIndexUpdates {#runpendingsearchindexupdates}
|
|
1946
|
-
|
|
1947
|
-
<GraphQLDoc
|
|
1948
|
-
type="mutation"
|
|
1949
|
-
typeName="runPendingSearchIndexUpdates"
|
|
1950
|
-
typeLinks={{
|
|
1951
|
-
Success: '/reference/graphql-api/admin/object-types#success',
|
|
1952
|
-
}}
|
|
1953
|
-
>
|
|
1954
|
-
{`type Mutation {
|
|
1955
|
-
runPendingSearchIndexUpdates: Success!
|
|
1956
|
-
}`}
|
|
1957
|
-
</GraphQLDoc>
|
|
1958
|
-
|
|
1959
|
-
## runScheduledTask {#runscheduledtask}
|
|
1960
|
-
|
|
1961
|
-
<GraphQLDoc
|
|
1962
|
-
type="mutation"
|
|
1963
|
-
typeName="runScheduledTask"
|
|
1964
|
-
typeLinks={{
|
|
1965
|
-
Success: '/reference/graphql-api/admin/object-types#success',
|
|
1966
|
-
String: '/reference/graphql-api/admin/object-types#string',
|
|
1967
|
-
}}
|
|
1968
|
-
>
|
|
1969
|
-
{`type Mutation {
|
|
1970
|
-
runScheduledTask(id: String!): Success!
|
|
1971
|
-
}`}
|
|
1972
|
-
</GraphQLDoc>
|
|
1973
|
-
|
|
1974
|
-
## setCustomerForDraftOrder {#setcustomerfordraftorder}
|
|
1975
|
-
|
|
1976
|
-
<GraphQLDoc
|
|
1977
|
-
type="mutation"
|
|
1978
|
-
typeName="setCustomerForDraftOrder"
|
|
1979
|
-
typeLinks={{
|
|
1980
|
-
SetCustomerForDraftOrderResult: '/reference/graphql-api/admin/object-types#setcustomerfordraftorderresult',
|
|
1981
|
-
ID: '/reference/graphql-api/admin/object-types#id',
|
|
1982
|
-
CreateCustomerInput: '/reference/graphql-api/admin/input-types#createcustomerinput',
|
|
1983
|
-
}}
|
|
1984
|
-
>
|
|
1985
|
-
{`type Mutation {
|
|
1986
|
-
setCustomerForDraftOrder(orderId: ID!, customerId: ID, input: CreateCustomerInput): SetCustomerForDraftOrderResult!
|
|
1987
|
-
}`}
|
|
1988
|
-
</GraphQLDoc>
|
|
1989
|
-
|
|
1990
|
-
## setDraftOrderBillingAddress {#setdraftorderbillingaddress}
|
|
1991
|
-
|
|
1992
|
-
<GraphQLDoc
|
|
1993
|
-
type="mutation"
|
|
1994
|
-
typeName="setDraftOrderBillingAddress"
|
|
1995
|
-
typeLinks={{
|
|
1996
|
-
Order: '/reference/graphql-api/admin/object-types#order',
|
|
1997
|
-
ID: '/reference/graphql-api/admin/object-types#id',
|
|
1998
|
-
CreateAddressInput: '/reference/graphql-api/admin/input-types#createaddressinput',
|
|
1999
|
-
}}
|
|
2000
|
-
>
|
|
2001
|
-
{`"""Sets the billing address for a draft Order"""
|
|
2002
|
-
type Mutation {
|
|
2003
|
-
setDraftOrderBillingAddress(orderId: ID!, input: CreateAddressInput!): Order!
|
|
2004
|
-
}`}
|
|
2005
|
-
</GraphQLDoc>
|
|
2006
|
-
|
|
2007
|
-
## setDraftOrderCustomFields {#setdraftordercustomfields}
|
|
2008
|
-
|
|
2009
|
-
<GraphQLDoc
|
|
2010
|
-
type="mutation"
|
|
2011
|
-
typeName="setDraftOrderCustomFields"
|
|
2012
|
-
typeLinks={{
|
|
2013
|
-
Order: '/reference/graphql-api/admin/object-types#order',
|
|
2014
|
-
ID: '/reference/graphql-api/admin/object-types#id',
|
|
2015
|
-
UpdateOrderInput: '/reference/graphql-api/admin/input-types#updateorderinput',
|
|
2016
|
-
}}
|
|
2017
|
-
>
|
|
2018
|
-
{`"""Allows any custom fields to be set for the active order"""
|
|
2019
|
-
type Mutation {
|
|
2020
|
-
setDraftOrderCustomFields(orderId: ID!, input: UpdateOrderInput!): Order!
|
|
2021
|
-
}`}
|
|
2022
|
-
</GraphQLDoc>
|
|
2023
|
-
|
|
2024
|
-
## setDraftOrderShippingAddress {#setdraftordershippingaddress}
|
|
2025
|
-
|
|
2026
|
-
<GraphQLDoc
|
|
2027
|
-
type="mutation"
|
|
2028
|
-
typeName="setDraftOrderShippingAddress"
|
|
2029
|
-
typeLinks={{
|
|
2030
|
-
Order: '/reference/graphql-api/admin/object-types#order',
|
|
2031
|
-
ID: '/reference/graphql-api/admin/object-types#id',
|
|
2032
|
-
CreateAddressInput: '/reference/graphql-api/admin/input-types#createaddressinput',
|
|
2033
|
-
}}
|
|
2034
|
-
>
|
|
2035
|
-
{`"""Sets the shipping address for a draft Order"""
|
|
2036
|
-
type Mutation {
|
|
2037
|
-
setDraftOrderShippingAddress(orderId: ID!, input: CreateAddressInput!): Order!
|
|
2038
|
-
}`}
|
|
2039
|
-
</GraphQLDoc>
|
|
2040
|
-
|
|
2041
|
-
## setDraftOrderShippingMethod {#setdraftordershippingmethod}
|
|
2042
|
-
|
|
2043
|
-
<GraphQLDoc
|
|
2044
|
-
type="mutation"
|
|
2045
|
-
typeName="setDraftOrderShippingMethod"
|
|
2046
|
-
typeLinks={{
|
|
2047
|
-
SetOrderShippingMethodResult: '/reference/graphql-api/admin/object-types#setordershippingmethodresult',
|
|
2048
|
-
ID: '/reference/graphql-api/admin/object-types#id',
|
|
2049
|
-
}}
|
|
2050
|
-
>
|
|
2051
|
-
{`"""Sets the shipping method by id, which can be obtained with the \`eligibleShippingMethodsForDraftOrder\` query"""
|
|
2052
|
-
type Mutation {
|
|
2053
|
-
setDraftOrderShippingMethod(orderId: ID!, shippingMethodId: ID!): SetOrderShippingMethodResult!
|
|
2054
|
-
}`}
|
|
2055
|
-
</GraphQLDoc>
|
|
2056
|
-
|
|
2057
|
-
## setOrderCustomFields {#setordercustomfields}
|
|
2058
|
-
|
|
2059
|
-
<GraphQLDoc
|
|
2060
|
-
type="mutation"
|
|
2061
|
-
typeName="setOrderCustomFields"
|
|
2062
|
-
typeLinks={{
|
|
2063
|
-
Order: '/reference/graphql-api/admin/object-types#order',
|
|
2064
|
-
UpdateOrderInput: '/reference/graphql-api/admin/input-types#updateorderinput',
|
|
2065
|
-
}}
|
|
2066
|
-
>
|
|
2067
|
-
{`type Mutation {
|
|
2068
|
-
setOrderCustomFields(input: UpdateOrderInput!): Order
|
|
2069
|
-
}`}
|
|
2070
|
-
</GraphQLDoc>
|
|
2071
|
-
|
|
2072
|
-
## setOrderCustomer {#setordercustomer}
|
|
2073
|
-
|
|
2074
|
-
<GraphQLDoc
|
|
2075
|
-
type="mutation"
|
|
2076
|
-
typeName="setOrderCustomer"
|
|
2077
|
-
typeLinks={{
|
|
2078
|
-
Order: '/reference/graphql-api/admin/object-types#order',
|
|
2079
|
-
SetOrderCustomerInput: '/reference/graphql-api/admin/input-types#setordercustomerinput',
|
|
2080
|
-
}}
|
|
2081
|
-
>
|
|
2082
|
-
{`"""Allows a different Customer to be assigned to an Order. Added in v2.2.0."""
|
|
2083
|
-
type Mutation {
|
|
2084
|
-
setOrderCustomer(input: SetOrderCustomerInput!): Order
|
|
2085
|
-
}`}
|
|
2086
|
-
</GraphQLDoc>
|
|
2087
|
-
|
|
2088
|
-
## setSettingsStoreValue {#setsettingsstorevalue}
|
|
2089
|
-
|
|
2090
|
-
<GraphQLDoc
|
|
2091
|
-
type="mutation"
|
|
2092
|
-
typeName="setSettingsStoreValue"
|
|
2093
|
-
typeLinks={{
|
|
2094
|
-
SetSettingsStoreValueResult: '/reference/graphql-api/admin/object-types#setsettingsstorevalueresult',
|
|
2095
|
-
SettingsStoreInput: '/reference/graphql-api/admin/input-types#settingsstoreinput',
|
|
2096
|
-
}}
|
|
2097
|
-
>
|
|
2098
|
-
{`"""Set a single key-value pair (automatically scoped based on field configuration)"""
|
|
2099
|
-
type Mutation {
|
|
2100
|
-
setSettingsStoreValue(input: SettingsStoreInput!): SetSettingsStoreValueResult!
|
|
2101
|
-
}`}
|
|
2102
|
-
</GraphQLDoc>
|
|
2103
|
-
|
|
2104
|
-
## setSettingsStoreValues {#setsettingsstorevalues}
|
|
2105
|
-
|
|
2106
|
-
<GraphQLDoc
|
|
2107
|
-
type="mutation"
|
|
2108
|
-
typeName="setSettingsStoreValues"
|
|
2109
|
-
typeLinks={{
|
|
2110
|
-
SetSettingsStoreValueResult: '/reference/graphql-api/admin/object-types#setsettingsstorevalueresult',
|
|
2111
|
-
SettingsStoreInput: '/reference/graphql-api/admin/input-types#settingsstoreinput',
|
|
2112
|
-
}}
|
|
2113
|
-
>
|
|
2114
|
-
{`"""Set multiple key-value pairs in a transaction (each automatically scoped)"""
|
|
2115
|
-
type Mutation {
|
|
2116
|
-
setSettingsStoreValues(inputs: [SettingsStoreInput!]!): [SetSettingsStoreValueResult!]!
|
|
2117
|
-
}`}
|
|
2118
|
-
</GraphQLDoc>
|
|
2119
|
-
|
|
2120
|
-
## settlePayment {#settlepayment}
|
|
2121
|
-
|
|
2122
|
-
<GraphQLDoc
|
|
2123
|
-
type="mutation"
|
|
2124
|
-
typeName="settlePayment"
|
|
2125
|
-
typeLinks={{
|
|
2126
|
-
SettlePaymentResult: '/reference/graphql-api/admin/object-types#settlepaymentresult',
|
|
2127
|
-
ID: '/reference/graphql-api/admin/object-types#id',
|
|
2128
|
-
}}
|
|
2129
|
-
>
|
|
2130
|
-
{`type Mutation {
|
|
2131
|
-
settlePayment(id: ID!): SettlePaymentResult!
|
|
2132
|
-
}`}
|
|
2133
|
-
</GraphQLDoc>
|
|
2134
|
-
|
|
2135
|
-
## settleRefund {#settlerefund}
|
|
2136
|
-
|
|
2137
|
-
<GraphQLDoc
|
|
2138
|
-
type="mutation"
|
|
2139
|
-
typeName="settleRefund"
|
|
2140
|
-
typeLinks={{
|
|
2141
|
-
SettleRefundResult: '/reference/graphql-api/admin/object-types#settlerefundresult',
|
|
2142
|
-
SettleRefundInput: '/reference/graphql-api/admin/input-types#settlerefundinput',
|
|
2143
|
-
}}
|
|
2144
|
-
>
|
|
2145
|
-
{`type Mutation {
|
|
2146
|
-
settleRefund(input: SettleRefundInput!): SettleRefundResult!
|
|
2147
|
-
}`}
|
|
2148
|
-
</GraphQLDoc>
|
|
2149
|
-
|
|
2150
|
-
## transitionFulfillmentToState {#transitionfulfillmenttostate}
|
|
2151
|
-
|
|
2152
|
-
<GraphQLDoc
|
|
2153
|
-
type="mutation"
|
|
2154
|
-
typeName="transitionFulfillmentToState"
|
|
2155
|
-
typeLinks={{
|
|
2156
|
-
TransitionFulfillmentToStateResult: '/reference/graphql-api/admin/object-types#transitionfulfillmenttostateresult',
|
|
2157
|
-
ID: '/reference/graphql-api/admin/object-types#id',
|
|
2158
|
-
String: '/reference/graphql-api/admin/object-types#string',
|
|
2159
|
-
}}
|
|
2160
|
-
>
|
|
2161
|
-
{`type Mutation {
|
|
2162
|
-
transitionFulfillmentToState(id: ID!, state: String!): TransitionFulfillmentToStateResult!
|
|
2163
|
-
}`}
|
|
2164
|
-
</GraphQLDoc>
|
|
2165
|
-
|
|
2166
|
-
## transitionOrderToState {#transitionordertostate}
|
|
2167
|
-
|
|
2168
|
-
<GraphQLDoc
|
|
2169
|
-
type="mutation"
|
|
2170
|
-
typeName="transitionOrderToState"
|
|
2171
|
-
typeLinks={{
|
|
2172
|
-
TransitionOrderToStateResult: '/reference/graphql-api/admin/object-types#transitionordertostateresult',
|
|
2173
|
-
ID: '/reference/graphql-api/admin/object-types#id',
|
|
2174
|
-
String: '/reference/graphql-api/admin/object-types#string',
|
|
2175
|
-
}}
|
|
2176
|
-
>
|
|
2177
|
-
{`type Mutation {
|
|
2178
|
-
transitionOrderToState(id: ID!, state: String!): TransitionOrderToStateResult
|
|
2179
|
-
}`}
|
|
2180
|
-
</GraphQLDoc>
|
|
2181
|
-
|
|
2182
|
-
## transitionPaymentToState {#transitionpaymenttostate}
|
|
2183
|
-
|
|
2184
|
-
<GraphQLDoc
|
|
2185
|
-
type="mutation"
|
|
2186
|
-
typeName="transitionPaymentToState"
|
|
2187
|
-
typeLinks={{
|
|
2188
|
-
TransitionPaymentToStateResult: '/reference/graphql-api/admin/object-types#transitionpaymenttostateresult',
|
|
2189
|
-
ID: '/reference/graphql-api/admin/object-types#id',
|
|
2190
|
-
String: '/reference/graphql-api/admin/object-types#string',
|
|
2191
|
-
}}
|
|
2192
|
-
>
|
|
2193
|
-
{`type Mutation {
|
|
2194
|
-
transitionPaymentToState(id: ID!, state: String!): TransitionPaymentToStateResult!
|
|
2195
|
-
}`}
|
|
2196
|
-
</GraphQLDoc>
|
|
2197
|
-
|
|
2198
|
-
## unsetDraftOrderBillingAddress {#unsetdraftorderbillingaddress}
|
|
2199
|
-
|
|
2200
|
-
<GraphQLDoc
|
|
2201
|
-
type="mutation"
|
|
2202
|
-
typeName="unsetDraftOrderBillingAddress"
|
|
2203
|
-
typeLinks={{
|
|
2204
|
-
Order: '/reference/graphql-api/admin/object-types#order',
|
|
2205
|
-
ID: '/reference/graphql-api/admin/object-types#id',
|
|
2206
|
-
}}
|
|
2207
|
-
>
|
|
2208
|
-
{`"""Unsets the billing address for a draft Order"""
|
|
2209
|
-
type Mutation {
|
|
2210
|
-
unsetDraftOrderBillingAddress(orderId: ID!): Order!
|
|
2211
|
-
}`}
|
|
2212
|
-
</GraphQLDoc>
|
|
2213
|
-
|
|
2214
|
-
## unsetDraftOrderShippingAddress {#unsetdraftordershippingaddress}
|
|
2215
|
-
|
|
2216
|
-
<GraphQLDoc
|
|
2217
|
-
type="mutation"
|
|
2218
|
-
typeName="unsetDraftOrderShippingAddress"
|
|
2219
|
-
typeLinks={{
|
|
2220
|
-
Order: '/reference/graphql-api/admin/object-types#order',
|
|
2221
|
-
ID: '/reference/graphql-api/admin/object-types#id',
|
|
2222
|
-
}}
|
|
2223
|
-
>
|
|
2224
|
-
{`"""Unsets the shipping address for a draft Order"""
|
|
2225
|
-
type Mutation {
|
|
2226
|
-
unsetDraftOrderShippingAddress(orderId: ID!): Order!
|
|
2227
|
-
}`}
|
|
2228
|
-
</GraphQLDoc>
|
|
2229
|
-
|
|
2230
|
-
## updateActiveAdministrator {#updateactiveadministrator}
|
|
2231
|
-
|
|
2232
|
-
<GraphQLDoc
|
|
2233
|
-
type="mutation"
|
|
2234
|
-
typeName="updateActiveAdministrator"
|
|
2235
|
-
typeLinks={{
|
|
2236
|
-
Administrator: '/reference/graphql-api/admin/object-types#administrator',
|
|
2237
|
-
UpdateActiveAdministratorInput: '/reference/graphql-api/admin/input-types#updateactiveadministratorinput',
|
|
2238
|
-
}}
|
|
2239
|
-
>
|
|
2240
|
-
{`"""Update the active (currently logged-in) Administrator"""
|
|
2241
|
-
type Mutation {
|
|
2242
|
-
updateActiveAdministrator(input: UpdateActiveAdministratorInput!): Administrator!
|
|
2243
|
-
}`}
|
|
2244
|
-
</GraphQLDoc>
|
|
2245
|
-
|
|
2246
|
-
## updateAdministrator {#updateadministrator}
|
|
2247
|
-
|
|
2248
|
-
<GraphQLDoc
|
|
2249
|
-
type="mutation"
|
|
2250
|
-
typeName="updateAdministrator"
|
|
2251
|
-
typeLinks={{
|
|
2252
|
-
Administrator: '/reference/graphql-api/admin/object-types#administrator',
|
|
2253
|
-
UpdateAdministratorInput: '/reference/graphql-api/admin/input-types#updateadministratorinput',
|
|
2254
|
-
}}
|
|
2255
|
-
>
|
|
2256
|
-
{`"""Update an existing Administrator"""
|
|
2257
|
-
type Mutation {
|
|
2258
|
-
updateAdministrator(input: UpdateAdministratorInput!): Administrator!
|
|
2259
|
-
}`}
|
|
2260
|
-
</GraphQLDoc>
|
|
2261
|
-
|
|
2262
|
-
## updateAsset {#updateasset}
|
|
2263
|
-
|
|
2264
|
-
<GraphQLDoc
|
|
2265
|
-
type="mutation"
|
|
2266
|
-
typeName="updateAsset"
|
|
2267
|
-
typeLinks={{
|
|
2268
|
-
Asset: '/reference/graphql-api/admin/object-types#asset',
|
|
2269
|
-
UpdateAssetInput: '/reference/graphql-api/admin/input-types#updateassetinput',
|
|
2270
|
-
}}
|
|
2271
|
-
>
|
|
2272
|
-
{`"""Update an existing Asset"""
|
|
2273
|
-
type Mutation {
|
|
2274
|
-
updateAsset(input: UpdateAssetInput!): Asset!
|
|
2275
|
-
}`}
|
|
2276
|
-
</GraphQLDoc>
|
|
2277
|
-
|
|
2278
|
-
## updateChannel {#updatechannel}
|
|
2279
|
-
|
|
2280
|
-
<GraphQLDoc
|
|
2281
|
-
type="mutation"
|
|
2282
|
-
typeName="updateChannel"
|
|
2283
|
-
typeLinks={{
|
|
2284
|
-
UpdateChannelResult: '/reference/graphql-api/admin/object-types#updatechannelresult',
|
|
2285
|
-
UpdateChannelInput: '/reference/graphql-api/admin/input-types#updatechannelinput',
|
|
2286
|
-
}}
|
|
2287
|
-
>
|
|
2288
|
-
{`"""Update an existing Channel"""
|
|
2289
|
-
type Mutation {
|
|
2290
|
-
updateChannel(input: UpdateChannelInput!): UpdateChannelResult!
|
|
2291
|
-
}`}
|
|
2292
|
-
</GraphQLDoc>
|
|
2293
|
-
|
|
2294
|
-
## updateCollection {#updatecollection}
|
|
2295
|
-
|
|
2296
|
-
<GraphQLDoc
|
|
2297
|
-
type="mutation"
|
|
2298
|
-
typeName="updateCollection"
|
|
2299
|
-
typeLinks={{
|
|
2300
|
-
Collection: '/reference/graphql-api/admin/object-types#collection',
|
|
2301
|
-
UpdateCollectionInput: '/reference/graphql-api/admin/input-types#updatecollectioninput',
|
|
2302
|
-
}}
|
|
2303
|
-
>
|
|
2304
|
-
{`"""Update an existing Collection"""
|
|
2305
|
-
type Mutation {
|
|
2306
|
-
updateCollection(input: UpdateCollectionInput!): Collection!
|
|
2307
|
-
}`}
|
|
2308
|
-
</GraphQLDoc>
|
|
2309
|
-
|
|
2310
|
-
## updateCountry {#updatecountry}
|
|
2311
|
-
|
|
2312
|
-
<GraphQLDoc
|
|
2313
|
-
type="mutation"
|
|
2314
|
-
typeName="updateCountry"
|
|
2315
|
-
typeLinks={{
|
|
2316
|
-
Country: '/reference/graphql-api/admin/object-types#country',
|
|
2317
|
-
UpdateCountryInput: '/reference/graphql-api/admin/input-types#updatecountryinput',
|
|
2318
|
-
}}
|
|
2319
|
-
>
|
|
2320
|
-
{`"""Update an existing Country"""
|
|
2321
|
-
type Mutation {
|
|
2322
|
-
updateCountry(input: UpdateCountryInput!): Country!
|
|
2323
|
-
}`}
|
|
2324
|
-
</GraphQLDoc>
|
|
2325
|
-
|
|
2326
|
-
## updateCustomer {#updatecustomer}
|
|
2327
|
-
|
|
2328
|
-
<GraphQLDoc
|
|
2329
|
-
type="mutation"
|
|
2330
|
-
typeName="updateCustomer"
|
|
2331
|
-
typeLinks={{
|
|
2332
|
-
UpdateCustomerResult: '/reference/graphql-api/admin/object-types#updatecustomerresult',
|
|
2333
|
-
UpdateCustomerInput: '/reference/graphql-api/admin/input-types#updatecustomerinput',
|
|
2334
|
-
}}
|
|
2335
|
-
>
|
|
2336
|
-
{`"""Update an existing Customer"""
|
|
2337
|
-
type Mutation {
|
|
2338
|
-
updateCustomer(input: UpdateCustomerInput!): UpdateCustomerResult!
|
|
2339
|
-
}`}
|
|
2340
|
-
</GraphQLDoc>
|
|
2341
|
-
|
|
2342
|
-
## updateCustomerAddress {#updatecustomeraddress}
|
|
2343
|
-
|
|
2344
|
-
<GraphQLDoc
|
|
2345
|
-
type="mutation"
|
|
2346
|
-
typeName="updateCustomerAddress"
|
|
2347
|
-
typeLinks={{
|
|
2348
|
-
Address: '/reference/graphql-api/admin/object-types#address',
|
|
2349
|
-
UpdateAddressInput: '/reference/graphql-api/admin/input-types#updateaddressinput',
|
|
2350
|
-
}}
|
|
2351
|
-
>
|
|
2352
|
-
{`"""Update an existing Address"""
|
|
2353
|
-
type Mutation {
|
|
2354
|
-
updateCustomerAddress(input: UpdateAddressInput!): Address!
|
|
2355
|
-
}`}
|
|
2356
|
-
</GraphQLDoc>
|
|
2357
|
-
|
|
2358
|
-
## updateCustomerGroup {#updatecustomergroup}
|
|
2359
|
-
|
|
2360
|
-
<GraphQLDoc
|
|
2361
|
-
type="mutation"
|
|
2362
|
-
typeName="updateCustomerGroup"
|
|
2363
|
-
typeLinks={{
|
|
2364
|
-
CustomerGroup: '/reference/graphql-api/admin/object-types#customergroup',
|
|
2365
|
-
UpdateCustomerGroupInput: '/reference/graphql-api/admin/input-types#updatecustomergroupinput',
|
|
2366
|
-
}}
|
|
2367
|
-
>
|
|
2368
|
-
{`"""Update an existing CustomerGroup"""
|
|
2369
|
-
type Mutation {
|
|
2370
|
-
updateCustomerGroup(input: UpdateCustomerGroupInput!): CustomerGroup!
|
|
2371
|
-
}`}
|
|
2372
|
-
</GraphQLDoc>
|
|
2373
|
-
|
|
2374
|
-
## updateCustomerNote {#updatecustomernote}
|
|
2375
|
-
|
|
2376
|
-
<GraphQLDoc
|
|
2377
|
-
type="mutation"
|
|
2378
|
-
typeName="updateCustomerNote"
|
|
2379
|
-
typeLinks={{
|
|
2380
|
-
HistoryEntry: '/reference/graphql-api/admin/object-types#historyentry',
|
|
2381
|
-
UpdateCustomerNoteInput: '/reference/graphql-api/admin/input-types#updatecustomernoteinput',
|
|
2382
|
-
}}
|
|
2383
|
-
>
|
|
2384
|
-
{`type Mutation {
|
|
2385
|
-
updateCustomerNote(input: UpdateCustomerNoteInput!): HistoryEntry!
|
|
2386
|
-
}`}
|
|
2387
|
-
</GraphQLDoc>
|
|
2388
|
-
|
|
2389
|
-
## updateFacet {#updatefacet}
|
|
2390
|
-
|
|
2391
|
-
<GraphQLDoc
|
|
2392
|
-
type="mutation"
|
|
2393
|
-
typeName="updateFacet"
|
|
2394
|
-
typeLinks={{
|
|
2395
|
-
Facet: '/reference/graphql-api/admin/object-types#facet',
|
|
2396
|
-
UpdateFacetInput: '/reference/graphql-api/admin/input-types#updatefacetinput',
|
|
2397
|
-
}}
|
|
2398
|
-
>
|
|
2399
|
-
{`"""Update an existing Facet"""
|
|
2400
|
-
type Mutation {
|
|
2401
|
-
updateFacet(input: UpdateFacetInput!): Facet!
|
|
2402
|
-
}`}
|
|
2403
|
-
</GraphQLDoc>
|
|
2404
|
-
|
|
2405
|
-
## updateFacetValue {#updatefacetvalue}
|
|
2406
|
-
|
|
2407
|
-
<GraphQLDoc
|
|
2408
|
-
type="mutation"
|
|
2409
|
-
typeName="updateFacetValue"
|
|
2410
|
-
typeLinks={{
|
|
2411
|
-
FacetValue: '/reference/graphql-api/admin/object-types#facetvalue',
|
|
2412
|
-
UpdateFacetValueInput: '/reference/graphql-api/admin/input-types#updatefacetvalueinput',
|
|
2413
|
-
}}
|
|
2414
|
-
>
|
|
2415
|
-
{`"""Update a single FacetValue"""
|
|
2416
|
-
type Mutation {
|
|
2417
|
-
updateFacetValue(input: UpdateFacetValueInput!): FacetValue!
|
|
2418
|
-
}`}
|
|
2419
|
-
</GraphQLDoc>
|
|
2420
|
-
|
|
2421
|
-
## updateFacetValues {#updatefacetvalues}
|
|
2422
|
-
|
|
2423
|
-
<GraphQLDoc
|
|
2424
|
-
type="mutation"
|
|
2425
|
-
typeName="updateFacetValues"
|
|
2426
|
-
typeLinks={{
|
|
2427
|
-
FacetValue: '/reference/graphql-api/admin/object-types#facetvalue',
|
|
2428
|
-
UpdateFacetValueInput: '/reference/graphql-api/admin/input-types#updatefacetvalueinput',
|
|
2429
|
-
}}
|
|
2430
|
-
>
|
|
2431
|
-
{`"""Update one or more FacetValues"""
|
|
2432
|
-
type Mutation {
|
|
2433
|
-
updateFacetValues(input: [UpdateFacetValueInput!]!): [FacetValue!]!
|
|
2434
|
-
}`}
|
|
2435
|
-
</GraphQLDoc>
|
|
2436
|
-
|
|
2437
|
-
## updateGlobalSettings {#updateglobalsettings}
|
|
2438
|
-
|
|
2439
|
-
<GraphQLDoc
|
|
2440
|
-
type="mutation"
|
|
2441
|
-
typeName="updateGlobalSettings"
|
|
2442
|
-
typeLinks={{
|
|
2443
|
-
UpdateGlobalSettingsResult: '/reference/graphql-api/admin/object-types#updateglobalsettingsresult',
|
|
2444
|
-
UpdateGlobalSettingsInput: '/reference/graphql-api/admin/input-types#updateglobalsettingsinput',
|
|
2445
|
-
}}
|
|
2446
|
-
>
|
|
2447
|
-
{`type Mutation {
|
|
2448
|
-
updateGlobalSettings(input: UpdateGlobalSettingsInput!): UpdateGlobalSettingsResult!
|
|
2449
|
-
}`}
|
|
2450
|
-
</GraphQLDoc>
|
|
2451
|
-
|
|
2452
|
-
## updateOrderNote {#updateordernote}
|
|
2453
|
-
|
|
2454
|
-
<GraphQLDoc
|
|
2455
|
-
type="mutation"
|
|
2456
|
-
typeName="updateOrderNote"
|
|
2457
|
-
typeLinks={{
|
|
2458
|
-
HistoryEntry: '/reference/graphql-api/admin/object-types#historyentry',
|
|
2459
|
-
UpdateOrderNoteInput: '/reference/graphql-api/admin/input-types#updateordernoteinput',
|
|
2460
|
-
}}
|
|
2461
|
-
>
|
|
2462
|
-
{`type Mutation {
|
|
2463
|
-
updateOrderNote(input: UpdateOrderNoteInput!): HistoryEntry!
|
|
2464
|
-
}`}
|
|
2465
|
-
</GraphQLDoc>
|
|
2466
|
-
|
|
2467
|
-
## updatePaymentMethod {#updatepaymentmethod}
|
|
2468
|
-
|
|
2469
|
-
<GraphQLDoc
|
|
2470
|
-
type="mutation"
|
|
2471
|
-
typeName="updatePaymentMethod"
|
|
2472
|
-
typeLinks={{
|
|
2473
|
-
PaymentMethod: '/reference/graphql-api/admin/object-types#paymentmethod',
|
|
2474
|
-
UpdatePaymentMethodInput: '/reference/graphql-api/admin/input-types#updatepaymentmethodinput',
|
|
2475
|
-
}}
|
|
2476
|
-
>
|
|
2477
|
-
{`"""Update an existing PaymentMethod"""
|
|
2478
|
-
type Mutation {
|
|
2479
|
-
updatePaymentMethod(input: UpdatePaymentMethodInput!): PaymentMethod!
|
|
2480
|
-
}`}
|
|
2481
|
-
</GraphQLDoc>
|
|
2482
|
-
|
|
2483
|
-
## updateProduct {#updateproduct}
|
|
2484
|
-
|
|
2485
|
-
<GraphQLDoc
|
|
2486
|
-
type="mutation"
|
|
2487
|
-
typeName="updateProduct"
|
|
2488
|
-
typeLinks={{
|
|
2489
|
-
Product: '/reference/graphql-api/admin/object-types#product',
|
|
2490
|
-
UpdateProductInput: '/reference/graphql-api/admin/input-types#updateproductinput',
|
|
2491
|
-
}}
|
|
2492
|
-
>
|
|
2493
|
-
{`"""Update an existing Product"""
|
|
2494
|
-
type Mutation {
|
|
2495
|
-
updateProduct(input: UpdateProductInput!): Product!
|
|
2496
|
-
}`}
|
|
2497
|
-
</GraphQLDoc>
|
|
2498
|
-
|
|
2499
|
-
## updateProductOption {#updateproductoption}
|
|
2500
|
-
|
|
2501
|
-
<GraphQLDoc
|
|
2502
|
-
type="mutation"
|
|
2503
|
-
typeName="updateProductOption"
|
|
2504
|
-
typeLinks={{
|
|
2505
|
-
ProductOption: '/reference/graphql-api/admin/object-types#productoption',
|
|
2506
|
-
UpdateProductOptionInput: '/reference/graphql-api/admin/input-types#updateproductoptioninput',
|
|
2507
|
-
}}
|
|
2508
|
-
>
|
|
2509
|
-
{`"""Create a new ProductOption within a ProductOptionGroup"""
|
|
2510
|
-
type Mutation {
|
|
2511
|
-
updateProductOption(input: UpdateProductOptionInput!): ProductOption!
|
|
2512
|
-
}`}
|
|
2513
|
-
</GraphQLDoc>
|
|
2514
|
-
|
|
2515
|
-
## updateProductOptionGroup {#updateproductoptiongroup}
|
|
2516
|
-
|
|
2517
|
-
<GraphQLDoc
|
|
2518
|
-
type="mutation"
|
|
2519
|
-
typeName="updateProductOptionGroup"
|
|
2520
|
-
typeLinks={{
|
|
2521
|
-
ProductOptionGroup: '/reference/graphql-api/admin/object-types#productoptiongroup',
|
|
2522
|
-
UpdateProductOptionGroupInput: '/reference/graphql-api/admin/input-types#updateproductoptiongroupinput',
|
|
2523
|
-
}}
|
|
2524
|
-
>
|
|
2525
|
-
{`"""Update an existing ProductOptionGroup"""
|
|
2526
|
-
type Mutation {
|
|
2527
|
-
updateProductOptionGroup(input: UpdateProductOptionGroupInput!): ProductOptionGroup!
|
|
2528
|
-
}`}
|
|
2529
|
-
</GraphQLDoc>
|
|
2530
|
-
|
|
2531
|
-
## updateProductVariant {#updateproductvariant}
|
|
2532
|
-
|
|
2533
|
-
<GraphQLDoc
|
|
2534
|
-
type="mutation"
|
|
2535
|
-
typeName="updateProductVariant"
|
|
2536
|
-
typeLinks={{
|
|
2537
|
-
ProductVariant: '/reference/graphql-api/admin/object-types#productvariant',
|
|
2538
|
-
UpdateProductVariantInput: '/reference/graphql-api/admin/input-types#updateproductvariantinput',
|
|
2539
|
-
}}
|
|
2540
|
-
>
|
|
2541
|
-
{`"""Update an existing ProductVariant"""
|
|
2542
|
-
type Mutation {
|
|
2543
|
-
updateProductVariant(input: UpdateProductVariantInput!): ProductVariant!
|
|
2544
|
-
}`}
|
|
2545
|
-
</GraphQLDoc>
|
|
2546
|
-
|
|
2547
|
-
## updateProductVariants {#updateproductvariants}
|
|
2548
|
-
|
|
2549
|
-
<GraphQLDoc
|
|
2550
|
-
type="mutation"
|
|
2551
|
-
typeName="updateProductVariants"
|
|
2552
|
-
typeLinks={{
|
|
2553
|
-
ProductVariant: '/reference/graphql-api/admin/object-types#productvariant',
|
|
2554
|
-
UpdateProductVariantInput: '/reference/graphql-api/admin/input-types#updateproductvariantinput',
|
|
2555
|
-
}}
|
|
2556
|
-
>
|
|
2557
|
-
{`"""Update existing ProductVariants"""
|
|
2558
|
-
type Mutation {
|
|
2559
|
-
updateProductVariants(input: [UpdateProductVariantInput!]!): [ProductVariant]!
|
|
2560
|
-
}`}
|
|
2561
|
-
</GraphQLDoc>
|
|
2562
|
-
|
|
2563
|
-
## updateProducts {#updateproducts}
|
|
2564
|
-
|
|
2565
|
-
<GraphQLDoc
|
|
2566
|
-
type="mutation"
|
|
2567
|
-
typeName="updateProducts"
|
|
2568
|
-
typeLinks={{
|
|
2569
|
-
Product: '/reference/graphql-api/admin/object-types#product',
|
|
2570
|
-
UpdateProductInput: '/reference/graphql-api/admin/input-types#updateproductinput',
|
|
2571
|
-
}}
|
|
2572
|
-
>
|
|
2573
|
-
{`"""Update multiple existing Products"""
|
|
2574
|
-
type Mutation {
|
|
2575
|
-
updateProducts(input: [UpdateProductInput!]!): [Product!]!
|
|
2576
|
-
}`}
|
|
2577
|
-
</GraphQLDoc>
|
|
2578
|
-
|
|
2579
|
-
## updatePromotion {#updatepromotion}
|
|
2580
|
-
|
|
2581
|
-
<GraphQLDoc
|
|
2582
|
-
type="mutation"
|
|
2583
|
-
typeName="updatePromotion"
|
|
2584
|
-
typeLinks={{
|
|
2585
|
-
UpdatePromotionResult: '/reference/graphql-api/admin/object-types#updatepromotionresult',
|
|
2586
|
-
UpdatePromotionInput: '/reference/graphql-api/admin/input-types#updatepromotioninput',
|
|
2587
|
-
}}
|
|
2588
|
-
>
|
|
2589
|
-
{`type Mutation {
|
|
2590
|
-
updatePromotion(input: UpdatePromotionInput!): UpdatePromotionResult!
|
|
2591
|
-
}`}
|
|
2592
|
-
</GraphQLDoc>
|
|
2593
|
-
|
|
2594
|
-
## updateProvince {#updateprovince}
|
|
2595
|
-
|
|
2596
|
-
<GraphQLDoc
|
|
2597
|
-
type="mutation"
|
|
2598
|
-
typeName="updateProvince"
|
|
2599
|
-
typeLinks={{
|
|
2600
|
-
Province: '/reference/graphql-api/admin/object-types#province',
|
|
2601
|
-
UpdateProvinceInput: '/reference/graphql-api/admin/input-types#updateprovinceinput',
|
|
2602
|
-
}}
|
|
2603
|
-
>
|
|
2604
|
-
{`"""Update an existing Province"""
|
|
2605
|
-
type Mutation {
|
|
2606
|
-
updateProvince(input: UpdateProvinceInput!): Province!
|
|
2607
|
-
}`}
|
|
2608
|
-
</GraphQLDoc>
|
|
2609
|
-
|
|
2610
|
-
## updateRole {#updaterole}
|
|
2611
|
-
|
|
2612
|
-
<GraphQLDoc
|
|
2613
|
-
type="mutation"
|
|
2614
|
-
typeName="updateRole"
|
|
2615
|
-
typeLinks={{
|
|
2616
|
-
Role: '/reference/graphql-api/admin/object-types#role',
|
|
2617
|
-
UpdateRoleInput: '/reference/graphql-api/admin/input-types#updateroleinput',
|
|
2618
|
-
}}
|
|
2619
|
-
>
|
|
2620
|
-
{`"""Update an existing Role"""
|
|
2621
|
-
type Mutation {
|
|
2622
|
-
updateRole(input: UpdateRoleInput!): Role!
|
|
2623
|
-
}`}
|
|
2624
|
-
</GraphQLDoc>
|
|
2625
|
-
|
|
2626
|
-
## updateScheduledTask {#updatescheduledtask}
|
|
2627
|
-
|
|
2628
|
-
<GraphQLDoc
|
|
2629
|
-
type="mutation"
|
|
2630
|
-
typeName="updateScheduledTask"
|
|
2631
|
-
typeLinks={{
|
|
2632
|
-
ScheduledTask: '/reference/graphql-api/admin/object-types#scheduledtask',
|
|
2633
|
-
UpdateScheduledTaskInput: '/reference/graphql-api/admin/input-types#updatescheduledtaskinput',
|
|
2634
|
-
}}
|
|
2635
|
-
>
|
|
2636
|
-
{`type Mutation {
|
|
2637
|
-
updateScheduledTask(input: UpdateScheduledTaskInput!): ScheduledTask!
|
|
2638
|
-
}`}
|
|
2639
|
-
</GraphQLDoc>
|
|
2640
|
-
|
|
2641
|
-
## updateSeller {#updateseller}
|
|
2642
|
-
|
|
2643
|
-
<GraphQLDoc
|
|
2644
|
-
type="mutation"
|
|
2645
|
-
typeName="updateSeller"
|
|
2646
|
-
typeLinks={{
|
|
2647
|
-
Seller: '/reference/graphql-api/admin/object-types#seller',
|
|
2648
|
-
UpdateSellerInput: '/reference/graphql-api/admin/input-types#updatesellerinput',
|
|
2649
|
-
}}
|
|
2650
|
-
>
|
|
2651
|
-
{`"""Update an existing Seller"""
|
|
2652
|
-
type Mutation {
|
|
2653
|
-
updateSeller(input: UpdateSellerInput!): Seller!
|
|
2654
|
-
}`}
|
|
2655
|
-
</GraphQLDoc>
|
|
2656
|
-
|
|
2657
|
-
## updateShippingMethod {#updateshippingmethod}
|
|
2658
|
-
|
|
2659
|
-
<GraphQLDoc
|
|
2660
|
-
type="mutation"
|
|
2661
|
-
typeName="updateShippingMethod"
|
|
2662
|
-
typeLinks={{
|
|
2663
|
-
ShippingMethod: '/reference/graphql-api/admin/object-types#shippingmethod',
|
|
2664
|
-
UpdateShippingMethodInput: '/reference/graphql-api/admin/input-types#updateshippingmethodinput',
|
|
2665
|
-
}}
|
|
2666
|
-
>
|
|
2667
|
-
{`"""Update an existing ShippingMethod"""
|
|
2668
|
-
type Mutation {
|
|
2669
|
-
updateShippingMethod(input: UpdateShippingMethodInput!): ShippingMethod!
|
|
2670
|
-
}`}
|
|
2671
|
-
</GraphQLDoc>
|
|
2672
|
-
|
|
2673
|
-
## updateStockLocation {#updatestocklocation}
|
|
2674
|
-
|
|
2675
|
-
<GraphQLDoc
|
|
2676
|
-
type="mutation"
|
|
2677
|
-
typeName="updateStockLocation"
|
|
2678
|
-
typeLinks={{
|
|
2679
|
-
StockLocation: '/reference/graphql-api/admin/object-types#stocklocation',
|
|
2680
|
-
UpdateStockLocationInput: '/reference/graphql-api/admin/input-types#updatestocklocationinput',
|
|
2681
|
-
}}
|
|
2682
|
-
>
|
|
2683
|
-
{`type Mutation {
|
|
2684
|
-
updateStockLocation(input: UpdateStockLocationInput!): StockLocation!
|
|
2685
|
-
}`}
|
|
2686
|
-
</GraphQLDoc>
|
|
2687
|
-
|
|
2688
|
-
## updateTag {#updatetag}
|
|
2689
|
-
|
|
2690
|
-
<GraphQLDoc
|
|
2691
|
-
type="mutation"
|
|
2692
|
-
typeName="updateTag"
|
|
2693
|
-
typeLinks={{
|
|
2694
|
-
Tag: '/reference/graphql-api/admin/object-types#tag',
|
|
2695
|
-
UpdateTagInput: '/reference/graphql-api/admin/input-types#updatetaginput',
|
|
2696
|
-
}}
|
|
2697
|
-
>
|
|
2698
|
-
{`"""Update an existing Tag"""
|
|
2699
|
-
type Mutation {
|
|
2700
|
-
updateTag(input: UpdateTagInput!): Tag!
|
|
2701
|
-
}`}
|
|
2702
|
-
</GraphQLDoc>
|
|
2703
|
-
|
|
2704
|
-
## updateTaxCategory {#updatetaxcategory}
|
|
2705
|
-
|
|
2706
|
-
<GraphQLDoc
|
|
2707
|
-
type="mutation"
|
|
2708
|
-
typeName="updateTaxCategory"
|
|
2709
|
-
typeLinks={{
|
|
2710
|
-
TaxCategory: '/reference/graphql-api/admin/object-types#taxcategory',
|
|
2711
|
-
UpdateTaxCategoryInput: '/reference/graphql-api/admin/input-types#updatetaxcategoryinput',
|
|
2712
|
-
}}
|
|
2713
|
-
>
|
|
2714
|
-
{`"""Update an existing TaxCategory"""
|
|
2715
|
-
type Mutation {
|
|
2716
|
-
updateTaxCategory(input: UpdateTaxCategoryInput!): TaxCategory!
|
|
2717
|
-
}`}
|
|
2718
|
-
</GraphQLDoc>
|
|
2719
|
-
|
|
2720
|
-
## updateTaxRate {#updatetaxrate}
|
|
2721
|
-
|
|
2722
|
-
<GraphQLDoc
|
|
2723
|
-
type="mutation"
|
|
2724
|
-
typeName="updateTaxRate"
|
|
2725
|
-
typeLinks={{
|
|
2726
|
-
TaxRate: '/reference/graphql-api/admin/object-types#taxrate',
|
|
2727
|
-
UpdateTaxRateInput: '/reference/graphql-api/admin/input-types#updatetaxrateinput',
|
|
2728
|
-
}}
|
|
2729
|
-
>
|
|
2730
|
-
{`"""Update an existing TaxRate"""
|
|
2731
|
-
type Mutation {
|
|
2732
|
-
updateTaxRate(input: UpdateTaxRateInput!): TaxRate!
|
|
2733
|
-
}`}
|
|
2734
|
-
</GraphQLDoc>
|
|
2735
|
-
|
|
2736
|
-
## updateZone {#updatezone}
|
|
2737
|
-
|
|
2738
|
-
<GraphQLDoc
|
|
2739
|
-
type="mutation"
|
|
2740
|
-
typeName="updateZone"
|
|
2741
|
-
typeLinks={{
|
|
2742
|
-
Zone: '/reference/graphql-api/admin/object-types#zone',
|
|
2743
|
-
UpdateZoneInput: '/reference/graphql-api/admin/input-types#updatezoneinput',
|
|
2744
|
-
}}
|
|
2745
|
-
>
|
|
2746
|
-
{`"""Update an existing Zone"""
|
|
2747
|
-
type Mutation {
|
|
2748
|
-
updateZone(input: UpdateZoneInput!): Zone!
|
|
2749
|
-
}`}
|
|
2750
|
-
</GraphQLDoc>
|