Set or update a stock location's ship-from address

curl --request PATCH \
  --url https://api.mercemur.com/api/v1/stock-locations/{locationId}/address \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "address_line_1": "<string>",
  "address_line_2": "<string>",
  "city": "<string>",
  "province": "<string>",
  "postal_code": "<string>",
  "country_code": "<string>",
  "phone": "<string>"
}
'

const options = {
  method: 'PATCH',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    address_line_1: '<string>',
    address_line_2: '<string>',
    city: '<string>',
    province: '<string>',
    postal_code: '<string>',
    country_code: '<string>',
    phone: '<string>'
  })
};

fetch('https://api.mercemur.com/api/v1/stock-locations/{locationId}/address', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.mercemur.com/api/v1/stock-locations/{locationId}/address"

payload = {
    "address_line_1": "<string>",
    "address_line_2": "<string>",
    "city": "<string>",
    "province": "<string>",
    "postal_code": "<string>",
    "country_code": "<string>",
    "phone": "<string>"
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.mercemur.com/api/v1/stock-locations/{locationId}/address"

	payload := strings.NewReader("{\n  \"address_line_1\": \"<string>\",\n  \"address_line_2\": \"<string>\",\n  \"city\": \"<string>\",\n  \"province\": \"<string>\",\n  \"postal_code\": \"<string>\",\n  \"country_code\": \"<string>\",\n  \"phone\": \"<string>\"\n}")

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

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	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))

}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.mercemur.com/api/v1/stock-locations/{locationId}/address",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'address_line_1' => '<string>',
    'address_line_2' => '<string>',
    'city' => '<string>',
    'province' => '<string>',
    'postal_code' => '<string>',
    'country_code' => '<string>',
    'phone' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "data": {
    "address_line_1": "<string>",
    "city": "<string>",
    "country_code": "<string>",
    "phone": "<string>",
    "postal_code": "<string>",
    "province": "<string>",
    "updated_at": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>",
    "reason": "malformed_json"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>",
    "reason": "malformed_json"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>",
    "reason": "malformed_json"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>",
    "reason": "malformed_json"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>",
    "reason": "malformed_json"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>",
    "reason": "malformed_json"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>",
    "reason": "malformed_json"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>",
    "reason": "malformed_json"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>",
    "reason": "malformed_json"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>",
    "reason": "malformed_json"
  }
}

PATCH

api

stock-locations

{locationId}

address

Set or update a stock location's ship-from address

curl --request PATCH \
  --url https://api.mercemur.com/api/v1/stock-locations/{locationId}/address \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "address_line_1": "<string>",
  "address_line_2": "<string>",
  "city": "<string>",
  "province": "<string>",
  "postal_code": "<string>",
  "country_code": "<string>",
  "phone": "<string>"
}
'

const options = {
  method: 'PATCH',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    address_line_1: '<string>',
    address_line_2: '<string>',
    city: '<string>',
    province: '<string>',
    postal_code: '<string>',
    country_code: '<string>',
    phone: '<string>'
  })
};

fetch('https://api.mercemur.com/api/v1/stock-locations/{locationId}/address', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.mercemur.com/api/v1/stock-locations/{locationId}/address"

payload = {
    "address_line_1": "<string>",
    "address_line_2": "<string>",
    "city": "<string>",
    "province": "<string>",
    "postal_code": "<string>",
    "country_code": "<string>",
    "phone": "<string>"
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.mercemur.com/api/v1/stock-locations/{locationId}/address"

	payload := strings.NewReader("{\n  \"address_line_1\": \"<string>\",\n  \"address_line_2\": \"<string>\",\n  \"city\": \"<string>\",\n  \"province\": \"<string>\",\n  \"postal_code\": \"<string>\",\n  \"country_code\": \"<string>\",\n  \"phone\": \"<string>\"\n}")

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

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	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))

}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.mercemur.com/api/v1/stock-locations/{locationId}/address",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'address_line_1' => '<string>',
    'address_line_2' => '<string>',
    'city' => '<string>',
    'province' => '<string>',
    'postal_code' => '<string>',
    'country_code' => '<string>',
    'phone' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "data": {
    "address_line_1": "<string>",
    "city": "<string>",
    "country_code": "<string>",
    "phone": "<string>",
    "postal_code": "<string>",
    "province": "<string>",
    "updated_at": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>",
    "reason": "malformed_json"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>",
    "reason": "malformed_json"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>",
    "reason": "malformed_json"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>",
    "reason": "malformed_json"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>",
    "reason": "malformed_json"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>",
    "reason": "malformed_json"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>",
    "reason": "malformed_json"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>",
    "reason": "malformed_json"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>",
    "reason": "malformed_json"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>",
    "reason": "malformed_json"
  }
}

Authorizations

Authorization

string

header

required

A secret API key. Publishable keys cannot reach this API. A key may carry an expiry, and an expired key is refused exactly like an unknown one, with a 401 that names no reason; check the key's expires_at in the dashboard rather than inferring it from a response. When a merchant rolls a key's secret they choose a grace window of up to 3 days, and for its duration BOTH the new secret and the one it replaced authenticate, so an integration moves over on its own deploy schedule instead of at the instant the button is pressed. Move before the window closes: after it, the old secret is refused. Nothing else about this contract moves with a roll. The key keeps its id and its scopes, so the only thing an integration updates is the credential itself.

Headers

Idempotency-Key

string

required

A unique key per logical write. Replaying a request with the same key returns the first response byte for byte instead of applying the write twice.

Path Parameters

locationId

string

required

Body

application/json

UPSERT SEMANTICS: the first call for a location creates the address row, every later call merges the patch onto whatever is already stored. A field omitted from the body leaves the stored value unchanged; there is no separate create/update split to call. This mirrors the admin route it is published alongside exactly.

address_line_1

string

address_line_2

string

city

string

province

string

postal_code

string

country_code

string

Normalized to 2-letter uppercase on every write; anything else is refused before it reaches the row.

phone

string

Response

Success

data

object

Show child attributes

Inventory levels

Low stock thresholds

Stock transfers

Reservations

Stock locations

Retail locations

Regions

Shipping profiles

Shipping options

Carriers

API Reference

Set or update a stock location's ship-from address

Authorizations

Headers

Path Parameters

Body

Response