728 lines
28 KiB
PHP
728 lines
28 KiB
PHP
<!doctype html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta content="IE=edge,chrome=1" http-equiv="X-UA-Compatible">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1">
|
|
<title>e2e.megrendeles.hu API</title>
|
|
|
|
<link href="https://fonts.googleapis.com/css?family=PT+Sans&display=swap" rel="stylesheet">
|
|
|
|
<link rel="stylesheet" href="{{ asset("/vendor/scribe/css/theme-default.style.css") }}" media="screen">
|
|
<link rel="stylesheet" href="{{ asset("/vendor/scribe/css/theme-default.print.css") }}" media="print">
|
|
|
|
<script src="https://cdn.jsdelivr.net/npm/lodash@4.17.10/lodash.min.js"></script>
|
|
|
|
<link rel="stylesheet"
|
|
href="https://unpkg.com/@highlightjs/cdn-assets@10.7.2/styles/obsidian.min.css">
|
|
<script src="https://unpkg.com/@highlightjs/cdn-assets@10.7.2/highlight.min.js"></script>
|
|
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/jets/0.14.1/jets.min.js"></script>
|
|
|
|
<style id="language-style">
|
|
/* starts out as display none and is replaced with js later */
|
|
body .content .bash-example code { display: none; }
|
|
body .content .javascript-example code { display: none; }
|
|
body .content .php-example code { display: none; }
|
|
</style>
|
|
|
|
<script>
|
|
var baseUrl = "http://localhost:9000";
|
|
var useCsrf = Boolean(1);
|
|
var csrfUrl = "/sanctum/csrf-cookie";
|
|
</script>
|
|
<script src="{{ asset("/vendor/scribe/js/tryitout-3.37.2.js") }}"></script>
|
|
|
|
<script src="{{ asset("/vendor/scribe/js/theme-default-3.37.2.js") }}"></script>
|
|
|
|
</head>
|
|
|
|
<body data-languages="["bash","javascript","php"]">
|
|
|
|
<a href="#" id="nav-button">
|
|
<span>
|
|
MENU
|
|
<img src="{{ asset("/vendor/scribe/images/navbar.png") }}" alt="navbar-image" />
|
|
</span>
|
|
</a>
|
|
<div class="tocify-wrapper">
|
|
<img src="../images/pictures/Eurestlogo1.png" alt="logo" class="logo" style="padding-top: 10px;" width="100%"/>
|
|
|
|
<div class="lang-selector">
|
|
<button type="button" class="lang-button" data-language-name="bash">bash</button>
|
|
<button type="button" class="lang-button" data-language-name="javascript">javascript</button>
|
|
<button type="button" class="lang-button" data-language-name="php">php</button>
|
|
</div>
|
|
|
|
<div class="search">
|
|
<input type="text" class="search" id="input-search" placeholder="Search">
|
|
</div>
|
|
|
|
<div id="toc">
|
|
<ul id="tocify-header-0" class="tocify-header">
|
|
<li class="tocify-item level-1" data-unique="introduction">
|
|
<a href="#introduction">Introduction</a>
|
|
</li>
|
|
|
|
</ul>
|
|
<ul id="tocify-header-1" class="tocify-header">
|
|
<li class="tocify-item level-1" data-unique="authenticating-requests">
|
|
<a href="#authenticating-requests">Authenticating requests</a>
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
<ul id="tocify-header-2" class="tocify-header">
|
|
<li class="tocify-item level-1" data-unique="general-interfaces">
|
|
<a href="#general-interfaces">General Interfaces</a>
|
|
</li>
|
|
<ul id="tocify-subheader-general-interfaces" class="tocify-subheader">
|
|
<li class="tocify-item level-2" data-unique="general-interfaces-GETapi-v1-status">
|
|
<a href="#general-interfaces-GETapi-v1-status">Display a server Status.</a>
|
|
</li>
|
|
</ul>
|
|
</ul>
|
|
<ul id="tocify-header-3" class="tocify-header">
|
|
<li class="tocify-item level-1" data-unique="order-management">
|
|
<a href="#order-management">Order management</a>
|
|
</li>
|
|
<ul id="tocify-subheader-order-management" class="tocify-subheader">
|
|
<li class="tocify-item level-2" data-unique="order-management-GETapi-v1-order-unprocessed">
|
|
<a href="#order-management-GETapi-v1-order-unprocessed">Display a listing of the unprocessed orders.</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="order-management-PUTapi-v1-order-setProcessed">
|
|
<a href="#order-management-PUTapi-v1-order-setProcessed">Set processed orders.</a>
|
|
</li>
|
|
</ul>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
|
|
<ul class="toc-footer" id="toc-footer">
|
|
<li><a href="{{ route("scribe.postman") }}">View Postman collection</a></li>
|
|
<li><a href="{{ route("scribe.openapi") }}">View OpenAPI spec</a></li>
|
|
<li><a href="http://github.com/knuckleswtf/scribe">Documentation powered by Scribe ✍</a></li>
|
|
</ul>
|
|
<ul class="toc-footer" id="last-updated">
|
|
<li>Last updated: February 19 2023</li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="page-wrapper">
|
|
<div class="dark-box"></div>
|
|
<div class="content">
|
|
<h1 id="introduction">Introduction</h1>
|
|
<p>E-megrendelés elkészült megrendeléséhez API hozzáférés JSON adatformátummal. </p>
|
|
<p>Ennek a dokumentációnak az a célja, hogy minden olyan információt megadjon, amelyre szüksége van az API-nkkal való együttműködéshez.</p>
|
|
<blockquote>
|
|
<p>Base URL</p>
|
|
</blockquote>
|
|
<pre><code class="language-yaml">http://localhost</code></pre>
|
|
|
|
<h1 id="authenticating-requests">Authenticating requests</h1>
|
|
<p>To authenticate requests, include an <strong><code>Authorization</code></strong> header with the value <strong><code>"Bearer {YOUR_AUTH_KEY}"</code></strong>.</p>
|
|
<p>All authenticated endpoints are marked with a <code>requires authentication</code> badge in the documentation below.</p>
|
|
<p>You can retrieve your token by service provider.</p>
|
|
|
|
<h1 id="general-interfaces">General Interfaces</h1>
|
|
|
|
|
|
|
|
<h2 id="general-interfaces-GETapi-v1-status">Display a server Status.</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-GETapi-v1-status">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request GET \
|
|
--get "http://localhost/api/v1/status" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost/api/v1/status"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
fetch(url, {
|
|
method: "GET",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
|
|
<div class="php-example">
|
|
<pre><code class="language-php">$client = new \GuzzleHttp\Client();
|
|
$response = $client->get(
|
|
'http://localhost/api/v1/status',
|
|
[
|
|
'headers' => [
|
|
'Content-Type' => 'application/json',
|
|
'Accept' => 'application/json',
|
|
],
|
|
]
|
|
);
|
|
$body = $response->getBody();
|
|
print_r(json_decode((string) $body));</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-GETapi-v1-status">
|
|
<blockquote>
|
|
<p>Example response (200, Server status):</p>
|
|
</blockquote>
|
|
<pre>
|
|
|
|
<code class="language-json">{
|
|
"status": 200,
|
|
"success": true,
|
|
"apiVersion": "1",
|
|
"processedTime": "2020.01.01. 12:00:12.401670",
|
|
"data": {
|
|
"APIStatus": "up"
|
|
}
|
|
}</code>
|
|
</pre>
|
|
</span>
|
|
<span id="execution-results-GETapi-v1-status" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-GETapi-v1-status"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-GETapi-v1-status"></code></pre>
|
|
</span>
|
|
<span id="execution-error-GETapi-v1-status" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-GETapi-v1-status"></code></pre>
|
|
</span>
|
|
<form id="form-GETapi-v1-status" data-method="GET"
|
|
data-path="api/v1/status"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
data-headers='{"Content-Type":"application\/json","Accept":"application\/json"}'
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('GETapi-v1-status', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-GETapi-v1-status"
|
|
onclick="tryItOut('GETapi-v1-status');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-GETapi-v1-status"
|
|
onclick="cancelTryOut('GETapi-v1-status');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-GETapi-v1-status" hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-green">GET</small>
|
|
<b><code>api/v1/status</code></b>
|
|
</p>
|
|
</form>
|
|
|
|
<h3>Response</h3>
|
|
<h4 class="fancy-heading-panel"><b>Response Fields</b></h4>
|
|
<p>
|
|
<b><code>status</code></b> <small>integer</small>
|
|
<br>
|
|
<p>request HTTP status</p>
|
|
</p>
|
|
<p>
|
|
<b><code>success</code></b> <small>boolean</small>
|
|
<br>
|
|
<p>process successes</p>
|
|
</p>
|
|
<p>
|
|
<b><code>apiVersion</code></b> <small>integer</small>
|
|
<br>
|
|
<p>current API version</p>
|
|
</p>
|
|
<p>
|
|
<b><code>processedTime</code></b> <small>string</small>
|
|
<br>
|
|
<p>DateTime process Timestamp</p>
|
|
</p>
|
|
<p>
|
|
<b><code>data.APIStatus</code></b> <small>string</small>
|
|
<br>
|
|
<p>API status state (up and down).</p>
|
|
</p>
|
|
<h1 id="order-management">Order management</h1>
|
|
|
|
|
|
|
|
<h2 id="order-management-GETapi-v1-order-unprocessed">Display a listing of the unprocessed orders.</h2>
|
|
|
|
<p>
|
|
<small class="badge badge-darkred">requires authentication</small>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-GETapi-v1-order-unprocessed">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request GET \
|
|
--get "http://localhost/api/v1/order/unprocessed" \
|
|
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost/api/v1/order/unprocessed"
|
|
);
|
|
|
|
const headers = {
|
|
"Authorization": "Bearer {YOUR_AUTH_KEY}",
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
fetch(url, {
|
|
method: "GET",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
|
|
<div class="php-example">
|
|
<pre><code class="language-php">$client = new \GuzzleHttp\Client();
|
|
$response = $client->get(
|
|
'http://localhost/api/v1/order/unprocessed',
|
|
[
|
|
'headers' => [
|
|
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
|
|
'Content-Type' => 'application/json',
|
|
'Accept' => 'application/json',
|
|
],
|
|
]
|
|
);
|
|
$body = $response->getBody();
|
|
print_r(json_decode((string) $body));</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-GETapi-v1-order-unprocessed">
|
|
<blockquote>
|
|
<p>Example response (200, Has unprocessed orders):</p>
|
|
</blockquote>
|
|
<pre>
|
|
|
|
<code class="language-json">{
|
|
"status": 200,
|
|
"success": true,
|
|
"apiVersion": "1",
|
|
"processedTime": "2020.01.01. 12:00:12.401670",
|
|
"data": [
|
|
{
|
|
"id": 1001,
|
|
"supplier_id": 11,
|
|
"profit_center_id": 99,
|
|
"humanId": "ROZMAR/BAL/22/1103",
|
|
"deliveryDate": "2020-01-30",
|
|
"confirmed": "2022-01-15 09:19:09",
|
|
"APICallBackId": "987f3001-6364-4d7c-8b0c-daf29dbd38ec",
|
|
"supplierHooreycaId": "S1084",
|
|
"supplierName": "Beszállító Kft.",
|
|
"profitCenterHooreycaId": "BAL",
|
|
"profitCenterName": "Profitcenter Neve - Eurest konyha",
|
|
"items": [
|
|
{
|
|
"id": 1111,
|
|
"hooreycaId": "H201",
|
|
"name": "Tőkehal filé (Alaszkai) 180/200 g",
|
|
"productUnit": "g",
|
|
"sellerUnit": "csom",
|
|
"unitMultiplier": 1,
|
|
"amountUnit": "kg",
|
|
"quantity": 15,
|
|
"price": 1234
|
|
},
|
|
{
|
|
"id": 2222,
|
|
"hooreycaId": "H300",
|
|
"name": "Garnélafarok Black tiger 16/20 tisztított, ",
|
|
"productUnit": "kg",
|
|
"sellerUnit": "csom",
|
|
"unitMultiplier": 1,
|
|
"amountUnit": "kg",
|
|
"quantity": 3,
|
|
"price": 5678
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"pagination": {
|
|
"count": 1,
|
|
"total": 21,
|
|
"perPage": 1,
|
|
"currentPage": 2,
|
|
"totalPages": 21,
|
|
"links": {
|
|
"previous": "http://{base_path}/api/v1/order/unprocessed?page=1",
|
|
"next": "http://{base_path}/api/v1/order/unprocessed?page=3"
|
|
}
|
|
}
|
|
}</code>
|
|
</pre>
|
|
<blockquote>
|
|
<p>Example response (401, Request unauthenticated):</p>
|
|
</blockquote>
|
|
<pre>
|
|
|
|
<code class="language-json">{
|
|
"status": 401,
|
|
"success": false,
|
|
"error": {
|
|
"code": "unauthenticated",
|
|
"message": "You are not authenticated for this request."
|
|
}
|
|
}</code>
|
|
</pre>
|
|
</span>
|
|
<span id="execution-results-GETapi-v1-order-unprocessed" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-GETapi-v1-order-unprocessed"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-GETapi-v1-order-unprocessed"></code></pre>
|
|
</span>
|
|
<span id="execution-error-GETapi-v1-order-unprocessed" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-GETapi-v1-order-unprocessed"></code></pre>
|
|
</span>
|
|
<form id="form-GETapi-v1-order-unprocessed" data-method="GET"
|
|
data-path="api/v1/order/unprocessed"
|
|
data-authed="1"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
data-headers='{"Authorization":"Bearer {YOUR_AUTH_KEY}","Content-Type":"application\/json","Accept":"application\/json"}'
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('GETapi-v1-order-unprocessed', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-GETapi-v1-order-unprocessed"
|
|
onclick="tryItOut('GETapi-v1-order-unprocessed');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-GETapi-v1-order-unprocessed"
|
|
onclick="cancelTryOut('GETapi-v1-order-unprocessed');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-GETapi-v1-order-unprocessed" hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-green">GET</small>
|
|
<b><code>api/v1/order/unprocessed</code></b>
|
|
</p>
|
|
<p>
|
|
<label id="auth-GETapi-v1-order-unprocessed" hidden>Authorization header:
|
|
<b><code>Bearer </code></b><input type="text"
|
|
name="Authorization"
|
|
data-prefix="Bearer "
|
|
data-endpoint="GETapi-v1-order-unprocessed"
|
|
data-component="header"></label>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>URL Parameters</b></h4>
|
|
<p>
|
|
<b><code>page</code></b> <small>integer</small>
|
|
<input type="number"
|
|
name="page"
|
|
data-endpoint="GETapi-v1-order-unprocessed"
|
|
value="4"
|
|
data-component="url" hidden>
|
|
<br>
|
|
<p>The page number.</p>
|
|
</p>
|
|
</form>
|
|
|
|
<h3>Response</h3>
|
|
<h4 class="fancy-heading-panel"><b>Response Fields</b></h4>
|
|
<p>
|
|
<b><code>status</code></b> <small>integer</small>
|
|
<br>
|
|
<p>request HTTP status</p>
|
|
</p>
|
|
<p>
|
|
<b><code>success</code></b> <small>boolean</small>
|
|
<br>
|
|
<p>process successes</p>
|
|
</p>
|
|
<p>
|
|
<b><code>apiVersion</code></b> <small>integer</small>
|
|
<br>
|
|
<p>current API version</p>
|
|
</p>
|
|
<p>
|
|
<b><code>processedTime</code></b> <small>string</small>
|
|
<br>
|
|
<p>DateTime process Timestamp</p>
|
|
</p>
|
|
<p>
|
|
<b><code>data</code></b> <small>object</small>
|
|
<br>
|
|
<p>collection of Orders.</p>
|
|
</p>
|
|
<p>
|
|
<b><code>data.APICallBackId</code></b> <small>string</small>
|
|
<br>
|
|
<p>Neet to set order update status in setProcessed interface.</p>
|
|
</p>
|
|
<h2 id="order-management-PUTapi-v1-order-setProcessed">Set processed orders.</h2>
|
|
|
|
<p>
|
|
<small class="badge badge-darkred">requires authentication</small>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-PUTapi-v1-order-setProcessed">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request PUT \
|
|
"http://localhost/api/v1/order/setProcessed" \
|
|
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json" \
|
|
--data "{
|
|
\"APICallBackId\": [
|
|
\"in\"
|
|
]
|
|
}"
|
|
</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost/api/v1/order/setProcessed"
|
|
);
|
|
|
|
const headers = {
|
|
"Authorization": "Bearer {YOUR_AUTH_KEY}",
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
let body = {
|
|
"APICallBackId": [
|
|
"in"
|
|
]
|
|
};
|
|
|
|
fetch(url, {
|
|
method: "PUT",
|
|
headers,
|
|
body: JSON.stringify(body),
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
|
|
<div class="php-example">
|
|
<pre><code class="language-php">$client = new \GuzzleHttp\Client();
|
|
$response = $client->put(
|
|
'http://localhost/api/v1/order/setProcessed',
|
|
[
|
|
'headers' => [
|
|
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
|
|
'Content-Type' => 'application/json',
|
|
'Accept' => 'application/json',
|
|
],
|
|
'json' => [
|
|
'APICallBackId' => [
|
|
'in',
|
|
],
|
|
],
|
|
]
|
|
);
|
|
$body = $response->getBody();
|
|
print_r(json_decode((string) $body));</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-PUTapi-v1-order-setProcessed">
|
|
<blockquote>
|
|
<p>Example response (200, Has unprocessed orders):</p>
|
|
</blockquote>
|
|
<pre>
|
|
|
|
<code class="language-json">{
|
|
"status": 200,
|
|
"success": true,
|
|
"apiVersion": "1",
|
|
"processedTime": "2020.01.01. 12:00:12.401670",
|
|
"data": {
|
|
"987f3001-6364-4d7c-8b0c-daf29dbd38ec": "updated",
|
|
"987ee197-5293-48de-a488-3c9a05229bb6": "invalid Id"
|
|
}
|
|
}</code>
|
|
</pre>
|
|
<blockquote>
|
|
<p>Example response (500, Request invalid Request Body data):</p>
|
|
</blockquote>
|
|
<pre>
|
|
|
|
<code class="language-json">{
|
|
"status": 500,
|
|
"success": false,
|
|
"apiVersion": "1",
|
|
"processedTime": "2020.01.01. 12:00:12.401670",
|
|
"error": {
|
|
"code": "invalid data",
|
|
"message": '{"room_id":["sff","sdf"]}'
|
|
}
|
|
}</code>
|
|
</pre>
|
|
<blockquote>
|
|
<p>Example response (401, Request unauthenticated):</p>
|
|
</blockquote>
|
|
<pre>
|
|
|
|
<code class="language-json">{
|
|
"status": 401,
|
|
"success": false,
|
|
"error": {
|
|
"code": "unauthenticated",
|
|
"message": "You are not authenticated for this request."
|
|
}
|
|
}</code>
|
|
</pre>
|
|
</span>
|
|
<span id="execution-results-PUTapi-v1-order-setProcessed" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-PUTapi-v1-order-setProcessed"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-PUTapi-v1-order-setProcessed"></code></pre>
|
|
</span>
|
|
<span id="execution-error-PUTapi-v1-order-setProcessed" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-PUTapi-v1-order-setProcessed"></code></pre>
|
|
</span>
|
|
<form id="form-PUTapi-v1-order-setProcessed" data-method="PUT"
|
|
data-path="api/v1/order/setProcessed"
|
|
data-authed="1"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
data-headers='{"Authorization":"Bearer {YOUR_AUTH_KEY}","Content-Type":"application\/json","Accept":"application\/json"}'
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('PUTapi-v1-order-setProcessed', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-PUTapi-v1-order-setProcessed"
|
|
onclick="tryItOut('PUTapi-v1-order-setProcessed');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-PUTapi-v1-order-setProcessed"
|
|
onclick="cancelTryOut('PUTapi-v1-order-setProcessed');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-PUTapi-v1-order-setProcessed" hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-darkblue">PUT</small>
|
|
<b><code>api/v1/order/setProcessed</code></b>
|
|
</p>
|
|
<p>
|
|
<small class="badge badge-purple">PATCH</small>
|
|
<b><code>api/v1/order/setProcessed</code></b>
|
|
</p>
|
|
<p>
|
|
<label id="auth-PUTapi-v1-order-setProcessed" hidden>Authorization header:
|
|
<b><code>Bearer </code></b><input type="text"
|
|
name="Authorization"
|
|
data-prefix="Bearer "
|
|
data-endpoint="PUTapi-v1-order-setProcessed"
|
|
data-component="header"></label>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Body Parameters</b></h4>
|
|
<p>
|
|
<b><code>APICallBackId</code></b> <small>string[]</small>
|
|
<input type="text"
|
|
name="APICallBackId[0]"
|
|
data-endpoint="PUTapi-v1-order-setProcessed"
|
|
data-component="body" hidden>
|
|
<input type="text"
|
|
name="APICallBackId[1]"
|
|
data-endpoint="PUTapi-v1-order-setProcessed"
|
|
data-component="body" hidden>
|
|
<br>
|
|
<p>List of APICallBackId need to set.</p>
|
|
</p>
|
|
</form>
|
|
|
|
<h3>Response</h3>
|
|
<h4 class="fancy-heading-panel"><b>Response Fields</b></h4>
|
|
<p>
|
|
<b><code>status</code></b> <small>integer</small>
|
|
<br>
|
|
<p>request HTTP status</p>
|
|
</p>
|
|
<p>
|
|
<b><code>success</code></b> <small>boolean</small>
|
|
<br>
|
|
<p>process successes</p>
|
|
</p>
|
|
<p>
|
|
<b><code>apiVersion</code></b> <small>integer</small>
|
|
<br>
|
|
<p>current API version</p>
|
|
</p>
|
|
<p>
|
|
<b><code>processedTime</code></b> <small>string</small>
|
|
<br>
|
|
<p>DateTime process Timestamp</p>
|
|
</p>
|
|
<p>
|
|
<b><code>data</code></b> <small>object</small>
|
|
<br>
|
|
<p>collection of updated Order status.</p>
|
|
</p>
|
|
<p>
|
|
<b><code>data.APICallBackId</code></b> <small>string</small>
|
|
<br>
|
|
<p>Order update status ("updated" is ok).</p>
|
|
</p>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="dark-box">
|
|
<div class="lang-selector">
|
|
<button type="button" class="lang-button" data-language-name="bash">bash</button>
|
|
<button type="button" class="lang-button" data-language-name="javascript">javascript</button>
|
|
<button type="button" class="lang-button" data-language-name="php">php</button>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|