REST API for Latepoint icon

REST API for Latepoint

Consume REST API for LatePoint on Tools

Actions40

Overview

This node integrates with the LatePoint REST API to manage orders, specifically supporting the creation of new orders. It allows users to create an order by either specifying individual fields or sending a custom JSON or form data body. This flexibility is useful in scenarios where you want to automate order creation in a booking or service management system, such as creating customer orders after a booking is confirmed or processing sales transactions.

Practical examples include:

  • Automatically creating an order when a customer books a service.
  • Sending complex order details as a JSON payload for advanced use cases.
  • Using form data to submit order information if required by the API.

Properties

Name Meaning
Description A text description or prompt explaining the purpose of the API call, helping AI understand the context.
Send Body Whether to send a custom request body (JSON or form data) instead of using individual input fields. Applicable for create and update operations.
Body Content Type The format of the custom body content: either JSON or Form Data.
JSON Body A JSON object string representing the entire request body to send. Useful for complex or nested order data structures.
Form Data Key-value pairs to send as form data parameters in the request body.
Additional Fields Collection of individual fields relevant to the order resource that can be set when not sending a custom body. Includes fields like customer_id, subtotal, total, status (order status), payment_status, fulfillment_status, customer_comment, and coupon_code.

Additional Fields Details (for Orders resource)

  • customer_id: Identifier of the customer placing the order.
  • subtotal: Numeric subtotal amount of the order.
  • total: Numeric total amount of the order.
  • status: Order status; options are "Open", "Completed", or "Cancelled".
  • payment_status: Payment status; options are "Not Paid", "Paid", or "Partially Paid".
  • fulfillment_status: Fulfillment status; options are "Not Fulfilled", "Fulfilled", or "Completed".
  • customer_comment: Any comment from the customer related to the order.
  • coupon_code: Coupon code applied to the order.

Output

The node outputs the response from the LatePoint API as JSON. For the Create operation on Orders, this will typically be the newly created order object returned by the API, containing all relevant order details such as IDs, amounts, statuses, and any other metadata provided by the API.

If multiple items are returned (not typical for create), each item is output as a separate JSON object in the output array.

No binary data output is indicated.

Dependencies

  • Requires an API key credential for authenticating with the LatePoint REST API.
  • The base URL and API key must be configured in the node credentials.
  • The node sends HTTP requests with JSON content type by default.
  • No additional external dependencies beyond the LatePoint API and its authentication.

Troubleshooting

  • Invalid JSON in body: If using the JSON Body option, ensure the JSON string is valid. Errors parsing JSON will throw an error indicating invalid JSON.
  • Missing credentials: The node requires API credentials; if not configured, it throws an error.
  • API errors: Any errors returned by the LatePoint API will be surfaced. Use the error messages to verify request parameters and API access.
  • Incorrect field names or types: When not using a custom body, ensure additional fields match expected API field names and types.
  • Form Data issues: When using form data, ensure parameters are correctly named and values are strings.

Links and References

Discussion