PHPackages                             deniztezcan/laravel-bolcom-retailer-api - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. deniztezcan/laravel-bolcom-retailer-api

ActiveLibrary[API Development](/categories/api)

deniztezcan/laravel-bolcom-retailer-api
=======================================

Laravel package for the Bol.com v5 Retailer API

2.3.1(2y ago)2452MITPHP

Since Mar 18Pushed 2y ago3 watchersCompare

[ Source](https://github.com/deniztezcan/laravel-bolcom-retailer-api)[ Packagist](https://packagist.org/packages/deniztezcan/laravel-bolcom-retailer-api)[ Docs](https://github.com/deniztezcan/laravel-bolcom-retailer-api)[ RSS](/packages/deniztezcan-laravel-bolcom-retailer-api/feed)WikiDiscussions master Synced 2d ago

READMEChangelog (10)Dependencies (3)Versions (20)Used By (0)

Laravel Bol.com Retailer v5 API
===============================

[](#laravel-bolcom-retailer-v5-api)

[![Latest Stable Version](https://camo.githubusercontent.com/82b5231717d815a9ef89ace107feb9bb6f615835c09eaeb613a86be7d4006069/68747470733a2f2f706f7365722e707567782e6f72672f64656e697a74657a63616e2f6c61726176656c2d626f6c636f6d2d72657461696c65722d6170692f762f737461626c65)](https://packagist.org/packages/deniztezcan/laravel-bolcom-retailer-api)[![Total Downloads](https://camo.githubusercontent.com/44ed93339ab12ba4e9a8685084211141e08144621078f93ffeb32d4aea046729/68747470733a2f2f706f7365722e707567782e6f72672f64656e697a74657a63616e2f6c61726176656c2d626f6c636f6d2d72657461696c65722d6170692f646f776e6c6f616473)](https://packagist.org/packages/deniztezcan/laravel-bolcom-retailer-api)[![Latest Unstable Version](https://camo.githubusercontent.com/fa14002b2060cffe0937e5bd38773e5fa371f08a35095839ac4e1cab17802d8a/68747470733a2f2f706f7365722e707567782e6f72672f64656e697a74657a63616e2f6c61726176656c2d626f6c636f6d2d72657461696c65722d6170692f762f756e737461626c65)](https://packagist.org/packages/deniztezcan/laravel-bolcom-retailer-api)[![License](https://camo.githubusercontent.com/9674e08e86005d2ae4f96abcb903d1dafd5103f08526bfabfa24552fb167f394/68747470733a2f2f706f7365722e707567782e6f72672f64656e697a74657a63616e2f6c61726176656c2d626f6c636f6d2d72657461696c65722d6170692f6c6963656e7365)](https://packagist.org/packages/deniztezcan/laravel-bolcom-retailer-api)[![Maintainability](https://camo.githubusercontent.com/e66fccf34b45d63710648c27243b93c9b574ddc11016d3c376125ba3aded4174/68747470733a2f2f6170692e636f6465636c696d6174652e636f6d2f76312f6261646765732f39303537623739383535666363303239663938392f6d61696e7461696e6162696c697479)](https://codeclimate.com/github/deniztezcan/laravel-bolcom-retailer-api/maintainability)

A Laravel package for the Bol.com v5 Retailer API. Losely based on the incomplete `jasperverbeet/bolcom-retailer-api-v3-php` package.

Instalation
-----------

[](#instalation)

```
composer require deniztezcan/laravel-bolcom-retailer-api

```

Add a ServiceProvider to your providers array in `config/app.php`:

```
    'providers' => [
    	//other things here

    	DenizTezcan\BolRetailer\BolServiceProvider::class,
    ];
```

Add the facade to the facades array:

```
    'aliases' => [
    	//other things here

    	'BolRetailerAPI' => DenizTezcan\BolRetailer\Facades\BolRetailerAPI::class,
    ];
```

Finally, publish the configuration files:

```
php artisan vendor:publish --provider="DenizTezcan\BolRetailer\BolServiceProvider"

```

### Configuration

[](#configuration)

Please set your API: `key` and `secret` in the `config/bolcom-retailer.php`

How to use
----------

[](#how-to-use)

- [Commission](#commission)
    - [Bulk](#bulk)
    - [Single](#single)
- [Offers](#offers)
    - [Create](#create)
    - [CSV dump](#csv-dump)
    - [Get Offer by Offer ID](#get-offer-by-offer-ID)
    - [Update offer price](#Update-offer-price)
    - [Update fulfilment promise](#Update-fulfilment-promise)
    - [Update offer stock](#Update-offer-stock)
- [Orders](#orders)
    - [Get open orders](#Get-open-orders)
    - [Get order by order-id](#Get-order-by-order-id)
    - [Cancel order by order-item-id](#Cancel-order-by-order-item-id)
    - [Ship order by order-item-id](#Ship-order-by-order-item-id)
- [All features](#features)

### Commission

[](#commission)

#### Bulk

[](#bulk)

To get commissions in bulk, we need to send EANs in bulk.

```
$request = BolRetailerAPI::commissions()->getCommissions([['ean' => '3615674428738'], ['ean' => '0958054542376'], ['ean' => '1863180850327']]);
$commissions = $request->commissions;
```

#### Single

[](#single)

To get commissions for the single EAN.

```
$commission = BolRetailerAPI::commissions()->getCommission('3615674428738');
```

### Offers

[](#offers)

#### Create

[](#create)

It is possible to create an offer via the v3 api

```
BolRetailerAPI::offers()->createOffer(
	$ean,
	$conditionName, //  "NEW" "AS_NEW" "GOOD" "REASONABLE" "MODERATE",
	$conditionCategory, // "NEW" "SECONDHAND"
	$referenceCode, // Your internal SKU or other ID
	$onHoldByRetailer,
	$unknownProductTitle,
	$price,
	$stockAmount,
	$stockManagedByRetailer, //False incase you want Bol to remove the stock automatically from their system based on orders
	$fulfilmentType, //"FBB" "FBR" (FBB - Fulfilment By Bol) (FBR - Fulfilment by Retailer)
	$fulfilmentDeliveryCode //"24uurs-23" "24uurs-22" "24uurs-21" "24uurs-20" "24uurs-19" "24uurs-18" "24uurs-17" "24uurs-16" "24uurs-15" "24uurs-14" "24uurs-13" "24uurs-12" "1-2d" "2-3d" "3-5d" "4-8d" "1-8d" "MijnLeverbelofte"
);
```

#### CSV dump

[](#csv-dump)

To get a list of all offers you have in CSV

```
$event = BolRetailerAPI::offers()->requestDump();
sleep(120); //it takes some time for bol to generate the CSV a sleep is needed to make sure the CSV is ready
$csv = BolRetailerAPI::offers()->handleDumpRequest((string) $event->entityId);
```

#### Get Offer by Offer ID

[](#get-offer-by-offer-id)

You can get a specific offers by it's offer id

```
$offer = BolRetailerAPI::offers()->getOffer($offerId);
```

#### Update fulfilment promise

[](#update-fulfilment-promise)

You can update the fulfilment promise of an offer by it's offer id

```
BolRetailerAPI::offers()->updateOffer(
	$offerId,
	$referenceCode,
	$onHoldByRetailer,
	$unknownProductTitle,
	$fulfilmentType, //"FBB" "FBR" (FBB - Fulfilment By Bol) (FBR - Fulfilment by Retailer)
	$fulfilmentDeliveryCode //"24uurs-23" "24uurs-22" "24uurs-21" "24uurs-20" "24uurs-19" "24uurs-18" "24uurs-17" "24uurs-16" "24uurs-15" "24uurs-14" "24uurs-13" "24uurs-12" "1-2d" "2-3d" "3-5d" "4-8d" "1-8d" "MijnLeverbelofte"
);
```

#### Update offer price

[](#update-offer-price)

You can update the price of an offer by it's offer id

```
BolRetailerAPI::offers()->updateOfferPrice(
	$offerId,
	[
		[
			'quantity' => 1,
			'price' => 1.00
		]
	]
);
```

#### Update offer stock

[](#update-offer-stock)

You can update the stock of an offer by it's offer id

```
BolRetailerAPI::offers()->updateOfferStock(
	$offerId,
	$amount,
	$managedByRetailer
);
```

### Orders

[](#orders)

#### Get open orders

[](#get-open-orders)

```
$orders = BolRetailerAPI::orders()->getOrders();
```

#### Get order by order-id

[](#get-order-by-order-id)

```
$order = BolRetailerAPI::orders()->getOrder($orderId);
```

#### Cancel order by order-item-id

[](#cancel-order-by-order-item-id)

```
BolRetailerAPI::orders()->cancelOrderItem(
	$orderItemId,
	$reasonCode //"OUT_OF_STOCK" "REQUESTED_BY_CUSTOMER" "BAD_CONDITION" "HIGHER_SHIPCOST" "INCORRECT_PRICE" "NOT_AVAIL_IN_TIME" "NO_BOL_GUARANTEE" "ORDERED_TWICE" "RETAIN_ITEM" "TECH_ISSUE" "UNFINDABLE_ITEM" "OTHER"
);
```

#### Ship order by order-item-id

[](#ship-order-by-order-item-id)

```
BolRetailerAPI::orders()->cancelOrderItem(
	$shipOrderItem,
	$shipmentReference, //optional only for internal purposes
	$transporterCode, // TNT for PostNL
	$trackAndTrace, // Track and Trace number
);
```

Features
--------

[](#features)

The following features are available (an - means the feature is planned, but not yet included):

MethodURIFrom VersionLink to Bol documentationPOST/retailer/commissionv1.1.0[link](https://api.bol.com/retailer/public/redoc/v5#operation/get-commissions)GET/retailer/commission/{ean}v1.0.0[link](https://api.bol.com/retailer/public/redoc/v5#operation/get-commission)POST/retailer/offersv1.1.0[link](https://api.bol.com/retailer/public/redoc/v5#operation/post-offer)POST/retailer/offers/exportv1.3.0[link](https://api.bol.com/retailer/public/redoc/v5#operation/post-offer-export)GET/retailer/offers/export/{offer-export-id}v1.3.0[link](https://api.bol.com/retailer/public/redoc/v5#operation/get-offer-export)GET/retailer/offers/{offer-id}v1.1.0[link](https://api.bol.com/retailer/public/redoc/v5#operation/get-offer)PUT/retailer/offers/{offer-id}v1.0.0[link](https://api.bol.com/retailer/public/redoc/v5#operation/put-offer)PUT/retailer/offers/{offer-id}/pricev1.0.0[link](https://api.bol.com/retailer/public/redoc/v5#operation/update-offer-price)PUT/retailer/offers/{offer-id}/stockv1.0.0[link](https://api.bol.com/retailer/public/redoc/v5#operation/update-offer-stock)GET/retailer/ordersv1.0.0[link](https://api.bol.com/retailer/public/redoc/v5#operation/get-orders)GET/retailer/orders/{orders-id}v1.0.0[link](https://api.bol.com/retailer/public/redoc/v5#operation/get-order)PUT/retailer/orders/{order-item-id}/cancellationv1.1.0[link](https://api.bol.com/retailer/public/redoc/v5#operation/cancel-order)PUT/retailer/orders/{order-item-id}/shipmentv1.0.0[link](https://api.bol.com/retailer/public/redoc/v5#operation/ship-order-item)

###  Health Score

30

—

LowBetter than 64% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity12

Limited adoption so far

Community10

Small or concentrated contributor base

Maturity65

Established project with proven stability

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~93 days

Recently: every ~161 days

Total

14

Last Release

1035d ago

Major Versions

1.3.1 → 2.0.12021-09-14

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/10155092?v=4)[Deniz Tezcan](/maintainers/deniztezcan)[@deniztezcan](https://github.com/deniztezcan)

---

Top Contributors

[![deniztezcan](https://avatars.githubusercontent.com/u/10155092?v=4)](https://github.com/deniztezcan "deniztezcan (37 commits)")

---

Tags

phpapilaravelretailerv5bolBol.com

### Embed Badge

![Health badge](/badges/deniztezcan-laravel-bolcom-retailer-api/health.svg)

```
[![Health](https://phpackages.com/badges/deniztezcan-laravel-bolcom-retailer-api/health.svg)](https://phpackages.com/packages/deniztezcan-laravel-bolcom-retailer-api)
```

###  Alternatives

[smodav/mpesa

M-Pesa API implementation

16363.7k1](/packages/smodav-mpesa)[mozex/anthropic-laravel

Anthropic PHP for Laravel is a supercharged PHP API client that allows you to interact with the Anthropic API

71226.4k1](/packages/mozex-anthropic-laravel)[dariusiii/tmdb-laravel

Laravel Package for TMDB ( The Movie Database ) API. Provides easy access to the wtfzdotnet/php-tmdb-api library.

1821.1k](/packages/dariusiii-tmdb-laravel)[specialtactics/l5-api

Dependencies for the Laravel API Boilerplate package

3672.8k2](/packages/specialtactics-l5-api)[gufy/whmcs

WHMCS API for Laravel 5

201.7k](/packages/gufy-whmcs)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
