API Hub

Esta referência é de uma action do API Hub. Para mais informações, consulte a documentação do API Hub.

Esta é a referência da action @layers:payments:Shipping:getQuotation.
Para responder a esta action, seu app deve implementar uma rota que receba uma requisição POST seguindo os seguintes formatos de requisição e resposta:

Requisição

Este é o formato da requisição que sua API deve receber.

channelobjectObrigatório

Informações do canal de venda que está buscando os items.

idstringObrigatório

Identificador do canal de venda

slugstringObrigatório

metadataobject

Metadados

shippingobjectObrigatório

aliasstringObrigatório

Identificador único do frete sendo cotado

carrierobjectObrigatório

Informações sobre a transportadora

zipCodestringObrigatório

CEP de destino

itemsarrayObrigatório

Lista de itens que serão calculados o frete

items

metadataobject

Metadados

namestringObrigatório

Nome do item

packageobjectObrigatório

Tamanho do pacote que contém o item

widthnumberObrigatório

Largura em centímetros

depthnumberObrigatório

Profundidade em centímetros

heightnumberObrigatório

Altura em centímetros

weightnumberObrigatório

Peso em quilogramas

quantitynumberObrigatório

Quantidade do item

listAliasstringObrigatório

Identificador único do list

isWholeListbooleanObrigatório

Indica se o item, é de um list completo

contextobjectObrigatório

Contexto da requisição

issuedAtstringdate-timeObrigatório

Data e hora de quando a requisição foi feita

Exemplo:2026-02-13T18:40:11.162Z

actionstringObrigatório

Identificador da action

Exemplo:@layers:payments:Shipping:getQuotation

communitystringObrigatório

Identificador da comunidade

Exemplo:idcomunidadeteste

secretstring

Chave secreta específica do app

Exemplo:********************

Resposta

Este é o formato da resposta que sua API deve retornar.