Sign in
Orders

Get order

Retrieve an order by id.

get/api/v1/orders/{id}

Path parameters

idstring required

The order id

Response

The order

idstring required
checkoutIntentIdstring required

ID of the checkout intent that was responsible for creating this order.

createdAtstring required

Timestamp the order was persisted to Rye.

updatedAtstring required

Timestamp the order was last updated at

referenceIdstring

The referenceId you supplied on the checkout intent, echoed back so you can reconcile this order against your own records. Absent when none was supplied.

Example response

{
  "checkoutIntentId": "ci_aaa8af5c5aae4c0e8ef0172c26c65c13",
  "buyer": {
    "postalCode": "10001",
    "country": "US",
    "province": "NY",
    "city": "New York",
    "address2": "Apt 1",
    "address1": "123 Main St",
    "phone": "1234567890",
    "email": "john.doe@example.com",
    "lastName": "Doe",
    "firstName": "John"
  },
  "createdAt": "2026-03-25T00:00:00Z",
  "updatedAt": "2026-03-27T00:00:00Z",
  "referenceId": "order-1234"
}

Changes