Skip to main content
OrdersVersion: v3

Get Order by ID

GET/payments/orders/{orderId}

The "Get Order by ID" API allows to retrieve information for a specific order using its unique identifier. Use this endpoint to fetch details for a single order based on the provided order ID.

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your access token.

Scope:payments/orders.readonly
Auth methods:OAuthPrivate Integration
Token type:Sub-Account Token

Request​

Headers

Versionstringrequired

API Version

Available optionsv3

Path Parameters

orderIdstringrequired

ID of the order that needs to be returned

Example:653f5e0cde5a1314e62a837c

Query Parameters

locationIdstring

LocationId is the id of the sub-account.

Example:3SwdhCu3svxI8AKsPJt6
altIdstringrequired

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

Example:3SwdhCu3svxI8AKsPJt6

Response

Successful response

_idstringrequired

The unique identifier for the order.

Example:653f5e0cde5a1314e62a837c
altIdstringrequired

AltId is the unique identifier eg: location id.

Example:3SwdhCu3svxI8AKsPJt6
altTypestringrequired

AltType is the type of identifier.

Example:location
contactIdstring

Contact id corresponding to the order.

Example:XPLSw2SVagl12LMDeTmQ
currencystring

Currency in which order was created.

Example:USD
amountnumber

Order value.

Example:100
statusstringrequired

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

Example:completed
liveModeboolean

Order is in live / test mode.

Example:false
createdAtstring<date-time>required

The creation timestamp of the order.

Example:2023-11-20T10:23:36.515Z
updatedAtstring<date-time>required

The last update timestamp of the order.

Example:2024-01-23T09:57:04.846Z
fulfillmentStatusstring

Fulfillment status of the order.

Example:unfulfilled
contactSnapshotobject

Contact details of the order.

Example:{ last_name: "Mcclain", type: "lead", first_name_lower_case: "rogan", email: "[email protected]", last_name_lower_case: "mcclain", location_id: "o6241QsiRwUIJHyjuhos", company_name: "Jordan and Cox Trading"}
amountSummaryobject

Amount details of the order.

sourceobject

Source details of the order.

itemsstring[]

Item details of the order.

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

Coupon details of the order.

Example:{ code: "FEST10", _id: "63455e48901b43d4ef364a20" }
trackingIdstring

Tracking id of the order.

Example:63319ef9-de0a-4c84-aebd-3585fb4a0cdf
fingerprintstring

Fingerprint id of the order.

Example:5d51db5a-42b0-4b04-ba88-2c046c982a3a
metaobject

Meta details of the order.

Example:{ couponSessionExpired: true }
markAsTestboolean

Is test order.

Example:false
traceIdstring

Trace id of the order.

Example:d3b16a92-a8ed-4e6b-8467-844750f78ed5
automaticTaxesCalculatedboolean

Automatic taxes applied for the Order

Example:true
taxCalculationProviderobject

Provider name for automatic tax calculation

Example:taxjar
createdBystring

User ID who created the order.

Example:user123