Skip to content
Snippets Groups Projects
Ilya Sleptsov's avatar
Ilya Sleptsov authored
0b68db97
History

PimClient

PIM

This PHP package is automatically generated by the OpenAPI Generator project:

  • API version: 1.0.0
  • Build package: org.openapitools.codegen.languages.PhpClientCodegen For more information, please visit https://greensight.ru/

Requirements

PHP 5.5 and later

Installation & Usage

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://gitlab.com/greensight/ensi/catalog/clients/pim-client-php.git"
    }
  ],
  "require": {
    "greensight/ensi/catalog/clients/pim-client-php": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/PimClient/vendor/autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new Ensi\PimClient\Api\BrandsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$create_brand_request = new \Ensi\PimClient\Dto\CreateBrandRequest(); // \Ensi\PimClient\Dto\CreateBrandRequest | 

try {
    $result = $apiInstance->createBrand($create_brand_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BrandsApi->createBrand: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Endpoints

All URIs are relative to http://localhost/api/v1

Class Method HTTP request Description
BrandsApi createBrand POST /classifiers/brands Запрос на создание нового бренда
BrandsApi deleteBrand DELETE /classifiers/brands/{id} Запрос на удаление бренда по ID
BrandsApi deleteBrandImage POST /classifiers/brands/{id}:delete-image Удаление текущей картинки бренда
BrandsApi getBrand GET /classifiers/brands/{id} Запрос бренда по ID
BrandsApi massDeleteBrands POST /classifiers/brands:mass-delete Массовое удаление брендов
BrandsApi patchBrand PATCH /classifiers/brands/{id} Обновляет отдельные поля бренда
BrandsApi replaceBrand PUT /classifiers/brands/{id} Запрос на обновление бренда
BrandsApi searchBrands POST /classifiers/brands:search Поиск брендов, удовлетворяющих фильтру
BrandsApi uploadBrandImage POST /classifiers/brands/{id}:upload-image Загрузка картинки для бренда
CategoriesApi bindCategoryProperties POST /categories/categories/{id}:bind-properties Запрос на изменение привязанных к категории атрибутов
CategoriesApi createCategory POST /categories/categories Запрос на создание новой категории
CategoriesApi deleteCategories POST /categories/categories:mass-delete Массовое удаление категорий
CategoriesApi deleteCategory DELETE /categories/categories/{id} Запрос на удаление категории
CategoriesApi deleteCategoryImage POST /categories/categories/{id}:delete-image Удаление текущей картинки категории
CategoriesApi getCategoriesTree POST /categories/categories:tree Формирование дерева категорий
CategoriesApi getCategory GET /categories/categories/{id} Запрос категории по ID
CategoriesApi patchCategory PATCH /categories/categories/{id} Запрос на обновление отдельных полей категории
CategoriesApi replaceCategory PUT /categories/categories/{id} Запрос на обновление категории
CategoriesApi searchCategories POST /categories/categories:search Поиск категорий, удовлетворяющих фильтру
CategoriesApi uploadCategoryImage POST /categories/categories/{id}:upload-image Загрузка картинки для категории
EnumsApi getMetricsCategories GET /classifiers/enums/metrics-categories Возвращает информацию о доступных метриках ваалидации товаров
EnumsApi getProductTypes GET /classifiers/enums/product-types Возвращает информацию о доступных типах товаров
EnumsApi getPropertyTypes GET /classifiers/enums/property-types Возвращает информацию о доступных типах атрибутов
ProductFieldsApi getProductField GET /classifiers/product-fields/{id} Получение настроек поля по идентификатору
ProductFieldsApi patchProductField PATCH /classifiers/product-fields/{id} Обновление настроек поля товара
ProductFieldsApi searchProductFields POST /classifiers/product-fields:search Поиск полей товаров, удовлетворяющих условиям отбора
ProductFlagsApi getProductFlag GET /classifiers/product-flags/{id} Получение признака по идентификатору
ProductFlagsApi replaceProductFlag PUT /classifiers/product-flags/{id} Обновление данных признака
ProductFlagsApi searchProductFlags POST /classifiers/product-flags:search Поиск признаков товаров, удовлетворяющих условиям отбора
ProductStatusesApi getProductStatus GET /classifiers/product-statuses/{id} Получение статуса по идентификатору
ProductStatusesApi replaceProductStatus PUT /classifiers/product-statuses/{id} Обновление данных статуса
ProductStatusesApi searchProductStatuses POST /classifiers/product-statuses:search Поиск статусов товаров, удовлетворяющих условиям отбора
ProductsApi createProduct POST /products/products Запрос на создание нового товара
ProductsApi deleteProduct DELETE /products/products/{id} Запрос на удаление товара
ProductsApi getProduct GET /products/published/{id} Запрос на получение опубликованной версии товара
ProductsApi getProductDraft GET /products/products/{id} Запрос на получение черновика товара
ProductsApi massDeleteProducts POST /products/products:mass-delete Массовое удаление товаров
ProductsApi patchProduct PATCH /products/products/{id} Запрос на обновление отдельных свойств товара
ProductsApi patchProductAttributes PATCH /products/products/{id}/attributes Обновление только заданных атрибутов товара
ProductsApi patchProductImages PATCH /products/products/{id}/images Обновление только заданных картинок
ProductsApi preloadProductImage POST /products/products:preload-image Загрузка картинки для товара или атрибута товара
ProductsApi replaceProduct PUT /products/products/{id} Запрос на обновление товара
ProductsApi replaceProductAttributes PUT /products/products/{id}/attributes Замещение всех атрибутов товара
ProductsApi replaceProductImages PUT /products/products/{id}/images Замещение всех картинок товара
ProductsApi searchProductDrafts POST /products/products:search Поиск черновиков товаров, удовлетворяющих фильтру
ProductsApi searchProducts POST /products/published:search Поиск опубликованных товаров, удовлетворяющих фильтру
PropertiesApi createDirectoryValue POST /categories/properties/{id}:add-directory Запрос на создание нового значения справочника
PropertiesApi createProperty POST /categories/properties Запрос на создание нового свойства
PropertiesApi deleteDirectoryValue DELETE /categories/properties/directory/{id} Запрос на удаление значения справочника
PropertiesApi deleteProperties POST /categories/properties:mass-delete Массовое удаление свойств
PropertiesApi deleteProperty DELETE /categories/properties/{id} Запрос на удаление свойства
PropertiesApi getDirectoryValue GET /categories/properties/directory/{id} Возвращает данные значения справочника
PropertiesApi getProperty GET /categories/properties/{id} Получение данных свойства
PropertiesApi patchDirectoryValue PATCH /categories/properties/directory/{id} Запрос на обновление отдельных атрибутов значения справочника
PropertiesApi patchProperty PATCH /categories/properties/{id} Запрос на обновление отдельных атрибутов свойства
PropertiesApi preloadDirectoryValueFile POST /categories/properties/directory:preload-file Загрузка файла для значения справочника
PropertiesApi preloadDirectoryValueImage POST /categories/properties/directory:preload-image Загрузка картинки для значения справочника
PropertiesApi replaceDirectoryValue PUT /categories/properties/directory/{id} Запрос на обновление значения справочника
PropertiesApi replaceProperty PUT /categories/properties/{id} Запрос на обновление свойства
PropertiesApi searchDirectoryValues POST /categories/properties/directory:search Поиск значений справочников, удовлетворяющих фильтру
PropertiesApi searchProperties POST /categories/properties:search Поиск свойств, удовлетворяющих фильтру
VariantsApi createVariantGroup POST /products/variants Запрос на создание новой склейки
VariantsApi deleteVariantGroup DELETE /products/variants/{id} Запрос на удаление склейки
VariantsApi getVariantGroup GET /products/variants/{id} Запрос на получение склейки товаров
VariantsApi patchVariantGroup PATCH /products/variants/{id} Запрос на обновление отдельных свойств склейки
VariantsApi replaceVariantGroup PUT /products/variants/{id} Запрос на обновление данных склейки
VariantsApi searchVariantGroups POST /products/variants:search Поиск склеек, удовлетворяющих фильтру

Documentation For Models

Documentation For Authorization

All endpoints do not require authorization.

Author