---
title: "Loja"
description: "Catálogo, produtos e resgate de itens."
---
<div class="lm-ref-kicker"><code>ecommerce</code><span>namespace</span></div>

Catálogo, produtos e resgate de itens.

<div class="lm-ref-stats lm-ref-stats--compact">
  <div class="lm-ref-stat"><strong>5</strong><span>métodos</span></div>
  <div class="lm-ref-stat"><code>ecommerce</code><span>namespace</span></div>
</div>

> Esta página é gerada automaticamente pelo `@luckymaker/sdk-generator`. Não edite manualmente.

## `getItem`

<div class="lm-endpoint"><span class="lm-http lm-http--get">GET</span><code>/ecommerce/items/:id</code></div>

Assinatura:

```ts
getItem(id: string, settings?: SdkSettings): Promise<GetItemResponse>
```

### Parâmetros de rota

| Nome | Tipo |
|---|---|
| `id` | `string` |

### Tipos

```ts
type GetItemParams = { "id": string; };
type GetItemResponse = unknown;
```

### Exemplo

```ts
const response = await sdk.ecommerce.getItem("string");
```

<a class="lm-playground-link" href="/docs/guias/playground/?namespace=ecommerce&method=getItem">Testar esta função no playground <svg class="lm-arrow-icon" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true"><path d="M5 12h14"/><path d="m12 5 7 7-7 7"/></svg></a>

## `listBrands`

<div class="lm-endpoint"><span class="lm-http lm-http--get">GET</span><code>/ecommerce/brands</code></div>

Assinatura:

```ts
listBrands(query?: ListBrandsQuery, settings?: SdkSettings): Promise<ListBrandsResponse>
```

### Query

| Nome | Tipo | Obrigatório |
|---|---|---|
| `page` | `number` | não |
| `ids` | `string` | não |
| `slugs` | `string` | não |
| `q` | `string` | não |

### Tipos

```ts
type ListBrandsQuery = { "page"?: number; "ids"?: string; "slugs"?: string; "q"?: string; };
type ListBrandsResponse = unknown;
```

### Exemplo

```ts
const response = await sdk.ecommerce.listBrands();
```

<a class="lm-playground-link" href="/docs/guias/playground/?namespace=ecommerce&method=listBrands">Testar esta função no playground <svg class="lm-arrow-icon" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true"><path d="M5 12h14"/><path d="m12 5 7 7-7 7"/></svg></a>

## `listCategories`

<div class="lm-endpoint"><span class="lm-http lm-http--get">GET</span><code>/ecommerce/categories</code></div>

Assinatura:

```ts
listCategories(settings?: SdkSettings): Promise<ListCategoriesResponse>
```

### Tipos

```ts
type ListCategoriesResponse = unknown;
```

### Exemplo

```ts
const response = await sdk.ecommerce.listCategories();
```

<a class="lm-playground-link" href="/docs/guias/playground/?namespace=ecommerce&method=listCategories">Testar esta função no playground <svg class="lm-arrow-icon" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true"><path d="M5 12h14"/><path d="m12 5 7 7-7 7"/></svg></a>

## `listItems`

<div class="lm-endpoint"><span class="lm-http lm-http--get">GET</span><code>/ecommerce/items</code></div>

Assinatura:

```ts
listItems(query?: ListItemsQuery, settings?: SdkSettings): Promise<ListItemsResponse>
```

### Query

| Nome | Tipo | Obrigatório |
|---|---|---|
| `highlighted` | `boolean` | não |
| `related_to` | `string \| number` | não |
| `category` | `string \| number` | não |
| `brand` | `string` | não |
| `q` | `string` | não |
| `limit` | `number` | não |
| `offset` | `number` | não |

### Tipos

```ts
type ListItemsQuery = { "highlighted"?: boolean; "related_to"?: string | number; "category"?: string | number; "brand"?: string; "q"?: string; "limit"?: number; "offset"?: number; };
type ListItemsResponse = unknown;
```

### Exemplo

```ts
const response = await sdk.ecommerce.listItems();
```

<a class="lm-playground-link" href="/docs/guias/playground/?namespace=ecommerce&method=listItems">Testar esta função no playground <svg class="lm-arrow-icon" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true"><path d="M5 12h14"/><path d="m12 5 7 7-7 7"/></svg></a>

## `redeemItem`

<div class="lm-endpoint"><span class="lm-http lm-http--post">POST</span><code>/ecommerce/items/:id/redeem</code></div>

Assinatura:

```ts
redeemItem(id: string, settings?: SdkSettings): Promise<RedeemItemResponse>
```

### Parâmetros de rota

| Nome | Tipo |
|---|---|
| `id` | `string` |

### Tipos

```ts
type RedeemItemParams = { "id": string; };
type RedeemItemResponse = unknown;
```

### Exemplo

```ts
const response = await sdk.ecommerce.redeemItem("string");
```

<a class="lm-playground-link" href="/docs/guias/playground/?namespace=ecommerce&method=redeemItem">Testar esta função no playground <svg class="lm-arrow-icon" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true"><path d="M5 12h14"/><path d="m12 5 7 7-7 7"/></svg></a>