---
title: "Frete"
description: "Endereços, cotações e rastreio de entrega."
---
shippingnamespace
Endereços, cotações e rastreio de entrega.
7métodos
shippingnamespace
> Esta página é gerada automaticamente pelo `@luckymaker/sdk-generator`. Não edite manualmente.
## `createAddress`
POST/user/shipping/address
Assinatura:
```ts
createAddress(body?: CreateAddressBody, settings?: SdkSettings): Promise
```
### Body
| Nome | Tipo | Obrigatório |
|---|---|---|
| `kind` | `"HOME_ADDRESS" \| "WORK_ADDRESS" \| "OTHER_ADDRESS"` | sim |
| `cep` | `string` | sim |
| `address` | `string` | sim |
| `streetNumber` | `string` | sim |
| `neighborhood` | `string` | sim |
| `complement` | `string \| null` | não |
| `referencePoint` | `string \| null` | não |
| `city` | `string` | sim |
| `state` | `string` | sim |
### Tipos
```ts
type CreateAddressBody = { "kind": "HOME_ADDRESS" | "WORK_ADDRESS" | "OTHER_ADDRESS"; "cep": string; "address": string; "streetNumber": string; "neighborhood": string; "complement"?: string | null; "referencePoint"?: string | null; "city": string; "state": string; };
type CreateAddressResponse = { "id": string; "kind": "HOME_ADDRESS" | "WORK_ADDRESS" | "OTHER_ADDRESS"; "isDefault": boolean; "cep": string; "address": string; "streetNumber": string; "neighborhood": string; "complement": string | null; "referencePoint": string | null; "city": string; "state": string; "createdAt": string; "updatedAt": string; };
```
### Exemplo
```ts
const response = await sdk.shipping.createAddress({ "kind": "HOME_ADDRESS", "cep": "string", "address": "string", "streetNumber": "string", "neighborhood": "string", "city": "string", "state": "string" });
```
Testar esta função no playground
## `deleteAddress`
DELETE/user/shipping/address/:id
Assinatura:
```ts
deleteAddress(id: string, settings?: SdkSettings): Promise
```
### Parâmetros de rota
| Nome | Tipo |
|---|---|
| `id` | `string` |
### Tipos
```ts
type DeleteAddressParams = { "id": string; };
type DeleteAddressResponse = null;
```
### Exemplo
```ts
const response = await sdk.shipping.deleteAddress("string");
```
Testar esta função no playground
## `getQuote`
GET/shipping/quote
Assinatura:
```ts
getQuote(query?: GetQuoteQuery, settings?: SdkSettings): Promise
```
### Query
| Nome | Tipo | Obrigatório |
|---|---|---|
| `cep` | `string` | sim |
| `itemId` | `string` | não |
| `items` | `string` | não |
### Tipos
```ts
type GetQuoteQuery = { "cep": string; "itemId"?: string; "items"?: string; };
type GetQuoteResponse = { "options": Array<{ "quoteId": string; "serviceId": string; "serviceName": string; "carrier": string; "price": number; "deliveryDays": number; "error"?: string; }>; "provider": "MELHOR_ENVIO" | "CUSTOM"; };
```
### Exemplo
```ts
const response = await sdk.shipping.getQuote({ "cep": "string" });
```
Testar esta função no playground
## `listAddresses`
GET/user/shipping/address
Assinatura:
```ts
listAddresses(settings?: SdkSettings): Promise
```
### Tipos
```ts
type ListAddressesResponse = Array<{ "id": string; "kind": "HOME_ADDRESS" | "WORK_ADDRESS" | "OTHER_ADDRESS"; "isDefault": boolean; "cep": string; "address": string; "streetNumber": string; "neighborhood": string; "complement": string | null; "referencePoint": string | null; "city": string; "state": string; "createdAt": string; "updatedAt": string; }>;
```
### Exemplo
```ts
const response = await sdk.shipping.listAddresses();
```
Testar esta função no playground
## `setDefaultAddress`
POST/user/shipping/address/:id/default
Assinatura:
```ts
setDefaultAddress(id: string, settings?: SdkSettings): Promise
```
### Parâmetros de rota
| Nome | Tipo |
|---|---|
| `id` | `string` |
### Tipos
```ts
type SetDefaultAddressParams = { "id": string; };
type SetDefaultAddressResponse = { "id": string; "kind": "HOME_ADDRESS" | "WORK_ADDRESS" | "OTHER_ADDRESS"; "isDefault": boolean; };
```
### Exemplo
```ts
const response = await sdk.shipping.setDefaultAddress("string");
```
Testar esta função no playground
## `unsetDefaultAddress`
DELETE/user/shipping/address/:id/default
Assinatura:
```ts
unsetDefaultAddress(id: string, settings?: SdkSettings): Promise
```
### Parâmetros de rota
| Nome | Tipo |
|---|---|
| `id` | `string` |
### Tipos
```ts
type UnsetDefaultAddressParams = { "id": string; };
type UnsetDefaultAddressResponse = null;
```
### Exemplo
```ts
const response = await sdk.shipping.unsetDefaultAddress("string");
```
Testar esta função no playground
## `updateAddress`
PUT/user/shipping/address/:id
Assinatura:
```ts
updateAddress(id: string, body?: UpdateAddressBody, settings?: SdkSettings): Promise
```
### Parâmetros de rota
| Nome | Tipo |
|---|---|
| `id` | `string` |
### Body
| Nome | Tipo | Obrigatório |
|---|---|---|
| `kind` | `"HOME_ADDRESS" \| "WORK_ADDRESS" \| "OTHER_ADDRESS"` | não |
| `cep` | `string` | não |
| `address` | `string` | não |
| `streetNumber` | `string` | não |
| `neighborhood` | `string` | não |
| `complement` | `string \| null` | não |
| `referencePoint` | `string \| null` | não |
| `city` | `string` | não |
| `state` | `string` | não |
### Tipos
```ts
type UpdateAddressParams = { "id": string; };
type UpdateAddressBody = { "kind"?: "HOME_ADDRESS" | "WORK_ADDRESS" | "OTHER_ADDRESS"; "cep"?: string; "address"?: string; "streetNumber"?: string; "neighborhood"?: string; "complement"?: string | null; "referencePoint"?: string | null; "city"?: string; "state"?: string; };
type UpdateAddressResponse = { "id": string; "kind": "HOME_ADDRESS" | "WORK_ADDRESS" | "OTHER_ADDRESS"; "isDefault": boolean; "cep": string; "address": string; "streetNumber": string; "neighborhood": string; "complement": string | null; "referencePoint": string | null; "city": string; "state": string; "createdAt": string; "updatedAt": string; };
```
### Exemplo
```ts
const response = await sdk.shipping.updateAddress("string", { "kind": "HOME_ADDRESS", "cep": "string", "address": "string", "streetNumber": "string", "neighborhood": "string", "complement": "string", "referencePoint": "string", "city": "string", "state": "string" });
```
Testar esta função no playground