Vtex APIs

26 APIs592 Endpoints8 Categories

API Catalog(5 of 26)

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.

33 endpoints

Customer Credit API

With Customer Credit your store can enable **credit payments** through the checkout. You can also control **invoices** and the **credit limits** of your clients. Learn more about Customer Credit in our [Help Center article](https://help.vtex.com/en/tracks/customer-credit-getting-started--1hCRg21lXYy2seOKgqQ2CC/36grlQ69NK6OCuioeekyCs). Additionally, you can find more information on installment paym. The API exposes 25 endpoints secured with apiKey authentication.

25 endpoints

Giftcard API

>ℹ️ Check the new [Payments onboarding guide](https://developers.vtex.com/docs/guides/payments-overview). We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Payments and is organized by focusing on the developer's journey. The gift card is a payment method configured as a cash value associated with a clien. The API exposes 11 endpoints secured with apiKey authentication.

11 endpoints

Giftcard Hub API

>ℹ️ Check the new [Payments onboarding guide](https://developers.vtex.com/vtex-rest-api/docs/payments-overview). We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Payments and is organized by focusing on the developer's journey. The Gift Card Hub API allows interactions with all Gift card providers regist. The API exposes 15 endpoints secured with apiKey authentication.

15 endpoints

Message Center API

Message Center corresponds to [order transactional email templates](https://help.vtex.com/en/tutorial/order-transactional-email-templates--3g2S2kqBOoSGcCaqMYK2my). The store can configure templates to automatically send emails to customers and notify them about their order events, such as payment confirmation and shipping. Message Center API Index DKIM configuration - `POST` [Generate DKIM keys](h. The API exposes 1 endpoints secured with apiKey authentication.

1 endpoints

Connect Your Agent

Step 1: Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fvtex.local" | sh

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fvtex.local" | 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.