πŸš€ More Vendrato tools: FunnelDupe β€’ GHL Utils
πŸ“¦

List Orders

n8n-nodes-base.httpRequest

Retrieves a paginated list of orders with advanced filtering options.

gohighlevel payments orders ecommerce crm
App GoHighLevel
Category api integration
Version 1.0.0
Author Community
Credentials GoHighLevel OAuth2 API

πŸ’‘ Use Cases

πŸ“š API Documentation

Reference documentation for this API endpoint:

πŸ”— https://marketplace.gohighlevel.com/docs/ghl/store/list-orders β†—

πŸ“‹ Node Configuration

{
  "nodes": [
    {
      "parameters": {
        "content": "## πŸ“¦ List Orders\n\n**Usage:**\nRetrieves a paginated list of orders with advanced filtering options.\n\n**Required Input:**\n- `altId`: Location ID (agency or location)\n- `altType`: 'location' or 'agency'\n\n**Optional Fields:**\n- `locationId`: Filter by location ID\n- `status`: Order status filter\n- `paymentMode`: Payment method filter\n- `startAt`: Start date for date range filter\n- `endAt`: End date for date range filter\n- `search`: Search by order details\n- `contactId`: Filter by contact ID\n- `funnelProductIds`: Filter by funnel product IDs\n- `limit`, `offset`: Pagination controls\n\n**Setup:**\n1. Configure GoHighLevel OAuth2 API credentials\n2. Pass required fields and optional filters\n3. Node returns paginated order list\n\n**Output:**\nReturns `data` array with orders and `totalCount` for pagination\n\n**Credential Setup (HTTP Header Auth):**\n1. In n8n, go to Credentials β†’ Add Credential\n2. Select \"Header Auth\"\n3. Set Name: `Authorization`\n4. Set Value: `Bearer YOUR_ACCESS_TOKEN`\n5. Get your token from GHL Settings β†’ Integrations β†’ Private Integrations",
        "height": 238,
        "width": 389,
        "color": 4
      },
      "type": "n8n-nodes-base.stickyNote",
      "position": [
        96,
        332
      ],
      "typeVersion": 1,
      "id": "sticky-list-orders",
      "name": "Sticky Note"
    },
    {
      "parameters": {
        "method": "GET",
        "url": "=https://services.leadconnectorhq.com/payments/orders?altId={{ $json.altId }}&altType={{ $json.altType }}{{ $json.locationId ? '&locationId=' + $json.locationId : '' }}{{ $json.status ? '&status=' + $json.status : '' }}{{ $json.paymentMode ? '&paymentMode=' + $json.paymentMode : '' }}{{ $json.startAt ? '&startAt=' + $json.startAt : '' }}{{ $json.endAt ? '&endAt=' + $json.endAt : '' }}{{ $json.search ? '&search=' + $json.search : '' }}{{ $json.contactId ? '&contactId=' + $json.contactId : '' }}{{ $json.funnelProductIds ? '&funnelProductIds=' + $json.funnelProductIds : '' }}{{ $json.limit ? '&limit=' + $json.limit : '' }}{{ $json.offset ? '&offset=' + $json.offset : '' }}",
        "authentication": "genericCredentialType",
        "sendHeaders": true,
        "headerParameters": {
          "parameters": [
            {
              "name": "Version",
              "value": "2021-07-28"
            }
          ]
        },
        "options": {},
        "genericAuthType": "httpHeaderAuth"
      },
      "id": "list-orders-node",
      "name": "List Orders",
      "type": "n8n-nodes-base.httpRequest",
      "typeVersion": 4.1,
      "position": [
        368,
        400
      ],
      "credentials": {
        "httpHeaderAuth": {
          "id": "GHL_Private_Token",
          "name": "GoHighLevel Private Integration"
        }
      }
    }
  ],
  "connections": {},
  "pinData": {},
  "meta": {
    "templateCredsSetupCompleted": true,
    "instanceId": "751aeba95f3d1aebe5a6ebe9d20293dd6c0f61b00ef369c580f0dc54913f5fcb"
  }
}
[
  {
    "id": "c9eb11ec-5674-4d8b-8519-03acbd29b040",
    "meta": {
      "name": "API Call Node",
      "id": "api-call",
      "icon": {
        "svg": "",
        "type": "SVG"
      },
      "description": "## πŸ“¦ List Orders  **Usage:**"
    },
    "label": "List Orders",
    "dependencies": {
      "node-fetch": "3.3.2"
    },
    "script": "import fetch from \"node-fetch\";\nexport default async function apiCall({\n    url,\n    method,\n    contentType,\n    authorization,\n    body,\n    shouldAwait,\n    queryParams,\n    customHeaders\n}: NodeInputs, {\n    logging\n}: NodeScriptOptions) : NodeOutput  {\n    const headers = {\n        \"Content-Type\": contentType,\n        ...customHeaders\n    };\n    if (authorization) headers[\"Authorization\"] = authorization;\n\n    let queryParamsString = '';\n    if (queryParams) {\n        queryParamsString = '?' + new URLSearchParams(queryParams).toString();\n    }\n\n    const fetchOptions = {\n        method,\n        headers\n    };\n\n    if (method !== 'GET') {\n        fetchOptions.body = JSON.stringify(body);\n    }\n\n    const fetchPromise = fetch(url + queryParamsString, fetchOptions);\n\n    if (!shouldAwait) {\n        return {\n            data: null\n        };\n    }\n\n    const response = await fetchPromise;\n    const data = await response.json();\n    return {\n        status: response.status,\n        data\n    };\n}",
    "inputs": {
      "properties": {
        "method": {
          "type": "string",
          "description": "The HTTP method to use for the API call",
          "enum": [
            "GET",
            "POST",
            "PUT",
            "DELETE",
            "PATCH"
          ],
          "default": "GET",
          "title": "HTTP Method",
          "buildship": {
            "options": [
              {
                "label": "GET",
                "value": "GET"
              },
              {
                "value": "POST",
                "label": "POST"
              },
              {
                "value": "PUT",
                "label": "PUT"
              },
              {
                "label": "DELETE",
                "value": "DELETE"
              },
              {
                "label": "PATCH",
                "value": "PATCH"
              }
            ],
            "index": 0,
            "sensitive": false
          }
        },
        "url": {
          "description": "The URL of the API endpoint",
          "title": "URL",
          "type": "string",
          "buildship": {
            "index": 1
          }
        },
        "authorization": {
          "description": "The authorization header for the API call, if required (e.g., Bearer or Basic token)",
          "type": "string",
          "title": "Authorization",
          "buildship": {
            "sensitive": true,
            "index": 2
          }
        },
        "queryParams": {
          "default": {},
          "description": "The query parameters for the API call",
          "type": "object",
          "title": "Query Parameters",
          "buildship": {
            "index": 3,
            "sensitive": false
          }
        },
        "body": {
          "type": "object",
          "buildship": {
            "index": 4
          },
          "description": "The body to send with the API call",
          "title": "Body"
        },
        "contentType": {
          "enum": [
            "application/json",
            "application/x-www-form-urlencoded",
            "multipart/form-data",
            "text/plain"
          ],
          "description": "The content type of the API call",
          "title": "Content Type",
          "buildship": {
            "index": 5,
            "options": [
              {
                "label": "application/json",
                "value": "application/json"
              },
              {
                "value": "application/x-www-form-urlencoded",
                "label": "application/x-www-form-urlencoded"
              },
              {
                "label": "multipart/form-data",
                "value": "multipart/form-data"
              },
              {
                "label": "text/plain",
                "value": "text/plain"
              }
            ]
          },
          "type": "string"
        },
        "shouldAwait": {
          "description": "Whether to wait for the request to complete or not",
          "title": "Await?",
          "type": "boolean",
          "buildship": {
            "sensitive": false,
            "index": 6
          }
        },
        "customHeaders": {
          "type": "object",
          "description": "Additional custom headers for the API call",
          "title": "Custom Headers",
          "buildship": {
            "index": 7,
            "sensitive": false
          }
        }
      },
      "type": "object",
      "required": [
        "url",
        "shouldAwait",
        "method"
      ]
    },
    "integrations": [],
    "name": "API Call Node",
    "output": {
      "buildship": {},
      "properties": {
        "status": {
          "buildship": {
            "index": 0
          },
          "type": "number",
          "description": "The HTTP status of the API response",
          "title": "Status"
        },
        "data": {
          "buildship": {
            "index": 1
          },
          "title": "Data",
          "type": "object",
          "description": "The data object from the API response"
        }
      },
      "type": "object"
    },
    "isCollapsed": false,
    "type": "script",
    "values": {
      "method": "GET",
      "url": {
        "_$expression_": "`https://services.leadconnectorhq.com/payments/orders?altId=${ctx?.[\"root\"]?.[\"inputs\"]?.[\"body\"].altId}&altType=${ctx?.[\"root\"]?.[\"inputs\"]?.[\"body\"].altType}{{ $json.locationId ? '&locationId=' + $json.locationId : '' }}{{ $json.status ? '&status=' + $json.status : '' }}{{ $json.paymentMode ? '&paymentMode=' + $json.paymentMode : '' }}{{ $json.startAt ? '&startAt=' + $json.startAt : '' }}{{ $json.endAt ? '&endAt=' + $json.endAt : '' }}{{ $json.search ? '&search=' + $json.search : '' }}{{ $json.contactId ? '&contactId=' + $json.contactId : '' }}{{ $json.funnelProductIds ? '&funnelProductIds=' + $json.funnelProductIds : '' }}{{ $json.limit ? '&limit=' + $json.limit : '' }}{{ $json.offset ? '&offset=' + $json.offset : '' }}`",
        "type": "javascript",
        "hasErrors": false
      },
      "authorization": {
        "_$expression_": "`Bearer ${(await getSecret(\"ANONYMIZED_SECRET\"))}`",
        "type": "javascript",
        "hasErrors": false
      },
      "queryParams": {},
      "body": {},
      "contentType": "application/json",
      "shouldAwait": true,
      "customHeaders": {
        "Version": "2021-07-28"
      }
    }
  }
]
{
  "subflows": [
    {
      "flow": [
        {
          "id": 454,
          "module": "http:ActionSendDataBasicAuth",
          "version": 3,
          "parameters": {
            "key": "ANONYMIZED_CREDENTIALS",
            "handleErrors": false,
            "useNewZLibDeCompress": true
          },
          "mapper": {
            "ca": "",
            "qs": [],
            "url": "https://services.leadconnectorhq.com/payments/orders?altId={{1.altId}}&altType={{1.altType}}{{ $json.locationId ? '&locationId=' + $json.locationId : '' }}{{ $json.status ? '&status=' + $json.status : '' }}{{ $json.paymentMode ? '&paymentMode=' + $json.paymentMode : '' }}{{ $json.startAt ? '&startAt=' + $json.startAt : '' }}{{ $json.endAt ? '&endAt=' + $json.endAt : '' }}{{ $json.search ? '&search=' + $json.search : '' }}{{ $json.contactId ? '&contactId=' + $json.contactId : '' }}{{ $json.funnelProductIds ? '&funnelProductIds=' + $json.funnelProductIds : '' }}{{ $json.limit ? '&limit=' + $json.limit : '' }}{{ $json.offset ? '&offset=' + $json.offset : '' }}",
            "data": "",
            "gzip": true,
            "method": "get",
            "headers": [
              {
                "name": "Version",
                "value": "2021-07-28"
              },
              {
                "name": "Authorization",
                "value": "Bearer {{ANONYMIZED_TOKEN}}"
              }
            ],
            "timeout": "",
            "useMtls": false,
            "bodyType": "raw",
            "contentType": "application/json",
            "serializeUrl": false,
            "shareCookies": false,
            "parseResponse": true,
            "followRedirect": true,
            "useQuerystring": false,
            "followAllRedirects": false,
            "rejectUnauthorized": true
          },
          "metadata": {
            "designer": {
              "x": 300,
              "y": 300,
              "name": "List Orders"
            },
            "restore": {
              "expect": {
                "qs": {
                  "mode": "chose",
                  "items": []
                },
                "method": {
                  "mode": "chose",
                  "label": "GET"
                },
                "headers": {
                  "mode": "chose",
                  "items": [
                    null,
                    null
                  ]
                },
                "bodyType": {
                  "label": "Raw"
                },
                "contentType": {
                  "label": "JSON (application/json)"
                }
              },
              "parameters": {
                "key": {
                  "label": "ANONYMIZED_CREDENTIALS"
                }
              }
            },
            "parameters": [
              {
                "name": "key",
                "type": "keychain:basicauth",
                "label": "Credentials",
                "required": true
              },
              {
                "name": "handleErrors",
                "type": "boolean",
                "label": "Evaluate all states as errors (except for 2xx and 3xx )",
                "required": true
              },
              {
                "name": "useNewZLibDeCompress",
                "type": "hidden"
              }
            ],
            "expect": [
              {
                "name": "url",
                "type": "url",
                "label": "URL",
                "required": true
              },
              {
                "name": "serializeUrl",
                "type": "boolean",
                "label": "Serialize URL",
                "required": true
              },
              {
                "name": "method",
                "type": "select",
                "label": "Method",
                "required": true,
                "validate": {
                  "enum": [
                    "get",
                    "head",
                    "post",
                    "put",
                    "patch",
                    "delete",
                    "options"
                  ]
                }
              },
              {
                "name": "headers",
                "spec": [
                  {
                    "name": "name",
                    "type": "text",
                    "label": "Name",
                    "required": true
                  },
                  {
                    "name": "value",
                    "type": "text",
                    "label": "Value"
                  }
                ],
                "type": "array",
                "label": "Headers"
              },
              {
                "name": "qs",
                "spec": [
                  {
                    "name": "name",
                    "type": "text",
                    "label": "Name",
                    "required": true
                  },
                  {
                    "name": "value",
                    "type": "text",
                    "label": "Value"
                  }
                ],
                "type": "array",
                "label": "Query String"
              },
              {
                "name": "bodyType",
                "type": "select",
                "label": "Body type",
                "validate": {
                  "enum": [
                    "raw",
                    "x_www_form_urlencoded",
                    "multipart_form_data"
                  ]
                }
              },
              {
                "name": "parseResponse",
                "type": "boolean",
                "label": "Parse response",
                "required": true
              },
              {
                "name": "contentType",
                "type": "select",
                "label": "Content type",
                "validate": {
                  "enum": [
                    "text/plain",
                    "application/json",
                    "application/xml",
                    "text/xml",
                    "text/html",
                    "custom"
                  ]
                }
              },
              {
                "name": "data",
                "type": "buffer",
                "label": "Request content"
              }
            ]
          }
        }
      ]
    }
  ],
  "metadata": {
    "version": 1
  }
}
← Browse all nodes