codetiv / upgates-php-sdk

dev-main 2026-09-21 12:18 UTC

Requires

• nesbot/carbon: ^3.14
• saloonphp/pagination-plugin: ^2.0
• saloonphp/saloon: ^4.0

Requires (Dev)

• laravel/pint: ^1.18
• symfony/var-dumper: ^8.1

MIT

• Pavel Skrbel

• php
• api
• sdk
• upgates

Published on Packagist.org on 2026-09-21 12:19 UTC

README

Upgates PHP SDK

Elegant SDK written in PHP to work with the Upgates API, built with Saloon v4.

use Codetiv\Upgates\Sdk\Upgates;

$upgates = new Upgates(
    storeName: 'dev-shop-1',
    serverMark: 't1',
    apiLogin: '11111111',
    apiKey: 'rdK2STJcJVWqq2G1'
);

// Uses product resource to get complete product's list
$products = $upgates->products()->listComplete();

foreach ($products as $item) {
    echo 'Product: ' . $item['code'] . PHP_EOL;
}

Installation

composer require codetiv/upgates-php-sdk

Upgates API documentation

To get started, we highly recommend reading the API documentation.

Usage & Authentication

To communicate with the API, you'll need to create an integration access. You can do this in the e-shop admin panel under the “Add-ons / API” section.

After you create new integration, you will need apiLogin and apiKey values - found in the LOGIN and KLÍČ API (API KEY) columns of the API integrations table. Note: the API key is hidden by default - click to reveal it before copying.

You'll also need your storeName and serverMark values, which you can find in your API access URL. After creating an API integration in your admin panel, you'll see a URL below the API integrations table in the following format:

https://PROJECT.admin.SERVER.upgates.com/api/v2

• storeName = the PROJECT part (e.g. if the URL is https://mystore.admin.s10.upgates.com/api/v2, storeName is mystore)
• serverMark = the SERVER part (e.g. s10)

After you have all of that you can instantiate the SDK:

use Codetiv\Upgates\Sdk\Upgates;

$upgates = new Upgates(
    storeName: 'mystore',
    serverMark: 's10',
    apiLogin: '11111111',
    apiKey: 'rdK2STJcJVWqq2G1'
);

API coverage

Resource checklist based on the official API reference.

• Articles (Články)
• Availabilities (Dostupnosti)
• Shipments (Dopravy)
• Invoices (Faktury)
• Languages (Jazyky)
• News (Aktuality)
• Price lists (Ceníky)
• E-shop settings (Nastavení eshopu)
• Shop operator (Provozovatel eshopu)
• API status (Status)
• Conversion codes (Konverzní kódy)
• Shopping carts (Košíky)
• Products (Produkty)
• Product lists (Produkty - seznamy)
• Product reviews & ratings (Produkty - recenze a hodnocení)
• Manufacturers (Výrobci)
• Parameters (Parametry)
• Custom fields (Vlastní pole)
• Tags (Štítky)
• Warehouses (Sklady)
• Orders (Objednávky)
• Order history (Objednávky - historie)
• Order attachments (Objednávky - přílohy)
• Order statuses (Stavy objednávek)
• Customers (Zákazníci)
• Customer groups (Skupiny zákazníků)
• Users (Uživatelé)
• Payments (Platby)
• Discount coupons (Slevové kupóny)
• Advisors (Rádce)
• Redirects (Přesměrování)
• Webhooks (Webhooky)
• Files (Soubory)
• Graphics — code editor (Grafika - editor kódu)
• Graphics — backups (Grafika - zálohy)