HighLevel: List Orders

← Payments operations · Get started

Operation gohighlevel.list_orders

Provider route: GET /payments/orders. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/gohighlevel with npm, or alter-sdk-gohighlevel with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { HighLevelIntegration } from "@alter-ai/gohighlevel";

async function execute(input: Parameters<HighLevelIntegration["payments"]["listOrders"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new HighLevelIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.payments.listOrders(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_gohighlevel import HighLevelIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = HighLevelIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.payments.list_orders(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
query	object	Required within parent	Additional keys: not allowed
query.locationId	string	Optional
query.altId	string	Required within parent
query.status	string	Optional
query.paymentStatus	string	Optional	One of: paid, unpaid, refunded, partially_paid
query.paymentMode	string	Optional
query.startAt	string	Optional
query.endAt	string	Optional
query.search	string	Optional
query.contactId	string	Optional
query.funnelProductIds	string	Optional
query.sourceId	string	Optional
query.limit	number	Optional	Default: 10
query.offset	number	Optional	Default: 0

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand List Orders — response body

Referenced models: List Orders — response body

Schemas

List Orders — response body

Field	Type	Presence	Description and constraints
$	object	Root
data	array	Required within parent	An array of orders
data[]	Model	Each item	Expand List Orders — response body — data item
totalCount	JSON	Required within parent
totalCount (anyOf 1)	number	Alternative	total orders count
totalCount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: List Orders — response body — data item

List Orders — response body — data item

Field	Type	Presence	Description and constraints
$	object	Root
_id	string	Required within parent	The unique identifier for the order.
altId	string	Required within parent	AltId is the unique identifier eg: location id.
altType	string	Required within parent	AltType is the type of identifier.
amount	JSON	Optional
amount (anyOf 1)	number	Alternative	Order value.
amount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
contactEmail	string	Optional	Contact email corresponding to the order.
contactId	string	Optional	Contact id corresponding to the order.
contactName	string	Optional	Contact name corresponding to the order.
couponCode	string	Optional	Coupon code for the order.
createdAt	string	Required within parent	The creation timestamp of the order. Format: date-time
createdBy	string	Optional	User ID who created the order.
currency	string	Optional	Currency in which order was created.
discount	JSON	Optional
discount (anyOf 1)	number	Alternative	Discount value on order.
discount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
fulfillmentStatus	string	Optional	Fulfillment status of the order.
liveMode	boolean	Optional	Order is in live / test mode.
onetimeProducts	JSON	Optional
onetimeProducts (anyOf 1)	number	Alternative	Total one time products in an order.
onetimeProducts (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
recurringProducts	JSON	Optional
recurringProducts (anyOf 1)	number	Alternative	Total recurring time products in an order.
recurringProducts (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
sourceId	string	Optional	Source id for the order.
sourceMeta	object	Optional	Meta content for the source of order.
sourceName	string	Optional	Source name for the order.
sourceSubType	string	Optional	Source sub-type for the order.
sourceType	string	Required within parent	Source type of order (eg: funnel).
status	string	Required within parent	The status of the order (e.g., completed).
subtotal	JSON	Optional
subtotal (anyOf 1)	number	Alternative	Order sub-total value.
subtotal (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
totalProducts	JSON	Optional
totalProducts (anyOf 1)	number	Alternative	Total products in an order.
totalProducts (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
updatedAt	string	Required within parent	The last update timestamp of the order. Format: date-time

Policy, approvals and errors

SDK function policy ID: gohighlevel.list_orders. Catalog operation: list-orders. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["payments/orders.readonly"]

Pinned headers: {"Version": "v3"}

Official provider source