Home > @infiniteobjects/shopify-data-manager > AdminTypes > Mutation
The schema’s entry point for all mutation operations.
Signature:
export interface Mutation
| Property | Modifiers | Type | Description |
|---|---|---|---|
| abandonmentEmailStateUpdate? | Maybe<AbandonmentEmailStateUpdatePayload> | (Optional) Updates the email state value for an abandonment. | |
| abandonmentUpdateActivitiesDeliveryStatuses? | Maybe<AbandonmentUpdateActivitiesDeliveryStatusesPayload> | (Optional) Updates the marketing activities delivery statuses for an abandonment. | |
| appPurchaseOneTimeCreate? | Maybe<AppPurchaseOneTimeCreatePayload> | (Optional) Charges a shop for features or services one time. This type of charge is recommended for apps that aren’t billed on a recurring basis. Test and demo shops aren’t charged. | |
| appSubscriptionCancel? | Maybe<AppSubscriptionCancelPayload> | (Optional) Cancels an app subscription on a store. | |
| appSubscriptionCreate? | Maybe<AppSubscriptionCreatePayload> | (Optional) Allows an app to charge a store for features or services on a recurring basis. | |
| appSubscriptionLineItemUpdate? | Maybe<AppSubscriptionLineItemUpdatePayload> | (Optional) Updates the capped amount on the usage pricing plan of an app subscription line item. | |
| appSubscriptionTrialExtend? | Maybe<AppSubscriptionTrialExtendPayload> | (Optional) Extends the trial of an app subscription. | |
| appUsageRecordCreate? | Maybe<AppUsageRecordCreatePayload> | (Optional) Enables an app to charge a store for features or services on a per-use basis. The usage charge value is counted towards the cappedAmount limit that was specified in the appUsagePricingDetails field when the app subscription was created. If you create an app usage charge that causes the total usage charges in a billing interval to exceed the capped amount, then a Total price exceeds balance remaining error is returned. |
|
| bulkOperationCancel? | Maybe<BulkOperationCancelPayload> | <p>(Optional) Starts the cancelation process of a running bulk operation.</p><p>There may be a short delay from when a cancelation starts until the operation is actually canceled.</p> | |
| bulkOperationRunMutation? | Maybe<BulkOperationRunMutationPayload> | <p>(Optional) Creates and runs a bulk operation mutation.</p><p>To learn how to bulk import large volumes of data asynchronously, refer to the [bulk import data guide](https://shopify.dev/api/usage/bulk-operations/imports).</p> | |
| bulkOperationRunQuery? | Maybe<BulkOperationRunQueryPayload> | <p>(Optional) Creates and runs a bulk operation query.</p><p>See the [bulk operations guide](https://shopify.dev/api/usage/bulk-operations/imports) for more details.</p> | |
| bulkProductResourceFeedbackCreate? | Maybe<BulkProductResourceFeedbackCreatePayload> | (Optional) Creates product feedback for multiple products. | |
| cartTransformCreate? | Maybe<CartTransformCreatePayload> | (Optional) Create a CartTransform function to the Shop. | |
| cartTransformDelete? | Maybe<CartTransformDeletePayload> | (Optional) Destroy a cart transform function from the Shop. | |
| catalogContextUpdate? | Maybe<CatalogContextUpdatePayload> | (Optional) Updates the context of a catalog. | |
| catalogCreate? | Maybe<CatalogCreatePayload> | (Optional) Creates a new catalog. | |
| catalogDelete? | Maybe<CatalogDeletePayload> | (Optional) Delete a catalog. | |
| catalogUpdate? | Maybe<CatalogUpdatePayload> | (Optional) Updates an existing catalog. | |
| checkoutBrandingUpsert? | Maybe<CheckoutBrandingUpsertPayload> | (Optional) Updates the checkout branding settings for a [checkout profile](https://shopify.dev/api/admin-graphql/unstable/queries/checkoutProfile). If the settings don’t exist, then new settings are created. The checkout branding settings applied to a published checkout profile will be immediately visible within the store’s checkout. The checkout branding settings applied to a draft checkout profile could be previewed within the admin checkout editor. | |
| collectionAddProducts? | Maybe<CollectionAddProductsPayload> | (Optional) Adds products to a collection. | |
| collectionAddProductsV2? | Maybe<CollectionAddProductsV2Payload> | (Optional) Asynchronously adds a set of products to a given collection. It can take a long time to run. Instead of returning a collection, it returns a job which should be polled. | |
| collectionCreate? | Maybe<CollectionCreatePayload> | (Optional) Creates a collection. | |
| collectionDelete? | Maybe<CollectionDeletePayload> | (Optional) Deletes a collection. | |
| collectionPublish? | Maybe<CollectionPublishPayload> | (Optional) Publishes a collection to a channel. | |
| collectionRemoveProducts? | Maybe<CollectionRemoveProductsPayload> | (Optional) Removes a set of products from a given collection. The mutation can take a long time to run. Instead of returning an updated collection the mutation returns a job, which should be [polled](https://shopify.dev/api/admin-graphql/latest/queries/job). For use with manual collections only. | |
| collectionReorderProducts? | Maybe<CollectionReorderProductsPayload> | (Optional) Asynchronously reorders a set of products within a specified collection. Instead of returning an updated collection, this mutation returns a job, which should be [polled](https://shopify.dev/api/admin-graphql/latest/queries/job). The [Collection.sortOrder](https://shopify.dev/api/admin-graphql/latest/objects/Collection#field-collection-sortorder) must be MANUAL. Displaced products will have their position altered in a consistent manner, with no gaps. |
|
| collectionUnpublish? | Maybe<CollectionUnpublishPayload> | (Optional) Unpublishes a collection. | |
| collectionUpdate? | Maybe<CollectionUpdatePayload> | (Optional) Updates a collection. | |
| companiesDelete? | Maybe<CompaniesDeletePayload> | (Optional) Deletes a list of companies. | |
| companyAddressDelete? | Maybe<CompanyAddressDeletePayload> | (Optional) Deletes a company address. | |
| companyAssignCustomerAsContact? | Maybe<CompanyAssignCustomerAsContactPayload> | (Optional) Assigns the customer as a company contact. | |
| companyAssignMainContact? | Maybe<CompanyAssignMainContactPayload> | (Optional) Assigns the main contact for the company. | |
| companyContactAssignRole? | Maybe<CompanyContactAssignRolePayload> | (Optional) Assigns a role to a contact for a location. | |
| companyContactAssignRoles? | Maybe<CompanyContactAssignRolesPayload> | (Optional) Assigns roles on a company contact. | |
| companyContactCreate? | Maybe<CompanyContactCreatePayload> | (Optional) Creates a company contact. | |
| companyContactDelete? | Maybe<CompanyContactDeletePayload> | (Optional) Deletes a company contact. | |
| companyContactRemoveFromCompany? | Maybe<CompanyContactRemoveFromCompanyPayload> | (Optional) Removes a company contact from a Company. | |
| companyContactRevokeRole? | Maybe<CompanyContactRevokeRolePayload> | (Optional) Revokes a role on a company contact. | |
| companyContactRevokeRoles? | Maybe<CompanyContactRevokeRolesPayload> | (Optional) Revokes roles on a company contact. | |
| companyContactsDelete? | Maybe<CompanyContactsDeletePayload> | (Optional) Deletes one or more company contacts. | |
| companyContactSendWelcomeEmail? | Maybe<CompanyContactSendWelcomeEmailPayload> | (Optional) Sends the company contact a welcome email. | |
| companyContactUpdate? | Maybe<CompanyContactUpdatePayload> | (Optional) Updates a company contact. | |
| companyCreate? | Maybe<CompanyCreatePayload> | (Optional) Creates a company. | |
| companyDelete? | Maybe<CompanyDeletePayload> | (Optional) Deletes a company. | |
| companyLocationAssignAddress? | Maybe<CompanyLocationAssignAddressPayload> | (Optional) Updates an address on a company location. | |
| companyLocationAssignRoles? | Maybe<CompanyLocationAssignRolesPayload> | (Optional) Assigns roles on a company location. | |
| companyLocationAssignTaxExemptions? | Maybe<CompanyLocationAssignTaxExemptionsPayload> | (Optional) Assigns tax exemptions to the company location. | |
| companyLocationCreate? | Maybe<CompanyLocationCreatePayload> | (Optional) Creates a company location. | |
| companyLocationCreateTaxRegistration? | Maybe<CompanyLocationCreateTaxRegistrationPayload> | (Optional) Creates a tax registration for a company location. | |
| companyLocationDelete? | Maybe<CompanyLocationDeletePayload> | (Optional) Deletes a company location. | |
| companyLocationRevokeRoles? | Maybe<CompanyLocationRevokeRolesPayload> | (Optional) Revokes roles on a company location. | |
| companyLocationRevokeTaxExemptions? | Maybe<CompanyLocationRevokeTaxExemptionsPayload> | (Optional) Revokes tax exemptions from the company location. | |
| companyLocationRevokeTaxRegistration? | Maybe<CompanyLocationRevokeTaxRegistrationPayload> | (Optional) Revokes tax registration on a company location. | |
| companyLocationsDelete? | Maybe<CompanyLocationsDeletePayload> | (Optional) Deletes a list of company locations. | |
| companyLocationUpdate? | Maybe<CompanyLocationUpdatePayload> | (Optional) Updates a company location. | |
| companyRevokeMainContact? | Maybe<CompanyRevokeMainContactPayload> | (Optional) Revokes the main contact from the company. | |
| companyUpdate? | Maybe<CompanyUpdatePayload> | (Optional) Updates a company. | |
| customerAddTaxExemptions? | Maybe<CustomerAddTaxExemptionsPayload> | (Optional) Add tax exemptions for the customer. | |
| customerCreate? | Maybe<CustomerCreatePayload> | (Optional) Create a new customer. As of API version 2022-10, apps using protected customer data must meet the protected customer data [requirements](https://shopify.dev/apps/store/data-protection/protected-customer-data). | |
| customerDelete? | Maybe<CustomerDeletePayload> | (Optional) Delete a customer. As of API version 2022-10, apps using protected customer data must meet the protected customer data [requirements](https://shopify.dev/apps/store/data-protection/protected-customer-data). | |
| customerEmailMarketingConsentUpdate? | Maybe<CustomerEmailMarketingConsentUpdatePayload> | (Optional) Update a customer’s email marketing information information. | |
| customerGenerateAccountActivationUrl? | Maybe<CustomerGenerateAccountActivationUrlPayload> | (Optional) Generate an account activation URL for a customer. | |
| customerMerge? | Maybe<CustomerMergePayload> | (Optional) Merges two customers. | |
| customerPaymentMethodCreateFromDuplicationData? | Maybe<CustomerPaymentMethodCreateFromDuplicationDataPayload> | <p>(Optional) Creates a vaulted payment method for a customer from duplication data.</p><p>This data must be obtained from another shop within the same organization.</p><p>Currently, this only supports Shop Pay payment methods. This is only available for selected partner apps.</p> | |
| customerPaymentMethodCreditCardCreate? | Maybe<CustomerPaymentMethodCreditCardCreatePayload> | (Optional) Creates a credit card payment method for a customer using a session id. These values are only obtained through card imports happening from a PCI compliant environment. Please use customerPaymentMethodRemoteCreate if you are not managing credit cards directly. | |
| customerPaymentMethodCreditCardUpdate? | Maybe<CustomerPaymentMethodCreditCardUpdatePayload> | (Optional) Updates the credit card payment method for a customer. | |
| customerPaymentMethodGetDuplicationData? | Maybe<CustomerPaymentMethodGetDuplicationDataPayload> | <p>(Optional) Returns encrypted data that can be used to duplicate the payment method in another shop within the same organization.</p><p>Currently, this only supports Shop Pay payment methods. This is only available for selected partner apps.</p> | |
| customerPaymentMethodGetUpdateUrl? | Maybe<CustomerPaymentMethodGetUpdateUrlPayload> | <p>(Optional) Returns a URL that allows the customer to update a specific payment method.</p><p>Currently, customerPaymentMethodGetUpdateUrl only supports Shop Pay.</p> |
|
| customerPaymentMethodPaypalBillingAgreementCreate? | Maybe<CustomerPaymentMethodPaypalBillingAgreementCreatePayload> | (Optional) Creates a PayPal billing agreement for a customer. | |
| customerPaymentMethodPaypalBillingAgreementUpdate? | Maybe<CustomerPaymentMethodPaypalBillingAgreementUpdatePayload> | (Optional) Updates a PayPal billing agreement for a customer. | |
| customerPaymentMethodRemoteCreate? | Maybe<CustomerPaymentMethodRemoteCreatePayload> | (Optional) Create a payment method from remote gateway identifiers. | |
| customerPaymentMethodRemoteCreditCardCreate? | Maybe<CustomerPaymentMethodRemoteCreditCardCreatePayload> | (Optional) Create a payment method from a credit card stored by Stripe. | |
| customerPaymentMethodRevoke? | Maybe<CustomerPaymentMethodRevokePayload> | (Optional) Revokes a customer’s payment method. | |
| customerPaymentMethodSendUpdateEmail? | Maybe<CustomerPaymentMethodSendUpdateEmailPayload> | (Optional) Sends a link to the customer so they can update a specific payment method. | |
| customerRemoveTaxExemptions? | Maybe<CustomerRemoveTaxExemptionsPayload> | (Optional) Remove tax exemptions from a customer. | |
| customerReplaceTaxExemptions? | Maybe<CustomerReplaceTaxExemptionsPayload> | (Optional) Replace tax exemptions for a customer. | |
| customerSegmentMembersQueryCreate? | Maybe<CustomerSegmentMembersQueryCreatePayload> | (Optional) Creates a customer segment members query. | |
| customerSmsMarketingConsentUpdate? | Maybe<CustomerSmsMarketingConsentUpdatePayload> | (Optional) Update a customer’s SMS marketing consent information. | |
| customerUpdate? | Maybe<CustomerUpdatePayload> | (Optional) Update a customer’s attributes. As of API version 2022-10, apps using protected customer data must meet the protected customer data [requirements](https://shopify.dev/apps/store/data-protection/protected-customer-data). | |
| customerUpdateDefaultAddress? | Maybe<CustomerUpdateDefaultAddressPayload> | (Optional) Updates a customer’s default address. | |
| delegateAccessTokenCreate? | Maybe<DelegateAccessTokenCreatePayload> | <p>(Optional) Creates a delegate access token.</p><p>To learn more about creating delegate access tokens, refer to [Delegate OAuth access tokens to subsystems] (https://shopify.dev/apps/auth/oauth/delegate-access-tokens).</p> | |
| delegateAccessTokenDestroy? | Maybe<DelegateAccessTokenDestroyPayload> | (Optional) Destroys a delegate access token. | |
| deliveryCustomizationActivation? | Maybe<DeliveryCustomizationActivationPayload> | (Optional) Activates and deactivates delivery customizations. | |
| deliveryCustomizationCreate? | Maybe<DeliveryCustomizationCreatePayload> | (Optional) Creates a delivery customization. | |
| deliveryCustomizationDelete? | Maybe<DeliveryCustomizationDeletePayload> | (Optional) Creates a delivery customization. | |
| deliveryCustomizationUpdate? | Maybe<DeliveryCustomizationUpdatePayload> | (Optional) Updates a delivery customization. | |
| deliveryProfileCreate? | Maybe<DeliveryProfileCreatePayload> | (Optional) Create a delivery profile. | |
| deliveryProfileRemove? | Maybe<DeliveryProfileRemovePayload> | (Optional) Enqueue the removal of a delivery profile. | |
| deliveryProfileUpdate? | Maybe<DeliveryProfileUpdatePayload> | (Optional) Update a delivery profile. | |
| deliverySettingUpdate? | Maybe<DeliverySettingUpdatePayload> | (Optional) Set the delivery settings for a shop. | |
| deliveryShippingOriginAssign? | Maybe<DeliveryShippingOriginAssignPayload> | (Optional) Assigns a location as the shipping origin while using legacy compatibility mode for multi-location delivery profiles. | |
| discountAutomaticActivate? | Maybe<DiscountAutomaticActivatePayload> | (Optional) Activates an automatic discount. | |
| discountAutomaticAppCreate? | Maybe<DiscountAutomaticAppCreatePayload> | (Optional) Creates an app discount. | |
| discountAutomaticAppUpdate? | Maybe<DiscountAutomaticAppUpdatePayload> | (Optional) Updates an automatic app discount. | |
| discountAutomaticBasicCreate? | Maybe<DiscountAutomaticBasicCreatePayload> | (Optional) Creates a basic automatic discount. | |
| discountAutomaticBasicUpdate? | Maybe<DiscountAutomaticBasicUpdatePayload> | (Optional) Updates a basic automatic discount. | |
| discountAutomaticBulkDelete? | Maybe<DiscountAutomaticBulkDeletePayload> | (Optional) Asynchronously delete automatic discounts in bulk if a search or saved_search_id argument is provided or if a maximum discount threshold is reached (1,000). Otherwise, deletions will occur inline. **Warning:** All automatic discounts will be deleted if a blank search argument is provided. |
|
| discountAutomaticBxgyCreate? | Maybe<DiscountAutomaticBxgyCreatePayload> | (Optional) Creates a BXGY automatic discount. | |
| discountAutomaticBxgyUpdate? | Maybe<DiscountAutomaticBxgyUpdatePayload> | (Optional) Updates an existing Buy X, Get Y (BXGY) automatic discount. | |
| discountAutomaticDeactivate? | Maybe<DiscountAutomaticDeactivatePayload> | (Optional) Deactivates an automatic discount. | |
| discountAutomaticDelete? | Maybe<DiscountAutomaticDeletePayload> | (Optional) Deletes an automatic discount. | |
| discountAutomaticFreeShippingCreate? | Maybe<DiscountAutomaticFreeShippingCreatePayload> | (Optional) Creates a free shipping automatic discount. | |
| discountAutomaticFreeShippingUpdate? | Maybe<DiscountAutomaticFreeShippingUpdatePayload> | (Optional) Updates a free shipping automatic discount. | |
| discountCodeActivate? | Maybe<DiscountCodeActivatePayload> | (Optional) Activates a code discount. | |
| discountCodeAppCreate? | Maybe<DiscountCodeAppCreatePayload> | (Optional) Creates a code app discount. | |
| discountCodeAppUpdate? | Maybe<DiscountCodeAppUpdatePayload> | (Optional) Updates a code app discount. | |
| discountCodeBasicCreate? | Maybe<DiscountCodeBasicCreatePayload> | (Optional) Creates a basic code discount. | |
| discountCodeBasicUpdate? | Maybe<DiscountCodeBasicUpdatePayload> | (Optional) Updates a basic code discount. | |
| discountCodeBulkActivate? | Maybe<DiscountCodeBulkActivatePayload> | (Optional) Asynchronously activate code discounts in bulk using a search query, a saved search ID, or a list of code discount IDs. | |
| discountCodeBulkDeactivate? | Maybe<DiscountCodeBulkDeactivatePayload> | (Optional) Asynchronously deactivate code discounts in bulk using a search query, a saved search ID, or a list of code discount IDs. | |
| discountCodeBulkDelete? | Maybe<DiscountCodeBulkDeletePayload> | (Optional) Asynchronously delete code discounts in bulk using a search query, a saved search ID, or a list of code discount IDs. | |
| discountCodeBxgyCreate? | Maybe<DiscountCodeBxgyCreatePayload> | (Optional) Creates a Buy X get Y (BXGY) code discount. | |
| discountCodeBxgyUpdate? | Maybe<DiscountCodeBxgyUpdatePayload> | (Optional) Updates a Buy X, Get Y (BXGY) code discount. | |
| discountCodeDeactivate? | Maybe<DiscountCodeDeactivatePayload> | (Optional) Deactivates a code discount. | |
| discountCodeDelete? | Maybe<DiscountCodeDeletePayload> | (Optional) Deletes a code discount. | |
| discountCodeFreeShippingCreate? | Maybe<DiscountCodeFreeShippingCreatePayload> | (Optional) Creates a free shipping code discount. | |
| discountCodeFreeShippingUpdate? | Maybe<DiscountCodeFreeShippingUpdatePayload> | (Optional) Updates a free shipping code discount. | |
| discountCodeRedeemCodeBulkDelete? | Maybe<DiscountCodeRedeemCodeBulkDeletePayload> | (Optional) Asynchronously delete discount redeem codes in bulk. Specify the redeem codes to delete by providing a search query, a saved search ID, or a list of redeem code IDs. | |
| discountRedeemCodeBulkAdd? | Maybe<DiscountRedeemCodeBulkAddPayload> | (Optional) Asynchronously add discount redeem codes in bulk. Specify the codes to add and the discount code ID that the codes will belong to. | |
| disputeEvidenceUpdate? | Maybe<DisputeEvidenceUpdatePayload> | (Optional) Updates a dispute evidence. | |
| draftOrderBulkAddTags? | Maybe<DraftOrderBulkAddTagsPayload> | (Optional) Adds tags to multiple draft orders. | |
| draftOrderBulkDelete? | Maybe<DraftOrderBulkDeletePayload> | (Optional) Deletes multiple draft orders. | |
| draftOrderBulkRemoveTags? | Maybe<DraftOrderBulkRemoveTagsPayload> | (Optional) Removes tags from multiple draft orders. | |
| draftOrderCalculate? | Maybe<DraftOrderCalculatePayload> | (Optional) Calculates the properties of a draft order. Useful for determining information such as total taxes or price without actually creating a draft order. | |
| draftOrderComplete? | Maybe<DraftOrderCompletePayload> | (Optional) Completes a draft order and creates an order. | |
| draftOrderCreate? | Maybe<DraftOrderCreatePayload> | (Optional) Creates a draft order. | |
| draftOrderCreateFromOrder? | Maybe<DraftOrderCreateFromOrderPayload> | (Optional) Creates a Draft Order from Order. | |
| draftOrderCreateMerchantCheckout? | Maybe<DraftOrderCreateMerchantCheckoutPayload> | (Optional) Creates a merchant checkout for the given draft order. | |
| draftOrderDelete? | Maybe<DraftOrderDeletePayload> | (Optional) Deletes a draft order. | |
| draftOrderDuplicate? | Maybe<DraftOrderDuplicatePayload> | (Optional) Duplicates a draft order. | |
| draftOrderInvoicePreview? | Maybe<DraftOrderInvoicePreviewPayload> | (Optional) Previews a draft order invoice email. | |
| draftOrderInvoiceSend? | Maybe<DraftOrderInvoiceSendPayload> | (Optional) Sends an email invoice for a draft order. | |
| draftOrderUpdate? | Maybe<DraftOrderUpdatePayload> | <p>(Optional) Updates a draft order.</p><p>If a checkout has been started for a draft order, any update to the draft will unlink the checkout. Checkouts are created but not immediately completed when opening the merchant credit card modal in the admin, and when a buyer opens the invoice URL. This is usually fine, but there is an edge case where a checkout is in progress and the draft is updated before the checkout completes. This will not interfere with the checkout and order creation, but if the link from draft to checkout is broken the draft will remain open even after the order is created.</p> | |
| eventBridgeServerPixelUpdate? | Maybe<EventBridgeServerPixelUpdatePayload> | (Optional) Updates the server pixel to connect to an EventBridge endpoint. Running this mutation deletes any previous subscriptions for the server pixel. | |
| eventBridgeWebhookSubscriptionCreate? | Maybe<EventBridgeWebhookSubscriptionCreatePayload> | (Optional) Creates a new Amazon EventBridge webhook subscription. | |
| eventBridgeWebhookSubscriptionUpdate? | Maybe<EventBridgeWebhookSubscriptionUpdatePayload> | (Optional) Updates an Amazon EventBridge webhook subscription. | |
| fileAcknowledgeUpdateFailed? | Maybe<FileAcknowledgeUpdateFailedPayload> | (Optional) Acknowledges file update failure by resetting FAILED status to READY and clearing any media errors. | |
| fileCreate? | Maybe<FileCreatePayload> | (Optional) Creates file assets using an external URL or for files that were previously uploaded using the [stagedUploadsCreate mutation](https://shopify.dev/api/admin-graphql/latest/mutations/stageduploadscreate). These files are added to the [Files page](https://shopify.com/admin/settings/files) in Shopify admin. | |
| fileDelete? | Maybe<FileDeletePayload> | (Optional) Deletes existing file assets that were uploaded to Shopify. | |
| fileUpdate? | Maybe<FileUpdatePayload> | (Optional) Updates an existing file asset that was uploaded to Shopify. | |
| flowTriggerReceive? | Maybe<FlowTriggerReceivePayload> | (Optional) Triggers any workflows that begin with the trigger specified in the request body. To learn more, refer to [_Create Shopify Flow triggers_](https://shopify.dev/apps/flow/triggers). | |
| fulfillmentCancel? | Maybe<FulfillmentCancelPayload> | (Optional) Cancels a fulfillment. | |
| fulfillmentConstraintRuleCreate? | Maybe<FulfillmentConstraintRuleCreatePayload> | (Optional) Creates a fulfillment constraint rule and its metafield. | |
| fulfillmentConstraintRuleDelete? | Maybe<FulfillmentConstraintRuleDeletePayload> | (Optional) Deletes a fulfillment constraint rule and its metafields. | |
| fulfillmentCreateV2? | Maybe<FulfillmentCreateV2Payload> | (Optional) Creates a fulfillment for one or many fulfillment orders. The fulfillment orders are associated with the same order and are assigned to the same location. | |
| fulfillmentEventCreate? | Maybe<FulfillmentEventCreatePayload> | (Optional) Creates a fulfillment event for a specified fulfillment. | |
| fulfillmentOrderAcceptCancellationRequest? | Maybe<FulfillmentOrderAcceptCancellationRequestPayload> | (Optional) Accept a cancellation request sent to a fulfillment service for a fulfillment order. | |
| fulfillmentOrderAcceptFulfillmentRequest? | Maybe<FulfillmentOrderAcceptFulfillmentRequestPayload> | (Optional) Accepts a fulfillment request sent to a fulfillment service for a fulfillment order. | |
| fulfillmentOrderCancel? | Maybe<FulfillmentOrderCancelPayload> | (Optional) Marks a fulfillment order as canceled. | |
| fulfillmentOrderClose? | Maybe<FulfillmentOrderClosePayload> | (Optional) Marks an in-progress fulfillment order as incomplete, indicating the fulfillment service is unable to ship any remaining items and intends to close the fulfillment order. | |
| fulfillmentOrderHold? | Maybe<FulfillmentOrderHoldPayload> | (Optional) Applies a fulfillment hold on an open fulfillment order. | |
| fulfillmentOrderLineItemsPreparedForPickup? | Maybe<FulfillmentOrderLineItemsPreparedForPickupPayload> | <p>(Optional) Mark line items associated with a fulfillment order as being ready for pickup by a customer.</p><p>Sends a Ready For Pickup notification to the customer to let them know that their order is ready to be picked up.</p> | |
| fulfillmentOrderMerge? | Maybe<FulfillmentOrderMergePayload> | (Optional) Merges a set or multiple sets of fulfillment orders together into one based on line item inputs and quantities. | |
| fulfillmentOrderMove? | Maybe<FulfillmentOrderMovePayload> | <p>(Optional) Changes the location which is assigned to fulfill a number of unfulfilled fulfillment order line items.</p><p>Moving a fulfillment order will fail in the following circumstances:</p><p>* The fulfillment order is closed. * The destination location has never stocked the requested inventory item. * The API client doesn’t have the correct permissions.</p><p>Line items which have already been fulfilled can’t be re-assigned and will always remain assigned to the original location.</p><p>You can’t change the assigned location while a fulfillment order has a [request status](https://shopify.dev/docs/api/admin-graphql/latest/enums/FulfillmentOrderRequestStatus) of SUBMITTED, ACCEPTED, CANCELLATION_REQUESTED, or CANCELLATION_REJECTED. These request statuses mean that a fulfillment order is awaiting action by a fulfillment service and can’t be re-assigned without first having the fulfillment service accept a cancellation request. This behavior is intended to prevent items from being fulfilled by multiple locations or fulfillment services.</p><p>### How re-assigning line items affects fulfillment orders</p><p>**First scenario:** Re-assign all line items belonging to a fulfillment order to a new location.</p><p>In this case, the [assignedLocation](https://shopify.dev/docs/api/admin-graphql/latest/objects/fulfillmentorder#field-fulfillmentorder-assignedlocation) of the original fulfillment order will be updated to the new location.</p><p>**Second scenario:** Re-assign a subset of the line items belonging to a fulfillment order to a new location. You can specify a subset of line items using the fulfillmentOrderLineItems parameter (available as of the 2023-04 API version), or specify that the original fulfillment order contains line items which have already been fulfilled.</p><p>If the new location is already assigned to another active fulfillment order, on the same order, then a new fulfillment order is created. The existing fulfillment order is closed and line items are recreated in a new fulfillment order.</p> |
|
| fulfillmentOrderOpen? | Maybe<FulfillmentOrderOpenPayload> | (Optional) Marks a scheduled fulfillment order as open. | |
| fulfillmentOrderRejectCancellationRequest? | Maybe<FulfillmentOrderRejectCancellationRequestPayload> | (Optional) Rejects a cancellation request sent to a fulfillment service for a fulfillment order. | |
| fulfillmentOrderRejectFulfillmentRequest? | Maybe<FulfillmentOrderRejectFulfillmentRequestPayload> | (Optional) Rejects a fulfillment request sent to a fulfillment service for a fulfillment order. | |
| fulfillmentOrderReleaseHold? | Maybe<FulfillmentOrderReleaseHoldPayload> | (Optional) Releases the fulfillment hold on a fulfillment order. | |
| fulfillmentOrderReschedule? | Maybe<FulfillmentOrderReschedulePayload> | (Optional) Reschedules a scheduled fulfillment order. | |
| fulfillmentOrderSplit? | Maybe<FulfillmentOrderSplitPayload> | (Optional) Splits a fulfillment order or orders based on line item inputs and quantities. | |
| fulfillmentOrdersReleaseHolds? | Maybe<FulfillmentOrdersReleaseHoldsPayload> | (Optional) Releases the fulfillment holds on a list of fulfillment orders. | |
| fulfillmentOrdersSetFulfillmentDeadline? | Maybe<FulfillmentOrdersSetFulfillmentDeadlinePayload> | (Optional) Sets the latest date and time by which the fulfillment orders need to be fulfilled. | |
| fulfillmentOrderSubmitCancellationRequest? | Maybe<FulfillmentOrderSubmitCancellationRequestPayload> | (Optional) Sends a cancellation request to the fulfillment service of a fulfillment order. | |
| fulfillmentOrderSubmitFulfillmentRequest? | Maybe<FulfillmentOrderSubmitFulfillmentRequestPayload> | (Optional) Sends a fulfillment request to the fulfillment service of a fulfillment order. | |
| fulfillmentServiceCreate? | Maybe<FulfillmentServiceCreatePayload> | <p>(Optional) Creates a fulfillment service.</p><p>## Fulfillment service location</p><p>When creating a fulfillment service, a new location will be automatically created on the shop and will be associated with this fulfillment service. This location will be named after the fulfillment service and inherit the shop’s address.</p><p>If you are using API version 2023-10 or later, and you need to specify custom attributes for the fulfillment service location (for example, to change its address to a country different from the shop’s country), use the [LocationEdit](https://shopify.dev/api/admin-graphql/latest/mutations/locationEdit) mutation after creating the fulfillment service.</p> |
|
| fulfillmentServiceDelete? | Maybe<FulfillmentServiceDeletePayload> | (Optional) Deletes a fulfillment service. | |
| fulfillmentServiceUpdate? | Maybe<FulfillmentServiceUpdatePayload> | <p>(Optional) Updates a fulfillment service.</p><p>If you are using API version 2023-10 or later, and you need to update the location managed by the fulfillment service (for example, to change the address of a fulfillment service), use the [LocationEdit](https://shopify.dev/api/admin-graphql/latest/mutations/locationEdit) mutation.</p> |
|
| fulfillmentTrackingInfoUpdateV2? | Maybe<FulfillmentTrackingInfoUpdateV2Payload> | (Optional) Updates tracking information for a fulfillment. | |
| giftCardCreate? | Maybe<GiftCardCreatePayload> | (Optional) Create a gift card. | |
| giftCardDisable? | Maybe<GiftCardDisablePayload> | (Optional) Disable a gift card. A disabled gift card cannot be used by a customer. A disabled gift card cannot be re-enabled. | |
| giftCardUpdate? | Maybe<GiftCardUpdatePayload> | (Optional) Update a gift card. | |
| inventoryActivate? | Maybe<InventoryActivatePayload> | (Optional) Activate an inventory item at a location. | |
| inventoryAdjustQuantities? | Maybe<InventoryAdjustQuantitiesPayload> | (Optional) Apply changes to inventory quantities. | |
| inventoryAdjustQuantity? | Maybe<InventoryAdjustQuantityPayload> | (Optional) Adjusts the inventory by a certain quantity. | |
| inventoryBulkAdjustQuantityAtLocation? | Maybe<InventoryBulkAdjustQuantityAtLocationPayload> | (Optional) Adjusts the inventory at a location for multiple inventory items. | |
| inventoryBulkToggleActivation? | Maybe<InventoryBulkToggleActivationPayload> | (Optional) Modify the activation status of an inventory item at locations. Activating an inventory item at a particular location allows that location to stock that inventory item. Deactivating an inventory item at a location removes the inventory item’s quantities and turns off the inventory item from that location. | |
| inventoryDeactivate? | Maybe<InventoryDeactivatePayload> | (Optional) Removes an inventory item’s quantities from a location, and turns off inventory at the location. | |
| inventoryItemUpdate? | Maybe<InventoryItemUpdatePayload> | (Optional) Updates an inventory item. | |
| inventoryMoveQuantities? | Maybe<InventoryMoveQuantitiesPayload> | (Optional) Moves inventory between inventory quantity names at a single location. | |
| inventorySetOnHandQuantities? | Maybe<InventorySetOnHandQuantitiesPayload> | (Optional) Set inventory on-hand quantities using absolute values. | |
| locationActivate? | Maybe<LocationActivatePayload> | (Optional) Activates a location. | |
| locationAdd? | Maybe<LocationAddPayload> | (Optional) Adds a new location. | |
| locationDeactivate? | Maybe<LocationDeactivatePayload> | (Optional) Deactivates a location and moves inventory, pending orders, and moving transfers to a destination location. | |
| locationDelete? | Maybe<LocationDeletePayload> | (Optional) Deletes a location. | |
| locationEdit? | Maybe<LocationEditPayload> | <p>(Optional) Edits an existing location.</p><p>[As of the 2023-10 API version](https://shopify.dev/changelog/apps-can-now-change-the-name-and-address-of-their-fulfillment-service-locations), apps can change the name and address of their fulfillment service locations.</p> | |
| locationLocalPickupDisable? | Maybe<LocationLocalPickupDisablePayload> | (Optional) Disables local pickup for a location. | |
| locationLocalPickupEnable? | Maybe<LocationLocalPickupEnablePayload> | (Optional) Enables local pickup for a location. | |
| marketCreate? | Maybe<MarketCreatePayload> | (Optional) Creates a new market. | |
| marketCurrencySettingsUpdate? | Maybe<MarketCurrencySettingsUpdatePayload> | (Optional) Updates currency settings of a market. | |
| marketDelete? | Maybe<MarketDeletePayload> | (Optional) Deletes a market definition. | |
| marketingActivityCreate? | Maybe<MarketingActivityCreatePayload> | (Optional) Create new marketing activity. | |
| marketingActivityCreateExternal? | Maybe<MarketingActivityCreateExternalPayload> | (Optional) Creates a new external marketing activity. | |
| marketingActivityUpdate? | Maybe<MarketingActivityUpdatePayload> | (Optional) Updates a marketing activity with the latest information. | |
| marketingActivityUpdateExternal? | Maybe<MarketingActivityUpdateExternalPayload> | (Optional) Update an external marketing activity. | |
| marketingEngagementCreate? | Maybe<MarketingEngagementCreatePayload> | (Optional) Creates a new marketing event engagement for a marketing activity or a marketing channel. | |
| marketLocalizationsRegister? | Maybe<MarketLocalizationsRegisterPayload> | (Optional) Creates or updates market localizations. | |
| marketLocalizationsRemove? | Maybe<MarketLocalizationsRemovePayload> | (Optional) Deletes market localizations. | |
| marketRegionDelete? | Maybe<MarketRegionDeletePayload> | (Optional) Deletes a market region. | |
| marketRegionsCreate? | Maybe<MarketRegionsCreatePayload> | (Optional) Creates regions that belong to an existing market. | |
| marketUpdate? | Maybe<MarketUpdatePayload> | (Optional) Updates the properties of a market. | |
| marketWebPresenceCreate? | Maybe<MarketWebPresenceCreatePayload> | (Optional) Creates a web presence for a market. | |
| marketWebPresenceDelete? | Maybe<MarketWebPresenceDeletePayload> | (Optional) Deletes a market web presence. | |
| marketWebPresenceUpdate? | Maybe<MarketWebPresenceUpdatePayload> | (Optional) Updates a market web presence. | |
| metafieldDefinitionCreate? | Maybe<MetafieldDefinitionCreatePayload> | (Optional) Creates a metafield definition. | |
| metafieldDefinitionDelete? | Maybe<MetafieldDefinitionDeletePayload> | (Optional) Delete a metafield definition. Optionally deletes all associated metafields asynchronously when specified. | |
| metafieldDefinitionPin? | Maybe<MetafieldDefinitionPinPayload> | (Optional) You can organize your metafields in your Shopify admin by pinning/unpinning metafield definitions. The order of your pinned metafield definitions determines the order in which your metafields are displayed on the corresponding pages in your Shopify admin. By default, only pinned metafields are automatically displayed. | |
| metafieldDefinitionUnpin? | Maybe<MetafieldDefinitionUnpinPayload> | (Optional) You can organize your metafields in your Shopify admin by pinning/unpinning metafield definitions. The order of your pinned metafield definitions determines the order in which your metafields are displayed on the corresponding pages in your Shopify admin. By default, only pinned metafields are automatically displayed. | |
| metafieldDefinitionUpdate? | Maybe<MetafieldDefinitionUpdatePayload> | (Optional) Updates a metafield definition. | |
| metafieldDelete? | Maybe<MetafieldDeletePayload> | (Optional) Deletes a metafield. | |
| metafieldsSet? | Maybe<MetafieldsSetPayload> | <p>(Optional) Sets metafield values. Metafield values will be set regardless if they were previously created or not.</p><p>Allows a maximum of 25 metafields to be set at a time.</p><p>Note that this operation is atomic as of 2023-01, meaning no changes are persisted if any error is encountered.</p> |
|
| metafieldStorefrontVisibilityCreate? | Maybe<MetafieldStorefrontVisibilityCreatePayload> | (Optional) Creates a MetafieldStorefrontVisibility record to make all metafields that belong to the specified resource and have the established namespace and key combination visible in the Storefront API. |
|
| metafieldStorefrontVisibilityDelete? | Maybe<MetafieldStorefrontVisibilityDeletePayload> | (Optional) Deletes a MetafieldStorefrontVisibility record. All metafields that belongs to the specified record will no longer be visible in the Storefront API. |
|
| metaobjectBulkDelete? | Maybe<MetaobjectBulkDeletePayload> | (Optional) Asynchronously delete metaobjects and their associated metafields in bulk. | |
| metaobjectCreate? | Maybe<MetaobjectCreatePayload> | (Optional) Creates a new metaobject. | |
| metaobjectDefinitionCreate? | Maybe<MetaobjectDefinitionCreatePayload> | (Optional) Creates a new metaobject definition. | |
| metaobjectDefinitionDelete? | Maybe<MetaobjectDefinitionDeletePayload> | (Optional) Deletes the specified metaobject definition. Also deletes all related metafield definitions, metaobjects, and metafields asynchronously. | |
| metaobjectDefinitionUpdate? | Maybe<MetaobjectDefinitionUpdatePayload> | (Optional) Updates a metaobject definition with new settings and metafield definitions. | |
| metaobjectDelete? | Maybe<MetaobjectDeletePayload> | (Optional) Deletes the specified metaobject and its associated metafields. | |
| metaobjectUpdate? | Maybe<MetaobjectUpdatePayload> | (Optional) Updates an existing metaobject. | |
| metaobjectUpsert? | Maybe<MetaobjectUpsertPayload> | (Optional) Retrieves a metaobject by handle, then updates it with the provided input values. If no matching metaobject is found, a new metaobject is created with the provided input values. | |
| orderCapture? | Maybe<OrderCapturePayload> | (Optional) Captures payment for an authorized transaction on an order. An order can only be captured if it has a successful authorization transaction. Capturing an order will claim the money reserved by the authorization. | |
| orderClose? | Maybe<OrderClosePayload> | (Optional) Closes an open order. | |
| orderCreateMandatePayment? | Maybe<OrderCreateMandatePaymentPayload> | (Optional) Creates a payment for an order by mandate. | |
| orderEditAddCustomItem? | Maybe<OrderEditAddCustomItemPayload> | (Optional) Adds a custom line item to an existing order. For example, you could add a gift wrapping service as a [custom line item](https://shopify.dev/apps/fulfillment/order-management-apps/order-editing#add-a-custom-line-item). To learn how to edit existing orders, refer to [Edit an existing order with Admin API](https://shopify.dev/apps/fulfillment/order-management-apps/order-editing). | |
| orderEditAddLineItemDiscount? | Maybe<OrderEditAddLineItemDiscountPayload> | (Optional) Adds a discount to a newly added line item on the current order edit. More information on how to use the GraphQL Admin API to edit an existing order, refer to [Edit existing orders](https://shopify.dev/apps/fulfillment/order-management-apps/order-editing). | |
| orderEditAddVariant? | Maybe<OrderEditAddVariantPayload> | (Optional) Adds a line item from an existing product variant. | |
| orderEditBegin? | Maybe<OrderEditBeginPayload> | (Optional) Starts editing an order. Mutations are operating on OrderEdit. All order edits start with orderEditBegin, have any number of orderEdit* mutations made, and end with orderEditCommit. |
|
| orderEditCommit? | Maybe<OrderEditCommitPayload> | (Optional) Applies and saves staged changes to an order. Mutations are operating on OrderEdit. All order edits start with orderEditBegin, have any number of orderEdit* mutations made, and end with orderEditCommit. |
|
| orderEditRemoveLineItemDiscount? | Maybe<OrderEditRemoveLineItemDiscountPayload> | (Optional) Removes a line item discount that was applied as part of an order edit. | |
| orderEditSetQuantity? | Maybe<OrderEditSetQuantityPayload> | (Optional) Sets the quantity of a line item on an order that is being edited. More information on how to use the GraphQL Admin API to edit an existing order, refer to [Edit existing orders](https://shopify.dev/apps/fulfillment/order-management-apps/order-editing). | |
| orderInvoiceSend? | Maybe<OrderInvoiceSendPayload> | (Optional) Sends an email invoice for an order. | |
| orderMarkAsPaid? | Maybe<OrderMarkAsPaidPayload> | (Optional) Marks an order as paid. You can only mark an order as paid if it isn’t already fully paid. | |
| orderOpen? | Maybe<OrderOpenPayload> | (Optional) Opens a closed order. | |
| orderUpdate? | Maybe<OrderUpdatePayload> | (Optional) Updates the fields of an order. | |
| paymentCustomizationActivation? | Maybe<PaymentCustomizationActivationPayload> | (Optional) Activates and deactivates payment customizations. | |
| paymentCustomizationCreate? | Maybe<PaymentCustomizationCreatePayload> | (Optional) Creates a payment customization. | |
| paymentCustomizationDelete? | Maybe<PaymentCustomizationDeletePayload> | (Optional) Deletes a payment customization. | |
| paymentCustomizationUpdate? | Maybe<PaymentCustomizationUpdatePayload> | (Optional) Updates a payment customization. | |
| paymentReminderSend? | Maybe<PaymentReminderSendPayload> | (Optional) Sends an email payment reminder for a payment schedule. | |
| paymentTermsCreate? | Maybe<PaymentTermsCreatePayload> | (Optional) Create payment terms on an order. To create payment terms on a draft order, use a draft order mutation and include the request with the DraftOrderInput. |
|
| paymentTermsDelete? | Maybe<PaymentTermsDeletePayload> | (Optional) Delete payment terms for an order. To delete payment terms on a draft order, use a draft order mutation and include the request with the DraftOrderInput. |
|
| paymentTermsUpdate? | Maybe<PaymentTermsUpdatePayload> | (Optional) Update payment terms on an order. To update payment terms on a draft order, use a draft order mutation and include the request with the DraftOrderInput. |
|
| priceListCreate? | Maybe<PriceListCreatePayload> | (Optional) Creates a price list. You can use the priceListCreate mutation to create a new price list for a country. This enables you to sell your products with international pricing. |
|
| priceListDelete? | Maybe<PriceListDeletePayload> | (Optional) Deletes a price list. For example, you can delete a price list so that it no longer applies for products in the associated market. | |
| priceListFixedPricesAdd? | Maybe<PriceListFixedPricesAddPayload> | (Optional) Creates or updates fixed prices on a price list. You can use the priceListFixedPricesAdd mutation to set a fixed price for specific product variants. This lets you change product variant pricing on a per country basis. Any existing fixed price list prices for these variants will be overwritten. |
|
| priceListFixedPricesByProductUpdate? | Maybe<PriceListFixedPricesByProductUpdatePayload> | (Optional) Updates the fixed prices for all variants for a product on a price list. You can use the priceListFixedPricesByProductUpdate mutation to set or remove a fixed price for all variants of a product associated with the price list. |
|
| priceListFixedPricesDelete? | Maybe<PriceListFixedPricesDeletePayload> | (Optional) Deletes specific fixed prices from a price list using a product variant ID. You can use the priceListFixedPricesDelete mutation to delete a set of fixed prices from a price list. After deleting the set of fixed prices from the price list, the price of each product variant reverts to the original price that was determined by the price list adjustment. |
|
| priceListFixedPricesUpdate? | Maybe<PriceListFixedPricesUpdatePayload> | (Optional) Updates fixed prices on a price list. You can use the priceListFixedPricesUpdate mutation to set a fixed price for specific product variants or to delete prices for variants associated with the price list. |
|
| priceListUpdate? | Maybe<PriceListUpdatePayload> | (Optional) Updates a price list. If you modify the currency, then any fixed prices set on the price list will be deleted. | |
| priceRuleActivate? | Maybe<PriceRuleActivatePayload> | (Optional) Activate a price rule. | |
| priceRuleCreate? | Maybe<PriceRuleCreatePayload> | (Optional) Create a price rule using the input. | |
| priceRuleDeactivate? | Maybe<PriceRuleDeactivatePayload> | (Optional) Deactivate a price rule. | |
| priceRuleDelete? | Maybe<PriceRuleDeletePayload> | (Optional) Delete a price rule. | |
| priceRuleDiscountCodeCreate? | Maybe<PriceRuleDiscountCodeCreatePayload> | (Optional) Create a discount code for a price rule. | |
| priceRuleDiscountCodeUpdate? | Maybe<PriceRuleDiscountCodeUpdatePayload> | (Optional) Update a discount code for a price rule. | |
| priceRuleUpdate? | Maybe<PriceRuleUpdatePayload> | (Optional) Updates a price rule using its ID and an input. | |
| privateMetafieldDelete? | Maybe<PrivateMetafieldDeletePayload> | (Optional) Deletes a private metafield. Private metafields are automatically deleted when the app that created them is uninstalled. | |
| privateMetafieldUpsert? | Maybe<PrivateMetafieldUpsertPayload> | <p>(Optional) Creates or updates a private metafield. Use private metafields when you don’t want the metafield data to be accessible by merchants or other apps. Private metafields are accessible only by the application that created them and only from the GraphQL Admin API.</p><p>An application can create a maximum of 10 private metafields per shop resource.</p> | |
| productAppendImages? | Maybe<ProductAppendImagesPayload> | (Optional) Appends images to a product. | |
| productChangeStatus? | Maybe<ProductChangeStatusPayload> | (Optional) Changes the status of a product. This allows you to set the availability of the product across all channels. | |
| productCreate? | Maybe<ProductCreatePayload> | <p>(Optional) Creates a product.</p><p>If you need to create a product with many [variants](https://shopify.dev/api/admin-graphql/latest/input-objects/ProductVariantInput) that are active at several [locations](https://shopify.dev/api/admin-graphql/latest/input-objects/InventoryLevelInput), especially with a lot of [collections](https://shopify.dev/api/admin-graphql/latest/mutations/productCreate#field-productinput-collectionstojoin) and [tags](https://shopify.dev/api/admin-graphql/latest/mutations/productCreate#field-productinput-tags), then you should first create the product with just the variants.</p><p>After the product is created, you can activate the variants at locations and add the other related objects to the product. This reduces the size of each mutation and increases the likelihood that it will complete before the operation times out.</p><p>The following example shows how you might break up product creation and object association into multiple steps:</p><p>1. Create the product with variants. Don’t specify any tags or collections on the product, and don’t specify [inventory quantities](https://shopify.dev/api/admin-graphql/latest/input-objects/ProductVariantInput#field-productvariantinput-inventoryquantities) for each variant.</p><p>2. After the product is created, add tags to the product using the [tagsAdd](https://shopify.dev/api/admin-graphql/latest/mutations/tagsAdd) mutation, and add collections using the [collectionsAddProducts](https://shopify.dev/api/admin-graphql/latest/mutations/collectionAddProducts) mutation.</p><p>3. Use the [inventoryBulkToggleActivation](https://shopify.dev/api/admin-graphql/latest/mutations/inventoryBulkToggleActivation) mutation on each [inventory item](https://shopify.dev/api/admin-graphql/latest/objects/InventoryItem) to activate it at the appropriate locations.</p><p>4. After activating the variants at the locations, adjust inventory quantities at each location using the [inventoryBulkAdjustQuantityAtLocation](https://shopify.dev/api/admin-graphql/latest/mutations/inventoryBulkAdjustQuantityAtLocation) mutation.</p> | |
| productCreateMedia? | Maybe<ProductCreateMediaPayload> | (Optional) Creates media for a product. | |
| productDelete? | Maybe<ProductDeletePayload> | <p>(Optional) Deletes a product, including all associated variants and media.</p><p>As of API version 2023-01, if you need to delete a large product, such as one that has many [variants](https://shopify.dev/api/admin-graphql/latest/input-objects/ProductVariantInput) that are active at several [locations](https://shopify.dev/api/admin-graphql/latest/input-objects/InventoryLevelInput), you may encounter timeout errors. To avoid these timeout errors, you can instead use the asynchronous [ProductDeleteAsync](https://shopify.dev/api/admin-graphql/latest/mutations/productDeleteAsync) mutation.</p> |
|
| productDeleteAsync? | Maybe<ProductDeleteAsyncPayload> | (Optional) Deletes a product asynchronously, including all associated variants and media. | |
| productDeleteImages? | Maybe<ProductDeleteImagesPayload> | (Optional) Removes product images from the product. | |
| productDeleteMedia? | Maybe<ProductDeleteMediaPayload> | (Optional) Deletes media for a product. | |
| productDuplicate? | Maybe<ProductDuplicatePayload> | <p>(Optional) Duplicates a product.</p><p>As of API version 2023-01, if you need to duplicate a large product, such as one that has many [variants](https://shopify.dev/api/admin-graphql/latest/input-objects/ProductVariantInput) that are active at several [locations](https://shopify.dev/api/admin-graphql/latest/input-objects/InventoryLevelInput), you may encounter timeout errors. To avoid these timeout errors, you can instead use the asynchronous [ProductDuplicateAsyncV2](https://shopify.dev/api/admin-graphql/latest/mutations/productDuplicateAsyncV2) mutation.</p> |
|
| productDuplicateAsync? | Maybe<ProductDuplicateAsyncPayload> | (Optional) Asynchronously duplicate a single product. | |
| productDuplicateAsyncV2? | Maybe<ProductDuplicateAsyncV2Payload> | (Optional) Asynchronously duplicate a single product. | |
| productFeedCreate? | Maybe<ProductFeedCreatePayload> | (Optional) Creates a product feed for a specific publication. | |
| productFeedDelete? | Maybe<ProductFeedDeletePayload> | (Optional) Deletes a product feed for a specific publication. | |
| productFullSync? | Maybe<ProductFullSyncPayload> | (Optional) Runs the full product sync for a given shop. | |
| productImageUpdate? | Maybe<ProductImageUpdatePayload> | (Optional) Updates an image of a product. | |
| productJoinSellingPlanGroups? | Maybe<ProductJoinSellingPlanGroupsPayload> | (Optional) Adds multiple selling plan groups to a product. | |
| productLeaveSellingPlanGroups? | Maybe<ProductLeaveSellingPlanGroupsPayload> | (Optional) Removes multiple groups from a product. | |
| productPublish? | Maybe<ProductPublishPayload> | (Optional) Publishes a product. Products that are sold exclusively on subscription (requiresSellingPlan: true) can only be published on online stores. |
|
| productReorderImages? | Maybe<ProductReorderImagesPayload> | (Optional) Asynchronously reorders a set of images for a given product. | |
| productReorderMedia? | Maybe<ProductReorderMediaPayload> | (Optional) Asynchronously reorders the media attached to a product. | |
| productUnpublish? | Maybe<ProductUnpublishPayload> | (Optional) Unpublishes a product. | |
| productUpdate? | Maybe<ProductUpdatePayload> | (Optional) Updates a product. If you update a product and only include some variants in the update, then any variants not included will be deleted. To safely manage variants without the risk of deleting excluded variants, use [productVariantsBulkUpdate](https://shopify.dev/api/admin-graphql/latest/mutations/productvariantsbulkupdate). If you want to update a single variant, then use [productVariantUpdate](https://shopify.dev/api/admin-graphql/latest/mutations/productvariantupdate). | |
| productUpdateMedia? | Maybe<ProductUpdateMediaPayload> | (Optional) Updates media for a product. | |
| productVariantAppendMedia? | Maybe<ProductVariantAppendMediaPayload> | (Optional) Appends media from a product to variants of the product. | |
| productVariantCreate? | Maybe<ProductVariantCreatePayload> | (Optional) Creates a product variant. | |
| productVariantDelete? | Maybe<ProductVariantDeletePayload> | (Optional) Deletes a product variant. | |
| productVariantDetachMedia? | Maybe<ProductVariantDetachMediaPayload> | (Optional) Detaches media from product variants. | |
| productVariantJoinSellingPlanGroups? | Maybe<ProductVariantJoinSellingPlanGroupsPayload> | (Optional) Adds multiple selling plan groups to a product variant. | |
| productVariantLeaveSellingPlanGroups? | Maybe<ProductVariantLeaveSellingPlanGroupsPayload> | (Optional) Remove multiple groups from a product variant. | |
| productVariantRelationshipBulkUpdate? | Maybe<ProductVariantRelationshipBulkUpdatePayload> | (Optional) Creates new bundles, updates existing bundles, and removes bundle components for one or multiple bundles. | |
| productVariantsBulkCreate? | Maybe<ProductVariantsBulkCreatePayload> | (Optional) Creates product variants in bulk. If you want to create a single variant, then use [productVariantCreate](https://shopify.dev/api/admin-graphql/latest/mutations/productvariantcreate). | |
| productVariantsBulkDelete? | Maybe<ProductVariantsBulkDeletePayload> | (Optional) Deletes product variants in bulk. If you want to delete a single variant, then use [productVariantDelete](https://shopify.dev/api/admin-graphql/latest/mutations/productvariantdelete). | |
| productVariantsBulkReorder? | Maybe<ProductVariantsBulkReorderPayload> | (Optional) Reorder product variants in bulk. | |
| productVariantsBulkUpdate? | Maybe<ProductVariantsBulkUpdatePayload> | (Optional) Updates product variants in bulk. If you want to update a single variant, then use [productVariantUpdate](https://shopify.dev/api/admin-graphql/latest/mutations/productvariantupdate). | |
| productVariantUpdate? | Maybe<ProductVariantUpdatePayload> | (Optional) Updates a product variant. | |
| publicationCreate? | Maybe<PublicationCreatePayload> | (Optional) Creates a publication. | |
| publicationDelete? | Maybe<PublicationDeletePayload> | (Optional) Deletes a publication. | |
| publicationUpdate? | Maybe<PublicationUpdatePayload> | (Optional) Updates a publication. | |
| publishablePublish? | Maybe<PublishablePublishPayload> | (Optional) Publishes a resource to a channel. If the resource is a product, then it’s visible in the channel only if the product status is active. Products that are sold exclusively on subscription (requiresSellingPlan: true) can be published only on online stores. |
|
| publishablePublishToCurrentChannel? | Maybe<PublishablePublishToCurrentChannelPayload> | (Optional) Publishes a resource to current channel. If the resource is a product, then it’s visible in the channel only if the product status is active. Products that are sold exclusively on subscription (requiresSellingPlan: true) can be published only on online stores. |
|
| publishableUnpublish? | Maybe<PublishableUnpublishPayload> | (Optional) Unpublishes a resource from a channel. If the resource is a product, then it’s visible in the channel only if the product status is active. |
|
| publishableUnpublishToCurrentChannel? | Maybe<PublishableUnpublishToCurrentChannelPayload> | (Optional) Unpublishes a resource from the current channel. If the resource is a product, then it’s visible in the channel only if the product status is active. |
|
| pubSubServerPixelUpdate? | Maybe<PubSubServerPixelUpdatePayload> | (Optional) Updates the server pixel to connect to a Google PubSub endpoint. Running this mutation deletes any previous subscriptions for the server pixel. | |
| pubSubWebhookSubscriptionCreate? | Maybe<PubSubWebhookSubscriptionCreatePayload> | (Optional) Creates a new Google Cloud Pub/Sub webhook subscription. | |
| pubSubWebhookSubscriptionUpdate? | Maybe<PubSubWebhookSubscriptionUpdatePayload> | (Optional) Updates a Google Cloud Pub/Sub webhook subscription. | |
| quantityPricingByVariantUpdate? | Maybe<QuantityPricingByVariantUpdatePayload> | (Optional) Updates quantity pricing on a price list. You can use the quantityPricingByVariantUpdate mutation to set fixed prices, quantity rules, and quantity price breaks. This mutation does not allow partial successes. If any of the requested resources fail to update, none of the requested resources will be updated. Delete operations are executed before create operations. |
|
| quantityRulesAdd? | Maybe<QuantityRulesAddPayload> | (Optional) Creates or updates existing quantity rules on a price list. You can use the quantityRulesAdd mutation to set order level minimums, maximumums and increments for specific product variants. |
|
| quantityRulesDelete? | Maybe<QuantityRulesDeletePayload> | (Optional) Deletes specific quantity rules from a price list using a product variant ID. You can use the quantityRulesDelete mutation to delete a set of quantity rules from a price list. |
|
| refundCreate? | Maybe<RefundCreatePayload> | (Optional) Creates a refund. | |
| returnApproveRequest? | Maybe<ReturnApproveRequestPayload> | (Optional) Approves a customer’s return request. If this mutation is successful, then the Return.status field of the approved return is set to OPEN. |
|
| returnCancel? | Maybe<ReturnCancelPayload> | (Optional) Cancels a return and restores the items back to being fulfilled. Canceling a return is only available before any work has been done on the return (such as an inspection or refund). | |
| returnClose? | Maybe<ReturnClosePayload> | (Optional) Indicates a return is complete, either when a refund has been made and items restocked, or simply when it has been marked as returned in the system. | |
| returnCreate? | Maybe<ReturnCreatePayload> | (Optional) Creates a return. | |
| returnDeclineRequest? | Maybe<ReturnDeclineRequestPayload> | (Optional) Declines a return on an order. When a return is declined, each ReturnLineItem.fulfillmentLineItem can be associated to a new return. Use the ReturnCreate or ReturnRequest mutation to initiate a new return. |
|
| returnRefund? | Maybe<ReturnRefundPayload> | (Optional) Refunds a return and associates it with the related return request. | |
| returnReopen? | Maybe<ReturnReopenPayload> | (Optional) Reopens a closed return. | |
| returnRequest? | Maybe<ReturnRequestPayload> | (Optional) A customer’s return request that hasn’t been approved or declined. This mutation sets the value of the Return.status field to REQUESTED. To create a return that has the Return.status field set to OPEN, use the returnCreate mutation. |
|
| reverseDeliveryCreateWithShipping? | Maybe<ReverseDeliveryCreateWithShippingPayload> | (Optional) Creates a new reverse delivery with associated external shipping information. | |
| reverseDeliveryDispose? | Maybe<ReverseDeliveryDisposePayload> | (Optional) Disposes reverse delivery line items for a reverse delivery on the same shop. | |
| reverseDeliveryShippingUpdate? | Maybe<ReverseDeliveryShippingUpdatePayload> | (Optional) Updates a reverse delivery with associated external shipping information. | |
| reverseFulfillmentOrderDispose? | Maybe<ReverseFulfillmentOrderDisposePayload> | (Optional) Disposes reverse fulfillment order line items. | |
| savedSearchCreate? | Maybe<SavedSearchCreatePayload> | (Optional) Creates a saved search. | |
| savedSearchDelete? | Maybe<SavedSearchDeletePayload> | (Optional) Delete a saved search. | |
| savedSearchUpdate? | Maybe<SavedSearchUpdatePayload> | (Optional) Updates a saved search. | |
| scriptTagCreate? | Maybe<ScriptTagCreatePayload> | <p>(Optional) <div class="note"><h4>Theme app extensions</h4> <p>Your app might not pass App Store review if it uses script tags instead of theme app extensions. All new apps, and apps that integrate with Online Store 2.0 themes, should use theme app extensions, such as app blocks or app embed blocks. Script tags are an alternative you can use with only vintage themes. Learn more.</p></div></p><p>Creates a new script tag.</p> | |
| scriptTagDelete? | Maybe<ScriptTagDeletePayload> | <p>(Optional) <div class="note"><h4>Theme app extensions</h4> <p>Your app might not pass App Store review if it uses script tags instead of theme app extensions. All new apps, and apps that integrate with Online Store 2.0 themes, should use theme app extensions, such as app blocks or app embed blocks. Script tags are an alternative you can use with only vintage themes. Learn more.</p></div></p><p>Deletes a script tag.</p> | |
| scriptTagUpdate? | Maybe<ScriptTagUpdatePayload> | <p>(Optional) <div class="note"><h4>Theme app extensions</h4> <p>Your app might not pass App Store review if it uses script tags instead of theme app extensions. All new apps, and apps that integrate with Online Store 2.0 themes, should use theme app extensions, such as app blocks or app embed blocks. Script tags are an alternative you can use with only vintage themes. Learn more.</p></div></p><p>Updates a script tag.</p> | |
| segmentCreate? | Maybe<SegmentCreatePayload> | (Optional) Creates a segment. | |
| segmentDelete? | Maybe<SegmentDeletePayload> | (Optional) Deletes a segment. | |
| segmentUpdate? | Maybe<SegmentUpdatePayload> | (Optional) Updates a segment. | |
| sellingPlanGroupAddProducts? | Maybe<SellingPlanGroupAddProductsPayload> | (Optional) Adds multiple products to a selling plan group. | |
| sellingPlanGroupAddProductVariants? | Maybe<SellingPlanGroupAddProductVariantsPayload> | (Optional) Adds multiple product variants to a selling plan group. | |
| sellingPlanGroupCreate? | Maybe<SellingPlanGroupCreatePayload> | (Optional) Creates a Selling Plan Group. | |
| sellingPlanGroupDelete? | Maybe<SellingPlanGroupDeletePayload> | (Optional) Delete a Selling Plan Group. | |
| sellingPlanGroupRemoveProducts? | Maybe<SellingPlanGroupRemoveProductsPayload> | (Optional) Removes multiple products from a selling plan group. | |
| sellingPlanGroupRemoveProductVariants? | Maybe<SellingPlanGroupRemoveProductVariantsPayload> | (Optional) Removes multiple product variants from a selling plan group. | |
| sellingPlanGroupUpdate? | Maybe<SellingPlanGroupUpdatePayload> | (Optional) Update a Selling Plan Group. | |
| serverPixelCreate? | Maybe<ServerPixelCreatePayload> | (Optional) Creates a new unconfigured server pixel. A single server pixel can exist for an app and shop combination. If you call this mutation when a server pixel already exists, then an error will return. | |
| serverPixelDelete? | Maybe<ServerPixelDeletePayload> | (Optional) Deletes the Server Pixel associated with the current app & shop. | |
| shippingPackageDelete? | Maybe<ShippingPackageDeletePayload> | (Optional) Deletes a shipping package. | |
| shippingPackageMakeDefault? | Maybe<ShippingPackageMakeDefaultPayload> | (Optional) Set a shipping package as the default. The default shipping package is the one used to calculate shipping costs on checkout. | |
| shippingPackageUpdate? | Maybe<ShippingPackageUpdatePayload> | (Optional) Updates a shipping package. | |
| shopLocaleDisable? | Maybe<ShopLocaleDisablePayload> | (Optional) Deletes a locale for a shop. This also deletes all translations of this locale. | |
| shopLocaleEnable? | Maybe<ShopLocaleEnablePayload> | (Optional) Adds a locale for a shop. The newly added locale is in the unpublished state. | |
| shopLocaleUpdate? | Maybe<ShopLocaleUpdatePayload> | (Optional) Updates a locale for a shop. | |
| shopPolicyUpdate? | Maybe<ShopPolicyUpdatePayload> | (Optional) Updates a shop policy. | |
| shopResourceFeedbackCreate? | Maybe<ShopResourceFeedbackCreatePayload> | <p>(Optional) The ResourceFeedback object lets your app report the status of shops and their resources. For example, if your app is a marketplace channel, then you can use resource feedback to alert merchants that they need to connect their marketplace account by signing in.</p><p>Resource feedback notifications are displayed to the merchant on the home screen of their Shopify admin, and in the product details view for any products that are published to your app.</p><p>This resource should be used only in cases where you’re describing steps that a merchant is required to complete. If your app offers optional or promotional set-up steps, or if it makes recommendations, then don’t use resource feedback to let merchants know about them.</p><p>## Sending feedback on a shop</p><p>You can send resource feedback on a shop to let the merchant know what steps they need to take to make sure that your app is set up correctly. Feedback can have one of two states: requires_action or success. You need to send a requires_action feedback request for each step that the merchant is required to complete.</p><p>If there are multiple set-up steps that require merchant action, then send feedback with a state of requires_action as merchants complete prior steps. And to remove the feedback message from the Shopify admin, send a success feedback request.</p><p>#### Important Sending feedback replaces previously sent feedback for the shop. Send a new shopResourceFeedbackCreate mutation to push the latest state of a shop or its resources to Shopify.</p> |
|
| stagedUploadsCreate? | Maybe<StagedUploadsCreatePayload> | <p>(Optional) Creates staged upload targets for each input. This is the first step in the upload process. The returned staged upload targets’ URL and parameter fields can be used to send a request to upload the file described in the corresponding input.</p><p>For more information on the upload process, refer to [Upload media to Shopify](https://shopify.dev/apps/online-store/media/products#step-1-upload-media-to-shopify).</p> | |
| stagedUploadTargetGenerate? | Maybe<StagedUploadTargetGeneratePayload> | (Optional) Generates the URL and signed paramaters needed to upload an asset to Shopify. | |
| stagedUploadTargetsGenerate? | Maybe<StagedUploadTargetsGeneratePayload> | (Optional) Uploads multiple images. | |
| standardMetafieldDefinitionEnable? | Maybe<StandardMetafieldDefinitionEnablePayload> | <p>(Optional) Activates the specified standard metafield definition from its template.</p><p>Refer to the [list of standard metafield definition templates](https://shopify.dev/apps/metafields/definitions/standard-definitions).</p> | |
| standardMetaobjectDefinitionEnable? | Maybe<StandardMetaobjectDefinitionEnablePayload> | (Optional) Enables the specified standard metaobject definition from its template. | |
| storefrontAccessTokenCreate? | Maybe<StorefrontAccessTokenCreatePayload> | (Optional) Creates a storefront access token. An app can have a maximum of 100 active storefront access tokens for each shop. | |
| storefrontAccessTokenDelete? | Maybe<StorefrontAccessTokenDeletePayload> | (Optional) Deletes a storefront access token. | |
| subscriptionBillingAttemptCreate? | Maybe<SubscriptionBillingAttemptCreatePayload> | (Optional) Creates a new subscription billing attempt. For more information, refer to [Create a subscription contract](https://shopify.dev/docs/apps/selling-strategies/subscriptions/contracts/create#step-4-create-a-billing-attempt). | |
| subscriptionBillingCycleContractDraftCommit? | Maybe<SubscriptionBillingCycleContractDraftCommitPayload> | (Optional) Commits the updates of a Subscription Billing Cycle Contract draft. | |
| subscriptionBillingCycleContractDraftConcatenate? | Maybe<SubscriptionBillingCycleContractDraftConcatenatePayload> | (Optional) Concatenates a contract to a Subscription Draft. | |
| subscriptionBillingCycleContractEdit? | Maybe<SubscriptionBillingCycleContractEditPayload> | (Optional) Edit the contents of a subscription contract for the specified billing cycle. | |
| subscriptionBillingCycleEditDelete? | Maybe<SubscriptionBillingCycleEditDeletePayload> | (Optional) Delete the schedule and contract edits of the selected subscription billing cycle. | |
| subscriptionBillingCycleEditsDelete? | Maybe<SubscriptionBillingCycleEditsDeletePayload> | (Optional) Delete the current and future schedule and contract edits of a list of subscription billing cycles. | |
| subscriptionBillingCycleScheduleEdit? | Maybe<SubscriptionBillingCycleScheduleEditPayload> | (Optional) Modify the schedule of a specific billing cycle. | |
| subscriptionContractAtomicCreate? | Maybe<SubscriptionContractAtomicCreatePayload> | (Optional) Creates a Subscription Contract. | |
| subscriptionContractCreate? | Maybe<SubscriptionContractCreatePayload> | (Optional) Creates a Subscription Contract. | |
| subscriptionContractProductChange? | Maybe<SubscriptionContractProductChangePayload> | (Optional) Allows for the easy change of a Product in a Contract or a Product price change. | |
| subscriptionContractSetNextBillingDate? | Maybe<SubscriptionContractSetNextBillingDatePayload> | (Optional) Sets the next billing date of a Subscription Contract. | |
| subscriptionContractUpdate? | Maybe<SubscriptionContractUpdatePayload> | (Optional) Updates a Subscription Contract. | |
| subscriptionDraftCommit? | Maybe<SubscriptionDraftCommitPayload> | (Optional) Commits the updates of a Subscription Contract draft. | |
| subscriptionDraftDiscountAdd? | Maybe<SubscriptionDraftDiscountAddPayload> | (Optional) Adds a subscription discount to a subscription draft. | |
| subscriptionDraftDiscountCodeApply? | Maybe<SubscriptionDraftDiscountCodeApplyPayload> | (Optional) Applies a code discount on the subscription draft. | |
| subscriptionDraftDiscountRemove? | Maybe<SubscriptionDraftDiscountRemovePayload> | (Optional) Removes a subscription discount from a subscription draft. | |
| subscriptionDraftDiscountUpdate? | Maybe<SubscriptionDraftDiscountUpdatePayload> | (Optional) Updates a subscription discount on a subscription draft. | |
| subscriptionDraftFreeShippingDiscountAdd? | Maybe<SubscriptionDraftFreeShippingDiscountAddPayload> | (Optional) Adds a subscription free shipping discount to a subscription draft. | |
| subscriptionDraftFreeShippingDiscountUpdate? | Maybe<SubscriptionDraftFreeShippingDiscountUpdatePayload> | (Optional) Updates a subscription free shipping discount on a subscription draft. | |
| subscriptionDraftLineAdd? | Maybe<SubscriptionDraftLineAddPayload> | (Optional) Adds a subscription line to a subscription draft. | |
| subscriptionDraftLineRemove? | Maybe<SubscriptionDraftLineRemovePayload> | (Optional) Removes a subscription line from a subscription draft. | |
| subscriptionDraftLineUpdate? | Maybe<SubscriptionDraftLineUpdatePayload> | (Optional) Updates a subscription line on a subscription draft. | |
| subscriptionDraftUpdate? | Maybe<SubscriptionDraftUpdatePayload> | (Optional) Updates a Subscription Draft. | |
| tagsAdd? | Maybe<TagsAddPayload> | (Optional) Add tags to an order, a draft order, a customer, a product, or an online store article. | |
| tagsRemove? | Maybe<TagsRemovePayload> | (Optional) Remove tags from an order, a draft order, a customer, a product, or an online store article. | |
| taxAppConfigure? | Maybe<TaxAppConfigurePayload> | (Optional) Allows tax app configurations for tax partners. | |
| translationsRegister? | Maybe<TranslationsRegisterPayload> | (Optional) Creates or updates translations. | |
| translationsRemove? | Maybe<TranslationsRemovePayload> | (Optional) Deletes translations. | |
| urlRedirectBulkDeleteAll? | Maybe<UrlRedirectBulkDeleteAllPayload> | (Optional) Asynchronously delete [URL redirects](https://shopify.dev/api/admin-graphql/latest/objects/UrlRedirect) in bulk. | |
| urlRedirectBulkDeleteByIds? | Maybe<UrlRedirectBulkDeleteByIdsPayload> | (Optional) Asynchronously delete [URLRedirect](https://shopify.dev/api/admin-graphql/latest/objects/UrlRedirect) objects in bulk by IDs. Learn more about [URLRedirect](https://help.shopify.com/en/manual/online-store/menus-and-links/url-redirect) objects. | |
| urlRedirectBulkDeleteBySavedSearch? | Maybe<UrlRedirectBulkDeleteBySavedSearchPayload> | (Optional) Asynchronously delete redirects in bulk. | |
| urlRedirectBulkDeleteBySearch? | Maybe<UrlRedirectBulkDeleteBySearchPayload> | (Optional) Asynchronously delete redirects in bulk. | |
| urlRedirectCreate? | Maybe<UrlRedirectCreatePayload> | (Optional) Creates a [UrlRedirect](https://shopify.dev/api/admin-graphql/latest/objects/UrlRedirect) object. |
|
| urlRedirectDelete? | Maybe<UrlRedirectDeletePayload> | (Optional) Deletes a [UrlRedirect](https://shopify.dev/api/admin-graphql/latest/objects/UrlRedirect) object. |
|
| urlRedirectImportCreate? | Maybe<UrlRedirectImportCreatePayload> | <p>(Optional) Creates a [UrlRedirectImport](https://shopify.dev/api/admin-graphql/latest/objects/UrlRedirectImport) object.</p><p>After creating the UrlRedirectImport object, the UrlRedirectImport request can be performed using the [urlRedirectImportSubmit](https://shopify.dev/api/admin-graphql/latest/mutations/urlRedirectImportSubmit) mutation.</p> |
|
| urlRedirectImportSubmit? | Maybe<UrlRedirectImportSubmitPayload> | <p>(Optional) Submits a UrlRedirectImport request to be processed.</p><p>The UrlRedirectImport request is first created with the [urlRedirectImportCreate](https://shopify.dev/api/admin-graphql/latest/mutations/urlRedirectImportCreate) mutation.</p> |
|
| urlRedirectUpdate? | Maybe<UrlRedirectUpdatePayload> | (Optional) Updates a URL redirect. | |
| webhookSubscriptionCreate? | Maybe<WebhookSubscriptionCreatePayload> | (Optional) Creates a new webhook subscription. | |
| webhookSubscriptionDelete? | Maybe<WebhookSubscriptionDeletePayload> | (Optional) Deletes a webhook subscription. | |
| webhookSubscriptionUpdate? | Maybe<WebhookSubscriptionUpdatePayload> | (Optional) Updates a webhook subscription. | |
| webPixelCreate? | Maybe<WebPixelCreatePayload> | (Optional) Creates a new web pixel settings. | |
| webPixelDelete? | Maybe<WebPixelDeletePayload> | (Optional) Deletes the web pixel shop settings. | |
| webPixelUpdate? | Maybe<WebPixelUpdatePayload> | (Optional) Updates the web pixel settings. |