OBJECT
Query

Root queries that don't modify database records.
GraphQL Schema definition

type Query {
# Search for published adverts. NOTE: This is probably only helpful for exposing 
# search directly to consumers.
# 
# Arguments
# attributes: Search query params to determine which adverts are 
# returned.
advertSearch(attributes: AdvertSearchInput): AdvertSearchResponse! 
# Select adverts with the given attributes. Only adverts that match all queried 
# fields will be returned. If no arguments are given, returns an empty response.
# 
# Arguments
# q: Keywords to search for. (Currently Title and Product ID)
# idTitleSkuBarcode: Search in ProductID, Title, SKU and Barcode
# brandIds: [Not documented]
# legacyIds: [Not documented]
# retailerIds: Filter to only associated sellers. (Overridden for 
# seller api keys).
# status: [Not documented]
# taxonIds: [Not documented]
# taxonIdsWithDescendants: Select adverts that have associated 
# taxons and including the taxon descendants.
# title: [Not documented]
# variantBarcodes: Select adverts that have associated variants 
# with one of the given barcodes.
# variantSkus: Select adverts that have associated variants with 
# one of the given skus.
# createdSince: Select adverts created since this time
# createdUntil: Select adverts created until this time
# sort: Specifies how the list is sorted
# vetted: Select adverts that have been vetted
# rejectedViaVetting: Select adverts that have been rejected via 
# vetting
# withVettingRejectedReason: Select adverts that have a vetting 
# rejection reason
# requiresVetting: Select adverts that require vetting
# stockStatus: Select adverts with stock or without stock
# failedCatalogRuleIds: Filter adverts with provided catalog rule 
# errors. Note this filter may be impacted by background tasks.
# withFailedCatalogRules: Filter adverts with any catalog rule 
# errors. Note this filter may be impacted by background tasks.
# externalId: Select adverts with a particular External ID
# after: Returns the elements in the list that come after the 
# specified cursor.
# before: Returns the elements in the list that come before the 
# specified cursor.
# first: Returns the first _n_ elements from the list.
# last: Returns the last _n_ elements from the list.
advertsWhere(
q: String,
idTitleSkuBarcode: String,
brandIds: [ID!],
legacyIds: [Int!],
retailerIds: [ID!],
status: AdvertStatusEnum,
taxonIds: [ID!],
taxonIdsWithDescendants: [ID!],
title: String,
variantBarcodes: [String!],
variantSkus: [String!],
createdSince: ISO8601DateTime,
createdUntil: ISO8601DateTime,
sort: [AdvertsWhereSort!],
vetted: Boolean,
rejectedViaVetting: Boolean,
withVettingRejectedReason: Boolean,
requiresVetting: Boolean,
stockStatus: AdvertStockStatusEnum,
failedCatalogRuleIds: [ID!],
withFailedCatalogRules: Boolean,
externalId: ExternalIDInput,
after: String,
before: String,
first: Int,
last: Int
): AdvertsConnection! 
# Adyen settings for billing
adyenBillingSettings: AdyenBillingSettings 
# Adyen settings for ecommerce
adyenEcommerceSettings: AdyenEcommerceSettings 
# Afterpay payment configuration data
afterpay: Afterpay 
# Afterpay settings
afterpaySettings: AfterpaySettings 
# Includes deleted and unpublished adverts. When using a Seller API key, adverts 
# will be restricted to that Seller.
# 
# Arguments
# updatedSince: Only return adverts which have been updated since 
# this date
# vetted: True if advert is vetted
# requiresVetting: True if the advert requires vetting
# sort: Specifies how the list is sorted
# after: Returns the elements in the list that come after the 
# specified cursor.
# before: Returns the elements in the list that come before the 
# specified cursor.
# first: Returns the first _n_ elements from the list.
# last: Returns the last _n_ elements from the list.
allAdverts(
updatedSince: ISO8601DateTime,
vetted: Boolean,
requiresVetting: Boolean,
sort: [AdvertsWhereSort!],
after: String,
before: String,
first: Int,
last: Int
): AllAdvertsConnection! 
# Query for sellers (extant and prospective or retailer).
# 
# Arguments
# updatedSince: Only return sellers which have been updated since 
# this date
# accountType: Only return sellers with these types (default is 
# retailer and prospective)
# includeDeleted: Include soft deleted sellers in the list
# sort: Specifies how the list is sorted
# after: Returns the elements in the list that come after the 
# specified cursor.
# before: Returns the elements in the list that come before the 
# specified cursor.
# first: Returns the first _n_ elements from the list.
# last: Returns the last _n_ elements from the list.
allSellers(
updatedSince: ISO8601DateTime,
accountType: [AllSellersAccountTypeEnum!],
includeDeleted: Boolean,
sort: [AllSellersSort!],
after: String,
before: String,
first: Int,
last: Int
): AllSellersConnection! 
apiKeyPrincipal: APIKeyPrincipal 
# Get billings
# 
# Arguments
# retailerIds: IDs of sellers. If omitted will return all billing 
# invoices in marketplace. (Overridden for seller API keys)
# filters: Filters the list of billings with different criteria
# sort: Specifies how the list is sorted
# after: Returns the elements in the list that come after the 
# specified cursor.
# before: Returns the elements in the list that come before the 
# specified cursor.
# first: Returns the first _n_ elements from the list.
# last: Returns the last _n_ elements from the list.
billings(
retailerIds: [ID!],
filters: BillingFilters,
sort: BillingSort,
after: String,
before: String,
first: Int,
last: Int
): BillingsConnection! 
braintree: Braintree 
# Braintree settings for billing
braintreeBillingSettings: BraintreeBillingSettings 
# Braintree settings for ecommerce
braintreeEcommerceSettings: BraintreeEcommerceSettings 
# Search for Brands
# 
# Arguments
# keyword: Filter brands based on the keyword value passed.
# after: Returns the elements in the list that come after the 
# specified cursor.
# before: Returns the elements in the list that come before the 
# specified cursor.
# first: Returns the first _n_ elements from the list.
# last: Returns the last _n_ elements from the list.
brandSearch(
keyword: String,
after: String,
before: String,
first: Int,
last: Int
): ESBrandSearchConnection! 
# Arguments
# showOnlineOnly: Request only brands that have online adverts 
# associated with them.
# after: Returns the elements in the list that come after the 
# specified cursor.
# before: Returns the elements in the list that come before the 
# specified cursor.
# first: Returns the first _n_ elements from the list.
# last: Returns the last _n_ elements from the list.
brands(
showOnlineOnly: Boolean,
after: String,
before: String,
first: Int,
last: Int
): BrandsConnection! 
# Get cart details.
# 
# Arguments
# id: ID of the requested cart.
cart(id: ID!): Cart! 
# Returns a collection of Catalog Rules available on the marketplace.
# 
# Arguments
# createdSince: Only return catalog rules made on or after this 
# date
# createdUntil: Only return catalog rules made on or before this 
# date
# keys: Filter catalog rules by the key field
# sort: Specifies how the list is sorted
# after: Returns the elements in the list that come after the 
# specified cursor.
# before: Returns the elements in the list that come before the 
# specified cursor.
# first: Returns the first _n_ elements from the list.
# last: Returns the last _n_ elements from the list.
catalogRules(
createdSince: ISO8601DateTime,
createdUntil: ISO8601DateTime,
keys: [CatalogRulesKeyEnum!],
sort: CatalogRulesSort,
after: String,
before: String,
first: Int,
last: Int
): CatalogRulesConnection! 
# Returns relevant change logs
# 
# Arguments
# createdAt: Show changes made between dates
# after: Returns the elements in the list that come after the 
# specified cursor.
# before: Returns the elements in the list that come before the 
# specified cursor.
# first: Returns the first _n_ elements from the list.
# last: Returns the last _n_ elements from the list.
changeLogs(
createdAt: DateRangeInput,
after: String,
before: String,
first: Int,
last: Int
): ChangeLogsConnection 
# BETA: may change behaviour or arguments
# 
# Arguments
# itemId: [Not documented]
# createdAt: [Not documented]
# event: [Not documented]
# itemType: [Not documented]
# whodunnit: [Not documented]
# whodunnitType: [Not documented]
# after: Returns the elements in the list that come after the 
# specified cursor.
# before: Returns the elements in the list that come before the 
# specified cursor.
# first: Returns the first _n_ elements from the list.
# last: Returns the last _n_ elements from the list.
contextualHistory(
itemId: ID,
createdAt: DateRangeInput,
event: String,
itemType: String,
whodunnit: String,
whodunnitType: String,
after: String,
before: String,
first: Int,
last: Int
): ContextualHistoryConnection! 
# All countries and states
# 
# Arguments
# after: Returns the elements in the list that come after the 
# specified cursor.
# before: Returns the elements in the list that come before the 
# specified cursor.
# first: Returns the first _n_ elements from the list.
# last: Returns the last _n_ elements from the list.
countries(after: String, before: String, first: Int, last: Int): CountrysConnection! 
# Returns all CustomFieldGroups
# 
# Arguments
# after: Returns the elements in the list that come after the 
# specified cursor.
# before: Returns the elements in the list that come before the 
# specified cursor.
# first: Returns the first _n_ elements from the list.
# last: Returns the last _n_ elements from the list.
customFieldGroups(
after: String,
before: String,
first: Int,
last: Int
): CustomFieldGroupsConnection! 
# Direct email marketing
emailMarketing: EmailMarketing! 
# Email Marketing Subscriptions
# 
# Arguments
# subscribedSince: Only return Subscriptions created after this 
# date, format: YYYY-MM-DD
# after: Returns the elements in the list that come after the 
# specified cursor.
# before: Returns the elements in the list that come before the 
# specified cursor.
# first: Returns the first _n_ elements from the list.
# last: Returns the last _n_ elements from the list.
emailMarketingSubscriptions(
subscribedSince: ISO8601Date,
after: String,
before: String,
first: Int,
last: Int
): SubscriptionsConnection! 
# Arguments
# ownerType: Specify the type of the external id, eg: invoice, 
# order, variant.
# key: Label for the system or client that uses this external ID.
# value: The external ID used by an external system or client.
# values: The external IDs (plural) used by an external system or 
# client.
# first: Limit to the first N values
externalIds(
ownerType: String,
key: String,
value: String,
values: [String!],
first: Int
): [ExternalID!]! 
# Check if a feature flag is enabled?
# 
# Arguments
# name: The flag name to check if it is enabled.
featureEnabled(name: String!): Boolean! 
# Site footer data
footer: Footer! 
# Givex settings
givexSettings: GivexSettings 
# Deprecated: beta
# 
# Arguments
# keywords: Search query params to determine which records are 
# returned
# after: Returns the elements in the list that come after the 
# specified cursor.
# before: Returns the elements in the list that come before the 
# specified cursor.
# first: Returns the first _n_ elements from the list.
# last: Returns the last _n_ elements from the list.
globalSearch(
keywords: String!,
after: String,
before: String,
first: Int,
last: Int
): GlobalSearchResultsConnection! 
# Golden Product records.
# 
# Arguments
# activeStatus: [Not documented]
# after: Returns the elements in the list that come after the 
# specified cursor.
# before: Returns the elements in the list that come before the 
# specified cursor.
# first: Returns the first _n_ elements from the list.
# last: Returns the last _n_ elements from the list.
goldenProducts(
activeStatus: GoldenProductActiveStatusEnum,
after: String,
before: String,
first: Int,
last: Int
): GoldenProductsConnection! 
# Site header data
header: Header! 
healthCheck: HealthCheck! 
# Arguments
# type: [Not documented]
# status: [Not documented]
# after: Returns the elements in the list that come after the 
# specified cursor.
# before: Returns the elements in the list that come before the 
# specified cursor.
# first: Returns the first _n_ elements from the list.
# last: Returns the last _n_ elements from the list.
importExports(
type: ImportExportTypeEnum,
status: ImportExportStatusEnum,
after: String,
before: String,
first: Int,
last: Int
): ImportExportConnection 
# Get invoice amendments
# 
# Arguments
# filters: Filters the list of invoice amendments with different 
# criteria
# sort: Specifies how the list is sorted
# after: Returns the elements in the list that come after the 
# specified cursor.
# before: Returns the elements in the list that come before the 
# specified cursor.
# first: Returns the first _n_ elements from the list.
# last: Returns the last _n_ elements from the list.
invoiceAmendments(
filters: InvoiceAmendmentFilters,
sort: InvoiceAmendmentSort,
after: String,
before: String,
first: Int,
last: Int
): InvoiceAmendmentsConnection! 
# All invoice annotation types
# 
# Arguments
# after: Returns the elements in the list that come after the 
# specified cursor.
# before: Returns the elements in the list that come before the 
# specified cursor.
# first: Returns the first _n_ elements from the list.
# last: Returns the last _n_ elements from the list.
invoiceAnnotationType(
after: String,
before: String,
first: Int,
last: Int
): InvoiceAnnotationTypeConnection 
# Get invoices
# 
# Arguments
# filters: Filters the list of invoices with different criteria
# sort: Specifies how the list is sorted
# after: Returns the elements in the list that come after the 
# specified cursor.
# before: Returns the elements in the list that come before the 
# specified cursor.
# first: Returns the first _n_ elements from the list.
# last: Returns the last _n_ elements from the list.
invoices(
filters: InvoiceFilters,
sort: InvoiceSort,
after: String,
before: String,
first: Int,
last: Int
): InvoicesConnection! 
# Klaviyo settings.
klaviyoSettings: KlaviyoSettings 
# Get suggestions for location-based search queries.
# 
# Arguments
# query: Location query string. Can be a city or postcode.
locationSuggestions(query: String!): [Location!]! 
# Loyalty program levels
# 
# Arguments
# after: Returns the elements in the list that come after the 
# specified cursor.
# before: Returns the elements in the list that come before the 
# specified cursor.
# first: Returns the first _n_ elements from the list.
# last: Returns the last _n_ elements from the list.
loyaltyProgramLevels(
after: String,
before: String,
first: Int,
last: Int
): LoyaltyProgramLevelsConnection 
# Arguments
# sellerId: ID of the seller. May be omitted if using a seller 
# api key, but is required otherwise
# filters: [Not documented]
# after: Returns the elements in the list that come after the 
# specified cursor.
# before: Returns the elements in the list that come before the 
# specified cursor.
# first: Returns the first _n_ elements from the list.
# last: Returns the last _n_ elements from the list.
mappings(
sellerId: ID,
filters: MappingFilters,
after: String,
before: String,
first: Int,
last: Int
): MappingsConnection! 
# Fetches an object given its ID.
# 
# Arguments
# id: ID of the object.
node(id: ID!): Node 
# Fetches a list of objects given a list of IDs.
# 
# Arguments
# ids: IDs of the objects.
nodes(ids: [ID!]!): [Node]! 
# Get order details
# 
# Arguments
# orderId: ID of the requested order.
order(orderId: ID!): Order! 
# Get order details from the cart that it was created from.
# 
# Arguments
# cartId: ID of the cart that was converted into this order.
orderFromCart(cartId: ID!): Order 
paymentEvent: PaymentEvent! 
# Paypal Commerce settings
paypalCommerceSettings: PaypalCommerceSettings 
# Returns a list of Promotions
# 
# Arguments
# status: One of: active, upcoming, expired, all. Defaults to 
# all.
# sellerId: ID of the seller. If omitted will return promotions 
# for all sellers.
# after: Returns the elements in the list that come after the 
# specified cursor.
# before: Returns the elements in the list that come before the 
# specified cursor.
# first: Returns the first _n_ elements from the list.
# last: Returns the last _n_ elements from the list.
promotions(
status: String,
sellerId: ID,
after: String,
before: String,
first: Int,
last: Int
): PromotionsConnection! 
# Returns a list of Prototypes
# 
# Arguments
# ids: Only return Prototypes matching IDs in array
# after: Returns the elements in the list that come after the 
# specified cursor.
# before: Returns the elements in the list that come before the 
# specified cursor.
# first: Returns the first _n_ elements from the list.
# last: Returns the last _n_ elements from the list.
prototypes(ids: [ID!], after: String, before: String, first: Int, last: Int): PrototypesConnection! 
# RankedResult records - force first adverts for category/brand
# 
# Arguments
# after: Returns the elements in the list that come after the 
# specified cursor.
# before: Returns the elements in the list that come before the 
# specified cursor.
# first: Returns the first _n_ elements from the list.
# last: Returns the last _n_ elements from the list.
rankedResults(after: String, before: String, first: Int, last: Int): RankedResultsConnection! 
# Returns a list of redirects
# 
# Arguments
# after: Returns the elements in the list that come after the 
# specified cursor.
# before: Returns the elements in the list that come before the 
# specified cursor.
# first: Returns the first _n_ elements from the list.
# last: Returns the last _n_ elements from the list.
redirects(after: String, before: String, first: Int, last: Int): RedirectConnection! 
# Pre and Post Refund Reasons
refundReasons: RefundReason! 
# Refund request notes
# 
# Arguments
# createdSince: Only return refund request notes created after 
# this date.
# createdUntil: Only return refund request notes created before 
# this date.
# newStatus: Only return refund request notes with this as the 
# new status.
# refundRequestIds: Only return refund request notes for 
# associated refund requests.
# refundRequestLineItemIds: Only return refund request notes for 
# associated refund request line items.
# retailerIds: Only return remittances for associated sellers. 
# (Overridden for seller API keys)
# after: Returns the elements in the list that come after the 
# specified cursor.
# before: Returns the elements in the list that come before the 
# specified cursor.
# first: Returns the first _n_ elements from the list.
# last: Returns the last _n_ elements from the list.
refundRequestNotes(
createdSince: ISO8601DateTime,
createdUntil: ISO8601DateTime,
newStatus: String,
refundRequestIds: [ID!],
refundRequestLineItemIds: [ID!],
retailerIds: [ID!],
after: String,
before: String,
first: Int,
last: Int
): RefundRequestNoteConnection! 
# Retrieve refund requests
# 
# Arguments
# sellerId: ID of the seller. If omitted will return all refund 
# requests
# filters: Filters the list of refund requests with different 
# criteria
# after: Returns the elements in the list that come after the 
# specified cursor.
# before: Returns the elements in the list that come before the 
# specified cursor.
# first: Returns the first _n_ elements from the list.
# last: Returns the last _n_ elements from the list.
refundRequests(
sellerId: ID,
filters: RefundRequestFilters,
after: String,
before: String,
first: Int,
last: Int
): RefundRequestConnection! 
# Get remittance advices.
# 
# Arguments
# legacyIds: Only return remittances with these legacy IDs.
# retailerIds: Only return remittances for associated sellers. 
# (Overridden for seller API keys)
# retailerLegacyIds: Only return remittances for sellers with 
# these legacy IDs. (Overridden for seller API keys)
# retailerNames: Only return remittances for sellers with these 
# names. (Overridden for seller API keys)
# createdSince: Only return remittance advices created after this 
# date.
# createdUntil: Only return remittance advices created before 
# this date.
# remittanceActionLastRunSince: Only return remittance advices 
# with remittance actions run before this date.
# remittanceActionLastRunUntil: Only return remittance advices 
# with remittance actions run after this date.
# paidSince: Only return remittance advices paid after this date.
# paidUntil: Only return remittance advices paid before this 
# date.
# remittableType: Only return remittances associated with 
# invoices (if value is 'invoice') or invoice amendments (if value is 
# 'invoice_amendment').
# total: Only return remittances with this total value.
# totalPaid: Only return remittances with this total paid value.
# invoiceIds: Only return remittances for associated invoices.
# invoiceLegacyIds: Only return remittances for invoices with 
# these legacy IDs.
# invoiceAmendmentIds: Only return remittances for associated 
# invoice amendments.
# invoiceAmendmentLegacyIds: Only return remittances for invoice 
# amendments with these legacy IDs.
# remittanceActions: Only return remittances with particular 
# remittance actions performed on them. Options available: 'hyperwallet', 'xero'.
# paymentReference: Only return remittance advices with a 
# specified payment reference.
# after: Returns the elements in the list that come after the 
# specified cursor.
# before: Returns the elements in the list that come before the 
# specified cursor.
# first: Returns the first _n_ elements from the list.
# last: Returns the last _n_ elements from the list.
remittanceAdvices(
legacyIds: [Int!],
retailerIds: [ID!],
retailerLegacyIds: [Int!],
retailerNames: [String!],
createdSince: ISO8601DateTime,
createdUntil: ISO8601DateTime,
remittanceActionLastRunSince: ISO8601DateTime,
remittanceActionLastRunUntil: ISO8601DateTime,
paidSince: ISO8601DateTime,
paidUntil: ISO8601DateTime,
remittableType: String,
total: Float,
totalPaid: Float,
invoiceIds: [ID!],
invoiceLegacyIds: [Int!],
invoiceAmendmentIds: [ID!],
invoiceAmendmentLegacyIds: [Int!],
remittanceActions: [String!],
paymentReference: [String!],
after: String,
before: String,
first: Int,
last: Int
): RemittanceAdviceConnection! 
# Get multiple remittances.
# 
# Arguments
# createdSince: Only return remittances made after this date
# createdUntil: Only return remittances made before this date
# released: Only return remittances that are released (if value 
# is 'true') or held (if value is 'false').
# processed: Only return remittances where a remittance advice 
# has been generated (if value is 'true') or pending generation (if value is 
# 'false').
# retailerIds: Only return remittances for associated sellers.
# retailerBusinessNames: Only return remittances for sellers with 
# these names.
# remittableType: Only return remittances associated with 
# invoices (if value is 'invoice') or invoice amendments (if value is 
# 'invoice_amendment').
# invoiceIds: Only return remittances for associated invoices.
# invoiceLegacyIds: Only return remittances for invoices with 
# these legacy IDs.
# invoiceAmendmentIds: Only return remittances for associated 
# invoice amendments.
# invoiceAmendmentLegacyIds: Only return remittances for invoice 
# amendments with these legacy IDs.
# pendingReasons: Only return remittances that are unprocessed 
# for a particular reason.Options available: 'missing_remittance_details', 
# 'missing_hyperwallet_details', 'zero_or_negative_total_remittance_amount', 
# 'pending_hyperwallet_verification', 'missing_xero_account', 'pending_release'.
# after: Returns the elements in the list that come after the 
# specified cursor.
# before: Returns the elements in the list that come before the 
# specified cursor.
# first: Returns the first _n_ elements from the list.
# last: Returns the last _n_ elements from the list.
remittances(
createdSince: ISO8601DateTime,
createdUntil: ISO8601DateTime,
released: Boolean,
processed: Boolean,
retailerIds: [ID!],
retailerBusinessNames: [String!],
remittableType: String,
invoiceIds: [ID!],
invoiceLegacyIds: [Int!],
invoiceAmendmentIds: [ID!],
invoiceAmendmentLegacyIds: [Int!],
pendingReasons: String,
after: String,
before: String,
first: Int,
last: Int
): RemittanceConnection! 
sellerCategories: [SellerCategoryLink!]! 
# Minimal set of attributes required for displaying and filtering Sellers on a map
sellerGeographicLocations: [SellerGeolocation!]! 
# Query ElasticSearch for sellers.
# 
# Arguments
# attributes: Query params to define which sellers to search for.
# pagination: Params to define how to paginate search results.
sellerSearch(
attributes: SellerSearchInput,
pagination: SellerSearchPaginationInput
): SellerSearchResponse! 
# Insights & Statistics for a seller
# 
# Arguments
# sellerId: ID of the seller. May be omitted if using a seller 
# api key, but is required otherwise
sellerStats(sellerId: ID): SellerStats 
# Select sellers with the given attributes. Only sellers that match all queried 
# fields will be returned. If no arguments are given, returns all available 
# sellers
# 
# Arguments
# q: Keywords to search for. (Currently Business Name, Email 
# Address, and Legal Business Name)
# retailerIds: Filter by ID of the sellers.
# slaRatingRange: Filter by the SLA rating range
# sort: Specifies how the list is sorted
# after: Returns the elements in the list that come after the 
# specified cursor.
# before: Returns the elements in the list that come before the 
# specified cursor.
# first: Returns the first _n_ elements from the list.
# last: Returns the last _n_ elements from the list.
sellersWhere(
q: String,
retailerIds: [ID!],
slaRatingRange: SellerSlaRatingRangeInput,
sort: SellersWhereSort,
after: String,
before: String,
first: Int,
last: Int
): SellerConnection! 
# SendGrid settings.
sendgridSettings: SendgridSettings 
# Information about the current session
session: SessionData 
# Shipment Addresses
# 
# Arguments
# sellerId: ID of the seller. If omitted will return all shipment 
# addresses for marketplace.
# after: Returns the elements in the list that come after the 
# specified cursor.
# before: Returns the elements in the list that come before the 
# specified cursor.
# first: Returns the first _n_ elements from the list.
# last: Returns the last _n_ elements from the list.
shipmentAddresses(
sellerId: ID,
after: String,
before: String,
first: Int,
last: Int
): AddresssConnection 
# Shipment Carriers
# 
# Arguments
# after: Returns the elements in the list that come after the 
# specified cursor.
# before: Returns the elements in the list that come before the 
# specified cursor.
# first: Returns the first _n_ elements from the list.
# last: Returns the last _n_ elements from the list.
shipmentCarriers(after: String, before: String, first: Int, last: Int): ShipmentCarrierConnection 
# Returns a collection of shipping options available on the marketplace
# 
# Arguments
# sellerId: ID of the seller. If omitted will return all shipping 
# rules including marketplace rules
# filters: Filters the list of shipping options with different 
# criteria
# after: Returns the elements in the list that come after the 
# specified cursor.
# before: Returns the elements in the list that come before the 
# specified cursor.
# first: Returns the first _n_ elements from the list.
# last: Returns the last _n_ elements from the list.
shippingOptions(
sellerId: ID,
filters: ShippingOptionFilters,
after: String,
before: String,
first: Int,
last: Int
): ShippingOptionConnection 
# Returns a collection of shipping profiles available on the marketplace
# 
# Arguments
# after: Returns the elements in the list that come after the 
# specified cursor.
# before: Returns the elements in the list that come before the 
# specified cursor.
# first: Returns the first _n_ elements from the list.
# last: Returns the last _n_ elements from the list.
shippingProfiles(after: String, before: String, first: Int, last: Int): ShippingProfileConnection 
# Returns a collection of shipping rates available on the marketplace
# 
# Arguments
# sellerId: ID of the seller. If omitted will return all shipping 
# rules including marketplace rules
# after: Returns the elements in the list that come after the 
# specified cursor.
# before: Returns the elements in the list that come before the 
# specified cursor.
# first: Returns the first _n_ elements from the list.
# last: Returns the last _n_ elements from the list.
shippingRates(
sellerId: ID,
after: String,
before: String,
first: Int,
last: Int
): ShippingRateConnection 
# Returns a collection of shipping zones available on the marketplace
# 
# Arguments
# sellerId: ID of the seller. If omitted will return all shipping 
# rules including marketplace rules
# after: Returns the elements in the list that come after the 
# specified cursor.
# before: Returns the elements in the list that come before the 
# specified cursor.
# first: Returns the first _n_ elements from the list.
# last: Returns the last _n_ elements from the list.
shippingZones(
sellerId: ID,
after: String,
before: String,
first: Int,
last: Int
): ShippingZoneConnection 
# Returns a Shippit Credentials Object for shipping settings
# 
# Arguments
# sellerId: ID of the seller. If omitted will return an error
shippitCredentials(sellerId: ID!): ShippitCredentials 
# Site configuration properties
siteConfig: SiteConfig! 
taxCodes: [TaxCode!]! 
# Arguments
# searchValue: Filter taxons where the taxon name contains the 
# search value string. Must have a minimum of 2 characters for each search word.
# after: Returns the elements in the list that come after the 
# specified cursor.
# before: Returns the elements in the list that come before the 
# specified cursor.
# first: Returns the first _n_ elements from the list.
# last: Returns the last _n_ elements from the list.
taxonSearch(
searchValue: String,
after: String,
before: String,
first: Int,
last: Int
): TaxonConnection! 
# Arguments
# parentId: Filter taxons that belong to to the selected parent.
# showOnlineOnly: Filter taxons that have online adverts 
# associated with them.
# after: Returns the elements in the list that come after the 
# specified cursor.
# before: Returns the elements in the list that come before the 
# specified cursor.
# first: Returns the first _n_ elements from the list.
# last: Returns the last _n_ elements from the list.
taxons(
parentId: ID,
showOnlineOnly: Boolean,
after: String,
before: String,
first: Int,
last: Int
): TaxonsConnection! 
# Get taxon and brand suggestions for text-based search queries.
# 
# Arguments
# query: Query string to be used to find text suggestions.
textQuerySuggestions(query: String!): [TextQuerySuggestion!]! 
# Return theming attributes from AppConfig
theme: Theme! 
# Third-party login links
# 
# Arguments
# after: Returns the elements in the list that come after the 
# specified cursor.
# before: Returns the elements in the list that come before the 
# specified cursor.
# first: Returns the first _n_ elements from the list.
# last: Returns the last _n_ elements from the list.
# scope: What kind of login provider?
thirdPartyLoginLinks(
after: String,
before: String,
first: Int,
last: Int,
scope: ThirdPartyLoginLinkScopeEnum!
): ThirdPartyLoginLinkConnection! 
# Fetch I18n translation values by key.
# 
# Arguments
# translations: Params to generate the requested translations.
translations(translations: [TranslationInput!]!): [Translation!]! 
# Retrieve carts that have been updated relative a certain timestamp.
# Either updatedSince or notUpdatedSince must be supplied.
# If you supply both or neither, you will get no results.
# 
# Arguments
# updatedSince: Only return carts which have been updated since 
# this date
# notUpdatedSince: Only return carts which have not been updated 
# since this date
# after: Returns the elements in the list that come after the 
# specified cursor.
# before: Returns the elements in the list that come before the 
# specified cursor.
# first: Returns the first _n_ elements from the list.
# last: Returns the last _n_ elements from the list.
updatedCarts(
updatedSince: ISO8601DateTime,
notUpdatedSince: ISO8601DateTime,
after: String,
before: String,
first: Int,
last: Int
): UpdatedCartsConnection! 
# Retrieve orders that have been updated after a certain date
# 
# Arguments
# updatedSince: Only return orders which have been updated since 
# this date
# after: Returns the elements in the list that come after the 
# specified cursor.
# before: Returns the elements in the list that come before the 
# specified cursor.
# first: Returns the first _n_ elements from the list.
# last: Returns the last _n_ elements from the list.
updatedOrders(
updatedSince: ISO8601DateTime!,
after: String,
before: String,
first: Int,
last: Int
): UpdatedOrdersConnection! 
# Retrieve refund requests that have been updated after a certain date
# 
# Arguments
# updatedSince: Only return refund requests which have been 
# updated since this date
# after: Returns the elements in the list that come after the 
# specified cursor.
# before: Returns the elements in the list that come before the 
# specified cursor.
# first: Returns the first _n_ elements from the list.
# last: Returns the last _n_ elements from the list.
updatedRefundRequests(
updatedSince: ISO8601DateTime!,
after: String,
before: String,
first: Int,
last: Int
): UpdatedRefundRequestsConnection! 
user: User! 
# Select variants with the given attributes. Only variants that match all queried 
# fields will be returned. If no arguments are given, returns an empty response.
# 
# Arguments
# advertFilters: [Not documented]
# variantFilters: [Not documented]
# after: Returns the elements in the list that come after the 
# specified cursor.
# before: Returns the elements in the list that come before the 
# specified cursor.
# first: Returns the first _n_ elements from the list.
# last: Returns the last _n_ elements from the list.
variantsWhere(
advertFilters: AdvertFilterInput,
variantFilters: VariantFilterInput,
after: String,
before: String,
first: Int,
last: Int
): VariantConnection! 
# Returns the webhook events associated to webhooks
# 
# Arguments
# webhookId: ID of the webhook, if not provided then all webhook 
# events are returned, ordered by updated_at timestamp
# after: Returns the elements in the list that come after the 
# specified cursor.
# before: Returns the elements in the list that come before the 
# specified cursor.
# first: Returns the first _n_ elements from the list.
# last: Returns the last _n_ elements from the list.
webhookEvents(
webhookId: ID,
after: String,
before: String,
first: Int,
last: Int
): WebhookEventsConnection 
# Returns the webhooks linked to marketplacer events.
# 
# Arguments
# after: Returns the elements in the list that come after the 
# specified cursor.
# before: Returns the elements in the list that come before the 
# specified cursor.
# first: Returns the first _n_ elements from the list.
# last: Returns the last _n_ elements from the list.
webhooks(after: String, before: String, first: Int, last: Int): WebhooksConnection 
# Yotpo settings
yotpoSettings: YotpoSettings 
# Zip settings
zipSettings: ZipSettings 
# Zooz settings
zoozSettings: ZoozSettings 
}
Require by

This element is not required by anyone
Query

link GraphQL Schema definition

link Require by

GraphQL Schema definition

Require by
