kkraszy / sellrocket-php
SellRocket (Beel-API) PHP library
Requires
- php: ^8.1
- ext-json: *
- guzzlehttp/guzzle: ^7.5
Requires (Dev)
- friendsofphp/php-cs-fixer: ^3.34
- phpunit/phpunit: ^10.0
Suggests
None
Provides
None
Conflicts
None
Replaces
None
README
PHP wrapper for the SellRocket Beel-API, which is compatible with a subset (55 of 110) of the BaseLinker API methods.
Forked from mnastalski/baselinker-php.
Requirements
- PHP >=8.1
Installation
composer require kkraszy/sellrocket-php
Usage
Creating an instance
Generate an API token in SellRocket (Integracje → Połączenia → Beel) and use your account's connector URL:
use SellRocket\SellRocket; $sellRocket = new SellRocket('[API token]', 'https://yourname-beel-api.enterprise.sellrocket.pl/');
Creating a request
$response = $sellRocket->orders()->getOrders([ 'date_from' => 1609506671, 'get_unconfirmed_orders' => true, ]); $response->toArray(); /* [ 'status' => 'SUCCESS', 'orders' => [ [ 'order_id' => '123456', ... ], ... ] ] */ $orders = $response->getParameter('orders');
Supported methods
Only the methods handled by the Beel-API are wrapped. Anything else in the BaseLinker API (external storages, order returns, receipts, BaseLinker Connect, inventory documents, purchase orders, suppliers, payers, parcel pickups, product variants) is not supported.
productCatalog() — inventory
getInventoryPriceGroups getInventoryWarehouses getInventories addInventoryCategory
updateInventoryCategory* getInventoryCategories addInventoryProduct
updateInventoryProduct* deleteInventoryProduct getInventoryProductsData
getInventoryProductsList getInventoryProductsStock updateInventoryProductsStock
getInventoryProductsPrices updateInventoryProductsPrices
* helpers calling the matching add* method with an id.
productStorages() — product storages
getStoragesList addCategory deleteCategory getCategories addProduct deleteProduct
getProductsData getProductsList getProductsQuantity updateProductsQuantity
getProductsPrices updateProductsPrices
orders()
getJournalList addOrder getOrderSources getOrderExtraFields getOrders
getOrdersByEmail getOrdersByPhone addInvoice getInvoices getSeries
getOrderStatusList getOrderPaymentsHistory setOrderFields addOrderProduct
setOrderProductFields deleteOrderProduct setOrderPayment setOrderStatus
setOrderStatuses addOrderInvoiceFile getInvoiceFile runOrderMacroTrigger
courierShipments()
createPackage createPackageManual getCouriersList getCourierFields
getCourierServices getCourierAccounts getLabel getOrderPackages