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:Items:getRelated.
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.

catalogTabsarrayObrigatório

items

aliasstring

Identificador único da aba

titlestring

Título da aba

channelobject

Informações do canal de venda

idstringObrigatório

Identificador do canal de venda

slugstringObrigatório

Slug do canal de venda

metadataobject

Metadados

metadataobject

Dados adicionais do item

userobjectObrigatório

idstringObrigatório

Identificador do usuário

namestring

Nome do usuário

Exemplo:Carlos Pereira

aliasstring

Identificador do usuário na comunidade

Exemplo:user2

timezonestring

Fuso horário do usuário

Exemplo:America/Sao_Paulo

languagestring

Língua do usuário

Exemplo:pt-BR

accountIdstringObrigatório

Identificador da conta do usuário

emailstringemail

E-mail do usuário

Exemplo:carlos.pereira@gmail.com

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.174Z

actionstringObrigatório

Identificador da action

Exemplo:@layers:payments:Items:getRelated

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.

itemsarrayObrigatório

items

listsarrayObrigatório

items

aliasstringObrigatório

Identificador do kit de itens

metadataobject

Dados adicionais do kit de itens

namestringObrigatório

Nome do kit de itens

captionstring

Descrição do kit de itens

channelIdstringObrigatório

Identificador do canal de venda que o kit pertence

contentarray

Descrição longa do item

items

kindstring

Tipo do conteúdo

markdownstring

Conteúdo em markdown

galleryarrayObrigatório

Array com imagens

items

thumbstringObrigatório

URL da imagem

urlstringObrigatório

URL da imagem em um cdn

itemsarrayObrigatório

Lista de itens

items

aliasstringObrigatório

Identificador do item

metadataobject

Dados adicionais do item

catalogTabobjectObrigatório

Aba do catálogo que o item pertence

aliasstringObrigatório

Identificador único da aba

titlestringObrigatório

Título da aba

metadataobject

Dados adicionais da aba

channelobjectObrigatório

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

idstringObrigatório

Identificador do canal de venda

slugstringObrigatório

metadataobject

Dados adicionais do canal

namestringObrigatório

Nome do item

captionstring

Descrição do item

inventoryIdstringObrigatório

Identificador do item no estoque

channelIdstringObrigatório

Identificador do canal de venda que o item pertence

isInventoryFractionalboolean

Indica se o estoque só é consumido em compras fracionadas(onde o kit não é comprado por completo)

contentarray

Descrição longa do item

items

kindstring

Tipo do conteúdo

markdownstring

Conteúdo em markdown

galleryarrayObrigatório

Array com imagens

items

thumbstringObrigatório

URL da imagem

urlstringObrigatório

URL da imagem em um cdn

priceobjectObrigatório

Preço do item

amountnumber

Valor em centavos

currencystring

Tipo da moeda

priceFromobject

Preço do item sem considerar preço promocional

amountnumber

Valor em centavos

currencystring

Tipo da moeda

categoriesarray

Lista de categorias associadas ao item

items

kindstringObrigatório

Diz se o item é recurrence ou product

packageobject

Tamanho do pacote que contém o item, caso for físico

widthnumber

Largura em cm

depthnumber

Profundidade em cm

heightnumber

Altura em cm

weightnumber

Peso em kg

shippableboolean

Indica se o item requer frete

chainarray

Código dos itens que devem ser comprados juntos, se esse item for comprado

items

wholePriceobject

Preço da lista quando comprada por completo

amountnumber

Valor em centavos

currencystring

Tipo da moeda

unifiedListAliasstring

Código do grupo que unifica este list no marketplace com outros lists

unifiedListsarray

items

aliasstringObrigatório

Identificador do list de itens

namestringObrigatório

Nome do grupo

tagsarray

Lista de tags que identificam o list

items

namestringObrigatório

Nome da tag

iconstring

Ícone da tag