Get product · Bigblue Developers

POST/bigblue.storeapi.v1.PublicAPI/GetProduct

Returns one product. You can only look up products by Bigblue id, not by sku or barcode. To find products by your own reference, list them with ListProducts and index them on your side.

Request body

idstringrequired

Bigblue product ID.

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

Responses

200The product.

productProduct

The product, including dimensions once measured.

400The ID doesn't match the product ID pattern.

{
  "code": "invalid_argument",
  "msg": "id value does not match regex pattern `^[[:alnum:]]{4}-[[:alnum:]]{6}-[[:alnum:]]{4}$`",
  "meta": { "argument": "id" }
}

404No product with this ID exists.

{ "code": "not_found", "msg": "product not found" }

POST/bigblue.storeapi.v1.PublicAPI/GetProduct

Request

{ "id": "BGBL-ESPSRT-SMAL" }

200

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