List products · Bigblue Developers

POST/bigblue.storeapi.v1.PublicAPI/ListProducts

Returns your products one page at a time. There are no filters. Bundles aren't included. Use ListBundles for them.

Request body

page_sizeintegerdefault 500

Products per page.

page_tokenstring

The next_page_token from the previous response. Leave empty for the first page.

Responses

200A page of products.

productsProduct[]

The products on this page.

next_page_tokenstring

Token for the next page. Missing on the last page.

POST/bigblue.storeapi.v1.PublicAPI/ListProducts

Request

{ "page_size": 100 }

200

{
  "products": [
    {
      "id": "BGBL-ESPSRT-SMAL",
      "sku": "ESP-SHIRT-S",
      "name": "Espresso T-shirt, Small",
      "weight": 210,
      "barcode": "3401579800127",
      "value": { "amount": "24.9", "currency": "EUR" }
    },
    {
      "id": "BGBL-ESPSRT-MEDI",
      "sku": "ESP-SHIRT-M",
      "name": "Espresso T-shirt, Medium",
      "weight": 225,
      "barcode": "3401579800134",
      "value": { "amount": "24.9", "currency": "EUR" }
    }
  ],
  "next_page_token": "ChgKFgoJcHJvZHVjdHMSCUJHQkwtRVNQ"
}

List every page

async function* allProducts() {
  let pageToken = '';
  do {
    const page = await call('ListProducts', { page_size: 250, page_token: pageToken });
    yield* page.products ?? [];
    pageToken = page.next_page_token ?? '';
  } while (pageToken);
}