MagDv\Cargomart\DictionaryApi

All URIs are relative to https://cargomart.ru.

Method	HTTP request	Description
apiV2DictionaryAcContainerTypeGet()	GET /api/v2/dictionary/ac/container-type	Список видов тары.
apiV2DictionaryAcCountryGet()	GET /api/v2/dictionary/ac/country	Список стран
apiV2DictionaryExpeditorBranchGet()	GET /api/v2/dictionary/expeditor-branch	Вывод списка филиалов.
apiV2DictionaryGet()	GET /api/v2/dictionary	Метод возвращает список словарей
apiV2OrderRefuseReasonGet()	GET /api/v2/order-refuse-reason	Словарь причин для отказа
apiV2PriceTypeGet()	GET /api/v2/price-type	Словарь тип цены

`apiV2DictionaryAcContainerTypeGet()`

apiV2DictionaryAcContainerTypeGet($filter_search, $selected_ids, $page, $per_page): \MagDv\Cargomart\Dto\ContainerTypeList

Список видов тары.

Example

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


// Configure API key authorization: CookieTokenAuth
$config = MagDv\Cargomart\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = MagDv\Cargomart\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');

// Configure API key authorization: HeaderAuthorizationAuth
$config = MagDv\Cargomart\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = MagDv\Cargomart\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new MagDv\Cargomart\Api\DictionaryApi(
    // If you want use custom http client, pass your client which implements `Psr\Http\Client\ClientInterface`.
    // This is optional, `Psr18ClientDiscovery` will be used to find http client. For instance `GuzzleHttp\Client` implements that interface
    new GuzzleHttp\Client(),
    $config
);
$filter_search = 'filter_search_example'; // string | Поисковая строка
$selected_ids = array('selected_ids_example'); // string[] | Дополнительные id для поиска (на первое место)
$page = 56; // int | Страница выдачи
$per_page = 56; // int | Количество объектов на странице

try {
    $result = $apiInstance->apiV2DictionaryAcContainerTypeGet($filter_search, $selected_ids, $page, $per_page);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DictionaryApi->apiV2DictionaryAcContainerTypeGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
filter_search	string	Поисковая строка	[optional]
selected_ids	string[]	Дополнительные id для поиска (на первое место)	[optional]
page	int	Страница выдачи	[optional]
per_page	int	Количество объектов на странице	[optional]

Return type

\MagDv\Cargomart\Dto\ContainerTypeList

Authorization

CookieTokenAuth, HeaderAuthorizationAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`apiV2DictionaryAcCountryGet()`

apiV2DictionaryAcCountryGet($filter_search, $selected_ids, $page, $per_page): \MagDv\Cargomart\Dto\CountryListResponse

Список стран

Example

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


// Configure API key authorization: CookieTokenAuth
$config = MagDv\Cargomart\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = MagDv\Cargomart\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');

// Configure API key authorization: HeaderAuthorizationAuth
$config = MagDv\Cargomart\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = MagDv\Cargomart\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new MagDv\Cargomart\Api\DictionaryApi(
    // If you want use custom http client, pass your client which implements `Psr\Http\Client\ClientInterface`.
    // This is optional, `Psr18ClientDiscovery` will be used to find http client. For instance `GuzzleHttp\Client` implements that interface
    new GuzzleHttp\Client(),
    $config
);
$filter_search = 'filter_search_example'; // string | Поисковая строка
$selected_ids = array('selected_ids_example'); // string[] | Дополнительные id для поиска (на первое место)
$page = 56; // int | Страница выдачи
$per_page = 56; // int | Количество объектов на странице

try {
    $result = $apiInstance->apiV2DictionaryAcCountryGet($filter_search, $selected_ids, $page, $per_page);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DictionaryApi->apiV2DictionaryAcCountryGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
filter_search	string	Поисковая строка	[optional]
selected_ids	string[]	Дополнительные id для поиска (на первое место)	[optional]
page	int	Страница выдачи	[optional]
per_page	int	Количество объектов на странице	[optional]

Return type

\MagDv\Cargomart\Dto\CountryListResponse

Authorization

CookieTokenAuth, HeaderAuthorizationAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`apiV2DictionaryExpeditorBranchGet()`

apiV2DictionaryExpeditorBranchGet(): \MagDv\Cargomart\Dto\BranchList

Вывод списка филиалов.

Example

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


// Configure API key authorization: CookieTokenAuth
$config = MagDv\Cargomart\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = MagDv\Cargomart\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');

// Configure API key authorization: HeaderAuthorizationAuth
$config = MagDv\Cargomart\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = MagDv\Cargomart\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new MagDv\Cargomart\Api\DictionaryApi(
    // If you want use custom http client, pass your client which implements `Psr\Http\Client\ClientInterface`.
    // This is optional, `Psr18ClientDiscovery` will be used to find http client. For instance `GuzzleHttp\Client` implements that interface
    new GuzzleHttp\Client(),
    $config
);

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

Parameters

This endpoint does not need any parameter.

Return type

\MagDv\Cargomart\Dto\BranchList

Authorization

CookieTokenAuth, HeaderAuthorizationAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`apiV2DictionaryGet()`

apiV2DictionaryGet($with): \MagDv\Cargomart\Dto\DictionaryList

Метод возвращает список словарей

Example

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


// Configure API key authorization: CookieTokenAuth
$config = MagDv\Cargomart\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = MagDv\Cargomart\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');

// Configure API key authorization: HeaderAuthorizationAuth
$config = MagDv\Cargomart\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = MagDv\Cargomart\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new MagDv\Cargomart\Api\DictionaryApi(
    // If you want use custom http client, pass your client which implements `Psr\Http\Client\ClientInterface`.
    // This is optional, `Psr18ClientDiscovery` will be used to find http client. For instance `GuzzleHttp\Client` implements that interface
    new GuzzleHttp\Client(),
    $config
);
$with = array(new \MagDv\Cargomart\Dto\\MagDv\Cargomart\Dto\DictionaryTypeEnum()); // \MagDv\Cargomart\Dto\DictionaryTypeEnum[] | Идентификатор справочника

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

Parameters

Name	Type	Description	Notes
with	\MagDv\Cargomart\Dto\DictionaryTypeEnum[]	Идентификатор справочника	[optional]

Return type

\MagDv\Cargomart\Dto\DictionaryList

Authorization

CookieTokenAuth, HeaderAuthorizationAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`apiV2OrderRefuseReasonGet()`

apiV2OrderRefuseReasonGet(): \MagDv\Cargomart\Dto\OrderRefuseReasonsResponse

Словарь причин для отказа

Example

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


// Configure API key authorization: CookieTokenAuth
$config = MagDv\Cargomart\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = MagDv\Cargomart\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');

// Configure API key authorization: HeaderAuthorizationAuth
$config = MagDv\Cargomart\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = MagDv\Cargomart\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new MagDv\Cargomart\Api\DictionaryApi(
    // If you want use custom http client, pass your client which implements `Psr\Http\Client\ClientInterface`.
    // This is optional, `Psr18ClientDiscovery` will be used to find http client. For instance `GuzzleHttp\Client` implements that interface
    new GuzzleHttp\Client(),
    $config
);

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

Parameters

This endpoint does not need any parameter.

Return type

\MagDv\Cargomart\Dto\OrderRefuseReasonsResponse

Authorization

CookieTokenAuth, HeaderAuthorizationAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`apiV2PriceTypeGet()`

apiV2PriceTypeGet(): \MagDv\Cargomart\Dto\OrderPriceTypeResponse

Словарь тип цены

Example

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


// Configure API key authorization: CookieTokenAuth
$config = MagDv\Cargomart\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = MagDv\Cargomart\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');

// Configure API key authorization: HeaderAuthorizationAuth
$config = MagDv\Cargomart\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = MagDv\Cargomart\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new MagDv\Cargomart\Api\DictionaryApi(
    // If you want use custom http client, pass your client which implements `Psr\Http\Client\ClientInterface`.
    // This is optional, `Psr18ClientDiscovery` will be used to find http client. For instance `GuzzleHttp\Client` implements that interface
    new GuzzleHttp\Client(),
    $config
);

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

Parameters

This endpoint does not need any parameter.

Return type

\MagDv\Cargomart\Dto\OrderPriceTypeResponse

Authorization

CookieTokenAuth, HeaderAuthorizationAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

Files

DictionaryApi.md

Latest commit

History

DictionaryApi.md

File metadata and controls

MagDv\Cargomart\DictionaryApi

apiV2DictionaryAcContainerTypeGet()

Example

Parameters

Return type

Authorization

HTTP request headers

apiV2DictionaryAcCountryGet()

Example

Parameters

Return type

Authorization

HTTP request headers

apiV2DictionaryExpeditorBranchGet()

Example

Parameters

Return type

Authorization

HTTP request headers

apiV2DictionaryGet()

Example

Parameters

Return type

Authorization

HTTP request headers

apiV2OrderRefuseReasonGet()

Example

Parameters

Return type

Authorization

HTTP request headers

apiV2PriceTypeGet()

Example

Parameters

Return type

Authorization

HTTP request headers

`apiV2DictionaryAcContainerTypeGet()`

`apiV2DictionaryAcCountryGet()`

`apiV2DictionaryExpeditorBranchGet()`

`apiV2DictionaryGet()`

`apiV2OrderRefuseReasonGet()`

`apiV2PriceTypeGet()`