Replace storefront items
curl --request PUT \
--url https://api-sandbox.beinfi.com/storefronts/{storefrontID}/items \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"items": [
{
"productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"visible": true,
"availableOnsite": false
}
]
}
'import requests
url = "https://api-sandbox.beinfi.com/storefronts/{storefrontID}/items"
payload = { "items": [
{
"productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"visible": True,
"availableOnsite": False
}
] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
items: [
{
productId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
visible: true,
availableOnsite: false
}
]
})
};
fetch('https://api-sandbox.beinfi.com/storefronts/{storefrontID}/items', 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}/items",
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([
'items' => [
[
'productId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'visible' => true,
'availableOnsite' => false
]
]
]),
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}/items"
payload := strings.NewReader("{\n \"items\": [\n {\n \"productId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"visible\": true,\n \"availableOnsite\": false\n }\n ]\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api-sandbox.beinfi.com/storefronts/{storefrontID}/items")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"items\": [\n {\n \"productId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"visible\": true,\n \"availableOnsite\": false\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.beinfi.com/storefronts/{storefrontID}/items")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"items\": [\n {\n \"productId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"visible\": true,\n \"availableOnsite\": false\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"position": 123,
"visible": true,
"availableOnsite": true,
"productStatus": "active",
"imageUrl": "<string>"
}
]
}{
"message": "<string>",
"error_code": "internal_error",
"tracer_id": "<string>",
"resource": "<string>"
}{
"message": "<string>",
"error_code": "internal_error",
"tracer_id": "<string>",
"errors": [
{
"field": "<string>",
"value": "<string>",
"constraint": "<string>",
"description": "<string>"
}
]
}Storefronts
Replace storefront items
Sends the whole shelf as one ordered list, replacing the current one. Each item’s position is its index in the array. A product that is not in your account returns 404.
PUT
/
storefronts
/
{storefrontID}
/
items
Replace storefront items
curl --request PUT \
--url https://api-sandbox.beinfi.com/storefronts/{storefrontID}/items \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"items": [
{
"productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"visible": true,
"availableOnsite": false
}
]
}
'import requests
url = "https://api-sandbox.beinfi.com/storefronts/{storefrontID}/items"
payload = { "items": [
{
"productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"visible": True,
"availableOnsite": False
}
] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
items: [
{
productId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
visible: true,
availableOnsite: false
}
]
})
};
fetch('https://api-sandbox.beinfi.com/storefronts/{storefrontID}/items', 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}/items",
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([
'items' => [
[
'productId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'visible' => true,
'availableOnsite' => false
]
]
]),
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}/items"
payload := strings.NewReader("{\n \"items\": [\n {\n \"productId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"visible\": true,\n \"availableOnsite\": false\n }\n ]\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api-sandbox.beinfi.com/storefronts/{storefrontID}/items")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"items\": [\n {\n \"productId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"visible\": true,\n \"availableOnsite\": false\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.beinfi.com/storefronts/{storefrontID}/items")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"items\": [\n {\n \"productId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"visible\": true,\n \"availableOnsite\": false\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"position": 123,
"visible": true,
"availableOnsite": true,
"productStatus": "active",
"imageUrl": "<string>"
}
]
}{
"message": "<string>",
"error_code": "internal_error",
"tracer_id": "<string>",
"resource": "<string>"
}{
"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
application/json
The storefront's items, in display order.
Show child attributes
Show child attributes
Response
The shelf after the change.
Show child attributes
Show child attributes