# Authentication
Source: https://api-docs.levanta.io/authentication

Authenticate your requests to Levanta with an API key

<AccordionGroup>
  <Accordion title="1. Create a Levanta Account">
    Visit [app.levanta.io](https://app.levanta.io/auth/sign-up) to create a Levanta account.
  </Accordion>

  <Accordion title="2. Generate an API Key">
    Navigate to Settings > API and click "Generate API Key". This will generate a new
    API key that you can use to authenticate your requests.
  </Accordion>

  <Accordion title="3. Authenticate Requests">
    To authenticate your requests, include the `Authorization` header with the value `Bearer <api_key>`.
    For example:

    ```javascript theme={null}
    const headers = {
        Authorization: 'Bearer <api_key>'
    };
    await fetch('https://app.levanta.io/api/<creator|seller>/<version>/<endpoint>', {
        method: '...',
        headers
    })
    ```
  </Accordion>
</AccordionGroup>


# Help
Source: https://api-docs.levanta.io/help

Having trouble? We're here to help

Still having trouble? We're here to help! Reach out to us at [cs@levanta.io](mailto:cs@levanta.io)
or open a ticket in our [Levanta Support Portal](https://levanta.io/contact-support/).


# Introduction
Source: https://api-docs.levanta.io/introduction-v2

Welcome to Levanta's v2 API Documentation.

<Check>These APIs support multiple retailers such as Amazon, Walmart, and Shopify.</Check>

## Understanding Levanta's APIs

<CardGroup>
  <Card title="Authentication" icon="lock" href="/authentication">
    Gain access to Levanta APIs
  </Card>

  <Card title="Pagination" icon="Book" href="/pagination">
    Learn how to paginate through Levanta API results
  </Card>

  <Card title="Marketplaces" icon="earth-americas" href="/marketplaces-v2">
    Levanta supports many marketplaces
  </Card>

  <Card title="Help" icon="circle-question" href="/help" />
</CardGroup>

## Endpoint Documentation

Browse our API documentation with an interactive playground.

<CardGroup>
  <Card title="Creator v2 API Documentation" icon="computer-mouse-scrollwheel" href="/v2/creator">
    List products, generate links, and pull conversions.
  </Card>

  <Card title="Seller v2 API Documentation" icon="computer-mouse-scrollwheel" href="/v2/seller">
    List brands, creators, products, and pull performance reports across all marketplaces.
  </Card>

  <Card title="Creator v1 API Documentation" icon="computer-mouse-scrollwheel" href="/creator/reports/list-reports">
    To list Amazon Attribution & Creator Connection Reports see the V1 Creator API
  </Card>
</CardGroup>


# Levanta MCP for Sellers
Source: https://api-docs.levanta.io/levanta-mcp

Connect Claude and Open AI assistants to your Levanta data through the Model Context Protocol.

Levanta MCP for Sellers lets AI assistants such as Claude and ChatGPT securely access your Levanta data — brands, creators,
products, and performance reports — so you can ask questions and build reports
in natural language.

## What is Levanta MCP for Sellers?

* For Levanta Sellers only
* A hosted MCP connection that gives your AI assistant tool-based access to
  your Levanta brands, creators, products, and performance reports.
* Authenticated via **OAuth**, so you sign in with your existing Levanta account
  and the assistant only gets access to data your account can already see.
* Accessible from any AI tool that supports remote MCP connections.

**MCP URL:**

```
https://app.levanta.io/api/mcp
```

## Quick start

<CardGroup>
  <Card title="Claude" icon="https://mintcdn.com/levanta/TfSrZ6LA6QjNqV3k/icons/claude.svg?fit=max&auto=format&n=TfSrZ6LA6QjNqV3k&q=85&s=71cd672811174ac58f7b3c0d44810bb1" href="#claude">
    See instructions
  </Card>

  <Card title="ChatGPT" icon="https://mintcdn.com/levanta/TfSrZ6LA6QjNqV3k/icons/chatgpt.svg?fit=max&auto=format&n=TfSrZ6LA6QjNqV3k&q=85&s=0f4dcf8d56952102df6decc981e13433" href="#chatgpt">
    See instructions
  </Card>
</CardGroup>

## Authentication

Levanta MCP for Sellers uses **OAuth**, so you authorize access to your Levanta
account directly from your MCP client.

* Each client (for example, Claude or ChatGPT) registers as an OAuth application
  with Levanta.
* When you connect Levanta MCP for Sellers, you're redirected to Levanta to sign in and
  grant access.
* No API key or token configuration is required.

<Note>
  Levanta MCP respects your team membership and role. You can only access the brands, creators, products, and reports
  your Levanta account already has permission to view.
</Note>

## Installation instructions

### Claude

You can add Levanta as a custom connector:

1. Navigate to **Settings > Connectors**.
2. Click **Add custom connector**.
3. Enter the Levanta MCP URL: `https://app.levanta.io/api/mcp`
4. Click **Add** to save the connector.
5. Follow the prompts to authenticate with your Levanta account.

To use the connector in a conversation:

1. Click the **+** button in your chat interface.
2. Select **Connectors**.
3. Toggle the Levanta connector on for that conversation.

<Note>
  Custom connectors using remote MCP are not available on all Claude plans. See the [Claude support
  page](https://support.claude.com/en/articles/11175166-getting-started-with-custom-connectors-using-remote-mcp) for
  more information.
</Note>

### ChatGPT

ChatGPT connects to custom MCP apps through **developer mode**. You'll first
enable developer mode, then create an app pointing at Levanta MCP for Sellers.

1. Enable developer mode: go to **Settings → Apps → Advanced settings → Developer mode**.
2. Open ChatGPT **Apps** settings and, next to **Advanced settings**, click **Create app**.
   (The **Create app** button only appears while developer mode is enabled.)
3. Enter a name (for example, "Levanta") and the Levanta MCP URL: `https://app.levanta.io/api/mcp`
4. Set the authentication method to **OAuth**, then create the app and follow the
   prompts to sign in to your Levanta account.
5. Your new app appears under **Drafts** in the app settings. Open its details
   page to toggle the available tools on.

To use it in a conversation, choose **Developer mode** from the **+** menu in the
composer and select the Levanta app for that conversation.

<Note>
  Developer mode is available to Pro, Plus, Business, Enterprise, and Education accounts on the web. It grants full
  MCP client access, so review write actions carefully before confirming them. See the [ChatGPT developer mode
  docs](https://developers.openai.com/api/docs/guides/developer-mode) for details.
</Note>

## Example workflows

Once connected, you can ask your MCP-enabled assistant to:

* "List all of my brands on Levanta."
* "Show me the creators currently partnered with my brand."
* "Find my top products by commission rate this month."
* "Summarize my seller performance totals for the last 30 days."
* "Which creators are driving the most sales for my brand?"
* "Build a product performance report and highlight my best ROAS products."

## Available tools

Levanta MCP for Sellers includes a curated set of read-only tools for exploring
your account and pulling performance reports.

| Tool                                   | Description                                                                                                                                                          |
| -------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `whoami`                               | Returns the authenticated Levanta user and team information.                                                                                                         |
| `seller_list_brands`                   | Lists brands for the authenticated seller team.                                                                                                                      |
| `seller_list_creators`                 | Lists creators with active partnerships for the authenticated seller team.                                                                                           |
| `seller_list_products`                 | Lists products for a seller brand, including product identifiers, marketplace, commission, availability, and status.                                                 |
| `seller_get_performance_report_totals` | Returns total seller performance report metrics across the full filtered dataset.                                                                                    |
| `seller_product_report`                | Lists seller product performance report rows aggregated by product, including sales, commission, ROAS, conversion, click, detail page view, and add-to-cart metrics. |
| `seller_creator_report`                | Lists seller creator performance report rows aggregated by creator, including sales, commission, ROAS, conversion, click, detail page view, and add-to-cart metrics. |
| `knowledge_base`                       | Returns the public Levanta knowledge base articles.                                                                                                                  |

<Note>
  All MCP date and datetime inputs are interpreted in UTC. When you ask for relative ranges like "today", "yesterday",
  or "last 7 days", they resolve using UTC calendar boundaries.
</Note>

## Troubleshooting

If your MCP client cannot connect or tools fail to run:

<AccordionGroup>
  <Accordion title="Restart your client or CLI tool">
    After installation, you may need to restart your client or CLI tool to load the new MCP configuration.
  </Accordion>

  <Accordion title="Check the connection URL">
    Make sure the Levanta MCP URL is set to `https://app.levanta.io/api/mcp`.
  </Accordion>

  <Accordion title="Re-authenticate Levanta MCP">
    Access tokens are short-lived. If your session has expired, re-authorize Levanta MCP in your client so it can
    request fresh tokens. Most MCP clients provide a way to re-authenticate MCP connections.
  </Accordion>

  <Accordion title="Verify your account access">
    Confirm that your Levanta account has access to the brands and data you expect to see. Levanta MCP can only
    access what your account can.
  </Accordion>
</AccordionGroup>

## Need help?

Reach out to our team through [Levanta Support](mailto:cs@levanta.io).


# Marketplaces
Source: https://api-docs.levanta.io/marketplaces-v2

Levanta supports marketplaces across our API

The following marketplaces are supported by Levanta:

<ul>
  <li>amazon.com</li>
  <li>amazon.com.mx</li>
  <li>amazon.co.uk</li>
  <li>amazon.ca</li>
  <li>amazon.de</li>
  <li>amazon.es</li>
  <li>amazon.fr</li>
  <li>amazon.it</li>
  <li>amazon.nl</li>
  <li>walmart.com</li>
  <li>shopify.com</li>
</ul>

Endpoints that support a `marketplace` input value will generally accept those values or `all` to scope
the api call to all marketplaces. This union is subject to expand as new marketplaces are added.


# Pagination
Source: https://api-docs.levanta.io/pagination

Paginate through Levanta API results

Levanta uses cursor-based pagination to break a large query result into smaller chunks
that reduces load on our systems. Not all endpoints support pagination, but those that do
will return a `cursor` field in the response. You can use this cursor to fetch the next
page of results. Page size can be set via the `limit` query parameter and cursor can be
set via the `cursor` query parameter. When there are no more results to return the `cursor`
field will be returned as `null`.

## Example

```javascript theme={null}
let cursor = '';
while (cursor !== null) {
    const url = new URL('https://app.levanta.io/api/<creator|seller>/<version>/<endpoint>');
    const search = new URLSearchParams({
        limit: '100',
        cursor,
    });
    url.search = search.toString();
    const response = await fetch(url.toString(), {
        method: '...',
        headers: {
            Authorization: 'Bearer <api_key>',
        },
    });
    const json = await response.json();
    cursor = json.cursor;
}
```


# List Brands
Source: https://api-docs.levanta.io/v2/creator/brands/list-brands

https://app.levanta.io/api/creator/v2/openapi.json get /brands
List all brands in Levanta's marketplace



# List Deals
Source: https://api-docs.levanta.io/v2/creator/deals/list-deals

https://app.levanta.io/api/creator/v2/openapi.json get /deals



# Create Product Link
Source: https://api-docs.levanta.io/v2/creator/links/create-product-link

https://app.levanta.io/api/creator/v2/openapi.json post /links



# Get Product Links Status
Source: https://api-docs.levanta.io/v2/creator/links/get-product-links-status

https://app.levanta.io/api/creator/v2/openapi.json get /links/status



# List Products
Source: https://api-docs.levanta.io/v2/creator/products/list-products

https://app.levanta.io/api/creator/v2/openapi.json get /products



# List Conversion Updates
Source: https://api-docs.levanta.io/v2/creator/reports/list-conversion-updates

https://app.levanta.io/api/creator/v2/openapi.json get /reports/conversions/updates
List conversion updates within a date range [start, end]. Start date must be before end date and the date range must not be greater than 60 days



# List Conversions
Source: https://api-docs.levanta.io/v2/creator/reports/list-conversions

https://app.levanta.io/api/creator/v2/openapi.json get /reports/conversions
List conversions within a date range [start, end]. Start date must be before end date and the date range must not be greater than 60 days



# Get Brand by ID
Source: https://api-docs.levanta.io/v2/seller/brands/get-brand-by-id

https://app.levanta.io/api/seller/v2/openapi.json get /brands/{brand_id}



# List Brands
Source: https://api-docs.levanta.io/v2/seller/brands/list-brands

https://app.levanta.io/api/seller/v2/openapi.json get /brands



# Get Creator by ID
Source: https://api-docs.levanta.io/v2/seller/creators/get-creator-by-id

https://app.levanta.io/api/seller/v2/openapi.json get /creators/{id}



# List Creators
Source: https://api-docs.levanta.io/v2/seller/creators/list-creators

https://app.levanta.io/api/seller/v2/openapi.json get /creators/active
List creators that you have an active partnership with. Filter by brand IDs.



# List Products
Source: https://api-docs.levanta.io/v2/seller/products/list-products

https://app.levanta.io/api/seller/v2/openapi.json get /products
List your products across brands. Filter by brand IDs and product IDs.



# List Conversions
Source: https://api-docs.levanta.io/v2/seller/reports/list-conversions

https://app.levanta.io/api/seller/v2/openapi.json get /reports/conversions
Conversion-level sales data for Walmart and Shopify. Date range must not exceed 60 days.



# List Performance Reports by Brand
Source: https://api-docs.levanta.io/v2/seller/reports/list-performance-reports-by-brand

https://app.levanta.io/api/seller/v2/openapi.json get /reports/performance/brand
Aggregated performance metrics across all marketplaces, grouped by brand.



# List Performance Reports by Creator
Source: https://api-docs.levanta.io/v2/seller/reports/list-performance-reports-by-creator

https://app.levanta.io/api/seller/v2/openapi.json get /reports/performance/creator
Aggregated performance metrics across all marketplaces, grouped by creator.



# List Performance Reports by Date
Source: https://api-docs.levanta.io/v2/seller/reports/list-performance-reports-by-date

https://app.levanta.io/api/seller/v2/openapi.json get /reports/performance/date
Aggregated performance metrics across all marketplaces, grouped by date.



# List Performance Reports by Product
Source: https://api-docs.levanta.io/v2/seller/reports/list-performance-reports-by-product

https://app.levanta.io/api/seller/v2/openapi.json get /reports/performance/product
Aggregated performance metrics across all marketplaces, grouped by product.