canonical: https://jentic.com/apis/vtex.local/checkout-api

# Vtex Checkout API

>ℹ️ Check the new [Checkout onboarding guide](https://developers.vtex.com/vtex-rest-api/docs/checkout-overview). We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about the Checkout and is organized by focusing on the developer's journey. The Checkout API allows you to obtain and configure information about the. The API exposes 33 endpoints secured with apiKey authentication.

## For AI agents

Programmatically cart simulation, get current or create a new cart. Covers 33 operations with apiKey authentication.

## Scope

Does not handle communications, crm, or developer tools - use for payments only.

## Capabilities

- Cart simulation
- Get current or create a new cart
- Remove all items from shopping cart
- Update cart items
- Add cart items

## Use cases

### Payments Operations

Use the Checkout API to perform payments operations programmatically. The API provides 33 endpoints covering core functionality including cart simulation, get current or create a new cart, get cart information by id.

Example prompt: Call POST `/api/checkout/pub/orderForms/simulation` to cart simulation

### Automated Shopping cart Management

Automate shopping cart operations by combining multiple Checkout API endpoints. Agents can get current or create a new cart and then get cart information by id in a single workflow.

Example prompt: Call GET `/api/checkout/pub/orderForm` to get current or create a new cart, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Checkout API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle apiKey tokens manually.

Example prompt: Search Jentic for 'cart simulation', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/api/checkout/pub/orderForms/simulation` | Cart simulation |
| GET | `/api/checkout/pub/orderForm` | Get current or create a new cart |
| GET | `/api/checkout/pub/orderForm/{orderFormId}` | Get cart information by ID |
| POST | `/api/checkout/pub/orderForm/{orderFormId}/items/removeAll` | Remove all items from shopping cart |
| GET | `/checkout/changeToAnonymousUser/{orderFormId}` | Remove all personal data from shopping cart |
| POST | `/api/checkout/pub/orderForm/{orderFormId}/items/update` | Update cart items |
| POST | `/api/checkout/pub/orderForm/{orderFormId}/items` | Add cart items |
| PATCH | `/api/checkout/pub/orderForm/{orderFormId}/items` | Handle cart items |

## Key resources

- **Shopping cart** — Operations related to Shopping cart
- **Cart attachments** — Operations related to Cart attachments
- **Custom data** — Operations related to Custom data
- **Configuration** — Operations related to Configuration
- **Fulfillment** — Operations related to Fulfillment

## Why Jentic

- **Setup:** Wiring the VTEX Checkout API by hand means setting both the X-VTEX-API-AppKey and X-VTEX-API-AppToken headers, resolving the account and environment host template, and managing the order form calls yourself. Through Jentic you install once, import the Checkout API from the API Directory, store the key pair once, and your agent calls it.
- **Permission scoping:** The Checkout API puts the order form id in the URL path (`/api/checkout/pub/orderForm/{orderFormId}`), so a rule can pin your agent to reading one order form and simulating a cart. You choose the operations it may call, so ones like removing all items are not included unless you add them.
- **Credential handling:** Your VTEX AppKey and AppToken are stored once, encrypted, by your own Jentic One instance and injected at execution time. They never enter the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'simulate a cart' or 'read an order form', and Jentic returns the matching Checkout API operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Stripe** — Alternative payments API
- **Adyen** — Alternative payments API
- **Square** — Complementary payments API
- **Paypal** — Complementary payments API

## FAQ

### What authentication does the Checkout API use?

The Checkout API uses an API key passed in the `X-VTEX-API-AppKey` header. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I cart simulation with the Checkout API?

Yes. Use the POST `/api/checkout/pub/orderForms/simulation` endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Checkout API?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I cart simulation through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'cart simulation'. Jentic returns the matching Checkout API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the Checkout API have?

The Checkout API exposes 33 endpoints covering shopping cart, cart attachments, custom data operations.

### Can I limit what my agent is allowed to do with the Checkout API?

Yes. Because you run Jentic One yourself, your own rules decide which Checkout API operations and credentials the agent may use. Since the order form id sits in the URL path, such as `/api/checkout/pub/orderForm/{orderFormId}`, you can pin the agent to reading a single order form and running a cart simulation. Operations you do not grant, like removing all items from the cart, stay unavailable to the agent unless you explicitly add them.