Search docs/

Prover Itens da tab de uma loja

{...}

Essa rota retorna informações relacionadas aos itens disponíveis no canal de venda especificado no corpo da requisição. Ela é utilizada como uma ação pela nossa plataforma de Pagamentos e é chamada quando um usuário acessa o canal de venda. Também enviamos os dados do usuário atual que está realizando a requisição, permitindo que o provedor tenha controle sobre quais itens serão retornados para cada usuário.

Comentários

É importante ressaltar que a resposta deve conter todas as chaves exibidas no exemplo, mesmo que com valores null, para garantir que a validação seja realizada corretamente.

O exemplo apresenta itens normais (contendo o kind product) e itens recorrentes (contendo o kind recurrence). Cada tipo possui uma estrutura distinta que deve ser seguida para garantir que a validação seja realizada corretamente.

Se algum item não estiver aparecendo no Canal de Venda/Marketplace, pode ser que alguma validação tenha falhado. Nesse caso, será necessário verificar se todos os campos estão sendo enviados e se os valores estão corretos.

POST https://api.provedor-registrado.com/@layers:payments:Items:getRelated
CopiarCopiado

Requisição

Especificação

  • contextObjectobrigatório

  • secretStringobrigatório

    Chave secreta específica do app

  • dataObject

Exemplo

{
  "context": {
    "issuedAt": "2025-05-23T17:46:52.418Z",
    "action": "@layers:identificador_da_action",
    "community": "idcomunidadeteste"
  },
  "secret": "exemplo1-e000-11xe-2m33-4444444plo",
  "data": {
    "catalogTabs": [
      {
        "alias": "exemplo",
        "title": "exemplo",
        "channel": {
          "id": "exemplo",
          "slug": "exemplo",
          "metadata": {}
        },
        "metadata": {}
      }
    ],
    "user": {
      "id": "exemplo",
      "name": "Carlos Pereira",
      "alias": "user2",
      "timezone": "America/Sao_Paulo",
      "language": "pt-BR",
      "accountId": "exemplo",
      "email": "carlos.pereira@gmail.com"
    }
  }
}
CopiarCopiado

Resposta

Especificação

  • items[ ]obrigatório

  • listsObject[ ]obrigatório

  • unifiedListsObject[ ]

Exemplo

{
  "items": [
    {
      "alias": "exemplo",
      "metadata": {},
      "name": "exemplo",
      "caption": "exemplo",
      "channelId": "exemplo",
      "content": [
        {
          "kind": "markdown",
          "markdown": "exemplo"
        }
      ],
      "catalogTab": {
        "alias": "exemplo",
        "title": "exemplo",
        "metadata": {},
        "channel": {
          "id": "exemplo",
          "slug": "exemplo",
          "metadata": {}
        }
      },
      "gallery": [
        {
          "thumb": "exemplo",
          "url": "exemplo"
        }
      ],
      "price": {
        "amount": 5.5,
        "currency": "BRL"
      },
      "priceFrom": {
        "amount": 5.5,
        "currency": "BRL"
      },
      "categories": [
        "exemplo"
      ],
      "kind": "product",
      "package": {
        "width": 5,
        "depth": 5,
        "height": 5,
        "weight": 0.2
      },
      "shippable": true,
      "digital": true,
      "schoolName": "exemplo",
      "required": true,
      "linkingGroup": {
        "name": "exemplo",
        "icon": "bag",
        "color": "exemplo",
        "links": [
          "exemplo"
        ]
      },
      "blocked": {
        "reason": "exemplo"
      },
      "formId": "exemplo",
      "inventoryId": "exemplo",
      "maxQuantity": 5.5,
      "tags": [
        "exemplo"
      ]
    },
    {
      "alias": "exemplo",
      "metadata": {},
      "name": "exemplo",
      "caption": "exemplo",
      "channelId": "exemplo",
      "content": [
        {
          "kind": "markdown",
          "markdown": "exemplo"
        }
      ],
      "catalogTab": {
        "alias": "exemplo",
        "title": "exemplo",
        "metadata": {},
        "channel": {
          "id": "exemplo",
          "slug": "exemplo",
          "metadata": {}
        }
      },
      "gallery": [
        {
          "thumb": "exemplo",
          "url": "exemplo"
        }
      ],
      "price": {
        "amount": 5.5,
        "currency": "BRL"
      },
      "priceFrom": {
        "amount": 5.5,
        "currency": "BRL"
      },
      "categories": [
        "exemplo"
      ],
      "kind": "recurrence",
      "package": {
        "width": 5,
        "depth": 5,
        "height": 5,
        "weight": 0.2
      },
      "shippable": true,
      "digital": true,
      "schoolName": "exemplo",
      "required": true,
      "linkingGroup": {
        "name": "exemplo",
        "icon": "bag",
        "color": "exemplo",
        "links": [
          "exemplo"
        ]
      },
      "blocked": {
        "reason": "exemplo"
      },
      "formId": "exemplo",
      "inventoryId": "exemplo",
      "maxQuantity": 5.5,
      "tags": [
        "exemplo"
      ],
      "variants": [
        {
          "alias": "exemplo",
          "attributes": [
            {}
          ],
          "gallery": [
            {
              "thumb": "exemplo",
              "url": "exemplo"
            }
          ],
          "inventoryId": "exemplo",
          "plan": {
            "price": {
              "amount": 5.5,
              "currency": "BRL"
            },
            "initialPrice": {
              "amount": 5.5,
              "currency": "BRL"
            },
            "interval": "month",
            "intervalCount": 5.5,
            "hasProRata": true,
            "cyclesLimit": 5.5,
            "cycleEndDate": "exemplo"
          }
        }
      ]
    }
  ],
  "lists": [
    {
      "alias": "exemplo",
      "metadata": {},
      "name": "exemplo",
      "caption": "exemplo",
      "channelId": "exemplo",
      "content": [
        {
          "kind": "markdown",
          "markdown": "exemplo"
        }
      ],
      "gallery": [
        {
          "thumb": "exemplo",
          "url": "exemplo"
        }
      ],
      "items": [
        {
          "alias": "exemplo",
          "metadata": {},
          "catalogTab": {
            "alias": "exemplo",
            "title": "exemplo",
            "metadata": {},
            "channel": {
              "id": "exemplo",
              "slug": "exemplo",
              "metadata": {}
            }
          },
          "name": "exemplo",
          "caption": "exemplo",
          "inventoryId": "exemplo",
          "channelId": "exemplo",
          "isInventoryFractional": true,
          "content": [
            {
              "kind": "markdown",
              "markdown": "exemplo"
            }
          ],
          "gallery": [
            {
              "thumb": "exemplo",
              "url": "exemplo"
            }
          ],
          "price": {
            "amount": 5.5,
            "currency": "BRL"
          },
          "priceFrom": {
            "amount": 5.5,
            "currency": "BRL"
          },
          "categories": [
            "exemplo"
          ],
          "kind": "product",
          "package": {
            "width": 5,
            "depth": 5,
            "height": 5,
            "weight": 0.2
          },
          "shippable": true,
          "chain": [
            "exemplo"
          ]
        }
      ],
      "wholePrice": {
        "amount": 5.5,
        "currency": "BRL"
      },
      "unifiedListAlias": "exemplo"
    }
  ],
  "unifiedLists": [
    {
      "alias": "exemplo",
      "name": "exemplo",
      "tags": [
        {
          "name": "exemplo",
          "icon": "exemplo"
        }
      ]
    }
  ]
}
CopiarCopiado