README

Requirements

To use the Bol.com Retailer API client, the following things are required:

Generate your API Key

Installation

Install package using composer

composer require budgetlens/bol-retailer-api

Getting started

Initialize the Api client using the client ID / secret defined in an .env file.

$client = new \Budgetlens\BolRetailerApi\Client();

Or Use your own config.

$client = new \Budgetlens\BolRetailerApi\Client(new CustomApiConfig());

Examples

for more examples see "tests folder"

Commmissions

Get all commissions and reductions by EAN in bulk

$items = [
    [
        "ean" => "8712626055150",
        "condition" => "NEW",
        "unitPrice" => "34.99"
    ], [
        "ean" => "8804269223123",
        "condition" => "NEW",
        "unitPrice" => "699.95"
    ], [
        "ean" => "8712626055143",
        "condition" => "GOOD",
        "unitPrice" => "24.50"
    ], [
        "ean" => "0604020064587",
        "condition" => "NEW",
        "unitPrice" => "24.95"
    ], [
        "ean" => "8718526069334",
        "condition" => "NEW",
        "unitPrice" => "25.00"
    ]
];

$commissions = $client->commission->list($items);
print_r($commissions);

Get all commissions and reductions by EAN per single EAN

$ean = '8712626055143';
$unitPrice = 24.50;
$commission = $client->commission->get($ean, $unitPrice);
print_r($commission);

Budgetlens\BolRetailerApi\Resources\Commission Object
(
    [ean] => 8712626055143
    [condition] => NEW
    [unitPrice] => 0.24
    [fixedAmount] => 0.99
    [percentage] => 15
    [totalCost] => 4.67
    [totalCostWithoutReduction] => 
    [reductions] => Array
        (
        )

)

Insights

Get offer insights

$offerId = '7aec42a4-8c2b-4c38-ac3c-5e5a3f54341e';
$period = 'MONTH';
$numberOfPeriods = 1;
$name = ['PRODUCT_VISITS', 'BUY_BOX_PERCENTAGE'];

$insights = $client->insights->get($offerId, $period, $numberOfPeriods, $name);
print_r($insights);

Get performance indicators

$year = 2019;
$week = 10;
$indicators = ['CANCELLATIONS', 'FULFILMENT', 'PHONE_AVAILABILITY', 'CASE_ITEM_RATIO',
    'TRACK_AND_TRACE', 'RETURNS', 'REVIEWS'
];

$indicators = $client->insights->getPerformanceIndicators($year, $week, $indicators);
print_r($indicators);

Get sales forecast

$offerId = '91c28f60-ed1d-4b85-e053-828b620a4ed5';
$weeks = 12;
$forecast = $client->insights->getSalesForecast($offerId, $weeks);
print_r($forecast);

Get search terms (with related)

$term = 'Potter';
$period = 'WEEK';
$weeks = 2;
$related = true;

$searchTerm = $client->insights->getSearchTerms($term, $period, $weeks, $related);
print_r($searchTerm);

Inventory

Get LVB/FBB inventory

$inventory = $client->inventory->get();
print_r($inventory);

Illuminate\Support\Collection Object
(
    [items:protected] => Array
        (
            [0] => Budgetlens\BolRetailerApi\Resources\Inventory Object
                (
                    [ean] => 8718526069334
                    [bsku] => 2950003119187
                    [gradedStock] => 0
                    [regularStock] => 5
                    [title] => Star Wars - Nappy Star wars T-shirt - XL
                )

        )

)

Invoices

Not production ready !

Get all invoices

$invoices = $client->invoices->list();
print_r($invoices);

Get an invoice by invoice id

Get an invoice specification by invoice id

Offers

The offer related calls are async. Every action returns a StatusProcess resource.
With this resource you can poll the status of the transaction.

Note After creating a new offer the offerId is set in the entityId property of the StatusProcess resource. (if state is success).

Create a new offer

$offer = new Offer([
    'ean' => '0000007740404',
    'condition' => 'NEW',
    'reference' => 'unit-test',
    'onHoldByRetailer' => true,
    'unknownProductTitle' => 'unit-test',
    'price' => 99.99,
    'stock' => 0,
    'fulfilment' => 'FBB'
]);
$status = $client->offers->create($offer);
print_r($status);

Budgetlens\BolRetailerApi\Resources\ProcessStatus Object
(
    [processStatusId] => 1
    [entityId] => 
    [eventType] => CREATE_OFFER
    [description] => Create an offer with ean 0000007740404.
    [status] => PENDING
    [errorMessage] => 
    [createTimestamp] => 2021-03-17T11:00:31+01:00
    [links] => Illuminate\Support\Collection Object
        (
            [items:protected] => Array
                (
                    [0] => Budgetlens\BolRetailerApi\Resources\ProcessStatus\Link Object
                        (
                            [rel] => self
                            [href] => https://api.bol.com/retailer-demo/process-status/1
                            [method] => GET
                        )

                )

        )

    [id] => 1
)

Request an offer export file

The offers export comes with 2 steps.

request the export
retrieve the export

The request returns a status process to poll. Once the state is success the entityId contains the report-id to use for retrieving the export.

$status = $client->offers->requestExport();
print_r($status);

Budgetlens\BolRetailerApi\Resources\ProcessStatus Object
(
    [processStatusId] => 1
    [entityId] => 
    [eventType] => CREATE_OFFER_EXPORT
    [description] => Create an offer export.
    [status] => PENDING
    [errorMessage] => 
    [createTimestamp] => 2021-03-19T09:28:42+01:00
    [links] => Illuminate\Support\Collection Object
        (
            [items:protected] => Array
                (
                    [0] => Budgetlens\BolRetailerApi\Resources\ProcessStatus\Link Object
                        (
                            [rel] => self
                            [href] => https://api.bol.com/retailer-demo/process-status/1
                            [method] => GET
                        )

                )

        )

    [id] => 1
)

Retrieve an offer export file by offer export id

$offerExportId = 'some-id-retrieved-from-status-response-by-offer-export-request';
$offers = $client->offers->getExport($offerExportId);
print_r($offers);

// todo

Request unpublished offers export

The unpublished offers export comes with 2 steps.

request the export
retrieve the export

The request returns a status process to poll. Once the state is success the entityId contains the report-id to use for retrieving the export.

$status = $client->offers->requestUnpublishedExport();

Retrieve Unpublished Offers Export

$offers = $client->offers->getUnpublishedExport('$reportId');

Retrieve an offer by its offer id

$offerId = '13722de8-8182-d161-5422-4a0a1caab5c8';
$offer = $client->offers->get($offerId);
print_r($offer);

// todo: check offer object response

Update an offer

$offer = new Offer([
    'offerId' => '13722de8-8182-d161-5422-4a0a1caab5c8',
    'onHoldByRetailer' => false,
    'fulfilment' => 'FBR'
]);
$status = $client->offers->update($offer);
print_r($status);

// todo: fix status response

Delete offer by id

$offerId = '13722de8-8182-d161-5422-4a0a1caab5c8';
$status = $this->client->offers->delete($offerId);
print_r($status);

// todo: fix status response

Update price(s) for offer by id

$offer = new Offer([
    'offerId' => '13722de8-8182-d161-5422-4a0a1caab5c8',
    'pricing' => new Pricing([
        'bundlePrices' => [
            ['quantity' => 1, 'unitPrice' => 99.99],
            ['quantity' => 2, 'unitPrice' => 89.99],
            ['quantity' => 3, 'unitPrice' => 85.99]
        ]
    ])
]);
$status = $client->offers->updatePrice($offer);
print_r($status);

// todo: fix status response

Update stock for offer by id

$offer = new Offer([
    'offerId' => '13722de8-8182-d161-5422-4a0a1caab5c8',
    'stock' => new Stock([
        'amount' => 100
    ])
]);
$status = $client->offers->updateStock($offer);
print_r($status);

// todo: fix status response

Orders

Get Orders

// all 
$orders = $client->orders->getOpenOrders();

// specific fulfilment
$orders = $client->orders->getOpenOrders('FBR');
print_r($orders);
// pagination
$orders = $client->orders->getOpenOrders('FBR', 2);

Cancel an order item by an order item id

$orderItemId = '7616222250';
$status = $client->orders->cancelOrderItem($orderItemId, CancelReasonCodes::REQUESTED_BY_CUSTOMER);
print_r($status);

// todo: fix status response

Ship Order Item With Transporter information

$orderItemId = '6107434013';
$shipmentReference = 'unit-test';
$transport = new Transport([
    'transporterCode' => 'TNT',
    'trackAndTrace' => '3SAOLD1234567'
]);

$status = $client->orders->shipOrderItem($orderItemId, $shipmentReference, null, $transport);
print_r($status);

// todo: fix status response

Ship Order Item using Bol Shipment Label

$orderItemId = '6107434013';
$shipmentReference = 'unit-test';
$shipmentLabelId = 'd4c50077-0c19-435f-9bee-1b30b9f4ba1a';

$status = $client->orders->shipOrderItem($orderItemId, $shipmentReference, $shipmentLabelId);
print_r($status);

// todo: fix status response

Retrieve a single order

$order = $client->orders->get($orderId);
print_r($order);

// todo: fix response

Process Status

Gets the status of an asynchronous process by entity id and event type for a retailer

$statusResource = new ProcessStatus([
    'entityId' => 1,
    'eventType' => 'CONFIRM_SHIPMENT'
]);
$status = $client->status->get($statusResource);
// or 
$status = $client->status->getByEntityId(1, 'CONFIRM_SHIPMENT');
print_r($status);

// todo: fix response

Gets the status of multiple asynchronous processes by an array of process status ids for a retailer

$status = $client->status->batch([1,2,3]);
// or 
$batch = [
    new ProcessStatus(['id' => 1]),
    new ProcessStatus(['id' => 2]),
    new ProcessStatus(['id' => 3])
];
$statusses = $client->status->batch($batch);
print_r($statusses);

// todo: fix response

Get the status of an asynchronous process by process status id

$status = $client->status->get(1);
// or
$status = $client->status->getById(1);

Or you may pass the ProcessStatus instance directly to this method:

$statusResource = new ProcessStatus([
    'id' => 1
]);
$status = $client->status->get($statusResource);
print_r($status);

// todo: fix response

Get Process Status and wait for it to complete

$status = $this->client->status->waitUntilComplete($processId);

// try at least 10 times.
$status = $this->client->status->waitUntilComplete($processId, 10);

// try 10 times with a timeout of of 5 seconds.
$status = $this->client->status->waitUntilComplete($processId, 10, 5);

print_r($status);

// todo: fix response

Product Content

Not yet implemented

Replenishments

Get replenishments

$replenishments = $client->replenishments->list(
    null,
    null,
    null,
    null,
    ['ANNOUNCED'],
);
print_r($replenishments);

Post replenishment

$replenishment = new Replenishment([
    'reference' => 'unittest001',
    'deliveryInformation' => new Replenishment\DeliveryInformation([
        'expectedDeliveryDate' => '2024-02-01',
        'transporterCode' => 'POSTNL'
    ]),
    'labelingByBol' => true,
    'numberOfLoadCarriers' => 2,
    'lines' => [
        [
            'ean' => '0846127026185',
            'quantity' => 5
        ],
        [
            'ean' => '8716393000627',
            'quantity' => 2
        ]
    ]
]);


$status = $client->replenishments->create($replenishment);
print_r($status);

Budgetlens\BolRetailerApi\Resources\ProcessStatus Object
(
    [processStatusId] => 1
    [entityId] => 
    [eventType] => CREATE_REPLENISHMENT
    [description] => Create replenishment with reference 'UNITTEST001'.
    [status] => PENDING
    [errorMessage] => 
    [createTimestamp] => 2021-08-19T12:07:09+02:00
    [links] => Illuminate\Support\Collection Object
        (
            [items:protected] => Array
                (
                    [0] => Budgetlens\BolRetailerApi\Resources\ProcessStatus\Link Object
                        (
                            [rel] => self
                            [href] => https://api.bol.com/retailer-demo/process-status/1
                            [method] => GET
                        )

                )

        )

)

Post replenishment (Pickup)

$replenishment = new Replenishment([
    'reference' => 'unittest002',
    'pickupAppointment' => new Replenishment\PickupAppointment([
        'address' => new Address([
            'streetName' => 'Utrechtseweg',
            'houseNumber' => 99,
            'zipCode' => '3702 AA',
            'city' => 'Zeist',
            'countryCode' => 'NL',
            'attentionOf' => 'Station'
        ]),
        'pickupTimeSlot' => new Replenishment\PickupTimeslot([
            'fromDateTime' => '2024-01-21 09:30:00',
            'untilDateTime' => '2024-01-21 11:30:00'
        ]),
        'commentToTransporter' => 'Custom reference'
    ]),
    'labelingByBol' => true,
    'numberOfLoadCarriers' => 1,
    'lines' => [
        [
            'ean' => '0846127026185',
            'quantity' => 1
        ]
    ]
]);
$status = $client->replenishments->create($replenishment);
print_r($status);

Budgetlens\BolRetailerApi\Resources\ProcessStatus Object
(
    [processStatusId] => 1
    [entityId] => 
    [eventType] => CREATE_REPLENISHMENT
    [description] => Create replenishment with reference 'UNITTEST002'.
    [status] => PENDING
    [errorMessage] => 
    [createTimestamp] => 2021-08-19T14:22:06+02:00
    [links] => Illuminate\Support\Collection Object
        (
            [items:protected] => Array
                (
                    [0] => Budgetlens\BolRetailerApi\Resources\ProcessStatus\Link Object
                        (
                            [rel] => self
                            [href] => https://api.bol.com/retailer-demo/process-status/1
                            [method] => GET
                        )

                )

        )

)

Post pickup time slots

$address = new Address([
    'streetName' => 'Utrechtseweg',
    'houseNumber' => 99,
    'houseNumberExtension' => 'A',
    'zipCode' => '3702 AA',
    'city' => 'Zeist',
    'countryCode' => 'NL',
]);
$numberOfLoadCarriers = 2;

$timeslots = $client->replenishments->pickupTimeslots($address, $numberOfLoadCarriers);
print_r($timeslots);

Post product labels

$products = [
    ['ean' => '0846127026185', 'quantity' => 5],
    ['ean' => '8716393000627', 'quantity' => 2]
];

$labels = $client->replenishments->productLabels($products, LabelFormat::AVERY_J8159);
print_r($labels);

// the labels can be saved by using resource
// filename is optional, if empty the product labels export id (product-labels) is used as filename
$labels->save($path, $filename);

.Budgetlens\BolRetailerApi\Resources\Replenishment\ProductLabels Object
(
    [id] => product-labels
    [contents] => PDFCONTENT
    [fileExt:protected] => pdf
)

Get a replenishment by replenishment id

$id = '2312208179';
$replenishment = $client->replenishments->get($id);
print_r($replenishment);

Update replenishment

$replenishment = new Replenishment([
    'replenishmentId' => '2312188192',
    'deliveryInformation' => new Replenishment\DeliveryInformation([
        'expectedDeliveryDate' => '2024-01-29'
    ])
]);
$status = $client->replenishments->update($replenishment);
print_r($status);

Budgetlens\BolRetailerApi\Resources\ProcessStatus Object
(
    [processStatusId] => 1
    [entityId] => 2312188192
    [eventType] => UPDATE_REPLENISHMENT
    [description] => Update replenishment with replenishment id '2312188192'.
    [status] => PENDING
    [errorMessage] => 
    [createTimestamp] => 2021-08-19T15:13:28+02:00
    [links] => Illuminate\Support\Collection Object
        (
            [items:protected] => Array
                (
                    [0] => Budgetlens\BolRetailerApi\Resources\ProcessStatus\Link Object
                        (
                            [rel] => self
                            [href] => https://api.bol.com/retailer-demo/process-status/1
                            [method] => GET
                        )

                )

        )

)

Get load carrier labels

$id = '4220489554';
$labelType = 'TRANSPORT';
$label = $client->replenishments->loadCarrierLabels($id, $labelType);

// todo: implement response

Get pick list

$id = '2312208179';
$response = $client->replenishments->picklist($id);
print_r($response);
// the picklist can be saved by using resource
// filename is optional, if empty the picklist id is used as filename
$response->save($path, $filename);

Budgetlens\BolRetailerApi\Resources\Replenishment\Picklist Object
(
    [id] => 2312208179
    [contents] => PDFCONTENT
    [fileExt:protected] => pdf
)

Returns

Get All unhandled FBB Returns

$returns = $client->returns->list('FBB', false);
print_r($returns);

Illuminate\Support\Collection Object
(
    [items:protected] => Array
        (
            [0] => Budgetlens\BolRetailerApi\Resources\Returns Object
                (
                    [returnId] => 6
                    [registrationDateTime] => DateTime Object
                        (
                            [date] => 2018-04-27 19:55:12.000000
                            [timezone_type] => 1
                            [timezone] => +02:00
                        )

                    [fulfilmentMethod] => FBB
                    [returnItems] => Illuminate\Support\Collection Object
                        (
                            [items:protected] => Array
                                (
                                    [0] => Budgetlens\BolRetailerApi\Resources\Returns\Item Object
                                        (
                                            [rmaId] => 86127131
                                            [orderId] => 7616247328
                                            [ean] => 8718526069334
                                            [title] => 
                                            [expectedQuantity] => 1
                                            [returnReason] => Budgetlens\BolRetailerApi\Resources\Returns\ReturnReason Object
                                                (
                                                    [mainReason] => Verkeerd besteld
                                                    [detailedReason] => 
                                                    [customerComments] => Ik wilde eigenlijk een groter formaat
                                                )

                                            [trackAndTrace] => 
                                            [transporterName] => 
                                            [handled] => 
                                            [processingResults] => 
                                            [customerDetails] => 
                                        )

                                )

                        )

                )

        )

)

Get All Handled Returns

$returns = $client->returns->list(null, true);
print_r($returns);

Create return

$orderItemId = '1044796550';
$quantity = 1;
$state = ReturnResultTypes::RETURN_RECEIVED;

$status = $client->returns->create($orderItemId, $quantity, $state);
print_r($status);

Budgetlens\BolRetailerApi\Resources\ProcessStatus Object
(
    [processStatusId] => 1
    [entityId] => 
    [eventType] => CREATE_RETURN_ITEM
    [description] => Create return for order item 1044796550.
    [status] => PENDING
    [errorMessage] => 
    [createTimestamp] => 2021-08-24T10:20:09+02:00
    [links] => Illuminate\Support\Collection Object
        (
            [items:protected] => Array
                (
                    [0] => Budgetlens\BolRetailerApi\Resources\ProcessStatus\Link Object
                        (
                            [rel] => self
                            [href] => https://api.bol.com/retailer-demo/process-status/1
                            [method] => GET
                        )

                )

        )

)

Get a return by return id

$id = 15896813;
$return = $client->returns->get($id);
print_r($return);

Handle a return

$rmaId = '86123452';
$state = ReturnResultTypes::RETURN_RECEIVED;
$quantity = 3;

$status = $client->returns->handle($rmaId, $quantity, $state);
print_r($status);

Budgetlens\BolRetailerApi\Resources\ProcessStatus Object
(
    [processStatusId] => 1
    [entityId] => 86123452
    [eventType] => HANDLE_RETURN_ITEM
    [description] => Handle the return item with return number 86123452.
    [status] => PENDING
    [errorMessage] => 
    [createTimestamp] => 2021-08-24T10:35:22+02:00
    [links] => Illuminate\Support\Collection Object
        (
            [items:protected] => Array
                (
                    [0] => Budgetlens\BolRetailerApi\Resources\ProcessStatus\Link Object
                        (
                            [rel] => self
                            [href] => https://api.bol.com/retailer-demo/process-status/1
                            [method] => GET
                        )

                )

        )

)

Shipments

Get Shipments List

$shipments = $client->shipments->list();
print_r($shipments);

// get FBR Shipments only
$shipments = $client->shipments->list('FBR');

// get Shipments Belonging to specific orderID
$shipments = $client->shipments->list(null, '$orderId');

Get Shipment By ID

$id = '914587795';
$shipment = $client->shipments->get($id);
print_r($shipment);

Shipping Labels

Create Shipping Label

$order = new Order([
    'orderItems' => [
        [
            'orderItemId' => 2095052647
        ]
    ]
]);
$shippingLabelOfferId = '8f956bfc-fabe-45b4-b0e1-1b52a0896b74';
$status = $client->shipping->createLabel($order, $shippingLabelOfferId);
print_r($status);

Budgetlens\BolRetailerApi\Resources\ProcessStatus Object
(
    [processStatusId] => 1
    [entityId] => 
    [eventType] => CREATE_SHIPPING_LABEL
    [description] => Create shipping label with shipping label offer id 8f956bfc-fabe-45b4-b0e1-1b52a0896b74.
    [status] => PENDING
    [errorMessage] => 
    [createTimestamp] => 2021-03-22T09:06:13+01:00
    [links] => Illuminate\Support\Collection Object
        (
            [items:protected] => Array
                (
                    [0] => Budgetlens\BolRetailerApi\Resources\ProcessStatus\Link Object
                        (
                            [rel] => self
                            [href] => https://api.bol.com/retailer-demo/process-status/1
                            [method] => GET
                        )

                )

        )

    [id] => 1
)

Get delivery options for a shippable configuration of a number of order items within an order.

$order = new Order([
    'orderItems' => [
        [
            'orderItemId' => 2095052647
        ]
    ]
]);

$options = $client->shipping->getDeliveryOptions($order);
print_r($options);

Get a shipping label

$id = 'c628ba4f-f31a-4fac-a6a0-062326d0dbbd';
$label = $client->shipping->getLabel($id);
print_r($label);

Budgetlens\BolRetailerApi\Resources\Label Object
(
    [id] => c628ba4f-f31a-4fac-a6a0-062326d0dbbd
    [contents] => PDFCONTENT
    [fileExt:protected] => pdf
)

Transports

Add transport information by transport id

$transportId = '358612589';
$transporterCode = TransporterCode::TNT;
$trackAndTrace = '3SAOLD1234567';

$status = $client->transports->addInformation($transportId, $transporterCode, $trackAndTrace);
print_r($status);

Budgetlens\BolRetailerApi\Resources\ProcessStatus Object
(
    [processStatusId] => 1
    [entityId] => 358612589
    [eventType] => CHANGE_TRANSPORT
    [description] => Change transport with id 358612589.
    [status] => PENDING
    [errorMessage] => 
    [createTimestamp] => 2021-08-24T15:14:40+02:00
    [links] => Illuminate\Support\Collection Object
        (
            [items:protected] => Array
                (
                    [0] => Budgetlens\BolRetailerApi\Resources\ProcessStatus\Link Object
                        (
                            [rel] => self
                            [href] => https://api.bol.com/retailer-demo/process-status/1
                            [method] => GET
                        )

                )

        )

)

Subscriptions

List subscriptions

$subscriptions = $this->client->subscriptions->list();
print_r($subscriptions);

Illuminate\Support\Collection Object
(
    [items:protected] => Array
        (
            [0] => Budgetlens\BolRetailerApi\Resources\Subscription Object
                (
                    [id] => 1234
                    [resources] => Illuminate\Support\Collection Object
                        (
                            [items:protected] => Array
                                (
                                    [0] => PROCESS_STATUS
                                )

                            [escapeWhenCastingToString:protected] => 
                        )

                    [url] => https://www.example.com/push
                )

        )

    [escapeWhenCastingToString:protected] => 
)

Get Subscription By Id

$id = '1234';
$subscription = $this->client->subscriptions->get($id);
print_r($subscription)

Budgetlens\BolRetailerApi\Resources\Subscription Object
(
    [id] => 1234
    [resources] => Illuminate\Support\Collection Object
        (
            [items:protected] => Array
                (
                    [0] => PROCESS_STATUS
                )

            [escapeWhenCastingToString:protected] => 
        )

    [url] => https://www.example.com/push
)

Create subscription

$resources = [SubscriptionResource::PROCESS_STATUS];
$url = 'https://www.example.com/push';
$status = $this->client->subscriptions->create($resources, $url);
print_r($status);

Budgetlens\BolRetailerApi\Resources\ProcessStatus Object
(
    [processStatusId] => 1
    [entityId] => 
    [eventType] => CREATE_SUBSCRIPTION
    [description] => Create push notification subscription.
    [status] => PENDING
    [errorMessage] => 
    [createTimestamp] => DateTime Object
        (
            [date] => 2022-02-16 22:27:37.000000
            [timezone_type] => 1
            [timezone] => +01:00
        )

    [links] => Illuminate\Support\Collection Object
        (
            [items:protected] => Array
                (
                    [0] => Budgetlens\BolRetailerApi\Resources\ProcessStatus\Link Object
                        (
                            [rel] => self
                            [href] => https://api.bol.com/retailer-demo/process-status/1
                            [method] => GET
                        )

                )

            [escapeWhenCastingToString:protected] => 
        )

)

Update subscription

$id = '1234';
$resources = [SubscriptionResource::PROCESS_STATUS];
$url = 'https://www.example.com/push';

$status = $this->client->subscriptions->update($id, $resources, $url);
print_r($status);

Budgetlens\BolRetailerApi\Resources\ProcessStatus Object
(
    [processStatusId] => 1
    [entityId] => 1234
    [eventType] => UPDATE_SUBSCRIPTION
    [description] => Update push notification subscription with id 1234.
    [status] => PENDING
    [errorMessage] => 
    [createTimestamp] => DateTime Object
        (
            [date] => 2022-02-16 22:28:27.000000
            [timezone_type] => 1
            [timezone] => +01:00
        )

    [links] => Illuminate\Support\Collection Object
        (
            [items:protected] => Array
                (
                    [0] => Budgetlens\BolRetailerApi\Resources\ProcessStatus\Link Object
                        (
                            [rel] => self
                            [href] => https://api.bol.com/retailer-demo/process-status/1
                            [method] => GET
                        )

                )

            [escapeWhenCastingToString:protected] => 
        )

)

Delete subscription

$id = '1234';
$status = $this->client->subscriptions->delete($id);
print_r($status);

Budgetlens\BolRetailerApi\Resources\ProcessStatus Object
(
    [processStatusId] => 1
    [entityId] => 
    [eventType] => DELETE_SUBSCRIPTION
    [description] => Delete push notification subscription with id 1234.
    [status] => PENDING
    [errorMessage] => 
    [createTimestamp] => DateTime Object
        (
            [date] => 2022-02-16 22:29:15.000000
            [timezone_type] => 1
            [timezone] => +01:00
        )

    [links] => Illuminate\Support\Collection Object
        (
            [items:protected] => Array
                (
                    [0] => Budgetlens\BolRetailerApi\Resources\ProcessStatus\Link Object
                        (
                            [rel] => self
                            [href] => https://api.bol.com/retailer-demo/process-status/1
                            [method] => GET
                        )

                )

            [escapeWhenCastingToString:protected] => 
        )

)

Send test notification

$id = '54321';
$status = $this->client->subscriptions->test($id);
print_r($status);

Budgetlens\BolRetailerApi\Resources\ProcessStatus Object
(
    [processStatusId] => 1
    [entityId] => 
    [eventType] => SEND_SUBSCRIPTION_TST_MSG
    [description] => Send a test push notification for configured subscription.
    [status] => PENDING
    [errorMessage] => 
    [createTimestamp] => DateTime Object
        (
            [date] => 2022-02-16 22:30:15.000000
            [timezone_type] => 1
            [timezone] => +01:00
        )

    [links] => Illuminate\Support\Collection Object
        (
            [items:protected] => Array
                (
                    [0] => Budgetlens\BolRetailerApi\Resources\ProcessStatus\Link Object
                        (
                            [rel] => self
                            [href] => https://api.bol.com/retailer-demo/process-status/1
                            [method] => GET
                        )

                )

            [escapeWhenCastingToString:protected] => 
        )

)

Get Signature (public) keys

$keys = $this->client->subscriptions->getSignatureKeys();
print_r($keys);

Illuminate\Support\Collection Object
(
    [items:protected] => Array
        (
            [0] => Budgetlens\BolRetailerApi\Resources\Subscriptions\SignatureKey Object
                (
                    [id] => 0
                    [type] => RSA
                    [publicKey] => MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAh5x6f/IexlWgo23VF9yH7zmRWEaFShAXyFoR3Flh0ZwSn8hZY+rR3zJt/FWKT6mcw51cFjNWGoi92FLLCsXq49TS+8T6z5/AqpS/cORzFndiaPeMN5k9nla9ECwWqizqoBWRFyg7tnP0GkbZF+rjLlAbUznisEItGcfu9rw4+CfulFTwA9CGxKUDNJOcihEkUflsMlGL2Stqs1Q54O2GTPlLX4KTn1z7Iy4E8IqSOm9Z7sEFHK/RR7sf6K3JsN/h3nR0+NN8o2OGCZ1z17OjSnWXbq1QDZIkN+PntEIW540Og0SHDshLAGxOeW0jw8tU/uKZMhR7lmmrabLjutk3NQIDAQAB
                )

        )

    [escapeWhenCastingToString:protected] => 
)

Deprecated Endpoints

Inbounds

Create Inbound

- $inbound = new Inbound([
-    'reference' => 'my-reference',
-    'timeSlot' => new Timeslot([
-        'startDateTime' => new \DateTime('2018-04-05 12:00:00'),
-        'endDateTime' => new \DateTime('2018-04-05 17:00:00')
-    ]),
-    'inboundTransporter' => new Transporter([
-        'name' => 'PostNL',
-        'code' => 'PostNL'
-    ]),
-    'labellingService' => false,
-    'products' => [
-        ['ean' => '8718526069331', 'announcedQuantity' => 1],
-        ['ean' => '8718526069332', 'announcedQuantity' => 2],
-        ['ean' => '8718526069333', 'announcedQuantity' => 3],
-        ['ean' => '8718526069334', 'announcedQuantity' => 4]
-    ]
- ]);
- $status = $client->inbounds->create($inbound);

List Inbounds

- $inbounds = $client->inbounds->list();

Get Inbound Details

- $inbound = $client->inbounds->get($inboundId);

Get Inbound Packing List

- $packing = $client->inbounds->getPackingList($inboundId);
- // save pdf  (the filename is $inboundId.pdf)
- $packing->save('$path');
- // save pdf with custom filename
- $packing->save('$path', 'my-filename.pdf');

Get Inbound Shipping Label

- $label = $client->inbounds->getShippingLabel($inboundId);
- // save pdf  (the filename is $inboundId.pdf)
- $label->save('$path');
- // save pdf with custom filename
- $label->save('$path', 'my-shipping-label.pdf');

Get Product Labels

- $products = [
-     ['ean' => '0000000000000', 'quantity' => 1],
-     ['ean' => '1111111111111', 'quantity' => 2]
- ];
- $labels = $client->inbounds->getProductLabels($products, LabelFormat::ZEBRA_Z_PERFORM_1000T);
- // save pdf  (the filename is product-labels.pdf)
- $labels->save('$path');
- // save pdf with custom filename
- $labels->save('$path', 'my-product-labels.pdf');

Get Delivery Windows

- $expectedDeliveryDate = new \DateTime();
- $itemsToSend = 1;
- $deliveryWindows = $client->inbounds->getDeliveryWindows($expectedDeliveryDate, $itemsToSend);

Get Inbound transporters

- $transporters = $client->inbounds->getTransporters();

Usage with Laravel

~~You may incorporate this package in your Laravel application by using this package.~~

Changelog

Please see CHANGELOG for more information what has changed recently.

Testing

$ composer test

budgetlens / bol-retailer-api

Maintainers

Details