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
}
'
import requests

url = "http://localhost:3000/v1/retailers/locations"

payload = {
"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
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
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
})
};

fetch('http://localhost:3000/v1/retailers/locations', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/v1/retailers/locations",
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([
'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
]),
CURLOPT_HTTPHEADER => [
"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 := "http://localhost:3000/v1/retailers/locations"

payload := strings.NewReader("{\n \"retailer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"address_1\": \"<string>\",\n \"address_2\": \"<string>\",\n \"city\": \"<string>\",\n \"province\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"latitude\": 0,\n \"longitude\": 0\n}")

req, _ := http.NewRequest("POST", url, payload)

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("http://localhost:3000/v1/retailers/locations")
.header("Content-Type", "application/json")
.body("{\n \"retailer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"address_1\": \"<string>\",\n \"address_2\": \"<string>\",\n \"city\": \"<string>\",\n \"province\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"latitude\": 0,\n \"longitude\": 0\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("http://localhost:3000/v1/retailers/locations")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"retailer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"address_1\": \"<string>\",\n \"address_2\": \"<string>\",\n \"city\": \"<string>\",\n \"province\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"latitude\": 0,\n \"longitude\": 0\n}"

response = http.request(request)
puts response.read_body
{
  "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
  }
}
{
"error": "<string>"
}
{
"error": "<string>"
}

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