Skip to main content
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": "<string>",
  "address": "<string>",
  "channel": "<string>",
  "countryCode": "<string>",
  "state": "<string>"
}
'
{
  "data": {
    "id": "<string>",
    "createdAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
Authorization
string
header
required

API key with sf_live_ prefix. Pass as Authorization: Bearer sf_live_...

Headers

​
Idempotency-Key
string

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
​
title
string
required

Human-readable name for the store.

Example:

"Walmart Supercenter #4523"

​
address
string
required

Full street address.

Example:

"1234 Main St, Springfield, IL 62704"

​
location
object
​
channel
string

Retail channel classification.

Example:

"grocery"

​
countryCode
string

ISO 3166-1 alpha-2 country code.

Example:

"US"

​
state
string

State or province.

Example:

"IL"

Response

Place created.

​
data
object
required