GroupsApi

All URIs are relative to https://api.kinow.com/api

Method	HTTP request	Description
attachCustomerToGroup	POST /groups/{group_id}/customers
createGroup	POST /groups
detachCustomerFromGroup	DELETE /groups/{group_id}/customers/{customer_id}
getGroup	GET /groups/{group_id}
getGroupCustomers	GET /groups/{group_id}/customers
getGroups	GET /groups
getProductGroups	GET /products/{product_id}/groups

attachCustomerToGroup

attachCustomerToGroup($group_id, $customer_id)

Attach customer to the group

Example

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

// Configure API key authorization: ApiClientId
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Id', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Id', 'Bearer');
// Configure API key authorization: ApiClientSecret
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Secret', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Secret', 'Bearer');

$api_instance = new Kinow\Client\Api\GroupsApi();
$group_id = 789; // int | Group ID to fetch
$customer_id = 789; // int | Customer ID to attach

try {
    $api_instance->attachCustomerToGroup($group_id, $customer_id);
} catch (Exception $e) {
    echo 'Exception when calling GroupsApi->attachCustomerToGroup: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
group_id	int	Group ID to fetch
customer_id	int	Customer ID to attach

Return type

void (empty response body)

Authorization

ApiClientId, ApiClientSecret

HTTP request headers

Content-Type: Not defined
Accept: Not defined

createGroup

\Kinow\Client\Model\GroupResponse createGroup($body)

Create new Group

Example

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

// Configure API key authorization: ApiClientId
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Id', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Id', 'Bearer');
// Configure API key authorization: ApiClientSecret
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Secret', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Secret', 'Bearer');

$api_instance = new Kinow\Client\Api\GroupsApi();
$body = new \Kinow\Client\Model\CreateGroupRequest(); // \Kinow\Client\Model\CreateGroupRequest | Group settings

try {
    $result = $api_instance->createGroup($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GroupsApi->createGroup: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
body	\Kinow\Client\Model\CreateGroupRequest	Group settings

Return type

\Kinow\Client\Model\GroupResponse

Authorization

ApiClientId, ApiClientSecret

HTTP request headers

Content-Type: Not defined
Accept: Not defined

detachCustomerFromGroup

detachCustomerFromGroup($group_id, $customer_id)

Detach customer from group

Example

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

// Configure API key authorization: ApiClientId
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Id', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Id', 'Bearer');
// Configure API key authorization: ApiClientSecret
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Secret', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Secret', 'Bearer');

$api_instance = new Kinow\Client\Api\GroupsApi();
$group_id = 789; // int | Group ID to fetch
$customer_id = 789; // int | Customer ID to attach

try {
    $api_instance->detachCustomerFromGroup($group_id, $customer_id);
} catch (Exception $e) {
    echo 'Exception when calling GroupsApi->detachCustomerFromGroup: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
group_id	int	Group ID to fetch
customer_id	int	Customer ID to attach

Return type

void (empty response body)

Authorization

ApiClientId, ApiClientSecret

HTTP request headers

Content-Type: Not defined
Accept: Not defined

getGroup

\Kinow\Client\Model\GroupResponse getGroup($group_id)

Get Group

Example

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

// Configure API key authorization: ApiClientId
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Id', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Id', 'Bearer');
// Configure API key authorization: ApiClientSecret
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Secret', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Secret', 'Bearer');

$api_instance = new Kinow\Client\Api\GroupsApi();
$group_id = 789; // int | Group ID to fetch

try {
    $result = $api_instance->getGroup($group_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GroupsApi->getGroup: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
group_id	int	Group ID to fetch

Return type

\Kinow\Client\Model\GroupResponse

Authorization

ApiClientId, ApiClientSecret

HTTP request headers

Content-Type: Not defined
Accept: Not defined

getGroupCustomers

\Kinow\Client\Model\CustomerListResponse getGroupCustomers($group_id, $page, $per_page, $filters, $sort_by, $sort_direction)

Get customers list linked to a group

Example

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

// Configure API key authorization: ApiClientId
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Id', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Id', 'Bearer');
// Configure API key authorization: ApiClientSecret
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Secret', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Secret', 'Bearer');

$api_instance = new Kinow\Client\Api\GroupsApi();
$group_id = 789; // int | Group ID to fetch
$page = 789; // int | 
$per_page = 789; // int | 
$filters = "filters_example"; // string | ``` name[value]=string&name[operator]=contains&date_add[value]=string&date_add[operator]=lt _______________  { \"name\": { \"value\": \"string\", \"operator\": \"contains\" }, \"date_add\": { \"value\": \"string\", \"operator\": \"lt\" } } ``` Operator can be: strict, contains, between, in, gt (greater than), lt (lower than).
$sort_by = "sort_by_example"; // string | Sort by this attribute (id by default)
$sort_direction = "sort_direction_example"; // string | Sorting direction (asc by default)

try {
    $result = $api_instance->getGroupCustomers($group_id, $page, $per_page, $filters, $sort_by, $sort_direction);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GroupsApi->getGroupCustomers: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
group_id	int	Group ID to fetch
page	int		[optional]
per_page	int		[optional]
filters	string	``` name[value]=string&name[operator]=contains&date_add[value]=string&date_add[operator]=lt _______________ { "name": { "value": "string", "operator": "contains" }, "date_add": { "value": "string", "operator": "lt" } } ``` Operator can be: strict, contains, between, in, gt (greater than), lt (lower than).	[optional]
sort_by	string	Sort by this attribute (id by default)	[optional]
sort_direction	string	Sorting direction (asc by default)	[optional]

Return type

\Kinow\Client\Model\CustomerListResponse

Authorization

ApiClientId, ApiClientSecret

HTTP request headers

Content-Type: Not defined
Accept: Not defined

getGroups

\Kinow\Client\Model\GroupListResponse getGroups($page, $per_page, $filters, $sort_by, $sort_direction)

Get group list

Example

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

// Configure API key authorization: ApiClientId
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Id', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Id', 'Bearer');
// Configure API key authorization: ApiClientSecret
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Secret', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Secret', 'Bearer');

$api_instance = new Kinow\Client\Api\GroupsApi();
$page = 789; // int | 
$per_page = 789; // int | 
$filters = "filters_example"; // string | ``` name[value]=string&name[operator]=contains&date_add[value]=string&date_add[operator]=lt _______________  { \"name\": { \"value\": \"string\", \"operator\": \"contains\" }, \"date_add\": { \"value\": \"string\", \"operator\": \"lt\" } } ``` Operator can be: strict, contains, between, in, gt (greater than), lt (lower than).
$sort_by = "sort_by_example"; // string | Sort by this attribute (id by default)
$sort_direction = "sort_direction_example"; // string | Sorting direction (asc by default)

try {
    $result = $api_instance->getGroups($page, $per_page, $filters, $sort_by, $sort_direction);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GroupsApi->getGroups: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
page	int		[optional]
per_page	int		[optional]
filters	string	``` name[value]=string&name[operator]=contains&date_add[value]=string&date_add[operator]=lt _______________ { "name": { "value": "string", "operator": "contains" }, "date_add": { "value": "string", "operator": "lt" } } ``` Operator can be: strict, contains, between, in, gt (greater than), lt (lower than).	[optional]
sort_by	string	Sort by this attribute (id by default)	[optional]
sort_direction	string	Sorting direction (asc by default)	[optional]

Return type

\Kinow\Client\Model\GroupListResponse

Authorization

ApiClientId, ApiClientSecret

HTTP request headers

Content-Type: Not defined
Accept: Not defined

getProductGroups

\Kinow\Client\Model\GroupListResponse getProductGroups($product_id, $page, $per_page)

Get groups allowed to see this product

Example

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

// Configure API key authorization: ApiClientId
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Id', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Id', 'Bearer');
// Configure API key authorization: ApiClientSecret
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Secret', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Secret', 'Bearer');

$api_instance = new Kinow\Client\Api\GroupsApi();
$product_id = 789; // int | Product ID to fetch
$page = 789; // int | 
$per_page = 789; // int | 

try {
    $result = $api_instance->getProductGroups($product_id, $page, $per_page);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GroupsApi->getProductGroups: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
product_id	int	Product ID to fetch
page	int		[optional]
per_page	int		[optional]

Return type

\Kinow\Client\Model\GroupListResponse

Authorization

ApiClientId, ApiClientSecret

HTTP request headers

Content-Type: Not defined
Accept: Not defined

Files

GroupsApi.md

Latest commit

History

GroupsApi.md

File metadata and controls

GroupsApi

attachCustomerToGroup

Example

Parameters

Return type

Authorization

HTTP request headers

createGroup

Example

Parameters

Return type

Authorization

HTTP request headers

detachCustomerFromGroup

Example

Parameters

Return type

Authorization

HTTP request headers

getGroup

Example

Parameters

Return type

Authorization

HTTP request headers

getGroupCustomers

Example

Parameters

Return type

Authorization

HTTP request headers

getGroups

Example

Parameters

Return type

Authorization

HTTP request headers

getProductGroups

Example

Parameters

Return type

Authorization

HTTP request headers