HighLevel: Get Order by ID

← Payments operations · Get started

Operation gohighlevel.get_order_by_id

Provider route: GET /payments/orders/{orderId}. 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"]["getOrderById"]>[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.getOrderById(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.get_order_by_id(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.orderId	string	Required within parent
query	object	Required within parent	Additional keys: not allowed
query.locationId	string	Optional
query.altId	string	Required within parent

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 Get Order by ID — response body

Referenced models: Get Order by ID — response body

Schemas

Get Order by ID — response body

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]+)?$
amountSummary	JSON	Optional	Amount details of the order.
amountSummary (allOf 1)	Model	All variants apply	Expand Get Order by ID — response body — amount Summary discount, subtotal
automaticTaxesCalculated	boolean	Optional	Automatic taxes applied for the Order
contactId	string	Optional	Contact id corresponding to the order.
contactSnapshot	object	Optional	Contact details of the order.
coupon	object	Optional	Coupon details of 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.
fingerprint	string	Optional	Fingerprint id of the order.
fulfillmentStatus	string	Optional	Fulfillment status of the order.
items	array	Optional	Item details of the order.
items[]	string	Each item
liveMode	boolean	Optional	Order is in live / test mode.
markAsTest	boolean	Optional	Is test order.
meta	object	Optional	Meta details of the order.
source	JSON	Optional	Source details of the order.
source (allOf 1)	Model	All variants apply	Expand Get Order by ID — response body — source id, meta, name, sub Type, type
status	string	Required within parent	The status of the order (e.g., completed).
taxCalculationProvider	object	Optional	Provider name for automatic tax calculation
traceId	string	Optional	Trace id of the order.
trackingId	string	Optional	Tracking id of the order.
updatedAt	string	Required within parent	The last update timestamp of the order. Format: date-time

Referenced models: Get Order by ID — response body — amount Summary discount, subtotal, Get Order by ID — response body — source id, meta, name, sub Type, type

Get Order by ID — response body — amount Summary discount, subtotal

Field	Type	Presence	Description and constraints
$	object	Root
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]+)?$
subtotal	JSON	Required within parent
subtotal (anyOf 1)	number	Alternative	Order sub-total value.
subtotal (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Get Order by ID — response body — source id, meta, name, sub Type, type

Field	Type	Presence	Description and constraints
$	object	Root
id	string	Required within parent
meta	object	Optional
name	string	Optional
subType	string	Optional	Known values: one_step_order_form, two_step_order_form, upsell, tap_to_pay, card_payment, store, contact_view, email_campaign, payments_dashboard, shopify, subscription_view, store_upsell, woocommerce, service, meeting, imported_csv, qr_code, saas_one_time, saas_subscription
type	string	Required within parent	Known values: funnel, website, invoice, calendar, text2Pay, document_contracts, membership, mobile_app, communities, point_of_sale, manual, form, survey, payment_link, external

Policy, approvals and errors

SDK function policy ID: gohighlevel.get_order_by_id. Catalog operation: get-order-by-id. 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