Update Shop Profile
curl --request PUT \
--url https://api.getscale.ng/api/v1/hub/shop/{shopId} \
--header 'Content-Type: application/json' \
--header 'X-Shop-API-Key: <x-shop-api-key>' \
--data '
{
"shopName": "<string>",
"shopDescription": "<string>",
"shopAddress": "<string>",
"shopStateId": 123,
"shopLgaId": 123,
"phoneNumber": "<string>"
}
'import requests
url = "https://api.getscale.ng/api/v1/hub/shop/{shopId}"
payload = {
"shopName": "<string>",
"shopDescription": "<string>",
"shopAddress": "<string>",
"shopStateId": 123,
"shopLgaId": 123,
"phoneNumber": "<string>"
}
headers = {
"X-Shop-API-Key": "<x-shop-api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'X-Shop-API-Key': '<x-shop-api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
shopName: '<string>',
shopDescription: '<string>',
shopAddress: '<string>',
shopStateId: 123,
shopLgaId: 123,
phoneNumber: '<string>'
})
};
fetch('https://api.getscale.ng/api/v1/hub/shop/{shopId}', 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://api.getscale.ng/api/v1/hub/shop/{shopId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'shopName' => '<string>',
'shopDescription' => '<string>',
'shopAddress' => '<string>',
'shopStateId' => 123,
'shopLgaId' => 123,
'phoneNumber' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Shop-API-Key: <x-shop-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://api.getscale.ng/api/v1/hub/shop/{shopId}"
payload := strings.NewReader("{\n \"shopName\": \"<string>\",\n \"shopDescription\": \"<string>\",\n \"shopAddress\": \"<string>\",\n \"shopStateId\": 123,\n \"shopLgaId\": 123,\n \"phoneNumber\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("X-Shop-API-Key", "<x-shop-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.put("https://api.getscale.ng/api/v1/hub/shop/{shopId}")
.header("X-Shop-API-Key", "<x-shop-api-key>")
.header("Content-Type", "application/json")
.body("{\n \"shopName\": \"<string>\",\n \"shopDescription\": \"<string>\",\n \"shopAddress\": \"<string>\",\n \"shopStateId\": 123,\n \"shopLgaId\": 123,\n \"phoneNumber\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getscale.ng/api/v1/hub/shop/{shopId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-Shop-API-Key"] = '<x-shop-api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"shopName\": \"<string>\",\n \"shopDescription\": \"<string>\",\n \"shopAddress\": \"<string>\",\n \"shopStateId\": 123,\n \"shopLgaId\": 123,\n \"phoneNumber\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"message": "Shop updated successfully"
}
{
"message": "FORM_VALIDATION_ERROR",
"code": 400,
"validationErrors": [
{
"path": [
"lgaId"
],
"message": "LGA must exist in the specified state"
}
]
}
Shop Profile
Update Shop Profile
PUT
/
api
/
v1
/
hub
/
shop
/
{shopId}
Update Shop Profile
curl --request PUT \
--url https://api.getscale.ng/api/v1/hub/shop/{shopId} \
--header 'Content-Type: application/json' \
--header 'X-Shop-API-Key: <x-shop-api-key>' \
--data '
{
"shopName": "<string>",
"shopDescription": "<string>",
"shopAddress": "<string>",
"shopStateId": 123,
"shopLgaId": 123,
"phoneNumber": "<string>"
}
'import requests
url = "https://api.getscale.ng/api/v1/hub/shop/{shopId}"
payload = {
"shopName": "<string>",
"shopDescription": "<string>",
"shopAddress": "<string>",
"shopStateId": 123,
"shopLgaId": 123,
"phoneNumber": "<string>"
}
headers = {
"X-Shop-API-Key": "<x-shop-api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'X-Shop-API-Key': '<x-shop-api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
shopName: '<string>',
shopDescription: '<string>',
shopAddress: '<string>',
shopStateId: 123,
shopLgaId: 123,
phoneNumber: '<string>'
})
};
fetch('https://api.getscale.ng/api/v1/hub/shop/{shopId}', 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://api.getscale.ng/api/v1/hub/shop/{shopId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'shopName' => '<string>',
'shopDescription' => '<string>',
'shopAddress' => '<string>',
'shopStateId' => 123,
'shopLgaId' => 123,
'phoneNumber' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Shop-API-Key: <x-shop-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://api.getscale.ng/api/v1/hub/shop/{shopId}"
payload := strings.NewReader("{\n \"shopName\": \"<string>\",\n \"shopDescription\": \"<string>\",\n \"shopAddress\": \"<string>\",\n \"shopStateId\": 123,\n \"shopLgaId\": 123,\n \"phoneNumber\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("X-Shop-API-Key", "<x-shop-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.put("https://api.getscale.ng/api/v1/hub/shop/{shopId}")
.header("X-Shop-API-Key", "<x-shop-api-key>")
.header("Content-Type", "application/json")
.body("{\n \"shopName\": \"<string>\",\n \"shopDescription\": \"<string>\",\n \"shopAddress\": \"<string>\",\n \"shopStateId\": 123,\n \"shopLgaId\": 123,\n \"phoneNumber\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getscale.ng/api/v1/hub/shop/{shopId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-Shop-API-Key"] = '<x-shop-api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"shopName\": \"<string>\",\n \"shopDescription\": \"<string>\",\n \"shopAddress\": \"<string>\",\n \"shopStateId\": 123,\n \"shopLgaId\": 123,\n \"phoneNumber\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"message": "Shop updated successfully"
}
{
"message": "FORM_VALIDATION_ERROR",
"code": 400,
"validationErrors": [
{
"path": [
"lgaId"
],
"message": "LGA must exist in the specified state"
}
]
}
Modifies the shop’s profile name, description, address, location bounds (using state and LGA references), contact number, or banner/logo images. Accepts multipart form data.
Authorizations
string
required
Your Secret API Key (
sk_live_... or sk_test_...) generated from the Developer dashboard. Must be kept secret.Path Parameters
string
required
The unique UUID of the shop.
Request Body (Multipart / Form Data)
string
Name of the shop.
string
Description of the shop.
string
Physical street address of the storefront.
number
The state ID where the shop is located. Check the location API for valid IDs.
number
The Local Government Area (LGA) ID. Must exist within the specified state.
string
Contact phone number. Must be a valid Nigerian format.
file
New square logo image.
file
New horizontal banner image.
{
"status": "success",
"message": "Shop updated successfully"
}
{
"message": "FORM_VALIDATION_ERROR",
"code": 400,
"validationErrors": [
{
"path": [
"lgaId"
],
"message": "LGA must exist in the specified state"
}
]
}
⌘I