feat: update docs with new approach to consume Platform Actions (#3675)

This commit is contained in:
Lucas Gomide
2025-10-09 09:17:09 -03:00
committed by GitHub
parent 458f56fb33
commit 28a8a7e6fa
82 changed files with 7709 additions and 2690 deletions

View File

@@ -22,7 +22,7 @@ Antes de utilizar a integração com o Shopify, certifique-se de que você possu
### **Gerenciamento de Clientes**
<AccordionGroup>
<Accordion title="SHOPIFY_GET_CUSTOMERS">
<Accordion title="shopify/get_customers">
**Descrição:** Recupera uma lista de clientes da sua loja Shopify.
**Parâmetros:**
@@ -34,7 +34,7 @@ Antes de utilizar a integração com o Shopify, certifique-se de que você possu
- `limit` (string, opcional): Número máximo de clientes a retornar (padrão 250)
</Accordion>
<Accordion title="SHOPIFY_SEARCH_CUSTOMERS">
<Accordion title="shopify/search_customers">
**Descrição:** Pesquise por clientes usando critérios de filtragem avançados.
**Parâmetros:**
@@ -42,7 +42,7 @@ Antes de utilizar a integração com o Shopify, certifique-se de que você possu
- `limit` (string, opcional): Número máximo de clientes a retornar (padrão 250)
</Accordion>
<Accordion title="SHOPIFY_CREATE_CUSTOMER">
<Accordion title="shopify/create_customer">
**Descrição:** Crie um novo cliente em sua loja Shopify.
**Parâmetros:**
@@ -63,7 +63,7 @@ Antes de utilizar a integração com o Shopify, certifique-se de que você possu
- `metafields` (object, opcional): Metacampos adicionais em formato JSON
</Accordion>
<Accordion title="SHOPIFY_UPDATE_CUSTOMER">
<Accordion title="shopify/update_customer">
**Descrição:** Atualize um cliente existente em sua loja Shopify.
**Parâmetros:**
@@ -89,7 +89,7 @@ Antes de utilizar a integração com o Shopify, certifique-se de que você possu
### **Gestão de Pedidos**
<AccordionGroup>
<Accordion title="SHOPIFY_GET_ORDERS">
<Accordion title="shopify/get_orders">
**Descrição:** Recupera uma lista de pedidos da sua loja Shopify.
**Parâmetros:**
@@ -101,7 +101,7 @@ Antes de utilizar a integração com o Shopify, certifique-se de que você possu
- `limit` (string, opcional): Número máximo de pedidos a retornar (padrão 250)
</Accordion>
<Accordion title="SHOPIFY_CREATE_ORDER">
<Accordion title="shopify/create_order">
**Descrição:** Crie um novo pedido em sua loja Shopify.
**Parâmetros:**
@@ -114,7 +114,7 @@ Antes de utilizar a integração com o Shopify, certifique-se de que você possu
- `note` (string, opcional): Observação do pedido
</Accordion>
<Accordion title="SHOPIFY_UPDATE_ORDER">
<Accordion title="shopify/update_order">
**Descrição:** Atualize um pedido existente em sua loja Shopify.
**Parâmetros:**
@@ -128,7 +128,7 @@ Antes de utilizar a integração com o Shopify, certifique-se de que você possu
- `note` (string, opcional): Observação do pedido
</Accordion>
<Accordion title="SHOPIFY_GET_ABANDONED_CARTS">
<Accordion title="shopify/get_abandoned_carts">
**Descrição:** Recupera carrinhos abandonados da sua loja Shopify.
**Parâmetros:**
@@ -144,7 +144,7 @@ Antes de utilizar a integração com o Shopify, certifique-se de que você possu
### **Gestão de Produtos (REST API)**
<AccordionGroup>
<Accordion title="SHOPIFY_GET_PRODUCTS">
<Accordion title="shopify/get_products">
**Descrição:** Recupera uma lista de produtos da sua loja Shopify utilizando a REST API.
**Parâmetros:**
@@ -160,7 +160,7 @@ Antes de utilizar a integração com o Shopify, certifique-se de que você possu
- `limit` (string, opcional): Número máximo de produtos a retornar (padrão 250)
</Accordion>
<Accordion title="SHOPIFY_CREATE_PRODUCT">
<Accordion title="shopify/create_product">
**Descrição:** Crie um novo produto em sua loja Shopify utilizando a REST API.
**Parâmetros:**
@@ -176,7 +176,7 @@ Antes de utilizar a integração com o Shopify, certifique-se de que você possu
- `publishToPointToSale` (boolean, opcional): Se deve publicar no ponto de venda
</Accordion>
<Accordion title="SHOPIFY_UPDATE_PRODUCT">
<Accordion title="shopify/update_product">
**Descrição:** Atualize um produto existente em sua loja Shopify utilizando a REST API.
**Parâmetros:**
@@ -197,14 +197,14 @@ Antes de utilizar a integração com o Shopify, certifique-se de que você possu
### **Gestão de Produtos (GraphQL)**
<AccordionGroup>
<Accordion title="SHOPIFY_GET_PRODUCTS_GRAPHQL">
<Accordion title="shopify/get_products_graphql">
**Descrição:** Recupere produtos utilizando filtros avançados do GraphQL.
**Parâmetros:**
- `productFilterFormula` (object, opcional): Filtro avançado em forma normal disjuntiva com suporte a campos como id, title, vendor, status, handle, tag, created_at, updated_at, published_at
</Accordion>
<Accordion title="SHOPIFY_CREATE_PRODUCT_GRAPHQL">
<Accordion title="shopify/create_product_graphql">
**Descrição:** Crie um novo produto utilizando a API GraphQL com suporte aprimorado a mídias.
**Parâmetros:**
@@ -217,7 +217,7 @@ Antes de utilizar a integração com o Shopify, certifique-se de que você possu
- `additionalFields` (object, opcional): Campos adicionais do produto como status, requiresSellingPlan, giftCard
</Accordion>
<Accordion title="SHOPIFY_UPDATE_PRODUCT_GRAPHQL">
<Accordion title="shopify/update_product_graphql">
**Descrição:** Atualize um produto existente utilizando a API GraphQL com suporte aprimorado a mídias.
**Parâmetros:**
@@ -238,19 +238,13 @@ Antes de utilizar a integração com o Shopify, certifique-se de que você possu
```python
from crewai import Agent, Task, Crew
from crewai_tools import CrewaiEnterpriseTools
# Get enterprise tools (Shopify tools will be included)
enterprise_tools = CrewaiEnterpriseTools(
enterprise_token="your_enterprise_token"
)
# Create an agent with Shopify capabilities
shopify_agent = Agent(
role="E-commerce Manager",
goal="Manage online store operations and customer relationships efficiently",
backstory="An AI assistant specialized in e-commerce operations and online store management.",
tools=[enterprise_tools]
apps=['shopify']
)
# Task to create a new customer
@@ -272,19 +266,12 @@ crew.kickoff()
### Filtrando Ferramentas Específicas do Shopify
```python
from crewai_tools import CrewaiEnterpriseTools
# Get only specific Shopify tools
enterprise_tools = CrewaiEnterpriseTools(
enterprise_token="your_enterprise_token",
actions_list=["shopify_create_customer", "shopify_create_order", "shopify_get_products"]
)
store_manager = Agent(
role="Store Manager",
goal="Manage customer orders and product catalog",
backstory="An experienced store manager who handles customer relationships and inventory management.",
tools=enterprise_tools
apps=['shopify']
)
# Task to manage store operations
@@ -306,17 +293,12 @@ crew.kickoff()
```python
from crewai import Agent, Task, Crew
from crewai_tools import CrewaiEnterpriseTools
enterprise_tools = CrewaiEnterpriseTools(
enterprise_token="your_enterprise_token"
)
product_manager = Agent(
role="Product Manager",
goal="Manage product catalog and inventory with advanced GraphQL capabilities",
backstory="An AI assistant that specializes in product management and catalog optimization.",
tools=[enterprise_tools]
apps=['shopify']
)
# Task to manage product catalog
@@ -343,17 +325,12 @@ crew.kickoff()
```python
from crewai import Agent, Task, Crew
from crewai_tools import CrewaiEnterpriseTools
enterprise_tools = CrewaiEnterpriseTools(
enterprise_token="your_enterprise_token"
)
analytics_agent = Agent(
role="E-commerce Analyst",
goal="Analyze customer behavior and order patterns to optimize store performance",
backstory="An analytical AI that excels at extracting insights from e-commerce data.",
tools=[enterprise_tools]
apps=['shopify']
)
# Complex task involving multiple operations