For the complete documentation index, see llms.txt. Markdown versions of documentation pages are available by appending .md to the page URL.
Navegação principal
Theme
Visão geral Documentação para usuários do ChatGPT e do Codex Casos de uso

Especificação de conversão para finalização de compras

Contrato para integrar um plugin de finalização de compras ao fluxo de conversão do ChatGPT.

Os plugins de finalização de compras do ChatGPT estão em fase beta. Os testes estão em andamento com parceiros aprovados. Para solicitar acesso, preencha

este formulário

Objetivo

Nosso objetivo é permitir que o ChatGPT acione diretamente os plugins dos parceiros quando o usuário demonstra uma intenção clara de compra, por exemplo, ao finalizar um pedido.

Depois que os parceiros nos fornecem um feed de produtos para a busca, podemos conectar seus servidores MCP para executar ações de conversão na etapa final do funil de vendas. Para isso, os plugins dos parceiros devem seguir um contrato que padroniza o nome do widget, o nome da ferramenta e os dados de entrada da ferramenta.

Se quiser criar um plugin que siga esta especificação, solicite acesso pelo formulário do ChatGPT para lojistas.

Experiência do usuário

Quando os usuários pesquisam produtos, o painel lateral do produto pode exibir botões Abrir para os vendedores. Se um vendedor tiver um plugin, o ChatGPT pode abri-lo na própria conversa para que o usuário finalize a compra sem precisar acessar um site externo.

Contrato obrigatório atual

  • Nome do widget: ui://widget/checkout-session.html
  • Nome da ferramenta: checkout_session

checkout_session deve definir:

_meta.ui.resourceUri = "ui://widget/checkout-session.html";

Toda ferramenta chamada diretamente por um widget deve definir:

_meta["openai/widgetAccessible"] = true;

Dados de entrada de checkout_session

Para cada item da compra, apenas id e quantity são obrigatórios. O campo offerId e os metadados da oferta selecionada do lojista são opcionais:

{
  "checkout_session": {
    "items": [
      {
        "id": "string",
        "quantity": 1,
        "offerId": "string",
        "name": "Wireless headphones",
        "description": "Wireless headphones with noise cancellation.",
        "images": [
          "https://merchant.example.com/images/headphones.jpg",
          "https://merchant.example.com/images/headphones-side.jpg"
        ],
        "url": "https://merchant.example.com/products/headphones",
        "merchant_name": "Example Merchant",
        "price": "$24.99"
      }
    ]
  }
}

Os seguintes campos de cada item são opcionais:

Campo Descrição
offerId Identificador da oferta selecionada do lojista.
name Nome do produto na oferta selecionada.
description Descrição fornecida no feed do próprio lojista.
images Lista ordenada de URLs das imagens do feed do lojista. A primeira URL corresponde à imagem principal.
url URL da oferta selecionada do lojista.
merchant_name Nome do lojista selecionado.
price Preço exibido na oferta, em formato de string.

images contém zero ou mais URLs do feed do lojista selecionado. Se houver URLs, a primeira corresponde à imagem principal exibida. O ChatGPT omite os campos opcionais indisponíveis. Ele não gera uma descrição nem usa a descrição ou as imagens de outro lojista. Declare esses campos do item como opcionais no schema de entrada da ferramenta. Use os IDs do item da compra e da oferta para consultar os dados oficiais de produto, estoque e preço no seu próprio catálogo.

O objeto aninhado da sessão de finalização de compra segue a estrutura descrita na documentação de sessões de finalização de compra do Commerce.