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 shipment of client.checkoutIntents.shipments.list('id')) {
console.log(shipment);
}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.checkout_intents.shipments.list(
id="id",
)
page = page.data[0]
print(page)package com.rye.example;
import com.rye.client.CheckoutIntentsClient;
import com.rye.client.okhttp.CheckoutIntentsOkHttpClient;
import com.rye.models.checkoutintents.shipments.ShipmentListPage;
import com.rye.models.checkoutintents.shipments.ShipmentListParams;
public final class Main {
private Main() {}
public static void main(String[] args) {
CheckoutIntentsClient client = CheckoutIntentsOkHttpClient.fromEnv();
ShipmentListPage page = client.checkoutIntents().shipments().list("id");
}
}curl https://staging.api.rye.com/api/v1/checkout-intents/$ID/shipments \
-H "Authorization: Bearer $CHECKOUT_INTENTS_API_KEY"<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://staging.api.rye.com/api/v1/checkout-intents/{id}/shipments",
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/checkout-intents/{id}/shipments"
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/checkout-intents/{id}/shipments")
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{
"pageInfo": {
"hasPreviousPage": true,
"hasNextPage": true,
"endCursor": "<string>",
"startCursor": "<string>"
},
"data": [
{
"updatedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"marketplaceOrderId": "<string>",
"checkoutIntentId": "<string>",
"id": "<string>",
"trackingEvents": [
{
"status": "out_for_delivery",
"location": {
"country": "<string>",
"province": "<string>",
"city": "<string>"
},
"timestamp": {
"local": "<string>",
"utc": "2023-11-07T05:31:56Z"
},
"description": "<string>"
}
],
"shippedAt": "2023-11-07T05:31:56Z",
"tracking": {
"number": "<string>",
"carrierName": "<string>",
"deliveryDate": {
"estimated": "2023-11-07T05:31:56Z"
},
"url": "<string>"
},
"externalId": "<string>",
"status": "shipped"
}
]
}{
"name": "<string>",
"message": "<string>",
"stack": "<string>"
}{
"name": "<string>",
"message": "<string>",
"stack": "<string>"
}{
"name": "<string>",
"message": "<string>",
"status": 123,
"fields": {},
"stack": "<string>"
}Checkout Intents
List shipments for checkout intent
List shipments for a checkout intent
GET
/
api
/
v1
/
checkout-intents
/
{id}
/
shipments
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 shipment of client.checkoutIntents.shipments.list('id')) {
console.log(shipment);
}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.checkout_intents.shipments.list(
id="id",
)
page = page.data[0]
print(page)package com.rye.example;
import com.rye.client.CheckoutIntentsClient;
import com.rye.client.okhttp.CheckoutIntentsOkHttpClient;
import com.rye.models.checkoutintents.shipments.ShipmentListPage;
import com.rye.models.checkoutintents.shipments.ShipmentListParams;
public final class Main {
private Main() {}
public static void main(String[] args) {
CheckoutIntentsClient client = CheckoutIntentsOkHttpClient.fromEnv();
ShipmentListPage page = client.checkoutIntents().shipments().list("id");
}
}curl https://staging.api.rye.com/api/v1/checkout-intents/$ID/shipments \
-H "Authorization: Bearer $CHECKOUT_INTENTS_API_KEY"<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://staging.api.rye.com/api/v1/checkout-intents/{id}/shipments",
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/checkout-intents/{id}/shipments"
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/checkout-intents/{id}/shipments")
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{
"pageInfo": {
"hasPreviousPage": true,
"hasNextPage": true,
"endCursor": "<string>",
"startCursor": "<string>"
},
"data": [
{
"updatedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"marketplaceOrderId": "<string>",
"checkoutIntentId": "<string>",
"id": "<string>",
"trackingEvents": [
{
"status": "out_for_delivery",
"location": {
"country": "<string>",
"province": "<string>",
"city": "<string>"
},
"timestamp": {
"local": "<string>",
"utc": "2023-11-07T05:31:56Z"
},
"description": "<string>"
}
],
"shippedAt": "2023-11-07T05:31:56Z",
"tracking": {
"number": "<string>",
"carrierName": "<string>",
"deliveryDate": {
"estimated": "2023-11-07T05:31:56Z"
},
"url": "<string>"
},
"externalId": "<string>",
"status": "shipped"
}
]
}{
"name": "<string>",
"message": "<string>",
"stack": "<string>"
}{
"name": "<string>",
"message": "<string>",
"stack": "<string>"
}{
"name": "<string>",
"message": "<string>",
"status": 123,
"fields": {},
"stack": "<string>"
}Authorizations
Rye API key
Path Parameters
The id of the checkout intent
Query Parameters
Maximum number of results to return (default 100)
Required range:
1 <= x <= 100Response
Shipments list response
Show child attributes
Show child attributes
data
(Shipped · object | Delivered · object | Delayed · object | Out for Delivery · object | Ordered · object | Canceled · object)[]
required
Shipments that have tracking information (shipped, delayed, or delivered states)
- Shipped
- Delivered
- Delayed
- Out for Delivery
- Ordered
- Canceled
Show child attributes
Show child attributes
Was this page helpful?