Query

Object

_entities

_service

address

Look up an address by ID.

addressValidationRules

Returns address validation rules.

agreement

Look up a marketplace agreement by ID or slug.

agreements

List of the marketplace agreements.

allCategories

Unfiltered and unpaginated list of the shop's categories.

allowedOwners

analyticsId

Returns analytics ID (e.g. Google Tag ID).

app

Look up a app by ID.

apps

List of the apps.

appsInstallations

List of all apps installations

attribute

Look up an attribute by ID.

attributes

List of the shop's attributes.

availableImportSources

List of plugins that are available as product import sources

availablePlans

avalaraRequestLogs

List of Avalara calls.

catalogImportProcess

Look up a catalog import process by ID.

catalogImportProcesses

List of catalog import processes.

categories

List of the shop's categories.

category

Look up a category by ID or slug.

checkout

Look up a checkout by token.

checkoutEvents

List of checkout events.

checkoutLine

Look up a checkout line by ID.

checkoutLines

List of checkout lines.

checkouts

List of checkouts.

collection

Look up a collection by ID.

collections

List of the shop's collections.

content

Return information about content.

contentDraft

Return information about content for the editor.

contentList

List of the content.

countries

Countries available to the marketplace.

currencies

Currencies available to the marketplace.

customFieldTemplate

Look up a custom field template by ID or Content Type.

customFieldTemplates

List of the available custom field templates.

customStorefrontDomain

If set, the custom storefront domain

customerTaxCertificates

Get customer tax certificates by user ID.

customers

List of the shop's customers.

dashboardGraph

dashboardOrdersSummary

dashboardTopSellerPerformance

designerdata

designerdatalist

digitalContent

Look up digital content by ID.

digitalContents

List of digital content.

draftOrders

List of draft orders.

emailLogs

List of email logs.

emailTemplate

Look up an email template by ID.

emailTemplatePreview

Preview a template rendered.

emailTemplates

List of email templates.

exportFile

Look up a export file by ID.

exportFiles

List of export files.

fontList

List of the fonts for the storefront.

getClientSecret

Get client secret if necessary for frontend configuration.

getPayoutGateways

List of active payment gateways that have payouts enabled.

homepageEvents

List of activity events to display on homepage (at the moment it only contains order-events).

importThirdPartyProduct

Get third party product in form we can use for import

insightsMarketplacePaymentsSummary

insightsMarketplacePayoutsSummary

insightsMarketplaceTaxSummary

insightsMarketplaceTaxesByCountry

insightsMarketplaceTaxesByCountryArea

insightsOrdersCustomerSummary

insightsOrdersMarketplaceSummary

insightsOrdersSellerSummary

insightsTopPerformingCategories

insightsTopPerformingProducts

integrationEmbeddingToken

Token nexessary for connecting to the embedded integration platform

journalEntries

List of journal entries in the ledger system.

ledgers

List of ledgers in the system

locationGeocode

Geocode locations

locationSearch

Search Locations

marketplaceConfiguration

Return configuration for the marketplace.

marketplaceHomepageEvents

List of activity events to display on homepage (at the moment it only contains nautical-order-events).

me

Return the currently authenticated user.

media

Return information about media.

mediaList

List of the media.

menu

Look up a navigation menu by ID or name.

menuItem

Look up a menu item by ID.

menuItems

List of the storefronts's menu items.

menus

List of the storefront's menus.

microsite

Look up a microsite by ID or slug

microsites

List of microsites

nauticalConfiguration

Return requested nautical configuration item

nauticalConfigurationList

Return all nautical configuration items

nauticalDraftOrders

List of draft orders.

nauticalOrder

Look up nautical order by ID.

nauticalOrderByToken

Look up a nautical order by token

nauticalOrders

List of Nautical orders.

nauticalOrdersTotal

Return the total sales amount from a specific period.

nauticalQuoteOrderByToken

Look up a nautical quote order by token

nauticalQuoteOrders

List of quote orders.

newSellers

Number of new sellers created in given period.

optimizedHome

order

Look up an order by ID.

orderByToken

Look up an order by token.

orders

List of orders.

ordersTotal

Return the total sales amount from a specific period.

page

Look up a page by ID or slug.

pages

List of the shop's pages.

payment

Look up a payment by ID.

payments

List of payments.

payout

Look up a payout by ID.

payouts

List of payouts.

permissionGroup

Look up permission group by ID.

permissionGroups

List of permission groups.

plugin

Look up a plugin by ID.

pluginFlows

Get the flows associated with a particular plugin and seller

plugins

List of plugins.

priceBook

Look up a price book by ID.

priceBookProductTypes

List of price book product types.

priceBookProductTypesHistory

List of price book product types in history tables.

priceBookProducts

List of price book products.

priceBookProductsHistory

List of price book products in history table.

priceBookUsers

Look up users attached to a price book by ID.

priceBookVariants

List of price book variants in.

priceBookVariantsHistory

List of price book variants in history table.

priceBooks

List of price books.

product

Look up a product by ID.

productType

Look up a product type by ID.

productTypes

List of the shop's product types.

productVariant

Look up a product variant by ID or Nautical Stock Number (NSN).

productVariants

List of product variants.

products

List of the shop's products.

quoteOrders

List of quote orders.

refund

Look up an refund by ID.

refunds

List of refunds.

reportProductSales

List of top selling products.

returns

List of fulfillments.

sale

Look up a sale by ID.

sales

List of the shop's sales.

seller

Look up seller by global ID

sellerAgreement

Look up what agreement a seller is attached to for the current date

sellerAgreements

Look up agreement history for a seller

sellerBySlug

Look up seller by slug

sellerCommissions

Return the total commissions earned across all sellers for the given period.

sellerDetailCards

sellerEvents

sellerListCards

sellerOrders

Number of orders placed by sellers in given period.

sellerUser

sellerUsers

sellers

List of sellers

shippingZone

Look up a shipping zone by ID.

shippingZones

List of the shop's shipping zones.

shop

Return information about the shop.

staffUsers

List of the shop's staff users.

stock

Look up a stock by ID

stocks

List of stocks.

taxExemptCodes

List of tax exempt code supported by Avalara. Required permission: MANAGE_MARKETPLACE. Note: doesn't support app auth.

taxTypes

List of all tax rates available from tax gateway.

tenant

Look up a tenant by ID.

tenants

List of tenants.

thirdPartyProducts

List of third party products

typeformForm

Form details for specified form_id

typeformForms

All forms available on Typeform

user

Look up a user by ID.

userByEmail

Look up user by email.

userSellers

vendorMicrosite

Look up microsite by vendor ID

vendorPayout

Look up a vendor payout by ID.

vendorPayoutList

vendorPayouts

voucher

Look up a voucher by ID.

vouchers

List of the shop's vouchers.

warehouse

Look up a warehouse by ID.

warehouses

List of warehouses.

webhook

Look up a webhook by ID.

webhookEventLogs

List of webhook event logs.

webhookEvents

List of all available webhook events.

webhookJobs

List of webhook jobs

webhookSamplePayload

Retrieve a sample payload for a given webhook event based on real data. It can be useful for some integrations where sample payload is required.

wishlistItemsByName

List of the wishlist items by name.