OBJECT
Mutation

Queries for modifying data in the database.
GraphQL Schema definition

type Mutation {
# start a background job to download activity log data. Only accessible to 
# operator admin users.
# 
# Arguments
# input: Parameters for ActivityLogDownloadMutation
activityLogDownload(
input: ActivityLogDownloadMutationInput!
): ActivityLogDownloadMutationPayload 
# Initiate a username/password login for an administrator.
# 
# May return a session token (in which case no further action is
# required to complete the login, and the session token can be
# used as an API key until it expires).
# 
# May also return one or more multi-factor authentication (MFA)
# challenges. If it does, at least one MFA challenge needs to be
# successfully responded to in order to get the session token.
# 
# NOTE: MFA Challenge is not yet implemented in this login, so if it is
# required, an error will be returned.
# 
# Arguments
# input: Parameters for AdminLoginUsernameMutation
adminLoginUsername(input: AdminLoginUsernameMutationInput!): AdminLoginUsernameMutationPayload 
# Create an Admin Role. Only accessible to operator admin users.
# 
# Arguments
# input: Parameters for AdminRoleCreateMutation
adminRoleCreate(input: AdminRoleCreateMutationInput!): AdminRoleCreateMutationPayload 
# Delete an Admin Role. Only accessible to operator admin users.
# 
# Arguments
# input: Parameters for AdminRoleDeleteMutation
adminRoleDelete(input: AdminRoleDeleteMutationInput!): AdminRoleDeleteMutationPayload 
# Update an Admin Role. Only accessible to operator admin users.
# 
# Arguments
# input: Parameters for AdminRoleUpdateMutation
adminRoleUpdate(input: AdminRoleUpdateMutationInput!): AdminRoleUpdateMutationPayload 
# Mark an existing advert as deleted. Only accessible to operator and seller admin 
# users.
# 
# Arguments
# input: Parameters for AdvertDeleteMutation
advertDelete(input: AdvertDeleteMutationInput!): AdvertDeleteMutationPayload 
# Updates the advert's published status. Only accessible to operator and seller 
# admin users.
# 
# Arguments
# input: Parameters for AdvertPublishedUpdateMutation
advertPublishedUpdate(
input: AdvertPublishedUpdateMutationInput!
): AdvertPublishedUpdateMutationPayload 
# start a background job to import adverts. Only accessible to operator and seller 
# admin users.
# 
# Arguments
# input: Parameters for AdvertSpreadsheetConfirmImportMutation
advertSpreadsheetConfirmImport(
input: AdvertSpreadsheetConfirmImportMutationInput!
): AdvertSpreadsheetConfirmImportMutationPayload 
# start a background job to download adverts. Only accessible to operator and 
# seller admin users.
# 
# Arguments
# input: Parameters for AdvertSpreadsheetDownloadMutation
advertSpreadsheetDownload(
input: AdvertSpreadsheetDownloadMutationInput!
): AdvertSpreadsheetDownloadMutationPayload 
# start a background job to upload adverts. Only accessible to operator and seller 
# admin users.
# 
# Arguments
# input: Parameters for AdvertSpreadsheetUploadMutation
advertSpreadsheetUpload(
input: AdvertSpreadsheetUploadMutationInput!
): AdvertSpreadsheetUploadMutationPayload 
# Create an Advert if no ID is passed, otherwise updates existing Advert. Only 
# accessible to operator and seller admin users.
# 
# Arguments
# input: Parameters for AdvertUpsertMutation
advertUpsert(input: AdvertUpsertMutationInput!): AdvertUpsertMutationPayload 
# Bulk approves products via vetting. Only accessible to operator admin users.
# 
# Arguments
# input: [Not documented]
advertVettingApprove(input: AdvertVettingApproveInput!): AdvertVettingApproveMutationPayload 
# Bulk rejects products via vetting. Only accessible to operator admin users.
# 
# Arguments
# input: [Not documented]
advertVettingReject(input: AdvertVettingRejectInput!): AdvertVettingRejectMutationPayload 
# Bulk resubmit adverts for vetting. Only accessible to operator and seller admin 
# users.
# 
# Arguments
# input: [Not documented]
advertVettingResubmit(input: AdvertVettingResubmitInput!): AdvertVettingResubmitMutationPayload 
# Create or update Adyen settings. Only accessible to operator admin users.
# 
# Arguments
# input: Parameters for AdyenSettingsCreateOrUpdateMutation
adyenSettingsCreateOrUpdate(
input: AdyenSettingsCreateOrUpdateMutationInput!
): AdyenSettingsCreateOrUpdateMutationPayload 
# Delete Adyen settings. Only accessible to operator admin users.
# 
# Arguments
# input: Parameters for AdyenSettingsDeleteMutation
adyenSettingsDelete(
input: AdyenSettingsDeleteMutationInput!
): AdyenSettingsDeleteMutationPayload 
# Create or update Afterpay settings. Only accessible to operator admin users.
# 
# Arguments
# input: Parameters for AfterpaySettingsCreateOrUpdateMutation
afterpaySettingsCreateOrUpdate(
input: AfterpaySettingsCreateOrUpdateMutationInput!
): AfterpaySettingsCreateOrUpdateMutationPayload 
# Delete Afterpay settings. Only accessible to operator admin users.
# 
# Arguments
# input: Parameters for AfterpaySettingsDeleteMutation
afterpaySettingsDelete(
input: AfterpaySettingsDeleteMutationInput!
): AfterpaySettingsDeleteMutationPayload 
# Attempt a payment in Billing Invoice. Only accessible to operator and seller 
# admin users.
# 
# Arguments
# input: Parameters for AttemptBillingInvoicePaymentMutation
attemptBillingInvoicePayment(
input: AttemptBillingInvoicePaymentMutationInput!
): AttemptBillingInvoicePaymentMutationPayload 
# start a background job to download billing history. Only accessible to operator 
# and seller admin users.
# 
# Arguments
# input: Parameters for BillingHistoryDownloadMutation
billingHistoryDownload(
input: BillingHistoryDownloadMutationInput!
): BillingHistoryDownloadMutationPayload 
# Create or update Braintree settings. Only accessible to operator admin users.
# 
# Arguments
# input: Parameters for BraintreeSettingsCreateOrUpdateMutation
braintreeSettingsCreateOrUpdate(
input: BraintreeSettingsCreateOrUpdateMutationInput!
): BraintreeSettingsCreateOrUpdateMutationPayload 
# Delete Braintree settings. Only accessible to operator admin users.
# 
# Arguments
# input: Parameters for BraintreeSettingsDeleteMutation
braintreeSettingsDelete(
input: BraintreeSettingsDeleteMutationInput!
): BraintreeSettingsDeleteMutationPayload 
# Cancel a billing record. Only accessible to operator and seller admin users.
# 
# Arguments
# input: Parameters for CancelBillingInvoiceMutation
cancelBillingInvoice(
input: CancelBillingInvoiceMutationInput!
): CancelBillingInvoiceMutationPayload 
# Add an item to a order. Currently only supports product variants.
# 
# Arguments
# input: Parameters for CartAddCartItemMutation
cartAddCartItem(input: CartAddCartItemMutationInput!): CartAddCartItemMutationPayload 
# Add an item to current session cart. Only supports product variants.
# 
# Arguments
# input: Parameters for CartAddItemMutation
cartAddItem(input: CartAddItemMutationInput!): CartAddItemMutationPayload 
# Checkout a cart using the cart ID. This checkout can be used with Braintree 
# payment provider and can only be used if Braintree is set up on the marketplace. 
# Will receive order once cart has been processed successfully.
# 
# Arguments
# input: Parameters for CartCheckoutMutation
cartCheckout(input: CartCheckoutMutationInput!): CartCheckoutMutationPayload 
# Create a mutable cart to keep track of items that a user maybe wants to 
# purchase.
# 
# Arguments
# input: Parameters for CartCreateMutation
cartCreate(input: CartCreateMutationInput!): CartCreateMutationPayload 
# Delete a cart.
# 
# Arguments
# input: Parameters for CartDeleteMutation
cartDelete(input: CartDeleteMutationInput!): CartDeleteMutationPayload 
# Remove a line item from a cart.
# 
# Arguments
# input: Parameters for CartRemoveCartItemMutation
cartRemoveCartItem(input: CartRemoveCartItemMutationInput!): CartRemoveCartItemMutationPayload 
# Update a mutable cart to keep track of items that a user maybe wants to 
# purchase.
# 
# Arguments
# input: Parameters for CartUpdateMutation
cartUpdate(input: CartUpdateMutationInput!): CartUpdateMutationPayload 
# Update cart item details for a cart.
# 
# Arguments
# input: Parameters for CartUpdateCartItemMutation
cartUpdateCartItem(input: CartUpdateCartItemMutationInput!): CartUpdateCartItemMutationPayload 
# Create a Catalog Rule. Only accessible to operator admin users.
# 
# Arguments
# input: Parameters for CatalogRuleCreateMutation
catalogRuleCreate(input: CatalogRuleCreateMutationInput!): CatalogRuleCreateMutationPayload 
# Delete a Catalog rule. Only accessible to operator admin users.
# 
# Arguments
# input: Parameters for CatalogRuleDeleteMutation
catalogRuleDelete(input: CatalogRuleDeleteMutationInput!): CatalogRuleDeleteMutationPayload 
# Update a Catalog Rule. Only accessible to operator admin users.
# 
# Arguments
# input: Parameters for CatalogRuleUpdateMutation
catalogRuleUpdate(input: CatalogRuleUpdateMutationInput!): CatalogRuleUpdateMutationPayload 
# Updates status of invoice that have click_and_collect delivery type. Only 
# accessible to operator and seller admin users.
# 
# Arguments
# input: Parameters for ClickAndCollectStatusUpdateMutation
clickAndCollectStatusUpdate(
input: ClickAndCollectStatusUpdateMutationInput!
): ClickAndCollectStatusUpdateMutationPayload 
# Creates a CustomField if no ID is passed, otherwise updates existing CustomField 
# (note: CustomFieldGroup must be created prior to creating CustomField). Only 
# accessible to operator admin users.
# 
# Arguments
# input: Parameters for CustomFieldCreateOrUpdateMutation
customFieldCreateOrUpdate(
input: CustomFieldCreateOrUpdateMutationInput!
): CustomFieldCreateOrUpdateMutationPayload 
# Deletes an existing CustomField. Only accessible to operator admin users.
# 
# Arguments
# input: Parameters for CustomFieldDeleteMutation
customFieldDelete(input: CustomFieldDeleteMutationInput!): CustomFieldDeleteMutationPayload 
# Creates a CustomFieldGroup if no ID is passed, otherwise updates existing 
# CustomFieldGroup. Only accessible to operator admin users.
# 
# Arguments
# input: Parameters for CustomFieldGroupCreateOrUpdateMutation
customFieldGroupCreateOrUpdate(
input: CustomFieldGroupCreateOrUpdateMutationInput!
): CustomFieldGroupCreateOrUpdateMutationPayload 
# Deletes an existing CustomFieldGroup and associated CustomFields. Only 
# accessible to operator admin users.
# 
# Arguments
# input: Parameters for CustomFieldGroupDeleteMutation
customFieldGroupDelete(
input: CustomFieldGroupDeleteMutationInput!
): CustomFieldGroupDeleteMutationPayload 
# Enrol an authenticator for a user or admin. Users and Admins can only do this 
# for themselves. Only accessible to seller and operator admin users.
# 
# Arguments
# input: Parameters for EnrolAuthenticatorMutation
enrolAuthenticator(
input: EnrolAuthenticatorMutationInput!
): EnrolAuthenticatorMutationPayload @deprecated( reason: "Feature in development, subject to change without notice"  )
# Create an association between an existing Object (eg. Advert) and external IDs. 
# Only accessible to operator admin users.
# 
# Arguments
# input: Parameters for ExternalIDUpsertMutation
externalIdUpsert(input: ExternalIDUpsertMutationInput!): ExternalIDUpsertMutationPayload 
# Create an association between an existing Object (eg. Advert) and external IDs
# ExternalID's owner/key will be unique.
# For example, owner: 'Advert', key: 'my_store', value: '23'.
# If an ExternalID exists with an owner of 'Advert' and a key of 'my_store', this
# record will be found and updated with the new value, or created if it does not 
# exist.
# . Only accessible to operator admin users.
# 
# Arguments
# input: Parameters for ExternalIdsUpsertMutation
externalIdsUpsert(input: ExternalIdsUpsertMutationInput!): ExternalIdsUpsertMutationPayload 
# Create or update Givex settings. Only accessible to operator admin users.
# 
# Arguments
# input: Parameters for GivexSettingsCreateOrUpdateMutation
givexSettingsCreateOrUpdate(
input: GivexSettingsCreateOrUpdateMutationInput!
): GivexSettingsCreateOrUpdateMutationPayload 
# Delete Givex settings. Only accessible to operator admin users.
# 
# Arguments
# input: Parameters for GivexSettingsDeleteMutation
givexSettingsDelete(
input: GivexSettingsDeleteMutationInput!
): GivexSettingsDeleteMutationPayload 
# Create a Golden Product. Only accessible to operator admin users.
# 
# Arguments
# input: Parameters for GoldenProductCreateMutation
goldenProductCreate(
input: GoldenProductCreateMutationInput!
): GoldenProductCreateMutationPayload 
# Delete a Golden product. Only accessible to operator admin users.
# 
# Arguments
# input: Parameters for GoldenProductDeleteMutation
goldenProductDelete(
input: GoldenProductDeleteMutationInput!
): GoldenProductDeleteMutationPayload 
# Update a Golden Product. Only accessible to operator admin users.
# 
# Arguments
# input: Parameters for GoldenProductUpdateMutation
goldenProductUpdate(
input: GoldenProductUpdateMutationInput!
): GoldenProductUpdateMutationPayload 
# Create a golden product variant. Only accessible to operator admin users.
# 
# Arguments
# input: Parameters for GoldenProductVariantCreateMutation
goldenProductVariantCreate(
input: GoldenProductVariantCreateMutationInput!
): GoldenProductVariantCreateMutationPayload 
# Delete a Golden product variant record. Only accessible to operator admin users.
# 
# Arguments
# input: Parameters for GoldenProductVariantDeleteMutation
goldenProductVariantDelete(
input: GoldenProductVariantDeleteMutationInput!
): GoldenProductVariantDeleteMutationPayload 
# Link the provided variants to the golden product variants by appending to 
# existing association. Also links the advert to the golden product if a link is 
# not already established. Only accessible to operator admin users.
# 
# Arguments
# input: Parameters for GoldenProductVariantLinkVariantsMutation
goldenProductVariantLinkVariants(
input: GoldenProductVariantLinkVariantsMutationInput!
): GoldenProductVariantLinkVariantsMutationPayload 
# Unlink the provided variants from the golden product variant. Only accessible to 
# operator admin users.
# 
# Arguments
# input: Parameters for 
# GoldenProductVariantUnlinkVariantsMutation
goldenProductVariantUnlinkVariants(
input: GoldenProductVariantUnlinkVariantsMutationInput!
): GoldenProductVariantUnlinkVariantsMutationPayload 
# Update a golden product variant. Only accessible to operator admin users.
# 
# Arguments
# input: Parameters for GoldenProductVariantUpdateMutation
goldenProductVariantUpdate(
input: GoldenProductVariantUpdateMutationInput!
): GoldenProductVariantUpdateMutationPayload 
# Activates Golden product variants. Only accessible to operator admin users.
# 
# Arguments
# input: Parameters for GoldenProductVariantsActivateMutation
goldenProductVariantsActivate(
input: GoldenProductVariantsActivateMutationInput!
): GoldenProductVariantsActivateMutationPayload 
# Deactivate Golden Product Variants. Only accessible to operator admin users.
# 
# Arguments
# input: Parameters for GoldenProductVariantsDeactivateMutation
goldenProductVariantsDeactivate(
input: GoldenProductVariantsDeactivateMutationInput!
): GoldenProductVariantsDeactivateMutationPayload 
# Upload an image to be attached elsewhere. Only accessible to operator and seller 
# admin users.
# 
# Arguments
# input: Parameters for ImageUploadMutation
imageUpload(input: ImageUploadMutationInput!): ImageUploadMutationPayload 
# Create an inquiry to the seller. Only accessible to operator admin users.
# 
# Arguments
# input: Parameters for InquiryCreateMutation
inquiryCreate(input: InquiryCreateMutationInput!): InquiryCreateMutationPayload 
# Create an invoice amendment. Only accessible to operator admin users.
# 
# Arguments
# input: Parameters for InvoiceAmendmentCreateMutation
invoiceAmendmentCreate(
input: InvoiceAmendmentCreateMutationInput!
): InvoiceAmendmentCreateMutationPayload 
# Annotate an invoice.
# 
# Arguments
# input: Parameters for InvoiceAnnotationCreateMutation
invoiceAnnotationCreate(
input: InvoiceAnnotationCreateMutationInput!
): InvoiceAnnotationCreateMutationPayload 
# Resolve an invoice annotation.
# 
# Arguments
# input: Parameters for InvoiceAnnotationResolveMutation
invoiceAnnotationResolve(
input: InvoiceAnnotationResolveMutationInput!
): InvoiceAnnotationResolveMutationPayload 
# Create an invoice annotation type. Only accessible to operator admin users.
# 
# Arguments
# input: Parameters for InvoiceAnnotationTypeCreateMutation
invoiceAnnotationTypeCreate(
input: InvoiceAnnotationTypeCreateMutationInput!
): InvoiceAnnotationTypeCreateMutationPayload 
# Discard an invoice annotation type. Only accessible to operator admin users.
# 
# Arguments
# input: Parameters for InvoiceAnnotationTypeDiscardMutation
invoiceAnnotationTypeDiscard(
input: InvoiceAnnotationTypeDiscardMutationInput!
): InvoiceAnnotationTypeDiscardMutationPayload 
# Update an invoice annotation type. Only accessible to operator admin users.
# 
# Arguments
# input: Parameters for InvoiceAnnotationTypeUpdateMutation
invoiceAnnotationTypeUpdate(
input: InvoiceAnnotationTypeUpdateMutationInput!
): InvoiceAnnotationTypeUpdateMutationPayload 
# Update an invoice annotation.
# 
# Arguments
# input: Parameters for InvoiceAnnotationUpdateMutation
invoiceAnnotationUpdate(
input: InvoiceAnnotationUpdateMutationInput!
): InvoiceAnnotationUpdateMutationPayload 
# Create or update Klaviyo settings. Only accessible to operator admin users.
# 
# Arguments
# input: Parameters for KlaviyoSettingsCreateOrUpdateMutation
klaviyoSettingsCreateOrUpdate(
input: KlaviyoSettingsCreateOrUpdateMutationInput!
): KlaviyoSettingsCreateOrUpdateMutationPayload 
# Delete Klaviyo settings. Only accessible to operator admin users.
# 
# Arguments
# input: Parameters for KlaviyoSettingsDeleteMutation
klaviyoSettingsDelete(
input: KlaviyoSettingsDeleteMutationInput!
): KlaviyoSettingsDeleteMutationPayload 
# start a background job to download line items that have not yet been shipped. 
# Only accessible to operator and seller admin users.
# 
# Arguments
# input: Parameters for 
# LineItemsForShipmentsSpreadsheetDownloadMutation
lineItemsForShipmentsSpreadsheetDownload(
input: LineItemsForShipmentsSpreadsheetDownloadMutationInput!
): LineItemsForShipmentsSpreadsheetDownloadMutationPayload 
# start a background job to bulk dispatch line items. Only accessible to operator 
# and seller admin users.
# 
# Arguments
# input: Parameters for 
# LineItemsForShipmentsSpreadsheetUploadMutation
lineItemsForShipmentsSpreadsheetUpload(
input: LineItemsForShipmentsSpreadsheetUploadMutationInput!
): LineItemsForShipmentsSpreadsheetUploadMutationPayload 
# Logs a user out, based on a session cookie.
# 
# Arguments
# input: Parameters for UserLogOutMutation
logOut(input: UserLogOutMutationInput!): UserLogOutMutationPayload 
# Set the mapping value. Only accessible to operator and seller admin users.
# 
# Arguments
# input: Parameters for MappingSetMutation
mappingSet(input: MappingSetMutationInput!): MappingSetMutationPayload 
# Generate API keys. Only accessible to operator and seller admin users.
# 
# Arguments
# input: Parameters for MarketplacerAPIKeyCreateMutation
marketplacerApiKeyCreate(
input: MarketplacerAPIKeyCreateMutationInput!
): MarketplacerAPIKeyCreateMutationPayload 
# Create an association between an existing Object (eg. Advert) and multiple 
# Metadata objects
# Metadata's owner/key will be unique.
# For example, owner: 'Advert', key: 'my_store', value: '23'.
# If a Metadata exists with an owner of 'Advert' and a key of 'my_store', this
# record will be found and updated with the new value, or created if it does not 
# exist.
# . Only accessible to operator admin users.
# 
# Arguments
# input: Parameters for Metadata2UpsertMutation
metadata2Upsert(input: Metadata2UpsertMutationInput!): Metadata2UpsertMutationPayload 
# Create an association between an existing Object (eg. Order/Invoice/Seller) and 
# Metadata. Only accessible to operator admin users.
# 
# Arguments
# input: Parameters for MetadataUpsertMutation
metadataUpsert(input: MetadataUpsertMutationInput!): MetadataUpsertMutationPayload 
# Subscribe the given email to the marketing newsletter.
# 
# Arguments
# input: Parameters for NewsletterSubscribeMutation
newsletterSubscribe(
input: NewsletterSubscribeMutationInput!
): NewsletterSubscribeMutationPayload 
# Create an OptionType if no ID is passed, otherwise updates existing Prototype. 
# Only accessible to operator admin users.
# 
# Arguments
# input: Parameters for OptionTypeCreateOrUpdateMutation
optionTypeCreateOrUpdate(
input: OptionTypeCreateOrUpdateMutationInput!
): OptionTypeCreateOrUpdateMutationPayload 
# Create an OptionValue if no ID is passed, otherwise updates existing 
# OptionValue. Only accessible to operator admin users.
# 
# Arguments
# input: Parameters for OptionValueCreateOrUpdateMutation
optionValueCreateOrUpdate(
input: OptionValueCreateOrUpdateMutationInput!
): OptionValueCreateOrUpdateMutationPayload 
# Delete an existing OptionValue. Only accessible to operator admin users.
# 
# Arguments
# input: Parameters for OptionValueDeleteMutation
optionValueDelete(input: OptionValueDeleteMutationInput!): OptionValueDeleteMutationPayload 
# Create an order. Only accessible to operator admin users.
# 
# Arguments
# input: Parameters for OrderCreateMutation
orderCreate(input: OrderCreateMutationInput!): OrderCreateMutationPayload 
# start a background job to download order history. Only accessible to operator 
# and seller admin users.
# 
# Arguments
# input: Parameters for OrderHistoryDownloadMutation
orderHistoryDownload(
input: OrderHistoryDownloadMutationInput!
): OrderHistoryDownloadMutationPayload 
# Update a finalized order. Only accessible to operator admin users.
# 
# Arguments
# input: Parameters for OrderUpdateMutation
orderUpdate(input: OrderUpdateMutationInput!): OrderUpdateMutationPayload 
# Create a partner integration toggle event. Only accessible to operator and 
# seller admin users.
# 
# Arguments
# input: Parameters for 
# PartnerIntegrationToggleEventCreateMutation
partnerIntegrationToggleEventCreate(
input: PartnerIntegrationToggleEventCreateMutationInput!
): PartnerIntegrationToggleEventCreateMutationPayload 
# Resets password for a user or admin.
# 
# Arguments
# input: Parameters for PasswordResetMutation
passwordReset(input: PasswordResetMutationInput!): PasswordResetMutationPayload 
# Create a payment method. Only accessible to operator admin users.
# 
# Arguments
# input: Parameters for PaymentMethodCreateMutation
paymentMethodCreate(
input: PaymentMethodCreateMutationInput!
): PaymentMethodCreateMutationPayload 
# Delete a payment method. Only accessible to operator admin users.
# 
# Arguments
# input: Parameters for PaymentMethodDeleteMutation
paymentMethodDelete(
input: PaymentMethodDeleteMutationInput!
): PaymentMethodDeleteMutationPayload 
# Create or update PayPal Commerce settings. Only accessible to operator admin 
# users.
# 
# Arguments
# input: Parameters for 
# PaypalCommerceSettingsCreateOrUpdateMutation
paypalCommerceSettingsCreateOrUpdate(
input: PaypalCommerceSettingsCreateOrUpdateMutationInput!
): PaypalCommerceSettingsCreateOrUpdateMutationPayload 
# Delete PayPal Commerce settings. Only accessible to operator admin users.
# 
# Arguments
# input: Parameters for PaypalCommerceSettingsDeleteMutation
paypalCommerceSettingsDelete(
input: PaypalCommerceSettingsDeleteMutationInput!
): PaypalCommerceSettingsDeleteMutationPayload 
# Confirm an order using order ID. This order confirmation is used only for 
# redirect based payment providers such as Afterpay, Zip. Will receive order once 
# order has been processed successfully.
# 
# Arguments
# input: Parameters for ProcessPaymentGatewayRedirectMutation
processPaymentGatewayRedirect(
input: ProcessPaymentGatewayRedirectMutationInput!
): ProcessPaymentGatewayRedirectMutationPayload 
# Create or update a promotion. Only accessible to operator and seller admin 
# users.
# 
# Arguments
# input: Parameters for PromotionUpsertMutation
promotionUpsert(input: PromotionUpsertMutationInput!): PromotionUpsertMutationPayload 
# Create a Prototype if no ID is passed, otherwise updates existing Prototype. 
# Only accessible to operator admin users.
# 
# Arguments
# input: Parameters for PrototypeCreateOrUpdateMutation
prototypeCreateOrUpdate(
input: PrototypeCreateOrUpdateMutationInput!
): PrototypeCreateOrUpdateMutationPayload 
# Purge the sensitive user data from an order. Only accessible to operator admin 
# users.
# 
# Arguments
# input: Parameters for PurgeOrderDataMutation
purgeOrderData(input: PurgeOrderDataMutationInput!): PurgeOrderDataMutationPayload 
# Delete a ranked result. Only accessible to operator admin users.
# 
# Arguments
# input: Parameters for RankedResultDeleteMutation
rankedResultDelete(input: RankedResultDeleteMutationInput!): RankedResultDeleteMutationPayload 
# Upsert a ranked result. Only accessible to operator admin users.
# 
# Arguments
# input: Parameters for RankedResultUpsertMutation
rankedResultUpsert(input: RankedResultUpsertMutationInput!): RankedResultUpsertMutationPayload 
# Approve the refund request. Only accessible to operator admin users.
# 
# Arguments
# input: [Not documented]
refundRequestApprove(input: RefundRequestApproveInput!): RefundRequestApproveMutationPayload 
# Create a refund request. Only accessible to operator and seller admin users.
# 
# Arguments
# input: Parameters for RefundRequestCreateMutation
refundRequestCreate(
input: RefundRequestCreateMutationInput!
): RefundRequestCreateMutationPayload 
# Deny a refund request. Only accessible to operator admin users.
# 
# Arguments
# input: Parameters for RefundRequestDenyMutation
refundRequestDeny(input: RefundRequestDenyMutationInput!): RefundRequestDenyMutationPayload 
# Accept the refund request line item. Only accessible to operator and seller 
# admin users.
# 
# Arguments
# input: Parameters for RefundRequestLineItemAcceptMutation
refundRequestLineItemAccept(
input: RefundRequestLineItemAcceptMutationInput!
): RefundRequestLineItemAcceptMutationPayload 
# Deny the refund request line item. Only accessible to operator and seller admin 
# users.
# 
# Arguments
# input: Parameters for RefundRequestLineItemDenyMutation
refundRequestLineItemDeny(
input: RefundRequestLineItemDenyMutationInput!
): RefundRequestLineItemDenyMutationPayload 
# Return the refund request line item. Only accessible to operator and seller 
# admin users.
# 
# Arguments
# input: Parameters for RefundRequestLineItemReturnMutation
refundRequestLineItemReturn(
input: RefundRequestLineItemReturnMutationInput!
): RefundRequestLineItemReturnMutationPayload 
# Refund a refund request. Only accessible to operator admin users.
# 
# Arguments
# input: Parameters for RefundRequestRefundMutation
refundRequestRefund(
input: RefundRequestRefundMutationInput!
): RefundRequestRefundMutationPayload 
# Mark a refund request as having been returned. Only accessible to operator and 
# seller admin users.
# 
# Arguments
# input: Parameters for RefundRequestReturnMutation
refundRequestReturn(
input: RefundRequestReturnMutationInput!
): RefundRequestReturnMutationPayload 
# Revert a refund request denial. Only accessible to operator admin users.
# 
# Arguments
# input: Parameters for RefundRequestRevertDenialMutation
refundRequestRevertDenial(
input: RefundRequestRevertDenialMutationInput!
): RefundRequestRevertDenialMutationPayload 
# start a background job to download refund requests. Only accessible to operator 
# and seller admin users.
# 
# Arguments
# input: Parameters for RefundRequestSpreadsheetDownloadMutation
refundRequestSpreadsheetDownload(
input: RefundRequestSpreadsheetDownloadMutationInput!
): RefundRequestSpreadsheetDownloadMutationPayload 
# Update Remittance Advice. Only accessible to operator admin users.
# 
# Arguments
# input: Parameters for RemittanceAdviceUpdateMutation
remittanceAdviceUpdate(
input: RemittanceAdviceUpdateMutationInput!
): RemittanceAdviceUpdateMutationPayload 
# Remittances Release. Only accessible to operator admin users.
# 
# Arguments
# input: Parameters for RemittancesReleaseMutation
remittancesRelease(input: RemittancesReleaseMutationInput!): RemittancesReleaseMutationPayload 
# Sends a reset password email to the logged in user.
# 
# Arguments
# input: Parameters for ResetUserPasswordMutation
resetUserPassword(input: ResetUserPasswordMutationInput!): ResetUserPasswordMutationPayload 
# Create a return shipment for a refund request. Only accessible to operator and 
# seller admin users.
# 
# Arguments
# input: Parameters for ReturnShipmentCreateMutation
returnShipmentCreate(
input: ReturnShipmentCreateMutationInput!
): ReturnShipmentCreateMutationPayload 
# Update a return shipment for a refund request. Only accessible to operator and 
# seller admin users.
# 
# Arguments
# input: Parameters for ReturnShipmentUpdateMutation
returnShipmentUpdate(
input: ReturnShipmentUpdateMutationInput!
): ReturnShipmentUpdateMutationPayload 
# Generate Rithum API key for a Seller. Only accessible to operator and seller 
# admin users.
# 
# Arguments
# input: Parameters for RithumAPIKeyCreateMutation
rithumApiKeyCreate(input: RithumAPIKeyCreateMutationInput!): RithumAPIKeyCreateMutationPayload 
# Updates adyen billing payment method for seller. Only accessible to operator and 
# seller admin users.
# 
# Arguments
# input: Parameters for 
# SellerAdyenBillingPaymentMethodUpdateMutation
sellerAdyenBillingPaymentMethodUpdate(
input: SellerAdyenBillingPaymentMethodUpdateMutationInput!
): SellerAdyenBillingPaymentMethodUpdateMutationPayload 
# Updates braintree billing payment method for seller. Only accessible to operator 
# and seller admin users.
# 
# Arguments
# input: Parameters for 
# SellerBraintreeBillingPaymentMethodUpdateMutation
sellerBraintreeBillingPaymentMethodUpdate(
input: SellerBraintreeBillingPaymentMethodUpdateMutationInput!
): SellerBraintreeBillingPaymentMethodUpdateMutationPayload 
# Create prospective seller accounts. Only accessible to operator admin users.
# 
# Arguments
# input: Parameters for SellerCreateMutation
sellerCreate(input: SellerCreateMutationInput!): SellerCreateMutationPayload 
# Sends an invoice to the customer. Only accessible to operator and seller admin 
# users.
# 
# Arguments
# input: Parameters for SellerSendInvoiceToCustomerMutation
sellerSendInvoiceToCustomer(
input: SellerSendInvoiceToCustomerMutationInput!
): SellerSendInvoiceToCustomerMutationPayload 
# Download seller sla metrics as a csv file. Only accessible to operator admin 
# users.
# 
# Arguments
# input: Parameters for SellerSlaExportMetricMutation
sellerSlaExportMetricMutation(
input: SellerSlaExportMetricMutationInput!
): SellerSlaExportMetricMutationPayload 
# Update a seller. Requires an authenticated user to use mutation. Only accessible 
# to operator and seller admin users.
# 
# Arguments
# input: Parameters for SellerUpdateMutation
sellerUpdate(input: SellerUpdateMutationInput!): SellerUpdateMutationPayload 
# Create or update SendGrid settings. Only accessible to operator admin users.
# 
# Arguments
# input: Parameters for SendgridSettingsCreateOrUpdateMutation
sendgridSettingsCreateOrUpdate(
input: SendgridSettingsCreateOrUpdateMutationInput!
): SendgridSettingsCreateOrUpdateMutationPayload 
# Delete SendGrid settings. Only accessible to operator admin users.
# 
# Arguments
# input: Parameters for SendgridSettingsDeleteMutation
sendgridSettingsDelete(
input: SendgridSettingsDeleteMutationInput!
): SendgridSettingsDeleteMutationPayload 
# Updates the user session with location information.
# 
# Arguments
# input: Parameters for SessionLocationInformationUpdateMutation
sessionLocationInformationUpdateMutation(
input: SessionLocationInformationUpdateMutationInput!
): SessionLocationInformationUpdateMutationPayload 
# Logs a user out, based on a session token. Only accessible to operator and 
# seller admin users.
# 
# Arguments
# input: Parameters for SessionTokenLogOutMutation
sessionTokenLogOut(input: SessionTokenLogOutMutationInput!): SessionTokenLogOutMutationPayload 
# Create an address to ship items from. Only accessible to operator and seller 
# admin users.
# 
# Arguments
# input: Parameters for ShipmentAddressCreateMutation
shipmentAddressCreate(
input: ShipmentAddressCreateMutationInput!
): ShipmentAddressCreateMutationPayload 
# Change the sort order for a retailer's shipment addresses. Only accessible to 
# operator and seller admin users.
# 
# Arguments
# input: Parameters for ShipmentAddressSortMutation
shipmentAddressSort(
input: ShipmentAddressSortMutationInput!
): ShipmentAddressSortMutationPayload 
# Create a shipment. Only accessible to operator and seller admin users.
# 
# Arguments
# input: Parameters for ShipmentCreateMutation
shipmentCreate(input: ShipmentCreateMutationInput!): ShipmentCreateMutationPayload 
# Add a status to the shipment status log. Only accessible to operator and seller 
# admin users.
# 
# Arguments
# input: Parameters for ShipmentStatusCreateMutation
shipmentStatusCreate(
input: ShipmentStatusCreateMutationInput!
): ShipmentStatusCreateMutationPayload 
# Update a shipment. Only accessible to operator and seller admin users.
# 
# Arguments
# input: Parameters for ShipmentUpdateMutation
shipmentUpdate(input: ShipmentUpdateMutationInput!): ShipmentUpdateMutationPayload 
# Mark an existing shipping as deleted. Only accessible to operator and seller 
# admin users.
# 
# Arguments
# input: Parameters for ShippingOptionDeleteMutation
shippingOptionDelete(
input: ShippingOptionDeleteMutationInput!
): ShippingOptionDeleteMutationPayload 
# Create or update shipping rules. Only accessible to operator and seller admin 
# users.
# 
# Arguments
# input: Parameters for ShippingOptionUpsertMutation
shippingOptionUpsert(
input: ShippingOptionUpsertMutationInput!
): ShippingOptionUpsertMutationPayload 
# Create or Update Shipping Rates. Only accessible to operator and seller admin 
# users.
# 
# Arguments
# input: Parameters for ShippingRateCreateOrUpdateMutation
shippingRateCreateOrUpdate(
input: ShippingRateCreateOrUpdateMutationInput!
): ShippingRateCreateOrUpdateMutationPayload 
# Delete a shipping rate. Only accessible to operator and seller admin users.
# 
# Arguments
# input: Parameters for ShippingRateDeleteMutation
shippingRateDelete(input: ShippingRateDeleteMutationInput!): ShippingRateDeleteMutationPayload 
# Create or Update Shipping Zones. Only accessible to operator and seller admin 
# users.
# 
# Arguments
# input: Parameters for ShippingZoneCreateOrUpdateMutation
shippingZoneCreateOrUpdate(
input: ShippingZoneCreateOrUpdateMutationInput!
): ShippingZoneCreateOrUpdateMutationPayload 
# Delete a shipping zone. Only accessible to operator and seller admin users.
# 
# Arguments
# input: Parameters for ShippingZoneDeleteMutation
shippingZoneDelete(input: ShippingZoneDeleteMutationInput!): ShippingZoneDeleteMutationPayload 
# start a background job to download shipping zone postcodes. Only accessible to 
# operator and seller admin users.
# 
# Arguments
# input: Parameters for ShippingZoneSpreadsheetDownloadMutation
shippingZoneSpreadsheetDownload(
input: ShippingZoneSpreadsheetDownloadMutationInput!
): ShippingZoneSpreadsheetDownloadMutationPayload 
# Update Shippit API credentials. Only accessible to operator and seller admin 
# users.
# 
# Arguments
# input: Parameters for ShippitCredentialsUpsertMutation
shippitCredentialsUpsert(
input: ShippitCredentialsUpsertMutationInput!
): ShippitCredentialsUpsertMutationPayload 
# start a background job to download stock levels. Only accessible to operator and 
# seller admin users.
# 
# Arguments
# input: Parameters for StockLevelsSpreadsheetDownloadMutation
stockLevelsSpreadsheetDownload(
input: StockLevelsSpreadsheetDownloadMutationInput!
): StockLevelsSpreadsheetDownloadMutationPayload 
# start a background job to update stock levels of variants or inventories. Only 
# accessible to operator and seller admin users.
# 
# Arguments
# input: Parameters for StockLevelsSpreadsheetUploadMutation
stockLevelsSpreadsheetUpload(
input: StockLevelsSpreadsheetUploadMutationInput!
): StockLevelsSpreadsheetUploadMutationPayload 
# Create or update tax codes. Only accessible to operator admin users.
# 
# Arguments
# input: Parameters for TaxCodeCreateOrUpdateMutation
taxCodeCreateOrUpdate(
input: TaxCodeCreateOrUpdateMutationInput!
): TaxCodeCreateOrUpdateMutationPayload 
# Create a Taxon if no ID is passed, otherwise updates existing Taxon. Only 
# accessible to operator admin users.
# 
# Arguments
# input: Parameters for TaxonCreateOrUpdateMutation
taxonCreateOrUpdate(
input: TaxonCreateOrUpdateMutationInput!
): TaxonCreateOrUpdateMutationPayload 
# Create a mutable user. Only primary user for a seller can perform this. Only 
# accessible to operator and seller admin users.
# 
# Arguments
# input: Parameters for UserCreateMutation
userCreate(input: UserCreateMutationInput!): UserCreateMutationPayload 
# Updates the session currency.
# 
# Arguments
# input: Parameters for UserCurrencySelectMutation
userCurrencySelect(input: UserCurrencySelectMutationInput!): UserCurrencySelectMutationPayload 
# Delete a mutable user. Only primary user for a seller can perform this. Only 
# accessible to operator and seller admin users.
# 
# Arguments
# input: Parameters for UserDeleteMutation
userDelete(input: UserDeleteMutationInput!): UserDeleteMutationPayload 
# Initiate a token login for a seller.
# 
# Returns a session token which can be used as an API key until it
# expires).
# 
# Arguments
# input: Parameters for UserLoginTokenMutation
userLoginToken(input: UserLoginTokenMutationInput!): UserLoginTokenMutationPayload 
# Initiate a username/password login for a seller.
# 
# Returns a session token which can be used as an API key until it
# expires).
# 
# Arguments
# input: Parameters for UserLoginUsernameMutation
userLoginUsername(input: UserLoginUsernameMutationInput!): UserLoginUsernameMutationPayload 
# Verifies an MFA token for a user.
# 
# Returns a new session token which can be used as an API key until it
# expires only if the sessionToken field is requested).
# 
# Arguments
# input: Parameters for UserMFATokenVerificationMutation
userMfaTokenVerification(
input: UserMFATokenVerificationMutationInput!
): UserMFATokenVerificationMutationPayload 
# Update a mutable user. Requires an authenticated user to use mutation.
# 
# Arguments
# input: Parameters for UserUpdateMutation
userUpdate(input: UserUpdateMutationInput!): UserUpdateMutationPayload 
# Updates the favourite store of the current user.
# 
# Arguments
# input: Parameters for UserUpdateFavouriteStoreMutation
userUpdateFavouriteStore(
input: UserUpdateFavouriteStoreMutationInput!
): UserUpdateFavouriteStoreMutationPayload 
# Delete a variant. Only accessible to operator and seller admin users.
# 
# Arguments
# input: Parameters for VariantDeleteMutation
variantDelete(input: VariantDeleteMutationInput!): VariantDeleteMutationPayload 
# Update a variant. Only accessible to operator and seller admin users.
# 
# Arguments
# input: Parameters for VariantUpdateMutation
variantUpdate(input: VariantUpdateMutationInput!): VariantUpdateMutationPayload 
# Verify an authenticator for a user or admin. Users and Admins can only do this 
# for themselves. Only accessible to seller and operator admin users.
# 
# Arguments
# input: Parameters for VerifyAuthenticatorMutation
verifyAuthenticator(
input: VerifyAuthenticatorMutationInput!
): VerifyAuthenticatorMutationPayload @deprecated( reason: "Feature in development, subject to change without notice"  )
# Create a webhook. Only accessible to operator and seller admin users.
# 
# Arguments
# input: Parameters for WebhookCreateMutation
webhookCreate(input: WebhookCreateMutationInput!): WebhookCreateMutationPayload 
# Update a webhook. Only accessible to operator and seller admin users.
# 
# Arguments
# input: Parameters for WebhookUpdateMutation
webhookUpdate(input: WebhookUpdateMutationInput!): WebhookUpdateMutationPayload 
# Create or update Yotpo settings. Only accessible to operator admin users.
# 
# Arguments
# input: Parameters for YotpoSettingsCreateOrUpdateMutation
yotpoSettingsCreateOrUpdate(
input: YotpoSettingsCreateOrUpdateMutationInput!
): YotpoSettingsCreateOrUpdateMutationPayload 
# Delete Yotpo settings. Only accessible to operator admin users.
# 
# Arguments
# input: Parameters for YotpoSettingsDeleteMutation
yotpoSettingsDelete(
input: YotpoSettingsDeleteMutationInput!
): YotpoSettingsDeleteMutationPayload 
# Create or update Zip settings. Only accessible to operator admin users.
# 
# Arguments
# input: Parameters for ZipSettingsCreateOrUpdateMutation
zipSettingsCreateOrUpdate(
input: ZipSettingsCreateOrUpdateMutationInput!
): ZipSettingsCreateOrUpdateMutationPayload 
# Delete Zip settings. Only accessible to operator admin users.
# 
# Arguments
# input: Parameters for ZipSettingsDeleteMutation
zipSettingsDelete(input: ZipSettingsDeleteMutationInput!): ZipSettingsDeleteMutationPayload 
# Create or update Zooz settings. Only accessible to operator admin users.
# 
# Arguments
# input: Parameters for ZoozSettingsCreateOrUpdateMutation
zoozSettingsCreateOrUpdate(
input: ZoozSettingsCreateOrUpdateMutationInput!
): ZoozSettingsCreateOrUpdateMutationPayload 
# Delete Zooz settings. Only accessible to operator admin users.
# 
# Arguments
# input: Parameters for ZoozSettingsDeleteMutation
zoozSettingsDelete(input: ZoozSettingsDeleteMutationInput!): ZoozSettingsDeleteMutationPayload 
}
Require by

This element is not required by anyone
Mutation

link GraphQL Schema definition

link Require by

GraphQL Schema definition

Require by
