--- title: "Carrinho" description: "Carrinho persistido, itens, ofertas e validações." ---
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: ```ts addItems(body?: AddItemsBody, settings?: SdkSettings): Promise ``` > `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 ```ts 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 ```ts 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: ```ts getCart(settings?: SdkSettings): Promise ``` > `sdk.cart.uuid` é gerenciado pela SDK. O valor é criado e salvo automaticamente. ### Tipos ```ts type GetCartParams = { "uuid": string; }; type GetCartResponse = unknown; ``` ### Exemplo ```ts const response = await sdk.cart.getCart(); ``` Testar esta função no playground ## `getItems`
GET/cart/:uuid/items
Assinatura: ```ts getItems(settings?: SdkSettings): Promise ``` > `sdk.cart.uuid` é gerenciado pela SDK. O valor é criado e salvo automaticamente. ### Tipos ```ts type GetItemsParams = { "uuid": string; }; type GetItemsResponse = unknown; ``` ### Exemplo ```ts const response = await sdk.cart.getItems(); ``` Testar esta função no playground ## `previewIssues`
POST/user/cart/preview-issues
Assinatura: ```ts previewIssues(body?: PreviewIssuesBody, settings?: SdkSettings): Promise ``` ### 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` | não | | `cpf` | `string` | não | | `paymentMethod` | `"CARD" \| "PICPAY" \| "PIX" \| "CREDITS" \| "API" \| "POINTS" \| "DIGITAL_WALLET"` | não | | `payableShipping` | `boolean` | não | ### Tipos ```ts 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; "cpf"?: string; "paymentMethod"?: "CARD" | "PICPAY" | "PIX" | "CREDITS" | "API" | "POINTS" | "DIGITAL_WALLET"; "payableShipping"?: boolean; }; type PreviewIssuesResponse = unknown; ``` ### Exemplo ```ts const response = await sdk.cart.previewIssues({ "items": [] }); ``` Testar esta função no playground ## `previewIssuesCart`
POST/cart/:uuid/issues
Assinatura: ```ts previewIssuesCart(body?: PreviewIssuesCartBody, settings?: SdkSettings): Promise ``` > `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 ```ts type PreviewIssuesCartParams = { "uuid": string; }; type PreviewIssuesCartBody = { "cpf"?: string; "offers"?: unknown; }; type PreviewIssuesCartResponse = unknown; ``` ### Exemplo ```ts const response = await sdk.cart.previewIssuesCart({ "cpf": "string", "offers": "string" }); ``` Testar esta função no playground ## `removeItem`
DELETE/cart/:uuid/items/:itemId
Assinatura: ```ts removeItem(itemId: string | number | Array, settings?: SdkSettings): Promise ``` ### Parâmetros de rota | Nome | Tipo | |---|---| | `itemId` | `string \| number \| Array` | > `sdk.cart.uuid` é gerenciado pela SDK. O valor é criado e salvo automaticamente. ### Tipos ```ts type RemoveItemParams = { "uuid": string; "itemId": string | number | Array; }; type RemoveItemResponse = unknown; ``` ### Exemplo ```ts const response = await sdk.cart.removeItem("string"); ``` Testar esta função no playground ## `replaceItems`
PUT/cart/:uuid/items
Assinatura: ```ts replaceItems(body?: ReplaceItemsBody, settings?: SdkSettings): Promise ``` > `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 ```ts 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 ```ts const response = await sdk.cart.replaceItems({ "items": [] }); ``` Testar esta função no playground ## `updateCart`
PUT/cart/:uuid
Assinatura: ```ts updateCart(body?: UpdateCartBody, settings?: SdkSettings): Promise ``` > `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 ```ts 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 ```ts const response = await sdk.cart.updateCart({ "items": [], "cpf": "string" }); ``` Testar esta função no playground