curl --request PATCH \
--url https://api-sandbox.beinfi.com/storefronts/{storefrontID} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"slug": "<string>",
"description": "<string>",
"logoObjectKey": "<string>",
"bannerObjectKey": "<string>",
"theme": {
"whatsapp": "<string>",
"instagram": "<string>"
},
"pickupNote": "<string>",
"shippingFlatAmount": "<string>",
"requireAddress": true
}
'import requests
url = "https://api-sandbox.beinfi.com/storefronts/{storefrontID}"
payload = {
"name": "<string>",
"slug": "<string>",
"description": "<string>",
"logoObjectKey": "<string>",
"bannerObjectKey": "<string>",
"theme": {
"whatsapp": "<string>",
"instagram": "<string>"
},
"pickupNote": "<string>",
"shippingFlatAmount": "<string>",
"requireAddress": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
slug: '<string>',
description: '<string>',
logoObjectKey: '<string>',
bannerObjectKey: '<string>',
theme: {whatsapp: '<string>', instagram: '<string>'},
pickupNote: '<string>',
shippingFlatAmount: '<string>',
requireAddress: true
})
};
fetch('https://api-sandbox.beinfi.com/storefronts/{storefrontID}', 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-sandbox.beinfi.com/storefronts/{storefrontID}",
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([
'name' => '<string>',
'slug' => '<string>',
'description' => '<string>',
'logoObjectKey' => '<string>',
'bannerObjectKey' => '<string>',
'theme' => [
'whatsapp' => '<string>',
'instagram' => '<string>'
],
'pickupNote' => '<string>',
'shippingFlatAmount' => '<string>',
'requireAddress' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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 := "https://api-sandbox.beinfi.com/storefronts/{storefrontID}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"description\": \"<string>\",\n \"logoObjectKey\": \"<string>\",\n \"bannerObjectKey\": \"<string>\",\n \"theme\": {\n \"whatsapp\": \"<string>\",\n \"instagram\": \"<string>\"\n },\n \"pickupNote\": \"<string>\",\n \"shippingFlatAmount\": \"<string>\",\n \"requireAddress\": true\n}")
req, _ := http.NewRequest("PATCH", url, payload)
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))
}HttpResponse<String> response = Unirest.patch("https://api-sandbox.beinfi.com/storefronts/{storefrontID}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"description\": \"<string>\",\n \"logoObjectKey\": \"<string>\",\n \"bannerObjectKey\": \"<string>\",\n \"theme\": {\n \"whatsapp\": \"<string>\",\n \"instagram\": \"<string>\"\n },\n \"pickupNote\": \"<string>\",\n \"shippingFlatAmount\": \"<string>\",\n \"requireAddress\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.beinfi.com/storefronts/{storefrontID}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"description\": \"<string>\",\n \"logoObjectKey\": \"<string>\",\n \"bannerObjectKey\": \"<string>\",\n \"theme\": {\n \"whatsapp\": \"<string>\",\n \"instagram\": \"<string>\"\n },\n \"pickupNote\": \"<string>\",\n \"shippingFlatAmount\": \"<string>\",\n \"requireAddress\": true\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"slug": "<string>",
"name": "<string>",
"theme": {
"accent": "purple",
"mode": "light",
"layout": "grid",
"whatsapp": "<string>",
"instagram": "<string>"
},
"status": "active",
"fulfillmentMode": "pickup",
"requireAddress": true,
"createdAt": "2023-11-07T05:31:56Z",
"description": "<string>",
"logoUrl": "<string>",
"logoObjectKey": "<string>",
"bannerUrl": "<string>",
"bannerObjectKey": "<string>",
"pickupNote": "<string>",
"shippingFlatAmount": "<string>"
}{
"message": "<string>",
"error_code": "internal_error",
"tracer_id": "<string>",
"resource": "<string>"
}{
"message": "<string>",
"error_code": "internal_error",
"tracer_id": "<string>",
"resource": "<string>",
"metadata": {}
}{
"message": "<string>",
"error_code": "internal_error",
"tracer_id": "<string>",
"errors": [
{
"field": "<string>",
"value": "<string>",
"constraint": "<string>",
"description": "<string>"
}
]
}Update a storefront
Partial update: absent fields keep their value. status: disabled takes the shop offline immediately and can be reversed. Storefronts cannot be deleted.
curl --request PATCH \
--url https://api-sandbox.beinfi.com/storefronts/{storefrontID} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"slug": "<string>",
"description": "<string>",
"logoObjectKey": "<string>",
"bannerObjectKey": "<string>",
"theme": {
"whatsapp": "<string>",
"instagram": "<string>"
},
"pickupNote": "<string>",
"shippingFlatAmount": "<string>",
"requireAddress": true
}
'import requests
url = "https://api-sandbox.beinfi.com/storefronts/{storefrontID}"
payload = {
"name": "<string>",
"slug": "<string>",
"description": "<string>",
"logoObjectKey": "<string>",
"bannerObjectKey": "<string>",
"theme": {
"whatsapp": "<string>",
"instagram": "<string>"
},
"pickupNote": "<string>",
"shippingFlatAmount": "<string>",
"requireAddress": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
slug: '<string>',
description: '<string>',
logoObjectKey: '<string>',
bannerObjectKey: '<string>',
theme: {whatsapp: '<string>', instagram: '<string>'},
pickupNote: '<string>',
shippingFlatAmount: '<string>',
requireAddress: true
})
};
fetch('https://api-sandbox.beinfi.com/storefronts/{storefrontID}', 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-sandbox.beinfi.com/storefronts/{storefrontID}",
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([
'name' => '<string>',
'slug' => '<string>',
'description' => '<string>',
'logoObjectKey' => '<string>',
'bannerObjectKey' => '<string>',
'theme' => [
'whatsapp' => '<string>',
'instagram' => '<string>'
],
'pickupNote' => '<string>',
'shippingFlatAmount' => '<string>',
'requireAddress' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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 := "https://api-sandbox.beinfi.com/storefronts/{storefrontID}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"description\": \"<string>\",\n \"logoObjectKey\": \"<string>\",\n \"bannerObjectKey\": \"<string>\",\n \"theme\": {\n \"whatsapp\": \"<string>\",\n \"instagram\": \"<string>\"\n },\n \"pickupNote\": \"<string>\",\n \"shippingFlatAmount\": \"<string>\",\n \"requireAddress\": true\n}")
req, _ := http.NewRequest("PATCH", url, payload)
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))
}HttpResponse<String> response = Unirest.patch("https://api-sandbox.beinfi.com/storefronts/{storefrontID}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"description\": \"<string>\",\n \"logoObjectKey\": \"<string>\",\n \"bannerObjectKey\": \"<string>\",\n \"theme\": {\n \"whatsapp\": \"<string>\",\n \"instagram\": \"<string>\"\n },\n \"pickupNote\": \"<string>\",\n \"shippingFlatAmount\": \"<string>\",\n \"requireAddress\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.beinfi.com/storefronts/{storefrontID}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"description\": \"<string>\",\n \"logoObjectKey\": \"<string>\",\n \"bannerObjectKey\": \"<string>\",\n \"theme\": {\n \"whatsapp\": \"<string>\",\n \"instagram\": \"<string>\"\n },\n \"pickupNote\": \"<string>\",\n \"shippingFlatAmount\": \"<string>\",\n \"requireAddress\": true\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"slug": "<string>",
"name": "<string>",
"theme": {
"accent": "purple",
"mode": "light",
"layout": "grid",
"whatsapp": "<string>",
"instagram": "<string>"
},
"status": "active",
"fulfillmentMode": "pickup",
"requireAddress": true,
"createdAt": "2023-11-07T05:31:56Z",
"description": "<string>",
"logoUrl": "<string>",
"logoObjectKey": "<string>",
"bannerUrl": "<string>",
"bannerObjectKey": "<string>",
"pickupNote": "<string>",
"shippingFlatAmount": "<string>"
}{
"message": "<string>",
"error_code": "internal_error",
"tracer_id": "<string>",
"resource": "<string>"
}{
"message": "<string>",
"error_code": "internal_error",
"tracer_id": "<string>",
"resource": "<string>",
"metadata": {}
}{
"message": "<string>",
"error_code": "internal_error",
"tracer_id": "<string>",
"errors": [
{
"field": "<string>",
"value": "<string>",
"constraint": "<string>",
"description": "<string>"
}
]
}Authorizations
Your account's secret key: Authorization: Bearer sk_test_… or sk_live_…. Server-side only.
Path Parameters
Body
Fields to create or update a storefront. On PATCH all are optional and omitted ones do not change. On logoObjectKey and bannerObjectKey, "" removes the image.
The public address, 3–40 characters: lowercase letters, digits and single dashes. Unique across Infi and not a reserved word.
Logo image key, from POST /catalog/images/presign.
Banner image key, from POST /catalog/images/presign.
The shop's look, chosen from a fixed set of options.
Show child attributes
Show child attributes
disabled takes the shop offline immediately; active brings it back.
active, disabled How the buyer receives what they bought. A pickup shop never asks for an address; both lets the buyer choose at checkout.
pickup, shipping, both Pickup instructions shown to the buyer.
Flat shipping, as a decimal string. "0" is free; null means arranged separately. Refused on a pickup-only shop.
Collects an address even for pickup, for example to put it on the nota fiscal.
Response
The updated storefront.
A storefront in your account.
The shop's public address.
The shop's look, chosen from a fixed set of options.
Show child attributes
Show child attributes
active (live) or disabled (offline).
active, disabled How the buyer receives: pickup, shipping or both.
pickup, shipping, both Whether an address is collected even for pickup.
Logo image address. logoObjectKey carries the matching key.
Logo image key, from POST /catalog/images/presign.
Banner image address.
Banner image key, from POST /catalog/images/presign.
Pickup instructions shown to the buyer.
Flat shipping, as a decimal string. "0" is free; null means arranged separately.