fulfillmenttools icon

fulfillmenttools

Consume fulfillmenttools API

Actions12

Overview

This node interacts with the "Facility" resource of the Fulfillmenttools API, specifically supporting the List operation. It retrieves a list of facilities based on various filtering and pagination options. This is useful when you want to fetch multiple facility records for reporting, synchronization, or further processing in your workflow.

Typical use cases include:

  • Retrieving all facilities or a subset filtered by status or tenant-specific IDs.
  • Paginating through large sets of facilities using limits and start-after IDs.
  • Sorting the results by name, creation date, or postal code.

For example, you might use this node to get all online facilities sorted by name to display active locations in a dashboard.

Properties

Name Meaning
Return All Whether to return all matching facilities or limit the number of results returned.
Limit Maximum number of results to return (used if Return All is false).
Start After ID Return results starting after the specified facility ID (for pagination).
Size Number of results to show per request (page size).
Status Filter facilities by their status: Online, Offline, Suspended, or no filter (empty).
Tenant Facility ID Filter results by a specific tenant facility identifier.
Order By Sort the results by one of: Name, Created date, or Postal Code ascending, or no sorting (empty).

Output

The output is a JSON array where each item represents a facility object as returned by the Fulfillmenttools API. The structure includes all standard facility fields such as IDs, names, statuses, addresses, and other metadata.

No binary data is output by this node.

Example snippet of output JSON structure (simplified):

[
  {
    "id": "facility_123",
    "name": "Main Warehouse",
    "status": "ONLINE",
    "postalCode": "12345",
    "tenantFacilityId": "tenant_abc",
    ...
  },
  ...
]

Dependencies

  • Requires an API key credential for authenticating with the Fulfillmenttools API.
  • Uses internal helper functions to make HTTP GET requests and handle pagination automatically.
  • No additional external dependencies beyond the configured API authentication.

Troubleshooting

  • Empty results: Check that filters like Status or Tenant Facility ID are correct and match existing facilities.
  • API errors: If the API returns errors (e.g., unauthorized), verify that the API key credential is valid and has sufficient permissions.
  • Pagination issues: When using Start After ID, ensure the ID exists and is correctly formatted; otherwise, results may be empty or incomplete.
  • Limit vs Return All: Setting Return All to false but specifying a very high Limit may cause performance issues or timeouts depending on API constraints.

Links and References

Discussion