Products

A product holds the barcode the warehouse scans, the declared value and customs data for international shipping, and flags that affect storage and packing.

A product isn't stock. Stock arrives through inbound shipments, and you read it through inventory.

Operations

Create product

Add a product to your catalogue.

Update product

Replace a product's details.

Get product

Get a product by its ID.

List products

List all products.

Delete product

Remove a product created by mistake.

The Product object

idstring

Bigblue product ID, starting with your tenant code. Example: BGBL-ESPSRT-SMAL. Can't be changed.

Pattern^[A-Za-z0-9]{4}-[A-Za-z0-9]{6}-[A-Za-z0-9]{4}$

skustring

Your own reference. Not used for lookups.

Up to 40 characters

namestring

Name shown in the Bigblue app and on packing documents.

Up to 128 characters

descriptionstring

Internal description. Not printed on labels.

Up to 1,280 characters

optionsProductOption[]

Variant attributes, such as size or color.

weightinteger

Weight in grams. Read-only. Measured by the warehouse when the product is first received.

widthinteger

Width in millimeters. Read-only. Measured by the warehouse.

heightinteger

Height in millimeters. Read-only. Measured by the warehouse.

depthinteger

Depth in millimeters. Read-only. Measured by the warehouse.

barcodestring

EAN-13 or UPC-A barcode. Must match the barcode on the item.

Pattern^([0-9]{12,13}|)$

valueValue

Declared value of one unit, used for customs and stock valuation.

tariff_numberstring

HS code, for example 6109.10.

Pattern^[0-9.]{6,16}$

origin_countrystring

Country of manufacture, ISO 3166-1 alpha-2.

Exactly 2 characters

customs_descriptionstring

Description of the goods for customs documents.

name_translationsProductNameTranslation[]

Product names in other languages, used on customer documents.

track_lotsbooleandefault false

Store the product in lots. Inbound shipment lines for it then need a lot code, and inventory is reported per lot.

track_lot_expirybooleandefault false

Lots have an expiry date, which inbound shipment lines must include. Requires track_lots.

lot_expiry_threshold_daysintegerdefault 90

Number of days before the expiry date when a lot can no longer be sold. A negative value lets the lot be sold for that many days after expiry. Requires track_lot_expiry.

non_returnablebooleandefault false

The product can't be returned, for example personalized items.

foldablebooleandefault false

The product can be folded once along its longest side, so it fits a smaller box.

already_packagedbooleandefault false

The product ships as is, without extra packaging.

ProductOption

namestringrequired

Attribute name, for example Size.

1–64 characters

valuestringrequired

Attribute value, for example Small.

1–64 characters

Value

amountstringrequired

Decimal amount as a string, for example "24.90". See Money.

At least 1 character

currencystringrequired

ISO 4217 code, for example EUR.

Exactly 3 characters

ProductNameTranslation

languagestringrequired

ISO 639-1 code. Stored in lowercase.

Exactly 2 characters

namestring

Product name in that language.

Up to 64 characters

Notes

Barcode is required

CreateProduct and UpdateProduct reject an empty barcode with invalid_argument. You can't create a product without a barcode through the API.

UpdateProduct doesn't change lot settings

track_lots, track_lot_expiry and lot_expiry_threshold_days are only applied when you create a product. To change them later, use the Bigblue app.

Dimensions are measured by the warehouse

You can't send weight, width, height or depth. They are missing from responses until the warehouse receives and measures the product.

To sell several products as one item, create a bundle.