3269 lines
199 KiB
HTML
3269 lines
199 KiB
HTML
<!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">
|
||
Orders
|
||
|
||
<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/Orders.php"><a href="files/src-resourcegroup-orders.html"><abbr title="src/ResourceGroup/Orders.php">Orders.php</abbr></a></abbr>
|
||
:
|
||
<span class="phpdocumentor-element-found-in__line">48</span>
|
||
|
||
</aside>
|
||
|
||
<p class="phpdocumentor-summary">Class Orders</p>
|
||
|
||
|
||
|
||
<h5 class="phpdocumentor-tag-list__heading" id="tags">
|
||
Tags
|
||
<a href="classes/RetailCrm-Api-ResourceGroup-Orders.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>Orders</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.ExcessiveClassLength)</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-Orders.html#toc" class="headerlink"><i class="fas fa-link"></i></a>
|
||
|
||
</h3>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<h4 id="toc-methods">
|
||
Methods
|
||
<a href="classes/RetailCrm-Api-ResourceGroup-Orders.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-Orders.html#method_cancelBonusOperations">cancelBonusOperations()</a>
|
||
<span>
|
||
: <a href="classes/RetailCrm-Api-Model-Response-Orders-OrdersGetResponse.html"><abbr title="\RetailCrm\Api\Model\Response\Orders\OrdersGetResponse">OrdersGetResponse</abbr></a> </span>
|
||
</dt>
|
||
<dd>Makes POST "/api/v5/orders/loyalty/cancel-bonus-operations" request.</dd>
|
||
|
||
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
||
<a href="classes/RetailCrm-Api-ResourceGroup-Orders.html#method_combine">combine()</a>
|
||
<span>
|
||
: <a href="classes/RetailCrm-Api-Model-Response-Orders-OrdersCombineResponse.html"><abbr title="\RetailCrm\Api\Model\Response\Orders\OrdersCombineResponse">OrdersCombineResponse</abbr></a> </span>
|
||
</dt>
|
||
<dd>Makes POST "/api/v5/orders/combine" request.</dd>
|
||
|
||
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
||
<a href="classes/RetailCrm-Api-ResourceGroup-Orders.html#method_create">create()</a>
|
||
<span>
|
||
: <a href="classes/RetailCrm-Api-Model-Response-Orders-OrdersCreateResponse.html"><abbr title="\RetailCrm\Api\Model\Response\Orders\OrdersCreateResponse">OrdersCreateResponse</abbr></a> </span>
|
||
</dt>
|
||
<dd>Makes POST "/api/v5/orders/create" request.</dd>
|
||
|
||
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
||
<a href="classes/RetailCrm-Api-ResourceGroup-Orders.html#method_deliveryCancel">deliveryCancel()</a>
|
||
<span>
|
||
: <a href="classes/RetailCrm-Api-Model-Response-SuccessResponse.html"><abbr title="\RetailCrm\Api\Model\Response\SuccessResponse">SuccessResponse</abbr></a> </span>
|
||
</dt>
|
||
<dd>Makes POST "/api/v5/orders/{externalId}/delivery/cancel" request.</dd>
|
||
|
||
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
||
<a href="classes/RetailCrm-Api-ResourceGroup-Orders.html#method_edit">edit()</a>
|
||
<span>
|
||
: <a href="classes/RetailCrm-Api-Model-Response-Orders-OrdersCreateResponse.html"><abbr title="\RetailCrm\Api\Model\Response\Orders\OrdersCreateResponse">OrdersCreateResponse</abbr></a> </span>
|
||
</dt>
|
||
<dd>Makes POST "/api/v5/orders/{externalId}/edit" request.</dd>
|
||
|
||
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
||
<a href="classes/RetailCrm-Api-ResourceGroup-Orders.html#method_fixExternalIds">fixExternalIds()</a>
|
||
<span>
|
||
: <a href="classes/RetailCrm-Api-Model-Response-SuccessResponse.html"><abbr title="\RetailCrm\Api\Model\Response\SuccessResponse">SuccessResponse</abbr></a> </span>
|
||
</dt>
|
||
<dd>Makes POST "/api/v5/orders/fix-external-ids" request.</dd>
|
||
|
||
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
||
<a href="classes/RetailCrm-Api-ResourceGroup-Orders.html#method_get">get()</a>
|
||
<span>
|
||
: <a href="classes/RetailCrm-Api-Model-Response-Orders-OrdersGetResponse.html"><abbr title="\RetailCrm\Api\Model\Response\Orders\OrdersGetResponse">OrdersGetResponse</abbr></a> </span>
|
||
</dt>
|
||
<dd>Makes GET "/api/v5/orders" request.</dd>
|
||
|
||
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
||
<a href="classes/RetailCrm-Api-ResourceGroup-Orders.html#method_history">history()</a>
|
||
<span>
|
||
: <a href="classes/RetailCrm-Api-Model-Response-Orders-OrdersHistoryResponse.html"><abbr title="\RetailCrm\Api\Model\Response\Orders\OrdersHistoryResponse">OrdersHistoryResponse</abbr></a> </span>
|
||
</dt>
|
||
<dd>Makes GET "/api/v5/orders/history" request.</dd>
|
||
|
||
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
||
<a href="classes/RetailCrm-Api-ResourceGroup-Orders.html#method_linksCreate">linksCreate()</a>
|
||
<span>
|
||
: <a href="classes/RetailCrm-Api-Model-Response-SuccessResponse.html"><abbr title="\RetailCrm\Api\Model\Response\SuccessResponse">SuccessResponse</abbr></a> </span>
|
||
</dt>
|
||
<dd>Makes POST "/api/v5/orders/links/create" request.</dd>
|
||
|
||
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
||
<a href="classes/RetailCrm-Api-ResourceGroup-Orders.html#method_list">list()</a>
|
||
<span>
|
||
: <a href="classes/RetailCrm-Api-Model-Response-Orders-OrdersResponse.html"><abbr title="\RetailCrm\Api\Model\Response\Orders\OrdersResponse">OrdersResponse</abbr></a> </span>
|
||
</dt>
|
||
<dd>Makes GET "/api/v5/orders" request.</dd>
|
||
|
||
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
||
<a href="classes/RetailCrm-Api-ResourceGroup-Orders.html#method_loyaltyApply">loyaltyApply()</a>
|
||
<span>
|
||
: <a href="classes/RetailCrm-Api-Model-Response-Orders-OrdersLoyaltyApplyResponse.html"><abbr title="\RetailCrm\Api\Model\Response\Orders\OrdersLoyaltyApplyResponse">OrdersLoyaltyApplyResponse</abbr></a> </span>
|
||
</dt>
|
||
<dd>Makes POST "/api/v5/orders/loyalty/apply" request.</dd>
|
||
|
||
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
||
<a href="classes/RetailCrm-Api-ResourceGroup-Orders.html#method_paymentsCreate">paymentsCreate()</a>
|
||
<span>
|
||
: <a href="classes/RetailCrm-Api-Model-Response-IdResponse.html"><abbr title="\RetailCrm\Api\Model\Response\IdResponse">IdResponse</abbr></a> </span>
|
||
</dt>
|
||
<dd>Makes POST "/api/v5/orders/payments/create" request.</dd>
|
||
|
||
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
||
<a href="classes/RetailCrm-Api-ResourceGroup-Orders.html#method_paymentsDelete">paymentsDelete()</a>
|
||
<span>
|
||
: <a href="classes/RetailCrm-Api-Model-Response-SuccessResponse.html"><abbr title="\RetailCrm\Api\Model\Response\SuccessResponse">SuccessResponse</abbr></a> </span>
|
||
</dt>
|
||
<dd>Makes POST "/api/v5/orders/payments/{id}/delete" request.</dd>
|
||
|
||
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
||
<a href="classes/RetailCrm-Api-ResourceGroup-Orders.html#method_paymentsEdit">paymentsEdit()</a>
|
||
<span>
|
||
: <a href="classes/RetailCrm-Api-Model-Response-IdResponse.html"><abbr title="\RetailCrm\Api\Model\Response\IdResponse">IdResponse</abbr></a> </span>
|
||
</dt>
|
||
<dd>Makes POST "/api/v5/orders/payments/{id}/edit" request.</dd>
|
||
|
||
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
||
<a href="classes/RetailCrm-Api-ResourceGroup-Orders.html#method_platesPrint">platesPrint()</a>
|
||
<span>
|
||
: <a href="classes/RetailCrm-Api-Model-Response-Files-FilesDownloadResponse.html"><abbr title="\RetailCrm\Api\Model\Response\Files\FilesDownloadResponse">FilesDownloadResponse</abbr></a> </span>
|
||
</dt>
|
||
<dd>Makes GET "/api/v5/orders/{externalId}/plates/{plateId}/print" request.</dd>
|
||
|
||
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
||
<a href="classes/RetailCrm-Api-ResourceGroup-Orders.html#method_statuses">statuses()</a>
|
||
<span>
|
||
: <a href="classes/RetailCrm-Api-Model-Response-Orders-OrdersStatusesResponse.html"><abbr title="\RetailCrm\Api\Model\Response\Orders\OrdersStatusesResponse">OrdersStatusesResponse</abbr></a> </span>
|
||
</dt>
|
||
<dd>Makes GET "/api/v5/orders/statuses" request.</dd>
|
||
|
||
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
||
<a href="classes/RetailCrm-Api-ResourceGroup-Orders.html#method_upload">upload()</a>
|
||
<span>
|
||
: <a href="classes/RetailCrm-Api-Model-Response-Orders-OrdersUploadResponse.html"><abbr title="\RetailCrm\Api\Model\Response\Orders\OrdersUploadResponse">OrdersUploadResponse</abbr></a> </span>
|
||
</dt>
|
||
<dd>Makes POST "/api/v5/orders/upload" request.</dd>
|
||
|
||
</dl>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<section class="phpdocumentor-methods">
|
||
<h3 class="phpdocumentor-elements__header" id="methods">
|
||
Methods
|
||
<a href="classes/RetailCrm-Api-ResourceGroup-Orders.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_cancelBonusOperations">
|
||
cancelBonusOperations()
|
||
<a href="classes/RetailCrm-Api-ResourceGroup-Orders.html#method_cancelBonusOperations" 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/Orders.php"><a href="files/src-resourcegroup-orders.html"><abbr title="src/ResourceGroup/Orders.php">Orders.php</abbr></a></abbr>
|
||
:
|
||
<span class="phpdocumentor-element-found-in__line">603</span>
|
||
|
||
</aside>
|
||
|
||
<p class="phpdocumentor-summary">Makes POST "/api/v5/orders/loyalty/cancel-bonus-operations" request.</p>
|
||
|
||
<code class="phpdocumentor-code phpdocumentor-signature ">
|
||
<span class="phpdocumentor-signature__visibility">public</span>
|
||
<span class="phpdocumentor-signature__name">cancelBonusOperations</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/RetailCrm-Api-Model-Request-Orders-OrderLoyaltyCancelBonusOperationsRequest.html"><abbr title="\RetailCrm\Api\Model\Request\Orders\OrderLoyaltyCancelBonusOperationsRequest">OrderLoyaltyCancelBonusOperationsRequest</abbr></a> </span><span class="phpdocumentor-signature__argument__name">$request</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/RetailCrm-Api-Model-Response-Orders-OrdersGetResponse.html"><abbr title="\RetailCrm\Api\Model\Response\Orders\OrdersGetResponse">OrdersGetResponse</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\Factory\SimpleClientFactory;
|
||
use RetailCrm\Api\Interfaces\ApiExceptionInterface;
|
||
use RetailCrm\Api\Model\Entity\Delivery\SerializedEntityOrder;
|
||
use RetailCrm\Api\Model\Request\Orders\OrderLoyaltyCancelBonusOperationsRequest;
|
||
|
||
$client = SimpleClientFactory::createClient('https://test.retailcrm.pro', 'apiKey');
|
||
$request = new OrderLoyaltyCancelBonusOperationsRequest(
|
||
SerializedEntityOrder::withId(7751),
|
||
'bitrix-test'
|
||
);
|
||
|
||
try {
|
||
$response = $client->orders->cancelBonusOperations($request);
|
||
} catch (ApiExceptionInterface $exception) {
|
||
echo sprintf(
|
||
'Error from RetailCRM API (status code: %d): %s',
|
||
$exception->getStatusCode(),
|
||
$exception->getMessage()
|
||
);
|
||
|
||
if (count($exception->getErrorResponse()->errors) > 0) {
|
||
echo PHP_EOL . 'Errors: ' . implode(', ', $exception->getErrorResponse()->errors);
|
||
}
|
||
|
||
return;
|
||
}
|
||
|
||
echo 'Current loyalty account balance: ' . $response->order->loyaltyAccount->amount . ' bonuses.';
|
||
</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-Orders-OrderLoyaltyCancelBonusOperationsRequest.html"><abbr title="\RetailCrm\Api\Model\Request\Orders\OrderLoyaltyCancelBonusOperationsRequest">OrderLoyaltyCancelBonusOperationsRequest</abbr></a></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-Orders.html#method_cancelBonusOperations#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-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>
|
||
<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>
|
||
</dl>
|
||
|
||
<section>
|
||
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
||
<span class="phpdocumentor-signature__response_type"><a href="classes/RetailCrm-Api-Model-Response-Orders-OrdersGetResponse.html"><abbr title="\RetailCrm\Api\Model\Response\Orders\OrdersGetResponse">OrdersGetResponse</abbr></a></span>
|
||
</section>
|
||
|
||
</article>
|
||
<article
|
||
class="phpdocumentor-element
|
||
-method
|
||
-public
|
||
"
|
||
>
|
||
<h4 class="phpdocumentor-element__name" id="method_combine">
|
||
combine()
|
||
<a href="classes/RetailCrm-Api-ResourceGroup-Orders.html#method_combine" 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/Orders.php"><a href="files/src-resourcegroup-orders.html"><abbr title="src/ResourceGroup/Orders.php">Orders.php</abbr></a></abbr>
|
||
:
|
||
<span class="phpdocumentor-element-found-in__line">160</span>
|
||
|
||
</aside>
|
||
|
||
<p class="phpdocumentor-summary">Makes POST "/api/v5/orders/combine" request.</p>
|
||
|
||
<code class="phpdocumentor-code phpdocumentor-signature ">
|
||
<span class="phpdocumentor-signature__visibility">public</span>
|
||
<span class="phpdocumentor-signature__name">combine</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/RetailCrm-Api-Model-Request-Orders-OrdersCombineRequest.html"><abbr title="\RetailCrm\Api\Model\Request\Orders\OrdersCombineRequest">OrdersCombineRequest</abbr></a> </span><span class="phpdocumentor-signature__argument__name">$request</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/RetailCrm-Api-Model-Response-Orders-OrdersCombineResponse.html"><abbr title="\RetailCrm\Api\Model\Response\Orders\OrdersCombineResponse">OrdersCombineResponse</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\CombineTechnique;
|
||
use RetailCrm\Api\Factory\SimpleClientFactory;
|
||
use RetailCrm\Api\Interfaces\ApiExceptionInterface;
|
||
use RetailCrm\Api\Model\Entity\Orders\SerializedOrderReference;
|
||
use RetailCrm\Api\Model\Request\Orders\OrdersCombineRequest;
|
||
|
||
$client = SimpleClientFactory::createClient('https://test.retailcrm.pro', 'apiKey');
|
||
|
||
$request = new OrdersCombineRequest();
|
||
$request->order = new SerializedOrderReference(7143);
|
||
$request->resultOrder = new SerializedOrderReference(7140);
|
||
$request->technique = CombineTechnique::SUMM;
|
||
|
||
try {
|
||
$response = $client->orders->combine($request);
|
||
} catch (ApiExceptionInterface $exception) {
|
||
echo sprintf(
|
||
'Error from RetailCRM API (status code: %d): %s',
|
||
$exception->getStatusCode(),
|
||
$exception->getMessage()
|
||
);
|
||
|
||
if (count($exception->getErrorResponse()->errors) > 0) {
|
||
echo PHP_EOL . 'Errors: ' . implode(', ', $exception->getErrorResponse()->errors);
|
||
}
|
||
|
||
return;
|
||
}
|
||
|
||
echo 'Combine errors: ' . print_r($response->errors, 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">$request</span>
|
||
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/RetailCrm-Api-Model-Request-Orders-OrdersCombineRequest.html"><abbr title="\RetailCrm\Api\Model\Request\Orders\OrdersCombineRequest">OrdersCombineRequest</abbr></a></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-Orders.html#method_combine#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-Orders-OrdersCombineResponse.html"><abbr title="\RetailCrm\Api\Model\Response\Orders\OrdersCombineResponse">OrdersCombineResponse</abbr></a></span>
|
||
</section>
|
||
|
||
</article>
|
||
<article
|
||
class="phpdocumentor-element
|
||
-method
|
||
-public
|
||
"
|
||
>
|
||
<h4 class="phpdocumentor-element__name" id="method_create">
|
||
create()
|
||
<a href="classes/RetailCrm-Api-ResourceGroup-Orders.html#method_create" 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/Orders.php"><a href="files/src-resourcegroup-orders.html"><abbr title="src/ResourceGroup/Orders.php">Orders.php</abbr></a></abbr>
|
||
:
|
||
<span class="phpdocumentor-element-found-in__line">296</span>
|
||
|
||
</aside>
|
||
|
||
<p class="phpdocumentor-summary">Makes POST "/api/v5/orders/create" request.</p>
|
||
|
||
<code class="phpdocumentor-code phpdocumentor-signature ">
|
||
<span class="phpdocumentor-signature__visibility">public</span>
|
||
<span class="phpdocumentor-signature__name">create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/RetailCrm-Api-Model-Request-Orders-OrdersCreateRequest.html"><abbr title="\RetailCrm\Api\Model\Request\Orders\OrdersCreateRequest">OrdersCreateRequest</abbr></a> </span><span class="phpdocumentor-signature__argument__name">$request</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/RetailCrm-Api-Model-Response-Orders-OrdersCreateResponse.html"><abbr title="\RetailCrm\Api\Model\Response\Orders\OrdersCreateResponse">OrdersCreateResponse</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\CountryCodeIso3166;
|
||
use RetailCrm\Api\Enum\Customers\CustomerType;
|
||
use RetailCrm\Api\Factory\SimpleClientFactory;
|
||
use RetailCrm\Api\Interfaces\ApiExceptionInterface;
|
||
use RetailCrm\Api\Model\Entity\Orders\Delivery\OrderDeliveryAddress;
|
||
use RetailCrm\Api\Model\Entity\Orders\Delivery\SerializedOrderDelivery;
|
||
use RetailCrm\Api\Model\Entity\Orders\Items\Offer;
|
||
use RetailCrm\Api\Model\Entity\Orders\Items\OrderProduct;
|
||
use RetailCrm\Api\Model\Entity\Orders\Items\PriceType;
|
||
use RetailCrm\Api\Model\Entity\Orders\Items\Unit;
|
||
use RetailCrm\Api\Model\Entity\Orders\Order;
|
||
use RetailCrm\Api\Model\Entity\Orders\Payment;
|
||
use RetailCrm\Api\Model\Entity\Orders\SerializedRelationCustomer;
|
||
use RetailCrm\Api\Model\Request\Orders\OrdersCreateRequest;
|
||
|
||
$client = SimpleClientFactory::createClient('https://test.retailcrm.pro', 'apiKey');
|
||
|
||
$request = new OrdersCreateRequest();
|
||
$order = new Order();
|
||
$payment = new Payment();
|
||
$delivery = new SerializedOrderDelivery();
|
||
$deliveryAddress = new OrderDeliveryAddress();
|
||
$offer = new Offer();
|
||
$item = new OrderProduct();
|
||
|
||
$payment->type = 'bank-card';
|
||
$payment->status = 'paid';
|
||
$payment->amount = 1000;
|
||
$payment->paidAt = new DateTime();
|
||
|
||
$deliveryAddress->index = '344001';
|
||
$deliveryAddress->countryIso = CountryCodeIso3166::RUSSIAN_FEDERATION;
|
||
$deliveryAddress->region = 'Ростовская область';
|
||
$deliveryAddress->city = 'г. Ростов-на-Дону';
|
||
$deliveryAddress->street = 'ул. Пушкинская';
|
||
$deliveryAddress->building = '10';
|
||
|
||
$delivery->address = $deliveryAddress;
|
||
$delivery->cost = 0;
|
||
$delivery->netCost = 0;
|
||
|
||
$offer->name = 'Сборка №1445123';
|
||
$offer->displayName = 'Сборка №1445123';
|
||
$offer->xmlId = 'tGunLo27jlPGmbA8BrHxY2';
|
||
$offer->article = '14451445-14451445';
|
||
$offer->unit = new Unit('796', 'Штука', 'шт');
|
||
|
||
$item->offer = $offer;
|
||
$item->priceType = new PriceType('base');
|
||
$item->quantity = 1;
|
||
$item->purchasePrice = 60;
|
||
|
||
$order->delivery = $delivery;
|
||
$order->items = [$item];
|
||
$order->payments = [$payment];
|
||
$order->orderType = 'test';
|
||
$order->orderMethod = 'phone';
|
||
$order->countryIso = CountryCodeIso3166::RUSSIAN_FEDERATION;
|
||
$order->firstName = 'Test';
|
||
$order->lastName = 'User';
|
||
$order->patronymic = 'Patronymic';
|
||
$order->phone = '89003005069';
|
||
$order->email = 'testuser12345678901@example.com';
|
||
$order->managerId = 28;
|
||
$order->customer = SerializedRelationCustomer::withIdAndType(
|
||
4924,
|
||
CustomerType::CUSTOMER
|
||
);
|
||
$order->status = 'assembling';
|
||
$order->statusComment = 'Assembling order';
|
||
$order->weight = 1000;
|
||
$order->shipmentStore = 'main12';
|
||
$order->shipmentDate = (new DateTime())->add(new DateInterval('P7D'));
|
||
$order->shipped = false;
|
||
$order->customFields = [
|
||
"galka" => false,
|
||
"test_number" => 0,
|
||
"otpravit_dozakaz" => false,
|
||
];
|
||
|
||
$request->order = $order;
|
||
$request->site = 'moysklad';
|
||
|
||
try {
|
||
$response = $client->orders->create($request);
|
||
} catch (ApiExceptionInterface $exception) {
|
||
echo sprintf(
|
||
'Error from RetailCRM API (status code: %d): %s',
|
||
$exception->getStatusCode(),
|
||
$exception->getMessage()
|
||
);
|
||
|
||
if (count($exception->getErrorResponse()->errors) > 0) {
|
||
echo PHP_EOL . 'Errors: ' . implode(', ', $exception->getErrorResponse()->errors);
|
||
}
|
||
|
||
return;
|
||
}
|
||
|
||
printf(
|
||
'Created order id = %d with following data: %s',
|
||
$response->id,
|
||
print_r($response->order, 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">$request</span>
|
||
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/RetailCrm-Api-Model-Request-Orders-OrdersCreateRequest.html"><abbr title="\RetailCrm\Api\Model\Request\Orders\OrdersCreateRequest">OrdersCreateRequest</abbr></a></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-Orders.html#method_create#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-Orders-OrdersCreateResponse.html"><abbr title="\RetailCrm\Api\Model\Response\Orders\OrdersCreateResponse">OrdersCreateResponse</abbr></a></span>
|
||
</section>
|
||
|
||
</article>
|
||
<article
|
||
class="phpdocumentor-element
|
||
-method
|
||
-public
|
||
"
|
||
>
|
||
<h4 class="phpdocumentor-element__name" id="method_deliveryCancel">
|
||
deliveryCancel()
|
||
<a href="classes/RetailCrm-Api-ResourceGroup-Orders.html#method_deliveryCancel" 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/Orders.php"><a href="files/src-resourcegroup-orders.html"><abbr title="src/ResourceGroup/Orders.php">Orders.php</abbr></a></abbr>
|
||
:
|
||
<span class="phpdocumentor-element-found-in__line">1155</span>
|
||
|
||
</aside>
|
||
|
||
<p class="phpdocumentor-summary">Makes POST "/api/v5/orders/{externalId}/delivery/cancel" request.</p>
|
||
|
||
<code class="phpdocumentor-code phpdocumentor-signature ">
|
||
<span class="phpdocumentor-signature__visibility">public</span>
|
||
<span class="phpdocumentor-signature__name">deliveryCancel</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int|string </span><span class="phpdocumentor-signature__argument__name">$identifier</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type"><a href="classes/RetailCrm-Api-Model-Request-Orders-OrderDeliveryCancelRequest.html"><abbr title="\RetailCrm\Api\Model\Request\Orders\OrderDeliveryCancelRequest">OrderDeliveryCancelRequest</abbr></a> </span><span class="phpdocumentor-signature__argument__name">$request</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\ByIdentifier;
|
||
use RetailCrm\Api\Factory\SimpleClientFactory;
|
||
use RetailCrm\Api\Interfaces\ApiExceptionInterface;
|
||
use RetailCrm\Api\Model\Request\Orders\OrderDeliveryCancelRequest;
|
||
|
||
$client = SimpleClientFactory::createClient('https://test.retailcrm.pro', 'apiKey');
|
||
|
||
$request = new OrderDeliveryCancelRequest();
|
||
$request->by = ByIdentifier::EXTERNAL_ID;
|
||
$request->force = true;
|
||
|
||
try {
|
||
$response = $client->orders->deliveryCancel('8123522898559160', $request);
|
||
} catch (ApiExceptionInterface $exception) {
|
||
echo sprintf(
|
||
'Error from RetailCRM API (status code: %d): %s',
|
||
$exception->getStatusCode(),
|
||
$exception->getMessage()
|
||
);
|
||
|
||
if (count($exception->getErrorResponse()->errors) > 0) {
|
||
echo PHP_EOL . 'Errors: ' . implode(', ', $exception->getErrorResponse()->errors);
|
||
}
|
||
|
||
return;
|
||
}
|
||
|
||
echo 'Order delivery cancel result: ' . print_r($response->success, 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">$identifier</span>
|
||
: <span class="phpdocumentor-signature__argument__return-type">int|string</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-Orders-OrderDeliveryCancelRequest.html"><abbr title="\RetailCrm\Api\Model\Request\Orders\OrderDeliveryCancelRequest">OrderDeliveryCancelRequest</abbr></a></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-Orders.html#method_deliveryCancel#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-Exception-ApiException.html"><abbr title="\RetailCrm\Api\Exception\ApiException">ApiException</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-ClientException.html"><abbr title="\RetailCrm\Api\Exception\ClientException">ClientException</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-Interfaces-ApiExceptionInterface.html"><abbr title="\RetailCrm\Api\Interfaces\ApiExceptionInterface">ApiExceptionInterface</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_edit">
|
||
edit()
|
||
<a href="classes/RetailCrm-Api-ResourceGroup-Orders.html#method_edit" 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/Orders.php"><a href="files/src-resourcegroup-orders.html"><abbr title="src/ResourceGroup/Orders.php">Orders.php</abbr></a></abbr>
|
||
:
|
||
<span class="phpdocumentor-element-found-in__line">1099</span>
|
||
|
||
</aside>
|
||
|
||
<p class="phpdocumentor-summary">Makes POST "/api/v5/orders/{externalId}/edit" request.</p>
|
||
|
||
<code class="phpdocumentor-code phpdocumentor-signature ">
|
||
<span class="phpdocumentor-signature__visibility">public</span>
|
||
<span class="phpdocumentor-signature__name">edit</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int|string </span><span class="phpdocumentor-signature__argument__name">$identifier</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type"><a href="classes/RetailCrm-Api-Model-Request-Orders-OrdersEditRequest.html"><abbr title="\RetailCrm\Api\Model\Request\Orders\OrdersEditRequest">OrdersEditRequest</abbr></a> </span><span class="phpdocumentor-signature__argument__name">$request</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/RetailCrm-Api-Model-Response-Orders-OrdersCreateResponse.html"><abbr title="\RetailCrm\Api\Model\Response\Orders\OrdersCreateResponse">OrdersCreateResponse</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\Factory\SimpleClientFactory;
|
||
use RetailCrm\Api\Interfaces\ApiExceptionInterface;
|
||
use RetailCrm\Api\Model\Entity\Orders\Order;
|
||
use RetailCrm\Api\Model\Request\Orders\OrdersEditRequest;
|
||
|
||
$client = SimpleClientFactory::createClient('https://test.retailcrm.pro', 'apiKey');
|
||
|
||
$order = new Order();
|
||
$order->managerComment = 'Manager comment';
|
||
|
||
$request = new OrdersEditRequest();
|
||
$request->by = ByIdentifier::EXTERNAL_ID;
|
||
$request->site = 'aliexpress';
|
||
$request->order = $order;
|
||
|
||
try {
|
||
$response = $client->orders->edit('8123522898559160', $request);
|
||
} catch (ApiExceptionInterface $exception) {
|
||
echo sprintf(
|
||
'Error from RetailCRM API (status code: %d): %s',
|
||
$exception->getStatusCode(),
|
||
$exception->getMessage()
|
||
);
|
||
|
||
if (count($exception->getErrorResponse()->errors) > 0) {
|
||
echo PHP_EOL . 'Errors: ' . implode(', ', $exception->getErrorResponse()->errors);
|
||
}
|
||
|
||
return;
|
||
}
|
||
|
||
echo 'Edited order: ' . print_r($response->order, 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">$identifier</span>
|
||
: <span class="phpdocumentor-signature__argument__return-type">int|string</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-Orders-OrdersEditRequest.html"><abbr title="\RetailCrm\Api\Model\Request\Orders\OrdersEditRequest">OrdersEditRequest</abbr></a></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-Orders.html#method_edit#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-Orders-OrdersCreateResponse.html"><abbr title="\RetailCrm\Api\Model\Response\Orders\OrdersCreateResponse">OrdersCreateResponse</abbr></a></span>
|
||
</section>
|
||
|
||
</article>
|
||
<article
|
||
class="phpdocumentor-element
|
||
-method
|
||
-public
|
||
"
|
||
>
|
||
<h4 class="phpdocumentor-element__name" id="method_fixExternalIds">
|
||
fixExternalIds()
|
||
<a href="classes/RetailCrm-Api-ResourceGroup-Orders.html#method_fixExternalIds" 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/Orders.php"><a href="files/src-resourcegroup-orders.html"><abbr title="src/ResourceGroup/Orders.php">Orders.php</abbr></a></abbr>
|
||
:
|
||
<span class="phpdocumentor-element-found-in__line">356</span>
|
||
|
||
</aside>
|
||
|
||
<p class="phpdocumentor-summary">Makes POST "/api/v5/orders/fix-external-ids" request.</p>
|
||
|
||
<code class="phpdocumentor-code phpdocumentor-signature ">
|
||
<span class="phpdocumentor-signature__visibility">public</span>
|
||
<span class="phpdocumentor-signature__name">fixExternalIds</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/RetailCrm-Api-Model-Request-Orders-OrdersFixExternalIdsRequest.html"><abbr title="\RetailCrm\Api\Model\Request\Orders\OrdersFixExternalIdsRequest">OrdersFixExternalIdsRequest</abbr></a> </span><span class="phpdocumentor-signature__argument__name">$request</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\Factory\SimpleClientFactory;
|
||
use RetailCrm\Api\Interfaces\ApiExceptionInterface;
|
||
use RetailCrm\Api\Model\Entity\FixExternalRow;
|
||
use RetailCrm\Api\Model\Request\Orders\OrdersFixExternalIdsRequest;
|
||
|
||
$client = SimpleClientFactory::createClient('https://test.retailcrm.pro', 'apiKey');
|
||
|
||
$request = new OrdersFixExternalIdsRequest();
|
||
$request->orders = [
|
||
new FixExternalRow(1, 'external_1'),
|
||
new FixExternalRow(2, 'external_2'),
|
||
];
|
||
|
||
try {
|
||
$response = $client->orders->fixExternalIds($request);
|
||
} catch (ApiExceptionInterface $exception) {
|
||
echo sprintf(
|
||
'Error from RetailCRM API (status code: %d): %s',
|
||
$exception->getStatusCode(),
|
||
$exception->getMessage()
|
||
);
|
||
|
||
if (count($exception->getErrorResponse()->errors) > 0) {
|
||
echo PHP_EOL . 'Errors: ' . implode(', ', $exception->getErrorResponse()->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-Orders-OrdersFixExternalIdsRequest.html"><abbr title="\RetailCrm\Api\Model\Request\Orders\OrdersFixExternalIdsRequest">OrdersFixExternalIdsRequest</abbr></a></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-Orders.html#method_fixExternalIds#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_get">
|
||
get()
|
||
<a href="classes/RetailCrm-Api-ResourceGroup-Orders.html#method_get" 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/Orders.php"><a href="files/src-resourcegroup-orders.html"><abbr title="src/ResourceGroup/Orders.php">Orders.php</abbr></a></abbr>
|
||
:
|
||
<span class="phpdocumentor-element-found-in__line">1033</span>
|
||
|
||
</aside>
|
||
|
||
<p class="phpdocumentor-summary">Makes GET "/api/v5/orders" request.</p>
|
||
|
||
<code class="phpdocumentor-code phpdocumentor-signature ">
|
||
<span class="phpdocumentor-signature__visibility">public</span>
|
||
<span class="phpdocumentor-signature__name">get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int|string </span><span class="phpdocumentor-signature__argument__name">$identifier</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type"><a href="classes/RetailCrm-Api-Model-Request-BySiteRequest.html"><abbr title="\RetailCrm\Api\Model\Request\BySiteRequest">BySiteRequest</abbr></a>|null </span><span class="phpdocumentor-signature__argument__name">$request</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/RetailCrm-Api-Model-Response-Orders-OrdersGetResponse.html"><abbr title="\RetailCrm\Api\Model\Response\Orders\OrdersGetResponse">OrdersGetResponse</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\Factory\SimpleClientFactory;
|
||
use RetailCrm\Api\Interfaces\ApiExceptionInterface;
|
||
use RetailCrm\Api\Model\Request\BySiteRequest;
|
||
|
||
$client = SimpleClientFactory::createClient('https://test.retailcrm.pro', 'apiKey');
|
||
|
||
try {
|
||
$response = $client->orders->get(
|
||
'8123522898559160',
|
||
new BySiteRequest(ByIdentifier::EXTERNAL_ID, 'aliexpress')
|
||
);
|
||
} catch (ApiExceptionInterface $exception) {
|
||
echo sprintf(
|
||
'Error from RetailCRM API (status code: %d): %s',
|
||
$exception->getStatusCode(),
|
||
$exception->getMessage()
|
||
);
|
||
|
||
if (count($exception->getErrorResponse()->errors) > 0) {
|
||
echo PHP_EOL . 'Errors: ' . implode(', ', $exception->getErrorResponse()->errors);
|
||
}
|
||
|
||
return;
|
||
}
|
||
|
||
echo 'Orders: ' . print_r($response->order, 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">$identifier</span>
|
||
: <span class="phpdocumentor-signature__argument__return-type">int|string</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-BySiteRequest.html"><abbr title="\RetailCrm\Api\Model\Request\BySiteRequest">BySiteRequest</abbr></a>|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-Orders.html#method_get#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-Orders-OrdersGetResponse.html"><abbr title="\RetailCrm\Api\Model\Response\Orders\OrdersGetResponse">OrdersGetResponse</abbr></a></span>
|
||
</section>
|
||
|
||
</article>
|
||
<article
|
||
class="phpdocumentor-element
|
||
-method
|
||
-public
|
||
"
|
||
>
|
||
<h4 class="phpdocumentor-element__name" id="method_history">
|
||
history()
|
||
<a href="classes/RetailCrm-Api-ResourceGroup-Orders.html#method_history" 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/Orders.php"><a href="files/src-resourcegroup-orders.html"><abbr title="src/ResourceGroup/Orders.php">Orders.php</abbr></a></abbr>
|
||
:
|
||
<span class="phpdocumentor-element-found-in__line">418</span>
|
||
|
||
</aside>
|
||
|
||
<p class="phpdocumentor-summary">Makes GET "/api/v5/orders/history" request.</p>
|
||
|
||
<code class="phpdocumentor-code phpdocumentor-signature ">
|
||
<span class="phpdocumentor-signature__visibility">public</span>
|
||
<span class="phpdocumentor-signature__name">history</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type"><a href="classes/RetailCrm-Api-Model-Request-Orders-OrdersHistoryRequest.html"><abbr title="\RetailCrm\Api\Model\Request\Orders\OrdersHistoryRequest">OrdersHistoryRequest</abbr></a>|null </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-Orders-OrdersHistoryResponse.html"><abbr title="\RetailCrm\Api\Model\Response\Orders\OrdersHistoryResponse">OrdersHistoryResponse</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\Factory\SimpleClientFactory;
|
||
use RetailCrm\Api\Interfaces\ApiExceptionInterface;
|
||
use RetailCrm\Api\Model\Filter\Orders\OrderHistoryFilterV4Type;
|
||
use RetailCrm\Api\Model\Request\Orders\OrdersHistoryRequest;
|
||
|
||
$client = SimpleClientFactory::createClient('https://test.retailcrm.pro', 'apiKey');
|
||
|
||
$request = new OrdersHistoryRequest();
|
||
$request->limit = 100;
|
||
$request->page = 1;
|
||
$request->filter = new OrderHistoryFilterV4Type();
|
||
$request->filter->sinceId = 2691;
|
||
|
||
try {
|
||
$response = $client->orders->history($request);
|
||
} catch (ApiExceptionInterface $exception) {
|
||
echo sprintf(
|
||
'Error from RetailCRM API (status code: %d): %s',
|
||
$exception->getStatusCode(),
|
||
$exception->getMessage()
|
||
);
|
||
|
||
if (count($exception->getErrorResponse()->errors) > 0) {
|
||
echo PHP_EOL . 'Errors: ' . implode(', ', $exception->getErrorResponse()->errors);
|
||
}
|
||
|
||
return;
|
||
}
|
||
|
||
echo 'Orders history: ' . print_r($response->history, 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">$request</span>
|
||
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/RetailCrm-Api-Model-Request-Orders-OrdersHistoryRequest.html"><abbr title="\RetailCrm\Api\Model\Request\Orders\OrdersHistoryRequest">OrdersHistoryRequest</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-Orders.html#method_history#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-Orders-OrdersHistoryResponse.html"><abbr title="\RetailCrm\Api\Model\Response\Orders\OrdersHistoryResponse">OrdersHistoryResponse</abbr></a></span>
|
||
</section>
|
||
|
||
</article>
|
||
<article
|
||
class="phpdocumentor-element
|
||
-method
|
||
-public
|
||
"
|
||
>
|
||
<h4 class="phpdocumentor-element__name" id="method_linksCreate">
|
||
linksCreate()
|
||
<a href="classes/RetailCrm-Api-ResourceGroup-Orders.html#method_linksCreate" 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/Orders.php"><a href="files/src-resourcegroup-orders.html"><abbr title="src/ResourceGroup/Orders.php">Orders.php</abbr></a></abbr>
|
||
:
|
||
<span class="phpdocumentor-element-found-in__line">482</span>
|
||
|
||
</aside>
|
||
|
||
<p class="phpdocumentor-summary">Makes POST "/api/v5/orders/links/create" request.</p>
|
||
|
||
<code class="phpdocumentor-code phpdocumentor-signature ">
|
||
<span class="phpdocumentor-signature__visibility">public</span>
|
||
<span class="phpdocumentor-signature__name">linksCreate</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/RetailCrm-Api-Model-Request-Orders-OrdersLinksCreateRequest.html"><abbr title="\RetailCrm\Api\Model\Request\Orders\OrdersLinksCreateRequest">OrdersLinksCreateRequest</abbr></a> </span><span class="phpdocumentor-signature__argument__name">$request</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\Factory\SimpleClientFactory;
|
||
use RetailCrm\Api\Interfaces\ApiExceptionInterface;
|
||
use RetailCrm\Api\Model\Entity\Delivery\SerializedEntityOrder;
|
||
use RetailCrm\Api\Model\Entity\Orders\SerializedOrderLink;
|
||
use RetailCrm\Api\Model\Request\Orders\OrdersLinksCreateRequest;
|
||
|
||
$client = SimpleClientFactory::createClient('https://test.retailcrm.pro', 'apiKey');
|
||
|
||
$request = new OrdersLinksCreateRequest();
|
||
$request->link = new SerializedOrderLink();
|
||
$request->site = 'aliexpress';
|
||
$request->link->orders = [
|
||
SerializedEntityOrder::withNumber('8123522898559160'),
|
||
SerializedEntityOrder::withNumber('8123898472679160')
|
||
];
|
||
$request->link->comment = 'same client';
|
||
|
||
try {
|
||
$response = $client->orders->linksCreate($request);
|
||
} catch (ApiExceptionInterface $exception) {
|
||
echo sprintf(
|
||
'Error from RetailCRM API (status code: %d): %s',
|
||
$exception->getStatusCode(),
|
||
$exception->getMessage()
|
||
);
|
||
|
||
if (count($exception->getErrorResponse()->errors) > 0) {
|
||
echo PHP_EOL . 'Errors: ' . implode(', ', $exception->getErrorResponse()->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-Orders-OrdersLinksCreateRequest.html"><abbr title="\RetailCrm\Api\Model\Request\Orders\OrdersLinksCreateRequest">OrdersLinksCreateRequest</abbr></a></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-Orders.html#method_linksCreate#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_list">
|
||
list()
|
||
<a href="classes/RetailCrm-Api-ResourceGroup-Orders.html#method_list" 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/Orders.php"><a href="files/src-resourcegroup-orders.html"><abbr title="src/ResourceGroup/Orders.php">Orders.php</abbr></a></abbr>
|
||
:
|
||
<span class="phpdocumentor-element-found-in__line">98</span>
|
||
|
||
</aside>
|
||
|
||
<p class="phpdocumentor-summary">Makes GET "/api/v5/orders" request.</p>
|
||
|
||
<code class="phpdocumentor-code phpdocumentor-signature ">
|
||
<span class="phpdocumentor-signature__visibility">public</span>
|
||
<span class="phpdocumentor-signature__name">list</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type"><a href="classes/RetailCrm-Api-Model-Request-Orders-OrdersRequest.html"><abbr title="\RetailCrm\Api\Model\Request\Orders\OrdersRequest">OrdersRequest</abbr></a>|null </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-Orders-OrdersResponse.html"><abbr title="\RetailCrm\Api\Model\Response\Orders\OrdersResponse">OrdersResponse</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\Factory\SimpleClientFactory;
|
||
use RetailCrm\Api\Interfaces\ApiExceptionInterface;
|
||
use RetailCrm\Api\Model\Filter\Orders\OrderFilter;
|
||
use RetailCrm\Api\Model\Request\Orders\OrdersRequest;
|
||
|
||
$client = SimpleClientFactory::createClient('https://test.retailcrm.pro', 'apiKey');
|
||
|
||
$request = new OrdersRequest();
|
||
$request->filter = new OrderFilter();
|
||
$request->filter->ids = [7141];
|
||
|
||
try {
|
||
$response = $client->orders->list($request);
|
||
} catch (ApiExceptionInterface $exception) {
|
||
echo sprintf(
|
||
'Error from RetailCRM API (status code: %d): %s',
|
||
$exception->getStatusCode(),
|
||
$exception->getMessage()
|
||
);
|
||
|
||
if (count($exception->getErrorResponse()->errors) > 0) {
|
||
echo PHP_EOL . 'Errors: ' . implode(', ', $exception->getErrorResponse()->errors);
|
||
}
|
||
|
||
return;
|
||
}
|
||
|
||
echo 'Got orders: ' . print_r($response->orders, 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">$request</span>
|
||
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/RetailCrm-Api-Model-Request-Orders-OrdersRequest.html"><abbr title="\RetailCrm\Api\Model\Request\Orders\OrdersRequest">OrdersRequest</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-Orders.html#method_list#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-Orders-OrdersResponse.html"><abbr title="\RetailCrm\Api\Model\Response\Orders\OrdersResponse">OrdersResponse</abbr></a></span>
|
||
</section>
|
||
|
||
</article>
|
||
<article
|
||
class="phpdocumentor-element
|
||
-method
|
||
-public
|
||
"
|
||
>
|
||
<h4 class="phpdocumentor-element__name" id="method_loyaltyApply">
|
||
loyaltyApply()
|
||
<a href="classes/RetailCrm-Api-ResourceGroup-Orders.html#method_loyaltyApply" 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/Orders.php"><a href="files/src-resourcegroup-orders.html"><abbr title="src/ResourceGroup/Orders.php">Orders.php</abbr></a></abbr>
|
||
:
|
||
<span class="phpdocumentor-element-found-in__line">543</span>
|
||
|
||
</aside>
|
||
|
||
<p class="phpdocumentor-summary">Makes POST "/api/v5/orders/loyalty/apply" request.</p>
|
||
|
||
<code class="phpdocumentor-code phpdocumentor-signature ">
|
||
<span class="phpdocumentor-signature__visibility">public</span>
|
||
<span class="phpdocumentor-signature__name">loyaltyApply</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/RetailCrm-Api-Model-Request-Orders-OrdersLoyaltyApplyRequest.html"><abbr title="\RetailCrm\Api\Model\Request\Orders\OrdersLoyaltyApplyRequest">OrdersLoyaltyApplyRequest</abbr></a> </span><span class="phpdocumentor-signature__argument__name">$request</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/RetailCrm-Api-Model-Response-Orders-OrdersLoyaltyApplyResponse.html"><abbr title="\RetailCrm\Api\Model\Response\Orders\OrdersLoyaltyApplyResponse">OrdersLoyaltyApplyResponse</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\Factory\SimpleClientFactory;
|
||
use RetailCrm\Api\Interfaces\ApiExceptionInterface;
|
||
use RetailCrm\Api\Model\Entity\Delivery\SerializedEntityOrder;
|
||
use RetailCrm\Api\Model\Request\Orders\OrdersLoyaltyApplyRequest;
|
||
|
||
$client = SimpleClientFactory::createClient('https://test.retailcrm.pro', 'apiKey');
|
||
|
||
$request = new OrdersLoyaltyApplyRequest();
|
||
$request->site = 'bitrix-test';
|
||
$request->order = SerializedEntityOrder::withNumber('7');
|
||
$request->bonuses = 10;
|
||
|
||
try {
|
||
$response = $client->orders->loyaltyApply($request);
|
||
} catch (ApiExceptionInterface $exception) {
|
||
echo sprintf(
|
||
'Error from RetailCRM API (status code: %d): %s',
|
||
$exception->getStatusCode(),
|
||
$exception->getMessage()
|
||
);
|
||
|
||
if (count($exception->getErrorResponse()->errors) > 0) {
|
||
echo PHP_EOL . 'Errors: ' . implode(', ', $exception->getErrorResponse()->errors);
|
||
}
|
||
|
||
return;
|
||
}
|
||
|
||
echo 'Applied loyalty to order: ' . print_r($response->order, 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">$request</span>
|
||
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/RetailCrm-Api-Model-Request-Orders-OrdersLoyaltyApplyRequest.html"><abbr title="\RetailCrm\Api\Model\Request\Orders\OrdersLoyaltyApplyRequest">OrdersLoyaltyApplyRequest</abbr></a></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-Orders.html#method_loyaltyApply#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-Orders-OrdersLoyaltyApplyResponse.html"><abbr title="\RetailCrm\Api\Model\Response\Orders\OrdersLoyaltyApplyResponse">OrdersLoyaltyApplyResponse</abbr></a></span>
|
||
</section>
|
||
|
||
</article>
|
||
<article
|
||
class="phpdocumentor-element
|
||
-method
|
||
-public
|
||
"
|
||
>
|
||
<h4 class="phpdocumentor-element__name" id="method_paymentsCreate">
|
||
paymentsCreate()
|
||
<a href="classes/RetailCrm-Api-ResourceGroup-Orders.html#method_paymentsCreate" 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/Orders.php"><a href="files/src-resourcegroup-orders.html"><abbr title="src/ResourceGroup/Orders.php">Orders.php</abbr></a></abbr>
|
||
:
|
||
<span class="phpdocumentor-element-found-in__line">668</span>
|
||
|
||
</aside>
|
||
|
||
<p class="phpdocumentor-summary">Makes POST "/api/v5/orders/payments/create" request.</p>
|
||
|
||
<code class="phpdocumentor-code phpdocumentor-signature ">
|
||
<span class="phpdocumentor-signature__visibility">public</span>
|
||
<span class="phpdocumentor-signature__name">paymentsCreate</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/RetailCrm-Api-Model-Request-Orders-OrdersPaymentsCreateRequest.html"><abbr title="\RetailCrm\Api\Model\Request\Orders\OrdersPaymentsCreateRequest">OrdersPaymentsCreateRequest</abbr></a> </span><span class="phpdocumentor-signature__argument__name">$request</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/RetailCrm-Api-Model-Response-IdResponse.html"><abbr title="\RetailCrm\Api\Model\Response\IdResponse">IdResponse</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\Factory\SimpleClientFactory;
|
||
use RetailCrm\Api\Interfaces\ApiExceptionInterface;
|
||
use RetailCrm\Api\Model\Entity\Delivery\SerializedEntityOrder;
|
||
use RetailCrm\Api\Model\Entity\Orders\SerializedPayment;
|
||
use RetailCrm\Api\Model\Request\Orders\OrdersPaymentsCreateRequest;
|
||
|
||
$client = SimpleClientFactory::createClient('https://test.retailcrm.pro', 'apiKey');
|
||
|
||
$request = new OrdersPaymentsCreateRequest();
|
||
$request->payment = new SerializedPayment();
|
||
$request->payment->type = 'bank-card';
|
||
$request->payment->amount = 10000;
|
||
$request->payment->comment = 'Comment';
|
||
$request->payment->order = SerializedEntityOrder::withNumber('8123522898559160');
|
||
$request->site = 'aliexpress';
|
||
|
||
try {
|
||
$response = $client->orders->paymentsCreate($request);
|
||
} catch (ApiExceptionInterface $exception) {
|
||
echo sprintf(
|
||
'Error from RetailCRM API (status code: %d): %s',
|
||
$exception->getStatusCode(),
|
||
$exception->getMessage()
|
||
);
|
||
|
||
if (count($exception->getErrorResponse()->errors) > 0) {
|
||
echo PHP_EOL . 'Errors: ' . implode(', ', $exception->getErrorResponse()->errors);
|
||
}
|
||
|
||
return;
|
||
}
|
||
|
||
echo 'Created payment ID: ' . $response->id;
|
||
</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-Orders-OrdersPaymentsCreateRequest.html"><abbr title="\RetailCrm\Api\Model\Request\Orders\OrdersPaymentsCreateRequest">OrdersPaymentsCreateRequest</abbr></a></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-Orders.html#method_paymentsCreate#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-IdResponse.html"><abbr title="\RetailCrm\Api\Model\Response\IdResponse">IdResponse</abbr></a></span>
|
||
</section>
|
||
|
||
</article>
|
||
<article
|
||
class="phpdocumentor-element
|
||
-method
|
||
-public
|
||
"
|
||
>
|
||
<h4 class="phpdocumentor-element__name" id="method_paymentsDelete">
|
||
paymentsDelete()
|
||
<a href="classes/RetailCrm-Api-ResourceGroup-Orders.html#method_paymentsDelete" 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/Orders.php"><a href="files/src-resourcegroup-orders.html"><abbr title="src/ResourceGroup/Orders.php">Orders.php</abbr></a></abbr>
|
||
:
|
||
<span class="phpdocumentor-element-found-in__line">718</span>
|
||
|
||
</aside>
|
||
|
||
<p class="phpdocumentor-summary">Makes POST "/api/v5/orders/payments/{id}/delete" request.</p>
|
||
|
||
<code class="phpdocumentor-code phpdocumentor-signature ">
|
||
<span class="phpdocumentor-signature__visibility">public</span>
|
||
<span class="phpdocumentor-signature__name">paymentsDelete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$id</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\Factory\SimpleClientFactory;
|
||
use RetailCrm\Api\Interfaces\ApiExceptionInterface;
|
||
|
||
$client = SimpleClientFactory::createClient('https://test.retailcrm.pro', 'apiKey');
|
||
|
||
try {
|
||
$response = $client->orders->paymentsDelete(4562);
|
||
} catch (ApiExceptionInterface $exception) {
|
||
echo sprintf(
|
||
'Error from RetailCRM API (status code: %d): %s',
|
||
$exception->getStatusCode(),
|
||
$exception->getMessage()
|
||
);
|
||
|
||
if (count($exception->getErrorResponse()->errors) > 0) {
|
||
echo PHP_EOL . 'Errors: ' . implode(', ', $exception->getErrorResponse()->errors);
|
||
}
|
||
}
|
||
</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">$id</span>
|
||
: <span class="phpdocumentor-signature__argument__return-type">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-Orders.html#method_paymentsDelete#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_paymentsEdit">
|
||
paymentsEdit()
|
||
<a href="classes/RetailCrm-Api-ResourceGroup-Orders.html#method_paymentsEdit" 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/Orders.php"><a href="files/src-resourcegroup-orders.html"><abbr title="src/ResourceGroup/Orders.php">Orders.php</abbr></a></abbr>
|
||
:
|
||
<span class="phpdocumentor-element-found-in__line">783</span>
|
||
|
||
</aside>
|
||
|
||
<p class="phpdocumentor-summary">Makes POST "/api/v5/orders/payments/{id}/edit" request.</p>
|
||
|
||
<code class="phpdocumentor-code phpdocumentor-signature ">
|
||
<span class="phpdocumentor-signature__visibility">public</span>
|
||
<span class="phpdocumentor-signature__name">paymentsEdit</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int|string </span><span class="phpdocumentor-signature__argument__name">$identifier</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type"><a href="classes/RetailCrm-Api-Model-Request-Orders-OrdersPaymentsCreateRequest.html"><abbr title="\RetailCrm\Api\Model\Request\Orders\OrdersPaymentsCreateRequest">OrdersPaymentsCreateRequest</abbr></a> </span><span class="phpdocumentor-signature__argument__name">$request</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/RetailCrm-Api-Model-Response-IdResponse.html"><abbr title="\RetailCrm\Api\Model\Response\IdResponse">IdResponse</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\Factory\SimpleClientFactory;
|
||
use RetailCrm\Api\Interfaces\ApiExceptionInterface;
|
||
use RetailCrm\Api\Model\Entity\Orders\SerializedPayment;
|
||
use RetailCrm\Api\Model\Request\Orders\OrdersPaymentsEditRequest;
|
||
|
||
$client = SimpleClientFactory::createClient('https://test.retailcrm.pro', 'apiKey');
|
||
|
||
$request = new OrdersPaymentsEditRequest();
|
||
$request->by = ByIdentifier::ID;
|
||
$request->payment = new SerializedPayment();
|
||
$request->payment->comment = 'Comment';
|
||
$request->site = 'aliexpress';
|
||
|
||
try {
|
||
$response = $client->orders->paymentsEdit(4562, $request);
|
||
} catch (ApiExceptionInterface $exception) {
|
||
echo sprintf(
|
||
'Error from RetailCRM API (status code: %d): %s',
|
||
$exception->getStatusCode(),
|
||
$exception->getMessage()
|
||
);
|
||
|
||
if (count($exception->getErrorResponse()->errors) > 0) {
|
||
echo PHP_EOL . 'Errors: ' . implode(', ', $exception->getErrorResponse()->errors);
|
||
}
|
||
|
||
return;
|
||
}
|
||
|
||
echo 'Edited payment ID: ' . $response->id;
|
||
</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">$identifier</span>
|
||
: <span class="phpdocumentor-signature__argument__return-type">int|string</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-Orders-OrdersPaymentsCreateRequest.html"><abbr title="\RetailCrm\Api\Model\Request\Orders\OrdersPaymentsCreateRequest">OrdersPaymentsCreateRequest</abbr></a></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-Orders.html#method_paymentsEdit#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-IdResponse.html"><abbr title="\RetailCrm\Api\Model\Response\IdResponse">IdResponse</abbr></a></span>
|
||
</section>
|
||
|
||
</article>
|
||
<article
|
||
class="phpdocumentor-element
|
||
-method
|
||
-public
|
||
"
|
||
>
|
||
<h4 class="phpdocumentor-element__name" id="method_platesPrint">
|
||
platesPrint()
|
||
<a href="classes/RetailCrm-Api-ResourceGroup-Orders.html#method_platesPrint" 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/Orders.php"><a href="files/src-resourcegroup-orders.html"><abbr title="src/ResourceGroup/Orders.php">Orders.php</abbr></a></abbr>
|
||
:
|
||
<span class="phpdocumentor-element-found-in__line">1212</span>
|
||
|
||
</aside>
|
||
|
||
<p class="phpdocumentor-summary">Makes GET "/api/v5/orders/{externalId}/plates/{plateId}/print" request.</p>
|
||
|
||
<code class="phpdocumentor-code phpdocumentor-signature ">
|
||
<span class="phpdocumentor-signature__visibility">public</span>
|
||
<span class="phpdocumentor-signature__name">platesPrint</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string|int </span><span class="phpdocumentor-signature__argument__name">$identifier</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$plateId</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type"><a href="classes/RetailCrm-Api-Model-Request-BySiteRequest.html"><abbr title="\RetailCrm\Api\Model\Request\BySiteRequest">BySiteRequest</abbr></a> </span><span class="phpdocumentor-signature__argument__name">$request</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/RetailCrm-Api-Model-Response-Files-FilesDownloadResponse.html"><abbr title="\RetailCrm\Api\Model\Response\Files\FilesDownloadResponse">FilesDownloadResponse</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\Factory\SimpleClientFactory;
|
||
use RetailCrm\Api\Interfaces\ApiExceptionInterface;
|
||
use RetailCrm\Api\Model\Request\BySiteRequest;
|
||
|
||
$client = SimpleClientFactory::createClient('https://test.retailcrm.pro', 'apiKey');
|
||
|
||
try {
|
||
$request = new BySiteRequest();
|
||
$request = new BySiteRequest('id', 'gray_sale_ym');
|
||
|
||
$response = $client->orders->platesPrint(100, 18, $request);
|
||
} catch (ApiExceptionInterface $exception) {
|
||
echo sprintf(
|
||
'Error from RetailCRM API (status code: %d): %s',
|
||
$exception->getStatusCode(),
|
||
$exception->getMessage()
|
||
);
|
||
|
||
if (count($exception->getErrorResponse()->errors) > 0) {
|
||
echo PHP_EOL . 'Errors: ' . implode(', ', $exception->getErrorResponse()->errors);
|
||
}
|
||
|
||
return;
|
||
}
|
||
|
||
printf('Saving downloaded file to "%s."', $response->fileName);
|
||
file_put_contents($response->fileName, $response->data->getContents());
|
||
</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">$identifier</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">$plateId</span>
|
||
: <span class="phpdocumentor-signature__argument__return-type">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-BySiteRequest.html"><abbr title="\RetailCrm\Api\Model\Request\BySiteRequest">BySiteRequest</abbr></a></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-Orders.html#method_platesPrint#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-Exception-ApiException.html"><abbr title="\RetailCrm\Api\Exception\ApiException">ApiException</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-ClientException.html"><abbr title="\RetailCrm\Api\Exception\ClientException">ClientException</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-Interfaces-ApiExceptionInterface.html"><abbr title="\RetailCrm\Api\Interfaces\ApiExceptionInterface">ApiExceptionInterface</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-Files-FilesDownloadResponse.html"><abbr title="\RetailCrm\Api\Model\Response\Files\FilesDownloadResponse">FilesDownloadResponse</abbr></a></span>
|
||
</section>
|
||
|
||
</article>
|
||
<article
|
||
class="phpdocumentor-element
|
||
-method
|
||
-public
|
||
"
|
||
>
|
||
<h4 class="phpdocumentor-element__name" id="method_statuses">
|
||
statuses()
|
||
<a href="classes/RetailCrm-Api-ResourceGroup-Orders.html#method_statuses" 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/Orders.php"><a href="files/src-resourcegroup-orders.html"><abbr title="src/ResourceGroup/Orders.php">Orders.php</abbr></a></abbr>
|
||
:
|
||
<span class="phpdocumentor-element-found-in__line">841</span>
|
||
|
||
</aside>
|
||
|
||
<p class="phpdocumentor-summary">Makes GET "/api/v5/orders/statuses" request.</p>
|
||
|
||
<code class="phpdocumentor-code phpdocumentor-signature ">
|
||
<span class="phpdocumentor-signature__visibility">public</span>
|
||
<span class="phpdocumentor-signature__name">statuses</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/RetailCrm-Api-Model-Request-Orders-OrdersStatusesRequest.html"><abbr title="\RetailCrm\Api\Model\Request\Orders\OrdersStatusesRequest">OrdersStatusesRequest</abbr></a> </span><span class="phpdocumentor-signature__argument__name">$request</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/RetailCrm-Api-Model-Response-Orders-OrdersStatusesResponse.html"><abbr title="\RetailCrm\Api\Model\Response\Orders\OrdersStatusesResponse">OrdersStatusesResponse</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\Factory\SimpleClientFactory;
|
||
use RetailCrm\Api\Interfaces\ApiExceptionInterface;
|
||
use RetailCrm\Api\Model\Request\Orders\OrdersStatusesRequest;
|
||
|
||
$client = SimpleClientFactory::createClient('https://test.retailcrm.pro', 'apiKey');
|
||
|
||
$request = new OrdersStatusesRequest();
|
||
$request->externalIds = ['8123522898559160'];
|
||
|
||
try {
|
||
$response = $client->orders->statuses($request);
|
||
} catch (ApiExceptionInterface $exception) {
|
||
echo sprintf(
|
||
'Error from RetailCRM API (status code: %d): %s',
|
||
$exception->getStatusCode(),
|
||
$exception->getMessage()
|
||
);
|
||
|
||
if (count($exception->getErrorResponse()->errors) > 0) {
|
||
echo PHP_EOL . 'Errors: ' . implode(', ', $exception->getErrorResponse()->errors);
|
||
}
|
||
|
||
return;
|
||
}
|
||
|
||
echo 'Statuses: ' . print_r($response->orders, 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">$request</span>
|
||
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/RetailCrm-Api-Model-Request-Orders-OrdersStatusesRequest.html"><abbr title="\RetailCrm\Api\Model\Request\Orders\OrdersStatusesRequest">OrdersStatusesRequest</abbr></a></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-Orders.html#method_statuses#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-Orders-OrdersStatusesResponse.html"><abbr title="\RetailCrm\Api\Model\Response\Orders\OrdersStatusesResponse">OrdersStatusesResponse</abbr></a></span>
|
||
</section>
|
||
|
||
</article>
|
||
<article
|
||
class="phpdocumentor-element
|
||
-method
|
||
-public
|
||
"
|
||
>
|
||
<h4 class="phpdocumentor-element__name" id="method_upload">
|
||
upload()
|
||
<a href="classes/RetailCrm-Api-ResourceGroup-Orders.html#method_upload" 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/Orders.php"><a href="files/src-resourcegroup-orders.html"><abbr title="src/ResourceGroup/Orders.php">Orders.php</abbr></a></abbr>
|
||
:
|
||
<span class="phpdocumentor-element-found-in__line">973</span>
|
||
|
||
</aside>
|
||
|
||
<p class="phpdocumentor-summary">Makes POST "/api/v5/orders/upload" request.</p>
|
||
|
||
<code class="phpdocumentor-code phpdocumentor-signature ">
|
||
<span class="phpdocumentor-signature__visibility">public</span>
|
||
<span class="phpdocumentor-signature__name">upload</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/RetailCrm-Api-Model-Request-Orders-OrdersUploadRequest.html"><abbr title="\RetailCrm\Api\Model\Request\Orders\OrdersUploadRequest">OrdersUploadRequest</abbr></a> </span><span class="phpdocumentor-signature__argument__name">$request</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/RetailCrm-Api-Model-Response-Orders-OrdersUploadResponse.html"><abbr title="\RetailCrm\Api\Model\Response\Orders\OrdersUploadResponse">OrdersUploadResponse</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\CountryCodeIso3166;
|
||
use RetailCrm\Api\Enum\Customers\CustomerType;
|
||
use RetailCrm\Api\Factory\SimpleClientFactory;
|
||
use RetailCrm\Api\Interfaces\ApiExceptionInterface;
|
||
use RetailCrm\Api\Model\Entity\Orders\Delivery\OrderDeliveryAddress;
|
||
use RetailCrm\Api\Model\Entity\Orders\Delivery\SerializedOrderDelivery;
|
||
use RetailCrm\Api\Model\Entity\Orders\Items\Offer;
|
||
use RetailCrm\Api\Model\Entity\Orders\Items\OrderProduct;
|
||
use RetailCrm\Api\Model\Entity\Orders\Items\PriceType;
|
||
use RetailCrm\Api\Model\Entity\Orders\Items\Unit;
|
||
use RetailCrm\Api\Model\Entity\Orders\Order;
|
||
use RetailCrm\Api\Model\Entity\Orders\Payment;
|
||
use RetailCrm\Api\Model\Entity\Orders\SerializedRelationCustomer;
|
||
use RetailCrm\Api\Model\Request\Orders\OrdersUploadRequest;
|
||
|
||
$client = SimpleClientFactory::createClient('https://test.retailcrm.pro', 'apiKey');
|
||
|
||
$request = new OrdersUploadRequest();
|
||
$order = new Order();
|
||
$payment = new Payment();
|
||
$delivery = new SerializedOrderDelivery();
|
||
$deliveryAddress = new OrderDeliveryAddress();
|
||
$offer = new Offer();
|
||
$item = new OrderProduct();
|
||
|
||
$payment->type = 'bank-card';
|
||
$payment->status = 'paid';
|
||
$payment->amount = 1000;
|
||
$payment->paidAt = new DateTime();
|
||
|
||
$deliveryAddress->index = '344001';
|
||
$deliveryAddress->countryIso = CountryCodeIso3166::RUSSIAN_FEDERATION;
|
||
$deliveryAddress->region = 'Ростовская область';
|
||
$deliveryAddress->city = 'г. Ростов-на-Дону';
|
||
$deliveryAddress->street = 'ул. Пушкинская';
|
||
$deliveryAddress->building = '10';
|
||
|
||
$delivery->address = $deliveryAddress;
|
||
$delivery->cost = 0;
|
||
$delivery->netCost = 0;
|
||
|
||
$offer->name = 'Сборка №1445123';
|
||
$offer->displayName = 'Сборка №1445123';
|
||
$offer->xmlId = 'tGunLo27jlPGmbA8BrHxY2';
|
||
$offer->article = '14451445-14451445';
|
||
$offer->unit = new Unit('796', 'Штука', 'шт');
|
||
|
||
$item->offer = $offer;
|
||
$item->priceType = new PriceType('base');
|
||
$item->quantity = 1;
|
||
$item->purchasePrice = 60;
|
||
|
||
$order->delivery = $delivery;
|
||
$order->items = [$item];
|
||
$order->payments = [$payment];
|
||
$order->orderType = 'test';
|
||
$order->orderMethod = 'phone';
|
||
$order->countryIso = CountryCodeIso3166::RUSSIAN_FEDERATION;
|
||
$order->firstName = 'Test';
|
||
$order->lastName = 'User';
|
||
$order->patronymic = 'Patronymic';
|
||
$order->phone = '89003005069';
|
||
$order->email = 'testuser12345678901@example.com';
|
||
$order->managerId = 28;
|
||
$order->customer = SerializedRelationCustomer::withIdAndType(
|
||
4924,
|
||
CustomerType::CUSTOMER
|
||
);
|
||
$order->status = 'assembling';
|
||
$order->statusComment = 'Assembling order';
|
||
$order->weight = 1000;
|
||
$order->shipmentStore = 'main12';
|
||
$order->shipmentDate = (new DateTime())->add(new DateInterval('P7D'));
|
||
$order->shipped = false;
|
||
$order->customFields = [
|
||
"galka" => false,
|
||
"test_number" => 0,
|
||
"otpravit_dozakaz" => false,
|
||
];
|
||
|
||
$request->site = 'moysklad';
|
||
$request->orders = [$order];
|
||
|
||
try {
|
||
$response = $client->orders->upload($request);
|
||
} catch (ApiExceptionInterface $exception) {
|
||
echo sprintf(
|
||
'Error from RetailCRM API (status code: %d): %s',
|
||
$exception->getStatusCode(),
|
||
$exception->getMessage()
|
||
);
|
||
|
||
if (count($exception->getErrorResponse()->errors) > 0) {
|
||
echo PHP_EOL . 'Errors: ' . implode(', ', $exception->getErrorResponse()->errors);
|
||
}
|
||
|
||
return;
|
||
}
|
||
|
||
echo 'Uploaded: ' . print_r($response->uploadedOrders, 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">$request</span>
|
||
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/RetailCrm-Api-Model-Request-Orders-OrdersUploadRequest.html"><abbr title="\RetailCrm\Api\Model\Request\Orders\OrdersUploadRequest">OrdersUploadRequest</abbr></a></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-Orders.html#method_upload#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-Orders-OrdersUploadResponse.html"><abbr title="\RetailCrm\Api\Model\Response\Orders\OrdersUploadResponse">OrdersUploadResponse</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/Orders.php.txt" class="language-php line-numbers linkable-line-numbers"></pre>
|
||
</div>
|
||
<button data-exit-button class="phpdocumentor-modal__close">×</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-Orders.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-Orders.html#method_cancelBonusOperations">cancelBonusOperations()</a></li>
|
||
<li><a href="classes/RetailCrm-Api-ResourceGroup-Orders.html#method_combine">combine()</a></li>
|
||
<li><a href="classes/RetailCrm-Api-ResourceGroup-Orders.html#method_create">create()</a></li>
|
||
<li><a href="classes/RetailCrm-Api-ResourceGroup-Orders.html#method_deliveryCancel">deliveryCancel()</a></li>
|
||
<li><a href="classes/RetailCrm-Api-ResourceGroup-Orders.html#method_edit">edit()</a></li>
|
||
<li><a href="classes/RetailCrm-Api-ResourceGroup-Orders.html#method_fixExternalIds">fixExternalIds()</a></li>
|
||
<li><a href="classes/RetailCrm-Api-ResourceGroup-Orders.html#method_get">get()</a></li>
|
||
<li><a href="classes/RetailCrm-Api-ResourceGroup-Orders.html#method_history">history()</a></li>
|
||
<li><a href="classes/RetailCrm-Api-ResourceGroup-Orders.html#method_linksCreate">linksCreate()</a></li>
|
||
<li><a href="classes/RetailCrm-Api-ResourceGroup-Orders.html#method_list">list()</a></li>
|
||
<li><a href="classes/RetailCrm-Api-ResourceGroup-Orders.html#method_loyaltyApply">loyaltyApply()</a></li>
|
||
<li><a href="classes/RetailCrm-Api-ResourceGroup-Orders.html#method_paymentsCreate">paymentsCreate()</a></li>
|
||
<li><a href="classes/RetailCrm-Api-ResourceGroup-Orders.html#method_paymentsDelete">paymentsDelete()</a></li>
|
||
<li><a href="classes/RetailCrm-Api-ResourceGroup-Orders.html#method_paymentsEdit">paymentsEdit()</a></li>
|
||
<li><a href="classes/RetailCrm-Api-ResourceGroup-Orders.html#method_platesPrint">platesPrint()</a></li>
|
||
<li><a href="classes/RetailCrm-Api-ResourceGroup-Orders.html#method_statuses">statuses()</a></li>
|
||
<li><a href="classes/RetailCrm-Api-ResourceGroup-Orders.html#method_upload">upload()</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-Orders.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>
|