PHPackages spheremall/ms-client - 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. spheremall/ms-client ActiveLibrary spheremall/ms-client ==================== SphereMall API client for SphereMall GateWay 2.8.18.4(6y ago)107.4k7[2 PRs](https://github.com/SphereMall/PHP-MS-Client/pulls)PHPPHP ^7.0 Since Nov 30Pushed 5y ago6 watchersCompare [ Source](https://github.com/SphereMall/PHP-MS-Client)[ Packagist](https://packagist.org/packages/spheremall/ms-client)[ RSS](/packages/spheremall-ms-client/feed)WikiDiscussions master Synced 3d ago READMEChangelog (10)Dependencies (3)Versions (234)Used By (0) SphereMall Gateway PHP SDK ========================== [](#spheremall-gateway-php-sdk) Official PHP SDK for integrating with **SphereMall Product**. [Official documentation](https://spheremall.atlassian.net/wiki/spaces/MIC/pages) ### Version 2.8.18.2 [](#version-28182) - Added possibility to delete some parameters from Elastic FilterBuilder ### Version 2.8.18.1 [](#version-28181) - Fixed filter builder for "isMain" parameters to elasticserch facets ### Version 2.8.17 [](#version-2817) - Added filter builder for "isMain" parameters to elasticserch facets ### Version 2.8.15 [](#version-2815) - Exclude negative factor items from elasticsearch response (using SortBuilder) ### Version 2.8.14.1 [](#version-28141) - Minor changes in CorrelationsResourse for preparing elsaticsearch query ### Version 2.8.14 [](#version-2814) - Add channels resource ### Version 2.8.13.1 [](#version-28131) - Changes in ObjectMaker for `included` - Changes in `ProductsMapper`, `DocumentsMapper`, `EntityGroupsMapper` and `CategoriesMapper` ### Version 2.8.12 [](#version-2812) - ObjectMaker extended with `included` to be able to find nested relationships (for example MediaEntities -> Media) ### Version 2.8.11 [](#version-2811) - Add `boost` support for ElasticSearch queries: `WildCardQuery`, `TermsQuery`, `DistanceQuery`, `RangeQuery` ### Version 2.8.10.1 [](#version-28101) - Add `deleteDocumentFromIndex` method to `ElasticResource` resource ### Version 2.8.9 [](#version-289) - Add `WebSites` and `WebSiteSettings` resources ### Version 2.8.6 [](#version-286) Implementation of updates for `comments` entity: ------------------------------------------------ [](#implementation-of-updates-for-comments-entity) - ### Version 2.8.5 [](#version-285) Implementation of: ------------------ [](#implementation-of) - - ### Version 2.8.4.8 [](#version-2848) Extend OrderFinalized with deliveryTime --------------------------------------- [](#extend-orderfinalized-with-deliverytime) ### Version 2.8.4.7 [](#version-2847) Fix DistanceQuery (added possibility to set field name) ------------------------------------------------------- [](#fix-distancequery-added-possibility-to-set-field-name) ### Version 2.8.4.6 [](#version-2846) Fix correlation resource when use withMeta ------------------------------------------ [](#fix-correlation-resource-when-use-withmeta) ### Version 2.8.4.5 [](#version-2845) Fix entity factors set() method ------------------------------- [](#fix-entity-factors-set-method) ### Version 2.8.4.4 [](#version-2844) Fix for multi price range params -------------------------------- [](#fix-for-multi-price-range-params) ### Version 2.8.4.3 [](#version-2843) Add AttributeRangeConfig ------------------------ [](#add-attributerangeconfig) ### Version 2.8.4.2 [](#version-2842) Fix OrdersMaker signature ------------------------- [](#fix-ordersmaker-signature) ### Version 2.8.4.1 [](#version-2841) Change filter builder config bug -------------------------------- [](#change-filter-builder-config-bug) ### [Version 2.8.3](https://spheremall.atlassian.net/browse/MIC-1245) [](#version-283) Check success response refactored --------------------------------- [](#check-success-response-refactored) HttpHelper refactored for checking port in url ---------------------------------------------- [](#httphelper-refactored-for-checking-port-in-url) ObjectMaker refactored (temporary solution) to get all included, not only from relations ---------------------------------------------------------------------------------------- [](#objectmaker-refactored-temporary-solution-to-get-all-included-not-only-from-relations) ### [Version 2.8.2](https://spheremall.atlassian.net/browse/M20-156) [](#version-282) Fix url-s for elastic resource ------------------------------ [](#fix-url-s-for-elastic-resource) Implement JsonSerializable for Entity ------------------------------------- [](#implement-jsonserializable-for-entity) ### [Version 2.8.1](https://spheremall.atlassian.net/browse/M20-109) [](#version-281) Update work with filter params for elasticfilter ------------------------------------------------ [](#update-work-with-filter-params-for-elasticfilter) ! This version is compatible with MS Indexer >= 2.5.4 ! ---------------------------------------------------------- [](#-this-version-is-compatible-with-ms-indexer--254-) ### [Version 2.8.0](https://spheremall.atlassian.net/browse/MIC-1227) [](#version-280) Update correlation resource for working with elasticsearch ---------------------------------------------------------- [](#update-correlation-resource-for-working-with-elasticsearch) ! This version is compatible with MS Grapher >= 2.3.4.5 ! ------------------------------------------------------------ [](#-this-version-is-compatible-with-ms-grapher--2345-) ### [Version 2.7.24](https://spheremall.atlassian.net/browse/M20-96) [](#version-2724) Add CRUD wrapping for Marketing microservice -------------------------------------------- [](#add-crud-wrapping-for-marketing-microservice) ### [Version 2.7.23](https://spheremall.atlassian.net/browse/M20-80) [](#version-2723) Add CRUD wrapping for Marketing microservice -------------------------------------------- [](#add-crud-wrapping-for-marketing-microservice-1) ### [Version 2.7.22](https://spheremall.atlassian.net/browse/M20-80) [](#version-2722) created Categories and EntityGroups resource -------------------------------------------- [](#created-categories-and-entitygroups-resource) ### [Version 2.7.21](https://github.com/SphereMall/PHP-MS-Client/wiki/0.-SDK-Changelogs#version-1016) [](#version-2721) Extend attribute entity with attributeTypeId -------------------------------------------- [](#extend-attribute-entity-with-attributetypeid) ### [Version 2.7.19.2](https://github.com/SphereMall/PHP-MS-Client/wiki/0.-SDK-Changelogs#version-1016) [](#version-27192) Add CRUD wrapping for CatalogItemAttributes ------------------------------------------- [](#add-crud-wrapping-for-catalogitemattributes) ### [Version 2.7.19.1](https://github.com/SphereMall/PHP-MS-Client/wiki/0.-SDK-Changelogs#version-1016) [](#version-27191) !!! Indexer Microservice version: 2.4.0 + ----------------------------------------- [](#-indexer-microservice-version-240-) ======= Installation ------------ [](#installation) You can install the package manually or by adding it to your `composer.json`: ``` { "require": { "spheremall/ms-client": "^1.0" } } ``` Instantiating the SDK Client: ----------------------------- [](#instantiating-the-sdk-client) Pass in the configuration to the client: ``` $client = new Client([ 'gatewayUrl' => 'API_GATEWAY_URL', 'clientId' => 'API_CLIENT_ID', 'secretKey' => 'API_SECRET_KEY' ]); ``` Using the client with base Resources functionality -------------------------------------------------- [](#using-the-client-with-base-resources-functionality) - [Multiple Resources](https://github.com/SphereMall/PHP-MS-Client/wiki/1.-Multiple-Resources) - [Single Resource by ID](https://github.com/SphereMall/PHP-MS-Client/wiki/2.-Single-Resource-by-ID) - [Limiting and Offsetting Results](https://github.com/SphereMall/PHP-MS-Client/wiki/3.-Limiting-and-Offsetting-Results) - [Filtering result with specific fields](https://github.com/SphereMall/PHP-MS-Client/wiki/4.-Filtering-result-with-specific-fields) - [Sorting Results](https://github.com/SphereMall/PHP-MS-Client/wiki/5.-Sorting-Results) - [Counting Results](https://github.com/SphereMall/PHP-MS-Client/wiki/6.-Counting-Results) - [Product Resource](https://github.com/SphereMall/PHP-MS-Client/wiki/7.-Product-Resource) - [Get full](https://github.com/SphereMall/PHP-MS-Client/wiki/7.1.-Get-full) - [Shop](https://github.com/SphereMall/PHP-MS-Client/wiki/8.-Shop-service) - [ElasticSearch](https://github.com/SphereMall/PHP-MS-Client/wiki/9.-ElasticSearch) ### Health Score 40 — FairBetter than 88% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity27 Limited adoption so far Community23 Small or concentrated contributor base Maturity78 Established project with proven stability Bus Factor2 2 contributors hold 50%+ of commits 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 ~4 days Total 161 Last Release 2458d ago Major Versions 1.0.35 → 2.0.02018-04-16 1.0.37 → 2.1.02018-04-26 1.0.42 → 10401.x-dev2018-05-07 1.0.42.1 → 2.5.02018-05-09 1.0.42.2 → 2.5.22018-05-18 ### Community Maintainers ![](https://www.gravatar.com/avatar/4abe2ea8037fdd056f37ba1629505ca095c0cf15bd8894b75ca164e843af5a6f?d=identicon)[SergeyKondratovec](/maintainers/SergeyKondratovec) --- Top Contributors [![SergeyKondratovec](https://avatars.githubusercontent.com/u/32614007?v=4)](https://github.com/SergeyKondratovec "SergeyKondratovec (170 commits)")[![yaroslavdraha](https://avatars.githubusercontent.com/u/12752044?v=4)](https://github.com/yaroslavdraha "yaroslavdraha (61 commits)")[![Roman-Sydorchuk](https://avatars.githubusercontent.com/u/43537355?v=4)](https://github.com/Roman-Sydorchuk "Roman-Sydorchuk (33 commits)")[![dmytro-vorobei-spheremall](https://avatars.githubusercontent.com/u/199830207?v=4)](https://github.com/dmytro-vorobei-spheremall "dmytro-vorobei-spheremall (31 commits)")[![sauron918](https://avatars.githubusercontent.com/u/3842386?v=4)](https://github.com/sauron918 "sauron918 (25 commits)")[![ddis](https://avatars.githubusercontent.com/u/11501936?v=4)](https://github.com/ddis "ddis (17 commits)")[![skondratovec](https://avatars.githubusercontent.com/u/51446821?v=4)](https://github.com/skondratovec "skondratovec (16 commits)")[![SergiiBondarchuk](https://avatars.githubusercontent.com/u/22716555?v=4)](https://github.com/SergiiBondarchuk "SergiiBondarchuk (15 commits)")[![say-my-name-user](https://avatars.githubusercontent.com/u/17194260?v=4)](https://github.com/say-my-name-user "say-my-name-user (14 commits)")[![sm-mdm](https://avatars.githubusercontent.com/u/44439367?v=4)](https://github.com/sm-mdm "sm-mdm (12 commits)")[![MarchenkoOleksandr](https://avatars.githubusercontent.com/u/38476175?v=4)](https://github.com/MarchenkoOleksandr "MarchenkoOleksandr (5 commits)")[![antonradchuk](https://avatars.githubusercontent.com/u/28062083?v=4)](https://github.com/antonradchuk "antonradchuk (2 commits)")[![lazhevskyi](https://avatars.githubusercontent.com/u/22920918?v=4)](https://github.com/lazhevskyi "lazhevskyi (2 commits)")[![Viktorminator](https://avatars.githubusercontent.com/u/756578?v=4)](https://github.com/Viktorminator "Viktorminator (2 commits)")[![comaw](https://avatars.githubusercontent.com/u/6249409?v=4)](https://github.com/comaw "comaw (2 commits)") ### Code Quality TestsPHPUnit ### Embed Badge ![Health badge](/badges/spheremall-ms-client/health.svg) ``` [![Health](https://phpackages.com/badges/spheremall-ms-client/health.svg)](https://phpackages.com/packages/spheremall-ms-client) ``` ### Alternatives [bagisto/bagisto Bagisto Laravel E-Commerce 26.2k161.6k7](/packages/bagisto-bagisto)[magento/community-edition Magento 2 (Open Source) 12.1k52.1k10](/packages/magento-community-edition)[wheelpros/fitment-platform-api Magento 2 (Open Source) 12.1k1.2k](/packages/wheelpros-fitment-platform-api)[unopim/unopim UnoPim Laravel PIM 9.4k1.8k](/packages/unopim-unopim)[neuron-core/neuron-ai The PHP Agentic Framework. 1.8k245.3k21](/packages/neuron-core-neuron-ai)[tencentcloud/tencentcloud-sdk-php TencentCloudApi php sdk 3731.2M42](/packages/tencentcloud-tencentcloud-sdk-php) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)