https://github.com/boolxy/trendyol
Trendyol API Client Library for PHP
https://github.com/boolxy/trendyol
php trendyol trendyol-api-client trendyol-api-services
Last synced: 5 months ago
JSON representation
Trendyol API Client Library for PHP
- Host: GitHub
- URL: https://github.com/boolxy/trendyol
- Owner: boolxy
- License: mit
- Created: 2020-02-20T12:22:27.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2021-03-23T19:00:07.000Z (over 5 years ago)
- Last Synced: 2025-09-22T05:36:33.471Z (9 months ago)
- Topics: php, trendyol, trendyol-api-client, trendyol-api-services
- Language: PHP
- Homepage:
- Size: 443 KB
- Stars: 36
- Watchers: 6
- Forks: 12
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
# Trendyol API Client Library for PHP
[](https://github.styleci.io/repos/241877329)
[](https://packagist.org/packages/boolxy/trendyol)
[](https://packagist.org/packages/boolxy/trendyol)
Developed according to SOLID principles.
Trendyol is the largest and fastest growing mobile commerce company in Turkey and in the MENA region.
This library is the easiest way to use Trendyol API services in PHP.
If you are a Trendyol partner and use PHP programming language on your own website, this package is perfect for you.
Services:
- Product Service
- Order Service
- Claim Service
- Settlement Service
## Installation
This package can be installed via Composer:
```bash
composer require boolxy/trendyol
```
## Usage
### Product Service
#### Get brands
```php
use Boolxy\Trendyol\Trendyol;
$results = Trendyol::create($user, $pass, $supplier_id)
->productService()
->getBrands();
```
#### Get brands by name
```php
use Boolxy\Trendyol\Trendyol;
$results = Trendyol::create($user, $pass, $supplier_id)
->productService()
->getBrandsByName("TRENDYOL");
```
#### Get categories
```php
use Boolxy\Trendyol\Trendyol;
$results = Trendyol::create($user, $pass, $supplier_id)
->productService()
->getCategories();
```
#### Get attributes by categoryId
```php
use Boolxy\Trendyol\Trendyol;
$categoryId = 387;
$results = Trendyol::create($user, $pass, $supplier_id)
->productService()
->getAttributes($categoryId);
```
#### Get shipment providers
```php
use Boolxy\Trendyol\Trendyol;
$results = Trendyol::create($user, $pass, $supplier_id)
->productService()
->getProviders();
```
#### Get suppliers addresses
```php
use Boolxy\Trendyol\Trendyol;
$results = Trendyol::create($user, $pass, $supplier_id)
->productService()
->getSuppliersAddresses();
```
#### Get batch request result
```php
use Boolxy\Trendyol\Trendyol;
$batchRequestId = '5631d1a1-ec81-496f-9407-99876554433-1529820717';
$results = Trendyol::create($user, $pass, $supplier_id)
->productService()
->getBatchRequestResult($batchRequestId);
```
#### Get products
```php
use Boolxy\Trendyol\Trendyol;
$results = Trendyol::create($user, $pass, $supplier_id)
->productService()
->getProducts();
```
with filters:
```php
use Boolxy\Trendyol\Trendyol;
use Boolxy\Trendyol\Enums\DateQueryType;
$results = Trendyol::create($user, $pass, $supplier_id)
->productService()
->gettingProducts()
->dateQueryType(DateQueryType::create(DateQueryType::LAST_MODIFIED_DATE))
->barcode('XXX')
->page(1)
->size(50)
// ...
->get();
```
#### Update price and inventory
```php
use Boolxy\Trendyol\Trendyol;
$items = [
[
"barcode" => "8680000000",
"quantity" => 100,
"salePrice" => 112.85,
"listPrice" => 113.85,
],
// ...
];
$service = Trendyol::create($user, $pass, $supplier_id)
->productService()
->updatingPriceAndInventory();
foreach($items as $item) {
$service->addItem(
$item["barcode"],
$item["quantity"],
$item["salePrice"],
$item["listPrice"]
);
}
$results = $service->update();
```
#### Create your own products on Trendyol
```php
use Boolxy\Trendyol\Trendyol;
use Boolxy\Trendyol\Models\Product;
$attributes = [ /* ... */ ];
$product1 = new Product($attributes);
$items = [
$product1,
// ...
];
$service = Trendyol::create($user, $pass, $supplier_id)
->productService()
->creatingProducts();
foreach($items as $item) {
$service->addProduct($item);
}
$result = $service->create();
```
### Order Service
#### Get shipment packages
```php
use Boolxy\Trendyol\Trendyol;
use Boolxy\Trendyol\Enums\ShipmentOrderBy;
use Boolxy\Trendyol\Enums\ShipmentStatus;
use Boolxy\Trendyol\Enums\OrderByDirection;
$results = Trendyol::create($user, $pass, $supplier_id)
->orderService()
->gettingShipmentPackages()
->status(ShipmentStatus::create(ShipmentStatus::DELIVERED))
->orderByField(ShipmentOrderBy::create(ShipmentOrderBy::PACKAGE_LAST_MODIFIED_DATE))
->orderByDirection(OrderByDirection::create(OrderByDirection::DESC))
->page(1)
->size(10)
// ...
->get();
```
#### Update tracking number
```php
use Boolxy\Trendyol\Trendyol;
$shipmentPackageId = 11650604;
$trackingNumber = "7340447182689";
$result = Trendyol::create($user, $pass, $supplier_id)
->orderService()
->updateTrackingNumber($shipmentPackageId, $trackingNumber);
```
#### Send invoice link
```php
use Boolxy\Trendyol\Trendyol;
$shipmentPackageId = 11650604;
$invoiceLink = "https://extfatura.faturaentegratoru.com/324523-34523-52345-3453245.pdf";
$result = Trendyol::create($user, $pass, $supplier_id)
->orderService()
->sendInvoiceLink($invoiceLink, $shipmentPackageId);
```
#### Splitting shipment package
```php
use Boolxy\Trendyol\Trendyol;
$result = Trendyol::create($user, $pass, $supplier_id)
->orderService()
->splittingShipmentPackage()
->setShipmentPackageId(11650604)
->addOrderLineId(2)
->addOrderLineId(3)
->addOrderLineId(4)
// ...
->split();
```
multi
```php
use Boolxy\Trendyol\Trendyol;
$result = Trendyol::create($user, $pass, $supplier_id)
->orderService()
->splittingShipmentPackageMulti()
->setShipmentPackageId(11650604)
->addGroup([ 3, 5, 6 ])
->addGroup([ 7, 8, 9 ])
// ...
->split();
```
by quantity
```php
use Boolxy\Trendyol\Trendyol;
$result = Trendyol::create($user, $pass, $supplier_id)
->orderService()
->splittingShipmentPackageByQuantity()
->setShipmentPackageId(11650604)
->addQuantitySplit($orderLineId = 0, [ 2, 2 ])
// ...
->split();
```
### Claim Service
#### Get claims
```php
use Boolxy\Trendyol\Trendyol;
use Boolxy\Trendyol\Enums\ClaimItemStatus;
$result = Trendyol::create($user, $pass, $supplier_id)
->claimService()
->gettingClaims()
->status(ClaimItemStatus::create(ClaimItemStatus::CREATED))
// ...
->get();
```
#### Approve claim line items
```php
use Boolxy\Trendyol\Trendyol;
$result = Trendyol::create($user, $pass, $supplier_id)
->claimService()
->approvingClaimLineItems()
->addClaimItemId("f9da2317-876b-4b86-b8f7-0535c3b65731")
// ...
->approve();
```
#### Create claim issue
```php
use Boolxy\Trendyol\Trendyol;
$result = Trendyol::create($user, $pass, $supplier_id)
->claimService()
->creatingClaimIssue()
->setClaimIssueReasonId(1)
->setClaimId("f9da2317-876b-4b86-b8f7-0535c3b65731")
->setClaimItemIdList("b71461e3-d1a0-4c1d-9a6d-18ecbcb5158c")
->addFile(__DIR__ . '/test.png')
// ...
->create();
```
#### Get claims issue reasons
```php
use Boolxy\Trendyol\Trendyol;
$results = Trendyol::create($user, $pass, $supplierId)
->claimService()
->getClaimsIssueReasons();
```
### Settlement Service
#### Get settlements
```php
use Boolxy\Trendyol\Trendyol;
use Boolxy\Trendyol\Enums\SettlementDateType;
$results = Trendyol::create($user, $pass, $supplierId)
->settlementService()
->gettingSettlements()
->dateType(SettlementDateType::create(SettlementDateType::ORDER))
->startDate(1557469159834)
->endDate(1557469159834)
// ...
->get();
```
## Composer scripts
With reviewing the tests, you can learn more about the package.
Before testing: Copy phpunit.xml.dist as phpunit.xml and update it. After then you can start the testing.
- Run the tests
```bash
composer test
```
- Check for PSR-2 standards
```bash
composer check
```
- Apply PSR-2 standards
```bash
composer fix
```
## API Documentation
- https://developers.trendyol.com/
## Credits
- [Sezai Ozarslan](https://github.com/sezaiozarslan)
- [All Contributors](https://github.com/boolxy/trendyol/graphs/contributors)
## License
The MIT License (MIT).
Please see [License File](https://github.com/boolxy/trendyol/blob/master/LICENSE.md) for more information.