Get order

GET 
/orders/:id

Get order

Request

Path Parameters

idstringrequired
Example: invalid

200

Returns order detail with order items

objectstringrequired

idstringrequired

datestringrequired

createdAtstringrequired

updatedAtstringrequired

amountnumber<float>required

currencystringrequired

paymentMethodstringrequired

statusstringrequired

customerobjectrequired

firstNamestringrequired

lastNamestringrequired

emailstringrequired

productobjectrequired

idstringrequired

namestringrequired

typestringrequired

datestringrequired

paymentDetailsobjectrequired

subtotalnumber<float>required

discountsnumber<float>required

donationnumber<float>required

totalnumber<float>required

viewcyFeenumber<float>required

stripeFeenumber<float>required

refundedAmountnumber<float>required

netAmountnumber<float>required

refundablebooleanrequired

orderItemsobject[]required

idstring

registrationIdnullable

namestring

patronobject

firstNamenullablerequired

lastNamenullablerequired

emailnullablerequired

pricenumber<float>

feenumber<float>

basePricenumber<float>

baseFeenumber<float>

discountAmountnullable

discountNamenullable

seatnullable

statusnullable

refundableboolean

refundableAmountnumber<float>

totalRefundableAmountnumber<float>required

alreadyRefundedAmountnumber<float>required

metaobjectrequired

requestIdstringrequired

Example: returns_order_detail_with_order_items

{
  "object": "order_detail",
  "id": "T572027702",
  "date": "2025-05-01T12:00:00Z",
  "createdAt": "2024-01-02T03:04:05+01:00",
  "updatedAt": "2024-01-02T03:04:05+01:00",
  "amount": 75,
  "currency": "usd",
  "paymentMethod": "stripe",
  "status": "completed",
  "customer": {
    "firstName": "Jane",
    "lastName": "Customer",
    "email": "jane-customer@example.com"
  },
  "product": {
    "id": "vocal-training",
    "name": "Vocal Training",
    "type": "Course",
    "date": "2025-06-18T18:00:00Z"
  },
  "paymentDetails": {
    "subtotal": 75,
    "discounts": 0,
    "donation": 0,
    "total": 75,
    "viewcyFee": 7.5,
    "stripeFee": 3.75,
    "refundedAmount": 0,
    "netAmount": 63.75
  },
  "refundable": false,
  "orderItems": [
    {
      "id": "e1a2b3c4-d5e6-7f80-9a1b-2c3d4e5f6a7b",
      "registrationId": null,
      "name": "General Admission",
      "patron": {
        "firstName": null,
        "lastName": null,
        "email": null
      },
      "price": 75,
      "fee": 0,
      "basePrice": 75,
      "baseFee": 0,
      "discountAmount": null,
      "discountName": null,
      "seat": null,
      "status": null,
      "refundable": false,
      "refundableAmount": 0
    }
  ],
  "totalRefundableAmount": 0,
  "alreadyRefundedAmount": 0,
  "meta": {
    "requestId": "00000000-0000-0000-0000-000000000000"
  }
}

401

Returns 401

objectstringrequired

statusintegerrequired

messagestringrequired

metaobjectrequired

requestIdstringrequired

Example: returns_401

{
  "object": "error",
  "status": 401,
  "message": "Authentication required",
  "meta": {
    "requestId": "00000000-0000-0000-0000-000000000000"
  }
}

404

Returns 404 for non-existent order

objectstringrequired

statusintegerrequired

messagestringrequired

metaobjectrequired

requestIdstringrequired

Example: returns_404_for_non-existent_order

{
  "object": "error",
  "status": 404,
  "message": "Resource not found",
  "meta": {
    "requestId": "00000000-0000-0000-0000-000000000000"
  }
}