{"id":21297511,"url":"https://github.com/fvdm/nodejs-bolcom","last_synced_at":"2025-07-11T18:32:32.836Z","repository":{"id":19797647,"uuid":"23057275","full_name":"fvdm/nodejs-bolcom","owner":"fvdm","description":"[DEPRECATED] Unofficial node.js wrapper for the bol.com API","archived":true,"fork":false,"pushed_at":"2022-05-30T11:49:45.000Z","size":221,"stargazers_count":5,"open_issues_count":0,"forks_count":2,"subscribers_count":3,"default_branch":"develop","last_synced_at":"2025-03-26T13:29:25.262Z","etag":null,"topics":["api","bol","catalog","nodejs","unlicense"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/bolcom","language":"JavaScript","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"unlicense","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/fvdm.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"custom":"https://fvdm.com/donating/"}},"created_at":"2014-08-18T03:22:15.000Z","updated_at":"2024-01-10T23:32:09.000Z","dependencies_parsed_at":"2022-07-12T15:17:27.278Z","dependency_job_id":null,"html_url":"https://github.com/fvdm/nodejs-bolcom","commit_stats":null,"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"purl":"pkg:github/fvdm/nodejs-bolcom","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fvdm%2Fnodejs-bolcom","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fvdm%2Fnodejs-bolcom/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fvdm%2Fnodejs-bolcom/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fvdm%2Fnodejs-bolcom/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fvdm","download_url":"https://codeload.github.com/fvdm/nodejs-bolcom/tar.gz/refs/heads/develop","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fvdm%2Fnodejs-bolcom/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":264870619,"owners_count":23676277,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","bol","catalog","nodejs","unlicense"],"created_at":"2024-11-21T14:38:00.981Z","updated_at":"2025-07-11T18:32:32.578Z","avatar_url":"https://github.com/fvdm.png","language":"JavaScript","funding_links":["https://fvdm.com/donating/"],"categories":[],"sub_categories":[],"readme":"# bolcom\n\nAccess the Bol.com Partner Open API with Node.js (unofficial)\n\n\u003e **[Deprecation announcement](https://github.com/fvdm/nodejs-bolcom/issues/28)**\n\n[![npm](https://img.shields.io/npm/v/bolcom.svg?maxAge=3600)](https://github.com/fvdm/nodejs-bolcom/blob/master/CHANGELOG.md)\n[![Build Status](https://github.com/fvdm/nodejs-bolcom/actions/workflows/node.js.yml/badge.svg?branch=master)](https://github.com/fvdm/nodejs-bolcom/actions/workflows/node.js.yml)\n[![Coverage Status](https://coveralls.io/repos/github/fvdm/nodejs-bolcom/badge.svg?branch=master)](https://coveralls.io/github/fvdm/nodejs-bolcom?branch=master)\n\n* [Node.js](https://nodejs.org/)\n* [Bol.com](https://bol.com/)\n* [API documentation](https://partnerblog.bol.com/documentatie/open-api/)\n\n\n## Usage\n\n```js\nconst BolAPI = require ('bolcom');\nconst bol = new BolAPI ({\n  apikey: 'abc123',\n});\n\nbol.catalogSearch ({\n  q: 'node.js',\n})\n  .then (data =\u003e {\n    for (let p in data.products) {\n      product = data.products[p];\n      console.log (`${product.title} - € ${product.offerData.offers[0].price}`);\n    }\n  })\n  .catch (err =\u003e {\n    console.log ('Search failed');\n    console.log (err);\n  })\n;\n```\n\n\n## Requirements\n\n* [node.js](https://nodejs.org)\n* Bol.com API key ([read here](https://partnerblog.bol.com/documentatie/open-api/aan-de-slag-2/)) (Dutch)\n\n\n## Installation\n\n`npm install bolcom`\n\n\n## Methods\n\nError handling is not included in the following examples.\nSee the [Usage](#usage) section above for an example with proper error handling.\n\n\n### ping\n**( )**\n\nSimple API access test. The result `data` should be an _object_ with only one\nproperty named `message` with the exact value `Hello world!!`.\n\n\n```js\nbol.ping().then (data =\u003e {\n  if (data.Message === 'Hello World!') {\n    console.log ('pong');\n  }\n  else {\n    console.log ('ouch');\n  }\n});\n```\n\n\n### catalogSearch\n**({ ... })**\n\nSearch products in the catalog.\n\nThe result `data` is modified to remove a few xml-style annoyances.\n\n\nparam  | type   | description\n:------|:-------|:-----------\n...    | object | search paramaters\n\n\n```js\nbol.catalogSearch ({\n  q: 'node.js',\n})\n  .then (data =\u003e {\n    for (let i in data.products) {\n      let product = data.products[p];\n      console.log (`${product.title} - ${product.summary}`);\n    }\n  })\n;\n```\n\n[API documentation](https://partnerblog.bol.com/documentatie/open-api/handleiding/api-requests/catalog/get-catalogv4search/)\n\n\n### catalogLists\n**({ [...] })**\n\nProduct lists, based on list type and category.\n\n\nparam | type   | description\n:-----|:-------|:-----------\n[...] | object | Arguments, see API documentation\n\n\n```js\nbol.catalogLists()\n  .then (data =\u003e data.products)\n  .then (data =\u003e data.filter (itm =\u003e itm.rating \u003e= 40))\n  .then (data =\u003e data.forEach (itm =\u003e {\n    console.log (`${itm.rating} - ${itm.title}`);\n  }))\n;\n```\n\n[API documentation](https://partnerblog.bol.com/documentatie/open-api/handleiding/api-requests/catalog/get-catalogv4lists/)\n\n\n### catalogProducts\n**({ productId, [...] })**\n\nGet details information for one or more products.\n\n\nparam     | type     | description\n:---------|:---------|:-----------\nproductId | string   | Product ID\n[...]     | object   | Arguments, see API documentation\n\n\n```js\nbol.catalogProducts ({\n  productId: '9200000023292527',\n  includeattributes: true,\n})\n  .then (data =\u003e {\n    for (let p in data.products) {\n      let product = data.products[p];\n      console.log (`${product.title} - € ${product.offerData.offers[0].price}`);\n    }\n  })\n;\n```\n\n[API documentation](https://partnerblog.bol.com/documentatie/open-api/handleiding/api-requests/catalog/get-catalogv4products/)\n\n\n### catalogRecommendations\n**({ productId, [...] })**\n\nGet recommended products for a given product.\n\n\nparam     | type   | description\n:---------|:-------|:-----------\nproductId | string | Product ID\n[...]     | object | Arguments, see API documentation\n\n\n```js\nbol.catalogRecommendations ({\n  productId: '9200000023292527',\n})\n  .then (data =\u003e {\n    for (let i in data) {\n      let product = data[i];\n      console.log (`${product.title} - ${product.rating}`);\n    }\n  })\n;\n```\n\n[API documentation](https://partnerblog.bol.com/documentatie/open-api/handleiding/api-requests/catalog/get-catalogv4recommendations/)\n\n\n### catalogRelatedproducts\n**({ productId, [...] })**\n\nGet related products for a given product.\n\n\nparam     | type   | description\n:---------|:-------|:-----------\nproductId | string | Product ID\n[...]     | object | Arguments, see API documentation\n\n\n```js\nbol.catalogRelatedProducts ({\n  productId: '9200000010839998',\n})\n  .then (console.log)\n;\n```\n\n[API documentation](https://partnerblog.bol.com/documentatie/open-api/handleiding/api-requests/catalog/get-catalogv4relatedproducts/)\n\n\n## Errors\n\nmessage        | description\n:--------------|:-----------\nmissing apikey | Credentials are not set\n\n\n## Unlicense\n\nThis is free and unencumbered software released into the public domain.\n\nAnyone is free to copy, modify, publish, use, compile, sell, or\ndistribute this software, either in source code form or as a compiled\nbinary, for any purpose, commercial or non-commercial, and by any\nmeans.\n\nIn jurisdictions that recognize copyright laws, the author or authors\nof this software dedicate any and all copyright interest in the\nsoftware to the public domain. We make this dedication for the benefit\nof the public at large and to the detriment of our heirs and\nsuccessors. We intend this dedication to be an overt act of\nrelinquishment in perpetuity of all present and future rights to this\nsoftware under copyright law.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND,\nEXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF\nMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.\nIN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR\nOTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,\nARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR\nOTHER DEALINGS IN THE SOFTWARE.\n\nFor more information, please refer to \u003chttps://unlicense.org/\u003e\n\n\n## Author\n\n[Franklin](https://fvdm.com)\n| [Buy me a coffee](https://fvdm.com/donating)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffvdm%2Fnodejs-bolcom","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffvdm%2Fnodejs-bolcom","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffvdm%2Fnodejs-bolcom/lists"}