Create a place
curl --request POST \
--url https://shelfforce.ai/api/v1/places \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"title": "Walmart Supercenter #4523",
"address": "1234 Main St, Springfield, IL 62704",
"channel": "grocery",
"countryCode": "US",
"state": "IL"
}
'import requests
url = "https://shelfforce.ai/api/v1/places"
payload = {
"title": "Walmart Supercenter #4523",
"address": "1234 Main St, Springfield, IL 62704",
"channel": "grocery",
"countryCode": "US",
"state": "IL"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
title: 'Walmart Supercenter #4523',
address: '1234 Main St, Springfield, IL 62704',
channel: 'grocery',
countryCode: 'US',
state: 'IL'
})
};
fetch('https://shelfforce.ai/api/v1/places', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://shelfforce.ai/api/v1/places",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'title' => 'Walmart Supercenter #4523',
'address' => '1234 Main St, Springfield, IL 62704',
'channel' => 'grocery',
'countryCode' => 'US',
'state' => 'IL'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://shelfforce.ai/api/v1/places"
payload := strings.NewReader("{\n \"title\": \"Walmart Supercenter #4523\",\n \"address\": \"1234 Main St, Springfield, IL 62704\",\n \"channel\": \"grocery\",\n \"countryCode\": \"US\",\n \"state\": \"IL\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://shelfforce.ai/api/v1/places")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"Walmart Supercenter #4523\",\n \"address\": \"1234 Main St, Springfield, IL 62704\",\n \"channel\": \"grocery\",\n \"countryCode\": \"US\",\n \"state\": \"IL\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://shelfforce.ai/api/v1/places")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"title\": \"Walmart Supercenter #4523\",\n \"address\": \"1234 Main St, Springfield, IL 62704\",\n \"channel\": \"grocery\",\n \"countryCode\": \"US\",\n \"state\": \"IL\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "pl_mnop456",
"createdAt": "2026-02-23T10:30:00Z"
}
}{
"error": {
"code": "INVALID_API_KEY",
"message": "The provided API key is invalid or has been revoked."
}
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "The 'imageUrl' field must be a valid URL."
}
}{
"error": {
"code": "RATE_LIMITED",
"message": "Rate limit exceeded. Retry after 12 seconds."
}
}{
"error": {
"code": "INTERNAL_ERROR",
"message": "An unexpected error occurred. Please try again or contact support with request ID."
}
}Create a place
Creates a new store location within your organisation.
POST
/
api
/
v1
/
places
Create a place
curl --request POST \
--url https://shelfforce.ai/api/v1/places \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"title": "Walmart Supercenter #4523",
"address": "1234 Main St, Springfield, IL 62704",
"channel": "grocery",
"countryCode": "US",
"state": "IL"
}
'import requests
url = "https://shelfforce.ai/api/v1/places"
payload = {
"title": "Walmart Supercenter #4523",
"address": "1234 Main St, Springfield, IL 62704",
"channel": "grocery",
"countryCode": "US",
"state": "IL"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
title: 'Walmart Supercenter #4523',
address: '1234 Main St, Springfield, IL 62704',
channel: 'grocery',
countryCode: 'US',
state: 'IL'
})
};
fetch('https://shelfforce.ai/api/v1/places', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://shelfforce.ai/api/v1/places",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'title' => 'Walmart Supercenter #4523',
'address' => '1234 Main St, Springfield, IL 62704',
'channel' => 'grocery',
'countryCode' => 'US',
'state' => 'IL'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://shelfforce.ai/api/v1/places"
payload := strings.NewReader("{\n \"title\": \"Walmart Supercenter #4523\",\n \"address\": \"1234 Main St, Springfield, IL 62704\",\n \"channel\": \"grocery\",\n \"countryCode\": \"US\",\n \"state\": \"IL\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://shelfforce.ai/api/v1/places")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"Walmart Supercenter #4523\",\n \"address\": \"1234 Main St, Springfield, IL 62704\",\n \"channel\": \"grocery\",\n \"countryCode\": \"US\",\n \"state\": \"IL\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://shelfforce.ai/api/v1/places")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"title\": \"Walmart Supercenter #4523\",\n \"address\": \"1234 Main St, Springfield, IL 62704\",\n \"channel\": \"grocery\",\n \"countryCode\": \"US\",\n \"state\": \"IL\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "pl_mnop456",
"createdAt": "2026-02-23T10:30:00Z"
}
}{
"error": {
"code": "INVALID_API_KEY",
"message": "The provided API key is invalid or has been revoked."
}
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "The 'imageUrl' field must be a valid URL."
}
}{
"error": {
"code": "RATE_LIMITED",
"message": "Rate limit exceeded. Retry after 12 seconds."
}
}{
"error": {
"code": "INTERNAL_ERROR",
"message": "An unexpected error occurred. Please try again or contact support with request ID."
}
}Authorizations
API key with sf_live_ prefix. Pass as Authorization: Bearer sf_live_...
Headers
Unique key for idempotent requests. If a request with the same key was already processed within the last 24 hours, the cached response is returned with X-Idempotent-Replayed: true.
Example:
"idk_550e8400-e29b-41d4-a716-446655440000"
Body
application/json
Human-readable name for the store.
Example:
"Walmart Supercenter #4523"
Full street address.
Example:
"1234 Main St, Springfield, IL 62704"
Show child attributes
Show child attributes
Retail channel classification.
Example:
"grocery"
ISO 3166-1 alpha-2 country code.
Example:
"US"
State or province.
Example:
"IL"
Response
Place created.
Show child attributes
Show child attributes