📄️ AbstractOrderSellerReportType
No description
📄️ AbstractPercentReportType
No description
📄️ AbstractProductVariantType
No description
📄️ AccountAddressCreate
Create a new address for the customer.
📄️ AccountAddressDelete
Delete an address of the logged-in user.
📄️ AccountAddressSetDefault
Sets a default address for the authenticated user.
📄️ AccountAddressUpdate
Updates an address of the logged-in user.
📄️ AccountConfirm
Confirm user account with token sent by email during registration.
📄️ AccountDelete
Remove user account.
📄️ AccountError
No description
📄️ AccountRegister
Register a new user.
📄️ AccountRequestDeletion
Sends an email with the account removal link for the logged-in user.
📄️ AccountUpdate
Updates the account of the logged-in user.
📄️ AddressCreate
Creates user address.
📄️ AddressDelete
Deletes an address.
📄️ AddressSetDefault
Sets a default address for the given user.
📄️ AddressUpdate
Updates an address.
📄️ Address
Represents user address data.
📄️ AgreementBulkDelete
Deletes agreements.
📄️ AgreementBulkPublish
Publish agreements.
📄️ AgreementCommissionCreate
Creates a new agreement commission.
📄️ AgreementCommissionDelete
Deletes an agreement commission.
📄️ AgreementCommission
An agreement commission
📄️ AgreementCountableConnection
No description
📄️ AgreementCountableEdge
No description
📄️ AgreementCreate
Creates a new agreement.
📄️ AgreementDelete
Deletes a agreement.
📄️ AgreementError
No description
📄️ AgreementFeeCreate
Creates a new agreement fee.
📄️ AgreementFeeDelete
Deletes an agreement fee.
📄️ AgreementFees
Extra fees associated with an agreement
📄️ AgreementSellersCountableConnection
No description
📄️ AgreementSellersCountableEdge
No description
📄️ AgreementSellers
A seller agreement mapping
📄️ AgreementUpdate
Updates an existing agreement.
📄️ Agreement
A marketplace agreement created, edited and maintianed in the dashboard
📄️ Allocation
Represents allocation.
📄️ AnalyticsExportCSV
Generate analytics CSV export and return a signed download URL. The URL provides direct access to the file in cloud storage.
📄️ AnalyticsExportError
Error type for analytics export mutations.
📄️ AnalyticsExportUrl
Get a download URL for analytics CSV export. The URL triggers a synchronous download - navigate to it to download the file.
📄️ AppActivate
Activate the app.
📄️ AppCountableConnection
No description
📄️ AppCountableEdge
No description
📄️ AppCreate
Creates a new app.
📄️ AppDashboardIntegrationCreate
Creates a new dashboard integration for an app.
📄️ AppDashboardIntegrationDelete
Deletes an app storefront integration from the app.
📄️ AppDashboardIntegration
Represents a dashboard integration for an App.
📄️ AppDeactivate
Deactivate the app.
📄️ AppDelete
Deletes an app.
📄️ AppError
No description
📄️ AppStorefrontIntegrationCreate
Creates a new storefront integration for an app.
📄️ AppStorefrontIntegrationDelete
Deletes an app storefront integration from the app.
📄️ AppStorefrontIntegration
Represents a storefront integration for an App.
📄️ AppTokenCreate
Creates a new token.
📄️ AppTokenDelete
Deletes an authentication token assigned to app.
📄️ AppTokenVerify
Verify provided app token.
📄️ AppToken
Represents token data.
📄️ AppUpdate
Updates an existing app.
📄️ App
Represents app data.
📄️ AttributeAssign
Assign attributes to a given product or product type.
📄️ AttributeBulkDelete
Deletes attributes.
📄️ AttributeCountableConnection
No description
📄️ AttributeCountableEdge
No description
📄️ AttributeCreate
Creates an attribute.
📄️ AttributeDelete
Deletes an attribute.
📄️ AttributeError
No description
📄️ AttributeUnassignFromProductType
Un-assign attributes from a given product type.
📄️ AttributeUnassign
Un-assign attributes from a given product type.
📄️ AttributeUpdate
Updates attribute.
📄️ AttributeValueBulkCreate
Creates attribute values for a given attribute.
📄️ AttributeValueBulkDelete
Deletes values of attributes.
📄️ AttributeValueCountableConnection
No description
📄️ AttributeValueCountableEdge
No description
📄️ AttributeValueCreate
Creates a value for an attribute.
📄️ AttributeValueDelete
Deletes a value of an attribute.
📄️ AttributeValueUpdate
Updates value of an attribute.
📄️ AttributeValue
Represents a value of an attribute.
📄️ AttributeValuesReorder
Reorder the values of an attribute.
📄️ AttributeWarningMessageItem
No description
📄️ Attribute
Custom attribute of a product. Attributes can be assigned to products and variants at the product type level.
📄️ AuthError
No description
📄️ AuthURLGenerate
Create authorization URL.
📄️ AvalaraRequestLogCountableConnection
No description
📄️ AvalaraRequestLogCountableEdge
No description
📄️ AvalaraRequestLog
Represents products import process from 3rd party service or integration.
📄️ BigQueryCustomerReportType
No description
📄️ BigQueryDailyOrderCountsReportType
No description
📄️ BigQueryNetSalesByCategoryReportType
No description
📄️ BigQueryNetSalesBySellerReportType
No description
📄️ BigQueryOrdersBySellerReportType
No description
📄️ BigQueryOrdersByStatusReportType
No description
📄️ BigQueryPayoutReportType
No description
📄️ BigQuerySalesPerDayReportType
No description
📄️ BigQuerySellerOrdersReportType
No description
📄️ BigQuerySellerPayoutReportType
No description
📄️ BigQueryThirtySixtyNinetyReportType
No description
📄️ BigQueryVariantListReportType
No description
📄️ BulkProductError
No description
📄️ BulkProductImageError
No description
📄️ BulkProductVideoError
No description
📄️ BulkStockError
No description
📄️ CatalogExport
Export catalog.
📄️ CategoryBulkDelete
Deletes categories.
📄️ CategoryCountableConnection
No description
📄️ CategoryCountableEdge
No description
📄️ CategoryCreate
Creates a new category.
📄️ CategoryDelete
Deletes a category.
📄️ CategoryIdentity
GraphQL type for CategoryIdentitySchema
📄️ CategoryUpdate
Updates a category.
📄️ Category
Represents a single category of products. Categories allow to organize products in a tree-hierarchies which can be used for navigation in the storefront.
📄️ CheckoutAddPONumbers
Adds purchase order number to a checkout.
📄️ CheckoutAddPromoCode
Adds a gift card or a voucher to a checkout.
📄️ CheckoutBillingAddressUpdate
Update billing address in the existing checkout.
📄️ CheckoutComplete
Completes the checkout. As a result a new order is created and a payment charge is made. This action requires a successful payment before it can be performed. In case additional confirmation step as 3D secure is required confirmationNeeded flag will be set to True and no order created until payment is confirmed with second call of this mutation.
📄️ CheckoutCountableConnection
No description
📄️ CheckoutCountableEdge
No description
📄️ CheckoutCreate
Create a new checkout.
📄️ CheckoutCustomerAttach
Sets the customer as the owner of the checkout.
📄️ CheckoutCustomerDetach
Removes the user assigned as the owner of the checkout.
📄️ CheckoutDelete
Deletes a checkout.
📄️ CheckoutEmailUpdate
Updates email address in the existing checkout object.
📄️ CheckoutError
No description
📄️ CheckoutEventCountableConnection
No description
📄️ CheckoutEventCountableEdge
No description
📄️ CheckoutEventTriggered
Create a checkout event.
📄️ CheckoutEvent
Represents checkout event.
📄️ CheckoutLineAddNote
Add a note to a checkout line.
📄️ CheckoutLineCountableConnection
No description
📄️ CheckoutLineCountableEdge
No description
📄️ CheckoutLineDelete
Deletes a CheckoutLine.
📄️ CheckoutLine
Represents an item in the checkout.
📄️ CheckoutLinesAdd
Adds a checkout line to the existing checkout.
📄️ CheckoutLinesUpdate
Updates checkout line in the existing checkout.
📄️ CheckoutMarketplaceShippingMethodUpdate
Updates the marketplace shipping methods of the checkout.
📄️ CheckoutNoteUpdate
Updates the checkout note on the provided checkout.
📄️ CheckoutPaymentCreate
Create a new payment for given checkout.
📄️ CheckoutRemovePONumbers
Remove a purchase order from a checkout.
📄️ CheckoutRemovePromoCode
Remove a gift card or a voucher from a checkout.
📄️ CheckoutSellerShippingMethodsBulkUpdate
Bulk clears the seller shipping methods of the checkout.
📄️ CheckoutSellerShippingMethodsClear
Clears the seller shipping methods of the checkout.
📄️ CheckoutSellerShippingMethodsUpdate
Updates the seller shipping methods of the checkout.
📄️ CheckoutSellerShipping
Represents an shipping method for a particular seller on a checkout.
📄️ CheckoutSetTransactionCurrency
Update currency in the existing checkout object.
📄️ CheckoutShippingAddressUpdate
Update shipping address in the existing checkout.
📄️ CheckoutThemeCreate
Create a new checkout theme.
📄️ CheckoutThemeUpdate
Update a checkout theme.
📄️ CheckoutTheme
Represents a checkout page's options.
📄️ Checkout
Checkout object.
📄️ CollectionAddProducts
Adds products to a collection.
📄️ CollectionAddVariants
Adds variants to a collection.
📄️ CollectionBulkDelete
Deletes collections.
📄️ CollectionBulkPublish
Publish collections.
📄️ CollectionCountableConnection
No description
📄️ CollectionCountableEdge
No description
📄️ CollectionCreate
Creates a new collection.
📄️ CollectionDelete
Deletes a collection.
📄️ CollectionRemoveProducts
Remove products from a collection.
📄️ CollectionRemoveVariants
Remove variants from a collection.
📄️ CollectionReorderProducts
Reorder the products of a collection.
📄️ CollectionUpdate
Updates a collection.
📄️ Collection
Represents a collection of products.
📄️ ColumnObjectType
No description
📄️ ConfigurationItem
Stores information about a single configuration field.
📄️ ContentCountableConnection
No description
📄️ ContentCountableEdge
No description
📄️ ContentCreate
Creates a new content object.
📄️ ContentDelete
Deletes a voucher.
📄️ ContentDiscard
Discards the latest changes of a content object.
📄️ ContentDuplicate
Duplicate an existing content object.
📄️ ContentPageDataCreate
Creates a content page data object.
📄️ ContentPageDataUpdate
Updates a content page data object.
📄️ ContentPageData
Content page data.
📄️ ContentPublish
Publishes a content object.
📄️ ContentSave
Auto saves a content object.
📄️ Content
Content object.
📄️ CountryArea
No description
📄️ CountryDisplay
No description
📄️ CreateCustomerToken
Creates a new Nautical customer token.
📄️ CreateImportFile
Upload CSV file for product import and parse its structure.
📄️ CreditCard
No description
📄️ CSVMetadata
CSV file metadata extracted during parsing.
📄️ CustomAttributeAssign
Assign attributes to a given custom field template.
📄️ CustomAttributeUnassign
Un-assign attributes from a given custom field template.
📄️ CustomDomainCreate
Creates a custom domain
📄️ CustomDomainDelete
Deletes a custom domain
📄️ CustomDomain
No description
📄️ CustomFieldTemplate
Represents a type of custom field set. It defines what attributes are available to instances of this type.
📄️ CustomerBulkDelete
Deletes customers.
📄️ CustomerCreate
Creates a new customer.
📄️ CustomerDelete
Deletes a customer.
📄️ CustomerEvent
History log of the customer.
📄️ CustomerReportRowType
No description
📄️ CustomerUpdate
Updates an existing customer.
📄️ DailyOrderCountReportType
No description
📄️ DashboardGraphType
No description
📄️ DashboardOrdersSummaryType
No description
📄️ DashboardSellerOrderPerformanceType
No description
📄️ DashboardTopSellerPerformanceType
No description
📄️ DefaultSellerChecklist
No description
📄️ DesignerDataCreate
Create designer data.
📄️ DesignerDataType
No description
📄️ DesignerDataUpdate
Update existing designer data.
📄️ DigitalContentCountableConnection
No description
📄️ DigitalContentCountableEdge
No description
📄️ DigitalContentCreate
Create new digital content. This mutation must be sent as a multipart request. More detailed specs of the upload format can be found here//github.com/jaydenseric/graphql-multipart-request-spec
📄️ DigitalContentDelete
Remove digital content assigned to given variant.
📄️ DigitalContentUpdate
Update digital content.
📄️ DigitalContentUrlCreate
Generate new URL to digital content.
📄️ DigitalContentUrl
No description
📄️ DigitalContent
No description
📄️ DiscountError
No description
📄️ DjangoDebugException
Represents a single exception raised.
📄️ DjangoDebugSQL
Represents a single database query made to a Django managed DB.
📄️ DjangoDebug
Debugging information for the current query.
📄️ DocumentAdd
Add or attach a document to any allowed entity (note: consider to use DocumentAttach for 'attach' action). Must only receive one of either file or document_id in input.
📄️ DocumentAttach
Attach a document to any allowed entities.
📄️ DocumentError
No description
📄️ DocumentRemove
Delete or detach a document. Must only receive one of either target_ids or delete = True in input.
📄️ DocumentUpdate
Updates an existing document.
📄️ Document
Document
📄️ Domain
Represents shop's domain.
📄️ DraftOrderBulkDelete
Deletes draft order.
📄️ DraftOrderComplete
Completes creating an order.
📄️ DraftOrderCreate
Creates a new draft order.
📄️ DraftOrderDelete
Deletes a draft order.
📄️ DraftOrderLineDelete
Deletes an order line from a draft or quote order.
📄️ DraftOrderLinePriceOverride
Overrides unit net price of an order line of a draft or quote order.
📄️ DraftOrderLineUpdate
Updates an order line of a draft or quote order.
📄️ DraftOrderLinesBulkDelete
Deletes order lines.
📄️ DraftOrderLinesCreate
Create order lines for draft or quote orders.
📄️ DraftOrderSetTransactionCurrency
Update currency in the existing draft order object.
📄 ️ DraftOrderUpdate
Updates a draft order.
📄️ EmailChangeConfirm
Confirm the email change of the logged-in user.
📄️ EmailChangeRequest
Request email change for the current user.
📄️ EmailEventCountableConnection
No description
📄️ EmailEventCountableEdge
No description
📄️ EmailEvent
History log of all emails.
📄️ EmailTemplateCountableConnection
No description
📄️ EmailTemplateCountableEdge
No description
📄️ EmailTemplatePreview
Represents an email template preview.
📄️ EmailTemplateUpdate
EmailTemplate update mutation.
📄️ EmailTemplate
Represents an email template.
📄️ Event
Event object for all models.
📄️ ExchangeRatesRefresh
Refreshes currency exchange rates. Must have a currency exchange app enabled in the app marketplace.
📄️ ExportError
No description
📄️ ExportEvent
History log of export file.
📄️ ExportFileCountableConnection
No description
📄️ ExportFileCountableEdge
No description
📄️ ExportFile
Represents a job data of exported file.
📄️ FileSize
Represents amount of bytes in common formats.
📄️ File
Represents an uploaded file.
📄️ FilterObjectType
No description
📄️ FinancialError
No description
📄️ FinancialsCategoryCommission
No description
📄️ FinancialsFee
No description
📄️ FinancialsSnapshot
No description
📄️ FontCountableConnection
No description
📄️ FontCountableEdge
No description
📄️ Font
Font for a storefront.
📄️ FulfillmentBulkReturn
Processes return requests by grabbing the return status and
📄️ FulfillmentCancel
Cancels existing fulfillment and optionally restocks items.
📄️ FulfillmentCountableConnection
No description
📄️ FulfillmentCountableEdge
No description
📄️ FulfillmentLine
Represents line of the fulfillment.
📄️ FulfillmentReturnStatusBulkUpdate
Updated return status of existing fulfillment and optionally restocks items.
📄️ FulfillmentReturn
Returns selected quantity from fulfillment lines and restocks items.
📄️ FulfillmentUpdateTracking
Updates a fulfillment for an order.
📄️ Fulfillment
Represents order fulfillment.
📄️ GatewayConfigLine
Payment gateway client configuration key and value pair.
📄️ Geolocalization
Represents customers's geolocalization data.
📄️ GraphDataType
No description
📄️ GroupCountableConnection
No description
📄️ GroupCountableEdge
No description
📄️ Group
Represents permission group data.
📄️ Image
Represents an image.
📄️ ImportEvent
History log of import file.
📄️ ImportFileCountableConnection
No description
📄️ ImportFileCountableEdge
No description
📄️ ImportFile
Represents a job data of exported file.
📄️ InReportTopPerformingCategoriesType
No description
📄️ InReportTopPerformingProductsType
No description
📄️ InstanceAttributeUnassign
Unassign the specified attribute from an instance.
📄️ InvoiceCancel
Cancels an invoice.
📄️ InvoiceCreate
Creates a ready to send invoice.
📄️ InvoiceDelete
Deletes an invoice.
📄️ InvoiceError
No description
📄️ InvoiceFinalize
Finalizes an invoice.
📄️ InvoiceRefresh
Refreshes an invoice.
📄️ InvoiceRequestDelete
Requests deletion of an invoice.
📄️ InvoiceRequest
Request an invoice for the order using plugin.
📄️ InvoiceSendNotification
Send an invoice notification to the customer.
📄️ InvoiceUpdate
Updates an invoice.
📄️ Invoice
Represents an Invoice.
📄️ JournalEntryCorrect
Correct a previous journal entry by supplying
📄️ JournalEntryCountableConnection
No description
📄️ JournalEntryCountableEdge
No description
📄️ JournalEntry
Represents a journal entry in the system
📄️ LedgerCountableConnection
No description
📄️ LedgerCountableEdge
No description
📄️ LedgerEntry
Represents a ledger entry in the system
📄️ Ledger
Represents a ledger in the system
📄️ Margin
No description
📄️ MarketplaceConfigurationError
No description
📄️ MarketplaceConfigurationUpdate
Updates marketplace configuration.
📄️ MarketplaceConfiguration
Represents a marketplace configuration resource.
📄️ MarketplaceSubscriptionCountableConnection
No description
📄️ MarketplaceSubscriptionCountableEdge
No description
📄️ MarketplaceSubscription
Represents a marketplace subscription.
📄️ MediaBulkDelete
Deletes medias.
📄️ MediaCountableConnection
No description
📄️ MediaCountableEdge
No description
📄️ MediaCreate
Creates a new media object.
📄️ MediaUpdate
Update a media object.
📄️ Media
Media object.
📄️ MenuBulkDelete
Deletes menus.
📄️ MenuCountableConnection
No description
📄️ MenuCountableEdge
No description
📄️ MenuCreate
Creates a new Menu.
📄️ MenuDelete
Deletes a menu.
📄️ MenuError
No description
📄️ MenuItemBulkDelete
Deletes menu items.
📄️ MenuItemCountableConnection
No description
📄️ MenuItemCountableEdge
No description
📄️ MenuItemCreate
Creates a new menu item.
📄️ MenuItemDelete
Deletes a menu item.
📄️ MenuItemMove
Moves items of menus.
📄️ MenuItemUpdate
Updates a menu item.
📄️ MenuItem
Represents a single item of the related menu. Can store categories, collection, pages, sellers, products, content or policy pages.
📄️ MenuUpdate
Updates a menu.
📄️ Menu
Represents a single menu - an object that is used to help navigate through the store.
📄️ MetadataDelete
Delete metadata of an object.
📄️ MetadataError
No description
📄️ MetadataItem
No description
📄️ MetadataUpdate
Updates metadata of an object.
📄️ MoneyRange
Represents a range of amounts of money.
📄️ Money
Represents amount of money in specific currency.
📄️ MultiSellerShippingMethod
No description
📄️ NauticalConfigurationError
No description
📄️ NauticalConfigurationUpdate
Updates nautical configuration.
📄️ NauticalConfiguration
Represents a nautical configuration resource.
📄️ NauticalCurrency
No description
📄️ NauticalDraftOrderBulkDelete
Deletes draft orders.
📄️ NauticalDraftOrderComplete
Completes creating an order.
📄️ NauticalDraftOrderCreate
Creates a new Nautical draft order.
📄️ NauticalDraftOrderDelete
Deletes a draft order.
📄️ NauticalDraftOrderLineDelete
Deletes an order line from a draft or quote order.
📄️ NauticalDraftOrderLinePriceOverride
Overrides unit net price of a marketplace order line of a draft, or quote order.
📄️ NauticalDraftOrderLineUpdate
Updates an order line of a draft order.
📄️ NauticalDraftOrderLinesBulkDelete
Deletes order lines.
📄️ NauticalDraftOrderLinesCreate
Create order lines for a draft or quote order.
📄️ NauticalDraftOrderSetTransactionCurrency
Update currency in the existing nautical draft order object, related nautical order lines, child order and their lines.
📄️ NauticalDraftOrderUpdate
Updates a draft or quote nautical order.
📄️ NauticalOrderAddNote
Adds note to the order.
📄️ NauticalOrderBulkAssignCustomer
Adds customers to orders that are not attached to existing customers.
📄️ NauticalOrderCancel
Cancel an order.
📄️ NauticalOrderCapture
Capture a nautical order.
📄️ NauticalOrderCountableConnection
No description
📄️ NauticalOrderCountableEdge
No description
📄️ NauticalOrderEventOrderLineObject
No description
📄️ NauticalOrderEvent
History log of the order.
📄️ NauticalOrderFulfill
Creates new fulfillments for a nautical order.
📄️ NauticalOrderLineAddNote
Add a note to a nautical order line.
📄️ NauticalOrderLineBulkCancel
Cancels nautical order lines, associated order lines, and removes allocations for that order line.
📄️ NauticalOrderLine
Represents order line of particular order.
📄️ NauticalOrderLinesCsvUpload
Uploads lines for a draft order via CSV. This mutation must be sent as a multipart request. More detailed specs of the upload format can be found here//github.com/jaydenseric/graphql-multipart-request-spec
📄️ NauticalOrderMarkAsPaid
Mark order as manually paid.
📄️ NauticalOrderPaymentCreate
Create and process a new payment for given nautical order. Be aware that in nautical orders flow, payment will be handled as part of this mutation; while in checkout flow, it will be processed as part of CheckoutComplete mutation.
📄️ NauticalOrderRefreshTaxes
Attempts to force a refresh of the existing taxes on a non-placed nautical order.
📄️ NauticalOrderUpdateApplyVoucherCode
Apply an existing voucher code to a nautical order to give a discount.
📄️ NauticalOrderUpdateDeleteDiscount
Remove a discount from a nautical order.
📄️ NauticalOrderUpdateMarketplaceShipping
Updates a marketplace shipping method of the order.
📄️ NauticalOrderUpdateShipping
Updates a shipping method of the order.
📄️ NauticalOrderUpdate
Updates an order.
📄️ NauticalOrderVoid
Void a nautical order.
📄️ NauticalOrder
Represents a nautical order in the shop.
📄️ NauticalPaymentLinkSendToCustomer
Sends a payment link to a customer.
📄️ NauticalQuoteOrderSendToCustomer
Sends a quote order to a customer.
📄️ NetSalesByCategoryType
No description
📄️ NetSalesBySellerType
No description
📄️ NotificationError
No description
📄️ OrderAddNote
Adds note to the order.
📄️ OrderBulkCancel
Cancels orders.
📄️ OrderCancel
Cancel an order.
📄️ OrderCountableConnection
No description
📄️ OrderCountableEdge
No description
📄️ OrderDeclineFulfillment
Decline (permanently) part of an order. The buyer will not be charged for the missing stock. Use if stock in a warehouse is damaged, expired, or unavailable.
📄️ OrderError
No description
📄️ OrderEventOrderLineObject
No description
📄️ OrderEvent
History log of the order.
📄️ OrderFeeCreate
Creates a new order fee.
📄️ OrderFeeDelete
Deletes a order fee.
📄️ OrderFee
Extra fee associated with an order
📄️ OrderFulfill
Creates new fulfillments for an order.
📄️ OrderLineAddNote
Add a note to an order line.
📄️ OrderLineReportRowType
No description
📄️ OrderLine
Represents order line of particular order.
📄️ OrderLinesCsvUpload
Uploads lines for a draft order via CSV. This mutation must be sent as a multipart request. More detailed specs of the upload format can be found here//github.com/jaydenseric/graphql-multipart-request-spec
📄️ OrderMarkAsDelivered
Marks a fully fulfilled Order as delivered.
📄️ OrderMetrics
Order metrics including time series and status breakdown
📄️ OrderPayoutSummary
No description
📄️ OrderSummaryDeltaDataType
No description
📄️ OrderUpdateShipping
Updates a shipping method of the order.
📄️ OrderUpdate
Updates an order.
📄️ OrderUserOverrideFailure
No description
📄️ OrderVendorReportType
No description
📄️ OrderVendorSummaryType
No description
📄️ Order
Represents an order in the shop.
📄️ OrdersByStatusType
No description
📄️ PageBulkDelete
Deletes pages.
📄️ PageBulkPublish
Publish pages.
📄️ PageCountableConnection
No description
📄️ PageCountableEdge
No description
📄️ PageCreate
Creates a new page.
📄️ PageDelete
Deletes a page.
📄️ PageError
No description
📄️ PageImageDelete
Deletes a features image for the given page.
📄️ PageImageUpdate
Creates a featured image for the given page.This mutation must be sent as a 'multipart' request. More detailed specs of the upload format can be found here//github.com/jaydenseric/graphql-multipart-request-spec
📄️ PageInfo
The Relay compliant PageInfo type, containing data necessary to paginate this connection.
📄️ PageUpdate
Updates an existing page.
📄️ Page
A static page that can be manually added by a shop operator through the dashboard.
📄️ PasswordChange
Change the password of the logged in user.
📄️ PasswordRequestReset
Sends an email with the account password modification link.
📄️ PasswordSet
Sets the user's password from the token sent by email using the PasswordRequestReset mutation.
📄️ PaymentCapture
Captures the authorized payment amount.
📄️ PaymentCountableConnection
No description
📄️ PaymentCountableEdge
No description
📄️ PaymentError
No description
📄️ PaymentGateway
Available payment gateway backend with configuration necessary to setup client.
📄️ PaymentSource
Represents a payment source stored for user in payment gateway, such as credit card.
📄️ PaymentVoid
Voids the authorized payment.
📄️ Payment
Represents a payment of a given type.
📄️ PayoutBulkArchive
Archive payouts.
📄️ PayoutCountableConnection
No description
📄️ PayoutCountableEdge
No description
📄️ PayoutCreateAsync
Creates a new payout asynchronously. The payout will be created in CREATING state and then transition to DRAFT once the vendor payouts are created.
📄️ PayoutCreate
Creates a new payout.
📄️ PayoutDelete
Deletes a draft payout
📄️ PayoutError
No description
📄️ PayoutProcess
Process a payout asynchronously.
📄️ PayoutReportRowType
No description
📄️ PayoutStatusUpdate
Modifies the status of a payout. Valid transitions: DRAFT→LOCKED, LOCKED→DRAFT, LOCKED→PAID, PAID→ARCHIVED, ERROR→DRAFT. Use ERROR→DRAFT to recover payouts that failed during processing.
📄️ PayoutUpdate
Update vendor payouts connected to the given payout with adjustments and penalties
📄️ Payout
No description
📄️ PermissionGroupError
No description
📄️ PermissionGroupUpdate
Update permission group.
📄️ Permission
Represents a permission object in a friendly form.
📄️ PieChartSegment
Represents a segment in pie chart data
📄️ PluginCountableConnection
No description
📄️ PluginCountableEdge
No description
📄️ PluginError
No description
📄️ PluginUpdate
Update plugin configuration.
📄️ Plugin
Plugin.
📄️ PolicyBulkDelete
Deletes policy.
📄️ PolicyBulkPublish
Publish policy.
📄️ PolicyCountableConnection
No description
📄️ PolicyCountableEdge
No description
📄️ PolicyCreate
Creates a new policy.
📄️ PolicyDelete
Deletes a policy.
📄️ PolicyError
No description
📄️ PolicyUpdate
Updates an existing policy.
📄️ Policy
A policy that can be manually added by a shop operator through the dashboard.
📄️ PrivateMetadataDelete
Delete object's private metadata.
📄️ PrivateMetadataUpdate
Updates private metadata of an object.
📄️ ProductBulkCategoryUpdate
Update product category for multiple products
📄️ ProductBulkCreate
Creates multiple products.
📄️ ProductBulkDelete
Deletes products.
📄️ ProductBulkPublish
Publish products.
📄️ ProductCategoryReportType
No description
📄️ ProductCountableConnection
No description
📄️ ProductCountableEdge
No description
📄️ ProductCreate
Creates a new product.
📄️ ProductDelete
Deletes a product.
📄️ ProductDimensions
Product or Variant dimensions.
📄️ ProductError
No description
📄️ ProductImageBulkCreate
Create one or more product images. For each image, if URL is present, image will be taken from provided URL. If any image has no URL provided, then this mutation must be sent as a multipart request. More detailed specs of the upload format can be found here//github.com/jaydenseric/graphql-multipart-request-spec
📄️ ProductImageBulkDelete
Deletes product images.
📄️ ProductImageCountableConnection
No description
📄️ ProductImageCountableEdge
No description
📄️ ProductImageCreate
Create a product image. If URL is present, image will be taken from provided URL. If no URL provided, then this mutation must be sent as a multipart request. More detailed specs of the upload format can be found here//github.com/jaydenseric/graphql-multipart-request-spec
📄️ ProductImageDelete
Deletes a product image.
📄️ ProductImageReorder
Changes ordering of the product image.
📄️ ProductImageUpdate
Updates a product image.
📄️ ProductImage
Represents a product image.
📄️ ProductPricingInfo
Represents availability of a product in the storefront.
📄️ ProductReorderVariants
Reorder the variants of a product. Mutation updates updatedat on product and triggers PRODUCTUPDATED webhook.
📄️ ProductSetAvailabilityForPurchase
Set product availability for purchase date.
📄️ ProductStatusLog
Represents logs for each product state change.
📄️ ProductTypeBulkDelete
Deletes product types.
📄️ ProductTypeCountableConnection
No description
📄️ ProductTypeCountableEdge
No description
📄️ ProductTypeCreate
Creates a new product type.
📄️ ProductTypeDelete
Deletes a product type.
📄️ ProductTypeReorderAttributes
Reorder the attributes of a product type.
📄️ ProductTypeUpdate
Updates an existing product type.
📄️ ProductType
Represents a type of product. It defines what attributes are available to products of this type.
📄️ ProductUpdate
Updates an existing product.
📄️ ProductVariantBulkCreate
Creates product variants for a given product.
📄️ ProductVariantBulkDelete
Deletes product variants.
📄️ ProductVariantCountableConnection
No description
📄️ ProductVariantCountableEdge
No description
📄️ ProductVariantCreate
Creates a new variant for a product.
📄️ ProductVariantDelete
Deletes a product variant.
📄️ ProductVariantImageAssign
Assign an image to a product variant.
📄️ ProductVariantImageBulkAssign
Assign one or more images to a product variant.
📄️ ProductVariantImageUnassign
Unassign an image from a product variant.
📄️ ProductVariantReportType
No description
📄️ ProductVariantSetDefault
Set default variant for a product. Mutation triggers PRODUCT_UPDATED webhook.
📄️ ProductVariantStocksCreate
Creates stocks for product variant.
📄️ ProductVariantStocksDelete
Delete stocks from product variant.
📄️ ProductVariantStocksUpdate
Update stocks for product variant.
📄️ ProductVariantUpdate
Updates an existing variant for product.
📄️ ProductVariantVideoAssign
Assign a video to a product variant.
📄️ ProductVariantVideoUnassign
Unassign a video from a product variant.
📄️ ProductVariant
Represents a version of a product such as different size or color.
📄️ ProductVideoBulkCreate
Create one or more product videos. For each video, if URL is present, video will be taken from provided URL. If any video has no URL provided, then this mutation must be sent as a multipart request. More detailed specs of the upload format can be found here//github.com/jaydenseric/graphql-multipart-request-spec
📄️ ProductVideoBulkDelete
Deletes product videos.
📄️ ProductVideoCountableConnection
No description
📄️ ProductVideoCountableEdge
No description
📄️ ProductVideoCreate
Create a product video. If URL is present, video will be taken from provided URL. If no URL provided, then this mutation must be sent as a multipart request. More detailed specs of the upload format can be found here//github.com/jaydenseric/graphql-multipart-request-spec
📄️ ProductVideoDelete
Deletes a product video.
📄️ ProductVideoReorder
Changes ordering of the product videos.
📄️ ProductVideoUpdate
Updates a product video.
📄️ ProductVideo
Represents a product video.
📄️ Product
Represents an individual item for sale in the storefront.
📄️ ProductsExport
Export products to csv file.
📄️ PublicSeller
No description
📄️ RefundBulkDelete
Deletes all specified refunds. The refunds must be in the REQUESTED state to be able to be deleted
📄️ RefundCountableConnection
No description
📄️ RefundCountableEdge
No description
📄️ RefundCreate
Creates a new refund.
📄️ RefundError
No description
📄️ RefundLineBulkDelete
Deletes all specified refund lines.
📄️ RefundLineCountableConnection
No description
📄️ RefundLineCountableEdge
No description
📄️ RefundLine
Represents a refund line
📄️ RefundLinesAdd
Adds a refund lines to the existing refund.
📄️ RefundLinesUpdate
Update lines in a refund.
📄️ RefundPaymentCountableConnection
No description
📄️ RefundPaymentCountableEdge
No description
📄️ RefundPayment
Represents a refund payment
📄️ RefundPaymentsAdd
Add manual payments to a refund
📄️ RefundPaymentsDelete
Deletes specified refund payments. The refund must be in the PROCESSING state.
📄️ RefundPaymentsUpdate
Update refund payments.
📄️ RefundUpdate
Updates a refund.
📄️ Refund
Represents a refund scoped to an nautical order, a seller order, or a seller order line
📄️ RefundsChangeStatus
Updates the status of all specified refunds. All refunds must be able to make the state transition for any of them to update
📄️ SaleAddCatalogues
Adds products, variants, categories, or collections to a sale.
📄️ SaleBulkDelete
Deletes sales.
📄️ SaleCountableConnection
No description
📄️ SaleCountableEdge
No description
📄️ SaleCreate
Creates a new sale.
📄️ SaleDelete
Deletes a sale.
📄️ SaleRemoveCatalogues
Removes products, variants, categories, or collections from a sale.
📄️ SaleUpdate
Updates a sale.
📄️ Sale
Sales allow creating discounts for categories, collections, products, or variants and are visible to all the customers.
📄️ SalesMetrics
Sales metrics including time series and category breakdown
📄️ SalesPerDayType
No description
📄️ SalesVelocityItem
Sales velocity metrics for inventory planning (30/60/90 day windows)
📄️ SalesVelocityReport
Sales velocity report for inventory planning
📄️ SelectedAttribute
Represents a selected attribute and values.
📄️ SellerAddressCreate
Creates seller address.
📄️ SellerAddressDelete
Deletes an address.
📄️ SellerAddressSetDefault
Sets a default address for the given user.
📄️ SellerAddressUpdate
Updates an address.
📄️ SellerAgreementAcknowledge
Acknowledge the seller agreement for seller id
📄️ SellerAgreementAssign
Creates a new seller agreement mapping.
📄️ SellerAgreementDecline
Decline the seller agreement for seller id
📄️ SellerAgreementDelete
Deletes a seller agreement mapping.
📄️ SellerApplicationUpdate
Updates application for the given seller.
📄️ SellerApplication
No description
📄️ SellerBannerDelete
Create a seller banner.This mutation must be sent as a 'multipart' request. More detailed specs of the upload format can be found here//github.com/jaydenseric/graphql-multipart-request-spec
📄️ SellerBannerUpdate
Create a seller banner.This mutation must be sent as a 'multipart' request. More detailed specs of the upload format can be found here//github.com/jaydenseric/graphql-multipart-request-spec
📄️ SellerCountableConnection
No description
📄️ SellerCountableEdge
No description
📄️ SellerDataCreate
Create seller data.
📄️ SellerDataUpdate
Updates a sellers status and override information
📄️ SellerError
No description
📄️ SellerEventTypeCountableConnection
No description
📄️ SellerEventTypeCountableEdge
No description
📄️ SellerEventType
History log of the seller.
📄️ SellerLogoDelete
Deletes a seller logo. Only for MP Admin, MP Staff, or the seller.
📄️ SellerLogoUpdate
Create a seller logo. Only for MP Admin, MP Staff, or the seller. This mutation must be sent as a 'multipart' request. More detailed specs of the upload format can be found here//github.com/jaydenseric/graphql-multipart-request-spec
📄️ SellerNoteCreate
Create seller note.
📄️ SellerOnboardingChecklistComplete
Marks manually one checklist item as completed.
📄️ SellerOnboardingChecklistError
No description
📄️ SellerOnboardingChecklist
No description
📄️ SellerOnboardingSettingsCreate
Create new seller onboarding settings.
📄️ SellerOnboardingSettingsUpdate
Update seller onboarding settings.
📄️ SellerOnboardingSettings
Represents seller onboarding settings from the MPO.
📄️ SellerOrderReportRowType
No description
📄️ SellerOwnerDelete
Removes the user owner from a seller (including user's membership in the seller)
📄️ SellerPayoutRowType
No description
📄️ SellerSettingsUpdate
Updates settings for the given seller.
📄️ SellerShellCreate
Create seller shell.
📄️ SellerUserMappingCreate
Allows [re-]assign a user to a seller
📄️ SellerUserTypeCountableConnection
No description
📄️ SellerUserTypeCountableEdge
No description
📄️ SellerUserType
No description
📄️ SellerWithOwnerCreate
Create new Seller and a new staff user and assign created user as Seller owner.
📄️ Seller
No description
📄️ ShippingError
No description
📄️ ShippingMethod
Shipping method are the methods you'll use to get customer's orders to them. They are directly exposed to the customers.
📄️ ShippingPriceBulkDelete
Deletes shipping prices.
📄️ ShippingPriceCreate
Creates a new shipping price.
📄️ ShippingPriceDelete
Deletes a shipping price.
📄️ ShippingPriceUpdate
Updates a new shipping price.
📄️ ShippingZoneBulkDelete
Deletes shipping zones.
📄️ ShippingZoneCountableConnection
No description
📄️ ShippingZoneCountableEdge
No description
📄️ ShippingZoneCountryArea
Represents a state/province/region within a country that a shipping zone is limited to.
📄️ ShippingZoneCreate
Creates a new shipping zone.
📄️ ShippingZoneDelete
Deletes a shipping zone.
📄️ ShippingZoneUpdate
Updates a new shipping zone.
📄️ ShippingZone
Represents a shipping zone in the shop. Zones are the concept used only for grouping shipping methods in the dashboard, and are never exposed to the customers directly.
📄️ ShopError
No description
📄️ ShopFetchTaxRates
Fetch tax rates.
📄️ Shop
Represents a shop resource containing general shop data and configuration.
📄️ ShopifyWebhookTransactionCountableConnection
No description
📄️ ShopifyWebhookTransactionCountableEdge
No description
📄️ ShopifyWebhookTransaction
Shopify webhook transaction from the new plugin-based architecture. Uses synchronous processing (no Celery queue bugs) and preserves all Shopify data for debugging and future field mapping updates.
📄️ SingleVendorPayoutReport
No description
📄️ SingleVendorReportType
No description
📄️ SingleVendorSummaryType
No description
📄️ SSOIntegration
Represents a SSO integration.
📄️ SSOLogin
Login via SSO.
📄️ StaffBulkDelete
Deletes staff users.
📄️ StaffCreate
Creates a new staff user.
📄️ StaffDelete
Deletes a staff user.
📄️ StaffError
No description
📄️ StaffUpdate
Updates an existing staff user.
📄️ StartCSVImport
Start processing CSV product import with field mappings.
📄️ StockCountableConnection
No description
📄️ StockCountableEdge
No description
📄️ StockError
No description
📄️ StockEvent
History log of the variant stock.
📄️ Stock
Represents stock.
📄️ StorefrontThemeCreate
Create a new storefront theme.
📄️ StorefrontThemeUpdate
Update a storefront theme.
📄️ StorefrontTheme
Represents a storefront's theme options.
📄️ TaxCertificate
Customer Tax Certificate information.
📄️ TaxExemptCode
Avalara support tax exemption.
📄️ TaxType
Representation of tax types fetched from tax gateway.
📄️ TaxedMoneyRange
Represents a range of monetary values.
📄️ TaxedMoney
Represents a monetary value with taxes. In cases where taxes were not applied, net and gross values will be equal.
📄️ TenantCountableConnection
No description
📄️ TenantCountableEdge
No description
📄️ TenantError
No description
📄️ TenantOnboardingUpdate
Tenant onboarding update mutation.
📄️ TenantUpdate
Update a tenant
📄️ Tenant
Represents a Tenant in a multi-tenant deployment
📄️ ThirtySixtyNinetySellerReportRowType
No description
📄️ TimeSeriesDataPoint
Represents a single point in time-series data for charts
📄️ TokenCreateSSO
Create JWT token (Also creates a user if not previously signed up)
📄️ TokenCreate
Create JWT token.
📄️ TokenRefresh
Refresh JWT token. Mutation tries to take refreshToken from the input.If it fails it will try to take refreshToken from the http-only cookie -refreshToken. csrfToken is required when refreshToken is provided as a cookie.
📄️ TokenVerify
Verify JWT token.
📄️ TokensDeactivateAll
Deactivate all JWT tokens of the currently authenticated user.
📄️ Transaction
An object representing a single payment.
📄️ UserAvatarDelete
Deletes a user avatar. Only for staff members.
📄️ UserAvatarUpdate
Create a user avatar. Only for staff members. This mutation must be sent as a multipart request. More detailed specs of the upload format can be found here//github.com/jaydenseric/graphql-multipart-request-spec
📄️ UserBulkSetActive
Activate or deactivate users.
📄️ UserCountableConnection
No description
📄️ UserCountableEdge
No description
📄️ UserPermission
No description
📄️ User
Represents user data.
📄️ ValidationStatus
No description
📄️ VariantListType
No description
📄️ VariantPricingInfo
Represents availability of a variant in the storefront.
📄️ VendorPayoutCountableConnection
No description
📄️ VendorPayoutCountableEdge
No description
📄️ VendorPayoutCreate
Creates a VendorPayout for the specified seller in the payout if it does not already exist.
📄️ VendorPayoutEvent
History log of the vendor payout.
📄️ VendorPayoutNoteAdd
Adds note to the vendor payout.
📄️ VendorPayoutNoteUpdate
Edit a message in even from the vendor payout.
📄️ VendorPayoutOnboardingLinkRequest
Retrieves an onboarding link for the given vendor from the given gateway if available.
📄️ VendorPayoutReportSubset
No description
📄️ VendorPayoutReport
No description
📄️ VendorPayoutStatusUpdate
Modifies the status of a vendor payout
📄️ VendorPayout
No description
📄️ VendorPayoutsBulkExclude
Exclude vendor payouts. Only operates on vendor payouts where the parent payout is in DRAFT or ERROR state.
📄️ VendorPayoutsBulkInclude
Include vendor payouts. Only operates on vendor payouts where the parent payout is in DRAFT or ERROR state.
📄️ VendorPayoutsBulkProcess
Process vendor payouts.
📄️ VoucherAddCatalogues
Adds products, variants, categories, or collections to a voucher.
📄️ VoucherBulkDelete
Deletes vouchers.
📄️ VoucherCountableConnection
No description
📄️ VoucherCountableEdge
No description
📄️ VoucherCreate
Creates a new voucher.
📄️ VoucherDelete
Deletes a voucher.
📄️ VoucherRemoveCatalogues
Removes products, variants, categories, or collections from a voucher.
📄️ VoucherUpdate
Updates a voucher.
📄️ Voucher
Vouchers allow giving discounts to particular customers on categories, collections, or specific products or variants. They can be used during checkout by providing valid voucher codes.
📄️ WarehouseCountableConnection
No description
📄️ WarehouseCountableEdge
No description
📄️ WarehouseCreate
Creates new warehouse.
📄️ WarehouseDelete
Deletes selected warehouse.
📄️ WarehouseError
No description
📄️ WarehouseStats
Product stock stats for a specific warehouse including all variants
📄️ WarehouseUpdate
Updates given warehouse.
📄️ Warehouse
Represents warehouse.
📄️ WarningMessageItem
No description
📄️ WebhookCreate
Creates a new webhook subscription.
📄️ WebhookDelete
Deletes a webhook subscription.
📄️ WebhookError
No description
📄️ WebhookEventLogCountableConnection
No description
📄️ WebhookEventLogCountableEdge
No description
📄️ WebhookEventLog
History log of all webhook events.
📄️ WebhookEvent
Webhook event.
📄️ WebhookJobCountableConnection
No description
📄️ WebhookJobCountableEdge
No description
📄️ WebhookJob
Represents incoming webhook transaction with comprehensive data preservation. New ELT-based approach ensures no data loss and supports partial success states.
📄️ WebhookUpdate
Updates a webhook subscription.
📄️ Webhook
Webhook.
📄️ Weight
Represents weight value in a specific weight unit.
📄️ WishlistAddProductVariant
Add product variant to the current user's wishlist.
📄️ WishlistAddProduct
Add product to the current user's or target user's wishlist.
📄️ WishlistCountableConnection
No description
📄️ WishlistCountableEdge
No description
📄️ WishlistCreateForBuyer
Creates a new wishlist for any buyer if requestor is MPO
📄️ WishlistCreate
Creates a new wishlist
📄️ WishlistDelete
Update a wishlist
📄️ WishlistError
No description
📄️ WishlistItemCountableConnection
No description
📄️ WishlistItemCountableEdge
No description
📄️ WishlistItemUpdate
Update a wishlist item
📄️ WishlistItem
Wishlist item.
📄️ WishlistRemoveProductVariant
Remove product variant from the current user's wishlist.
📄️ WishlistRemoveProduct
Remove product from the current user's wishlist.
📄️ WishlistSetDefault
Set default wishlist for the user.
📄️ WishlistUpdate
Update a wishlist
📄️ Wishlist
Wishlist item.