PHPackages                             gadoma/walmart-api-php-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. [API Development](/categories/api)
4. /
5. gadoma/walmart-api-php-client

ActiveLibrary[API Development](/categories/api)

gadoma/walmart-api-php-client
=============================

Walmart Open API PHP client

1.0.4(5y ago)827.5k↓50%10[2 issues](https://github.com/Gadoma/walmart-api-php-client/issues)MITPHPCI failing

Since Apr 11Pushed 5y ago4 watchersCompare

[ Source](https://github.com/Gadoma/walmart-api-php-client)[ Packagist](https://packagist.org/packages/gadoma/walmart-api-php-client)[ RSS](/packages/gadoma-walmart-api-php-client/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (5)Dependencies (4)Versions (7)Used By (0)

Walmart Open API PHP client
===========================

[](#walmart-open-api-php-client)

[![GitHub license](https://camo.githubusercontent.com/7ccc9b29a26265d2041f917016746f8ba2e3f5164886def26f7988d43ca7eea0/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c6963656e73652f6761646f6d612f77616c6d6172742d6170692d7068702d636c69656e742e737667)](https://github.com/Gadoma/walmart-api-php-client/blob/develop/LICENSE) [![Travis build status](https://camo.githubusercontent.com/8d2a61f22c9ed72b6d689a9fb920907b6a56a110d9eadfaa0a9050cd51bacf1d/68747470733a2f2f696d672e736869656c64732e696f2f7472617669732f4761646f6d612f77616c6d6172742d6170692d7068702d636c69656e742f6d61737465722e737667)](https://travis-ci.org/Gadoma/walmart-api-php-client) [![Coveralls test coverage](https://camo.githubusercontent.com/7f2bf40bb21da3a7a1a4d53376a08c13134cfdfa7667e79c7cff0403ec9bfe1d/68747470733a2f2f696d672e736869656c64732e696f2f636f766572616c6c732f4761646f6d612f77616c6d6172742d6170692d7068702d636c69656e742f6d61737465722e737667)](https://coveralls.io/github/Gadoma/walmart-api-php-client?branch=master) [![SensioLabsInsight grade](https://camo.githubusercontent.com/057271fb5adfdcad8144f0227d39483cc73e25132d3af5d79fe4cf4662781eb8/68747470733a2f2f696d672e736869656c64732e696f2f73656e73696f6c6162732f692f64613631363837302d616535322d343633662d393232322d3164323034383261646462642e737667)](https://insight.sensiolabs.com/projects/da616870-ae52-463f-9222-1d20482addbd) [![Packagist](https://camo.githubusercontent.com/e79870d2aa41f18ae71aca025e068b3fc6c8bd26da7cf753b4ff51b04c7f1539/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f4761646f6d612f77616c6d6172742d6170692d7068702d636c69656e742e7376673f6d61784167653d32353932303030)](https://packagist.org/packages/gadoma/walmart-api-php-client) [![Packagist](https://camo.githubusercontent.com/e6aa8ab854d7eeb1b6e77efa33a2583fde9885e09269aab8fbad3fb64475ae81/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f4761646f6d612f77616c6d6172742d6170692d7068702d636c69656e742e7376673f6d61784167653d32353932303030)](https://packagist.org/packages/gadoma/walmart-api-php-client)

Introduction
------------

[](#introduction)

Welcome to the Walmart Open API PHP Client, a [Composer](https://getcomposer.org/) package for interacting with the [Walmart Open API](https://developer.walmartlabs.com/).

This library is powered by [Guzzle 6](https://github.com/guzzle/guzzle) thus requires PHP >= 5.5.0 to work.

Extensive [PHPUnit](https://github.com/sebastianbergmann/phpunit) tests are provided, the builds are handled by [Travis-CI](https://travis-ci.org) and test code coverage is calculated by [Coveralls.io](https://coveralls.io).

### Contributing

[](#contributing)

If you notice any bugs or have an idea for improvements, feel free to submit a ticket to the project [Issue Tracker](https://github.com/Gadoma/walmart-api-php-client/issues).

Pull requests are welcome, just remember to submit them to the *develop* branch. Any PRs to the *master* branch will be rejected.

Installation
------------

[](#installation)

### Composer

[](#composer)

If you don't have Composer already available on your local system, install it first:

```
curl -sS https://getcomposer.org/installer | php
```

### Manual installation

[](#manual-installation)

Create a *composer.json* file and add an entry in the "require" section:

```
{
    "require": {
        "gadoma/walmart-api-php-client": "^1.0"
    }
}
```

Run the below command afterwards:

```
php composer.phar install
```

### Composer installation

[](#composer-installation)

Alternatively to the above method you can just run the following:

```
php composer.phar require gadoma/walmart-api-php-client:^1.0
```

Usage
-----

[](#usage)

### Walmart API key

[](#walmart-api-key)

In order to use the Walmart Open API you need to obtain an API key. You can get it by registering a [Walmart developer account](https://developer.walmartlabs.com/member/register).

### Basic usage

[](#basic-usage)

```
// composer autoload
require 'vendor/autoload.php';

//API credentials
$apiKey = 'yourWalmartApiKey';

//Basic components used by the Services
$httpClient        = new \GuzzleHttp\Client();
$errorHandler      = new \WalmartApiClient\Exception\Handler\ApiExceptionHandler();
$transportService  = new \WalmartApiClient\Http\TransportService($httpClient, $errorHandler, $apiUrl);
$entityFactory     = new \WalmartApiClient\Factory\EntityFactory();
$collectionFactory = new \WalmartApiClient\Factory\CollectionFactory();

//Actual Services you will use for interacting with the API
$productService  = new \WalmartApiClient\Service\ProductService($transportService, $entityFactory, $collectionFactory);
$offerService    = new \WalmartApiClient\Service\OfferService($transportService, $entityFactory, $collectionFactory);
$reviewService   = new \WalmartApiClient\Service\ReviewService($transportService, $entityFactory, $collectionFactory);
$taxonomyService = new \WalmartApiClient\Service\TaxonomyService($transportService, $entityFactory, $collectionFactory);
```

### LinkShare Publisher Id

[](#linkshare-publisher-id)

It is possible to provide your *LinkShare Publisher Id* for URL tracking/attribution purposes. It is optional and you can read more about this subject on [Walmart Affiliates](https://affiliates.walmart.com/) website. To use your *LinkShare Publisher Id* with this library, just pass it to *TransportService* constructor in the process of creating the basic components, like shown below:

```
$apiKey = 'yourWalmartApiKey';
$linkSharePublisherId = 'yourId';

$httpClient        = new \GuzzleHttp\Client();
$errorHandler      = new \WalmartApiClient\Exception\Handler\ApiExceptionHandler();
$transportService  = new \WalmartApiClient\Http\TransportService($httpClient, $errorHandler, $apiUrl, $linkSharePublisherId);
```

Features
--------

[](#features)

Each of the available Services is a wrapper for one or more Walmart Open API services. The available methods' declarations and descriptions can be found in the [Service interfaces](https://github.com/Gadoma/walmart-api-php-client/tree/develop/src/WalmartApiClient/Service). Each of the methods returns either a single specific Entity (e.g. Product) or a Collection of Entities (e.g. Categories Collection).

### Product service

[](#product-service)

#### Integrates with

[](#integrates-with)

- [Product Lookup API](https://developer.walmartlabs.com/docs/read/Home)
- [Search API](https://developer.walmartlabs.com/docs/read/Search_API)
- [Product Recommendation API](https://developer.walmartlabs.com/docs/read/Product_Recommendation_API)
- [Post Browsed Products API](https://developer.walmartlabs.com/docs/read/Post_Browsed_Products_API)
- [Trending API](https://developer.walmartlabs.com/docs/read/Trending_API)

#### Available methods

[](#available-methods)

- getById
- getByUpc
- getByIds
- getBySearch
- getAllBySearch
- getPostbrowsedById
- getRecommendedById
- getTrending

### Offer service

[](#offer-service)

#### Integrates with

[](#integrates-with-1)

- [Special Feeds API](https://developer.walmartlabs.com/docs/read/Special_Feeds)

#### Available methods

[](#available-methods-1)

- getVod
- getPreorder
- getBestsellers
- getRollback
- getClearance
- getSpecialbuy

### Review service

[](#review-service)

#### Integrates with

[](#integrates-with-2)

- [Reviews API](https://developer.walmartlabs.com/docs/read/Reviews_Api)

#### Available methods

[](#available-methods-2)

- getReviews

### Store service

[](#store-service)

#### Integrates with

[](#integrates-with-3)

- [Store Locator API](https://developer.walmartlabs.com/docs/read/Store_Locator_API)

#### Available methods

[](#available-methods-3)

- getStoresByCoordinates
- getStoresByCity
- getStoresByZip

### Taxonomy service

[](#taxonomy-service)

#### Integrates with

[](#integrates-with-4)

- [Taxonomy API](https://developer.walmartlabs.com/docs/read/Taxonomy_API)

#### Available methods

[](#available-methods-4)

- getCategories

###  Health Score

36

—

LowBetter than 82% of packages

Maintenance15

Infrequent updates — may be unmaintained

Popularity34

Limited adoption so far

Community14

Small or concentrated contributor base

Maturity67

Established project with proven stability

 Bus Factor1

Top contributor holds 94.1% 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 ~434 days

Total

5

Last Release

1954d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/a2b26c4acdf11472a5cf8cc970af890cd7230067dff038ba259a8ff8444c10b8?d=identicon)[Gadoma](/maintainers/Gadoma)

---

Top Contributors

[![Gadoma](https://avatars.githubusercontent.com/u/4981829?v=4)](https://github.com/Gadoma "Gadoma (16 commits)")[![runofthemill](https://avatars.githubusercontent.com/u/8418440?v=4)](https://github.com/runofthemill "runofthemill (1 commits)")

---

Tags

apiclientwalmart

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/gadoma-walmart-api-php-client/health.svg)

```
[![Health](https://phpackages.com/badges/gadoma-walmart-api-php-client/health.svg)](https://phpackages.com/packages/gadoma-walmart-api-php-client)
```

###  Alternatives

[openai-php/laravel

OpenAI PHP for Laravel is a supercharged PHP API client that allows you to interact with the Open AI API

3.7k7.6M74](/packages/openai-php-laravel)[resend/resend-php

Resend PHP library.

574.7M21](/packages/resend-resend-php)[crowdin/crowdin-api-client

PHP client library for Crowdin API v2

611.5M5](/packages/crowdin-crowdin-api-client)[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)[markrogoyski/numverify-api-client-php

Numverify API Client for PHP

1220.9k](/packages/markrogoyski-numverify-api-client-php)[azuracast/php-api-client

An API client library for the AzuraCast API

311.3k](/packages/azuracast-php-api-client)

PHPackages © 2026

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