Nuvem Solution icon

Nuvem Solution

Interact with Nuvem Solution API

Actions120

Pedido → Criar Pedido Completo

AI-generated

Overview

The "Criar Pedido Completo" operation in the "Pedido" resource allows users to create a complete order with all its items in a single API call to the Nuvem Solution platform. This operation is useful for scenarios where an entire order, including multiple products or services, needs to be created atomically rather than creating the order and its items separately.

Typical use cases include:

  • Automating sales order creation from e-commerce platforms or CRM systems.
  • Integrating full order data from external systems into Nuvem Solution.
  • Batch processing of orders with detailed item information.

For example, a user can send a JSON payload describing the customer, payment terms, and a list of ordered items, and the node will create the order with all these details in one request.

Properties

Name Meaning
Request Body JSON body for the request. This should contain the complete order data including items.

The "Request Body" property expects a JSON object that represents the full order details as required by the Nuvem Solution API endpoint /erp/balcao/pedidos/completo. The exact structure depends on the API specification but typically includes customer info, payment details, and an array of order items.

Output

The node outputs the JSON response returned by the Nuvem Solution API after creating the complete order. This output typically contains:

  • Confirmation of the created order.
  • Order ID and metadata.
  • Details of the included items.
  • Status or error messages if any.

The output is provided as a JSON array (one element per input item) under the json field. There is no binary data output for this operation.

Dependencies

  • Requires an API key credential for authenticating with the Nuvem Solution API.
  • The node uses the base URL and authentication tokens obtained from the credentials.
  • The API endpoint used is: POST /erp/balcao/pedidos/completo.
  • The user must provide valid JSON in the "Request Body" property matching the API's expected schema.

Troubleshooting

  • Invalid JSON in Request Body: If the JSON is malformed or does not conform to the API schema, the API will return an error. Ensure the JSON is valid and correctly structured.
  • Authentication Errors: If the API key or token is invalid or expired, authentication will fail. Verify credentials are correct and have necessary permissions.
  • API Endpoint Errors: If the API returns errors related to missing fields or business rules (e.g., invalid customer ID, out-of-stock items), check the request body content carefully.
  • Network Issues: Connectivity problems may cause request failures. Check network access to the API endpoint.
  • Continue On Fail: If enabled, the node will continue processing other items even if one fails, returning error messages in the output.

Links and References

  • Nuvem Solution API Documentation (general reference; specific endpoint docs may require login)
  • Refer to your Nuvem Solution account or support for detailed API request body schemas for creating complete orders.

This summary is based solely on static analysis of the provided source code and property definitions. It assumes the user has access to the official API documentation for precise request body formats.

Discussion