Componente pré-criado de troca de pedidos

O pedido de troca componente pré-criado 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 o usuário pode escolher trocar vários itens em um pedido e selecionar opções incluindo métodos de reembolso e envio. Esse componente usa o componente pré-criado Autenticação de varejo para autenticar usuários. O componente também usa Geradores para resumos pós-chamada e perguntas frequentes.

Limitações

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

• Este componente não criptografa dados.

Exemplos de diálogos

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

Troca da loja por um item com defeito

O usuário final já foi autenticado anteriormente. O agente confirma quais itens o pedido mais recente precisa ser trocado e coleta o motivo da troca. O usuário seleciona a troca dos 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 uma 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 pedido mais recente terminado em 12375, que contém duas lâmpadas, dois Pixels e mais 10 produtos feitos em 10/11/2023?
sim
	Encontramos alguns produtos qualificados no seu pedido. Informe o produto que você quer trocar. Produto 1: lâmpada do Google, Produto 2: Google Pixel, Produto 3: luz de LED do Google. Diga ou insira o número do produto que você quer selecionar. Se preferir, diga ao lado para mostrar mais produtos.
1
	Para confirmar, você tem interesse em trocar a lâmpada do Google. É isso mesmo?
sim
	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: "O item está com defeito ou não funciona", "Problema de tamanho ou ajuste", "Problema de pedido incompleto", "Problema de estilo", "Cor incorreta" ou "Outros".
Item com defeito
	Agradecemos por nos informar. Como última etapa, como você gostaria de trocar o produto? Você pode dizer algo como: "Troque na loja" ou "Agendamento 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 de CEPs.
	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 selecione o número que quer, ou diga "próximo" para exibir mais endereços de lojas.
A primeira loja
	Para confirmar, você selecionou Google Texas, 500 W 2nd St, Suite 2900 Austin, Texas 78701, EUA. É isso mesmo?
sim
	Perfeito. Enviamos um código de frete e um número de tíquete para seu e-mail e número de telefone registrados. Imprima, anexe ao pacote e entregue a troca em até 30 dias. Depois de recebermos o item em nosso depósito, 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 exclui as cobranças de frete e manuseio. O produto da troca tem um valor mais alto. A diferença de preço é de US$ 20. 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 realizar a troca. Quer trocar outro pedido?
não, tudo bem
	Agradecemos sua ligação.

Reembolso por 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 coleta 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 item trocado tem um preço menor do que o novo item e confirma com o usuário o método de pagamento para um reembolso.

Entrada do usuário	Resposta do agente
	Você está ligando sobre o pedido mais recente com o número 12345 e duas lâmpadas, feito em 10/11/2023?
Não
	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 código do pedido que recebemos são 12346, certo?
Sim
	Ótimo, já coletamos o código do pedido. Encontramos alguns produtos qualificados no seu pedido. Informe o produto que você quer trocar. Produto 1: garrafa de água do google, Produto 2: camiseta do Google. Diga ou insira o número do produto que você quer selecionar, ou diga a seguir para mostrar mais produtos.
Dois
	Para verificar, você tem interesse em trocar a camiseta do Google por uma troca. É isso mesmo?
Sim
	Especifique o motivo da troca. Você pode dizer algo como: "O item está com defeito ou não funciona", "Problema de tamanho ou ajuste", "Problema de pedido incompleto", "Problema de estilo", "Cor incorreta" ou "Outros".
Problema de tamanho ou encaixe
	Agradecemos por nos informar o motivo da troca. Qual é o tamanho da troca? Temos os seguintes tamanhos disponíveis: Diga 1 para pequeno. Diga 2 para médio. Diga 3 para grande. Diga 4 para GG. Diga 5 para tamanho duplo GG.
1
	Por último, como você quer trocar o produto? Você pode dizer algo como "Trocar em uma loja" ou "Programar para retirada".
Agendar retirada
	Perfeito. Enviamos um rótulo para envio ao seu número de telefone e e-mail registrados. Imprima-o e anexe à embalagem. Nossa equipe vai entrar em contato com você nas próximas 24 a 48 horas para agendar a retirada. Depois que recebermos o item no nosso depósito, vai levar de 3 a 5 dias úteis para que o reembolso da troca apareça na sua conta. O produto trocado é de valor inferior, e você tem direito a um reembolso de US$ 5. Informe onde você quer 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 o reembolso seja devolvido à carteira. Você quer trocar outro pedido?
não
	Agradecemos sua ligação.

Pedido não qualificado

O usuário final foi autenticado anteriormente. O agente verifica a versão mais recente o pedido 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 qualificado para troca no seu pedido mais recente. Você 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 código do pedido que recebemos são 23487, certo?
sim
	Ótimo, já coletamos o código do pedido.
	Não há produtos no seu pedido que se qualificam para troca com base nas nossas políticas. Confira mais informações sobre nossa política de troca no site. Quer trocar outro pedido?
não
	Agradecemos sua ligação.

Convenções de nomenclatura

Esse componente predefinido usa as seguintes convenções de nomenclatura:

Recurso	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

Parâmetros de entrada são parâmetros usados para configurar certos comportamentos de do componente. Os parâmetros serão usados por uma ou mais condições dentro do para determinar como o componente deve se comportar. Os parâmetros no escopo do fluxo precisam ser definidos na página inicial do componente. No escopo da sessão podem ser definidos por um fluxo de chamada ou no início página 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 pedidos associados ao usuário autenticado, classificados em ordem decrescente pela data de realização do pedido. 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 saudar e confirmar a propriedade da conta.	string

Esse componente predefinido permite que os parâmetros opcionais a seguir configurem o comportamento do componente, incluindo as 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 informar 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 para devolução nos casos em que o ID do pedido não é encontrado ou 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 cinco últimos dígitos. O valor padrão é 2.	integer
$flow.max_retry_exchange_reason	Especifica o número de novas tentativas permitidas ao informar 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 indicando que o usuário selecionou "outros". motivo da troca. 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 vez. 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 produtos a serem trocados. 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 curva. O valor padrão é 1.	integer
$flow.max_store_display	Especifica o número máximo de lojas a serem apresentadas durante 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 uma loja. 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 um endereço de loja diferente. O valor padrão é 2.	integer
$flow.order_payment_mode_COD	Especifica o valor do campo order_payment_mode retornado pelo webhook get_order_details, indicando uma forma de pagamento 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 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, indicando que o usuário selecionou o reembolso para 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 indicando que o usuário selecionou para agendar uma retirada para a troca. O valor padrão é scheduled_for_pickup.	string

Para configurar os parâmetros de entrada deste 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 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 das Predefinições de parâmetro conforme necessário.
9. Clique em Salvar.

Parâmetros de saída

Os parâmetros de saída são de sessão que permanecerão ativos depois de sair. do componente. Esses parâmetros contêm informações importantes coletadas pelo componente. Esse componente predefinido 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 identificar o usuário.	string
all_recent_order_id	Esse parâmetro lista os códigos de pedido associados ao usuário autenticado, classificados por data de veiculação 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)
e-mail	O e-mail registrado na conta.	string
user_first_name	Nome do usuário, usado para saudar e confirmar a propriedade da conta.	string
transfer_reason	Esse parâmetro indica o motivo da saída do fluxo, se não foi 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 recusou-se a compartilhar as informações solicitadas pelo componente. max_no_input: a conversa atingiu o número máximo de novas tentativas para eventos sem entrada. Consulte Eventos integrados sem entrada. max_no_match: a conversa atingiu o número máximo de novas 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: um URL de webhook estava inacessível. Consulte Webhook.error.not-found.	string

Geradores

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

Perguntas frequentes

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

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

Resumo

O gerador Summarization é usado para gerar um resumo pós-chamada que descreve 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 seus serviços externos. Consulte a configuração de webhook.

Configuração do webhook

Para usar esse componente, você precisa configurar os webhooks flexíveis incluídos para extrair as informações necessárias dos seus serviços externos.

Autenticação

Se você não tiver configurado os serviços externos necessários para autenticação, será necessário fazer isso para ativar a autenticação de usuários para esse componente. Consulte Configuração do webhook de autenticação de varejo. para ver instruções detalhadas.

Confira detalhes dos pedidos

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

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.order_id	ID do pedido para o qual os detalhes serão recuperados.	string

Parâmetros de resposta da API

Os parâmetros a seguir são extraídos da resposta da API para serem usados 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 únicos em um pedido.	integer
order_payment_mode	Indica o modo de pagamento usado ao realizar o pedido.	string
exchangeable_product_id	Lista de IDs de produtos para produtos trocáveis no pedido.	Lista (string)
exchangeable_product_name	Lista de nomes de produtos para produtos que podem ser trocados no pedido.	Lista (string)
exchangeable_product_brand_name	Lista de nomes de marcas de produtos trocáveis no pedido.	Lista (string)
exchangeable_product_quantity	Lista de quantidades de produtos que podem ser trocados no pedido.	Lista (string)
exchangeable_product_price	Lista de preços dos produtos que podem ser trocados 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 Webhook URL dos Agentes de conversa (Dialogflow CX) pelo endpoint do serviço com que você quer fazer a integração. 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 seu webhook.
9. Revise e atualize a Configuração de resposta para extrair campos específicos do objeto. resposta. Não modifique os nomes dos parâmetros, porque eles são necessários para que o componente acesse os valores de campo retornados.
10. Revise e atualize as configurações de autenticação conforme necessário.
11. Clique em Salvar.

Conferir detalhes de pedidos duplicados

O webhook prebuilt_components_retail_services:get_duplicate_order_details é usado pelo componente para extrair informações detalhadas e distinguir entre pedidos quando vários números de pedidos têm os mesmos cinco últimos 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
$flow.duplicate_order_id	Lista com os últimos cinco dígitos dos números de pedidos 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 para serem usados 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 dessa matriz corresponde ao mesmo elemento na matriz all_order_time.	Lista (string)
all_order_time	Lista de horários de pedidos para pedidos duplicados com os últimos cinco dígitos especificados no formato HH:MM. Cada elemento nesta matriz corresponde ao mesmo elemento na matriz all_order_date.	Lista (string)

Para configurar o webhook "Acessar detalhes do pedido duplicado" para este 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 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 dos agentes de conversação (Dialogflow CX) 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 seu webhook.
9. Revise e atualize a Configuração de resposta para extrair campos específicos do objeto. resposta. Não modifique os nomes dos parâmetros, porque eles são necessários para que o componente acesse os valores de campo retornados.
10. Revise e atualize as configurações de autenticação conforme necessário.
11. Clique em Salvar.

Receber o tamanho da troca disponível

O webhook prebuilt_components_exchange_order:get_available_exchange_size é usada pelo componente a fim de recuperar tamanhos disponíveis para troca nos casos em que o usuário gostaria de 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 para serem usados 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 Webhook URL dos Agentes de conversa (Dialogflow CX) pelo endpoint do serviço com que você quer fazer a integração. 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 seu webhook.
9. Revise e atualize a Configuração de resposta para extrair campos específicos do objeto. resposta. Não modifique os nomes dos parâmetros, porque eles são necessários para que o componente acesse os valores de campo retornados.
10. Revise e atualize as configurações de autenticação conforme necessário.
11. Clique em Salvar.

Ver a disponibilidade de troca do produto

O prebuilt_components_exchange_order:get_product_exchange_availability webhook é usado pelo componente para verificar se o produto selecionado pelo usuário, quantidade e tamanho opcional 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
$flow.order_id	ID do pedido para o qual os detalhes serão recuperados.	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	Tamanho 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 para serem usados 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.	booleano
product_exchange_price	Indica o preço de troca de um único item do produto e tamanho selecionados.	number

Para configurar o webhook "Get product exchange availability" 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_exchange_order:get_product_exchange_availability.
7. Substitua o URL no campo Webhook URL dos Agentes de conversa (Dialogflow CX) pelo endpoint do serviço com que você quer fazer a integração. 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 seu webhook.
9. Revise e atualize a Configuração de resposta para extrair campos específicos do objeto. resposta. Não modifique os nomes dos parâmetros, porque eles são necessários para que o componente acesse os valores de campo retornados.
10. Revise e atualize as configurações de autenticação conforme necessário.
11. Clique em Salvar.

Criar um 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 de um pedido por estar 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 identificar o usuário.	string
$flow.order_id	O código do pedido para 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	É o motivo pelo qual o usuário quer trocar o produto.	string

Para configurar o webhook "Aumentar o webhook de tíquete de pedido incompleto para este componente", expanda para conferir 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 Webhook URL dos Agentes de conversa (Dialogflow CX) pelo endpoint do serviço com que você quer fazer a integração. 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 seu webhook.
9. Revise e atualize a Configuração de resposta para extrair campos específicos do objeto. resposta. Não modifique os nomes dos parâmetros, porque eles são necessários para que o componente acesse os valores de campo retornados.
10. Revise e atualize as configurações de autenticação conforme necessário.
11. Clique em Salvar.

Mais detalhes da loja

O webhook prebuilt_components_exchange_order:get_store_details é usado pelo componente para recuperar a lista de lojas perto do 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 nas proximidades.	string

Parâmetros de resposta da API

Os parâmetros a seguir são extraídos da resposta da API para serem usados pelo componente.

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

Para configurar o webhook "Pegar detalhes da loja" 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 prebuilt_components_exchange_order:get_store_details.
7. Substitua o URL no campo Webhook URL dos Agentes de conversa (Dialogflow CX) pelo endpoint do serviço com que você quer fazer a integração. 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 seu webhook.
9. Revise e atualize a Configuração de resposta para extrair campos específicos do objeto. resposta. Não modifique os nomes dos parâmetros, porque eles são necessários para que o componente acesse os valores de campo retornados.
10. Revise e atualize as configurações de autenticação conforme necessário.
11. Clique em Salvar.

Detalhes da postagem da 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 identificar o usuário.	string
$flow.order_id	O código do pedido para 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	Tamanho do produto que o usuário quer trocar.	string
$flow.order_product_exchange_reason	É o 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.	string
$flow.order_refund_mode	A forma de pagamento para o reembolso, se aplicável. Os valores válidos são definidos pela entidade prebuilt_components_exchange_order_refund_mode. Se nenhum reembolso for necessário, esse valor será null.	string
$flow.total_refund_amount	O valor a ser reembolsado, se o preço do produto a ser trocado for maior do que o do novo produto. Se nenhum reembolso for necessário, esse valor será null.	integer

Parâmetros de resposta da API

Os parâmetros a seguir são extraídos da resposta da API para serem usados pelo componente.

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

Para configurar o webhook de detalhes pós-troca 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:post_exchange_details.
7. Substitua o URL no campo Webhook URL dos Agentes de conversa (Dialogflow CX) pelo endpoint do serviço com que você quer fazer a integração. 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 seu webhook.
9. Revise e atualize a Configuração de resposta para extrair campos específicos do objeto. resposta. Não modifique os nomes dos parâmetros, porque eles são necessários para que o componente acesse 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 de COD

O webhook prebuilt_components_exchange_order:send_COD_refund_information é usada 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 identificar o usuário.	string
$flow.order_id	O código do pedido para enviar um tíquete.	string
$flow.channel	O canal específico para enviar informações. 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 de informações de envio de reembolso do COD para este 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 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 dos agentes de conversação (Dialogflow CX) 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 seu webhook.
9. Revise e atualize a Configuração de resposta para extrair campos específicos do objeto. resposta. Não modifique os nomes dos parâmetros, porque eles são necessários para que o componente acesse os valores de campo retornados.
10. Revise e atualize as configurações de autenticação conforme necessário.
11. Clique em Salvar.

Concluído

Seu agente e os webhooks dele estão configurados e prontos para testes.