bolcom

    2.1.1 • Public • Published

    bolcom

    Access the Bol.com Partner Open API with Node.js (unofficial)

    npm Build Status Coverage Status

    Usage

    const BolAPI = require ('bolcom');
    const bol = new BolAPI ({
      apikey: 'abc123',
    });
    
    bol.catalogSearch ({
      q: 'node.js',
    })
      .then (data => {
        for (let p in data.products) {
          product = data.products[p];
          console.log (`${product.title} - € ${product.offerData.offers[0].price}`);
        }
      })
      .catch (err => {
        console.log ('Search failed');
        console.log (err);
      })
    ;

    Requirements

    Installation

    npm install bolcom

    Methods

    Error handling is not included in the following examples. See the Usage section above for an example with proper error handling.

    ping

    ( )

    Simple API access test. The result data should be an object with only one property named message with the exact value Hello world!!.

    bol.ping().then (data => {
      if (data.Message === 'Hello World!') {
        console.log ('pong');
      }
      else {
        console.log ('ouch');
      }
    });

    catalogSearch

    ({ ... })

    Search products in the catalog.

    The result data is modified to remove a few xml-style annoyances.

    param type description
    ... object search paramaters
    bol.catalogSearch ({
      q: 'node.js',
    })
      .then (data => {
        for (let i in data.products) {
          let product = data.products[p];
          console.log (`${product.title} - ${product.summary}`);
        }
      })
    ;

    API documentation

    catalogLists

    ({ [...] })

    Product lists, based on list type and category.

    param type description
    [...] object Arguments, see API documentation
    bol.catalogLists()
      .then (data => data.products)
      .then (data => data.filter (itm => itm.rating >= 40))
      .then (data => data.forEach (itm => {
        console.log (`${itm.rating} - ${itm.title}`);
      }))
    ;

    API documentation

    catalogProducts

    ({ productId, [...] })

    Get details information for one or more products.

    param type description
    productId string Product ID
    [...] object Arguments, see API documentation
    bol.catalogProducts ({
      productId: '9200000023292527',
      includeattributes: true,
    })
      .then (data => {
        for (let p in data.products) {
          let product = data.products[p];
          console.log (`${product.title} - € ${product.offerData.offers[0].price}`);
        }
      })
    ;

    API documentation

    catalogOffers

    ({ productId, [...] })

    Get available offers for a given product.

    param type description
    productId string Product ID
    [...] object Arguments, see API documentation
    bol.catalogOffers ({
      productId: '9200000023292527',
    })
      .then (data => {
        for (let i in data.offers) {
          let offer = data.offers[i];
          console.log (`${offer.price} - ${offer.availabilityDescription}`);
        }
      })
    ;

    API documentation

    catalogRecommendations

    ({ productId, [...] })

    Get recommended products for a given product.

    param type description
    productId string Product ID
    [...] object Arguments, see API documentation
    bol.catalogRecommendations ({
      productId: '9200000023292527',
    })
      .then (data => {
        for (let i in data) {
          let product = data[i];
          console.log (`${product.title} - ${product.rating}`);
        }
      })
    ;

    API documentation

    catalogRelatedproducts

    ({ productId, [...] })

    Get related products for a given product.

    param type description
    productId string Product ID
    [...] object Arguments, see API documentation
    bol.catalogRelatedProducts ({
      productId: '9200000010839998',
    })
      .then (console.log)
    ;

    API documentation

    searchSuggestions

    ({ term, [xcat] })

    Get search suggestions for a keyword.

    param type default description
    term string Keyword to search on
    [xcat] string media_all Category, see docs
    bol.searchSuggestions ({
      term: 'potter',
      xcat: 'books_en',
    })
      .then (console.table)
    ;

    API documentation

    Errors

    message description
    missing apikey Credentials are not set

    Unlicense

    This is free and unencumbered software released into the public domain.

    Anyone is free to copy, modify, publish, use, compile, sell, or distribute this software, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.

    In jurisdictions that recognize copyright laws, the author or authors of this software dedicate any and all copyright interest in the software to the public domain. We make this dedication for the benefit of the public at large and to the detriment of our heirs and successors. We intend this dedication to be an overt act of relinquishment in perpetuity of all present and future rights to this software under copyright law.

    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

    For more information, please refer to https://unlicense.org/

    Author

    Franklin | Buy me a coffee

    Install

    npm i bolcom

    DownloadsWeekly Downloads

    9

    Version

    2.1.1

    License

    Unlicense

    Unpacked Size

    16.6 kB

    Total Files

    4

    Last publish

    Collaborators

    • franklin