Componente pré-criado para pedidos de troca

O componente pré-criado de pedido de troca verifica o nível de autenticação de um usuário. Depois que o usuário é autenticado, o componente fornece informações sobre os pedidos mais recentes ou anteriores do usuário. O usuário pode optar por trocar vários itens em um pedido e selecionar opções, incluindo métodos de reembolso e envio. Ele usa o componente pré-criado autenticação do Retail para autenticar usuários. O componente também usa Geradores para resumo pós-chamada e perguntas frequentes.

Limitações

Além das limitações comuns de componentes pré-criados, esse componente pré-criado tem as seguintes limitações:

• Este componente não criptografa nenhum dado.

Exemplos de diálogos

As caixas de diálogo de amostra abaixo demonstram cenários comuns processados por esse componente pré-criado. As caixas de diálogo de exemplo demonstram o comportamento quando o componente é chamado usando telefonia, que aciona a intent de boas-vindas padrão e a primeira resposta do agente no início da conversa.

Troca na loja por item com defeito

O usuário final já foi autenticado anteriormente. O agente confirma quais itens do pedido mais recente precisam ser trocados e coleta o motivo. O usuário seleciona a troca de itens em uma loja, e o agente fornece uma lista das lojas mais próximas. O usuário seleciona uma loja e o agente gera um rótulo para envio que é enviado aos canais registrados do usuário.

Entrada do usuário	Resposta do agente
	Você está ligando para falar sobre o número do seu pedido mais recente com final 12375, contendo duas lâmpadas, dois Pixel e 10 outros produtos feitos em 10/11/2023?
sim
	Encontramos alguns produtos qualificados no seu pedido. Informe qual produto você quer trocar. Produto 1: luminária do Google, Produto 2: Google Pixel, Produto 3: luz de LED do Google. Diga ou digite o número do produto que você quer selecionar ou diga ao lado para mostrar mais produtos.
1
	Para confirmar, você tem interesse em trocar a luminária do Google. É isso mesmo?
sim
	Podemos ver que a quantidade disponível do produto que você selecionou é 2. Especifique a quantidade de produtos que você quer trocar.
Dois
	Especifique o motivo da troca. Você pode dizer algo como: "Item com defeito ou não funciona", problema de tamanho ou ajuste, problema com pedido incompleto, problema de estilo, cor incorreta ou outros comentários.
Item com defeito
	Agradecemos o aviso. Por fim, como você quer trocar o produto? Você pode dizer algo como: "Trocar em uma loja" ou "Agendar para retirada".
Quero trocar em uma loja
	Vamos encontrar uma loja perto de você.
	O agente coleta o CEP usando o componente pré-criado Coleção CEP
	Aqui está a lista de locais próximos ao CEP inserido. Endereço 1: Google Texas, 500 W 2nd St, Suite 2900 Austin, Texas 78701, EUA. Endereço 2: Google California, 19510 Jamboree Road, Irvine, Califórnia 92612, EUA. Diga ou digite o número do próximo endereço que você quer selecionar ou diga mais "da loja".
A primeira loja
	Para confirmar, você selecionou Google Texas, 500 W 2nd St, Suite 2900 Austin, Texas 78701, EUA. É isso mesmo?
sim
	Perfeito. Enviamos o rótulo para envio e o número do bilhete para seu e-mail e telefone registrados. Imprima e anexe ao pacote. Depois, entregue a troca em até 30 dias. Depois de receber o item no depósito, pode levar de três a cinco dias úteis para que a troca (se houver) apareça na sua conta. Observação: o valor do reembolso não inclui as cobranças de frete e manuseio. O produto de troca tem um valor mais alto. A diferença de preço é de R$ 20,00. Você vai receber o link de pagamento em breve no número de celular registrado. Por favor, faça o pagamento em até 24 horas para fazer a troca. Quer trocar outro pedido?
Não, é isso
	Agradecemos sua ligação.

Reembolso da diferença de preço

O usuário final já foi autenticado anteriormente. O agente coleta o número do pedido, o produto a ser trocado e o motivo da troca. O usuário opta por trocar os itens por um tamanho diferente e agenda uma retirada. O agente identifica que o preço do item trocado é menor do que o novo e confirma com o usuário a forma de pagamento de um reembolso.

Entrada do usuário	Resposta do agente
	Você está ligando para falar sobre o número do pedido mais recente que termina em 12345, contendo duas lâmpadas feitas em 10/11/2023?
No
	Quer trocar outro pedido?
Sim
	Informe os últimos cinco dígitos do ID do pedido que você quer trocar.
12346
	Os últimos cinco dígitos do ID do pedido que recebemos são 12346, correto?
Sim
	Ótimo, terminamos de coletar o código do pedido. Encontramos alguns produtos qualificados no seu pedido. Informe qual produto você quer trocar. Produto 1: garrafa de água do Google, Produto 2: camiseta do Google. Diga ou digite o número do produto que você quer selecionar ou diga ao lado para mostrar mais produtos.
Dois
	Para confirmar, você tem interesse em trocar a camiseta do Google por troca. É isso mesmo?
Sim
	Especifique o motivo da troca. Você pode dizer algo como: "Item com defeito ou não funciona", problema de tamanho ou ajuste, problema com pedido incompleto, problema de estilo, cor incorreta ou outros comentários.
Problema de tamanho ou ajuste
	Agradecemos por nos informar o motivo da troca. Poderia informar o tamanho que você quer usar na troca? Temos os seguintes tamanhos disponíveis: Diga 1 para pequeno. Diga 2 para médio. Diga 3 para grande. Diga 4 para XL. Diga 5 para GG.
1
	Como última etapa, como você quer trocar o produto? Você pode dizer algo como: "Trocar em uma loja" ou "Agendar para retirada".
Agendar para retirada
	Perfeito. Enviamos um rótulo para envio para seu e-mail e número de telefone registrados. Imprima e anexe ao pacote. Nossa equipe entrará em contato com você nas próximas 24 a 48 horas para agendar uma retirada. Depois de recebermos o item no nosso depósito, vai levar de três a cinco dias úteis para que o reembolso da troca apareça na sua conta. O produto trocado tem um valor mais baixo e você se qualifica para um reembolso de US$ 5. Informe onde gostaria de receber o reembolso. Você pode dizer algo como crédito da Google Store ou conta de origem.
Crédito da Google Store
	Agradecemos por confirmar que você quer que seu reembolso seja devolvido à carteira. Quer trocar outro pedido?
não
	Agradecemos sua ligação.

Pedido não qualificado

O usuário final já foi autenticado anteriormente. O agente verifica o pedido mais recente e descobre que não há produtos qualificados para troca. O agente coleta um número de pedido do usuário e descobre que o pedido fornecido não tem produtos qualificados.

Entrada do usuário	Resposta do agente
	Não encontramos nenhum produto no seu pedido mais recente qualificado para troca. Quer trocar outro pedido?
sim
	Informe os últimos cinco dígitos do ID do pedido que você quer trocar.
23487
	Os últimos cinco dígitos do ID do pedido que recebemos são 23487, correto?
sim
	Ótimo, terminamos de coletar o ID do pedido.
	Não há produtos no seu pedido qualificados para troca com base nas nossas políticas. Veja mais informações sobre nossa política de troca em nosso site. Quer trocar outro pedido?
não
	Agradecemos sua ligação.

Convenções de nomeação

Esse componente pré-criado usa as seguintes convenções de nomenclatura:

Engenharia de	Formato	Exemplo
Fluxo	[Nome do componente]	Status do pedido
Tipo da entidade	prebuilt_components_[component_name]_[entity_type]	prebuilt_components_exchange_order_location
Webhook	prebuilt_components_[component_name]:[webhook_action]	prebuilt_components_exchange_order:get_product_exchange_availability

Parâmetros de entrada

Os parâmetros de entrada são usados para configurar determinados comportamentos do componente. Os parâmetros são usados por uma ou mais condições no fluxo para determinar como o componente vai se comportar. Os parâmetros com escopo de fluxo precisam ser definidos na página inicial do componente. Os parâmetros no escopo da sessão podem ser definidos por um fluxo de chamada ou na página inicial desse componente.

Esse componente pré-criado aceita os seguintes parâmetros de entrada:

Nome do parâmetro	Descrição	Formato da entrada
$session.params.phone_number	(Opcional) Número de telefone local do usuário, sem o código do país, utilizado para identificar o usuário.	string
$session.params.all_recent_order_id	(Opcional) Este parâmetro lista os IDs de pedido associados ao usuário autenticado, classificados pela data de posicionamento do pedido em ordem decrescente. O primeiro elemento da matriz representa o pedido mais recente. Se um usuário não tiver pedidos, o valor desse parâmetro será null.	Lista (string)
$session.params.email	(opcional) O e-mail registrado na conta.	string
$session.params.user_first_name	(Opcional) Nome do usuário, usado para dar as boas-vindas e confirmar a propriedade da conta.	string

Esse componente pré-criado permite que os parâmetros opcionais a seguir configurem o comportamento do componente, incluindo novas tentativas.

Nome do parâmetro	Descrição	Formato
$flow.max_retry_another_account	Especifica o número de novas tentativas permitidas ao selecionar se você quer continuar com uma conta alternativa. O valor padrão é 3.	integer
$flow.max_retry_order_number	Especifica o número de novas tentativas permitidas ao fornecer os últimos cinco dígitos de um número de pedido. O valor padrão é 3.	integer
$flow.max_retry_another_order	Especifica o número de novas tentativas permitidas ao selecionar outro pedido de devolução nos casos em que o ID do pedido não é encontrado ou o pedido não está qualificado para a troca. O valor padrão é 2.	integer
$flow.max_retry_select_order_number	Especifica o número de novas tentativas permitidas ao fornecer o número completo do pedido nos casos em que mais de um pedido compartilha os mesmos últimos cinco dígitos. O valor padrão é 2.	integer
$flow.max_retry_exchange_reason	Especifica o número de novas tentativas permitidas ao fornecer o motivo da troca. O valor padrão é 3.	integer
$flow.max_retry_exchange_reason_counter	Especifica o número de novas tentativas permitidas ao confirmar o motivo da troca. O valor padrão é 2.	integer
$flow.order_product_exchange_reason_others	Especifica o valor da entidade prebuilt_components_exchange_order_reason que indica que o usuário selecionou o motivo da troca "Outros". O valor padrão é "others".	string
$flow.max_product_display_counter	Especifica o número máximo de produtos a serem apresentados em uma única rodada. O valor padrão é 2.	integer
$flow.max_product_display	Especifica o número máximo de produtos a serem apresentados durante toda a conversa. O valor padrão é 9.	integer
$flow.max_product_exchange_confirm	Especifica o número máximo de novas tentativas permitidas ao confirmar o produto selecionado. O valor padrão é 2.	integer
$flow.max_retry_product_number_counter	Especifica o número máximo de novas tentativas permitidas ao selecionar um produto para troca. O valor padrão é 3.	integer
$flow.max_retry_select_quantity	Especifica o número máximo de novas tentativas permitidas ao selecionar a quantidade de produto a ser trocada. O valor padrão é 2.	integer
$flow.max_retry_size_number_counter	Especifica o número máximo de novas tentativas permitidas ao selecionar o tamanho a ser trocado. O valor padrão é 2.	integer
$flow.max_retry_another_zip_code	Especifica o número máximo de novas tentativas permitidas ao fornecer um CEP. O valor padrão é 2.	integer
$flow.max_store_display_counter	Especifica o número máximo de lojas a serem apresentadas em uma única conversão. O valor padrão é 1.	integer
$flow.max_store_display	Especifica o número máximo de armazenamentos a serem apresentados em toda a conversa. O valor padrão é 10.	integer
$flow.max_retry_store_number_counter	Especifica o número máximo de novas tentativas permitidas ao selecionar um armazenamento. O valor padrão é 2.	integer
$flow.max_retry_store_selection	Especifica o número de novas tentativas permitidas ao confirmar a seleção da loja. O valor padrão é 3.	integer
$flow.max_available_address_reselection_counter	Especifica o número de novas tentativas permitidas ao confirmar se o usuário quer selecionar outro endereço da loja. O valor padrão é 2.	integer
$flow.order_payment_mode_COD	Especifica o valor do campo order_payment_mode retornado pelo webhook de get_order_details, indicando uma forma de pagamento em dinheiro na entrega (COD, na sigla em inglês). O valor padrão é "COD".	string
$flow.order_payment_mode_store_credit	Especifica o valor do campo order_payment_mode retornado pelo webhook de get_order_details, indicando uma forma de pagamento de crédito da Google Store. O valor padrão é "store_credit".	string
$flow.order_refund_mode_source_account	Especifica o valor da entidade prebuilt_components_exchange_order_refund_mode que indica que o usuário escolheu reembolsar a conta de origem. O valor padrão é source_account.	string
$flow.order_exchange_location_scheduled_for_pickup	Especifica o valor da entidade prebuilt_components_exchange_order_location que indica que o usuário selecionou a opção de agendar uma retirada para a troca. O valor padrão é scheduled_for_pickup.	string

Para configurar os parâmetros de entrada desse componente, expanda para conferir as instruções.

1. Abra o Console do Dialogflow CX.
2. Escolha seu projeto do Google Cloud.
3. Selecione seu agente.
4. Selecione a guia Build.
5. Clique no componente importado na seção Fluxos.
6. Clique na página inicial na seção Páginas.
7. Clique na rota true na página inicial.
8. Na janela "Rota", edite os valores de Presets de parâmetros conforme necessário.
9. Clique em Salvar.

Parâmetros de saída

Os parâmetros de saída são parâmetros de sessão que permanecem ativos após a saída do componente. Esses parâmetros contêm informações importantes coletadas pelo componente. Esse componente pré-criado fornece valores para os seguintes parâmetros de saída:

Nome do parâmetro	Descrição	Formato da saída
phone_number	Número de telefone local do usuário, sem o código do país, utilizado para identificá-lo.	string
all_recent_order_id	Esse parâmetro lista os IDs de pedido associados ao usuário autenticado, classificados pela data de posicionamento do pedido em ordem decrescente. O primeiro elemento da matriz representa o pedido mais recente. Se um usuário não tiver pedidos, o valor desse parâmetro será null.	Lista (string)
email	O e-mail registrado na conta.	string
user_first_name	Nome do usuário, usado para cumprimentar e confirmar a propriedade da conta.	string
transfer_reason	Esse parâmetro indica o motivo da saída do fluxo, se não tiver sido bem-sucedido. O valor retornado é um destes: agent: o usuário final solicitou um agente humano em algum momento durante a conversa. denial_of_information: o usuário final se recusou a compartilhar informações solicitadas pelo componente. max_no_input: a conversa atingiu o número máximo de tentativas para eventos sem entrada. Consulte eventos integrados sem entrada. max_no_match: a conversa atingiu o número máximo de tentativas para eventos sem correspondência. Consulte eventos integrados sem correspondência. webhook_error: ocorreu um erro de webhook. Consulte o evento integrado webhook.error. webhook_not_found: não foi possível acessar um URL do webhook. Consulte webhook.error.not-found built-in event.	string

Geradores

Esse componente usa Geradores para ativar partes específicas da conversa.

Perguntas frequentes

O gerador FAQ é usado para lidar com perguntas frequentes sobre devoluções e trocas, incluindo:

• Há um prazo para o processo de devolução?
• Posso trocar um presente?
• O preço do produto e o valor do reembolso são diferentes. Por quê?

Geração de resumos

O gerador Summarization é usado para gerar um resumo pós-chamada descrevendo a conversa processada pelo componente.

Configuração básica

Para configurar esse componente pré-criado:

1. Importe o componente pré-criado.
2. Configure os Webhooks flexíveis fornecidos com a configuração que descreve os serviços externos do Dialogflow. Consulte Configuração do Webhook.

Configuração do webhook

Para usar esse componente, configure os webhooks flexíveis incluídos para recuperar as informações necessárias dos serviços externos.

Autenticação

Se você ainda não tiver configurado serviços externos necessários para autenticação, configure-os para ativar a autenticação de usuários para esse componente. Consulte Configuração do webhook de autenticação do Retail para instruções detalhadas.

Mais detalhes do pedido

O webhook prebuilt_components_exchange_order:get_order_details é usado pelo componente para recuperar detalhes de um pedido especificado.

Parâmetros de solicitação de API

Os parâmetros a seguir são fornecidos pelo componente como entradas para a solicitação de API.

Nome do parâmetro	Descrição	Formato da entrada
ID do pedido	ID do pedido para o qual recuperar detalhes.	string

Parâmetros de resposta da API

Os parâmetros a seguir são extraídos da resposta da API a ser usado pelo componente.

Nome do parâmetro	Descrição	Formato da saída
order_date	Data em que o pedido foi feito, no formato YYYY-MM-DD.	string
order_product_count	O número de produtos exclusivos em um pedido.	integer
order_payment_mode	Indica a forma de pagamento usada ao fazer o pedido.	string
exchangeable_product_id	Lista de IDs dos produtos que podem ser trocados no pedido.	Lista (string)
exchangeable_product_name	Lista de nomes de produtos para trocar no pedido.	Lista (string)
exchangeable_product_brand_name	Lista de nomes de marcas de produtos permutáveis no pedido.	Lista (string)
exchangeable_product_quantity	Lista de quantidades de produtos permutáveis no pedido.	Lista (string)
exchangeable_product_price	Lista de preços de produtos alternáveis no pedido.	Lista (string)

Para configurar o webhook "Ver detalhes do pedido" para este componente, expanda para ver instruções.

1. Abra o Console do Dialogflow CX.
2. Escolha seu projeto do Google Cloud.
3. Selecione seu agente.
4. Selecione a guia Gerenciar.
5. Clique em Webhooks.
6. Selecione o webhook prebuilt_components_exchange_order:get_order_details.
7. Substitua o URL no campo URL do webhook do Dialogflow pelo endpoint do serviço que você quer integrar. Selecione o Método adequado no menu suspenso.
8. Revise e atualize o Corpo da solicitação para formar o formato de solicitação adequado para o webhook.
9. Revise e atualize a Configuração de resposta para extrair campos específicos da resposta do webhook. Não modifique os nomes dos parâmetros, porque eles são exigidos pelo componente para acessar os valores de campo retornados.
10. Revise e atualize as configurações de Autenticação conforme necessário.
11. Clique em Salvar.

Receber detalhes do pedido duplicados

O webhook prebuilt_components_retail_services:get_duplicate_order_details é usado pelo componente para extrair informações detalhadas e distinguir entre ordens quando vários números de pedido têm os mesmos últimos cinco dígitos.

Parâmetros de solicitação de API

Os parâmetros a seguir são fornecidos pelo componente como entradas para a solicitação de API.

Nome do parâmetro	Descrição	Formato da entrada
ID do pedido $flow.duplicada	Lista contendo os últimos cinco dígitos dos números de pedido compartilhados entre um ou mais pedidos do usuário.	Lista (string)

Parâmetros de resposta da API

Os parâmetros a seguir são extraídos da resposta da API a ser usado pelo componente.

Nome do parâmetro	Descrição	Formato da saída
all_order_date	Lista de datas para pedidos duplicados com os últimos cinco dígitos especificados no formato YYYY-MM-DD. Cada elemento nessa matriz corresponde ao mesmo elemento na matriz all_order_time.	Lista (string)
all_order_time	Lista de horários para pedidos duplicados com os últimos cinco dígitos especificados no formato HH:MM. Cada elemento nessa matriz corresponde ao mesmo elemento na matriz all_order_date.	Lista (string)

Para configurar o webhook "Receber detalhes do pedido duplicados" para este componente, abra as instruções.

1. Abra o Console do Dialogflow CX.
2. Escolha seu projeto do Google Cloud.
3. Selecione seu agente.
4. Selecione a guia Gerenciar.
5. Clique em Webhooks.
6. Selecione o webhook prebuilt_components_retail_services:get_duplicate_order_details.
7. Substitua o URL no campo URL do webhook do Dialogflow pelo endpoint do serviço que você quer integrar. Selecione o Método adequado no menu suspenso.
8. Revise e atualize o Corpo da solicitação para formar o formato de solicitação adequado para o webhook.
9. Revise e atualize a Configuração de resposta para extrair campos específicos da resposta do webhook. Não modifique os nomes dos parâmetros, porque eles são exigidos pelo componente para acessar os valores de campo retornados.
10. Revise e atualize as configurações de Autenticação conforme necessário.
11. Clique em Salvar.

Saber o tamanho da troca disponível

O webhook prebuilt_components_exchange_order:get_available_exchange_size é usado pelo componente para extrair os tamanhos disponíveis para troca nos casos em que o usuário quer trocar um item devido a problemas de tamanho ou ajuste.

Parâmetros de solicitação de API

Os parâmetros a seguir são fornecidos pelo componente como entradas para a solicitação de API.

Nome do parâmetro	Descrição	Formato da entrada
$flow.selected_order_product_id	ID do produto que o usuário quer trocar.	string

Parâmetros de resposta da API

Os parâmetros a seguir são extraídos da resposta da API a ser usado pelo componente.

Nome do parâmetro	Descrição	Formato da saída
product_available_sizes	Lista de tamanhos disponíveis para o produto selecionado.	Lista (string)

Para configurar o webhook "Ver tamanho de troca disponível" para este componente, expanda para ver instruções.

1. Abra o Console do Dialogflow CX.
2. Escolha seu projeto do Google Cloud.
3. Selecione seu agente.
4. Selecione a guia Gerenciar.
5. Clique em Webhooks.
6. Selecione o webhook prebuilt_components_exchange_order:get_available_exchange_size.
7. Substitua o URL no campo URL do webhook do Dialogflow pelo endpoint do serviço que você quer integrar. Selecione o Método adequado no menu suspenso.
8. Revise e atualize o Corpo da solicitação para formar o formato de solicitação adequado para o webhook.
9. Revise e atualize a Configuração de resposta para extrair campos específicos da resposta do webhook. Não modifique os nomes dos parâmetros, porque eles são exigidos pelo componente para acessar os valores de campo retornados.
10. Revise e atualize as configurações de Autenticação conforme necessário.
11. Clique em Salvar.

Acessar a disponibilidade de troca de produtos

O webhook prebuilt_components_exchange_order:get_product_exchange_availability é usado pelo componente para verificar se o produto, a quantidade e o tamanho opcional selecionados pelo usuário estão disponíveis para troca.

Parâmetros de solicitação de API

Os parâmetros a seguir são fornecidos pelo componente como entradas para a solicitação de API.

Nome do parâmetro	Descrição	Formato da entrada
ID do pedido	ID do pedido para o qual recuperar detalhes.	string
$flow.selected_order_product_id	ID do produto que o usuário quer trocar.	string
$flow.order_product_quantity_exchange_count	Quantidade do produto que o usuário quer trocar.	integer
$flow.product_selected_size	O tamanho do produto pelo qual o usuário quer trocar.	string

Parâmetros de resposta da API

Os parâmetros a seguir são extraídos da resposta da API a ser usado pelo componente.

Nome do parâmetro	Descrição	Formato da saída
product_exchange_availability	Indica se o produto, a quantidade e o tamanho selecionados estão disponíveis para troca.	boolean
product_exchange_price	Indica o preço de troca de um único item do produto e tamanho selecionados.	number

Para configurar o webhook de disponibilidade da troca de produtos para este componente, expanda para ver instruções.

1. Abra o Console do Dialogflow CX.
2. Escolha seu projeto do Google Cloud.
3. Selecione seu agente.
4. Selecione a guia Gerenciar.
5. Clique em Webhooks.
6. Selecione o webhook prebuilt_components_exchange_order:get_product_exchange_availability.
7. Substitua o URL no campo URL do webhook do Dialogflow pelo endpoint do serviço que você quer integrar. Selecione o Método adequado no menu suspenso.
8. Revise e atualize o Corpo da solicitação para formar o formato de solicitação adequado para o webhook.
9. Revise e atualize a Configuração de resposta para extrair campos específicos da resposta do webhook. Não modifique os nomes dos parâmetros, porque eles são exigidos pelo componente para acessar os valores de campo retornados.
10. Revise e atualize as configurações de Autenticação conforme necessário.
11. Clique em Salvar.

Abrir tíquete de pedido incompleto

O webhook prebuilt_components_exchange_order:raise_incomplete_order_ticket é usado pelo componente para gerar um tíquete quando o usuário quer trocar um produto em um pedido porque ele está incompleto.

Parâmetros de solicitação de API

Os parâmetros a seguir são fornecidos pelo componente como entradas para a solicitação de API.

Nome do parâmetro	Descrição	Formato da entrada
$session.params.phone_number	Número de telefone local do usuário, sem o código do país, utilizado para identificá-lo.	string
ID do pedido	ID do pedido para o qual enviar um tíquete.	string
$flow.selected_order_product_id	ID do produto que o usuário quer trocar.	string
$flow.order_product_quantity_exchange_count	Quantidade do produto que o usuário quer trocar.	integer
$flow.order_product_exchange_reason	Motivo pelo qual o usuário quer trocar o produto.	string

Para configurar o webhook "Aumentar tíquete de pedido incompleto" para este componente, expanda para ver instruções.

1. Abra o Console do Dialogflow CX.
2. Escolha seu projeto do Google Cloud.
3. Selecione seu agente.
4. Selecione a guia Gerenciar.
5. Clique em Webhooks.
6. Selecione o webhook prebuilt_components_exchange_order:raise_incomplete_order_ticket.
7. Substitua o URL no campo URL do webhook do Dialogflow pelo endpoint do serviço que você quer integrar. Selecione o Método adequado no menu suspenso.
8. Revise e atualize o Corpo da solicitação para formar o formato de solicitação adequado para o webhook.
9. Revise e atualize a Configuração de resposta para extrair campos específicos da resposta do webhook. Não modifique os nomes dos parâmetros, porque eles são exigidos pelo componente para acessar os valores de campo retornados.
10. Revise e atualize as configurações de Autenticação conforme necessário.
11. Clique em Salvar.

Conferir detalhes da loja

O webhook prebuilt_components_exchange_order:get_store_details é usado pelo componente para recuperar a lista de lojas próximas ao CEP fornecido pelo usuário.

Parâmetros de solicitação de API

Os parâmetros a seguir são fornecidos pelo componente como entradas para a solicitação de API.

Nome do parâmetro	Descrição	Formato da entrada
$flow.zip_code	CEP para pesquisar lojas próximas.	string

Parâmetros de resposta da API

Os parâmetros a seguir são extraídos da resposta da API a ser usado pelo componente.

Nome do parâmetro	Descrição	Formato da saída
store_id	Lista de IDs de loja.	Lista (string)
store_address	Lista de endereços de lojas correspondentes a cada elemento de store_id.	Lista (string)

Para configurar o webhook "Receber detalhes da loja" para esse componente, expanda para ver instruções.

1. Abra o Console do Dialogflow CX.
2. Escolha seu projeto do Google Cloud.
3. Selecione seu agente.
4. Selecione a guia Gerenciar.
5. Clique em Webhooks.
6. Selecione o webhook prebuilt_components_exchange_order:get_store_details.
7. Substitua o URL no campo URL do webhook do Dialogflow pelo endpoint do serviço que você quer integrar. Selecione o Método adequado no menu suspenso.
8. Revise e atualize o Corpo da solicitação para formar o formato de solicitação adequado para o webhook.
9. Revise e atualize a Configuração de resposta para extrair campos específicos da resposta do webhook. Não modifique os nomes dos parâmetros, porque eles são exigidos pelo componente para acessar os valores de campo retornados.
10. Revise e atualize as configurações de Autenticação conforme necessário.
11. Clique em Salvar.

Detalhes da pós-troca

O webhook prebuilt_components_exchange_order:post_exchange_details é usado pelo componente para enviar uma troca.

Parâmetros de solicitação de API

Os parâmetros a seguir são fornecidos pelo componente como entradas para a solicitação de API.

Nome do parâmetro	Descrição	Formato da entrada
$session.params.phone_number	Número de telefone local do usuário, sem o código do país, utilizado para identificá-lo.	string
ID do pedido	ID do pedido para o qual enviar um tíquete.	string
$flow.selected_order_product_id	ID do produto que o usuário quer trocar.	string
$flow.order_product_quantity_exchange_count	Quantidade do produto que o usuário quer trocar.	integer
$flow.product_selected_size	O tamanho do produto pelo qual o usuário quer trocar.	string
$flow.order_product_exchange_reason	Motivo pelo qual o usuário quer trocar o produto.	string
$flow.order_exchange_location	O modo selecionado para a troca. Os valores válidos são definidos pela entidade prebuilt_components_exchange_order_location.	string
$flow.order_exchange_store_id	O ID da loja selecionada pelo usuário para uma troca da loja.	string
$flow.order_refund_mode	A forma de pagamento do reembolso, se aplicável. Os valores válidos são definidos pela entidade prebuilt_components_exchange_order_refund_mode. Se não for necessário um reembolso, esse valor será null.	string
$flow.total_refund_amount	O valor a ser reembolsado, se o preço trocável do produto for maior que o novo. Se não for necessário um reembolso, esse valor será null.	integer

Parâmetros de resposta da API

Os parâmetros a seguir são extraídos da resposta da API a ser usado pelo componente.

Nome do parâmetro	Descrição	Formato da saída
order_exchange_ticket_id	ID do tíquete da troca enviada.	string

Para configurar o webhook de detalhes da pós-troca para esse componente, abra as instruções.

1. Abra o Console do Dialogflow CX.
2. Escolha seu projeto do Google Cloud.
3. Selecione seu agente.
4. Selecione a guia Gerenciar.
5. Clique em Webhooks.
6. Selecione o webhook prebuild_components_exchange_order:post_exchange_details.
7. Substitua o URL no campo URL do webhook do Dialogflow pelo endpoint do serviço que você quer integrar. Selecione o Método adequado no menu suspenso.
8. Revise e atualize o Corpo da solicitação para formar o formato de solicitação adequado para o webhook.
9. Revise e atualize a Configuração de resposta para extrair campos específicos da resposta do webhook. Não modifique os nomes dos parâmetros, porque eles são exigidos pelo componente para acessar os valores de campo retornados.
10. Revise e atualize as configurações de Autenticação conforme necessário.
11. Clique em Salvar.

Enviar informações de reembolso do COD

O webhook prebuilt_components_exchange_order:send_COD_refund_information é usado pelo componente para enviar informações de pagamento relacionadas à troca a um usuário.

Parâmetros de solicitação de API

Os parâmetros a seguir são fornecidos pelo componente como entradas para a solicitação de API.

Nome do parâmetro	Descrição	Formato da entrada
$session.params.phone_number	Número de telefone local do usuário, sem o código do país, utilizado para identificá-lo.	string
ID do pedido	ID do pedido para o qual enviar um tíquete.	string
$flow.channel	O canal específico para o qual as informações serão enviadas. Os valores válidos são definidos pela entidade prebuilt_components_channel_email_phone. Por padrão, phone e email são aceitos.	string

Para configurar o webhook "Enviar informações de reembolso do COD" para este componente, expanda para ver instruções.

1. Abra o Console do Dialogflow CX.
2. Escolha seu projeto do Google Cloud.
3. Selecione seu agente.
4. Selecione a guia Gerenciar.
5. Clique em Webhooks.
6. Selecione o webhook prebuilt_components_exchange_order:send_COD_refund_information.
7. Substitua o URL no campo URL do webhook do Dialogflow pelo endpoint do serviço que você quer integrar. Selecione o Método adequado no menu suspenso.
8. Revise e atualize o Corpo da solicitação para formar o formato de solicitação adequado para o webhook.
9. Revise e atualize a Configuração de resposta para extrair campos específicos da resposta do webhook. Não modifique os nomes dos parâmetros, porque eles são exigidos pelo componente para acessar os valores de campo retornados.
10. Revise e atualize as configurações de Autenticação conforme necessário.
11. Clique em Salvar.

Completos

Seu agente e os webhooks dele agora precisam estar configurados e prontos para serem testados.