AvantGuard - Pax8 - Partner icon

AvantGuard - Pax8 - Partner

AvantGuard - Pax8

Actions28

Overview

The "Create Order" operation for the "Orders" resource allows users to create a new order in the system by specifying details such as the purchasing company, line items, and optional additional fields. This node is useful in scenarios where automated order creation is needed, such as integrating e-commerce platforms, automating procurement workflows, or syncing orders from external systems.

For example, a reseller platform could use this node to programmatically submit customer orders to a backend system, including detailed line item provisioning information and metadata about who placed the order.

Properties

Name Meaning
Additional Query Parameters Optional query parameters to modify request behavior. Currently supports: Is Mock (boolean) which, if true, performs validations only without interacting with the database.
Company Id The unique identifier of the purchasing company (end-user) placing the order.
Line Items JSON array describing the individual line items in the order. Each item includes line item number, parent line item number, quantity, and provisioning details such as user email address.
Additional Body Fields Optional additional fields for the order body, including:
- Id: Unique id of the order
- Created Date: Date when the order was created
- Ordered By: Type of user who created the order; options are "Pax 8 Partner", "Customer", or "Pax 8"
- Ordered By User Id: Unique id of the user who created the order
- Ordered By User Email: Email address of the user who created the order
- Is Scheduled: Boolean indicating if the order is future dated

Output

The node outputs JSON data representing the created order as returned by the API. This typically includes all submitted order details along with any server-generated fields such as order status, timestamps, or identifiers assigned by the backend.

If the API supports binary data output (not indicated here), it would be summarized accordingly, but this node primarily deals with JSON order data.

Dependencies

  • Requires an API key credential for authenticating with the Pax8 Partner API.
  • The base URL for requests is https://api.pax8.com/v1.
  • The node uses standard HTTP headers for JSON content (Accept: application/json, Content-Type: application/json).
  • No other external dependencies are indicated.

Troubleshooting

  • Validation errors: If Is Mock is set to false or omitted, the API will attempt to create the order. Validation errors may occur if required fields like companyId or lineItems are missing or malformed.
  • Authentication failures: Ensure that a valid API key credential is configured in n8n for the Pax8 Partner API.
  • JSON parsing issues: The lineItems property expects a valid JSON string. Malformed JSON will cause errors.
  • Incorrect option values: For fields like Ordered By, only the specified options ("Pax 8 Partner", "Customer", "Pax 8") are accepted.
  • Network or API errors: Check connectivity and API availability if requests fail unexpectedly.

Links and References

Discussion