Skip to main content
POST
/
v1
/
retailers
/
locations
Create location
curl --request POST \
  --url http://localhost:3000/v1/retailers/locations \
  --header 'Content-Type: application/json' \
  --data '
{
  "retailer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "address_1": "<string>",
  "address_2": "<string>",
  "city": "<string>",
  "province": "<string>",
  "postal_code": "<string>",
  "latitude": 0,
  "longitude": 0
}
'
{
  "success": true,
  "location": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "retailer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "store_number": "<string>",
    "address_1": "<string>",
    "address_2": "<string>",
    "city": "<string>",
    "province": "<string>",
    "postal_code": "<string>",
    "latitude": 123,
    "longitude": 123,
    "product_count": 123
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.switchyard.run/llms.txt

Use this file to discover all available pages before exploring further.

Body

application/json

Create location request

​
retailer_id
string<uuid>
required

Retailer ID

​
name
string
required

Location name

Required string length: 1 - 200
​
address_1
string | null

Address line 1

Maximum string length: 500
​
address_2
string | null

Address line 2

Maximum string length: 500
​
city
string | null

City

Maximum string length: 100
​
province
string | null

Province/State

Maximum string length: 50
​
postal_code
string | null

Postal/ZIP code

Maximum string length: 20
​
latitude
number | null

Latitude

Required range: -90 <= x <= 90
​
longitude
number | null

Longitude

Required range: -180 <= x <= 180

Response

Created location

Create location response

​
success
boolean
required
​
location
object
required

Location