Checkout API

vtex · Company

Company No Auth Free & Open 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 shopping cart and its attachments, personalization of custom fields, orderForm structure, fulfil

Authentication

No authentication requiredFree to use with no key needed.

Sample Requests

GET Get current or create a new cart

You can use this request to get your current shopping cart information (`orderFormId`) or to create a new cart. **Important**: To create a new empty shopping cart you need to send this request with the query param `forceNewCart=true`. The [orderForm](https://developers.vtex.com/docs/guides/ord

https://api.apis.guru/v2/specs/vtex.local/Checkout-API/1.0/api/checkout/pub/orderForm?forceNewCart=true

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/Checkout-API/1.0/api/checkout/pub/orderForm?forceNewCart=true" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json"

import requests
params = {
    "forceNewCart": "true"
}
headers = {
    "Accept": "application/json",
    "Content-Type": "application/json"
}
response = requests.get(
    "https://api.apis.guru/v2/specs/vtex.local/Checkout-API/1.0/api/checkout/pub/orderForm",
    params=params,
    headers=headers,
)
print(response.json())

const url = new URL('https://api.apis.guru/v2/specs/vtex.local/Checkout-API/1.0/api/checkout/pub/orderForm');
url.searchParams.set('forceNewCart', 'true');

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/Checkout-API/1.0/api/checkout/pub/orderForm")
	q := baseURL.Query()
	q.Set("forceNewCart", "true")
	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/Checkout-API/1.0/api/checkout/pub/orderForm")
uri.query = URI.encode_www_form({
  "forceNewCart" => "true"
})

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/Checkout-API/1.0/api/checkout/pub/orderForm?" . http_build_query([
    "forceNewCart" => "true"
]);
$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 pickup points by location

Retrieves information on pickup points close to a given location determined by geocoordinates or postal code. The pickup points returned are not necessarily all active ones. Make sure to validate the information consumed by integrations.

https://api.apis.guru/v2/specs/vtex.local/Checkout-API/1.0/api/checkout/pub/pickup-points?postalCode=1234000&countryCode=BRA&geoCoordinates=-47.924747467041016,-15.832582473754883

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/Checkout-API/1.0/api/checkout/pub/pickup-points?postalCode=1234000&countryCode=BRA&geoCoordinates=-47.924747467041016%2C-15.832582473754883" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json"

import requests
params = {
    "postalCode": "1234000",
    "countryCode": "BRA",
    "geoCoordinates": "-47.924747467041016,-15.832582473754883"
}
headers = {
    "Accept": "application/json",
    "Content-Type": "application/json"
}
response = requests.get(
    "https://api.apis.guru/v2/specs/vtex.local/Checkout-API/1.0/api/checkout/pub/pickup-points",
    params=params,
    headers=headers,
)
print(response.json())

const url = new URL('https://api.apis.guru/v2/specs/vtex.local/Checkout-API/1.0/api/checkout/pub/pickup-points');
url.searchParams.set('postalCode', '1234000');
url.searchParams.set('countryCode', 'BRA');
url.searchParams.set('geoCoordinates', '-47.924747467041016,-15.832582473754883');

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/Checkout-API/1.0/api/checkout/pub/pickup-points")
	q := baseURL.Query()
	q.Set("postalCode", "1234000")
	q.Set("countryCode", "BRA")
	q.Set("geoCoordinates", "-47.924747467041016,-15.832582473754883")
	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/Checkout-API/1.0/api/checkout/pub/pickup-points")
uri.query = URI.encode_www_form({
  "postalCode" => "1234000",
  "countryCode" => "BRA",
  "geoCoordinates" => "-47.924747467041016,-15.832582473754883"
})

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/Checkout-API/1.0/api/checkout/pub/pickup-points?" . http_build_query([
    "postalCode" => "1234000",
    "countryCode" => "BRA",
    "geoCoordinates" => "-47.924747467041016,-15.832582473754883"
]);
$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 Get client profile by email

Retrieve a client's profile information by providing an email address. If the response body fields are empty, the following situations may have occurred: 1. There is no client registered with the email address provided in your store, or; 2. Client profile is invalid or incomplete. For more in

https://api.apis.guru/v2/specs/vtex.local/Checkout-API/1.0/api/checkout/pub/profiles?email=[email protected]

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/Checkout-API/1.0/api/checkout/pub/profiles?email=clark.kent%40examplemail.com" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json"

import requests
params = {
    "email": "[email protected]"
}
headers = {
    "Accept": "application/json",
    "Content-Type": "application/json"
}
response = requests.get(
    "https://api.apis.guru/v2/specs/vtex.local/Checkout-API/1.0/api/checkout/pub/profiles",
    params=params,
    headers=headers,
)
print(response.json())

const url = new URL('https://api.apis.guru/v2/specs/vtex.local/Checkout-API/1.0/api/checkout/pub/profiles');
url.searchParams.set('email', '[email protected]');

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/Checkout-API/1.0/api/checkout/pub/profiles")
	q := baseURL.Query()
	q.Set("email", "[email protected]")
	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/Checkout-API/1.0/api/checkout/pub/profiles")
uri.query = URI.encode_www_form({
  "email" => "[email protected]"
})

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/Checkout-API/1.0/api/checkout/pub/profiles?" . http_build_query([
    "email" => "[email protected]"
]);
$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));

Postman Setup Guide

Get Postman ↗

See official documentation for authentication and setup.

What can you build with Checkout API?

Checkout 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. Checkout 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 ↗