Skip to main content
POST
/
settings
/
shipping
/
warehouses
Add Warehouse
curl --request POST \
  --url https://staging-api.puppetvendors.com/settings/shipping/warehouses \
  --header 'Content-Type: application/json' \
  --header 'x-access-token: <api-key>' \
  --data '
{
  "name": "<string>",
  "address1": "<string>",
  "address2": "<string>",
  "city": "<string>",
  "province": "<string>",
  "zip": "<string>",
  "country": "<string>"
}
'
import requests

url = "https://staging-api.puppetvendors.com/settings/shipping/warehouses"

payload = {
"name": "<string>",
"address1": "<string>",
"address2": "<string>",
"city": "<string>",
"province": "<string>",
"zip": "<string>",
"country": "<string>"
}
headers = {
"x-access-token": "<api-key>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'POST',
headers: {'x-access-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
address1: '<string>',
address2: '<string>',
city: '<string>',
province: '<string>',
zip: '<string>',
country: '<string>'
})
};

fetch('https://staging-api.puppetvendors.com/settings/shipping/warehouses', 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://staging-api.puppetvendors.com/settings/shipping/warehouses",
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([
'name' => '<string>',
'address1' => '<string>',
'address2' => '<string>',
'city' => '<string>',
'province' => '<string>',
'zip' => '<string>',
'country' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-access-token: <api-key>"
],
]);

$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://staging-api.puppetvendors.com/settings/shipping/warehouses"

payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"address1\": \"<string>\",\n \"address2\": \"<string>\",\n \"city\": \"<string>\",\n \"province\": \"<string>\",\n \"zip\": \"<string>\",\n \"country\": \"<string>\"\n}")

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

req.Header.Add("x-access-token", "<api-key>")
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://staging-api.puppetvendors.com/settings/shipping/warehouses")
.header("x-access-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"address1\": \"<string>\",\n \"address2\": \"<string>\",\n \"city\": \"<string>\",\n \"province\": \"<string>\",\n \"zip\": \"<string>\",\n \"country\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://staging-api.puppetvendors.com/settings/shipping/warehouses")

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

request = Net::HTTP::Post.new(url)
request["x-access-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"address1\": \"<string>\",\n \"address2\": \"<string>\",\n \"city\": \"<string>\",\n \"province\": \"<string>\",\n \"zip\": \"<string>\",\n \"country\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
V2 Preview — This endpoint is part of the V2 API preview. Breaking changes may occur.

Overview

Add a new warehouse / location. The server assigns a new numeric locationId (one greater than the current max on this vendor). Vendor scope required.

Request Body

name
string
required
Warehouse name (max 200 chars).
address1
string
Street address line 1 (max 500 chars).
address2
string
Street address line 2 (max 500 chars).
city
string
City (max 200 chars).
province
string
State / province (max 200 chars).
zip
string
Postal code (max 50 chars).
country
string
Country (max 200 chars).

Response

200
{
  "success": true,
  "data": {
    "locationId": 2,
    "name": "Main Warehouse",
    "address1": "123 Main St",
    "city": "Austin",
    "province": "TX",
    "zip": "78701",
    "country": "US"
  }
}

Example

curl -X POST "https://staging-api.puppetvendors.com/settings/shipping/warehouses" \
  -H "x-access-token: YOUR_VENDOR_JWT" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Main Warehouse",
    "address1": "123 Main St",
    "city": "Austin",
    "province": "TX",
    "zip": "78701",
    "country": "US"
  }'

More Examples

Create a US warehouse
curl -X POST "https://staging-api.puppetvendors.com/settings/shipping/warehouses" \
  -H "Content-Type: application/json" \
  -H "x-access-token: YOUR_VENDOR_JWT" \
  -d '{
    "name": "East Coast Warehouse",
    "address1": "456 Industrial Blvd",
    "address2": "Unit 7B",
    "city": "Newark",
    "province": "NJ",
    "zip": "07102",
    "country": "US",
    "phone": "+1-555-0123",
    "email": "warehouse@acmeco.com",
    "defaultShippingAddress": true
  }'