payments_list_orders
Retrieve orders from GoHighLevel by filtering with status, payment status, date range, contact, or product IDs. Use to manage payment records and track order history.
Instructions
List Orders
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| altId | Yes | AltId is the unique identifier e.g: location id. | |
| endAt | No | Closing interval of orders. | |
| limit | No | The maximum number of items to be included in a single page of results | |
| offset | No | The starting index of the page, indicating the position from which the results should be retrieved. | |
| search | No | The name of the order for searching. | |
| status | No | Order status. | |
| startAt | No | Starting interval of orders. | |
| sourceId | No | Source id | |
| contactId | No | Contact id for filtering of orders. | |
| locationId | No | LocationId is the id of the sub-account. Defaults to GHL_LOCATION_ID when omitted. | |
| paymentMode | No | Mode of payment. | |
| paymentStatus | No | Payment Status of the Order | |
| funnelProductIds | No | Funnel product ids separated by comma. |