belenka\Raynetcrm\ProduktApi

All URIs are relative to https://app.raynet.cz/api/v2, except if the operation defines another base path.

Method	HTTP request	Description
productDelete()	DELETE /product/{productId}/	smazání produktu
productDetailGet()	GET /product/{productId}/	detail produktu
productEdit()	POST /product/{productId}/	upravení produktu
productGet()	GET /product/	seznam produktů
productInsert()	PUT /product/	založení nového produktu
productInvalidEdit()	POST /product/{productId}/invalid	zneplatnění produktu
productValidEdit()	POST /product/{productId}/valid	obnovení platnosti produktu

`productDelete()`

productDelete($product_id)

smazání produktu

Example

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


// Configure API key authorization: instanceName
$config = belenka\Raynetcrm\Configuration::getDefaultConfiguration()->setApiKey('X-Instance-Name', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = belenka\Raynetcrm\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Instance-Name', 'Bearer');

// Configure HTTP basic authorization: basicAuth
$config = belenka\Raynetcrm\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new belenka\Raynetcrm\Api\ProduktApi(
    // 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(),
    $config
);
$product_id = 123; // int | ID produktu

try {
    $apiInstance->productDelete($product_id);
} catch (Exception $e) {
    echo 'Exception when calling ProduktApi->productDelete: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
product_id	int	ID produktu

Return type

void (empty response body)

Authorization

instanceName, basicAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`productDetailGet()`

productDetailGet($product_id)

detail produktu

Získání detailu produktu. Pokud záznam produktu obsahuje volitelná pole, ve výstupu nejsou přítomná pole, která obsahují prázdnou hodnotu (z optimalizačních důvodů). https://app.raynet.cz/api/v2/product/3/

Example

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


// Configure API key authorization: instanceName
$config = belenka\Raynetcrm\Configuration::getDefaultConfiguration()->setApiKey('X-Instance-Name', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = belenka\Raynetcrm\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Instance-Name', 'Bearer');

// Configure HTTP basic authorization: basicAuth
$config = belenka\Raynetcrm\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new belenka\Raynetcrm\Api\ProduktApi(
    // 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(),
    $config
);
$product_id = 123; // int | ID produktu

try {
    $apiInstance->productDetailGet($product_id);
} catch (Exception $e) {
    echo 'Exception when calling ProduktApi->productDetailGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
product_id	int	ID produktu

Return type

void (empty response body)

Authorization

instanceName, basicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`productEdit()`

productEdit($product_id, $product_edit_dto)

upravení produktu

Upravení dat produktu

Example

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


// Configure API key authorization: instanceName
$config = belenka\Raynetcrm\Configuration::getDefaultConfiguration()->setApiKey('X-Instance-Name', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = belenka\Raynetcrm\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Instance-Name', 'Bearer');

// Configure HTTP basic authorization: basicAuth
$config = belenka\Raynetcrm\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new belenka\Raynetcrm\Api\ProduktApi(
    // 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(),
    $config
);
$product_id = 123; // int | ID produktu
$product_edit_dto = {"code":"007","name":"produkt 007","unit":"ks","description":"popis produktu","taxRate":21,"category":791,"productLine":206,"cost":1000,"price":1500,"tags":["tag 1","tag 2"],"customFields":{"Vaha_(g)_80307":25}}; // \belenka\Raynetcrm\Model\ProductEditDto

try {
    $apiInstance->productEdit($product_id, $product_edit_dto);
} catch (Exception $e) {
    echo 'Exception when calling ProduktApi->productEdit: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
product_id	int	ID produktu
product_edit_dto	\belenka\Raynetcrm\Model\ProductEditDto		[optional]

Return type

void (empty response body)

Authorization

instanceName, basicAuth

HTTP request headers

Content-Type: application/json
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`productGet()`

productGet($offset, $limit, $sort_column, $sort_direction, $fulltext, $name, $unit, $row_info_created_at, $row_info_updated_at, $row_info_last_modified_at, $row_info_row_access, $view, $tags)

seznam produktů

https://app.raynet.cz/api/v2/product/?offset=0&limit=1&name[LIKE]=Jan%

Example

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


// Configure API key authorization: instanceName
$config = belenka\Raynetcrm\Configuration::getDefaultConfiguration()->setApiKey('X-Instance-Name', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = belenka\Raynetcrm\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Instance-Name', 'Bearer');

// Configure HTTP basic authorization: basicAuth
$config = belenka\Raynetcrm\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new belenka\Raynetcrm\Api\ProduktApi(
    // 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(),
    $config
);
$offset = 0; // int | Zobrazeni zaznamu od zacatku
$limit = 100; // int | Maximální počet vrácených produktů je `1000`
$sort_column = name; // string | 
$sort_direction = ASC; // string | 
$fulltext = myText; // string | Fulltextové vyhledání v seznamu. Operátor se v tomto případě nepoužívá.
$name = Licence; // string | Filtrování produktů podle názvu. Lze využít operátoru `EQ`, `NE`, `LIKE`, `LIKE_NOCASE`
$unit = ks; // string | Filtrování prodktů podle jednotky. Lze využít operátoru `EQ`, `NE`, `LIKE`, `LIKE_NOCASE`
$row_info_created_at = 2022-06-01 10:00; // string | Filtrování prodktů podle data vytvoření. Lze využít operátoru `GT`, `GE`, `LT`, `LE`
$row_info_updated_at = 2022-06-01 10:00; // string | Filtrování prodktů podle posledního data upravení. Lze využít operátoru `GT`, `GE`, `LT`, `LE`
$row_info_last_modified_at = 2022-06-01 10:00; // string | Filtrování produktů podle posledního data modifikace (vytvoření nebo upravení). Lze využít operátoru `GT`, `GE`, `LT`, `LE`. Vhodné pro periodickou detekci změn.
$row_info_row_access = INVALID; // string | Filtrování zneplatněných klientů. Lze využít operátoru `EQ`, `NE`, `EQ_OR_NULL`, `NE_OR_NULL`
$view = rowInfo; // string | Pokud je hodnota rovna `rowInfo`, jsou vráceny pouze stavové informace o záznamu (data vytvoření, upravení, verze, ...). Vhodné pro periodickou detekci změn.
$tags = tags; // string | Filtrování podle štítku. Je možné hledat podle více štítků oddělených čárkou. Záznam potom musí alespoň jeden obsahovat (`tag1,tag2`).

try {
    $apiInstance->productGet($offset, $limit, $sort_column, $sort_direction, $fulltext, $name, $unit, $row_info_created_at, $row_info_updated_at, $row_info_last_modified_at, $row_info_row_access, $view, $tags);
} catch (Exception $e) {
    echo 'Exception when calling ProduktApi->productGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
offset	int	Zobrazeni zaznamu od zacatku	[optional]
limit	int	Maximální počet vrácených produktů je `1000`	[optional]
sort_column	string		[optional]
sort_direction	string		[optional]
fulltext	string	Fulltextové vyhledání v seznamu. Operátor se v tomto případě nepoužívá.	[optional]
name	string	Filtrování produktů podle názvu. Lze využít operátoru `EQ`, `NE`, `LIKE`, `LIKE_NOCASE`	[optional]
unit	string	Filtrování prodktů podle jednotky. Lze využít operátoru `EQ`, `NE`, `LIKE`, `LIKE_NOCASE`	[optional]
row_info_created_at	string	Filtrování prodktů podle data vytvoření. Lze využít operátoru `GT`, `GE`, `LT`, `LE`	[optional]
row_info_updated_at	string	Filtrování prodktů podle posledního data upravení. Lze využít operátoru `GT`, `GE`, `LT`, `LE`	[optional]
row_info_last_modified_at	string	Filtrování produktů podle posledního data modifikace (vytvoření nebo upravení). Lze využít operátoru `GT`, `GE`, `LT`, `LE`. Vhodné pro periodickou detekci změn.	[optional]
row_info_row_access	string	Filtrování zneplatněných klientů. Lze využít operátoru `EQ`, `NE`, `EQ_OR_NULL`, `NE_OR_NULL`	[optional]
view	string	Pokud je hodnota rovna `rowInfo`, jsou vráceny pouze stavové informace o záznamu (data vytvoření, upravení, verze, ...). Vhodné pro periodickou detekci změn.	[optional]
tags	string	Filtrování podle štítku. Je možné hledat podle více štítků oddělených čárkou. Záznam potom musí alespoň jeden obsahovat (`tag1,tag2`).	[optional]

Return type

void (empty response body)

Authorization

instanceName, basicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`productInsert()`

productInsert($product_insert_dto): \belenka\Raynetcrm\Model\Insert201Response

založení nového produktu

Example

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


// Configure API key authorization: instanceName
$config = belenka\Raynetcrm\Configuration::getDefaultConfiguration()->setApiKey('X-Instance-Name', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = belenka\Raynetcrm\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Instance-Name', 'Bearer');

// Configure HTTP basic authorization: basicAuth
$config = belenka\Raynetcrm\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new belenka\Raynetcrm\Api\ProduktApi(
    // 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(),
    $config
);
$product_insert_dto = {"code":"007","name":"produkt 007","unit":"ks","description":"popis produktu","taxRate":21,"category":791,"productLine":206,"cost":1000,"price":1500,"tags":["tag 1","tag 2"]}; // \belenka\Raynetcrm\Model\ProductInsertDto

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

Parameters

Name	Type	Description	Notes
product_insert_dto	\belenka\Raynetcrm\Model\ProductInsertDto		[optional]

Return type

\belenka\Raynetcrm\Model\Insert201Response

Authorization

instanceName, basicAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`productInvalidEdit()`

productInvalidEdit($product_id)

zneplatnění produktu

Zneplatnění záznamu produktu.

Example

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


// Configure API key authorization: instanceName
$config = belenka\Raynetcrm\Configuration::getDefaultConfiguration()->setApiKey('X-Instance-Name', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = belenka\Raynetcrm\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Instance-Name', 'Bearer');

// Configure HTTP basic authorization: basicAuth
$config = belenka\Raynetcrm\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new belenka\Raynetcrm\Api\ProduktApi(
    // 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(),
    $config
);
$product_id = 123; // int | ID produktu

try {
    $apiInstance->productInvalidEdit($product_id);
} catch (Exception $e) {
    echo 'Exception when calling ProduktApi->productInvalidEdit: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
product_id	int	ID produktu

Return type

void (empty response body)

Authorization

instanceName, basicAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`productValidEdit()`

productValidEdit($product_id)

obnovení platnosti produktu

Obnovení platnosti záznamu produktu.

Example

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


// Configure API key authorization: instanceName
$config = belenka\Raynetcrm\Configuration::getDefaultConfiguration()->setApiKey('X-Instance-Name', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = belenka\Raynetcrm\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Instance-Name', 'Bearer');

// Configure HTTP basic authorization: basicAuth
$config = belenka\Raynetcrm\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new belenka\Raynetcrm\Api\ProduktApi(
    // 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(),
    $config
);
$product_id = 123; // int | ID produktu

try {
    $apiInstance->productValidEdit($product_id);
} catch (Exception $e) {
    echo 'Exception when calling ProduktApi->productValidEdit: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
product_id	int	ID produktu

Return type

void (empty response body)

Authorization

instanceName, basicAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

ProduktApi.md

Latest commit

History

ProduktApi.md

File metadata and controls

belenka\Raynetcrm\ProduktApi

productDelete()

Example

Parameters

Return type

Authorization

HTTP request headers

productDetailGet()

Example

Parameters

Return type

Authorization

HTTP request headers

productEdit()

Example

Parameters

Return type

Authorization

HTTP request headers

productGet()

Example

Parameters

Return type

Authorization

HTTP request headers

productInsert()

Example

Parameters

Return type

Authorization

HTTP request headers

productInvalidEdit()

Example

Parameters

Return type

Authorization

HTTP request headers

productValidEdit()

Example

Parameters

Return type

Authorization

HTTP request headers

`productDelete()`

`productDetailGet()`

`productEdit()`

`productGet()`

`productInsert()`

`productInvalidEdit()`

`productValidEdit()`