Upsert products

curl --request POST \
  --url https://api.vambe.me/api/public/product/upsert/{promptBlockId} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '
[
  {
    "name": "<string>",
    "description": "<string>",
    "price": 1,
    "external_id": "<string>",
    "metadata": [
      {
        "key": "<string>",
        "value": "<string>"
      }
    ],
    "file_url": "<string>",
    "sku": "<string>"
  }
]
'

const options = {
  method: 'POST',
  headers: {'x-api-key': '<x-api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify([
    {
      name: '<string>',
      description: '<string>',
      price: 1,
      external_id: '<string>',
      metadata: [{key: '<string>', value: '<string>'}],
      file_url: '<string>',
      sku: '<string>'
    }
  ])
};

fetch('https://api.vambe.me/api/public/product/upsert/{promptBlockId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.vambe.me/api/public/product/upsert/{promptBlockId}"

payload = [
    {
        "name": "<string>",
        "description": "<string>",
        "price": 1,
        "external_id": "<string>",
        "metadata": [
            {
                "key": "<string>",
                "value": "<string>"
            }
        ],
        "file_url": "<string>",
        "sku": "<string>"
    }
]
headers = {
    "x-api-key": "<x-api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

POST

api

public

product

upsert

{promptBlockId}

Upsert products

curl --request POST \
  --url https://api.vambe.me/api/public/product/upsert/{promptBlockId} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '
[
  {
    "name": "<string>",
    "description": "<string>",
    "price": 1,
    "external_id": "<string>",
    "metadata": [
      {
        "key": "<string>",
        "value": "<string>"
      }
    ],
    "file_url": "<string>",
    "sku": "<string>"
  }
]
'

const options = {
  method: 'POST',
  headers: {'x-api-key': '<x-api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify([
    {
      name: '<string>',
      description: '<string>',
      price: 1,
      external_id: '<string>',
      metadata: [{key: '<string>', value: '<string>'}],
      file_url: '<string>',
      sku: '<string>'
    }
  ])
};

fetch('https://api.vambe.me/api/public/product/upsert/{promptBlockId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.vambe.me/api/public/product/upsert/{promptBlockId}"

payload = [
    {
        "name": "<string>",
        "description": "<string>",
        "price": 1,
        "external_id": "<string>",
        "metadata": [
            {
                "key": "<string>",
                "value": "<string>"
            }
        ],
        "file_url": "<string>",
        "sku": "<string>"
    }
]
headers = {
    "x-api-key": "<x-api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

Overview

Synchronize your entire product catalog with a product block. This endpoint creates new products, updates existing ones, and deletes products not in the request - providing a complete catalog sync. ⚠️ Important: Products not included in the request will be deleted from the block.

Use Cases

Full Catalog Sync: Replace entire catalog with current inventory
Nightly Sync: Complete synchronization from e-commerce platform
Inventory Management: Ensure only available products are in catalog
Clean Sync: Remove discontinued products automatically

Authentication

x-api-key: your_api_key_here

Path Parameters

Parameter	Type	Required	Description
`promptBlockId`	string	Yes	Product block ID to synchronize

Request Body

Array of product objects (no limit):

Field	Type	Required	Description
`name`	string	Yes	Product name
`description`	string	Yes	Natural language description for AI (max 8192)
`price`	number	Yes	Product price (positive number)
`currency`	string	Yes	Currency code
`type`	string	Yes	PRODUCT or SERVICE
`external_id`	string	Yes	Your unique identifier
`file_url`	string	No	Product image URL
`sku`	string	No	Product SKU. Falls back to `sku` key in metadata
`metadata`	array	Yes	Additional product data as key-value pairs

⚠️ DELETES PRODUCTS: Any products in the block that are NOT in this request will be permanently deleted.

Example Request

curl --request POST \
  'https://api.vambe.me/api/public/product/upsert/block-abc123' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: your_api_key_here' \
  --data-raw '[
    {
      "name": "Laptop Pro",
      "description": "High-performance laptop for professionals. 16GB RAM, 512GB SSD, Intel i7 processor. Perfect for development and creative work.",
      "price": 1299.99,
      "currency": "USD",
      "type": "PRODUCT",
      "external_id": "laptop-pro-001",
      "file_url": "https://shop.com/laptop.jpg",
      "sku": "LAPTOP-PRO-001",
      "metadata": [
        { "key": "brand", "value": "TechBrand" },
        { "key": "ram", "value": "16GB" },
        { "key": "storage", "value": "512GB" }
      ]
    }
  ]'

Behavior

What Happens

Creates: Products with new external_id are created
Updates: Products with existing external_id are updated
Deletes: Products in block but NOT in request are deleted
AI Embeddings: All products are re-indexed for AI search

Example Scenario

Before: Block has products A, B, C Request: Send products B (updated), D (new) After: Block has products B (updated), D (new) Deleted: Products A and C

Error Responses

Status Code	Description
400	Bad Request - Invalid data
401	Unauthorized
403	Forbidden
404	Product block not found
500	Internal Server Error

POST /api/public/product/create/ - Add without deleting
POST /api/public/product/delete/ - Delete specific products
GET /api/public/product/product-blocks - List blocks

Headers

x-api-key

string

required

API key needed to authorize the request

Path Parameters

promptBlockId

string

required

The prompt block ID to upsert the products

Body

application/json

The payload to send with the products

name

string

required

Minimum string length: 1

description

string

required

In the description you only need to add words that help the AI do a semantic search, avoide placing here prices, links or other type of data that is not natural language

Required string length: 1 - 8192

type

enum<string>

required

Available options:

shopify,

vambe,

woocommerce,

axis,

vtex,

jumpseller,

odoo,

tiendanube,

magento,

mercado_libre,

custom_app

currency

enum<string>

required

Available options:

CLP,

USD,

MXN,

BRL,

UF,

ARS,

COP,

UYU,

PEN,

EUR,

HNL,

BOB,

PYG,

GTQ,

NIO,

PAB,

CRC,

DOP,

VES,

BZD,

SRD,

GYD

price

number

required

Required range: x > 0

external_id

string

required

metadata

object[]

required

Show child attributes

file_url

string

sku

string

Response

Products upserted successfully.

⌘I

​Overview

​Use Cases

​Authentication

​Path Parameters

​Request Body

​Example Request

​Behavior

​What Happens

​Example Scenario

​Error Responses

​Related Endpoints

Headers

Path Parameters

Body

Response

Overview

Use Cases

Authentication

Path Parameters

Request Body

Example Request

Behavior

What Happens

Example Scenario

Error Responses

Related Endpoints