Skip to main content
GET
JavaScript

Authorizations

Authorization
string
header
required

Rye API key

Path Parameters

id
string
required

The order id

Response

The order

Represents a completed order. Orders are created after a checkout intent reaches the completed state.

id
string
required
checkoutIntentId
string
required

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

Example:

"ci_aaa8af5c5aae4c0e8ef0172c26c65c13"

createdAt
string
required

Timestamp the order was persisted to Rye.

Example:

"2026-03-25T00:00:00Z"

updatedAt
string
required

Timestamp the order was last updated at

Example:

"2026-03-27T00:00:00Z"

cancellation
object
required

The cancellation for this order, or null if none has been requested. Populated by joining the separate cancellations collection on the order's marketplace order id.

referenceId
string

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:

"order-1234"