Logistics API

Name: Logistics API 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.

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.

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 Logistics API API.

Retrieve shipping policy by ID

Update shipping policy by ID

Delete shipping policy by ID

Create shipping policy

List shipping policies

GET STARTED

Start building with Logistics API API

Explore with Jentic

View OpenAPI Document

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

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

Use Cases

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

★ E-Commerce Operations

Use the Logistics API to perform e commerce operations programmatically. The API provides 55 endpoints covering core functionality including retrieve shipping policy by id, update shipping policy by id, delete shipping policy by id.

Call GET /api/logistics/pvt/shipping-policies/{id} to retrieve shipping policy by id

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

Why though Jentic?

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

Credential isolation

Logistics 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., 'retrieve shipping policy by id') and Jentic returns the matching Logistics API operation with its input schema, so the agent can call the right endpoint without browsing docs.

Time to first call

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