Skip to main content
GET
/
api
/
v1
/
orders
JavaScript
import CheckoutIntents from 'checkout-intents';

const client = new CheckoutIntents({
  apiKey: process.env['CHECKOUT_INTENTS_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const order of client.orders.list()) {
  console.log(order.id);
}
import os
from checkout_intents import CheckoutIntents

client = CheckoutIntents(
    api_key=os.environ.get("CHECKOUT_INTENTS_API_KEY"),  # This is the default and can be omitted
)
page = client.orders.list()
page = page.data[0]
print(page.id)
package com.rye.example;

import com.rye.client.CheckoutIntentsClient;
import com.rye.client.okhttp.CheckoutIntentsOkHttpClient;
import com.rye.models.orders.OrderListPage;
import com.rye.models.orders.OrderListParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        CheckoutIntentsClient client = CheckoutIntentsOkHttpClient.fromEnv();

        OrderListPage page = client.orders().list();
    }
}
curl https://staging.api.rye.com/api/v1/orders \
    -H "Authorization: Bearer $CHECKOUT_INTENTS_API_KEY"
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://staging.api.rye.com/api/v1/orders",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://staging.api.rye.com/api/v1/orders"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
require 'uri'
require 'net/http'

url = URI("https://staging.api.rye.com/api/v1/orders")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "data": [
    {
      "id": "<string>",
      "checkoutIntentId": "ci_aaa8af5c5aae4c0e8ef0172c26c65c13",
      "createdAt": "2026-03-25T00:00:00Z",
      "updatedAt": "2026-03-27T00:00:00Z",
      "cancellation": {
        "reason": {
          "message": "<string>"
        },
        "marketplaceOrderId": "<string>",
        "checkoutIntentId": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "id": "<string>",
        "state": "requested"
      },
      "referenceId": "order-1234"
    }
  ],
  "pageInfo": {
    "hasPreviousPage": true,
    "hasNextPage": true,
    "endCursor": "<string>",
    "startCursor": "<string>"
  }
}
{
  "name": "<string>",
  "message": "<string>",
  "stack": "<string>"
}
{
  "name": "<string>",
  "message": "<string>",
  "status": 123,
  "fields": {},
  "stack": "<string>"
}

Authorizations

Authorization
string
header
required

Rye API key

Query Parameters

limit
integer<int32>

Maximum number of results to return (default 100)

Required range: 1 <= x <= 100
after
string
before
string

Response

Paginated list of orders

data
object[]
required
pageInfo
object
required