Send Admin API request ("Enviar solicitação à API Admin")
A ação Send Admin API request ("Enviar solicitação à API Admin") envia uma mutação à API GraphQL Shopify Admin. Dessa maneira, é possível realizar todas as ações permitidas pela API com o Flow.
Nesta página
Campos
A ação Send Admin API request ("Enviar solicitação à API Admin") apresenta os campos a seguir.
Campo | Descrição |
---|---|
Mutação | Obrigatório. A mutação GraphQL do admin da Shopify que você quer chamar. Uma mutação é uma API que realiza ações ou atualiza dados. |
Entradas de mutação | Obrigatório. Os dados (em JSON) que você precisa enviar como parte da solicitação de mutação. Cada mutação requer um conjunto de dados diferente, que é documentado no link fornecido para cada mutação. Para construir o JSON necessário, use o Liquid ou a ação "Run code" ("Executar código"). |
Acionadores
A ação Send Admin API request ("Enviar solicitação à API Admin") pode ser usada em todos os fluxos de trabalho com qualquer acionador, desde que o fluxo de trabalho forneça os dados necessários para criar as entradas de mutação.
Exemplos
Exemplo 1: atualizar o modelo usado para um produto
Neste exemplo, vamos usar a ação Send Admin API request ("Enviar solicitação à API Admin") para chamar a mutação productUpdate
e atualizar o modelo usado para um produto.
O campo id
é obrigatório e precisa ser um GID de produto válido. Nesse caso, é definido com a variável {{product.id}}
do Liquid. Isso pressupõe que seu fluxo de trabalho tem um acionador com um objeto de produto.
templateSuffix
é o nome do modelo que você quer usar com o produto. Por exemplo, se quiser aplicar o modelo pre-order
, você precisará definir o templateSuffix como pre-order
.
Exemplo 2: atualizar o status de isenção tributária de um cliente
Neste exemplo, vamos usar a ação Send Admin API request ("Enviar solicitação à API Admin") para chamar a mutação customerUpdate
e atualizar o status de isenção tributária do cliente.
O id
é obrigatório e precisa ser um GID de cliente válido. Nesse caso, é definido com a variável {{order.customer.id}}
do Liquid. Isso pressupõe que seu fluxo de trabalho tem um acionador que tem um objeto de pedido.
taxExempt
é um booleano que indica se o cliente está isento de tributos. Neste exemplo, é definido como true
.
Exemplo 3: atualizar a localidade de um cliente
Neste exemplo, vamos usar a ação Send Admin API request ("Enviar solicitação à API Admin") para chamar a mutação customerUpdate
e atualizar a localidade do cliente.
O campo id
é obrigatório e precisa ser um GID de cliente válido. Nesse caso, é definido com a variável {{customer.id}}
do Liquid. Isso pressupõe que seu fluxo de trabalho tem um acionador com um objeto de cliente.
locale
é uma string que representa a localidade do cliente. Neste exemplo, é definido como en
.
Limitações
A ação Send Admin API request ("Enviar solicitação à API Admin") tem as seguintes limitações:
- A ação não retorna dados no ambiente do Flow como resultado da mutação.
- A ação não é compatível com consultas GraphQL, apenas com mutações.
- A ação não é compatível com mutações assíncronas ou que retornam um tipo
Job
. - A ação não aceita mutações específicas de determinados apps, incluindo mutações de assinaturas e desconto.
- A ação exibirá uma lista de
Mutations
eMutation inputs
de uma única versão da API da Shopify, que atualmente é2024-01
. - Quando a versão da API é atualizada e contém uma alteração significativa, a ação pode falhar se depender desse campo específico.