Skip to main content
PATCH

Authorizations

Authorization
string
header
required

Token returned by POST /auth/token, sent as Authorization: Bearer <token>.

Path Parameters

id
integer
required

Cubbo product id, as returned by GET /inventory or POST /products.

Body

application/json

Body of PATCH /products/{id}. Every field is optional; only the fields sent are changed.

name
string

New product name. Must not be blank.

Example:

"Widget Pro Black v2"

description
string

New description; HTML is allowed.

Example:

"<p>Updated description.</p>"

bar_code
string

New barcode (UPC/EAN). Must be unique within the store. Rejected when the product has stock.

Example:

"7501234567899"

price
number

New unit price. Up to 8 significant digits. A non-numeric value is stored as 0.

Example:

109.99

skus
string[]

Replaces the full SKU list. Rejected when the product has stock. An empty array is ignored.

Example:
product_image
object

An image sent inline as base64. PNG or JPEG, at most 5 MB decoded; the base64 payload may not exceed 10485760 bytes.

weight
number

New unit weight, in weight_unit. Stored in kilograms. Must be at least 0.01.

Required range: x >= 0.01
Example:

750

weight_unit
string

Unit of weight. g or gr is converted to kilograms; any other value is stored as sent.

Example:

"g"

length
number

Package length in dimension_unit, between 0.01 and 999999.99.

Required range: 0.01 <= x <= 999999.99
Example:

12.5

width
number

Package width in dimension_unit, between 0.01 and 999999.99.

Required range: 0.01 <= x <= 999999.99
Example:

7

height
number

Package height in dimension_unit, between 0.01 and 999999.99.

Required range: 0.01 <= x <= 999999.99
Example:

3

dimension_unit
enum<string>

Unit of the dimensions.

Available options:
cm,
mm,
in,
m
Example:

"cm"

Response

Product updated.

Full product representation, as used by the Cubbo app. Returned by PATCH /products/{id} and, as an array, by POST /products with variants.

id
integer
required

Cubbo product id.

Example:

12345

name
string
required

Product name.

Example:

"Widget Pro Black"

is_kit
boolean
required

The product is a kit (bundle).

Example:

false

product_codes
object[]
required

SKUs registered for the product, with timestamps.

billing_name
string | null

Name printed on invoices.

Example:

null

description
string | null

Product description (may contain HTML).

Example:

"<p>A professional-grade widget.</p>"

has_imei
boolean

Each unit is identified by an IMEI.

Example:

false

requires_unit_code
boolean

Each unit is identified by a unique code (serial).

Example:

false

allow_unit_code_substitution
boolean

A reserved unit may be swapped for another unit of the same product at picking.

Example:

false

personalized_units
boolean | null

Units are personalized per order.

Example:

false

is_fragile
boolean

Requires fragile handling.

Example:

false

bar_code
string | null

Barcode (UPC/EAN).

Example:

"7501234567890"

is_dropshipping
boolean

Fulfilled by dropshipping.

Example:

false

has_expiration
boolean | null

Stock is tracked by lot with expiration dates.

Example:

true

freshness
integer | null

Minimum shelf life in days at receiving.

Example:

180

stock
object | null

Aggregate stock (without the LOST and by-source keys). Null for a product that has never had stock.

full_name
string

Product name including the parent name for variants.

Example:

"Widget Pro Black"

is_scannable
boolean

Units can be scanned at picking.

Example:

true

product_image_path
string | null

URL of the product image, when one is attached.

Example:

null

price
string | null

Unit price, as a decimal string.

Example:

"99.99"

weight
number | null

Unit weight in weight_unit.

Example:

0.5

weight_unit
string | null

Unit of weight.

Example:

"kg"

origin
string | null

Brazil only. Fiscal origin of the goods.

Example:

"NATIONAL"

buffer_stock
integer | null

Safety stock excluded from availability.

Example:

null

is_packageless
boolean

Ships without additional packaging.

Example:

false

length
string | null

Package length, as a decimal string.

Example:

"10.0"

width
string | null

Package width, as a decimal string.

Example:

"8.0"

height
string | null

Package height, as a decimal string.

Example:

"5.0"

dimension_unit
enum<string>

Unit of the dimensions.

Available options:
cm,
mm,
in,
m
Example:

"cm"

extipi
string

Brazil only. IPI exception code. Present only when set.

Example:

"001"

fci_key
string

Brazil only. FCI key. Present only when set.

Example:

"00000000-0000-0000-0000-000000000000"

is_discarded
boolean

The product has been removed from the catalog.

Example:

false

kit_childs
object[]

Components of the kit. Empty unless is_kit is true.

store
object

Store that owns the product. Carries the store's id and name plus its configuration fields.

ncm_configuration
object | null

Brazil only. The NCM fiscal configuration linked to the product (id, ncm, description and the tax rates and CFOP codes used on the NF-e). Null when none is linked.