Skip to main content
GET
/
payments
/
orders
/
{orderId}
Get Order by ID
curl --request GET \
  --url https://services.leadconnectorhq.com/payments/orders/{orderId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Version: <version>'
{
  "_id": "653f5e0cde5a1314e62a837c",
  "altId": "3SwdhCu3svxI8AKsPJt6",
  "altType": "location",
  "status": "completed",
  "createdAt": "2023-11-20T10:23:36.515Z",
  "updatedAt": "2024-01-23T09:57:04.846Z",
  "contactId": "XPLSw2SVagl12LMDeTmQ",
  "currency": "USD",
  "amount": "100",
  "liveMode": "false",
  "fulfillmentStatus": "unfulfilled",
  "contactSnapshot": "{ last_name: \"Mcclain\", type: \"lead\", first_name_lower_case: \"rogan\", email: \"anish+11@gohighlevel.com\", last_name_lower_case: \"mcclain\", location_id: \"o6241QsiRwUIJHyjuhos\", company_name: \"Jordan and Cox Trading\"}",
  "amountSummary": "{ subtotal: 100, discount: 5 }",
  "source": "{ type: \"invoice\", id: \"61dd48ff65b013bc39bb09c6\" }",
  "items": "{ _id: 61dd33e88058b9f967ca79dc, authorizeAmount: 0, locationId: \"SBAWb4yu7A4LSc0skQ6g\", name: \"Sample Product\": price: {}, product: { name: \"Testing product\", productType: \"SERVICE\" }}",
  "coupon": "{ code: \"FEST10\", _id: \"63455e48901b43d4ef364a20\" }",
  "trackingId": "63319ef9-de0a-4c84-aebd-3585fb4a0cdf",
  "fingerprint": "5d51db5a-42b0-4b04-ba88-2c046c982a3a",
  "meta": "{ couponSessionExpired: true }",
  "markAsTest": "false",
  "traceId": "d3b16a92-a8ed-4e6b-8467-844750f78ed5",
  "automaticTaxesCalculated": true,
  "taxCalculationProvider": "taxjar",
  "createdBy": "user123"
}

Authorizations

​
Authorization
string
header
required

Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.

Headers

​
Version
enum<string>
required

API Version

Available options:
2021-07-28

Path Parameters

​
orderId
string
required

ID of the order that needs to be returned

Example:

"653f5e0cde5a1314e62a837c"

Query Parameters

​
locationId
string

LocationId is the id of the sub-account.

Example:

"3SwdhCu3svxI8AKsPJt6"

​
altId
string
required

AltId is the unique identifier e.g: location id.

Example:

"3SwdhCu3svxI8AKsPJt6"

Response

Successful response

​
_id
string
required

The unique identifier for the order.

Example:

"653f5e0cde5a1314e62a837c"

​
altId
string
required

AltId is the unique identifier eg: location id.

Example:

"3SwdhCu3svxI8AKsPJt6"

​
altType
string
required

AltType is the type of identifier.

Example:

"location"

​
status
string
required

The status of the order (e.g., completed).

Example:

"completed"

​
createdAt
string<date-time>
required

The creation timestamp of the order.

Example:

"2023-11-20T10:23:36.515Z"

​
updatedAt
string<date-time>
required

The last update timestamp of the order.

Example:

"2024-01-23T09:57:04.846Z"

​
contactId
string

Contact id corresponding to the order.

Example:

"XPLSw2SVagl12LMDeTmQ"

​
currency
string

Currency in which order was created.

Example:

"USD"

​
amount
number

Order value.

Example:

"100"

​
liveMode
boolean

Order is in live / test mode.

Example:

"false"

​
fulfillmentStatus
string

Fulfillment status of the order.

Example:

"unfulfilled"

​
contactSnapshot
object

Contact details of the order.

Example:

"{ last_name: \"Mcclain\", type: \"lead\", first_name_lower_case: \"rogan\", email: \"anish+11@gohighlevel.com\", last_name_lower_case: \"mcclain\", location_id: \"o6241QsiRwUIJHyjuhos\", company_name: \"Jordan and Cox Trading\"}"

​
amountSummary
object
Example:

"{ subtotal: 100, discount: 5 }"

​
source
object
Example:

"{ type: \"invoice\", id: \"61dd48ff65b013bc39bb09c6\" }"

​
items
string[]

Item details of the order.

Example:

"{ _id: 61dd33e88058b9f967ca79dc, authorizeAmount: 0, locationId: \"SBAWb4yu7A4LSc0skQ6g\", name: \"Sample Product\": price: {}, product: { name: \"Testing product\", productType: \"SERVICE\" }}"

​
coupon
object

Coupon details of the order.

Example:

"{ code: \"FEST10\", _id: \"63455e48901b43d4ef364a20\" }"

​
trackingId
string

Tracking id of the order.

Example:

"63319ef9-de0a-4c84-aebd-3585fb4a0cdf"

​
fingerprint
string

Fingerprint id of the order.

Example:

"5d51db5a-42b0-4b04-ba88-2c046c982a3a"

​
meta
object

Meta details of the order.

Example:

"{ couponSessionExpired: true }"

​
markAsTest
boolean

Is test order.

Example:

"false"

​
traceId
string

Trace id of the order.

Example:

"d3b16a92-a8ed-4e6b-8467-844750f78ed5"

​
automaticTaxesCalculated
boolean

Automatic taxes applied for the Order

Example:

true

​
taxCalculationProvider
object

Provider name for automatic tax calculation

Example:

"taxjar"

​
createdBy
string

User ID who created the order.

Example:

"user123"

Last modified on March 4, 2026