Overview
This n8n custom node integrates with the VTEX e-commerce platform, specifically enabling users to retrieve detailed information about a specific order by its ID. The "Order: GET BY ID" operation is useful for automating workflows that require fetching order details for processing, reporting, or customer service tasks. For example, you might use this node to look up an order's status after a payment event, or to pull order data into another system for fulfillment.
Properties
| Name | Type | Meaning |
|---|---|---|
| ID Order | String | The unique identifier of the order to retrieve details for. This is required and should be the VTEX order ID. |
Output
- json: The output will contain the full details of the specified order in JSON format. The structure will reflect the VTEX API's response for an order, typically including fields such as orderId, status, items, customer information, shipping details, and more.
Dependencies
- External Service: Requires access to the VTEX API.
- Credentials: Needs a configured
vtexApicredential in n8n, which must include at least the domain (and likely authentication tokens or keys as per your VTEX setup). - n8n Configuration: Ensure the VTEX API credentials are set up in n8n under the name
vtexApi.
Troubleshooting
- Missing or Invalid Credentials: If the
vtexApicredential is not configured or is incorrect, the node will fail to connect to VTEX. Make sure the domain and any required authentication details are correct. - Invalid Order ID: Providing an incorrect or non-existent order ID will result in an error from the VTEX API, typically indicating "Order not found" or a similar message.
- API Rate Limits: Excessive requests may trigger rate limiting on the VTEX side, resulting in errors or delayed responses.
- Network Issues: Connectivity problems between n8n and VTEX can cause timeouts or failed requests.