ghl_payment_order_list
Retrieve a paginated list of orders with filters for status, payment status, payment mode, date range, contact, funnel products, and source. Supports pagination via limit and offset.
Instructions
List Orders The "List Orders" API allows to retrieve a paginated list of orders. Customize your results by filtering orders based on name, alt type, order status, payment mode, date range, type of source, contact, funnel products or paginate through the list using the provided query parameters. This endpoint provides a straightforward way to explore and retrieve order information. Endpoint: GET /payments/orders (Version header: v3; source: v3/payments-v3.json) OAuth scopes: payments/orders.readonly Pagination params: limit, offset — pass them to page through full result sets.
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. | |
| paymentMode | No | Mode of payment. | |
| paymentStatus | No | Payment Status of the Order | |
| funnelProductIds | No | Funnel product ids separated by comma. |