# Ready for Commerce > Build on Ready for Commerce: the app's own API, called with an organization's API key, and an MCP server for AI assistants. ## Guides ### Get started - [Introduction](https://developers.readyforcommerce.com/index.md): Ready for Commerce's API: the app's own operations for your programs, and an MCP server for your AI assistant. - [Authentication](https://developers.readyforcommerce.com/authentication.md): Call the API with an API key of your organization: how to create it, send it, keep it safe and replace it. - [Your first call](https://developers.readyforcommerce.com/first-call.md): Three calls, from checking your key to reading your organization and its usage this month. ### Using the API - [Errors](https://developers.readyforcommerce.com/errors.md): Every error has one shape, and a stable code that says what went wrong: decide by it. - [Pagination](https://developers.readyforcommerce.com/pagination.md): Every list answers a page and a cursor to the next one: follow it until it is null. - [Rate limits](https://developers.readyforcommerce.com/rate-limits.md): How many calls a key and an organization may make, what happens past them, and how to retry a write safely. ### AI assistants - [Connect an AI](https://developers.readyforcommerce.com/connect-an-ai.md): Work with your organization from Claude, ChatGPT or another AI assistant through Ready for Commerce's MCP server. ## API reference ### Overview - [API reference](https://developers.readyforcommerce.com/api-reference/introduction.md): The base URL, how a call authenticates, how it fails, and every group of operations. ### Credentials - [Get the calling credential](https://developers.readyforcommerce.com/api-reference/core-get-credential.md): Reads the calling credential: its organization, permissions, limits and the calls it may make now. It counts against no limit. ### Organization - [Get the organization](https://developers.readyforcommerce.com/api-reference/core-get-org.md): Reads the organization's settings: its name, slug and currency. - [Update the organization](https://developers.readyforcommerce.com/api-reference/core-update-org.md): Changes the organization's name or slug. ### Billing - [Get the billing summary](https://developers.readyforcommerce.com/api-reference/core-get-billing.md): Reads the organization's subscription, each module's projected bill and cap, the card's summary and any open invoice. - [Get this month's usage](https://developers.readyforcommerce.com/api-reference/core-get-billing-usage.md): Reads this month's count of each module's units and what is left of their free allowance, without amounts. ### Record types - [List record types](https://developers.readyforcommerce.com/api-reference/core-list-dataio-adapters.md): Lists what the caller may import or export, with each kind’s fields and options. - [Get a record type](https://developers.readyforcommerce.com/api-reference/core-get-dataio-adapter.md): Reads one kind of record the caller may import or export, with how many of them the organization holds. ### Imports - [List imports](https://developers.readyforcommerce.com/api-reference/core-list-imports.md): Lists the organization's imports, newest first, with each one's file, state, counts and who started it. The search reads the file's name; the filter reads file, entity, mode, fields (how many it maps), state (active, succeeded, withErrors, failed or canceled) and its rows' success, warning, error an… - [Start an import](https://developers.readyforcommerce.com/api-reference/core-start-import.md): Starts an import of an uploaded CSV or Excel file that creates or updates records, row by row. - [Create an upload URL](https://developers.readyforcommerce.com/api-reference/core-create-import-upload.md): Gives a URL to upload a CSV or Excel file to with a PUT, for an import; complete the upload once its bytes are sent. - [Complete an upload](https://developers.readyforcommerce.com/api-reference/core-complete-import-upload.md): Completes an import file’s upload once its bytes are sent, so it is checked; its file then turns ready or rejected. - [Fetch a file from a URL](https://developers.readyforcommerce.com/api-reference/core-fetch-import-file.md): Starts bringing a CSV or Excel file from a web address, to import it as an uploaded one; its job answers the file. - [Inspect an import file](https://developers.readyforcommerce.com/api-reference/core-inspect-import.md): Starts a look at an uploaded import file: its worksheets, its header, its first rows and how many rows it has. - [Check an import](https://developers.readyforcommerce.com/api-reference/core-check-import.md): Starts the checks an import would meet with a file and a mapping: the rows that will warn and what blocks its start. - [Write an import's results](https://developers.readyforcommerce.com/api-reference/core-start-import-results.md): Starts writing an ended import's file with each row's result and message, as CSV or Excel; its job answers the file. ### Files - [Get a file's status](https://developers.readyforcommerce.com/api-reference/core-get-file.md): Reads an uploaded file's status, until it is ready or rejected. ### Exports - [List exports](https://developers.readyforcommerce.com/api-reference/core-list-exports.md): Lists the organization's exports, newest first, with each one's file, state, format, size and who started it. The search reads the file's name; the filter reads file, entity (any of the entities it holds), fields (its columns), filters (its conditions), format, state (active, succeeded, failed or ca… - [Start an export](https://developers.readyforcommerce.com/api-reference/core-start-export.md): Starts an export of the chosen fields of the records a filter matches, for one or more kinds of record of one module, to CSV or Excel files, gzipped or zipped on request and several kinds always in one zip, kept 14 days. - [Rename an export](https://developers.readyforcommerce.com/api-reference/core-rename-export.md): Renames a finished export's file, keeping the extensions its file has, so its next download carries the new name. ### Export templates - [List export templates](https://developers.readyforcommerce.com/api-reference/core-list-export-templates.md): Lists the organization's saved export templates of one module, by name, each with the export setup it holds. - [Create an export template](https://developers.readyforcommerce.com/api-reference/core-create-export-template.md): Saves an export setup (its kinds of record, columns, filters and options) as a template under a name unique in the organization. - [Delete an export template](https://developers.readyforcommerce.com/api-reference/core-delete-export-template.md): Deletes a saved export template; the exports made with it stay as they are. - [Update an export template](https://developers.readyforcommerce.com/api-reference/core-update-export-template.md): Renames a saved export template, changes the export setup it holds, or both. ### Jobs - [Get a job](https://developers.readyforcommerce.com/api-reference/core-get-job.md): Reads a job's state and progress. - [List a job's messages](https://developers.readyforcommerce.com/api-reference/core-list-job-messages.md): Lists a job's messages, page by page. - [Get a job's file link](https://developers.readyforcommerce.com/api-reference/core-get-job-file.md): Gives a 5-minute link to download a job's input or output file. - [Cancel a job](https://developers.readyforcommerce.com/api-reference/core-cancel-job.md): Cancels a job that is still running. ### Search - [Search records](https://developers.readyforcommerce.com/api-reference/core-search.md): Finds the organization's records by words, a typo included, grouped by kind. ### Version history - [List a record's versions](https://developers.readyforcommerce.com/api-reference/core-list-versions.md): Lists a record's versions, newest first. - [Compare a version](https://developers.readyforcommerce.com/api-reference/core-get-version.md): Reads a version's state beside the version it is compared with, by default the one before it. - [Restore a version](https://developers.readyforcommerce.com/api-reference/core-restore-version.md): Restores a record to one of its versions. ### Incidents - [List incidents](https://developers.readyforcommerce.com/api-reference/core-list-incidents.md): Lists the organization's problems you may see. - [Mark an incident read or unread](https://developers.readyforcommerce.com/api-reference/core-mark-incident.md): Marks one of the organization's problems read or unread for you. - [Resolve an incident](https://developers.readyforcommerce.com/api-reference/core-resolve-incident.md): Resolves one of the organization's problems. ### Notifications - [List notifications](https://developers.readyforcommerce.com/api-reference/core-list-notifications.md): Lists your notifications, newest first. - [Mark a notification read or unread](https://developers.readyforcommerce.com/api-reference/core-mark-notification.md): Marks one of your notifications read or unread. - [Mark all read](https://developers.readyforcommerce.com/api-reference/core-mark-all-notifications-read.md): Marks all your notifications and the problems you see read. ### Saved views - [List saved views](https://developers.readyforcommerce.com/api-reference/core-list-views.md): Lists the saved views of a table you may read (resource: core.imports or core.exports), yours and every shared one, by name: each with whether it is shared, the search, filters, order and columns it keeps, and whether it is yours. - [Create a saved view](https://developers.readyforcommerce.com/api-reference/core-create-view.md): Saves what a table shows (its search, filters, order and columns) as a named view of yours, private or shared with the organization. Its filter and order read the table's fields: core.imports' file, entity, mode, fields, state (active, succeeded, withErrors, failed or canceled), success, warning, er… - [Set a table's default view](https://developers.readyforcommerce.com/api-reference/core-set-default-view.md): Sets the saved view a table (resource: core.imports or core.exports) opens with for you, any view of it you see, yours or a shared one, or clears it with viewId null. - [Delete a saved view](https://developers.readyforcommerce.com/api-reference/core-delete-view.md): Deletes a saved view of yours; whoever had it as the view their table opens with gets none. - [Update a saved view](https://developers.readyforcommerce.com/api-reference/core-update-view.md): Changes a saved view of yours: renames it, shares it with the organization or makes it private again (which takes it off the others' default), or saves over the search, filters, order and columns it keeps. ### Store connections - [List store connections](https://developers.readyforcommerce.com/api-reference/integrations-list-connections.md): Lists the organization's store connections. - [Connect a store](https://developers.readyforcommerce.com/api-reference/integrations-connect-store.md): Connects a store with its pasted keys, after a live test. - [Reconnect a store](https://developers.readyforcommerce.com/api-reference/integrations-reconnect-store.md): Reconnects a store with new pasted keys, keeping its connection and settings. - [Disconnect a store](https://developers.readyforcommerce.com/api-reference/integrations-disconnect-store.md): Disconnects a store and deletes everything that came from it, touching nothing in the store. ### Products - [List products](https://developers.readyforcommerce.com/api-reference/catalog-list-products.md): Lists the organization's products, the most recently changed first, with each one's title, slug, status and number of variants. The search reads the title; the filter reads status (draft, active, unlisted or archived); the sort reads updatedAt or title. - [Create a product](https://developers.readyforcommerce.com/api-reference/catalog-create-product.md): Creates a product with its options and its variants, each variant one combination of the option values with its identifiers: SKU, GTIN, ISBN, part number (mpn) and custom codes with their label, a GTIN's and an ISBN's check digit verified, each SKU, GTIN and ISBN unique in the organization. Each var… - [Get a product](https://developers.readyforcommerce.com/api-reference/catalog-get-product.md): Gets one product with its options, their values and its variants, each variant with its identifiers in their order (SKU, GTIN, ISBN, part number (mpn) and custom codes with their label), its currency, and its prices and costs as decimal strings in that currency, null where it has none. - [Delete a product](https://developers.readyforcommerce.com/api-reference/catalog-delete-product.md): Deletes a product for good with all its variants, and releases its listings in every store; it cannot be undone. - [Update a product](https://developers.readyforcommerce.com/api-reference/catalog-update-product.md): Changes a product's title, slug, condition, product type, SEO texts, options or variants, only the fields sent, with the version it was read at: a product saved since then is refused. Options and variants are each sent whole, those kept with their ids: one left out is removed, and removing a variant… - [Get a free SKU](https://developers.readyforcommerce.com/api-reference/catalog-get-free-sku.md): Gets a SKU no variant of the organization holds, three letters, three digits and three letters such as KMT-472-BXR, to give a new or changed variant; it is not reserved, so a save that finds it taken by then is refused. - [Update a product's prices](https://developers.readyforcommerce.com/api-reference/catalog-update-product-prices.md): Changes the price, compare-at price, MAP, MSRP and on-hand, supplier and fallback costs of the product's variants it names by id, as decimal strings in each variant's currency such as 19.99, null clearing one, with the version the product was read at; a compare-at price below the price, a price belo… - [Set a product's status](https://developers.readyforcommerce.com/api-reference/catalog-set-product-status.md): Sets a product's status to draft, active, unlisted or archived, from any other, with the version it was read at: a product saved since then is refused, and setting the status it already has changes nothing. - [Duplicate a product](https://developers.readyforcommerce.com/api-reference/catalog-duplicate-product.md): Copies a product as a new draft, its title followed by (Copy), then (Copy 2) and so on, with its description, its options and its variants with their prices, costs, measures and stock settings but without their identifiers, to start a similar product from one that exists. ## Changelog - [Changelog](https://developers.readyforcommerce.com/changelog.md): Every change to the Ready for Commerce API, newest first. ## OpenAPI Specs - [en](/openapi/en.json) > The links below point to documentation indexes. Follow each `/_llms/` index recursively until you reach documentation pages. ## Indexes - [Spanish (64 pages)](https://developers.readyforcommerce.com/_llms/es.txt): Guías, Referencia de la API, Cambios. This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.