> For the complete documentation index, see [llms.txt](https://docs.claret.app/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.claret.app/apis/public-apis/inventory.md).

# Inventory Data

The Inventory APIs allow external systems to create, update, and delete inventory records in Claret. These APIs support complete inventory management workflows including data synchronization and refresh operations.

As with all Claret API endpoints, the Inventory APIs require token authentication. For instructions on how to retrieve and pass through the authentication token, please refer to the [Authentication](/apis/authentication.md) documentation.

{% hint style="info" %}
All API documentation herein contains a `{tenant}` section of the URL path. These should always be replaced with the name of the actual tenant making the API call (i.e., `demo`, `yourcompany`, etc.)
{% endhint %}

## Available Endpoints

| Endpoint                                                              | Method | Description                                                  |
| --------------------------------------------------------------------- | ------ | ------------------------------------------------------------ |
| [Inventory Import](/apis/public-apis/inventory/import.md)             | POST   | Import inventory records via JSON payload or CSV file upload |
| [Inventory Batch Delete](/apis/public-apis/inventory/batch-delete.md) | POST   | Delete inventory records by row targeting or filter criteria |

## Common Workflows

### Full Inventory Refresh

For systems that need to replace all inventory data periodically:

1. Use the [Inventory Batch Delete](/apis/public-apis/inventory/batch-delete.md) API to remove existing records
2. Use the [Inventory Import](/apis/public-apis/inventory/import.md) API to load fresh data

### Incremental Updates

For systems that sync changes incrementally:

1. Use the [Inventory Import](/apis/public-apis/inventory/import.md) API with `allow_record_update: true` to upsert records
2. Use the [Inventory Batch Delete](/apis/public-apis/inventory/batch-delete.md) API to remove specific records that no longer exist in the source system


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.claret.app/apis/public-apis/inventory.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.