bol-api v0.1.1

Bol API

API functions for bol.com sellers v7 api: https://api.bol.com/retailer/public/redoc/v7/retailer.html Let me know if you require any additional functions.

Installation

NPM

Use the package manager npm to install bol-api.

npm i bol-api

Usage

Initialization

const Bol = require('bol-api'),
      bol = new Bol(API_KEY, API_SECRET);

Pause offer

https://api.bol.com/retailer/public/redoc/v7/retailer.html#operation/put-offer

let offer_id = "",
    pause = true,
    method = "FBR", // "FBR" OR "FBB" (see docs)
    tries = 3; // default
await bol.pause(offer_id, pause, method, tries);

Set stock

https://api.bol.com/retailer/public/redoc/v7/retailer.html#operation/update-offer-price

let offer_id = "",
    stock = 123, // max = 999
    managedByRetailer = true,
    tries = 3; // default
await bol.stock(offer_id, stock, tries);

Set delivery

https://api.bol.com/retailer/public/redoc/v7/retailer.html#operation/put-offer

let offer_id = "",
    fulfilment = {method: "FBR", deliveryCode: "1-2d"}, // see docs for all codes
    tries = 3; // default
await bol.delivery(offer_id, fulfilment, tries);

Offer export

https://api.bol.com/retailer/public/redoc/v7/retailer.html#operation/get-offer-export Please note this is blocking code, resolves once bol servers return csv export. Automatically converted to JSON format.

let tries = 3; // default
await bol.export(tries);
/* returns csv in JSON format
  [{
    offerId: '',
    ean: '',
    conditionName: 'NEW',
    conditionCategory: 'NEW',
    conditionComment: '',
    bundlePricesPrice: '29.95',
    fulfilmentDeliveryCode: '4-8d',
    stockAmount: '999',
    onHoldByRetailer: 'false',
    fulfilmentType: 'FBR',
    mutationDateTime: '2022-09-20 15:08:15.519 UTC',
    referenceCode: ''
  }]
*/

Get orders

https://api.bol.com/retailer/public/redoc/v7/retailer.html#operation/get-orders

let page = 1,
    status = "ALL", // "OPEN" || "ALL"
    tries = 3; // default
await bol.orders(page, status, tries);
/* returns array
  [{
    orderId: '',
    orderPlacedDateTime: '2022-12-30T20:24:09+01:00',
    orderItems: [ [Object] ]
  }]
*/

Order detail

https://api.bol.com/retailer/public/redoc/v7/retailer.html#operation/get-order

let order_id = "",
    tries = 3; // default
await bol.detail(order_id, tries);

Set price

https://api.bol.com/retailer/public/redoc/v7/retailer.html#operation/update-offer-price Currently no bundlePrices support please open a issue if you would like to see this feature.

let offer_id = "",
    price = 19.99,
    tries = 3; // default
await bol.price(offer_id, price, tries);

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

License

MIT