API ReferenceEndpointsProductsProducts

Products

Brainerce API reference: every products operation, with its method, path and a page of its own.

Products are the items sold in your store. Each product can be a simple SKU or a parent of multiple variants (size, color, …) — variants carry their own pricing and inventory. Products support modifiers (configurable options like engraving), tags, brands, categories, and SEO metadata. Use these endpoints to manage your catalogue and publish to sales channels.

Every operation below except one is on the public API under /v1 and takes Authorization: Bearer brainerce_*. The exception is POST /vc/{connectionId}/products/{productId}/review-photo, a storefront call made with the sales-channel id and a signed-in customer token, not an API key. The dashboard reads and writes products through its own internal routes (signed-in session); they are not part of the public contract and are not listed here.

Product metafield values live on Metafields, and product reviews on Product reviews.

Products operations

MethodEndpointOperation
POST/vc/{connectionId}/products/{productId}/review-photoUpload a review photo
GET/v1/productsList products with pagination
POST/v1/productsCreate a new product
GET/v1/products/{id}Get a single product by ID
PATCH/v1/products/{id}Update a product
DELETE/v1/products/{id}Delete a product
POST/v1/products/bulkCreate many products in one call (queued)
GET/v1/products/bulk/{jobId}Get bulk product creation status
GET/v1/products/bulk/import/{importId}Get aggregate status for a chunked import
GET/v1/products/bulk/{jobId}/errorsList per-product failures for a bulk create job
PATCH/v1/products/{id}/convert-to-variableConvert a SIMPLE product to VARIABLE
PATCH/v1/products/{id}/convert-to-simpleConvert a VARIABLE product back to SIMPLE
GET/v1/products/{id}/inventoryGet inventory for a product
PUT/v1/products/{id}/inventoryUpdate inventory for a product
POST/v1/products/{id}/variantsCreate a variant for a product
POST/v1/products/{id}/variants/bulkBulk save variants
PATCH/v1/products/{id}/variants/{variantId}Update a variant
DELETE/v1/products/{id}/variants/{variantId}Delete a variant
GET/v1/products/{id}/variants/{variantId}/inventoryGet variant inventory
PATCH/v1/products/{id}/variants/{variantId}/inventoryUpdate variant inventory
POST/v1/products/{id}/publish-sales-channelPublish a product to a sales-channel site
POST/v1/products/{id}/unpublish-sales-channelUnpublish a product from a sales-channel site