FreeWebStore icon

FreeWebStore

Interact with FreeWebStore API

Actions13

Overview

This node interacts with the FreeWebStore API to retrieve multiple orders based on specified filters and parameters. It is useful for scenarios where users need to fetch a list of orders with various filtering options such as status, date range, tags, and sorting preferences. For example, an e-commerce manager can use this node to get all open orders created within a specific date range, or to retrieve a limited number of recent orders sorted by creation date.

Use Case Examples

  1. Fetch up to 100 orders with status 'open' created after a certain date.
  2. Retrieve orders with specific tags and sort them by order number in descending order.

Properties

Name Meaning
Limit Number of results to return, limiting the number of orders fetched.
Offset Number of results to skip, useful for pagination.
Status Filter orders by their status such as open, closed, problem, new, starred, cart, or canceled.
Sort Sort order of the results, such as by creation date or order number, ascending or descending.
Tags Comma separated list of tags to filter orders by.
Start Date Filter orders from this date (ISO 8601 format).
End Date Filter orders until this date (ISO 8601 format).
Fields Comma separated list of optional fields to include in the response, such as customer or tags.

Output

JSON

  • orderId - Unique identifier of the order.
  • status - Current status of the order.
  • created - Creation date of the order.
  • orderNo - Order number.
  • customer - Customer details if requested in fields.
  • tags - Tags associated with the order if requested.

Dependencies

  • FreeWebStore API key credential required for authentication.

Troubleshooting

  • Common issues include invalid or missing API key, resulting in authentication errors.
  • Incorrect filter values or date formats may cause the API to return errors or empty results.
  • Network connectivity issues can prevent successful API requests.

Links

Discussion