Skip to documentation content
HintadataDocs

Capability contracts

One generated contract joins outcomes, docs, surfaces, operations, and access.

In this guide
  1. 1One generated contract joins outcomes, docs, surfaces, operations, and access.
In this guide
  1. 1One generated contract joins outcomes, docs, surfaces, operations, and access.

Capability contracts

CapabilityOutcomeSurface and docsOperations and access
API keysComplete the api keys workflow./dashboard/api-keys · authenticationrole:owner, role:admin, role:developer
AssortmentComplete the assortment workflow.api:listAssortmentOpportunitiesassortment.opportunities, scope:intelligence:read
BillingComplete the billing workflow./dashboard/billing · reference:dashboardrole:owner
CampaignsComplete the campaigns workflow.api:listCampaignSignalscampaigns.signals, scope:intelligence:read
CatalogComplete the catalog workflow.api:searchProductscatalog.search, scope:catalog:read
ComparisonsComplete the comparisons workflow.api:compareProductscomparisons.create, scope:compare:read
ConnectedComplete the connected workflow.api:listConnectedProductsconnected.catalog, connected.product, connected.history, scope:catalog:read
MerchantComplete the merchant workflow.api:importMerchantCatalogmerchant.catalog.import, merchant.coverage, scope:merchant:write, scope:intelligence:read
OffersComplete the offers workflow.api:getOffersBatchoffers.batch, scope:catalog:read
OverviewComplete the overview workflow./dashboard · reference:dashboardrole:owner, role:admin, role:developer, role:viewer
PricingComplete the pricing workflow.api:listPricingRecommendationspricing.recommendations, scope:intelligence:read
ProductsComplete the products workflow.api:getProductComparisonproducts.resolve, products.read, products.history, scope:catalog:read
WatchlistsComplete the watchlists workflow./dashboard/realtime · reference:dashboardrole:owner, role:admin, role:developer, role:viewer
SettingsComplete the settings workflow./dashboard/settings · reference:dashboardrole:owner, role:admin
SourcesComplete the sources workflow.api:putSourceSnapshotsources.snapshot, scope:sources:write
SourcingComplete the sourcing workflow.api:listSourcingOptionssourcing.options, scope:intelligence:read
TeamComplete the team workflow./dashboard/team · authenticationrole:owner, role:admin
UsageComplete the usage workflow./dashboard/usage · reference:dashboardrole:owner, role:admin, role:developer, role:viewer
WatchlistsComplete the watchlists workflow.api:listPriceWatcheswatchlists.batch, watchlists.list, watchlists.create, watchlists.update, watchlists.delete, scope:watchlists:write, scope:catalog:read
IntegrationsComplete the integrations workflow./dashboard/webhooks · webhookswebhooks.metrics, webhooks.audit, webhooks.test, webhooks.retry, webhooks.list, webhooks.create, webhooks.update, webhooks.delete, webhooks.rotation.prepare, webhooks.rotation.activate, webhooks.rotation.cancel, webhooks.incident.acknowledge, webhooks.deliveries, role:owner, role:admin, role:developer, scope:webhooks:write
Was this page helpful?