> For the complete documentation index, see [llms.txt](https://docs.osmos.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.osmos.io/source-connectors/shopee.md).

# Shopee

## Overview

You can create a Shopee Connector to read from your Shopee account API.\
The schema for this Source Connector is defined by the selected columns from the query.

## Prerequisites

Required information:

* Shopee App ID
* Shopee Secret
* GraphQL Query

## Creating a Shopee Source Connector

**Step 1:** After selecting **+ New Connector**, under the **System** prompt, click **Shopee**

<figure><img src="/files/BoetOCE8H6bTdOHnr3fa" alt=""><figcaption></figcaption></figure>

**Step 2:** Enter a **Connector Name**&#x20;

**Step 3:** Select **Source Connector**

### Steps 4 & 5: Authentication

#### **App ID & Secret**

**1:** To find the App ID, first Go to your Shopee Affiliate Homepage, click "Open API".

<figure><img src="/files/gprcTMoXKfpf1juIwmZv" alt=""><figcaption></figcaption></figure>

**2:** Copy your App ID and secret.

<figure><img src="/files/7sx6DONClTr1xmBZyJz7" alt=""><figcaption></figcaption></figure>

### Step 6: GraphQL Query

Provide a query to access the data through the Shopee API.&#x20;

{% hint style="info" %}
**Note:** the schema for this source Connector is defined by the selected columns from the query.&#x20;
{% endhint %}

## Advanced Options

**Header Normalization**

The source file may have characters at the start or end that includes spaces, tabs, carriage returns and line endings.  You can choose to keep all characters from the source or remove all whitespace.  **Select one of the options:**

1. **Don't normalize headers. Use headers exactly as they appear in the source:** If this option is selected, we will retain all characters from the source file.
2. **Remove extra whitespace and other common untypable characters from headers:** If this option is selected, we remove all whitespace (spaces, tabs, carriage returns, line endings) at start/end.


---

# 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, and the optional `goal` query parameter:

```
GET https://docs.osmos.io/source-connectors/shopee.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.