RetailCRM-Mirror/api-client-php
1
0
Fork 0
mirror of synced 2024-11-21 21:06:07 +03:00
Code Issues Projects Releases Wiki Activity
gh-pages
api-client-php/classes/RetailCrm-Api-ResourceGroup-CustomerInteraction.html
github-actions[bot] c604c2d144 Deploy to GitHub pages
2024-10-18 07:10:58 +00:00

897 lines
51 KiB
HTML
Raw Permalink Blame History

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>RetailCRM API Client</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<base href="../">
<link rel="icon" href="images/favicon.ico"/>
<link rel="stylesheet" href="css/normalize.css">
<link rel="stylesheet" href="css/base.css">
<link rel="preconnect" href="https://fonts.gstatic.com">
<link href="https://fonts.googleapis.com/css2?family=Open+Sans:wght@100;200;300;400;600;700&display=swap" rel="stylesheet">
<link href="https://fonts.googleapis.com/css2?family=Source+Code+Pro:wght@400;600;700&display=swap" rel="stylesheet">
<link rel="stylesheet" href="css/template.css">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/css/all.min.css" integrity="sha256-ybRkN9dBjhcS2qrW1z+hfCxq+1aBdwyQM5wlQoQVt/0=" crossorigin="anonymous" />
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/themes/prism-okaidia.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.css">
<script src="https://cdn.jsdelivr.net/npm/fuse.js@3.4.6"></script>
<script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script>
<script src="js/template.js"></script>
<script src="js/search.js"></script>
<script defer src="js/searchIndex.js"></script>
</head>
<body id="top">
<header class="phpdocumentor-header phpdocumentor-section">
<h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">RetailCRM API Client</a></h1>
<input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
<label class="phpdocumentor-header__menu-icon" for="menu-button">
<i class="fas fa-bars"></i>
</label>
<section data-search-form class="phpdocumentor-search">
<label>
<span class="visually-hidden">Search for</span>
<svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
<circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
<line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
</svg>
<input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
</label>
</section>
<nav class="phpdocumentor-topnav">
<ul class="phpdocumentor-topnav__menu">
</ul>
</nav>
</header>
<main class="phpdocumentor">
<div class="phpdocumentor-section">
<input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
<label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
Menu
</label>
<aside class="phpdocumentor-column -three phpdocumentor-sidebar">
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="namespaces/retailcrm.html" class="">RetailCrm</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="namespaces/retailcrm-api.html" class="">Api</a>
</li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="packages/RetailCrm.html" class="">RetailCrm</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="packages/RetailCrm-Api.html" class="">Api</a>
</li>
</ul>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="packages/Application.html" class="">Application</a>
</h4>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
</section>
</aside>
<div class="phpdocumentor-column -nine phpdocumentor-content">
<section>
<ul class="phpdocumentor-breadcrumbs">
<li class="phpdocumentor-breadcrumb"><a href="namespaces/retailcrm.html">RetailCrm</a></li>
<li class="phpdocumentor-breadcrumb"><a href="namespaces/retailcrm-api.html">Api</a></li>
<li class="phpdocumentor-breadcrumb"><a href="namespaces/retailcrm-api-resourcegroup.html">ResourceGroup</a></li>
</ul>
<article class="phpdocumentor-element -class">
<h2 class="phpdocumentor-content__title">
CustomerInteraction
<span class="phpdocumentor-element__extends">
extends <abbr title="\RetailCrm\Api\ResourceGroup\AbstractApiResourceGroup">AbstractApiResourceGroup</abbr>
</span>
<div class="phpdocumentor-element__package">
in package
<ul class="phpdocumentor-breadcrumbs">
<li class="phpdocumentor-breadcrumb"><a href="packages/RetailCrm.html">RetailCrm</a></li>
<li class="phpdocumentor-breadcrumb"><a href="packages/RetailCrm-Api.html">Api</a></li>
<li class="phpdocumentor-breadcrumb"><a href="packages/RetailCrm-Api-ResourceGroup.html">ResourceGroup</a></li>
</ul>
</div>
</h2>
<div class="phpdocumentor-label-line">
</div>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/ResourceGroup/CustomerInteraction.php"><a href="files/src-resourcegroup-customerinteraction.html"><abbr title="src/ResourceGroup/CustomerInteraction.php">CustomerInteraction.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">27</span>
</aside>
<p class="phpdocumentor-summary">Class CustomerInteraction</p>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/RetailCrm-Api-ResourceGroup-CustomerInteraction.html#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">category</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>CustomerInteraction</p>
</section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">SuppressWarnings</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>(PHPMD.CouplingBetweenObjects)</p>
</section>
</dd>
</dl>
<h3 id="toc">
Table of Contents
<a href="classes/RetailCrm-Api-ResourceGroup-CustomerInteraction.html#toc" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<h4 id="toc-methods">
Methods
<a href="classes/RetailCrm-Api-ResourceGroup-CustomerInteraction.html#toc-methods" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<dl class="phpdocumentor-table-of-contents">
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/RetailCrm-Api-ResourceGroup-CustomerInteraction.html#method_cartClear">cartClear()</a>
<span>
&nbsp;: <a href="classes/RetailCrm-Api-Model-Response-SuccessResponse.html"><abbr title="\RetailCrm\Api\Model\Response\SuccessResponse">SuccessResponse</abbr></a> </span>
</dt>
<dd>Makes POST &quot;/api/v5/customer-interaction/{site}/cart/clear&quot; request.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/RetailCrm-Api-ResourceGroup-CustomerInteraction.html#method_cartGet">cartGet()</a>
<span>
&nbsp;: <a href="classes/RetailCrm-Api-Model-Response-CustomerInteraction-CustomerInteractionCartGetResponse.html"><abbr title="\RetailCrm\Api\Model\Response\CustomerInteraction\CustomerInteractionCartGetResponse">CustomerInteractionCartGetResponse</abbr></a> </span>
</dt>
<dd>Makes GET &quot;/api/v5/customer-interaction/{site}/cart/{customerId}&quot; request.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/RetailCrm-Api-ResourceGroup-CustomerInteraction.html#method_cartSet">cartSet()</a>
<span>
&nbsp;: <a href="classes/RetailCrm-Api-Model-Response-SuccessResponse.html"><abbr title="\RetailCrm\Api\Model\Response\SuccessResponse">SuccessResponse</abbr></a> </span>
</dt>
<dd>Makes POST &quot;/api/v5/customer-interaction/{site}/cart/set&quot; request.</dd>
</dl>
<section class="phpdocumentor-methods">
<h3 class="phpdocumentor-elements__header" id="methods">
Methods
<a href="classes/RetailCrm-Api-ResourceGroup-CustomerInteraction.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_cartClear">
cartClear()
<a href="classes/RetailCrm-Api-ResourceGroup-CustomerInteraction.html#method_cartClear" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/ResourceGroup/CustomerInteraction.php"><a href="files/src-resourcegroup-customerinteraction.html"><abbr title="src/ResourceGroup/CustomerInteraction.php">CustomerInteraction.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">85</span>
</aside>
<p class="phpdocumentor-summary">Makes POST &quot;/api/v5/customer-interaction/{site}/cart/clear&quot; request.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">cartClear</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/RetailCrm-Api-Model-Request-CustomerInteraction-CustomerInteractionCartClearRequest.html"><abbr title="\RetailCrm\Api\Model\Request\CustomerInteraction\CustomerInteractionCartClearRequest">CustomerInteractionCartClearRequest</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$request</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string|int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$site</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/RetailCrm-Api-Model-Response-SuccessResponse.html"><abbr title="\RetailCrm\Api\Model\Response\SuccessResponse">SuccessResponse</abbr></a></span></code>
<div class="phpdocumentor-label-line">
</div>
<section class="phpdocumentor-description"><p>Example:</p>
<pre class="prettyprint"><code class="language-php">use RetailCrm\Api\Enum\BySite;
use RetailCrm\Api\Factory\SimpleClientFactory;
use RetailCrm\Api\Interfaces\ApiExceptionInterface;
use RetailCrm\Api\Model\Entity\CustomerInteraction\Cart;
use RetailCrm\Api\Model\Entity\CustomerInteraction\CartCustomer;
use RetailCrm\Api\Model\Request\CustomerInteraction\CustomerInteractionCartClearRequest;
$client = SimpleClientFactory::createClient('https://test.retailcrm.pro', 'apiKey');
$cart = new Cart();
$cart-&gt;clearedAt = new DateTime('now');
$cart-&gt;customer = new CartCustomer();
$cart-&gt;customer-&gt;id = 4770;
$cart-&gt;customer-&gt;browserId = 'browserId';
$cart-&gt;customer-&gt;gaClientId = 'gaClientId';
$request = new CustomerInteractionCartClearRequest();
$request-&gt;cart = $cart;
$request-&gt;siteBy = BySite::CODE;
try {
$response = $client-&gt;customerInteraction-&gt;cartClear('testSite', $request);
} catch (ApiExceptionInterface $exception) {
echo sprintf(
'Error from RetailCRM API (status code: %d): %s',
$exception-&gt;getStatusCode(),
$exception-&gt;getMessage()
);
if (count($exception-&gt;getErrorResponse()-&gt;errors) &gt; 0) {
echo PHP_EOL . 'Errors: ' . implode(', ', $exception-&gt;getErrorResponse()-&gt;errors);
}
return;
}
</code></pre>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$request</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/RetailCrm-Api-Model-Request-CustomerInteraction-CustomerInteractionCartClearRequest.html"><abbr title="\RetailCrm\Api\Model\Request\CustomerInteraction\CustomerInteractionCartClearRequest">CustomerInteractionCartClearRequest</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$site</span>
: <span class="phpdocumentor-signature__argument__return-type">string|int</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/RetailCrm-Api-ResourceGroup-CustomerInteraction.html#method_cartClear#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/RetailCrm-Api-Interfaces-ApiExceptionInterface.html"><abbr title="\RetailCrm\Api\Interfaces\ApiExceptionInterface">ApiExceptionInterface</abbr></a></span>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/RetailCrm-Api-Interfaces-ClientExceptionInterface.html"><abbr title="\RetailCrm\Api\Interfaces\ClientExceptionInterface">ClientExceptionInterface</abbr></a></span>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/RetailCrm-Api-Exception-Api-AccountDoesNotExistException.html"><abbr title="\RetailCrm\Api\Exception\Api\AccountDoesNotExistException">AccountDoesNotExistException</abbr></a></span>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/RetailCrm-Api-Exception-Api-ApiErrorException.html"><abbr title="\RetailCrm\Api\Exception\Api\ApiErrorException">ApiErrorException</abbr></a></span>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/RetailCrm-Api-Exception-Api-MissingCredentialsException.html"><abbr title="\RetailCrm\Api\Exception\Api\MissingCredentialsException">MissingCredentialsException</abbr></a></span>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/RetailCrm-Api-Exception-Api-MissingParameterException.html"><abbr title="\RetailCrm\Api\Exception\Api\MissingParameterException">MissingParameterException</abbr></a></span>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/RetailCrm-Api-Exception-Api-ValidationException.html"><abbr title="\RetailCrm\Api\Exception\Api\ValidationException">ValidationException</abbr></a></span>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/RetailCrm-Api-Exception-Client-HandlerException.html"><abbr title="\RetailCrm\Api\Exception\Client\HandlerException">HandlerException</abbr></a></span>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/RetailCrm-Api-Exception-Client-HttpClientException.html"><abbr title="\RetailCrm\Api\Exception\Client\HttpClientException">HttpClientException</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type"><a href="classes/RetailCrm-Api-Model-Response-SuccessResponse.html"><abbr title="\RetailCrm\Api\Model\Response\SuccessResponse">SuccessResponse</abbr></a></span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_cartGet">
cartGet()
<a href="classes/RetailCrm-Api-ResourceGroup-CustomerInteraction.html#method_cartGet" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/ResourceGroup/CustomerInteraction.php"><a href="files/src-resourcegroup-customerinteraction.html"><abbr title="src/ResourceGroup/CustomerInteraction.php">CustomerInteraction.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">224</span>
</aside>
<p class="phpdocumentor-summary">Makes GET &quot;/api/v5/customer-interaction/{site}/cart/{customerId}&quot; request.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">cartGet</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string|int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$site</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string|int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$customerId</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type"><a href="classes/RetailCrm-Api-Model-Request-ByAndSiteByRequest.html"><abbr title="\RetailCrm\Api\Model\Request\ByAndSiteByRequest">ByAndSiteByRequest</abbr></a>|null&nbsp;</span><span class="phpdocumentor-signature__argument__name">$request</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/RetailCrm-Api-Model-Response-CustomerInteraction-CustomerInteractionCartGetResponse.html"><abbr title="\RetailCrm\Api\Model\Response\CustomerInteraction\CustomerInteractionCartGetResponse">CustomerInteractionCartGetResponse</abbr></a></span></code>
<div class="phpdocumentor-label-line">
</div>
<section class="phpdocumentor-description"><p>Example:</p>
<pre class="prettyprint"><code class="language-php">use RetailCrm\Api\Enum\ByIdentifier;
use RetailCrm\Api\Enum\BySite;
use RetailCrm\Api\Factory\SimpleClientFactory;
use RetailCrm\Api\Interfaces\ApiExceptionInterface;
use RetailCrm\Api\Model\Request\ByAndSiteByRequest;
$client = SimpleClientFactory::createClient('https://test.retailcrm.pro', 'apiKey');
try {
$response = $client-&gt;customerInteraction-&gt;cartGet(
'testSite',
4200,
new ByAndSiteByRequest(ByIdentifier::ID, BySite::CODE)
);
} catch (ApiExceptionInterface $exception) {
echo sprintf(
'Error from RetailCRM API (status code: %d): %s',
$exception-&gt;getStatusCode(),
$exception-&gt;getMessage()
);
if (count($exception-&gt;getErrorResponse()-&gt;errors) &gt; 0) {
echo PHP_EOL . 'Errors: ' . implode(', ', $exception-&gt;getErrorResponse()-&gt;errors);
}
return;
}
echo 'Cart: ' . print_r($response-&gt;cart, true);
</code></pre>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$site</span>
: <span class="phpdocumentor-signature__argument__return-type">string|int</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$customerId</span>
: <span class="phpdocumentor-signature__argument__return-type">string|int</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$request</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/RetailCrm-Api-Model-Request-ByAndSiteByRequest.html"><abbr title="\RetailCrm\Api\Model\Request\ByAndSiteByRequest">ByAndSiteByRequest</abbr></a>|null</span>
= <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/RetailCrm-Api-ResourceGroup-CustomerInteraction.html#method_cartGet#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/RetailCrm-Api-Interfaces-ApiExceptionInterface.html"><abbr title="\RetailCrm\Api\Interfaces\ApiExceptionInterface">ApiExceptionInterface</abbr></a></span>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/RetailCrm-Api-Interfaces-ClientExceptionInterface.html"><abbr title="\RetailCrm\Api\Interfaces\ClientExceptionInterface">ClientExceptionInterface</abbr></a></span>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/RetailCrm-Api-Exception-Api-AccountDoesNotExistException.html"><abbr title="\RetailCrm\Api\Exception\Api\AccountDoesNotExistException">AccountDoesNotExistException</abbr></a></span>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/RetailCrm-Api-Exception-Api-ApiErrorException.html"><abbr title="\RetailCrm\Api\Exception\Api\ApiErrorException">ApiErrorException</abbr></a></span>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/RetailCrm-Api-Exception-Api-MissingCredentialsException.html"><abbr title="\RetailCrm\Api\Exception\Api\MissingCredentialsException">MissingCredentialsException</abbr></a></span>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/RetailCrm-Api-Exception-Api-MissingParameterException.html"><abbr title="\RetailCrm\Api\Exception\Api\MissingParameterException">MissingParameterException</abbr></a></span>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/RetailCrm-Api-Exception-Api-ValidationException.html"><abbr title="\RetailCrm\Api\Exception\Api\ValidationException">ValidationException</abbr></a></span>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/RetailCrm-Api-Exception-Client-HandlerException.html"><abbr title="\RetailCrm\Api\Exception\Client\HandlerException">HandlerException</abbr></a></span>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/RetailCrm-Api-Exception-Client-HttpClientException.html"><abbr title="\RetailCrm\Api\Exception\Client\HttpClientException">HttpClientException</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type"><a href="classes/RetailCrm-Api-Model-Response-CustomerInteraction-CustomerInteractionCartGetResponse.html"><abbr title="\RetailCrm\Api\Model\Response\CustomerInteraction\CustomerInteractionCartGetResponse">CustomerInteractionCartGetResponse</abbr></a></span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_cartSet">
cartSet()
<a href="classes/RetailCrm-Api-ResourceGroup-CustomerInteraction.html#method_cartSet" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/ResourceGroup/CustomerInteraction.php"><a href="files/src-resourcegroup-customerinteraction.html"><abbr title="src/ResourceGroup/CustomerInteraction.php">CustomerInteraction.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">161</span>
</aside>
<p class="phpdocumentor-summary">Makes POST &quot;/api/v5/customer-interaction/{site}/cart/set&quot; request.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">cartSet</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/RetailCrm-Api-Model-Request-CustomerInteraction-CustomerInteractionCartSetRequest.html"><abbr title="\RetailCrm\Api\Model\Request\CustomerInteraction\CustomerInteractionCartSetRequest">CustomerInteractionCartSetRequest</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$request</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string|int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$site</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/RetailCrm-Api-Model-Response-SuccessResponse.html"><abbr title="\RetailCrm\Api\Model\Response\SuccessResponse">SuccessResponse</abbr></a></span></code>
<div class="phpdocumentor-label-line">
</div>
<section class="phpdocumentor-description"><p>Example:</p>
<pre class="prettyprint"><code class="language-php">use RetailCrm\Api\Enum\BySite;
use RetailCrm\Api\Factory\SimpleClientFactory;
use RetailCrm\Api\Interfaces\ApiExceptionInterface;
use RetailCrm\Api\Model\Entity\CustomerInteraction\Cart;
use RetailCrm\Api\Model\Entity\CustomerInteraction\CartCustomer;
use RetailCrm\Api\Model\Entity\CustomerInteraction\CartItem;
use RetailCrm\Api\Model\Entity\Orders\Items\Offer;
use RetailCrm\Api\Model\Request\CustomerInteraction\CustomerInteractionCartSetRequest;
$client = SimpleClientFactory::createClient('https://test.retailcrm.pro', 'apiKey');
$customer = new CartCustomer();
$customer-&gt;id = 4770;
$cartItem = new CartItem();
$cartItem-&gt;price = 24.99;
$cartItem-&gt;quantity = 2;
$cartItem-&gt;offer = new Offer();
$cartItem-&gt;offer-&gt;externalId = '47701234567890';
$cart = new Cart();
$cart-&gt;items[] = $cartItem;
$cart-&gt;customer = $customer;
$request = new CustomerInteractionCartSetRequest();
$request-&gt;cart = $cart;
$request-&gt;siteBy = BySite::CODE;
try {
$response = $client-&gt;customerInteraction-&gt;cartSet('testSite', $request);
} catch (ApiExceptionInterface $exception) {
echo sprintf(
'Error from RetailCRM API (status code: %d): %s',
$exception-&gt;getStatusCode(),
$exception-&gt;getMessage()
);
if (count($exception-&gt;getErrorResponse()-&gt;errors) &gt; 0) {
echo PHP_EOL . 'Errors: ' . implode(', ', $exception-&gt;getErrorResponse()-&gt;errors);
}
return;
}
</code></pre>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$request</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/RetailCrm-Api-Model-Request-CustomerInteraction-CustomerInteractionCartSetRequest.html"><abbr title="\RetailCrm\Api\Model\Request\CustomerInteraction\CustomerInteractionCartSetRequest">CustomerInteractionCartSetRequest</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$site</span>
: <span class="phpdocumentor-signature__argument__return-type">string|int</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/RetailCrm-Api-ResourceGroup-CustomerInteraction.html#method_cartSet#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/RetailCrm-Api-Interfaces-ApiExceptionInterface.html"><abbr title="\RetailCrm\Api\Interfaces\ApiExceptionInterface">ApiExceptionInterface</abbr></a></span>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/RetailCrm-Api-Interfaces-ClientExceptionInterface.html"><abbr title="\RetailCrm\Api\Interfaces\ClientExceptionInterface">ClientExceptionInterface</abbr></a></span>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/RetailCrm-Api-Exception-Api-AccountDoesNotExistException.html"><abbr title="\RetailCrm\Api\Exception\Api\AccountDoesNotExistException">AccountDoesNotExistException</abbr></a></span>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/RetailCrm-Api-Exception-Api-ApiErrorException.html"><abbr title="\RetailCrm\Api\Exception\Api\ApiErrorException">ApiErrorException</abbr></a></span>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/RetailCrm-Api-Exception-Api-MissingCredentialsException.html"><abbr title="\RetailCrm\Api\Exception\Api\MissingCredentialsException">MissingCredentialsException</abbr></a></span>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/RetailCrm-Api-Exception-Api-MissingParameterException.html"><abbr title="\RetailCrm\Api\Exception\Api\MissingParameterException">MissingParameterException</abbr></a></span>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/RetailCrm-Api-Exception-Api-ValidationException.html"><abbr title="\RetailCrm\Api\Exception\Api\ValidationException">ValidationException</abbr></a></span>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/RetailCrm-Api-Exception-Client-HandlerException.html"><abbr title="\RetailCrm\Api\Exception\Client\HandlerException">HandlerException</abbr></a></span>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/RetailCrm-Api-Exception-Client-HttpClientException.html"><abbr title="\RetailCrm\Api\Exception\Client\HttpClientException">HttpClientException</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type"><a href="classes/RetailCrm-Api-Model-Response-SuccessResponse.html"><abbr title="\RetailCrm\Api\Model\Response\SuccessResponse">SuccessResponse</abbr></a></span>
</section>
</article>
</section>
<div class="phpdocumentor-modal" id="source-view">
<div class="phpdocumentor-modal-bg" data-exit-button></div>
<div class="phpdocumentor-modal-container">
<div class="phpdocumentor-modal-content">
<pre style="max-height: 500px; overflow-y: scroll" data-src="files/src/ResourceGroup/CustomerInteraction.php.txt" class="language-php line-numbers linkable-line-numbers"></pre>
</div>
<button data-exit-button class="phpdocumentor-modal__close">&times;</button>
</div>
</div>
<script type="text/javascript">
(function () {
function loadExternalCodeSnippet(el, url, line) {
Array.prototype.slice.call(el.querySelectorAll('pre[data-src]')).forEach((pre) => {
const src = url || pre.getAttribute('data-src').replace(/\\/g, '/');
const language = 'php';
const code = document.createElement('code');
code.className = 'language-' + language;
pre.textContent = '';
pre.setAttribute('data-line', line)
code.textContent = 'Loading…';
pre.appendChild(code);
var xhr = new XMLHttpRequest();
xhr.open('GET', src, true);
xhr.onreadystatechange = function () {
if (xhr.readyState !== 4) {
return;
}
if (xhr.status < 400 && xhr.responseText) {
code.textContent = xhr.responseText;
Prism.highlightElement(code);
return;
}
if (xhr.status === 404) {
code.textContent = '✖ Error: File could not be found';
return;
}
if (xhr.status >= 400) {
code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
return;
}
code.textContent = '✖ Error: An unknown error occurred';
};
xhr.send(null);
});
}
const modalButtons = document.querySelectorAll("[data-modal]");
const openedAsLocalFile = window.location.protocol === 'file:';
if (modalButtons.length > 0 && openedAsLocalFile) {
console.warn(
'Viewing the source code is unavailable because you are opening this page from the file:// scheme; ' +
'browsers block XHR requests when a page is opened this way'
);
}
modalButtons.forEach(function (trigger) {
if (openedAsLocalFile) {
trigger.setAttribute("hidden", "hidden");
}
trigger.addEventListener("click", function (event) {
event.preventDefault();
const modal = document.getElementById(trigger.dataset.modal);
if (!modal) {
console.error(`Modal with id "${trigger.dataset.modal}" could not be found`);
return;
}
modal.classList.add("phpdocumentor-modal__open");
loadExternalCodeSnippet(modal, trigger.dataset.src || null, trigger.dataset.line)
const exits = modal.querySelectorAll("[data-exit-button]");
exits.forEach(function (exit) {
exit.addEventListener("click", function (event) {
event.preventDefault();
modal.classList.remove("phpdocumentor-modal__open");
});
});
});
});
})();
</script>
</article>
</section>
<section class="phpdocumentor-on-this-page__sidebar">
<section class="phpdocumentor-on-this-page__content">
<strong class="phpdocumentor-on-this-page__title">On this page</strong>
<ul class="phpdocumentor-list -clean">
<li class="phpdocumentor-on-this-page-section__title">Table Of Contents</li>
<li>
<ul class="phpdocumentor-list -clean">
<li><a href="classes/RetailCrm-Api-ResourceGroup-CustomerInteraction.html#toc-methods">Methods</a></li>
</ul>
</li>
<li class="phpdocumentor-on-this-page-section__title">Methods</li>
<li>
<ul class="phpdocumentor-list -clean">
<li><a href="classes/RetailCrm-Api-ResourceGroup-CustomerInteraction.html#method_cartClear">cartClear()</a></li>
<li><a href="classes/RetailCrm-Api-ResourceGroup-CustomerInteraction.html#method_cartGet">cartGet()</a></li>
<li><a href="classes/RetailCrm-Api-ResourceGroup-CustomerInteraction.html#method_cartSet">cartSet()</a></li>
</ul>
</li>
</ul>
</section>
</section>
</div>
<section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
<section class="phpdocumentor-search-results__dialog">
<header class="phpdocumentor-search-results__header">
<h2 class="phpdocumentor-search-results__title">Search results</h2>
<button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
</header>
<section class="phpdocumentor-search-results__body">
<ul class="phpdocumentor-search-results__entries"></ul>
</section>
</section>
</section>
</div>
<a href="classes/RetailCrm-Api-ResourceGroup-CustomerInteraction.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
</main>
<script>
cssVars({});
</script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink