Frete

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:

createAddress(body?: CreateAddressBody, settings?: SdkSettings): Promise<CreateAddressResponse>

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

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

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:

deleteAddress(id: string, settings?: SdkSettings): Promise<DeleteAddressResponse>

Parâmetros de rota

Nome	Tipo
id	string

Tipos

type DeleteAddressParams = { "id": string; };
type DeleteAddressResponse = null;

Exemplo

const response = await sdk.shipping.deleteAddress("string");

Testar esta função no playground

getQuote

GET/shipping/quote

Assinatura:

getQuote(query?: GetQuoteQuery, settings?: SdkSettings): Promise<GetQuoteResponse>

Query

Nome	Tipo	Obrigatório
cep	string	sim
itemId	string	não
items	string	não

Tipos

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

const response = await sdk.shipping.getQuote({ "cep": "string" });

Testar esta função no playground

listAddresses

GET/user/shipping/address

Assinatura:

listAddresses(settings?: SdkSettings): Promise<ListAddressesResponse>

Tipos

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

const response = await sdk.shipping.listAddresses();

Testar esta função no playground

setDefaultAddress

POST/user/shipping/address/:id/default

Assinatura:

setDefaultAddress(id: string, settings?: SdkSettings): Promise<SetDefaultAddressResponse>

Parâmetros de rota

Nome	Tipo
id	string

Tipos

type SetDefaultAddressParams = { "id": string; };
type SetDefaultAddressResponse = { "id": string; "kind": "HOME_ADDRESS" | "WORK_ADDRESS" | "OTHER_ADDRESS"; "isDefault": boolean; };

Exemplo

const response = await sdk.shipping.setDefaultAddress("string");

Testar esta função no playground

unsetDefaultAddress

DELETE/user/shipping/address/:id/default

Assinatura:

unsetDefaultAddress(id: string, settings?: SdkSettings): Promise<UnsetDefaultAddressResponse>

Parâmetros de rota

Nome	Tipo
id	string

Tipos

type UnsetDefaultAddressParams = { "id": string; };
type UnsetDefaultAddressResponse = null;

Exemplo

const response = await sdk.shipping.unsetDefaultAddress("string");

Testar esta função no playground

updateAddress

PUT/user/shipping/address/:id

Assinatura:

updateAddress(id: string, body?: UpdateAddressBody, settings?: SdkSettings): Promise<UpdateAddressResponse>

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

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

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