PHPackages                             hitmeister/api-sdk - 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. hitmeister/api-sdk

ActiveLibrary[API Development](/categories/api)

hitmeister/api-sdk
==================

Kaufland.de onlineshop API SDK for PHP

1.54.0(3y ago)24117.3k↓20.6%28[15 issues](https://github.com/hitmeister/api-sdk-php/issues)[5 PRs](https://github.com/hitmeister/api-sdk-php/pulls)MITPHPPHP &gt;=5.4.0CI failing

Since Sep 23Pushed 2y ago13 watchersCompare

[ Source](https://github.com/hitmeister/api-sdk-php)[ Packagist](https://packagist.org/packages/hitmeister/api-sdk)[ Docs](https://www.kaufland.de/api/v1/)[ RSS](/packages/hitmeister-api-sdk/feed)WikiDiscussions develop Synced 1mo ago

READMEChangelog (10)Dependencies (6)Versions (74)Used By (0)

Kaufland.de Onlineshop - API SDK for PHP [![Build Status](https://camo.githubusercontent.com/df336bae6593eb909e36c9177f8a0ae12703dcfc5716ea24adb35de6399af0c0/68747470733a2f2f7472617669732d63692e6f72672f6869746d6569737465722f6170692d73646b2d7068702e7376673f6272616e63683d646576656c6f70)](https://travis-ci.org/hitmeister/api-sdk-php)
============================================================================================================================================================================================================================================================================================================================================

[](#kauflandde-onlineshop---api-sdk-for-php-)

[![Latest Stable Version](https://camo.githubusercontent.com/d8b96753d37f3344f08d7392afaad3cb813561055fd6bbbfd264f2e30dcd1095/687474703a2f2f696d672e736869656c64732e696f2f6769746875622f72656c656173652f6869746d6569737465722f6170692d73646b2d7068702e737667)](https://packagist.org/packages/hitmeister/api-sdk)[![Coverage Status](https://camo.githubusercontent.com/e86275fb40be9271082a4366508a5271ee7f8fd9ad4d4a8a1c2eabf2b18d6335/68747470733a2f2f636f766572616c6c732e696f2f7265706f732f6769746875622f6869746d6569737465722f6170692d73646b2d7068702f62616467652e7376673f6272616e63683d6d6173746572)](https://coveralls.io/github/hitmeister/api-sdk-php?branch=master)[![Total Downloads](https://camo.githubusercontent.com/9df8a500786350779fc5ab5eabc042107690f92836851f3e96938d3b4d5205de/687474703a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f6869746d6569737465722f6170692d73646b2e737667)](https://packagist.org/packages/hitmeister/api-sdk)

PHP client for [Kaufland.de Onlineshop API](https://www.kaufland.de/api/v1/).

Install
-------

[](#install)

Via Composer

```
$ composer require hitmeister/api-sdk
```

Via GitHub

```
$ git clone git@github.com:hitmeister/api-sdk-php.git
```

Quickstart
----------

[](#quickstart)

This section will give you a quick overview of the client and how the major functions work.

### Create client

[](#create-client)

Before starting, you will need the API keys from your [API settings page](https://www.kaufland.de/account/apisettings/). Also please provide the name of your partner solution name to the setUserAgent() field.

Include the autoloader in your main project (if you haven’t already), and instantiate a new client.

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

use Hitmeister\Component\Api\ClientBuilder;

$client = ClientBuilder::create()
	->setClientKey('YOUR_CLIENT_KEY')
	->setClientSecret('YOUR_CLIENT_SECRET')
	->setUserAgent('YOUR_USER_AGENT')
	->build();
```

### Namespaces overview

[](#namespaces-overview)

The client has a number of "namespaces", which generally expose API functionality. The namespaces correspond to the various API endpoints. This is a complete list of namespaces:

NamespaceFunctionality`attributes()`Retrieve the attributes data`categories()`Retrieve the categories data`claimMessages()`Post messages to the claim **DEPRECATED**, use `ticketMessages``claims()`Retrieve and manage the claims **DEPRECATED**, use `tickets``importFiles()`To send inventory data for multiple items at once`items()`Retrieve the product data`orders()`Retrieve the orders data`orderInvoices()`Retrieve and manage order invoices data`orderUnits()`Retrieve and manage your order units`productData()`Upload or change your product data for an EAN`productDataStatus()`Retrieve the status of your product data`reports()`Generate and retrieve summary reports`returns()`Retrieve the returns from your sales`returnUnits()`Accept, reject or repair returns from your sales`shipments()`Add shipment information to order units`shippingGroups()`Retrieve the shipping groups data`status()`System status`subscriptions()`Push notifications management`ticketMessages()`Post messages to the tickets`tickets( )`Manage tickets, i.e. N-to-N relations between order-units and claims`warehouses()`Warehouses management`units()`To upload inventory data one item at a time### Retrieve the categories data

[](#retrieve-the-categories-data)

You can search for categories:

```
$categories = $client->categories()->find('handy');
foreach ($categories as $category) {
	echo "Category ID: {$category->id_category}\n";
	echo "Category Name: {$category->name}\n";
}
```

Or get the information about one of them:

```
$category = $client->categories()->get(1);
echo "Category ID: {$category->id_category}\n";
echo "Category Name: {$category->name}\n";
```

### Retrieve the product data

[](#retrieve-the-product-data)

Search for items:

```
$items = $client->items()->find('iphone');
foreach ($items as $item) {
	$eans = implode(',', $item->eans);
	echo "Item ID: {$item->id_item}\n";
	echo "Category ID: {$item->id_category}\n";
	echo "Title: {$item->title}\n";
	echo "EANs: {$eans}\n";
}
```

Also you can find the items by EAN:

```
$items = $client->items()->findByEan('0885909781652');
```

### Send inventory data

[](#send-inventory-data)

According to the [API documentation](https://www.kaufland.de/api/v1/?page=product-data#uploading-and-updating-items) you have two options:

#### To upload your product data as CSV file

[](#to-upload-your-product-data-as-csv-file)

```
// Post the task to import your file. You will have the ID of the task.
$importFileId = $client->importFiles()
	->post('http://www.example.com/my_products.csv', 'PRODUCT_FEED');

// Retrieve the information about your task
$data = $client->importFiles()->get($importFileId);
echo "URL: {$data->uri}\n";
echo "Status: {$data->status}\n";
```

#### To update a single unit

[](#to-update-a-single-unit)

```
// $result will be true or false
$result = $client->units()->update(10, ['condition' => 'new']);
```

Testing
-------

[](#testing)

```
$ composer test
```

License
-------

[](#license)

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

###  Health Score

41

—

FairBetter than 89% of packages

Maintenance8

Infrequent updates — may be unmaintained

Popularity43

Moderate usage in the ecosystem

Community30

Small or concentrated contributor base

Maturity73

Established project with proven stability

 Bus Factor1

Top contributor holds 51.3% 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 ~51 days

Recently: every ~185 days

Total

55

Last Release

1119d ago

Major Versions

0.1.3 → 1.6.02016-07-01

### Community

Maintainers

![](https://www.gravatar.com/avatar/92b6b5d852eb4d345e999bf340ce84c5ccc70a8f3201b7708172f2cfeee0f4c9?d=identicon)[hitmeister](/maintainers/hitmeister)

![](https://www.gravatar.com/avatar/114f12fd3dbbb4922557c343e2ad082d5658fde4873490c3f61e39799db62df8?d=identicon)[aazon](/maintainers/aazon)

---

Top Contributors

[![aazon](https://avatars.githubusercontent.com/u/378058?v=4)](https://github.com/aazon "aazon (81 commits)")[![digitalcrab](https://avatars.githubusercontent.com/u/3217929?v=4)](https://github.com/digitalcrab "digitalcrab (10 commits)")[![odombrovskyi-dev](https://avatars.githubusercontent.com/u/4992072?v=4)](https://github.com/odombrovskyi-dev "odombrovskyi-dev (8 commits)")[![NastiaNovik](https://avatars.githubusercontent.com/u/24484545?v=4)](https://github.com/NastiaNovik "NastiaNovik (6 commits)")[![m074554n](https://avatars.githubusercontent.com/u/8243067?v=4)](https://github.com/m074554n "m074554n (6 commits)")[![johnholiver](https://avatars.githubusercontent.com/u/38569?v=4)](https://github.com/johnholiver "johnholiver (4 commits)")[![Datiswaken](https://avatars.githubusercontent.com/u/40599882?v=4)](https://github.com/Datiswaken "Datiswaken (4 commits)")[![FFluche](https://avatars.githubusercontent.com/u/50012081?v=4)](https://github.com/FFluche "FFluche (4 commits)")[![philippkraetsch](https://avatars.githubusercontent.com/u/12710755?v=4)](https://github.com/philippkraetsch "philippkraetsch (4 commits)")[![mansurs](https://avatars.githubusercontent.com/u/627138?v=4)](https://github.com/mansurs "mansurs (3 commits)")[![jecknig](https://avatars.githubusercontent.com/u/14073355?v=4)](https://github.com/jecknig "jecknig (3 commits)")[![yya](https://avatars.githubusercontent.com/u/1681268?v=4)](https://github.com/yya "yya (3 commits)")[![phil-schreiber](https://avatars.githubusercontent.com/u/1511199?v=4)](https://github.com/phil-schreiber "phil-schreiber (2 commits)")[![abdul-jabbar01](https://avatars.githubusercontent.com/u/22825645?v=4)](https://github.com/abdul-jabbar01 "abdul-jabbar01 (2 commits)")[![mschni2s](https://avatars.githubusercontent.com/u/45952127?v=4)](https://github.com/mschni2s "mschni2s (2 commits)")[![dariusbepunkt](https://avatars.githubusercontent.com/u/4473944?v=4)](https://github.com/dariusbepunkt "dariusbepunkt (2 commits)")[![ajibolam](https://avatars.githubusercontent.com/u/7952721?v=4)](https://github.com/ajibolam "ajibolam (1 commits)")[![NoorKaru](https://avatars.githubusercontent.com/u/273316515?v=4)](https://github.com/NoorKaru "NoorKaru (1 commits)")[![p-solutions](https://avatars.githubusercontent.com/u/29493267?v=4)](https://github.com/p-solutions "p-solutions (1 commits)")[![radarlog](https://avatars.githubusercontent.com/u/1484339?v=4)](https://github.com/radarlog "radarlog (1 commits)")

---

Tags

apisdkhitmeisterreal.dekauflandreal.digitalreal-digitalkaufland-sdkkaufland.de

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/hitmeister-api-sdk/health.svg)

```
[![Health](https://phpackages.com/badges/hitmeister-api-sdk/health.svg)](https://phpackages.com/packages/hitmeister-api-sdk)
```

###  Alternatives

[temporal/sdk

Temporal SDK

4002.2M18](/packages/temporal-sdk)[webit/w-firma-api

wFirma.pl API

1820.2k](/packages/webit-w-firma-api)[justcommunication-ru/tinkoff-acquiring-api-client

Tinkoff Acquiring API PHP Client

102.5k](/packages/justcommunication-ru-tinkoff-acquiring-api-client)

PHPackages © 2026

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