# Merchkit

## Docs

- [Check completeness for a channel](https://docs.merchkit.com/api-reference/check-completeness-for-a-channel.md): Recomputes the product’s completeness for one channel on demand. `channel` is REQUIRED — completeness is per-channel. Returns missing/invalid issues, each with acceptable values where applicable.
- [Create a asset](https://docs.merchkit.com/api-reference/create-a-asset.md): Creates a asset. Unknown attribute keys are rejected with 400.
- [Create a category](https://docs.merchkit.com/api-reference/create-a-category.md): Creates a category. Unknown attribute keys are rejected with 400.
- [Create a product](https://docs.merchkit.com/api-reference/create-a-product.md): Creates a product. Unknown attribute keys are rejected with 400.
- [Create a saved grid view](https://docs.merchkit.com/api-reference/create-a-saved-grid-view.md): `visibleColumns` (ordered) sets the visible columns + order; the friendly input is mapped to the stored view_config.
- [Create a vendor](https://docs.merchkit.com/api-reference/create-a-vendor.md): Creates a vendor. Unknown attribute keys are rejected with 400.
- [Create an attribute class](https://docs.merchkit.com/api-reference/create-an-attribute-class.md): `primaryEvaluationAttributeKey` (e.g. "category") + `attributeMappings` map each value to the attribute keys enabled for it.
- [Create an attribute definition](https://docs.merchkit.com/api-reference/create-an-attribute-definition.md): Create an attribute, including full AI-generation config. For an AI-generated attribute set `aiGenerated: true` + `customInstructions`, and `selectedTools`: `includeWebSearch` (live web research as a data source), `includeDataSources` (scraped sites/CSVs), `includeImages` (vision), `includeProductAt…
- [Get a asset](https://docs.merchkit.com/api-reference/get-a-asset.md): Full detail with reference attributes hydrated to `{entityId, entityType, label}` summaries.
- [Get a category](https://docs.merchkit.com/api-reference/get-a-category.md): Full detail with reference attributes hydrated to `{entityId, entityType, label}` summaries.
- [Get a product](https://docs.merchkit.com/api-reference/get-a-product.md): Full detail with reference attributes hydrated to `{entityId, entityType, label}` summaries.
- [Get a product’s change history](https://docs.merchkit.com/api-reference/get-a-product’s-change-history.md): Who changed what, when — from the append-only event log. Filter with `since` (ISO-8601) and `limit`.
- [Get a vendor](https://docs.merchkit.com/api-reference/get-a-vendor.md): Full detail with reference attributes hydrated to `{entityId, entityType, label}` summaries.
- [Get an attribute class (incl. attributeMappings)](https://docs.merchkit.com/api-reference/get-an-attribute-class-incl-attributemappings.md)
- [Get asset attribute values](https://docs.merchkit.com/api-reference/get-asset-attribute-values.md)
- [Get category attribute values](https://docs.merchkit.com/api-reference/get-category-attribute-values.md)
- [Get product attribute values](https://docs.merchkit.com/api-reference/get-product-attribute-values.md)
- [Get vendor attribute values](https://docs.merchkit.com/api-reference/get-vendor-attribute-values.md)
- [List a product’s references](https://docs.merchkit.com/api-reference/list-a-product’s-references.md): Returns the product’s references (cross-sell / related / accessories / …) — the `entity_list_reference` edges — as `{ [type]: [{entityId, entityType, label, position}] }`. Pass `type` to read one reference type; omit for all.
- [List a product’s variants](https://docs.merchkit.com/api-reference/list-a-product’s-variants.md): The products whose `parent_entity` is this product.
- [List assets](https://docs.merchkit.com/api-reference/list-assets.md): Returns a paginated list of assets. Filter with the DSL `filter[<key>][<operator>]=<value>` (operators: contains, equals, notEquals, notContains, startsWith, endsWith, blank, notBlank, greaterThan, lessThan, greaterThanOrEqual, lessThanOrEqual). Use `blank`/`notBlank` to find records missing an attr…
- [List attribute classes (cell-disabling rules)](https://docs.merchkit.com/api-reference/list-attribute-classes-cell-disabling-rules.md)
- [List attribute definitions](https://docs.merchkit.com/api-reference/list-attribute-definitions.md): The schema of what can be set on an entity type, optionally scoped to a channel.
- [List categories](https://docs.merchkit.com/api-reference/list-categories.md): Returns a paginated list of categories. Filter with the DSL `filter[<key>][<operator>]=<value>` (operators: contains, equals, notEquals, notContains, startsWith, endsWith, blank, notBlank, greaterThan, lessThan, greaterThanOrEqual, lessThanOrEqual). Use `blank`/`notBlank` to find records missing an…
- [List enabled channels](https://docs.merchkit.com/api-reference/list-enabled-channels.md): The channels enabled for this workspace. Read-only — channels are a global, platform-seeded catalog.
- [List products](https://docs.merchkit.com/api-reference/list-products.md): Returns a paginated list of products. Filter with the DSL `filter[<key>][<operator>]=<value>` (operators: contains, equals, notEquals, notContains, startsWith, endsWith, blank, notBlank, greaterThan, lessThan, greaterThanOrEqual, lessThanOrEqual). Use `blank`/`notBlank` to find records missing an at…
- [List saved grid views](https://docs.merchkit.com/api-reference/list-saved-grid-views.md): Saved table views for an entity type.
- [List vendors](https://docs.merchkit.com/api-reference/list-vendors.md): Returns a paginated list of vendors. Filter with the DSL `filter[<key>][<operator>]=<value>` (operators: contains, equals, notEquals, notContains, startsWith, endsWith, blank, notBlank, greaterThan, lessThan, greaterThanOrEqual, lessThanOrEqual). Use `blank`/`notBlank` to find records missing an att…
- [Poll an async job](https://docs.merchkit.com/api-reference/poll-an-async-job.md): Status + progress of an asynchronous operation (bulk write, import, export, workflow run).
- [Set asset attribute values](https://docs.merchkit.com/api-reference/set-asset-attribute-values.md): Sets one or more attribute values in a single audited write (the enrichment surface). Unknown keys are rejected with 400.
- [Set category attribute values](https://docs.merchkit.com/api-reference/set-category-attribute-values.md): Sets one or more attribute values in a single audited write (the enrichment surface). Unknown keys are rejected with 400.
- [Set product attribute values](https://docs.merchkit.com/api-reference/set-product-attribute-values.md): Sets one or more attribute values in a single audited write (the enrichment surface). Unknown keys are rejected with 400.
- [Set vendor attribute values](https://docs.merchkit.com/api-reference/set-vendor-attribute-values.md): Sets one or more attribute values in a single audited write (the enrichment surface). Unknown keys are rejected with 400.
- [Update a saved grid view](https://docs.merchkit.com/api-reference/update-a-saved-grid-view.md): Provided list fields (visibleColumns/pinned/sorting/filters) replace the current ones.
- [Update an attribute class](https://docs.merchkit.com/api-reference/update-an-attribute-class.md): `attributeMappings` is a full replacement (provide all categories).
- [Update an attribute definition](https://docs.merchkit.com/api-reference/update-an-attribute-definition.md): Identified by `key` + `entityType` (in the body). Provide only fields to change; array fields replace wholesale.
- [Update asset top-level fields](https://docs.merchkit.com/api-reference/update-asset-top-level-fields.md): Currently the variant parent (`parent_entity`, nullable to clear). Attribute values are set via the attributes sub-resource.
- [Update category top-level fields](https://docs.merchkit.com/api-reference/update-category-top-level-fields.md): Currently the variant parent (`parent_entity`, nullable to clear). Attribute values are set via the attributes sub-resource.
- [Update product top-level fields](https://docs.merchkit.com/api-reference/update-product-top-level-fields.md): Currently the variant parent (`parent_entity`, nullable to clear). Attribute values are set via the attributes sub-resource.
- [Update vendor top-level fields](https://docs.merchkit.com/api-reference/update-vendor-top-level-fields.md): Currently the variant parent (`parent_entity`, nullable to clear). Attribute values are set via the attributes sub-resource.
- [Workspace change feed](https://docs.merchkit.com/api-reference/workspace-change-feed.md): The account-wide audit feed. Agents poll with `since` to detect what changed.
- [Authentication](https://docs.merchkit.com/developers/authentication.md): Authenticate with workspace API keys: bearer mk_live_ tokens, one key per workspace, and per-resource read/write scopes.
- [Conventions](https://docs.merchkit.com/developers/conventions.md): Cross-cutting conventions: the pagination envelope, the filter DSL, the machine-recoverable error envelope, async jobs, and reference attributes.
- [MCP Server](https://docs.merchkit.com/developers/mcp.md): Operate your Merchkit catalog from Claude and other agents over the remote MCP server, authenticated with the same mk_live_ API key.
- [API Overview](https://docs.merchkit.com/developers/overview.md): What the Merchkit API is, how to think about products and attributes, and where to find the base URL, OpenAPI spec, and llms.txt.
- [Merchkit Documentation](https://docs.merchkit.com/index.md): Guides for using Merchkit and the developer reference for the Merchkit API and MCP server.
- [Using Acceptable Values to Constrain AI Output](https://docs.merchkit.com/product/attributes-and-enrichment/acceptable-values.md): Lock AI-generated data to specific approved values for consistency. Learn when to use Acceptable Values, how to set them up, and how they improve data quality at scale.
- [Attributes & Enrichment](https://docs.merchkit.com/product/attributes-and-enrichment/attributes-and-enrichment.md): Configure attributes, write AI prompts, run enrichment, and review AI-generated content for your product catalog.
- [Quick Start: Auto-Created Attributes from Integrations](https://docs.merchkit.com/product/attributes-and-enrichment/auto-created-attributes.md): When you import from Shopify or another connected platform, Merchkit automatically creates attributes from your existing fields and metafields. Here's how to find them and use them.
- [Building Dependent Attributes with Insert Value](https://docs.merchkit.com/product/attributes-and-enrichment/building-dependent-attributes.md): Use {{ }} tags and Required Values to create attributes that depend on other attributes. Build attribute chains where AI reads data from one field to enrich another.
- [Bulk Enrichment for Large Catalogs](https://docs.merchkit.com/product/attributes-and-enrichment/bulk-enrichment.md): Strategies and best practices for enriching catalogs with thousands to hundreds of thousands of products efficiently.
- [Configuring an Attribute for AI Enrichment](https://docs.merchkit.com/product/attributes-and-enrichment/configuring-attribute-for-ai.md): Walk through the Configure Attribute panel step-by-step. Learn how to set up each field—from Product Data to Prompts to Acceptable Values—so your AI enrichment works the way you want.
- [Creating Custom Attributes](https://docs.merchkit.com/product/attributes-and-enrichment/creating-custom-attributes.md): Build new attributes from scratch to capture data that matters to your catalog. Learn the naming conventions, field types, and workflow for creating custom attributes.
- [Editing and Overriding AI Output](https://docs.merchkit.com/product/attributes-and-enrichment/editing-overriding-output.md): Manually edit AI-generated values in your Products table, understand how manual edits interact with re-runs, and establish a feedback loop to improve your enrichment configuration.
- [Enrichment Quality: What 'Good' Looks Like](https://docs.merchkit.com/product/attributes-and-enrichment/enrichment-quality.md): Learn what quality AI-generated content looks like and how to establish benchmarks for your enriched catalog.
- [Field Type Guide: Text, Number, Image, Formula, Reference Lookup](https://docs.merchkit.com/product/attributes-and-enrichment/field-type-guide.md): Comprehensive reference for every field type. Learn when to use each one, how AI works with it, and how to configure it for your data needs.
- [Parent/Child Product Relationships](https://docs.merchkit.com/product/attributes-and-enrichment/parent-child-relationships.md): Use parent/child product relationships to model series and variants, share Sources across related SKUs, and inherit attribute values from parent to child.
- [Re-running Enrichment](https://docs.merchkit.com/product/attributes-and-enrichment/rerunning-enrichment.md): Update your AI prompts and re-run enrichment to improve attribute values across your catalog.
- [Reviewing AI-Generated Content](https://docs.merchkit.com/product/attributes-and-enrichment/reviewing-ai-content.md): Learn how to assess enrichment results in your Products table, spot-check quality across categories, and identify issues to fix.
- [Running Your First Enrichment](https://docs.merchkit.com/product/attributes-and-enrichment/running-first-enrichment.md): Execute AI enrichment on your products by selecting them in the Products view and using the Generate dropdown to populate attributes automatically.
- [Understanding Attributes in Merchkit](https://docs.merchkit.com/product/attributes-and-enrichment/understanding-attributes.md): Learn what attributes are, where to find them, and why they're central to both your data structure and AI enrichment setup.
- [Working with Categories](https://docs.merchkit.com/product/attributes-and-enrichment/working-with-categories.md): Organize your products into a taxonomy using Merchkit's Categories page. Understand category-level attributes and why channel-specific categories matter for Wayfair, Walmart, and other platforms.
- [Writing Effective AI Prompts](https://docs.merchkit.com/product/attributes-and-enrichment/writing-effective-prompts.md): Master the Prompt field to get high-quality AI-generated attribute values. Learn best practices, formatting tips, and how to iterate with the Edit with AI button.
- [Adding a Channel](https://docs.merchkit.com/product/channels-and-content-generation/adding-a-channel.md): Add a new sales channel to Merchkit in just a few steps and start generating marketplace-specific content.
- [Channel Attribute Templates](https://docs.merchkit.com/product/channels-and-content-generation/channel-attribute-templates.md): Learn about pre-loaded channel attributes and default AI prompts. Understand what comes out of the box and what you can customize.
- [Understanding the Channel Grid View](https://docs.merchkit.com/product/channels-and-content-generation/channel-grid-view.md): Explore the dedicated per-channel grid view, channel-specific attributes, and category views for marketplaces with per-category requirements like Wayfair.
- [Channel-Specific Guides](https://docs.merchkit.com/product/channels-and-content-generation/channel-specific-guides.md): Deep-dive guides for major channels including Wayfair, Walmart, Amazon, Google Merchant, ChatGPT/GEO, Houzz, Mirakl, and Nordstrom Rack. Channel-specific requirements and tips.
- [Channels & Content Generation](https://docs.merchkit.com/product/channels-and-content-generation/channels-and-content-generation.md): Generate channel-specific product content, manage channel views, and export data for marketplaces and sales channels.
- [Continuous Optimization: Refining Live Listings](https://docs.merchkit.com/product/channels-and-content-generation/continuous-optimization.md): Iteratively improve channel content based on performance data. Refine prompts, regenerate listings, and monitor results to boost sales.
- [Customizing Channel Attribute Prompts](https://docs.merchkit.com/product/channels-and-content-generation/customizing-channel-prompts.md): Learn how to modify default AI prompts for channel attributes. Understand when to customize versus when to use defaults.
- [Exporting Channel Data](https://docs.merchkit.com/product/channels-and-content-generation/exporting-channel-data.md): Download channel-formatted output and submit your marketplace feeds. Learn export formats and submission workflows.
- [Feed Validation & Error Resolution](https://docs.merchkit.com/product/channels-and-content-generation/feed-validation-errors.md): Diagnose and fix common channel and feed rejection reasons. Understand channel-specific error patterns and how to resolve them.
- [Generating Channel Content](https://docs.merchkit.com/product/channels-and-content-generation/generating-channel-content.md): Select SKUs and generate marketplace-ready content for your channels using Merchkit's AI-powered generation engine.
- [How Channels Work in Merchkit](https://docs.merchkit.com/product/channels-and-content-generation/how-channels-work.md): Understand how Merchkit channels function as dedicated content generation destinations with their own grid views, attribute sets, and formatting requirements—distinct from your main Products view and Integrations.
- [Pre-Export Validation Checklist](https://docs.merchkit.com/product/channels-and-content-generation/pre-export-validation.md): Verify your channel data is complete, accurate, and error-free before exporting to marketplaces.
- [Getting Started](https://docs.merchkit.com/product/getting-started/getting-started.md): Learn what Merchkit is, understand the core concepts, and get oriented with the interface before importing your first catalog.
- [Key Concepts & Terminology](https://docs.merchkit.com/product/getting-started/key-concepts-and-terminology.md): Learn the core building blocks of Merchkit — Products, Sources, Attributes, Categories, Integrations, and Channels — and how they relate to each other.
- [Navigating the Merchkit Interface](https://docs.merchkit.com/product/getting-started/navigating-the-interface.md): A visual walkthrough of Merchkit's sidebar navigation — where to find Products, Categories, Vendors, Images, Sources, Channels, Attributes, Workflows, and Integrations.
- [From Zero to Optimized Catalog in 7 Days](https://docs.merchkit.com/product/getting-started/onboarding-roadmap.md): A step-by-step checklist for your first week in Merchkit — from importing your catalog to having a fully enriched product database ready for channel publishing.
- [Understanding the Products View](https://docs.merchkit.com/product/getting-started/understanding-products-view.md): A detailed walkthrough of the Products table — the toolbar, table columns, Import and Export dropdowns, per-product actions, and the action bar for bulk operations like Generate.
- [What is Merchkit?](https://docs.merchkit.com/product/getting-started/what-is-merchkit.md): A quick overview of what Merchkit does, who it's for, and how it fits into your product data workflow — from raw catalog data to enriched, channel-ready content.
- [Glossary](https://docs.merchkit.com/product/glossary/glossary.md): Complete glossary of Merchkit terms, concepts, and their definitions.
- [Glossary & Terminology](https://docs.merchkit.com/product/glossary/glossary-terms.md): Canonical definitions for all Merchkit terms, UI labels, and synonym mappings. Use this glossary to understand Merchkit's vocabulary and find the right term when searching for help.
- [Connecting an Integration](https://docs.merchkit.com/product/integrations-and-field-mapping/connecting-an-integration.md): Step-by-step instructions for authenticating and connecting your first platform integration.
- [How Integrations Work in Merchkit](https://docs.merchkit.com/product/integrations-and-field-mapping/how-integrations-work.md): Learn how integrations connect your external platforms to Merchkit for automated data sync.
- [Integrations & Field Mapping](https://docs.merchkit.com/product/integrations-and-field-mapping/integrations-and-field-mapping.md): Connect Merchkit to external platforms, configure import/export field mapping, and manage data syncing.
- [Working with Metafields and Variants](https://docs.merchkit.com/product/integrations-and-field-mapping/metafields-and-variants.md): Configure import and export mapping for product metafields and variants.
- [Platform-Specific Integration Guides](https://docs.merchkit.com/product/integrations-and-field-mapping/platform-specific-guides.md): Platform quirks, auto-mapping behavior, and common gotchas for each supported integration.
- [Setting Up Export Mapping](https://docs.merchkit.com/product/integrations-and-field-mapping/setting-up-export-mapping.md): Configure which Merchkit columns map to platform fields when exporting your enriched data.
- [Setting Up Import Mapping](https://docs.merchkit.com/product/integrations-and-field-mapping/setting-up-import-mapping.md): Configure which platform fields map to Merchkit columns when importing product data.
- [Triggering an Integration Import or Export](https://docs.merchkit.com/product/integrations-and-field-mapping/triggering-integration-sync.md): Run integration syncs from the Products toolbar and understand sync status and failures.
- [Understanding Field Mapping](https://docs.merchkit.com/product/integrations-and-field-mapping/understanding-field-mapping.md): Learn what field mapping is and why it's critical for integration success.
- [Using Import Filters](https://docs.merchkit.com/product/integrations-and-field-mapping/using-import-filters.md): Control which products import from your platform using filtering rules.
- [Formula Functions Reference](https://docs.merchkit.com/product/reference/formula-functions.md): Complete reference of all available functions for the Formula field type in Merchkit — text, logical, and numeric functions with examples.
- [Reference](https://docs.merchkit.com/product/reference/reference.md): Technical reference documentation for Merchkit — formula functions, field types, and detailed specifications.
- [Adding Sources to a Product](https://docs.merchkit.com/product/sources-and-importing/adding-sources-to-product.md): Step-by-step guide to attaching URLs, text, and documents as sources for individual products.
- [Bulk Importing Sources](https://docs.merchkit.com/product/sources-and-importing/bulk-importing-sources.md): Import sources in bulk via CSV from the Sources sidebar page, ideal for attaching URLs or documents to many products at once.
- [How Data Gets Into Merchkit](https://docs.merchkit.com/product/sources-and-importing/how-data-gets-into-merchkit.md): Understand the three ways to get data into Merchkit: CSV import, integration imports, and sources for AI enrichment.
- [How Sources Work](https://docs.merchkit.com/product/sources-and-importing/how-sources-work.md): Understand what Sources are, why they matter for AI enrichment, and how they differ from product imports.
- [Import Validation: Understanding Errors & Warnings](https://docs.merchkit.com/product/sources-and-importing/import-validation-errors.md): Diagnose and fix common import errors and warnings
- [Importing Your First Catalog via CSV](https://docs.merchkit.com/product/sources-and-importing/importing-first-catalog-csv.md): Step-by-step walkthrough of the three-step CSV import flow: choose file, preview data, and map columns.
- [Managing Product Images](https://docs.merchkit.com/product/sources-and-importing/managing-product-images.md): Upload, organize, and use product images for AI enrichment
- [Preparing Your Data for Import](https://docs.merchkit.com/product/sources-and-importing/preparing-your-data-for-import.md): File format requirements, data structure best practices, and platform-specific export instructions for CSV import preparation.
- [Re-importing & Updating Existing Products](https://docs.merchkit.com/product/sources-and-importing/reimporting-updating-products.md): Update your product catalog by re-importing CSV data
- [Sources & Importing Your Data](https://docs.merchkit.com/product/sources-and-importing/sources-and-importing.md): Everything about getting data into Merchkit — CSV imports, integration syncs, sources for AI enrichment, vendors, images, and troubleshooting import issues.
- [Working with Vendors](https://docs.merchkit.com/product/sources-and-importing/working-with-vendors.md): Manage vendor information and set up vendor-level attributes in Merchkit
- [Account & Access Issues](https://docs.merchkit.com/product/troubleshooting/account-access-issues.md): Resolve login problems, password resets, permission errors, and workspace access issues.
- [Attribute & Enrichment Issues](https://docs.merchkit.com/product/troubleshooting/attribute-enrichment-issues.md): Debug AI generation problems by checking your prompt, acceptable values, source data, and dependencies.
- [Channel & Feed Errors](https://docs.merchkit.com/product/troubleshooting/channel-feed-errors.md): Resolve marketplace channel rejections, feed validation failures, and submission errors for Walmart, Amazon, Google Merchant, and other channels.
- [Import & Source Errors](https://docs.merchkit.com/product/troubleshooting/import-source-errors.md): Troubleshoot CSV import errors, source encoding issues, and document upload problems.
- [Integration & Field Mapping Errors](https://docs.merchkit.com/product/troubleshooting/integration-mapping-errors.md): Debug Shopify, WooCommerce, BigCommerce, and other integration connection failures, sync errors, and field mapping issues.
- [Troubleshooting](https://docs.merchkit.com/product/troubleshooting/troubleshooting.md): Diagnose and fix common issues with imports, enrichment, integrations, channels, and account access.

## OpenAPI Specs

- [openapi](https://www.merchkit.com/api/v1/openapi)

## Optional

- [merchkit.com](https://www.merchkit.com)