Vtex Logistics API

Name: Logistics API
Brand: Logistics API
Availability: InStock

★ Only Publicly Available OpenAPI DocumentE CommerceInventoryapiKey55 EndpointsREST

For Agents

Programmatically retrieve shipping policy by id, update shipping policy by id. Covers 55 operations with apiKey authentication.

Use for: I need to shipping policy by id, I want to shipping policy by id, Search for shipping policy by id, Find all shipping policy

Not supported: Does not handle payments, communications, or crm - use for e-commerce only.

[Logistics or fulfillment](https://help.vtex.com/en/tutorial/logistics--53udnvI5eBy8DKo8FOjMoP) is the process of planning and executing the transportation, storage of merchandise, and shipping orders to customers. You can accomplish all of this with the VTEX platform, which allows you to manage your inventory, shipping rates, pickup points and more. Logistics API Index Shipping Policies - `GET` [. The API exposes 55 endpoints secured with apiKey authentication.

Install Jentic One Beta

Connect the Logistics API to your agent

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

Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.

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%2Flogistics-api" | 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%2Flogistics-api" | 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 Logistics API.

Retrieve shipping policy by ID

Update shipping policy by ID

Delete shipping policy by ID

Create shipping policy

List shipping policies

Use Cases

GET STARTED

Start building with Logistics API

Explore with Jentic One

View OpenAPI Document

Automated Scheduled delivery Management

Automate scheduled delivery operations by combining multiple Logistics API endpoints. Agents can update shipping policy by id and then delete shipping policy by id in a single workflow.

Call PUT /api/logistics/pvt/shipping-policies/{id} to update shipping policy by id, then verify the result

AI Agent Integration via Jentic

AI agents discover and call Logistics 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 'retrieve shipping policy by id', load the operation schema, and execute with Jentic-managed credentials

Key Endpoints

55 endpoints — [logistics or fulfillment](https://help.

METHOD

PATH

DESCRIPTION

GET

/api/logistics/pvt/shipping-policies/{id}

Retrieve shipping policy by ID

PUT

/api/logistics/pvt/shipping-policies/{id}

Update shipping policy by ID

DELETE

/api/logistics/pvt/shipping-policies/{id}

Delete shipping policy by ID

POST

/api/logistics/pvt/shipping-policies

Create shipping policy

GET

/api/logistics/pvt/shipping-policies

List shipping policies

POST

/api/logistics/pvt/configuration/freights/{carrierId}/values/update

Create or update freight values

GET

/api/logistics/pvt/configuration/freights/{carrierId}/{cep}/values

List freight values

GET

/api/logistics/pvt/configuration/carriers/{carrierId}/getdayofweekblocked

Retrieve blocked delivery windows

GET

/api/logistics/pvt/shipping-policies/{id}

Retrieve shipping policy by ID

PUT

/api/logistics/pvt/shipping-policies/{id}

Update shipping policy by ID

DELETE

/api/logistics/pvt/shipping-policies/{id}

Delete shipping policy by ID

POST

/api/logistics/pvt/shipping-policies

Create shipping policy

GET

/api/logistics/pvt/shipping-policies

List shipping policies

POST

/api/logistics/pvt/configuration/freights/{carrierId}/values/update

Create or update freight values

GET

/api/logistics/pvt/configuration/freights/{carrierId}/{cep}/values

List freight values

Why Jentic?

What agents get from Jentic-routed access to this vendor.

Setup

Wiring the VTEX Logistics API by hand means pairing an App Key with an App Token in the X-VTEX-API-AppKey and X-VTEX-API-AppToken headers, and templating the {accountName} and {environment} host into every call. Through Jentic you install once, import the Logistics API from the API Directory, store the App Key and App Token once, and your agent calls it.

Permission scoping

The Logistics API puts the shipping policy id in the URL path (/api/logistics/pvt/shipping-policies/{id}), so a rule can pin your agent to one shipping policy. You choose the operations it may call, so destructive ones like deleting or overwriting a policy are not included unless you add them.

Credential isolation

Your VTEX App Key and App Token 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.

Intent-based discovery

Agents search Jentic by intent such as 'get a shipping policy by id' or 'update freight values for a carrier', and Jentic returns the matching Logistics API operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

FAQs

Specific to using Logistics API through Jentic.

What authentication does the Logistics API use?

The Logistics 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 retrieve shipping policy by id with the Logistics API?

Yes. Use the GET /api/logistics/pvt/shipping-policies/{id} endpoint. The API returns structured JSON responses that agents can parse and act on directly.

What are the rate limits for the Logistics 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 retrieve shipping policy by id through Jentic?

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

How many endpoints does the Logistics API have?

The Logistics API exposes 55 endpoints covering scheduled delivery, shipping policies, docks operations.

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

Yes. Because you run Jentic One yourself, your own rules decide which Logistics API operations the agent may call and which credentials it may use. You can grant read-only access to GET /api/logistics/pvt/shipping-policies/{id} while excluding destructive operations like deleting or overwriting a policy unless you explicitly add them. Since the shipping policy id sits in the URL path, a rule can also pin the agent to a single policy, and your VTEX App Key and App Token stay stored on your instance rather than in the agent's context.

Vtex Logistics API

Connect the Logistics API to your agent

Capabilities

Use Cases

Start building with Logistics API

Key Endpoints

Why Jentic?

Related APIs

FAQs