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": {
    "hasPreviousPage": true,
    "hasNextPage": true,
    "endCursor": "<string>",
    "startCursor": "<string>"
  },
  "data": [
    {
      "buyer": {
        "postalCode": "10001",
        "country": "United States",
        "province": "NY",
        "city": "New York",
        "address1": "123 Main St",
        "phone": "+1234567890",
        "email": "[email protected]",
        "lastName": "Doe",
        "firstName": "John",
        "address2": "Apt 1"
      },
      "quantity": 123,
      "productUrl": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "state": "retrieving_offer",
      "variantSelections": [
        {
          "value": "Small, Red, XS, L, etc.",
          "label": "Size, Color, etc."
        }
      ]
    }
  ]
}

Authorizations

Authorization
string
header
required

Rye API key

Query Parameters

limit
number<double>
after
string
before
string
id
string[]
state
enum<string>[]
Available options:
retrieving_offer,
awaiting_confirmation,
placing_order,
completed,
failed

Response

Paginated checkout intents response

pageInfo
object
required
data
object[]
required