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.

Request

Version stringrequired

API Version

Available optionsv3

orderId stringrequired

ID of the order that needs to be returned

locationId string

LocationId is the id of the sub-account.

altId stringrequired

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

application/json

Successful response

application/json

Schema

Schema

_idstringrequired

The unique identifier for the order.

altIdstringrequired

AltId is the unique identifier eg: location id.

altTypestringrequired

AltType is the type of identifier.

contactIdstring

Contact id corresponding to the order.

currencystring

Currency in which order was created.

amountnumber

Order value.

statusstringrequired

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

liveModeboolean

Order is in live / test mode.

createdAtstring<date-time>required

The creation timestamp of the order.

updatedAtstring<date-time>required

The last update timestamp of the order.

fulfillmentStatusstring

Fulfillment status of the order.

contactSnapshotobject

Contact details of the order.

amountSummaryobject

Amount details of the order.

sourceobject

Source details of the order.

itemsstring[]

Item details of the order.

couponobject

Coupon details of the order.

trackingIdstring

Tracking id of the order.

fingerprintstring

Fingerprint id of the order.

metaobject

Meta details of the order.

markAsTestboolean

Is test order.

traceIdstring

Trace id of the order.

automaticTaxesCalculatedboolean

Automatic taxes applied for the Order

taxCalculationProviderobject

Provider name for automatic tax calculation

createdBystring

User ID who created the order.

Example (auto)

{
  "_id": "653f5e0cde5a1314e62a837c",
  "altId": "3SwdhCu3svxI8AKsPJt6",
  "altType": "location",
  "contactId": "XPLSw2SVagl12LMDeTmQ",
  "currency": "USD",
  "amount": "100",
  "status": "completed",
  "liveMode": "false",
  "createdAt": "2023-11-20T10:23:36.515Z",
  "updatedAt": "2024-01-23T09:57:04.846Z",
  "fulfillmentStatus": "unfulfilled",
  "contactSnapshot": "{ 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\"}",
  "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"
}