Loja

ecommercenamespace

Catálogo, produtos e resgate de itens.

5métodos

ecommercenamespace

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

getItem

GET/ecommerce/items/:id

Assinatura:

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

Parâmetros de rota

Nome	Tipo
id	string

Tipos

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

Exemplo

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

Testar esta função no playground

listBrands

GET/ecommerce/brands

Assinatura:

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

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

Exemplo

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

Testar esta função no playground

listCategories

GET/ecommerce/categories

Assinatura:

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

Tipos

type ListCategoriesResponse = unknown;

Exemplo

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

Testar esta função no playground

listItems

GET/ecommerce/items

Assinatura:

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

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

Exemplo

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

Testar esta função no playground

redeemItem

POST/ecommerce/items/:id/redeem

Assinatura:

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

Parâmetros de rota

Nome	Tipo
id	string

Tipos

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

Exemplo

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

Testar esta função no playground