Get Order by ID
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
Bearer authentication header of the form Bearer <token>, where <token> is your access token.
payments/ orders. readonlyOAuthPrivate IntegrationSub-Account TokenRequest
Headers
API Version
v3Path Parameters
ID of the order that needs to be returned
653f5e0cde5a1314e62a837cQuery Parameters
LocationId is the id of the sub-account.
3SwdhCu3svxI8AKsPJt6AltId is the unique identifier e.g: location id.
3SwdhCu3svxI8AKsPJt6Response
Successful response
The unique identifier for the order.
653f5e0cde5a1314e62a837cAltId is the unique identifier eg: location id.
3SwdhCu3svxI8AKsPJt6AltType is the type of identifier.
locationContact id corresponding to the order.
XPLSw2SVagl12LMDeTmQCurrency in which order was created.
USDOrder value.
100The status of the order (e.g., completed).
completedOrder is in live / test mode.
falseThe creation timestamp of the order.
2023-11-20T10:23:36.515ZThe last update timestamp of the order.
2024-01-23T09:57:04.846ZFulfillment status of the order.
unfulfilledContact details of the order.
{ 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"}Amount details of the order.
Source details of the order.
Item details of the order.
{ _id: 61dd33e88058b9f967ca79dc, authorizeAmount: 0, locationId: "SBAWb4yu7A4LSc0skQ6g", name: "Sample Product": price: {}, product: { name: "Testing product", productType: "SERVICE" }}Coupon details of the order.
{ code: "FEST10", _id: "63455e48901b43d4ef364a20" }Tracking id of the order.
63319ef9-de0a-4c84-aebd-3585fb4a0cdfFingerprint id of the order.
5d51db5a-42b0-4b04-ba88-2c046c982a3aMeta details of the order.
{ couponSessionExpired: true }Is test order.
falseTrace id of the order.
d3b16a92-a8ed-4e6b-8467-844750f78ed5Automatic taxes applied for the Order
trueProvider name for automatic tax calculation
taxjarUser ID who created the order.
user123