Branches

Overview

This node retrieves a paginated list of branches from the Jelp Delivery service. It is useful when you need to fetch branch information such as locations or identifiers in bulk, with control over how many results to retrieve and which page of results to access. Typical use cases include synchronizing branch data into other systems, displaying branch options for delivery services, or performing analytics on branch distribution.

Properties

Output

The node outputs an array of JSON objects, each representing the response from the Jelp Delivery API containing branch data. The structure corresponds directly to the API's JSON response for the branches endpoint. There is no binary data output.

Example output JSON structure (simplified):

{
  "branches": [
    {
      "id": "branch_123",
      "name": "Main Branch",
      "address": "...",
      ...
    },
    ...
  ],
  "pagination": {
    "limit": 50,
    "page": 0,
    "total": 200
  }
}

Dependencies

• Requires an API key credential for authenticating with the Jelp Delivery API.
• The node uses a base URL constant defined elsewhere (BASE_URL) pointing to the Jelp Delivery API endpoint.
• Proper configuration of the API authentication credential within n8n is necessary.

Troubleshooting

• Authentication errors: If the node fails due to authentication, verify that the API key credential is correctly configured and has sufficient permissions.
• Invalid pagination parameters: Ensure that the Limit is at least 5 and Page is zero or positive; otherwise, the API may reject the request.
• API response parsing errors: If the API returns unexpected data or errors, the node attempts to parse JSON but may fail if the response is malformed. Check the API status and network connectivity.
• Empty results: If no branches are returned, verify that the requested page and limit correspond to existing data.

Links and References

• Jelp Delivery API Documentation (hypothetical link)
• n8n documentation on Creating Custom Nodes