Create product · Bigblue Developers

POST/bigblue.storeapi.v1.PublicAPI/CreateProduct

Creates a product. There is no batch endpoint, so importing a catalogue takes one request per product. See the sync example.

Choose the id carefully. You can't change it, and it appears on orders, inbound shipments, inventory and webhooks.

Request body

productProductFormrequired

The product to create.

ProductForm

idstringrequired

Bigblue product ID. Must start with your tenant code.

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

namestringrequired

Product name.

1–128 characters

barcodestringrequired

EAN-13 or UPC-A barcode. Can't be empty.

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

valueValuerequired

Declared value, for example { "amount": "24.90", "currency": "EUR" }.

tariff_numberstringrequired

HS code.

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

origin_countrystringrequired

Country of manufacture.

Exactly 2 characters

skustring

Your own reference.

Up to 40 characters

descriptionstring

Internal description.

Up to 1,280 characters

optionsProductOption[]

Variant attributes.

customs_descriptionstring

Description for customs documents.

Up to 64 characters

name_translationsProductNameTranslation[]

Names in other languages.

track_lotsbooleandefault false

Store the product in lots. Can only be set here.

track_lot_expirybooleandefault false

Lots have an expiry date. Requires track_lots.

lot_expiry_threshold_daysintegerdefault 90

Days before expiry when a lot can no longer be sold. Can be negative.

non_returnablebooleandefault false

The product can't be returned.

foldablebooleandefault false

The product can be folded once.

already_packagedbooleandefault false

The product ships without extra packaging.

You can't send weight, width, height or depth. The warehouse measures them when it first receives the product.

Responses

200The product was created.

productProduct

The new product. Dimensions are missing until the warehouse measures it.

400A field is invalid, the barcode is empty, or the value can't be parsed.

{ "code": "invalid_argument", "msg": "barcode is required" }

409A product with this ID already exists.

{ "code": "already_exists", "msg": "product BGBL-ESPSRT-SMAL already exists" }

If you're retrying, the first request succeeded.

POST/bigblue.storeapi.v1.PublicAPI/CreateProduct

Request

{
  "product": {
    "id": "BGBL-ESPSRT-SMAL",
    "sku": "ESP-SHIRT-S",
    "name": "Espresso T-shirt, Small",
    "options": [{ "name": "Size", "value": "Small" }],
    "barcode": "3401579800127",
    "value": { "amount": "24.90", "currency": "EUR" },
    "tariff_number": "6109.10",
    "origin_country": "PT",
    "customs_description": "Cotton t-shirt",
    "foldable": true
  }
}

200

{
  "product": {
    "id": "BGBL-ESPSRT-SMAL",
    "sku": "ESP-SHIRT-S",
    "name": "Espresso T-shirt, Small",
    "options": [{ "name": "Size", "value": "Small" }],
    "barcode": "3401579800127",
    "value": { "amount": "24.9", "currency": "EUR" },
    "tariff_number": "6109.10",
    "origin_country": "PT",
    "customs_description": "Cotton t-shirt",
    "foldable": true
  }
}