fulfillmenttools icon

fulfillmenttools

Consume fulfillmenttools API

Actions12

Overview

This node integrates with the Fulfillmenttools API to manage facility carriers, specifically allowing users to create a connection between a facility and a carrier. It is useful in logistics and supply chain automation scenarios where you need to programmatically link carriers to facilities for shipping, billing, and delivery configurations.

For example, a warehouse manager can use this node to register a new carrier connection for a specific facility, including detailed configuration such as billing numbers, contact IDs, cutoff times, delivery areas, parcel label classifications, and valid delivery targets. This enables automated handling of shipments through the specified carrier.

Properties

Name Meaning
Facility ID The unique identifier of the facility for which you want to create a carrier connection.
Carrier Ref The identifier of the carrier to be referenced/connected to the facility.
Locale Optional localization settings for names and descriptions related to parcel label classifications.
Facility Carrier A JSON object representing the detailed connection configuration, including credentials, configuration, cutoff time, delivery areas, name, status, parcel label classifications, tags, and valid delivery targets.

The Facility Carrier JSON structure includes:

  • credentials: Authentication and billing details required by the carrier.
  • configuration: Additional configuration such as contact IDs.
  • cutoffTime: Time after which orders are not accepted for same-day processing.
  • deliveryAreas: List of countries and postal codes served.
  • name: Name of the facility carrier connection.
  • status: Status of the connection (e.g., ACTIVE).
  • parcelLabelClassifications: Dimensions and localized names for parcel labels.
  • tags: Tags associated with the connection.
  • validDeliveryTargets: Allowed delivery target types (e.g., SHIP_TO_STORE).

Output

The node outputs a JSON object representing the response from the Fulfillmenttools API after creating the facility carrier connection. This typically includes all details of the newly created connection, confirming the stored data and any generated identifiers.

No binary data output is produced by this operation.

Dependencies

  • Requires an active connection to the Fulfillmenttools API.
  • Needs an API authentication token or key configured in n8n credentials for Fulfillmenttools.
  • The node uses internal helper functions to make HTTP requests to the Fulfillmenttools REST endpoints.

Troubleshooting

  • Common issues:

    • Missing or invalid Facility ID or Carrier Ref parameters will cause the API request to fail.
    • Incorrectly formatted JSON in the Facility Carrier property may result in validation errors.
    • Authentication failures if the API key credential is missing or invalid.
    • Network connectivity issues preventing access to the Fulfillmenttools API.

  • Error messages:

    • Errors returned from the API will be propagated, often indicating missing required fields or invalid values.
    • If the node is set to continue on failure, error messages will appear in the output JSON under an error field.

  • Resolutions:

    • Verify that all required fields are provided and correctly formatted.
    • Ensure the API key credential is properly configured and has necessary permissions.
    • Check network connectivity and API endpoint availability.
    • Use the locale parameter carefully to avoid unsupported language codes.

Links and References

Discussion