Carrinho

cartnamespace

Carrinho persistido, itens, ofertas e validações.

8métodos

cartnamespace

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

`addItems`

POST/cart/:uuid/items

Assinatura:

addItems(body?: AddItemsBody, settings?: SdkSettings): Promise<AddItemsResponse>

sdk.cart.uuid é gerenciado pela SDK. O valor é criado e salvo automaticamente.

Body

Nome	Tipo	Obrigatório
`item`	{ "cartItemId"?: string; "type": "RAFFLE_NUMBERS"; "raffleUUID": string; "amount": number; "cartOffer"?: { "version": 1; "offerId": string; "quantity": number; }; } \| { "cartItemId"?: string; "type": "CREDITS"; "amount": number; "cartOffer"?: false & true; } \| { "cartItemId"?: string; "type": "RAFFLE_NUMBERS"; "kind": "GAMBLING"; "raffleUUID": string; "priceMultiplier": number; "amount": number; "cartOffer"?: false & true; } \| { "cartItemId"?: string; "type": "ECOMMERCE_ITEM"; "amount": number; "itemId": string \| number; "cartOffer"?: false & true; } \| { "cartItemId"?: string; "type": "SUBSCRIPTION"; "amount": number; "planId": string; "cartOffer"?: false & true; } \| Array<{ "cartItemId"?: string; "type": "RAFFLE_NUMBERS"; "raffleUUID": string; "amount": number; "cartOffer"?: { "version": 1; "offerId": string; "quantity": number; }; } \| { "cartItemId"?: string; "type": "CREDITS"; "amount": number; "cartOffer"?: false & true; } \| { "cartItemId"?: string; "type": "RAFFLE_NUMBERS"; "kind": "GAMBLING"; "raffleUUID": string; "priceMultiplier": number; "amount": number; "cartOffer"?: false & true; } \| { "cartItemId"?: string; "type": "ECOMMERCE_ITEM"; "amount": number; "itemId": string \| number; "cartOffer"?: false & true; } \| { "cartItemId"?: string; "type": "SUBSCRIPTION"; "amount": number; "planId": string; "cartOffer"?: false & true; }>	sim
`cpf`	`string`	não
`offers`	`unknown`	não

Tipos

type AddItemsParams = { "uuid": string; };
type AddItemsBody = { "item": { "cartItemId"?: string; "type": "RAFFLE_NUMBERS"; "raffleUUID": string; "amount": number; "cartOffer"?: { "version": 1; "offerId": string; "quantity": number; }; } | { "cartItemId"?: string; "type": "CREDITS"; "amount": number; "cartOffer"?: false & true; } | { "cartItemId"?: string; "type": "RAFFLE_NUMBERS"; "kind": "GAMBLING"; "raffleUUID": string; "priceMultiplier": number; "amount": number; "cartOffer"?: false & true; } | { "cartItemId"?: string; "type": "ECOMMERCE_ITEM"; "amount": number; "itemId": string | number; "cartOffer"?: false & true; } | { "cartItemId"?: string; "type": "SUBSCRIPTION"; "amount": number; "planId": string; "cartOffer"?: false & true; } | Array<{ "cartItemId"?: string; "type": "RAFFLE_NUMBERS"; "raffleUUID": string; "amount": number; "cartOffer"?: { "version": 1; "offerId": string; "quantity": number; }; } | { "cartItemId"?: string; "type": "CREDITS"; "amount": number; "cartOffer"?: false & true; } | { "cartItemId"?: string; "type": "RAFFLE_NUMBERS"; "kind": "GAMBLING"; "raffleUUID": string; "priceMultiplier": number; "amount": number; "cartOffer"?: false & true; } | { "cartItemId"?: string; "type": "ECOMMERCE_ITEM"; "amount": number; "itemId": string | number; "cartOffer"?: false & true; } | { "cartItemId"?: string; "type": "SUBSCRIPTION"; "amount": number; "planId": string; "cartOffer"?: false & true; }>; "cpf"?: string; "offers"?: unknown; };
type AddItemsResponse = unknown;

Exemplo

const response = await sdk.cart.addItems({ "item": { "type": "RAFFLE_NUMBERS", "raffleUUID": "string", "amount": 0 } });

Testar esta função no playground

`getCart`

GET/cart/:uuid

Assinatura:

getCart(settings?: SdkSettings): Promise<GetCartResponse>

sdk.cart.uuid é gerenciado pela SDK. O valor é criado e salvo automaticamente.

Tipos

type GetCartParams = { "uuid": string; };
type GetCartResponse = unknown;

Exemplo

const response = await sdk.cart.getCart();

Testar esta função no playground

`getItems`

GET/cart/:uuid/items

Assinatura:

getItems(settings?: SdkSettings): Promise<GetItemsResponse>

sdk.cart.uuid é gerenciado pela SDK. O valor é criado e salvo automaticamente.

Tipos

type GetItemsParams = { "uuid": string; };
type GetItemsResponse = unknown;

Exemplo

const response = await sdk.cart.getItems();

Testar esta função no playground

`previewIssues`

POST/user/cart/preview-issues

Assinatura:

previewIssues(body?: PreviewIssuesBody, settings?: SdkSettings): Promise<PreviewIssuesResponse>

Body

Nome	Tipo	Obrigatório
`items`	`Array<{ "cartItemId"?: string; "type": "RAFFLE_NUMBERS"; "raffleUUID": string; "amount": number; } \| { "cartItemId"?: string; "type": "CREDITS"; "amount": number; } \| { "cartItemId"?: string; "type": "RAFFLE_NUMBERS"; "kind": "GAMBLING"; "raffleUUID": string; "priceMultiplier": number; "amount": number; } \| { "cartItemId"?: string; "type": "ECOMMERCE_ITEM"; "amount": number; "itemId": string \| number; } \| { "cartItemId"?: string; "type": "SUBSCRIPTION"; "amount": number; "planId": string; }>`	sim
`offers`	`Array<string>`	não
`cpf`	`string`	não
`paymentMethod`	`"CARD" \| "PICPAY" \| "PIX" \| "CREDITS" \| "API" \| "POINTS" \| "DIGITAL_WALLET"`	não
`payableShipping`	`boolean`	não

Tipos

type PreviewIssuesBody = { "items": Array<{ "cartItemId"?: string; "type": "RAFFLE_NUMBERS"; "raffleUUID": string; "amount": number; } | { "cartItemId"?: string; "type": "CREDITS"; "amount": number; } | { "cartItemId"?: string; "type": "RAFFLE_NUMBERS"; "kind": "GAMBLING"; "raffleUUID": string; "priceMultiplier": number; "amount": number; } | { "cartItemId"?: string; "type": "ECOMMERCE_ITEM"; "amount": number; "itemId": string | number; } | { "cartItemId"?: string; "type": "SUBSCRIPTION"; "amount": number; "planId": string; }>; "offers"?: Array<string>; "cpf"?: string; "paymentMethod"?: "CARD" | "PICPAY" | "PIX" | "CREDITS" | "API" | "POINTS" | "DIGITAL_WALLET"; "payableShipping"?: boolean; };
type PreviewIssuesResponse = unknown;

Exemplo

const response = await sdk.cart.previewIssues({ "items": [] });

Testar esta função no playground

`previewIssuesCart`

POST/cart/:uuid/issues

Assinatura:

previewIssuesCart(body?: PreviewIssuesCartBody, settings?: SdkSettings): Promise<PreviewIssuesCartResponse>

sdk.cart.uuid é gerenciado pela SDK. O valor é criado e salvo automaticamente.

Body

Nome	Tipo	Obrigatório
`cpf`	`string`	não
`offers`	`unknown`	não

Tipos

type PreviewIssuesCartParams = { "uuid": string; };
type PreviewIssuesCartBody = { "cpf"?: string; "offers"?: unknown; };
type PreviewIssuesCartResponse = unknown;

Exemplo

const response = await sdk.cart.previewIssuesCart({ "cpf": "string", "offers": "string" });

Testar esta função no playground

`removeItem`

DELETE/cart/:uuid/items/:itemId

Assinatura:

removeItem(itemId: string | number | Array<string | number>, settings?: SdkSettings): Promise<RemoveItemResponse>

Parâmetros de rota

Nome	Tipo
`itemId`	`string \| number \| Array<string \| number>`

sdk.cart.uuid é gerenciado pela SDK. O valor é criado e salvo automaticamente.

Tipos

type RemoveItemParams = { "uuid": string; "itemId": string | number | Array<string | number>; };
type RemoveItemResponse = unknown;

Exemplo

const response = await sdk.cart.removeItem("string");

Testar esta função no playground

`replaceItems`

PUT/cart/:uuid/items

Assinatura:

replaceItems(body?: ReplaceItemsBody, settings?: SdkSettings): Promise<ReplaceItemsResponse>

sdk.cart.uuid é gerenciado pela SDK. O valor é criado e salvo automaticamente.

Body

Nome	Tipo	Obrigatório
`items`	Array<{ "cartItemId"?: string; "type": "RAFFLE_NUMBERS"; "raffleUUID": string; "amount": number; "cartOffer"?: { "version": 1; "offerId": string; "quantity": number; }; } \| { "cartItemId"?: string; "type": "CREDITS"; "amount": number; "cartOffer"?: false & true; } \| { "cartItemId"?: string; "type": "RAFFLE_NUMBERS"; "kind": "GAMBLING"; "raffleUUID": string; "priceMultiplier": number; "amount": number; "cartOffer"?: false & true; } \| { "cartItemId"?: string; "type": "ECOMMERCE_ITEM"; "amount": number; "itemId": string \| number; "cartOffer"?: false & true; } \| { "cartItemId"?: string; "type": "SUBSCRIPTION"; "amount": number; "planId": string; "cartOffer"?: false & true; }>	sim
`cpf`	`string`	não
`offers`	`unknown`	não

Tipos

type ReplaceItemsParams = { "uuid": string; };
type ReplaceItemsBody = { "items": Array<{ "cartItemId"?: string; "type": "RAFFLE_NUMBERS"; "raffleUUID": string; "amount": number; "cartOffer"?: { "version": 1; "offerId": string; "quantity": number; }; } | { "cartItemId"?: string; "type": "CREDITS"; "amount": number; "cartOffer"?: false & true; } | { "cartItemId"?: string; "type": "RAFFLE_NUMBERS"; "kind": "GAMBLING"; "raffleUUID": string; "priceMultiplier": number; "amount": number; "cartOffer"?: false & true; } | { "cartItemId"?: string; "type": "ECOMMERCE_ITEM"; "amount": number; "itemId": string | number; "cartOffer"?: false & true; } | { "cartItemId"?: string; "type": "SUBSCRIPTION"; "amount": number; "planId": string; "cartOffer"?: false & true; }>; "cpf"?: string; "offers"?: unknown; };
type ReplaceItemsResponse = unknown;

Exemplo

const response = await sdk.cart.replaceItems({ "items": [] });

Testar esta função no playground

`updateCart`

PUT/cart/:uuid

Assinatura:

updateCart(body?: UpdateCartBody, settings?: SdkSettings): Promise<UpdateCartResponse>

sdk.cart.uuid é gerenciado pela SDK. O valor é criado e salvo automaticamente.

Body

Nome	Tipo	Obrigatório
`items`	Array<{ "cartItemId"?: string; "type": "RAFFLE_NUMBERS"; "raffleUUID": string; "amount": number; "cartOffer"?: { "version": 1; "offerId": string; "quantity": number; }; } \| { "cartItemId"?: string; "type": "CREDITS"; "amount": number; "cartOffer"?: false & true; } \| { "cartItemId"?: string; "type": "RAFFLE_NUMBERS"; "kind": "GAMBLING"; "raffleUUID": string; "priceMultiplier": number; "amount": number; "cartOffer"?: false & true; } \| { "cartItemId"?: string; "type": "ECOMMERCE_ITEM"; "amount": number; "itemId": string \| number; "cartOffer"?: false & true; } \| { "cartItemId"?: string; "type": "SUBSCRIPTION"; "amount": number; "planId": string; "cartOffer"?: false & true; }>	não
`cpf`	`string`	não

Tipos

type UpdateCartParams = { "uuid": string; };
type UpdateCartBody = { "items"?: Array<{ "cartItemId"?: string; "type": "RAFFLE_NUMBERS"; "raffleUUID": string; "amount": number; "cartOffer"?: { "version": 1; "offerId": string; "quantity": number; }; } | { "cartItemId"?: string; "type": "CREDITS"; "amount": number; "cartOffer"?: false & true; } | { "cartItemId"?: string; "type": "RAFFLE_NUMBERS"; "kind": "GAMBLING"; "raffleUUID": string; "priceMultiplier": number; "amount": number; "cartOffer"?: false & true; } | { "cartItemId"?: string; "type": "ECOMMERCE_ITEM"; "amount": number; "itemId": string | number; "cartOffer"?: false & true; } | { "cartItemId"?: string; "type": "SUBSCRIPTION"; "amount": number; "planId": string; "cartOffer"?: false & true; }>; "cpf"?: string; };
type UpdateCartResponse = unknown;

Exemplo

const response = await sdk.cart.updateCart({ "items": [], "cpf": "string" });

Testar esta função no playground