PHPackages                             jtl-scx/channel-api-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. jtl-scx/channel-api-client

Abandoned → [https://github.com/jtl-scx/channel-core](/?search=https%3A%2F%2Fgithub.com%2Fjtl-scx%2Fchannel-core)ArchivedLibrary[API Development](/categories/api)

jtl-scx/channel-api-client
==========================

API Client for SCX Channel API

0.51.0(4y ago)113.7k1[7 PRs](https://github.com/jtl-scx/channel-api-client/pulls)MITPHPPHP ^7.4|8.0.\*

Since Feb 24Pushed 3y ago1 watchersCompare

[ Source](https://github.com/jtl-scx/channel-api-client)[ Packagist](https://packagist.org/packages/jtl-scx/channel-api-client)[ RSS](/packages/jtl-scx-channel-api-client/feed)WikiDiscussions master Synced today

READMEChangelog (10)Dependencies (7)Versions (77)Used By (0)

 [![](https://user-images.githubusercontent.com/1415186/75040771-2ed7df80-54b3-11ea-8657-41a0cae9dafc.png)](https://user-images.githubusercontent.com/1415186/75040771-2ed7df80-54b3-11ea-8657-41a0cae9dafc.png)

SCX PHP-Channel-API-Client
==========================

[](#scx-php-channel-api-client)

[![Releases](https://camo.githubusercontent.com/cad8d036d273b77c6c3d514733057f7852f4822bf40ff979fcc657eaaae225cd/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f762f7461672f6a746c2d7363782f6368616e6e656c2d6170692d636c69656e74)](https://camo.githubusercontent.com/cad8d036d273b77c6c3d514733057f7852f4822bf40ff979fcc657eaaae225cd/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f762f7461672f6a746c2d7363782f6368616e6e656c2d6170692d636c69656e74)[![Testing](https://github.com/jtl-scx/channel-api-client/workflows/Testing/badge.svg)](https://github.com/jtl-scx/channel-api-client/workflows/Testing/badge.svg) [![codecov](https://camo.githubusercontent.com/85be04e54bd4e2ccb2f16baba447c8a0f18037ef50df6f9e4137ec618df4fd08/68747470733a2f2f636f6465636f762e696f2f67682f6a746c2d7363782f6368616e6e656c2d6170692d636c69656e742f6272616e63682f6d61737465722f67726170682f62616467652e7376673f746f6b656e3d594e4641325a524b3936)](https://codecov.io/gh/jtl-scx/channel-api-client)

SCX Channel-API Client repository for JTL-Sales-Channel-Extension based on PHP.

[Channel API Documentation](https://scx-sandbox.ui.jtl-software.com/docs/api_channel.html)

Usage
-----

[](#usage)

```
use JTL\SCX\Client\Api\AuthAwareApiClient;
use JTL\SCX\Client\Api\Configuration;
use JTL\SCX\Client\Channel\Api\Attribute\AttributesApi;
use JTL\SCX\Client\Channel\Api\Category\CategoryApi;
use JTL\SCX\Client\Channel\Api\Event\EventApi;
use JTL\SCX\Client\Channel\Api\Notification\NotificationApi;
use JTL\SCX\Client\Channel\Api\Offer\OfferApi;
use JTL\SCX\Client\Channel\Api\Order\OrderApi;
use JTL\SCX\Client\Channel\Api\Price\PriceApi;
use JTL\SCX\Client\Channel\Api\Report\ReportApi;
use JTL\SCX\Client\Channel\Api\Seller\SellerApi;

$configuration = new Configuration(
    Configuration::HOST_PRODUCTION,
    $_ENV['refreshToken']
);

// create a AuthAwareApiClient to handle authentication
$client = new AuthAwareApiClient($configuration);

// read and acknowledge seller events
$eventApi = new EventApi($client);

// manage sellers (create)
$sellerApi = new SellerApi($client);

// manage meta data such as Categories, Attributes or Price
$attributesApi = new AttributesApi($client);
$categoryApi = new CategoryApi($client);
$priceApi = new PriceApi($client);

// manage orders (send new orders, update order status or address information)
$orderApi = new OrderApi($client);

// manage offers (mark in progress, mark as listed, mark as listing failed)
$offerApi = new OfferApi($client);

// Send a notification message back to SCX Channel API.
$notificationApi = new NotificationApi($client);

// Send requested Report back to SCX
$reportingApi = new ReportApi($client);
// Send SELLER_INVENTORY Report
// see tests/Api/Report/Request/SendReportRequestTest.php
```

Working with Events
-------------------

[](#working-with-events)

Seller events are one of the most important features in SCX-Channel-Api. A Seller Event is created by a Seller API Implementation, such as JTL-Wawi to request a action by the existing channel integration.

See `JTL\SCX\Client\Channel\Event\EventType` for a list of existing Events.

```
use JTL\SCX\Client\Channel\Api\Event\EventApi;
use JTL\SCX\Client\Channel\Api\Event\Request\GetEventListRequest;

$eventApi = new EventApi($authAwareApiClient);

// read a bulk of unacknowledged events from SCX Channel Api
$sellerEventList = $eventApi->get();
foreach ($sellerEventList->getEventList() as $eventContainer) {

    // The Id of the event use this id to acknowledge event after processing
    $id = $eventContainer->getId();

    // Datetime when the event was created
    $createdAt = $eventContainer->getCreatedAt();

    // The Event Type
    $type = $eventContainer->getType();

    // The Event itself
    $eventModel = $eventContainer->getEvent();

    // processEvent($eventContainer)

    // finally acknowledge event after processing
    $eventApi->ack(new AcknowledgeEventIdListRequest([$id]));
}
```

###  Health Score

35

—

LowBetter than 79% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity26

Limited adoption so far

Community13

Small or concentrated contributor base

Maturity66

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 ~11 days

Total

57

Last Release

1643d ago

PHP version history (2 changes)0.9.0PHP ^7.4

0.33.0PHP ^7.4|8.0.\*

### Community

Maintainers

![](https://www.gravatar.com/avatar/38c22ffd540333580cddea1fb869a3f32e5ffd1cadc4b06e84eb2f01658ce961?d=identicon)[eazyAuctionDev](/maintainers/eazyAuctionDev)

---

Top Contributors

[![sleipi](https://avatars.githubusercontent.com/u/1415186?v=4)](https://github.com/sleipi "sleipi (61 commits)")[![Das-Ente](https://avatars.githubusercontent.com/u/20517536?v=4)](https://github.com/Das-Ente "Das-Ente (35 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (27 commits)")[![BrandtM](https://avatars.githubusercontent.com/u/20184278?v=4)](https://github.com/BrandtM "BrandtM (16 commits)")

---

Tags

jtlopenapiphp

###  Code Quality

TestsPHPUnit

Static AnalysisPHPStan, Psalm

Code StylePHP CS Fixer

Type Coverage Yes

### Embed Badge

![Health badge](/badges/jtl-scx-channel-api-client/health.svg)

```
[![Health](https://phpackages.com/badges/jtl-scx-channel-api-client/health.svg)](https://phpackages.com/packages/jtl-scx-channel-api-client)
```

###  Alternatives

[netflie/whatsapp-cloud-api

The first PHP SDK to send and receive messages using a cloud-hosted version of the WhatsApp Business Platform

640431.7k4](/packages/netflie-whatsapp-cloud-api)[php-twinfield/twinfield

Library for using the Twinfield Soap Service.

33769.2k1](/packages/php-twinfield-twinfield)[paddlehq/paddle-php-sdk

Paddle's PHP SDK for Paddle Billing.

53301.7k](/packages/paddlehq-paddle-php-sdk)[oxid-esales/graphql-base

OXID eSales GraphQL base module

24101.0k10](/packages/oxid-esales-graphql-base)[simivar/genius-php

Genius PHP is a open source library that allows you to access Genius API from your PHP application. Supports every resource.

13171.7k](/packages/simivar-genius-php)[lmc/matej-client

API Client for Matej recommendation engine

1159.5k](/packages/lmc-matej-client)

PHPackages © 2026

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