Update a product
curl --request PATCH \
--url https://api-sandbox.beinfi.com/products/{productID} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"imageObjectKey": "<string>",
"guaranteeDays": 18,
"accentColor": "<string>",
"media": [
{
"objectKey": "<string>",
"url": "<string>",
"alt": "<string>"
}
],
"faq": [
{
"question": "<string>",
"answer": "<string>"
}
],
"purchaseButtonText": "<string>",
"postPurchaseRedirectUrl": "<string>"
}
'import requests
url = "https://api-sandbox.beinfi.com/products/{productID}"
payload = {
"name": "<string>",
"description": "<string>",
"imageObjectKey": "<string>",
"guaranteeDays": 18,
"accentColor": "<string>",
"media": [
{
"objectKey": "<string>",
"url": "<string>",
"alt": "<string>"
}
],
"faq": [
{
"question": "<string>",
"answer": "<string>"
}
],
"purchaseButtonText": "<string>",
"postPurchaseRedirectUrl": "<string>"
}
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>',
description: '<string>',
imageObjectKey: '<string>',
guaranteeDays: 18,
accentColor: '<string>',
media: [{objectKey: '<string>', url: '<string>', alt: '<string>'}],
faq: [{question: '<string>', answer: '<string>'}],
purchaseButtonText: '<string>',
postPurchaseRedirectUrl: '<string>'
})
};
fetch('https://api-sandbox.beinfi.com/products/{productID}', 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/products/{productID}",
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>',
'description' => '<string>',
'imageObjectKey' => '<string>',
'guaranteeDays' => 18,
'accentColor' => '<string>',
'media' => [
[
'objectKey' => '<string>',
'url' => '<string>',
'alt' => '<string>'
]
],
'faq' => [
[
'question' => '<string>',
'answer' => '<string>'
]
],
'purchaseButtonText' => '<string>',
'postPurchaseRedirectUrl' => '<string>'
]),
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/products/{productID}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"imageObjectKey\": \"<string>\",\n \"guaranteeDays\": 18,\n \"accentColor\": \"<string>\",\n \"media\": [\n {\n \"objectKey\": \"<string>\",\n \"url\": \"<string>\",\n \"alt\": \"<string>\"\n }\n ],\n \"faq\": [\n {\n \"question\": \"<string>\",\n \"answer\": \"<string>\"\n }\n ],\n \"purchaseButtonText\": \"<string>\",\n \"postPurchaseRedirectUrl\": \"<string>\"\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/products/{productID}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"imageObjectKey\": \"<string>\",\n \"guaranteeDays\": 18,\n \"accentColor\": \"<string>\",\n \"media\": [\n {\n \"objectKey\": \"<string>\",\n \"url\": \"<string>\",\n \"alt\": \"<string>\"\n }\n ],\n \"faq\": [\n {\n \"question\": \"<string>\",\n \"answer\": \"<string>\"\n }\n ],\n \"purchaseButtonText\": \"<string>\",\n \"postPurchaseRedirectUrl\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.beinfi.com/products/{productID}")
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 \"description\": \"<string>\",\n \"imageObjectKey\": \"<string>\",\n \"guaranteeDays\": 18,\n \"accentColor\": \"<string>\",\n \"media\": [\n {\n \"objectKey\": \"<string>\",\n \"url\": \"<string>\",\n \"alt\": \"<string>\"\n }\n ],\n \"faq\": [\n {\n \"question\": \"<string>\",\n \"answer\": \"<string>\"\n }\n ],\n \"purchaseButtonText\": \"<string>\",\n \"postPurchaseRedirectUrl\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "prod_1d4YogBuw00jAySh5mbUpk",
"name": "<string>",
"type": "agent",
"pricingModel": "subscription",
"currency": "BRL",
"status": "active",
"guaranteeDays": 18,
"accentColor": "<string>",
"media": [
{
"type": "image",
"objectKey": "<string>",
"url": "<string>",
"alt": "<string>"
}
],
"faq": [
{
"question": "<string>",
"answer": "<string>"
}
],
"purchaseButtonText": "<string>",
"postPurchaseRedirectUrl": "<string>",
"draftSavedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"key": "<string>",
"description": "<string>",
"imageUrl": "<string>"
}{
"message": "<string>",
"error_code": "internal_error",
"tracer_id": "<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>"
}
]
}Catalog
Update a product
Replaces the product’s details: name, description and status are always written, so send all three. Omitting description clears it, and omitting status leaves the product without a status.
imageObjectKey is the exception: when absent, it stays as it is. Pricing is not changed here; create a new version instead.
PATCH
/
products
/
{productID}
Update a product
curl --request PATCH \
--url https://api-sandbox.beinfi.com/products/{productID} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"imageObjectKey": "<string>",
"guaranteeDays": 18,
"accentColor": "<string>",
"media": [
{
"objectKey": "<string>",
"url": "<string>",
"alt": "<string>"
}
],
"faq": [
{
"question": "<string>",
"answer": "<string>"
}
],
"purchaseButtonText": "<string>",
"postPurchaseRedirectUrl": "<string>"
}
'import requests
url = "https://api-sandbox.beinfi.com/products/{productID}"
payload = {
"name": "<string>",
"description": "<string>",
"imageObjectKey": "<string>",
"guaranteeDays": 18,
"accentColor": "<string>",
"media": [
{
"objectKey": "<string>",
"url": "<string>",
"alt": "<string>"
}
],
"faq": [
{
"question": "<string>",
"answer": "<string>"
}
],
"purchaseButtonText": "<string>",
"postPurchaseRedirectUrl": "<string>"
}
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>',
description: '<string>',
imageObjectKey: '<string>',
guaranteeDays: 18,
accentColor: '<string>',
media: [{objectKey: '<string>', url: '<string>', alt: '<string>'}],
faq: [{question: '<string>', answer: '<string>'}],
purchaseButtonText: '<string>',
postPurchaseRedirectUrl: '<string>'
})
};
fetch('https://api-sandbox.beinfi.com/products/{productID}', 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/products/{productID}",
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>',
'description' => '<string>',
'imageObjectKey' => '<string>',
'guaranteeDays' => 18,
'accentColor' => '<string>',
'media' => [
[
'objectKey' => '<string>',
'url' => '<string>',
'alt' => '<string>'
]
],
'faq' => [
[
'question' => '<string>',
'answer' => '<string>'
]
],
'purchaseButtonText' => '<string>',
'postPurchaseRedirectUrl' => '<string>'
]),
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/products/{productID}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"imageObjectKey\": \"<string>\",\n \"guaranteeDays\": 18,\n \"accentColor\": \"<string>\",\n \"media\": [\n {\n \"objectKey\": \"<string>\",\n \"url\": \"<string>\",\n \"alt\": \"<string>\"\n }\n ],\n \"faq\": [\n {\n \"question\": \"<string>\",\n \"answer\": \"<string>\"\n }\n ],\n \"purchaseButtonText\": \"<string>\",\n \"postPurchaseRedirectUrl\": \"<string>\"\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/products/{productID}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"imageObjectKey\": \"<string>\",\n \"guaranteeDays\": 18,\n \"accentColor\": \"<string>\",\n \"media\": [\n {\n \"objectKey\": \"<string>\",\n \"url\": \"<string>\",\n \"alt\": \"<string>\"\n }\n ],\n \"faq\": [\n {\n \"question\": \"<string>\",\n \"answer\": \"<string>\"\n }\n ],\n \"purchaseButtonText\": \"<string>\",\n \"postPurchaseRedirectUrl\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.beinfi.com/products/{productID}")
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 \"description\": \"<string>\",\n \"imageObjectKey\": \"<string>\",\n \"guaranteeDays\": 18,\n \"accentColor\": \"<string>\",\n \"media\": [\n {\n \"objectKey\": \"<string>\",\n \"url\": \"<string>\",\n \"alt\": \"<string>\"\n }\n ],\n \"faq\": [\n {\n \"question\": \"<string>\",\n \"answer\": \"<string>\"\n }\n ],\n \"purchaseButtonText\": \"<string>\",\n \"postPurchaseRedirectUrl\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "prod_1d4YogBuw00jAySh5mbUpk",
"name": "<string>",
"type": "agent",
"pricingModel": "subscription",
"currency": "BRL",
"status": "active",
"guaranteeDays": 18,
"accentColor": "<string>",
"media": [
{
"type": "image",
"objectKey": "<string>",
"url": "<string>",
"alt": "<string>"
}
],
"faq": [
{
"question": "<string>",
"answer": "<string>"
}
],
"purchaseButtonText": "<string>",
"postPurchaseRedirectUrl": "<string>",
"draftSavedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"key": "<string>",
"description": "<string>",
"imageUrl": "<string>"
}{
"message": "<string>",
"error_code": "internal_error",
"tracer_id": "<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.
Headers
A unique key per operation (a UUID works). Retrying with the same key returns the original response.
Path Parameters
Product ID.
Pattern:
^prod_[0-9A-Za-z]{22}$Example:
"prod_1d4YogBuw00jAySh5mbUpk"
Body
application/json
Product name.
Product description. Omitting it or sending null clears the current one.
active or archived. Always send it.
Available options:
active, archived The objectKey returned by POST /catalog/images/presign. Absent keeps the current photo; "" removes it. Refused if the key was not issued for your account.
Required range:
7 <= x <= 30Maximum array length:
10Show child attributes
Show child attributes
Maximum array length:
20Show child attributes
Show child attributes
Maximum string length:
40Response
The updated product.
A catalog entry. Pricing lives on the product's versions.
Pattern:
^prod_[0-9A-Za-z]{22}$Example:
"prod_1d4YogBuw00jAySh5mbUpk"
item (default) or agent.
Available options:
agent, item How the product is charged: subscription, one_time, usage or prepaid.
Available options:
subscription, one_time, usage, prepaid 3-letter ISO 4217 code, such as BRL.
Example:
"BRL"
active or archived.
Example:
"active"
Required range:
7 <= x <= 30Pattern:
^#[0-9A-Fa-f]{6}$Show child attributes
Show child attributes
Show child attributes
Show child attributes
A stable key you choose for the product, unique in your account. Lets you create the same product again without duplicating it.
Public address of the product photo.