Download the PHP package budgetlens/bol-retailer-api without Composer
On this page you can find all versions of the php package budgetlens/bol-retailer-api. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package bol-retailer-api
Bol.com Retailer API client
Bol Retailer API documentation
Requirements
To use the Bol.com Retailer API client, the following things are required:
- Generate your API Key
Installation
Install package using composer
Getting started
Initialize the Api client using the client ID / secret defined in an .env file.
Or Use your own config.
Examples
for more examples see "tests folder"
Commmissions
Get all commissions and reductions by EAN in bulk
Get all commissions and reductions by EAN per single EAN
Insights
Get offer insights
Get performance indicators
Get sales forecast
Get search terms (with related)
Inventory
Get LVB/FBB inventory
Invoices
Not production ready !
Get all 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
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.
Retrieve an offer export file by offer export id
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.
Retrieve Unpublished Offers Export
Retrieve an offer by its offer id
// todo: check offer object response
Update an offer
Delete offer by id
Update price(s) for offer by id
Update stock for offer by id
Orders
Get Orders
Cancel an order item by an order item id
Ship Order Item With Transporter information
Ship Order Item using Bol Shipment Label
Retrieve a single order
Process Status
Gets the status of an asynchronous process by entity id and event type for a retailer
Gets the status of multiple asynchronous processes by an array of process status ids for a retailer
Get the status of an asynchronous process by process status id
Or you may pass the ProcessStatus instance directly to this method:
Get Process Status and wait for it to complete
Product Content
Not yet implemented
Replenishments
Get replenishments
Post replenishment
Post replenishment (Pickup)
Post pickup time slots
Post product labels
Get a replenishment by replenishment id
Update replenishment
Get load carrier labels
Get pick list
Returns
Get All unhandled FBB Returns
Get All Handled Returns
Create return
Get a return by return id
Handle a return
Shipments
Get Shipments List
Get Shipment By ID
Shipping Labels
Create Shipping Label
Get delivery options for a shippable configuration of a number of order items within an order.
Get a shipping label
Transports
Add transport information by transport id
Subscriptions
List subscriptions
Get Subscription By Id
Create subscription
Update subscription
Delete subscription
Send test notification
Get Signature (public) keys
Deprecated Endpoints
Inbounds
Create Inbound
List Inbounds
Get Inbound Details
Get Inbound Packing List
Get Inbound Shipping Label
Get Product Labels
Get Delivery Windows
Get Inbound transporters
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
Contributing
Please see CONTRIBUTING for details.
Credits
License
The MIT License (MIT). Please see License File for more information.
All versions of bol-retailer-api with dependencies
ext-json Version *
guzzlehttp/guzzle Version ^6.3 || ^7.2
composer/ca-bundle Version ^1.2
illuminate/collections Version ^8.32 || ^v9.34