PHPackages                             dvomaks/promua-api - 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. dvomaks/promua-api

ActiveLibrary[API Development](/categories/api)

dvomaks/promua-api
==================

Laravel package for PromUA API integration with consistent service methods

1.1.3(7mo ago)02MITPHPPHP ^8.2CI passing

Since Oct 1Pushed 7mo agoCompare

[ Source](https://github.com/dvomaks/promua-api)[ Packagist](https://packagist.org/packages/dvomaks/promua-api)[ Docs](https://github.com/dvomaks/promua-api)[ GitHub Sponsors](https://github.com/dvomaks)[ RSS](/packages/dvomaks-promua-api/feed)WikiDiscussions main Synced 1mo ago

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

PromUA API Package
==================

[](#promua-api-package)

[![PHP Version](https://camo.githubusercontent.com/81943898d70129d190ba5d385a8758459ce57e7795b5122e1a148f4387a55131/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f7068702d382e322b2d626c75652e737667)](https://php.net/)[![Laravel Version](https://camo.githubusercontent.com/2d53d2a361313eb34c21858f3cdaf291564d2b217a28cd79f130f5eab3ce3d4d/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c61726176656c2d31312e302b2d7265642e737667)](https://laravel.com/)[![License](https://camo.githubusercontent.com/8bb50fd2278f18fc326bf71f6e88ca8f884f72f179d3e555e20ed30157190d0d/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d677265656e2e737667)](https://opensource.org/licenses/MIT)[![CircleCI](https://camo.githubusercontent.com/967d2ec1759f3054025f2702b3cd1ac50fd2ac20722fb1c31fbc47f42dfec57a/68747470733a2f2f646c2e636972636c6563692e636f6d2f7374617475732d62616467652f696d672f67682f64766f6d616b732f70726f6d75612d6170692f747265652f6d61696e2e7376673f7374796c653d737667)](https://dl.circleci.com/status-badge/redirect/gh/dvomaks/promua-api/tree/main)[![Packagist Version](https://camo.githubusercontent.com/254bbe5eacf032b36e1891d505070bfcb91ee388d5f5af551f0c8ba3c001013e/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f64766f6d616b732f70726f6d75612d6170692e7376673f7374796c653d666c617426636f6c6f723d6f72616e6765)](https://packagist.org/packages/dvomaks/promua-api)[![Total Downloads](https://camo.githubusercontent.com/bd7e45acd45b6d61f6ac40217c3f48a531f49bab4c9936afc516a99e8ff41160/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f64766f6d616b732f70726f6d75612d6170692e7376673f7374796c653d666c617426636f6c6f723d627269676874677265656e)](https://packagist.org/packages/dvomaks/promua-api)[![Coverage Status](https://camo.githubusercontent.com/b054b0876c09842be3059ec7c4b35917a2fe38450d9b528d7cb3d02e1b629d2e/68747470733a2f2f696d672e736869656c64732e696f2f636f6465636f762f632f6769746875622f64766f6d616b732f70726f6d75612d6170692f6d61696e2e737667)](https://codecov.io/gh/dvomaks/promua-api)[![Static Analysis](https://camo.githubusercontent.com/1720de5286ee5b4ddda5a2c8f833f435014c0f924afefb4c40089e44485e118e/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f5048505374616e2d6c6576656c253230352d626c756576696f6c6574)](https://phpstan.org/)[![Docs](https://camo.githubusercontent.com/4683832e1d7d957d912b5a294dcc3a2eacb1fe80b2e2fff49748131717f145bc/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f646f63732d756b2d626c75653f7374796c653d666c6174266c6f676f3d726561642d7468652d646f6373)](https://my.prom.ua/api/v1/docs)[![PHP Types](https://camo.githubusercontent.com/00d333ab584663f5603788a4e79415402c5fbbce983d254ae874bcee8d3367db/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f74797065732d7374726963742d677265656e3f7374796c653d666c6174266c6f676f3d706870)](https://www.php.net/manual/en/language.types.declarations.php)[![Last Commit](https://camo.githubusercontent.com/08ea45c54d0fae4c52ed0038c3017faab17af30a5c16a7298796845fb29380b9/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c6173742d636f6d6d69742f64766f6d616b732f70726f6d75612d6170692f6d61696e2e7376673f7374796c653d666c617426636f6c6f723d79656c6c6f77)](https://github.com/dvomaks/promua-api/commits/main)[![Tests](https://camo.githubusercontent.com/3a2b10dd0a3bc288eee10321335e5c3b9f21b4aefb15c5cc25caa6291e845a9b/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f74657374732d70617373696e672d627269676874677265656e3f7374796c653d666c6174266c6f676f3d706870)](https://github.com/dvomaks/promua-api/actions?query=workflow%3ATests)[![Code Style](https://camo.githubusercontent.com/dd0ebe1ac33704bd5f7987fce0a6fae438f0804e8ff50161f3fa38e18afe71c6/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f636f64652532307374796c652d50696e742d6666363962343f7374796c653d666c6174266c6f676f3d6c61726176656c)](https://laravel.com/docs/pint)

> Потужний Laravel пакет для інтеграції з PromUA API - провідною українською e-commerce платформою

📋 Зміст
-------

[](#-зміст)

- [Про проект](#-%D0%BF%D1%80%D0%BE-%D0%BF%D1%80%D0%BE%D0%B5%D0%BA%D1%82)
- [Можливості](#-%D0%BC%D0%BE%D0%B6%D0%BB%D0%B8%D0%B2%D0%BE%D1%81%D1%82%D1%96)
- [Встановлення](#-%D0%B2%D1%81%D1%82%D0%B0%D0%BD%D0%BE%D0%B2%D0%BB%D0%B5%D0%BD%D0%BD%D1%8F)
- [Налаштування](#-%D0%BD%D0%B0%D0%BB%D0%B0%D1%88%D1%82%D1%83%D0%B2%D0%B0%D0%BD%D0%BD%D1%8F)
- [Використання](#-%D0%B2%D0%B8%D0%BA%D0%BE%D1%80%D0%B8%D1%81%D1%82%D0%B0%D0%BD%D0%BD%D1%8F)
- [Приклади коду](#-%D0%BF%D1%80%D0%B8%D0%BA%D0%BB%D0%B0%D0%B4%D0%B8-%D0%BA%D0%BE%D0%B4%D1%83)
- [Документація API](#-%D0%B4%D0%BE%D0%BA%D1%83%D0%BC%D0%B5%D0%BD%D1%82%D0%B0%D1%86%D1%96%D1%8F-api)
- [Тестування](#-%D1%82%D0%B5%D1%81%D1%82%D1%83%D0%B2%D0%B0%D0%BD%D0%BD%D1%8F)
- [Внесок у розробку](#-%D0%B2%D0%BD%D0%B5%D1%81%D0%BE%D0%BA-%D1%83-%D1%80%D0%BE%D0%B7%D1%80%D0%BE%D0%B1%D0%BA%D1%83)
- [Ліцензія](#-%D0%BB%D1%96%D1%86%D0%B5%D0%BD%D0%B7%D1%96%D1%8F)

🚀 Про проект
------------

[](#-про-проект)

Цей пакет надає повноцінний PHP SDK для роботи з [PromUA API](https://prom.ua/) - однієї з найбільших e-commerce платформ України. Пакет дозволяє легко інтегрувати ваш Laravel додаток з PromUA для синхронізації замовлень, товарів, клієнтів та інших даних.

### Основні особливості

[](#основні-особливості)

- ✅ **Повна підтримка PromUA API v1**
- ✅ **Типізовані DTO для всіх відповідей**
- ✅ **Обробка помилок та винятків**
- ✅ **Гнучкі налаштування HTTP клієнта**
- ✅ **Всебічне тестування**
- ✅ **Документація українською мовою**
- ✅ **Сумісність з Laravel 11+**

🎯 Можливості
------------

[](#-можливості)

### 📦 Управління замовленнями

[](#-управління-замовленнями)

- Отримання списку замовлень з фільтрацією
- Отримання детальної інформації про замовлення
- Оновлення статусів замовлень
- Прикріплення квитанцій
- Обробка повернень

### 🛍️ Управління товарами

[](#️-управління-товарами)

- Отримання списку товарів
- Отримання товарів за зовнішнім ID
- Створення та редагування товарів
- Імпорт товарів через URL або файл
- Управління перекладами товарів

### 👥 Робота з клієнтами

[](#-робота-з-клієнтами)

- Отримання списку клієнтів
- Детальна інформація про клієнтів

### 💬 Система повідомлень

[](#-система-повідомлень)

- Отримання списку повідомлень
- Відповіді на повідомлення
- Управління статусами повідомлень

### 🗨️ Чат функціонал

[](#️-чат-функціонал)

- Отримання кімнат чату
- Історія повідомлень
- Надсилання повідомлень та файлів
- Позначення повідомлень як прочитаних

### 📁 Групи товарів

[](#-групи-товарів)

- Отримання списку груп
- Управління перекладами груп

### 💳 Способи оплати

[](#-способи-оплати)

- Отримання доступних способів оплати

### 🚚 Способи доставки

[](#-способи-доставки)

- Отримання способів доставки
- Збереження декларацій доставки

📦 Встановлення
--------------

[](#-встановлення)

### 1. Вимоги

[](#1-вимоги)

- PHP 8.2 або вище
- Laravel 11.0 або вище
- Composer

### 2. Встановлення через Composer

[](#2-встановлення-через-composer)

```
composer require dvomaks/promua-api
```

### 3. Публікація конфігурації

[](#3-публікація-конфігурації)

```
php artisan vendor:publish --provider="Dvomaks\PromuaApi\PromuaApiServiceProvider"
```

⚙️ Налаштування
---------------

[](#️-налаштування)

### 1. Змінні оточення

[](#1-змінні-оточення)

Додайте наступні змінні до вашого `.env` файлу:

```
# PromUA API Configuration
PROMUA_API_TOKEN=your_api_token_here
PROMUA_BASE_URL=https://my.prom.ua/api/v1
PROMUA_TIMEOUT=30
PROMUA_LANGUAGE=uk
```

### 2. Конфігурація (config/promua-api.php)

[](#2-конфігурація-configpromua-apiphp)

```