1
0
mirror of synced 2024-11-24 06:16:27 +03:00
api-client-php/docs/api/class-RetailCrm.ApiClient.html
2014-11-13 09:39:01 +03:00

1516 lines
36 KiB
HTML

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Class RetailCrm\ApiClient | retailCRM PHP API client</title>
<link rel="stylesheet" href="resources/bootstrap.min.css?260161822">
<link rel="stylesheet" href="resources/style.css?2608535020">
</head>
<body>
<div id="navigation" class="navbar navbar-fixed-top">
<div class="navbar-inner">
<div class="container">
<a href="index.html" class="brand">retailCRM PHP API client</a>
<div class="nav-collapse">
<ul class="nav">
<li>
<a href="namespace-RetailCrm.html" title="Summary of RetailCrm"><span>Namespace</span></a>
</li>
<li class="active">
<span>Class</span> </li>
<li class="divider-vertical"></li>
<li>
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
</li>
<li>
<a href="deprecated.html" title="List of deprecated elements"><span>Deprecated</span></a>
</li>
<li>
<a href="todo.html" title="Todo list"><span>Todo</span></a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div id="left">
<div id="menu">
<form id="search" class="form-search">
<input type="hidden" name="cx" value="">
<input type="hidden" name="ie" value="UTF-8">
<input type="text" name="q" class="search-query" placeholder="Search">
</form>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li class="active">
<a href="namespace-RetailCrm.html">
RetailCrm<span></span>
</a>
<ul>
<li>
<a href="namespace-RetailCrm.Exception.html">
Exception </a>
</li>
<li>
<a href="namespace-RetailCrm.Http.html">
Http </a>
</li>
<li>
<a href="namespace-RetailCrm.Response.html">
Response </a>
</li>
</ul></li>
</ul>
</div>
<div id="elements">
<h3>Classes</h3>
<ul>
<li class="active"><a href="class-RetailCrm.ApiClient.html">ApiClient</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<div id="content" class="class">
<h1>Class ApiClient</h1>
<div class="description">
<p>retailCRM API client class</p>
</div>
<div class="alert alert-info">
<b>Namespace:</b> RetailCrm<br>
<b>Located at</b> <a href="source-class-RetailCrm.ApiClient.html#8-609" title="Go to source code">RetailCrm/ApiClient.php</a><br>
</div>
<h2>Methods summary</h2>
<table class="summary table table-bordered table-striped methods" id="methods">
<tr data-order="__construct" id="___construct">
<td class="attributes"><code>
public
mixed
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#___construct">#</a>
<code><a href="source-class-RetailCrm.ApiClient.html#17-33" title="Go to source code">__construct</a>( <span>string <var>$url</var></span>, <span>string <var>$apiKey</var></span> )</code>
<div class="description short">
<p>Client creating</p>
</div>
<div class="description detailed hidden">
<p>Client creating</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$url</var></dt>
<dd>
</dd>
<dt><var>$apiKey</var></dt>
<dd>
</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code>mixed</code>
</div>
</div>
</div></td>
</tr>
<tr data-order="ordersCreate" id="_ordersCreate">
<td class="attributes"><code>
public
<code><a href="class-RetailCrm.Response.ApiResponse.html">RetailCrm\Response\ApiResponse</a></code>
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_ordersCreate">#</a>
<code><a href="source-class-RetailCrm.ApiClient.html#35-50" title="Go to source code">ordersCreate</a>( <span>array <var>$order</var></span> )</code>
<div class="description short">
<p>Create a order</p>
</div>
<div class="description detailed hidden">
<p>Create a order</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$order</var></dt>
<dd>
</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code><code><a href="class-RetailCrm.Response.ApiResponse.html">RetailCrm\Response\ApiResponse</a></code></code>
</div>
</div>
</div></td>
</tr>
<tr data-order="ordersEdit" id="_ordersEdit">
<td class="attributes"><code>
public
<code><a href="class-RetailCrm.Response.ApiResponse.html">RetailCrm\Response\ApiResponse</a></code>
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_ordersEdit">#</a>
<code><a href="source-class-RetailCrm.ApiClient.html#52-74" title="Go to source code">ordersEdit</a>( <span>array <var>$order</var></span>, <span>mixed <var>$by</var> = <span class="php-quote">'externalId'</span></span> )</code>
<div class="description short">
<p>Edit a order</p>
</div>
<div class="description detailed hidden">
<p>Edit a order</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$order</var></dt>
<dd>
</dd>
<dt><var>$by</var></dt>
<dd>
</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code><code><a href="class-RetailCrm.Response.ApiResponse.html">RetailCrm\Response\ApiResponse</a></code></code>
</div>
</div>
</div></td>
</tr>
<tr data-order="ordersUpload" id="_ordersUpload">
<td class="attributes"><code>
public
<code><a href="class-RetailCrm.Response.ApiResponse.html">RetailCrm\Response\ApiResponse</a></code>
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_ordersUpload">#</a>
<code><a href="source-class-RetailCrm.ApiClient.html#76-91" title="Go to source code">ordersUpload</a>( <span>array <var>$orders</var></span> )</code>
<div class="description short">
<p>Upload array of the orders</p>
</div>
<div class="description detailed hidden">
<p>Upload array of the orders</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$orders</var></dt>
<dd>
</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code><code><a href="class-RetailCrm.Response.ApiResponse.html">RetailCrm\Response\ApiResponse</a></code></code>
</div>
</div>
</div></td>
</tr>
<tr data-order="ordersGet" id="_ordersGet">
<td class="attributes"><code>
public
<code><a href="class-RetailCrm.Response.ApiResponse.html">RetailCrm\Response\ApiResponse</a></code>
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_ordersGet">#</a>
<code><a href="source-class-RetailCrm.ApiClient.html#93-105" title="Go to source code">ordersGet</a>( <span>string <var>$id</var></span>, <span>string <var>$by</var> = <span class="php-quote">'externalId'</span></span> )</code>
<div class="description short">
<p>Get order by id or externalId</p>
</div>
<div class="description detailed hidden">
<p>Get order by id or externalId</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$id</var></dt>
<dd>
</dd>
<dt><var>$by</var></dt>
<dd>(default: 'externalId')
</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code><code><a href="class-RetailCrm.Response.ApiResponse.html">RetailCrm\Response\ApiResponse</a></code></code>
</div>
</div>
</div></td>
</tr>
<tr data-order="ordersHistory" id="_ordersHistory">
<td class="attributes"><code>
public
<code><a href="class-RetailCrm.Response.ApiResponse.html">RetailCrm\Response\ApiResponse</a></code>
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_ordersHistory">#</a>
<code><a href="source-class-RetailCrm.ApiClient.html#107-143" title="Go to source code">ordersHistory</a>( <span>DateTime <var>$startDate</var> = <span class="php-keyword1">null</span></span>, <span>DateTime <var>$endDate</var> = <span class="php-keyword1">null</span></span>, <span>integer <var>$limit</var> = <span class="php-num">100</span></span>, <span>integer <var>$offset</var> = <span class="php-num">0</span></span>, <span>boolean <var>$skipMyChanges</var> = <span class="php-keyword1">true</span> </span> )</code>
<div class="description short">
<p>Returns a orders history</p>
</div>
<div class="description detailed hidden">
<p>Returns a orders history</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$startDate</var></dt>
<dd>(default: null)
</dd>
<dt><var>$endDate</var></dt>
<dd>(default: null)
</dd>
<dt><var>$limit</var></dt>
<dd>(default: 100)
</dd>
<dt><var>$offset</var></dt>
<dd>(default: 0)
</dd>
<dt><var>$skipMyChanges</var></dt>
<dd>(default: true)
</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code><code><a href="class-RetailCrm.Response.ApiResponse.html">RetailCrm\Response\ApiResponse</a></code></code>
</div>
</div>
</div></td>
</tr>
<tr data-order="ordersList" id="_ordersList">
<td class="attributes"><code>
public
<code><a href="class-RetailCrm.Response.ApiResponse.html">RetailCrm\Response\ApiResponse</a></code>
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_ordersList">#</a>
<code><a href="source-class-RetailCrm.ApiClient.html#145-168" title="Go to source code">ordersList</a>( <span>array <var>$filter</var> = <span class="php-keyword1">array</span>()</span>, <span>integer <var>$page</var> = <span class="php-keyword1">null</span></span>, <span>integer <var>$limit</var> = <span class="php-keyword1">null</span></span> )</code>
<div class="description short">
<p>Returns filtered orders list</p>
</div>
<div class="description detailed hidden">
<p>Returns filtered orders list</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$filter</var></dt>
<dd>(default: array())
</dd>
<dt><var>$page</var></dt>
<dd>(default: null)
</dd>
<dt><var>$limit</var></dt>
<dd>(default: null)
</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code><code><a href="class-RetailCrm.Response.ApiResponse.html">RetailCrm\Response\ApiResponse</a></code></code>
</div>
</div>
</div></td>
</tr>
<tr data-order="ordersStatuses" id="_ordersStatuses">
<td class="attributes"><code>
public
<code><a href="class-RetailCrm.Response.ApiResponse.html">RetailCrm\Response\ApiResponse</a></code>
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_ordersStatuses">#</a>
<code><a href="source-class-RetailCrm.ApiClient.html#170-189" title="Go to source code">ordersStatuses</a>( <span>array <var>$ids</var> = <span class="php-keyword1">array</span>()</span>, <span>array <var>$externalIds</var> = <span class="php-keyword1">array</span>()</span> )</code>
<div class="description short">
<p>Returns statuses of the orders</p>
</div>
<div class="description detailed hidden">
<p>Returns statuses of the orders</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$ids</var></dt>
<dd>(default: array())
</dd>
<dt><var>$externalIds</var></dt>
<dd>(default: array())
</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code><code><a href="class-RetailCrm.Response.ApiResponse.html">RetailCrm\Response\ApiResponse</a></code></code>
</div>
</div>
</div></td>
</tr>
<tr data-order="ordersFixExternalIds" id="_ordersFixExternalIds">
<td class="attributes"><code>
public
<code><a href="class-RetailCrm.Response.ApiResponse.html">RetailCrm\Response\ApiResponse</a></code>
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_ordersFixExternalIds">#</a>
<code><a href="source-class-RetailCrm.ApiClient.html#191-206" title="Go to source code">ordersFixExternalIds</a>( <span>array <var>$ids</var></span> )</code>
<div class="description short">
<p>Save order IDs' (id and externalId) association in the CRM</p>
</div>
<div class="description detailed hidden">
<p>Save order IDs' (id and externalId) association in the CRM</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$ids</var></dt>
<dd>
</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code><code><a href="class-RetailCrm.Response.ApiResponse.html">RetailCrm\Response\ApiResponse</a></code></code>
</div>
</div>
</div></td>
</tr>
<tr data-order="customersCreate" id="_customersCreate">
<td class="attributes"><code>
public
<code><a href="class-RetailCrm.Response.ApiResponse.html">RetailCrm\Response\ApiResponse</a></code>
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_customersCreate">#</a>
<code><a href="source-class-RetailCrm.ApiClient.html#208-223" title="Go to source code">customersCreate</a>( <span>array <var>$customer</var></span> )</code>
<div class="description short">
<p>Create a customer</p>
</div>
<div class="description detailed hidden">
<p>Create a customer</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$customer</var></dt>
<dd>
</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code><code><a href="class-RetailCrm.Response.ApiResponse.html">RetailCrm\Response\ApiResponse</a></code></code>
</div>
</div>
</div></td>
</tr>
<tr data-order="customersEdit" id="_customersEdit">
<td class="attributes"><code>
public
<code><a href="class-RetailCrm.Response.ApiResponse.html">RetailCrm\Response\ApiResponse</a></code>
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_customersEdit">#</a>
<code><a href="source-class-RetailCrm.ApiClient.html#225-247" title="Go to source code">customersEdit</a>( <span>array <var>$customer</var></span>, <span>mixed <var>$by</var> = <span class="php-quote">'externalId'</span></span> )</code>
<div class="description short">
<p>Edit a customer</p>
</div>
<div class="description detailed hidden">
<p>Edit a customer</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$customer</var></dt>
<dd>
</dd>
<dt><var>$by</var></dt>
<dd>
</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code><code><a href="class-RetailCrm.Response.ApiResponse.html">RetailCrm\Response\ApiResponse</a></code></code>
</div>
</div>
</div></td>
</tr>
<tr data-order="customersUpload" id="_customersUpload">
<td class="attributes"><code>
public
<code><a href="class-RetailCrm.Response.ApiResponse.html">RetailCrm\Response\ApiResponse</a></code>
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_customersUpload">#</a>
<code><a href="source-class-RetailCrm.ApiClient.html#249-264" title="Go to source code">customersUpload</a>( <span>array <var>$customers</var></span> )</code>
<div class="description short">
<p>Upload array of the customers</p>
</div>
<div class="description detailed hidden">
<p>Upload array of the customers</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$customers</var></dt>
<dd>
</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code><code><a href="class-RetailCrm.Response.ApiResponse.html">RetailCrm\Response\ApiResponse</a></code></code>
</div>
</div>
</div></td>
</tr>
<tr data-order="customersGet" id="_customersGet">
<td class="attributes"><code>
public
<code><a href="class-RetailCrm.Response.ApiResponse.html">RetailCrm\Response\ApiResponse</a></code>
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_customersGet">#</a>
<code><a href="source-class-RetailCrm.ApiClient.html#266-278" title="Go to source code">customersGet</a>( <span>string <var>$id</var></span>, <span>string <var>$by</var> = <span class="php-quote">'externalId'</span></span> )</code>
<div class="description short">
<p>Get customer by id or externalId</p>
</div>
<div class="description detailed hidden">
<p>Get customer by id or externalId</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$id</var></dt>
<dd>
</dd>
<dt><var>$by</var></dt>
<dd>(default: 'externalId')
</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code><code><a href="class-RetailCrm.Response.ApiResponse.html">RetailCrm\Response\ApiResponse</a></code></code>
</div>
</div>
</div></td>
</tr>
<tr data-order="customersList" id="_customersList">
<td class="attributes"><code>
public
<code><a href="class-RetailCrm.Response.ApiResponse.html">RetailCrm\Response\ApiResponse</a></code>
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_customersList">#</a>
<code><a href="source-class-RetailCrm.ApiClient.html#280-303" title="Go to source code">customersList</a>( <span>array <var>$filter</var> = <span class="php-keyword1">array</span>()</span>, <span>integer <var>$page</var> = <span class="php-keyword1">null</span></span>, <span>integer <var>$limit</var> = <span class="php-keyword1">null</span></span> )</code>
<div class="description short">
<p>Returns filtered customers list</p>
</div>
<div class="description detailed hidden">
<p>Returns filtered customers list</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$filter</var></dt>
<dd>(default: array())
</dd>
<dt><var>$page</var></dt>
<dd>(default: null)
</dd>
<dt><var>$limit</var></dt>
<dd>(default: null)
</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code><code><a href="class-RetailCrm.Response.ApiResponse.html">RetailCrm\Response\ApiResponse</a></code></code>
</div>
</div>
</div></td>
</tr>
<tr data-order="customersFixExternalIds" id="_customersFixExternalIds">
<td class="attributes"><code>
public
<code><a href="class-RetailCrm.Response.ApiResponse.html">RetailCrm\Response\ApiResponse</a></code>
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_customersFixExternalIds">#</a>
<code><a href="source-class-RetailCrm.ApiClient.html#305-320" title="Go to source code">customersFixExternalIds</a>( <span>array <var>$ids</var></span> )</code>
<div class="description short">
<p>Save customer IDs' (id and externalId) association in the CRM</p>
</div>
<div class="description detailed hidden">
<p>Save customer IDs' (id and externalId) association in the CRM</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$ids</var></dt>
<dd>
</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code><code><a href="class-RetailCrm.Response.ApiResponse.html">RetailCrm\Response\ApiResponse</a></code></code>
</div>
</div>
</div></td>
</tr>
<tr data-order="deliveryServicesList" id="_deliveryServicesList">
<td class="attributes"><code>
public
<code><a href="class-RetailCrm.Response.ApiResponse.html">RetailCrm\Response\ApiResponse</a></code>
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_deliveryServicesList">#</a>
<code><a href="source-class-RetailCrm.ApiClient.html#322-330" title="Go to source code">deliveryServicesList</a>( )</code>
<div class="description short">
<p>Returns deliveryServices list</p>
</div>
<div class="description detailed hidden">
<p>Returns deliveryServices list</p>
<h4>Returns</h4>
<div class="list">
<code><code><a href="class-RetailCrm.Response.ApiResponse.html">RetailCrm\Response\ApiResponse</a></code></code>
</div>
</div>
</div></td>
</tr>
<tr data-order="deliveryTypesList" id="_deliveryTypesList">
<td class="attributes"><code>
public
<code><a href="class-RetailCrm.Response.ApiResponse.html">RetailCrm\Response\ApiResponse</a></code>
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_deliveryTypesList">#</a>
<code><a href="source-class-RetailCrm.ApiClient.html#332-340" title="Go to source code">deliveryTypesList</a>( )</code>
<div class="description short">
<p>Returns deliveryTypes list</p>
</div>
<div class="description detailed hidden">
<p>Returns deliveryTypes list</p>
<h4>Returns</h4>
<div class="list">
<code><code><a href="class-RetailCrm.Response.ApiResponse.html">RetailCrm\Response\ApiResponse</a></code></code>
</div>
</div>
</div></td>
</tr>
<tr data-order="orderMethodsList" id="_orderMethodsList">
<td class="attributes"><code>
public
<code><a href="class-RetailCrm.Response.ApiResponse.html">RetailCrm\Response\ApiResponse</a></code>
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_orderMethodsList">#</a>
<code><a href="source-class-RetailCrm.ApiClient.html#342-350" title="Go to source code">orderMethodsList</a>( )</code>
<div class="description short">
<p>Returns orderMethods list</p>
</div>
<div class="description detailed hidden">
<p>Returns orderMethods list</p>
<h4>Returns</h4>
<div class="list">
<code><code><a href="class-RetailCrm.Response.ApiResponse.html">RetailCrm\Response\ApiResponse</a></code></code>
</div>
</div>
</div></td>
</tr>
<tr data-order="orderTypesList" id="_orderTypesList">
<td class="attributes"><code>
public
<code><a href="class-RetailCrm.Response.ApiResponse.html">RetailCrm\Response\ApiResponse</a></code>
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_orderTypesList">#</a>
<code><a href="source-class-RetailCrm.ApiClient.html#352-360" title="Go to source code">orderTypesList</a>( )</code>
<div class="description short">
<p>Returns orderTypes list</p>
</div>
<div class="description detailed hidden">
<p>Returns orderTypes list</p>
<h4>Returns</h4>
<div class="list">
<code><code><a href="class-RetailCrm.Response.ApiResponse.html">RetailCrm\Response\ApiResponse</a></code></code>
</div>
</div>
</div></td>
</tr>
<tr data-order="paymentStatusesList" id="_paymentStatusesList">
<td class="attributes"><code>
public
<code><a href="class-RetailCrm.Response.ApiResponse.html">RetailCrm\Response\ApiResponse</a></code>
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_paymentStatusesList">#</a>
<code><a href="source-class-RetailCrm.ApiClient.html#362-370" title="Go to source code">paymentStatusesList</a>( )</code>
<div class="description short">
<p>Returns paymentStatuses list</p>
</div>
<div class="description detailed hidden">
<p>Returns paymentStatuses list</p>
<h4>Returns</h4>
<div class="list">
<code><code><a href="class-RetailCrm.Response.ApiResponse.html">RetailCrm\Response\ApiResponse</a></code></code>
</div>
</div>
</div></td>
</tr>
<tr data-order="paymentTypesList" id="_paymentTypesList">
<td class="attributes"><code>
public
<code><a href="class-RetailCrm.Response.ApiResponse.html">RetailCrm\Response\ApiResponse</a></code>
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_paymentTypesList">#</a>
<code><a href="source-class-RetailCrm.ApiClient.html#372-380" title="Go to source code">paymentTypesList</a>( )</code>
<div class="description short">
<p>Returns paymentTypes list</p>
</div>
<div class="description detailed hidden">
<p>Returns paymentTypes list</p>
<h4>Returns</h4>
<div class="list">
<code><code><a href="class-RetailCrm.Response.ApiResponse.html">RetailCrm\Response\ApiResponse</a></code></code>
</div>
</div>
</div></td>
</tr>
<tr data-order="productStatusesList" id="_productStatusesList">
<td class="attributes"><code>
public
<code><a href="class-RetailCrm.Response.ApiResponse.html">RetailCrm\Response\ApiResponse</a></code>
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_productStatusesList">#</a>
<code><a href="source-class-RetailCrm.ApiClient.html#382-390" title="Go to source code">productStatusesList</a>( )</code>
<div class="description short">
<p>Returns productStatuses list</p>
</div>
<div class="description detailed hidden">
<p>Returns productStatuses list</p>
<h4>Returns</h4>
<div class="list">
<code><code><a href="class-RetailCrm.Response.ApiResponse.html">RetailCrm\Response\ApiResponse</a></code></code>
</div>
</div>
</div></td>
</tr>
<tr data-order="statusGroupsList" id="_statusGroupsList">
<td class="attributes"><code>
public
<code><a href="class-RetailCrm.Response.ApiResponse.html">RetailCrm\Response\ApiResponse</a></code>
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_statusGroupsList">#</a>
<code><a href="source-class-RetailCrm.ApiClient.html#392-400" title="Go to source code">statusGroupsList</a>( )</code>
<div class="description short">
<p>Returns statusGroups list</p>
</div>
<div class="description detailed hidden">
<p>Returns statusGroups list</p>
<h4>Returns</h4>
<div class="list">
<code><code><a href="class-RetailCrm.Response.ApiResponse.html">RetailCrm\Response\ApiResponse</a></code></code>
</div>
</div>
</div></td>
</tr>
<tr data-order="statusesList" id="_statusesList">
<td class="attributes"><code>
public
<code><a href="class-RetailCrm.Response.ApiResponse.html">RetailCrm\Response\ApiResponse</a></code>
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_statusesList">#</a>
<code><a href="source-class-RetailCrm.ApiClient.html#402-410" title="Go to source code">statusesList</a>( )</code>
<div class="description short">
<p>Returns statuses list</p>
</div>
<div class="description detailed hidden">
<p>Returns statuses list</p>
<h4>Returns</h4>
<div class="list">
<code><code><a href="class-RetailCrm.Response.ApiResponse.html">RetailCrm\Response\ApiResponse</a></code></code>
</div>
</div>
</div></td>
</tr>
<tr data-order="deliveryServicesEdit" id="_deliveryServicesEdit">
<td class="attributes"><code>
public
<code><a href="class-RetailCrm.Response.ApiResponse.html">RetailCrm\Response\ApiResponse</a></code>
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_deliveryServicesEdit">#</a>
<code><a href="source-class-RetailCrm.ApiClient.html#412-431" title="Go to source code">deliveryServicesEdit</a>( <span>array <var>$data</var></span> )</code>
<div class="description short">
<p>Edit deliveryService</p>
</div>
<div class="description detailed hidden">
<p>Edit deliveryService</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$data</var></dt>
<dd>delivery service data
</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code><code><a href="class-RetailCrm.Response.ApiResponse.html">RetailCrm\Response\ApiResponse</a></code></code>
</div>
</div>
</div></td>
</tr>
<tr data-order="deliveryTypesEdit" id="_deliveryTypesEdit">
<td class="attributes"><code>
public
<code><a href="class-RetailCrm.Response.ApiResponse.html">RetailCrm\Response\ApiResponse</a></code>
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_deliveryTypesEdit">#</a>
<code><a href="source-class-RetailCrm.ApiClient.html#433-452" title="Go to source code">deliveryTypesEdit</a>( <span>array <var>$data</var></span> )</code>
<div class="description short">
<p>Edit deliveryType</p>
</div>
<div class="description detailed hidden">
<p>Edit deliveryType</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$data</var></dt>
<dd>delivery type data
</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code><code><a href="class-RetailCrm.Response.ApiResponse.html">RetailCrm\Response\ApiResponse</a></code></code>
</div>
</div>
</div></td>
</tr>
<tr data-order="orderMethodsEdit" id="_orderMethodsEdit">
<td class="attributes"><code>
public
<code><a href="class-RetailCrm.Response.ApiResponse.html">RetailCrm\Response\ApiResponse</a></code>
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_orderMethodsEdit">#</a>
<code><a href="source-class-RetailCrm.ApiClient.html#454-473" title="Go to source code">orderMethodsEdit</a>( <span>array <var>$data</var></span> )</code>
<div class="description short">
<p>Edit orderMethod</p>
</div>
<div class="description detailed hidden">
<p>Edit orderMethod</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$data</var></dt>
<dd>order method data
</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code><code><a href="class-RetailCrm.Response.ApiResponse.html">RetailCrm\Response\ApiResponse</a></code></code>
</div>
</div>
</div></td>
</tr>
<tr data-order="orderTypesEdit" id="_orderTypesEdit">
<td class="attributes"><code>
public
<code><a href="class-RetailCrm.Response.ApiResponse.html">RetailCrm\Response\ApiResponse</a></code>
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_orderTypesEdit">#</a>
<code><a href="source-class-RetailCrm.ApiClient.html#475-494" title="Go to source code">orderTypesEdit</a>( <span>array <var>$data</var></span> )</code>
<div class="description short">
<p>Edit orderType</p>
</div>
<div class="description detailed hidden">
<p>Edit orderType</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$data</var></dt>
<dd>order type data
</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code><code><a href="class-RetailCrm.Response.ApiResponse.html">RetailCrm\Response\ApiResponse</a></code></code>
</div>
</div>
</div></td>
</tr>
<tr data-order="paymentStatusesEdit" id="_paymentStatusesEdit">
<td class="attributes"><code>
public
<code><a href="class-RetailCrm.Response.ApiResponse.html">RetailCrm\Response\ApiResponse</a></code>
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_paymentStatusesEdit">#</a>
<code><a href="source-class-RetailCrm.ApiClient.html#496-515" title="Go to source code">paymentStatusesEdit</a>( <span>array <var>$data</var></span> )</code>
<div class="description short">
<p>Edit paymentStatus</p>
</div>
<div class="description detailed hidden">
<p>Edit paymentStatus</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$data</var></dt>
<dd>payment status data
</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code><code><a href="class-RetailCrm.Response.ApiResponse.html">RetailCrm\Response\ApiResponse</a></code></code>
</div>
</div>
</div></td>
</tr>
<tr data-order="paymentTypesEdit" id="_paymentTypesEdit">
<td class="attributes"><code>
public
<code><a href="class-RetailCrm.Response.ApiResponse.html">RetailCrm\Response\ApiResponse</a></code>
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_paymentTypesEdit">#</a>
<code><a href="source-class-RetailCrm.ApiClient.html#517-536" title="Go to source code">paymentTypesEdit</a>( <span>array <var>$data</var></span> )</code>
<div class="description short">
<p>Edit paymentType</p>
</div>
<div class="description detailed hidden">
<p>Edit paymentType</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$data</var></dt>
<dd>payment type data
</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code><code><a href="class-RetailCrm.Response.ApiResponse.html">RetailCrm\Response\ApiResponse</a></code></code>
</div>
</div>
</div></td>
</tr>
<tr data-order="productStatusesEdit" id="_productStatusesEdit">
<td class="attributes"><code>
public
<code><a href="class-RetailCrm.Response.ApiResponse.html">RetailCrm\Response\ApiResponse</a></code>
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_productStatusesEdit">#</a>
<code><a href="source-class-RetailCrm.ApiClient.html#538-557" title="Go to source code">productStatusesEdit</a>( <span>array <var>$data</var></span> )</code>
<div class="description short">
<p>Edit productStatus</p>
</div>
<div class="description detailed hidden">
<p>Edit productStatus</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$data</var></dt>
<dd>product status data
</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code><code><a href="class-RetailCrm.Response.ApiResponse.html">RetailCrm\Response\ApiResponse</a></code></code>
</div>
</div>
</div></td>
</tr>
<tr data-order="statusesEdit" id="_statusesEdit">
<td class="attributes"><code>
public
<code><a href="class-RetailCrm.Response.ApiResponse.html">RetailCrm\Response\ApiResponse</a></code>
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_statusesEdit">#</a>
<code><a href="source-class-RetailCrm.ApiClient.html#559-578" title="Go to source code">statusesEdit</a>( <span>array <var>$data</var></span> )</code>
<div class="description short">
<p>Edit order status</p>
</div>
<div class="description detailed hidden">
<p>Edit order status</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$data</var></dt>
<dd>status data
</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code><code><a href="class-RetailCrm.Response.ApiResponse.html">RetailCrm\Response\ApiResponse</a></code></code>
</div>
</div>
</div></td>
</tr>
<tr data-order="statisticUpdate" id="_statisticUpdate">
<td class="attributes"><code>
public
<code><a href="class-RetailCrm.Response.ApiResponse.html">RetailCrm\Response\ApiResponse</a></code>
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_statisticUpdate">#</a>
<code><a href="source-class-RetailCrm.ApiClient.html#580-588" title="Go to source code">statisticUpdate</a>( )</code>
<div class="description short">
<p>Update CRM basic statistic</p>
</div>
<div class="description detailed hidden">
<p>Update CRM basic statistic</p>
<h4>Returns</h4>
<div class="list">
<code><code><a href="class-RetailCrm.Response.ApiResponse.html">RetailCrm\Response\ApiResponse</a></code></code>
</div>
</div>
</div></td>
</tr>
</table>
<h3>Magic methods summary</h3>
<h2>Constants summary</h2>
<table class="summary table table-bordered table-striped constants" id="constants">
<tr data-order="VERSION" id="VERSION">
<td class="attributes"><code>string</code></td>
<td class="name">
<code>
<a href="source-class-RetailCrm.ApiClient.html#13" title="Go to source code"><b>VERSION</b></a>
</code>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</td>
<td class="value">
<div>
<a href="#VERSION" class="anchor">#</a>
<code><span class="php-quote">'v3'</span></code>
</div>
</td>
</tr>
</table>
</div>
</div>
<div id="footer">
retailCRM PHP API client API documentation generated by <a href="http://apigen.org">ApiGen</a>
</div>
</div>
<script src="resources/combined.js?371644040"></script>
<script src="elementlist.js?1838453619"></script>
</body>
</html>