Logistics API

vtex · Company

Company No Auth Free & Open API

>Check the [Fulfillment onboarding guide](https://developers.vtex.com/docs/guides/fulfillment). We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about fulfillment and is organized by focusing on the developer's journey. Logistics or fulfillment is the module responsible for shipping calculation and inventory management. The variable `{{environment}}` can be filled with `vtexcommercestable` or `vte

Authentication

No authentication requiredFree to use with no key needed.

Sample Requests

GET List shipping policies

This endpoint lists existing shipping policies from carriers in your store. > Note that, while most of our API endpoints return time fields in UTC, this endpoint returns **Scheduled Delivery** related time fields adjusted to the configured time zone of the account.

https://api.apis.guru/v2/specs/vtex.local/Logistics-API/1.0/api/logistics/pvt/shipping-policies?page=page&perPage=perPage

Hover any highlighted part to learn what it does

Headers — extra info sent with the request

Accept	application/json
Content-Type	application/json

curl -X GET "https://api.apis.guru/v2/specs/vtex.local/Logistics-API/1.0/api/logistics/pvt/shipping-policies?page=page&perPage=perPage" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json"

import requests
params = {
    "page": "page",
    "perPage": "perPage"
}
headers = {
    "Accept": "application/json",
    "Content-Type": "application/json"
}
response = requests.get(
    "https://api.apis.guru/v2/specs/vtex.local/Logistics-API/1.0/api/logistics/pvt/shipping-policies",
    params=params,
    headers=headers,
)
print(response.json())

const url = new URL('https://api.apis.guru/v2/specs/vtex.local/Logistics-API/1.0/api/logistics/pvt/shipping-policies');
url.searchParams.set('page', 'page');
url.searchParams.set('perPage', 'perPage');

const response = await fetch(url, {
  headers: {
    'Accept': 'application/json',
    'Content-Type': 'application/json'
  },
}); 
const data = await response.json();
console.log(data);

package main

import (
	"fmt"
	"io"
	"net/http"
	"net/url"
)

func main() {
	baseURL, _ := url.Parse("https://api.apis.guru/v2/specs/vtex.local/Logistics-API/1.0/api/logistics/pvt/shipping-policies")
	q := baseURL.Query()
	q.Set("page", "page")
	q.Set("perPage", "perPage")
	baseURL.RawQuery = q.Encode()
	targetURL := baseURL.String()
	req, _ := http.NewRequest("GET", targetURL, nil)
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "application/json")

	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

require "net/http"
require "json"

uri = URI("https://api.apis.guru/v2/specs/vtex.local/Logistics-API/1.0/api/logistics/pvt/shipping-policies")
uri.query = URI.encode_www_form({
  "page" => "page",
  "perPage" => "perPage"
})

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

req = Net::HTTP::Get.new(uri)
req["Accept"] = "application/json"
req["Content-Type"] = "application/json"

res = http.request(req)
puts JSON.parse(res.body)

<?php
$url = "https://api.apis.guru/v2/specs/vtex.local/Logistics-API/1.0/api/logistics/pvt/shipping-policies?" . http_build_query([
    "page" => "page",
    "perPage" => "perPage"
]);
$opts = ["http" => [
    "method" => "GET",
    "header" => implode("\r\n", [
        "Accept: application/json",
        "Content-Type: application/json"
    ]),
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));

GET List paged polygons

Lists stored polygons.

https://api.apis.guru/v2/specs/vtex.local/Logistics-API/1.0/api/logistics/pvt/configuration/geoshape?page={{page}}&perPage={{perPage}}

Hover any highlighted part to learn what it does

Headers — extra info sent with the request

Accept	application/json
Content-Type	application/json; charset=utf-8

curl -X GET "https://api.apis.guru/v2/specs/vtex.local/Logistics-API/1.0/api/logistics/pvt/configuration/geoshape?page=%7B%7Bpage%7D%7D&perPage=%7B%7BperPage%7D%7D" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json; charset=utf-8"

import requests
params = {
    "page": "{{page}}",
    "perPage": "{{perPage}}"
}
headers = {
    "Accept": "application/json",
    "Content-Type": "application/json; charset=utf-8"
}
response = requests.get(
    "https://api.apis.guru/v2/specs/vtex.local/Logistics-API/1.0/api/logistics/pvt/configuration/geoshape",
    params=params,
    headers=headers,
)
print(response.json())

const url = new URL('https://api.apis.guru/v2/specs/vtex.local/Logistics-API/1.0/api/logistics/pvt/configuration/geoshape');
url.searchParams.set('page', '{{page}}');
url.searchParams.set('perPage', '{{perPage}}');

const response = await fetch(url, {
  headers: {
    'Accept': 'application/json',
    'Content-Type': 'application/json; charset=utf-8'
  },
}); 
const data = await response.json();
console.log(data);

package main

import (
	"fmt"
	"io"
	"net/http"
	"net/url"
)

func main() {
	baseURL, _ := url.Parse("https://api.apis.guru/v2/specs/vtex.local/Logistics-API/1.0/api/logistics/pvt/configuration/geoshape")
	q := baseURL.Query()
	q.Set("page", "{{page}}")
	q.Set("perPage", "{{perPage}}")
	baseURL.RawQuery = q.Encode()
	targetURL := baseURL.String()
	req, _ := http.NewRequest("GET", targetURL, nil)
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "application/json; charset=utf-8")

	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

require "net/http"
require "json"

uri = URI("https://api.apis.guru/v2/specs/vtex.local/Logistics-API/1.0/api/logistics/pvt/configuration/geoshape")
uri.query = URI.encode_www_form({
  "page" => "{{page}}",
  "perPage" => "{{perPage}}"
})

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

req = Net::HTTP::Get.new(uri)
req["Accept"] = "application/json"
req["Content-Type"] = "application/json; charset=utf-8"

res = http.request(req)
puts JSON.parse(res.body)

<?php
$url = "https://api.apis.guru/v2/specs/vtex.local/Logistics-API/1.0/api/logistics/pvt/configuration/geoshape?" . http_build_query([
    "page" => "{{page}}",
    "perPage" => "{{perPage}}"
]);
$opts = ["http" => [
    "method" => "GET",
    "header" => implode("\r\n", [
        "Accept: application/json",
        "Content-Type: application/json; charset=utf-8"
    ]),
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));

GET List paged Pickup Points

Lists paged pickup points in your store.

https://api.apis.guru/v2/specs/vtex.local/Logistics-API/1.0/api/logistics/pvt/configuration/pickuppoints/_search?page={{pageNumber}}&keyword=&pageSize={{pageSize}}

Hover any highlighted part to learn what it does

Headers — extra info sent with the request

Accept	application/json
Content-Type	application/json; charset=utf-8

curl -X GET "https://api.apis.guru/v2/specs/vtex.local/Logistics-API/1.0/api/logistics/pvt/configuration/pickuppoints/_search?page=%7B%7BpageNumber%7D%7D&keyword=&pageSize=%7B%7BpageSize%7D%7D" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json; charset=utf-8"

import requests
params = {
    "page": "{{pageNumber}}",
    "keyword": "",
    "pageSize": "{{pageSize}}"
}
headers = {
    "Accept": "application/json",
    "Content-Type": "application/json; charset=utf-8"
}
response = requests.get(
    "https://api.apis.guru/v2/specs/vtex.local/Logistics-API/1.0/api/logistics/pvt/configuration/pickuppoints/_search",
    params=params,
    headers=headers,
)
print(response.json())

const url = new URL('https://api.apis.guru/v2/specs/vtex.local/Logistics-API/1.0/api/logistics/pvt/configuration/pickuppoints/_search');
url.searchParams.set('page', '{{pageNumber}}');
url.searchParams.set('keyword', '');
url.searchParams.set('pageSize', '{{pageSize}}');

const response = await fetch(url, {
  headers: {
    'Accept': 'application/json',
    'Content-Type': 'application/json; charset=utf-8'
  },
}); 
const data = await response.json();
console.log(data);

package main

import (
	"fmt"
	"io"
	"net/http"
	"net/url"
)

func main() {
	baseURL, _ := url.Parse("https://api.apis.guru/v2/specs/vtex.local/Logistics-API/1.0/api/logistics/pvt/configuration/pickuppoints/_search")
	q := baseURL.Query()
	q.Set("page", "{{pageNumber}}")
	q.Set("keyword", "")
	q.Set("pageSize", "{{pageSize}}")
	baseURL.RawQuery = q.Encode()
	targetURL := baseURL.String()
	req, _ := http.NewRequest("GET", targetURL, nil)
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "application/json; charset=utf-8")

	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

require "net/http"
require "json"

uri = URI("https://api.apis.guru/v2/specs/vtex.local/Logistics-API/1.0/api/logistics/pvt/configuration/pickuppoints/_search")
uri.query = URI.encode_www_form({
  "page" => "{{pageNumber}}",
  "keyword" => "",
  "pageSize" => "{{pageSize}}"
})

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

req = Net::HTTP::Get.new(uri)
req["Accept"] = "application/json"
req["Content-Type"] = "application/json; charset=utf-8"

res = http.request(req)
puts JSON.parse(res.body)

<?php
$url = "https://api.apis.guru/v2/specs/vtex.local/Logistics-API/1.0/api/logistics/pvt/configuration/pickuppoints/_search?" . http_build_query([
    "page" => "{{pageNumber}}",
    "keyword" => "",
    "pageSize" => "{{pageSize}}"
]);
$opts = ["http" => [
    "method" => "GET",
    "header" => implode("\r\n", [
        "Accept: application/json",
        "Content-Type: application/json; charset=utf-8"
    ]),
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));

Postman Setup Guide

Get Postman ↗

See official documentation for authentication and setup.

What can you build with Logistics API?

Logistics API is a Company API. Developers commonly use company APIs for:

enriching CRM records with company firmographics
building lead-generation and prospecting tools
verifying business identity and registration details
monitoring competitors and market intelligence
powering B2B data enrichment pipelines

No authentication required. This API is open — no signup or key needed. Ideal for quick prototypes and public-facing features. Logistics API is free to use, making it a low-risk choice to experiment with.

New to APIs? Read our beginner's guide · Learn about API keys · What is REST?

Open documentation ↗