Checkout API

Name: Checkout API API
Brand: Checkout API
Availability: InStock

★ Only Publicly Available OpenAPI DocumentPaymentsPayment ProcessingapiKey33 EndpointsREST

For Agents

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

Use for: I need to cart simulation, I want to current or create a new cart, Search for cart information by id, Find all remove all items from shopping cart

Connect the Checkout API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Checkout API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Install Jentic One Beta (Self-Hosted)

Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with Checkout API API.

Cart simulation

Get current or create a new cart

Remove all items from shopping cart

Update cart items

Add cart items

GET STARTED

Start building with Checkout API API

Explore with Jentic

View OpenAPI Document

Jentic publishes the only available OpenAPI document for Checkout API, keeping it validated and agent-ready.

>ℹ️ 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.

Use Cases

Patterns agents use Checkout API API for, with concrete tasks.

★ 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.

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.

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.

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

Key Endpoints

33 endpoints — >ℹ️ check the new [checkout onboarding guide](https://developers.

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

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

Why though Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

Checkout API apiKey credentials are stored encrypted in the Jentic vault (MAXsystem). Agents receive scoped access tokens — raw secrets never enter the agent context.

Intent-based discovery

Agents search by intent (e.g., 'cart simulation') and Jentic returns the matching Checkout API operation with its input schema, so the agent can call the right endpoint without browsing docs.

Time to first call

Direct Checkout API integration: 1-3 days for auth handling, response parsing, and error cases. Through Jentic: under 1 hour — search, load schema, execute.

Related APIs

Alternatives and complements available in the Jentic catalogue.

Alternative

Stripe

Alternative payments API

Choose Stripe when you need a different approach to payments operations

Alternative

Adyen

Alternative payments API

Choose Adyen when you need a different approach to payments operations

Complementary

Square

Complementary payments API

Choose Square when you need a complementary approach to payments operations

Complementary

Paypal

Complementary payments API

Choose Paypal when you need a complementary approach to payments operations

FAQs

Specific to using Checkout API API through Jentic.

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 the MAXsystem vault 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 at https://app.jentic.com/sign-up, 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.