Skip to main content
GET
Get Order

Authorizations

Authorization
string
header
required

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

Path Parameters

id
number
required

The ID of the entity for this request.

Example:

5

Query Parameters

return
string

Comma-separated list of specific fields to return/append in the response. See isAdditionalData for more details.

Example:

"id,nameFirst,nameLast"

isAdditionalData
boolean

Set to true to merge requested fields with default response, or false/omit to return only requested fields plus ID.

Example:

true

Response

200 - application/json

Order

id
number
required

Unique identifier.

orderDate
required

Represents the date when a particular order was placed.

orderItem
object[]
required

Represents the specific product or service purchased in a transaction.

PaymentId
number | null
required

Unique identifier for a specific transaction associated with an order.

PersonId
number | null
required

Unique identifier for the individual who placed the order.

totalFee
number | null
required

Represents the overall charge for an order, including all items, taxes, and additional costs.