SpringImport\Swagger\Magento2\Client\SalesRuleRuleRepositoryV1Api
May 23, 2017 · View on GitHub
All URIs are relative to http://t213.vg/rest/default
| Method | HTTP request | Description |
|---|---|---|
| salesRuleRuleRepositoryV1DeleteByIdDelete | DELETE /V1/salesRules/{ruleId} | |
| salesRuleRuleRepositoryV1GetByIdGet | GET /V1/salesRules/{ruleId} | |
| salesRuleRuleRepositoryV1GetListGet | GET /V1/salesRules/search | |
| salesRuleRuleRepositoryV1SavePost | POST /V1/salesRules | |
| salesRuleRuleRepositoryV1SavePut | PUT /V1/salesRules/{ruleId} |
salesRuleRuleRepositoryV1DeleteByIdDelete
bool salesRuleRuleRepositoryV1DeleteByIdDelete($ruleId)
Delete rule by ID.
Example
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$api_instance = new SpringImport\Swagger\Magento2\Client\Api\SalesRuleRuleRepositoryV1Api();
$ruleId = 56; // int |
try {
$result = $api_instance->salesRuleRuleRepositoryV1DeleteByIdDelete($ruleId);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling SalesRuleRuleRepositoryV1Api->salesRuleRuleRepositoryV1DeleteByIdDelete: ', $e->getMessage(), PHP_EOL;
}
?>
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ruleId | int |
Return type
bool
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
salesRuleRuleRepositoryV1GetByIdGet
\SpringImport\Swagger\Magento2\Client\Model\SalesRuleDataRuleInterface salesRuleRuleRepositoryV1GetByIdGet($ruleId)
Get rule by ID.
Example
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$api_instance = new SpringImport\Swagger\Magento2\Client\Api\SalesRuleRuleRepositoryV1Api();
$ruleId = 56; // int |
try {
$result = $api_instance->salesRuleRuleRepositoryV1GetByIdGet($ruleId);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling SalesRuleRuleRepositoryV1Api->salesRuleRuleRepositoryV1GetByIdGet: ', $e->getMessage(), PHP_EOL;
}
?>
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ruleId | int |
Return type
\SpringImport\Swagger\Magento2\Client\Model\SalesRuleDataRuleInterface
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
salesRuleRuleRepositoryV1GetListGet
\SpringImport\Swagger\Magento2\Client\Model\SalesRuleDataRuleSearchResultInterface salesRuleRuleRepositoryV1GetListGet(searchCriteriaFilterGroups0Filters0Value, searchCriteriaSortOrders0Field, searchCriteriaPageSize, $searchCriteriaCurrentPage)
Retrieve sales rules that match te specified criteria. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See http://devdocs.magento.com/codelinks/attributes.html#RuleRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.
Example
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$api_instance = new SpringImport\Swagger\Magento2\Client\Api\SalesRuleRuleRepositoryV1Api();
$searchCriteriaFilterGroups0Filters0Field = "searchCriteriaFilterGroups0Filters0Field_example"; // string | Field
$searchCriteriaFilterGroups0Filters0Value = "searchCriteriaFilterGroups0Filters0Value_example"; // string | Value
$searchCriteriaFilterGroups0Filters0ConditionType = "searchCriteriaFilterGroups0Filters0ConditionType_example"; // string | Condition type
$searchCriteriaSortOrders0Field = "searchCriteriaSortOrders0Field_example"; // string | Sorting field.
$searchCriteriaSortOrders0Direction = "searchCriteriaSortOrders0Direction_example"; // string | Sorting direction.
$searchCriteriaPageSize = 56; // int | Page size.
$searchCriteriaCurrentPage = 56; // int | Current page.
try {
$result = $api_instance->salesRuleRuleRepositoryV1GetListGet($searchCriteriaFilterGroups0Filters0Field, $searchCriteriaFilterGroups0Filters0Value, $searchCriteriaFilterGroups0Filters0ConditionType, $searchCriteriaSortOrders0Field, $searchCriteriaSortOrders0Direction, $searchCriteriaPageSize, $searchCriteriaCurrentPage);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling SalesRuleRuleRepositoryV1Api->salesRuleRuleRepositoryV1GetListGet: ', $e->getMessage(), PHP_EOL;
}
?>
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| searchCriteriaFilterGroups0Filters0Field | string | Field | [optional] |
| searchCriteriaFilterGroups0Filters0Value | string | Value | [optional] |
| searchCriteriaFilterGroups0Filters0ConditionType | string | Condition type | [optional] |
| searchCriteriaSortOrders0Field | string | Sorting field. | [optional] |
| searchCriteriaSortOrders0Direction | string | Sorting direction. | [optional] |
| searchCriteriaPageSize | int | Page size. | [optional] |
| searchCriteriaCurrentPage | int | Current page. | [optional] |
Return type
\SpringImport\Swagger\Magento2\Client\Model\SalesRuleDataRuleSearchResultInterface
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
salesRuleRuleRepositoryV1SavePost
\SpringImport\Swagger\Magento2\Client\Model\SalesRuleDataRuleInterface salesRuleRuleRepositoryV1SavePost($body)
Save sales rule.
Example
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$api_instance = new SpringImport\Swagger\Magento2\Client\Api\SalesRuleRuleRepositoryV1Api();
$body = new \SpringImport\Swagger\Magento2\Client\Model\Body88(); // \SpringImport\Swagger\Magento2\Client\Model\Body88 |
try {
$result = $api_instance->salesRuleRuleRepositoryV1SavePost($body);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling SalesRuleRuleRepositoryV1Api->salesRuleRuleRepositoryV1SavePost: ', $e->getMessage(), PHP_EOL;
}
?>
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | \SpringImport\Swagger\Magento2\Client\Model\Body88 | [optional] |
Return type
\SpringImport\Swagger\Magento2\Client\Model\SalesRuleDataRuleInterface
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
salesRuleRuleRepositoryV1SavePut
\SpringImport\Swagger\Magento2\Client\Model\SalesRuleDataRuleInterface salesRuleRuleRepositoryV1SavePut(body)
Save sales rule.
Example
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$api_instance = new SpringImport\Swagger\Magento2\Client\Api\SalesRuleRuleRepositoryV1Api();
$ruleId = "ruleId_example"; // string |
$body = new \SpringImport\Swagger\Magento2\Client\Model\Body87(); // \SpringImport\Swagger\Magento2\Client\Model\Body87 |
try {
$result = $api_instance->salesRuleRuleRepositoryV1SavePut($ruleId, $body);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling SalesRuleRuleRepositoryV1Api->salesRuleRuleRepositoryV1SavePut: ', $e->getMessage(), PHP_EOL;
}
?>
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ruleId | string | ||
| body | \SpringImport\Swagger\Magento2\Client\Model\Body87 | [optional] |
Return type
\SpringImport\Swagger\Magento2\Client\Model\SalesRuleDataRuleInterface
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]