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

const client = new CheckoutIntents({
  apiKey: 'My API Key',
});

// Automatically fetches more pages as needed.
for await (const checkoutIntent of client.checkoutIntents.list()) {
  console.log(checkoutIntent);
}
{
  "pageInfo": {
    "endCursor": "<string>",
    "startCursor": "<string>",
    "hasPreviousPage": true,
    "hasNextPage": true
  },
  "data": [
    {
      "variantSelections": [
        {
          "value": "Small, Red, XS, L, etc.",
          "label": "Size, Color, etc."
        }
      ],
      "buyer": {
        "postalCode": "10001",
        "country": "United States",
        "province": "NY",
        "city": "New York",
        "address2": "Apt 1",
        "address1": "123 Main St",
        "phone": "+1234567890",
        "email": "john.doe@example.com",
        "lastName": "Doe",
        "firstName": "John"
      },
      "quantity": 123,
      "productUrl": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "state": "retrieving_offer"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Rye API key

Query Parameters

​
limit
number
​
after
string
​
before
string
​
id
string[]
​
state
enum<string>[]

Response

Paginated checkout intents response

​
pageInfo
object
required
​
data
object[]
required
  • Option 1
  • Option 2
  • Option 3
  • Option 4
  • Option 5