Orders API

Name: Orders API API
Brand: Orders API
Availability: InStock

★ Only Publicly Available OpenAPI DocumentE CommerceStorefrontapiKey35 EndpointsREST

For Agents

Programmatically get order, get orders by order group id. Covers 35 operations with apiKey authentication.

Use for: I need to order, I want to orders by order group id, Search for orders, Find all start handling order

Connect the Orders API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Orders 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 Orders API API.

Get order

List orders

Start handling order

Cancel order

GET STARTED

Start building with Orders API API

Explore with Jentic

View OpenAPI Document

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

Each purchase a customer makes in your store generates an [order](https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials_196) on VTEX. With the Orders API, you can view orders statuses and manage multiple aspects involved in order fulfillment, such as financial transactions, invoicing, shipping, and subscriptions. You can also [modify orders](https://developers.vtex.com/docs/api-refere. The API exposes 35 endpoints secured with apiKey authentication.

Use Cases

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

★ E-Commerce Operations

Use the Orders API to perform e commerce operations programmatically. The API provides 35 endpoints covering core functionality including get order, get orders by order group id, list orders.

Call GET /api/oms/pvt/orders/{orderId} to get order

Automated Orders Management

Automate orders operations by combining multiple Orders API endpoints. Agents can get orders by order group id and then list orders in a single workflow.

Call GET /api/oms/pvt/orders/order-group/{orderGroup} to get orders by order group id, then verify the result

AI Agent Integration via Jentic

AI agents discover and call Orders 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 'get order', load the operation schema, and execute with Jentic-managed credentials

Key Endpoints

35 endpoints — each purchase a customer makes in your store generates an [order](https://help.

METHOD

PATH

DESCRIPTION

GET

/api/oms/pvt/orders/{orderId}

Get order

GET

/api/oms/pvt/orders/order-group/{orderGroup}

Get orders by order group ID

GET

/api/oms/pvt/orders

List orders

POST

/api/oms/pvt/orders/{orderId}/start-handling

Start handling order

POST

/api/oms/pvt/orders/{orderId}/cancel

Cancel order

POST

/api/oms/pvt/orders/{orderId}/changes

POST

/api/oms/pvt/orders/{orderId}/interactions

Add log in orders

POST

/api/oms/pvt/orders/{orderId}/invoice

Order invoice notification

GET

/api/oms/pvt/orders/{orderId}

Get order

GET

/api/oms/pvt/orders/order-group/{orderGroup}

Get orders by order group ID

GET

/api/oms/pvt/orders

List orders

POST

/api/oms/pvt/orders/{orderId}/start-handling

Start handling order

POST

/api/oms/pvt/orders/{orderId}/cancel

Cancel order

Why though Jentic?

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

Credential isolation

Orders 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., 'get order') and Jentic returns the matching Orders API operation with its input schema, so the agent can call the right endpoint without browsing docs.

Time to first call

Direct Orders 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

Shopify

Alternative e commerce API

Choose Shopify when you need a different approach to e commerce operations

Alternative

Stripe

Alternative e commerce API

Choose Stripe when you need a different approach to e commerce operations

FAQs

Specific to using Orders API API through Jentic.

What authentication does the Orders API use?

The Orders 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 get order with the Orders API?

Yes. Use the GET /api/oms/pvt/orders/{orderId} endpoint. The API returns structured JSON responses that agents can parse and act on directly.

What are the rate limits for the Orders 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 get order through Jentic?

Install the Jentic SDK with pip install jentic, authenticate at https://app.jentic.com/sign-up, then search for 'get order'. Jentic returns the matching Orders API operation with its input schema. Load the schema and execute the call — credentials are injected automatically.

How many endpoints does the Orders API have?

The Orders API exposes 35 endpoints covering orders, order modifications, invoice operations.