dev-image.mainlinesalvage.auctionmarketer.co.uk
Open in
urlscan Pro
51.89.232.49
Public Scan
URL:
https://dev-image.mainlinesalvage.auctionmarketer.co.uk/
Submission: On June 07 via api from US — Scanned from GB
Submission: On June 07 via api from US — Scanned from GB
Form analysis 21 forms found in the DOM
<form id="form-POSTapproval" data-method="POST" data-path="approval" data-authed="1" data-hasfiles="0" data-isarraybody="0" data-headers="{"Content-Type":"application\/xml","Accept":"application\/json"}"
autocomplete="off" onsubmit="event.preventDefault(); executeTryOut('POSTapproval', this);">
<h3> Request <button type="button" style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-tryout-POSTapproval" onclick="tryItOut('POSTapproval');">Try it out ⚡ </button>
<button type="button" style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-canceltryout-POSTapproval" onclick="cancelTryOut('POSTapproval');" hidden="">Cancel 🛑 </button> <button
type="submit" style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-executetryout-POSTapproval" hidden="">Send Request 💥 </button>
</h3>
<p>
<small class="badge badge-black">POST</small>
<b><code>approval</code></b>
</p>
<h4 class="fancy-heading-panel"><b>Query Parameters</b></h4>
<p>
<b><code>api_token</code></b> <small>string</small> <input type="text" name="api_token" data-endpoint="POSTapproval" value="{YOUR_AUTH_KEY}" data-component="query" hidden="">
<br>
</p>
<p>Authentication key.</p>
<p></p>
<p>
<b><code>websiteId</code></b> <small>string</small> <input type="text" name="websiteId" data-endpoint="POSTapproval" value="dicta" data-component="query" hidden="">
<br>
</p>
<ul>
<li>it has to be an existing user in am_users and am_field_values (for credit limit field)</li>
</ul>
<p></p>
<p>
<b><code>creditLimit</code></b> <small>number</small> <input type="number" name="creditLimit" data-endpoint="POSTapproval" value="299118929.75067" data-component="query" hidden="">
<br>
</p>
<p>
<b><code>registerApproval</code></b> <small>string</small> <input type="text" name="registerApproval" data-endpoint="POSTapproval" value="asperiores" data-component="query" hidden="">
<br>
</p>
</form><form id="form-PUTapproval--id-" data-method="PUT" data-path="approval/{id}" data-authed="1" data-hasfiles="0" data-isarraybody="0"
data-headers="{"Content-Type":"application\/xml","Accept":"application\/json"}" autocomplete="off" onsubmit="event.preventDefault(); executeTryOut('PUTapproval--id-', this);">
<h3> Request <button type="button" style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-tryout-PUTapproval--id-" onclick="tryItOut('PUTapproval--id-');">Try it out ⚡ </button>
<button type="button" style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-canceltryout-PUTapproval--id-" onclick="cancelTryOut('PUTapproval--id-');" hidden="">Cancel 🛑 </button>
<button type="submit" style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-executetryout-PUTapproval--id-" hidden="">Send Request 💥 </button>
</h3>
<p>
<small class="badge badge-darkblue">PUT</small>
<b><code>approval/{id}</code></b>
</p>
<h4 class="fancy-heading-panel"><b>URL Parameters</b></h4>
<p>
<b><code>id</code></b> <small>string</small> <input type="text" name="id" data-endpoint="PUTapproval--id-" value="aut" data-component="url" hidden="">
<br>
</p>
<h4 class="fancy-heading-panel"><b>Query Parameters</b></h4>
<p>
<b><code>api_token</code></b> <small>string</small> <input type="text" name="api_token" data-endpoint="PUTapproval--id-" value="{YOUR_AUTH_KEY}" data-component="query" hidden="">
<br>
</p>
<p>Authentication key.</p>
<p></p>
</form><form id="form-DELETEapproval--id-" data-method="DELETE" data-path="approval/{id}" data-authed="1" data-hasfiles="0" data-isarraybody="0"
data-headers="{"Content-Type":"application\/xml","Accept":"application\/json"}" autocomplete="off" onsubmit="event.preventDefault(); executeTryOut('DELETEapproval--id-', this);">
<h3> Request <button type="button" style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-tryout-DELETEapproval--id-" onclick="tryItOut('DELETEapproval--id-');">Try it out ⚡ </button>
<button type="button" style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-canceltryout-DELETEapproval--id-" onclick="cancelTryOut('DELETEapproval--id-');" hidden="">Cancel 🛑 </button>
<button type="submit" style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-executetryout-DELETEapproval--id-" hidden="">Send Request 💥 </button>
</h3>
<p>
<small class="badge badge-red">DELETE</small>
<b><code>approval/{id}</code></b>
</p>
<h4 class="fancy-heading-panel"><b>URL Parameters</b></h4>
<p>
<b><code>id</code></b> <small>string</small> <input type="text" name="id" data-endpoint="DELETEapproval--id-" value="praesentium" data-component="url" hidden="">
<br>
</p>
<h4 class="fancy-heading-panel"><b>Query Parameters</b></h4>
<p>
<b><code>api_token</code></b> <small>string</small> <input type="text" name="api_token" data-endpoint="DELETEapproval--id-" value="{YOUR_AUTH_KEY}" data-component="query" hidden="">
<br>
</p>
<p>Authentication key.</p>
<p></p>
</form><form id="form-POSTcatalogue_layout" data-method="POST" data-path="catalogue_layout" data-authed="1" data-hasfiles="0" data-isarraybody="0"
data-headers="{"Content-Type":"application\/xml","Accept":"application\/json"}" autocomplete="off" onsubmit="event.preventDefault(); executeTryOut('POSTcatalogue_layout', this);">
<h3> Request <button type="button" style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-tryout-POSTcatalogue_layout" onclick="tryItOut('POSTcatalogue_layout');">Try it out ⚡
</button>
<button type="button" style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-canceltryout-POSTcatalogue_layout" onclick="cancelTryOut('POSTcatalogue_layout');" hidden="">Cancel 🛑
</button> <button type="submit" style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-executetryout-POSTcatalogue_layout" hidden="">Send Request 💥 </button>
</h3>
<p>
<small class="badge badge-black">POST</small>
<b><code>catalogue_layout</code></b>
</p>
<h4 class="fancy-heading-panel"><b>Query Parameters</b></h4>
<p>
<b><code>api_token</code></b> <small>string</small> <input type="text" name="api_token" data-endpoint="POSTcatalogue_layout" value="{YOUR_AUTH_KEY}" data-component="query" hidden="">
<br>
</p>
<p>Authentication key.</p>
<p></p>
<p>
<b><code>websiteId</code></b> <small>string</small> <input type="text" name="websiteId" data-endpoint="POSTcatalogue_layout" value="earum" data-component="query" hidden="">
<br>
</p>
<ul>
<li>it has to be an existing user in am_users and am_field_values (for credit limit field)</li>
</ul>
<p></p>
<p>
<b><code>creditLimit</code></b> <small>number</small> <input type="number" name="creditLimit" data-endpoint="POSTcatalogue_layout" value="4084.72196" data-component="query" hidden="">
<br>
</p>
<p>
<b><code>registerApproval</code></b> <small>string</small> <input type="text" name="registerApproval" data-endpoint="POSTcatalogue_layout" value="occaecati" data-component="query" hidden="">
<br>
</p>
</form><form id="form-PUTcatalogue_layout--id-" data-method="PUT" data-path="catalogue_layout/{id}" data-authed="1" data-hasfiles="0" data-isarraybody="0"
data-headers="{"Content-Type":"application\/xml","Accept":"application\/json"}" autocomplete="off" onsubmit="event.preventDefault(); executeTryOut('PUTcatalogue_layout--id-', this);">
<h3> Request <button type="button" style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-tryout-PUTcatalogue_layout--id-" onclick="tryItOut('PUTcatalogue_layout--id-');">Try it out ⚡
</button>
<button type="button" style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-canceltryout-PUTcatalogue_layout--id-" onclick="cancelTryOut('PUTcatalogue_layout--id-');" hidden="">Cancel 🛑
</button> <button type="submit" style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-executetryout-PUTcatalogue_layout--id-" hidden="">Send Request 💥 </button>
</h3>
<p>
<small class="badge badge-darkblue">PUT</small>
<b><code>catalogue_layout/{id}</code></b>
</p>
<h4 class="fancy-heading-panel"><b>URL Parameters</b></h4>
<p>
<b><code>id</code></b> <small>string</small> <input type="text" name="id" data-endpoint="PUTcatalogue_layout--id-" value="sed" data-component="url" hidden="">
<br>
</p>
<h4 class="fancy-heading-panel"><b>Query Parameters</b></h4>
<p>
<b><code>api_token</code></b> <small>string</small> <input type="text" name="api_token" data-endpoint="PUTcatalogue_layout--id-" value="{YOUR_AUTH_KEY}" data-component="query" hidden="">
<br>
</p>
<p>Authentication key.</p>
<p></p>
</form><form id="form-DELETEcatalogue_layout--id-" data-method="DELETE" data-path="catalogue_layout/{id}" data-authed="1" data-hasfiles="0" data-isarraybody="0"
data-headers="{"Content-Type":"application\/xml","Accept":"application\/json"}" autocomplete="off" onsubmit="event.preventDefault(); executeTryOut('DELETEcatalogue_layout--id-', this);">
<h3> Request <button type="button" style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-tryout-DELETEcatalogue_layout--id-" onclick="tryItOut('DELETEcatalogue_layout--id-');">Try it
out ⚡ </button>
<button type="button" style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-canceltryout-DELETEcatalogue_layout--id-" onclick="cancelTryOut('DELETEcatalogue_layout--id-');" hidden="">Cancel 🛑
</button> <button type="submit" style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-executetryout-DELETEcatalogue_layout--id-" hidden="">Send Request 💥 </button>
</h3>
<p>
<small class="badge badge-red">DELETE</small>
<b><code>catalogue_layout/{id}</code></b>
</p>
<h4 class="fancy-heading-panel"><b>URL Parameters</b></h4>
<p>
<b><code>id</code></b> <small>string</small> <input type="text" name="id" data-endpoint="DELETEcatalogue_layout--id-" value="repellendus" data-component="url" hidden="">
<br>
</p>
<h4 class="fancy-heading-panel"><b>Query Parameters</b></h4>
<p>
<b><code>api_token</code></b> <small>string</small> <input type="text" name="api_token" data-endpoint="DELETEcatalogue_layout--id-" value="{YOUR_AUTH_KEY}" data-component="query" hidden="">
<br>
</p>
<p>Authentication key.</p>
<p></p>
</form><form id="form-POSTdocument" data-method="POST" data-path="document" data-authed="1" data-hasfiles="0" data-isarraybody="0" data-headers="{"Content-Type":"application\/xml","Accept":"application\/json"}"
autocomplete="off" onsubmit="event.preventDefault(); executeTryOut('POSTdocument', this);">
<h3> Request <button type="button" style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-tryout-POSTdocument" onclick="tryItOut('POSTdocument');">Try it out ⚡ </button>
<button type="button" style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-canceltryout-POSTdocument" onclick="cancelTryOut('POSTdocument');" hidden="">Cancel 🛑 </button> <button
type="submit" style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-executetryout-POSTdocument" hidden="">Send Request 💥 </button>
</h3>
<p>
<small class="badge badge-black">POST</small>
<b><code>document</code></b>
</p>
<h4 class="fancy-heading-panel"><b>Query Parameters</b></h4>
<p>
<b><code>api_token</code></b> <small>string</small> <input type="text" name="api_token" data-endpoint="POSTdocument" value="{YOUR_AUTH_KEY}" data-component="query" hidden="">
<br>
</p>
<p>Authentication key.</p>
<p></p>
<p>
<b><code>websiteId</code></b> <small>string</small> <input type="text" name="websiteId" data-endpoint="POSTdocument" value="sit" data-component="query" hidden="">
<br>
</p>
<ul>
<li>it has to be an existing user in am_users and am_field_values (for credit limit field)</li>
</ul>
<p></p>
<p>
<b><code>creditLimit</code></b> <small>number</small> <input type="number" name="creditLimit" data-endpoint="POSTdocument" value="3.512129899" data-component="query" hidden="">
<br>
</p>
<p>
<b><code>registerApproval</code></b> <small>string</small> <input type="text" name="registerApproval" data-endpoint="POSTdocument" value="a" data-component="query" hidden="">
<br>
</p>
</form><form id="form-PUTdocument--id-" data-method="PUT" data-path="document/{id}" data-authed="1" data-hasfiles="0" data-isarraybody="0"
data-headers="{"Content-Type":"application\/xml","Accept":"application\/json"}" autocomplete="off" onsubmit="event.preventDefault(); executeTryOut('PUTdocument--id-', this);">
<h3> Request <button type="button" style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-tryout-PUTdocument--id-" onclick="tryItOut('PUTdocument--id-');">Try it out ⚡ </button>
<button type="button" style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-canceltryout-PUTdocument--id-" onclick="cancelTryOut('PUTdocument--id-');" hidden="">Cancel 🛑 </button>
<button type="submit" style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-executetryout-PUTdocument--id-" hidden="">Send Request 💥 </button>
</h3>
<p>
<small class="badge badge-darkblue">PUT</small>
<b><code>document/{id}</code></b>
</p>
<h4 class="fancy-heading-panel"><b>URL Parameters</b></h4>
<p>
<b><code>id</code></b> <small>string</small> <input type="text" name="id" data-endpoint="PUTdocument--id-" value="architecto" data-component="url" hidden="">
<br>
</p>
<h4 class="fancy-heading-panel"><b>Query Parameters</b></h4>
<p>
<b><code>api_token</code></b> <small>string</small> <input type="text" name="api_token" data-endpoint="PUTdocument--id-" value="{YOUR_AUTH_KEY}" data-component="query" hidden="">
<br>
</p>
<p>Authentication key.</p>
<p></p>
</form><form id="form-DELETEdocument--id-" data-method="DELETE" data-path="document/{id}" data-authed="1" data-hasfiles="0" data-isarraybody="0"
data-headers="{"Content-Type":"application\/xml","Accept":"application\/json"}" autocomplete="off" onsubmit="event.preventDefault(); executeTryOut('DELETEdocument--id-', this);">
<h3> Request <button type="button" style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-tryout-DELETEdocument--id-" onclick="tryItOut('DELETEdocument--id-');">Try it out ⚡ </button>
<button type="button" style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-canceltryout-DELETEdocument--id-" onclick="cancelTryOut('DELETEdocument--id-');" hidden="">Cancel 🛑 </button>
<button type="submit" style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-executetryout-DELETEdocument--id-" hidden="">Send Request 💥 </button>
</h3>
<p>
<small class="badge badge-red">DELETE</small>
<b><code>document/{id}</code></b>
</p>
<h4 class="fancy-heading-panel"><b>URL Parameters</b></h4>
<p>
<b><code>id</code></b> <small>string</small> <input type="text" name="id" data-endpoint="DELETEdocument--id-" value="qui" data-component="url" hidden="">
<br>
</p>
<h4 class="fancy-heading-panel"><b>Query Parameters</b></h4>
<p>
<b><code>api_token</code></b> <small>string</small> <input type="text" name="api_token" data-endpoint="DELETEdocument--id-" value="{YOUR_AUTH_KEY}" data-component="query" hidden="">
<br>
</p>
<p>Authentication key.</p>
<p></p>
</form><form id="form-POSTimage" data-method="POST" data-path="image" data-authed="1" data-hasfiles="1" data-isarraybody="0" data-headers="{"Content-Type":"multipart\/form-data","Accept":"application\/json"}"
autocomplete="off" onsubmit="event.preventDefault(); executeTryOut('POSTimage', this);">
<h3> Request <button type="button" style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-tryout-POSTimage" onclick="tryItOut('POSTimage');">Try it out ⚡ </button>
<button type="button" style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-canceltryout-POSTimage" onclick="cancelTryOut('POSTimage');" hidden="">Cancel 🛑 </button> <button
type="submit" style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-executetryout-POSTimage" hidden="">Send Request 💥 </button>
</h3>
<p>
<small class="badge badge-black">POST</small>
<b><code>image</code></b>
</p>
<h4 class="fancy-heading-panel"><b>Query Parameters</b></h4>
<p>
<b><code>api_token</code></b> <small>string</small> <input type="text" name="api_token" data-endpoint="POSTimage" value="{YOUR_AUTH_KEY}" data-component="query" hidden="">
<br>
</p>
<p>Authentication key.</p>
<p></p>
<p>
<b><code>lot_id</code></b> <small>string</small> <input type="text" name="lot_id" data-endpoint="POSTimage" value="hic" data-component="query" hidden="">
<br>
</p>
<p>
<b><code>sort_no</code></b> <small>string</small> <input type="text" name="sort_no" data-endpoint="POSTimage" value="suscipit" data-component="query" hidden="">
<br>
</p>
<p>
<b><code>media_type</code></b> <small>number</small> <input type="number" name="media_type" data-endpoint="POSTimage" value="10837460.82" data-component="query" hidden="">
<br>
</p>
<p>
<b><code>image</code></b> <small>string</small> <input type="text" name="image" data-endpoint="POSTimage" value="et" data-component="query" hidden="">
<br>
</p>
<h4 class="fancy-heading-panel"><b>Body Parameters</b></h4>
<p>
<b><code>lot_id</code></b> <small>number</small> <input type="number" name="lot_id" data-endpoint="POSTimage" value="109366.96487519" data-component="body" hidden="">
<br>
</p>
<p>
<b><code>sort_no</code></b> <small>number</small> <input type="number" name="sort_no" data-endpoint="POSTimage" value="522739287.917" data-component="body" hidden="">
<br>
</p>
<p>
<b><code>image</code></b> <small>file</small> <input type="file" name="image" data-endpoint="POSTimage" value="" data-component="body" hidden="">
<br>
</p>
<p>Must be an image. Must not be greater than 50000000 kilobytes.</p>
<p></p>
</form><form id="form-POSTimage-sort" data-method="POST" data-path="image/sort" data-authed="1" data-hasfiles="0" data-isarraybody="0" data-headers="{"Content-Type":"application\/xml","Accept":"application\/json"}"
autocomplete="off" onsubmit="event.preventDefault(); executeTryOut('POSTimage-sort', this);">
<h3> Request <button type="button" style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-tryout-POSTimage-sort" onclick="tryItOut('POSTimage-sort');">Try it out ⚡ </button>
<button type="button" style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-canceltryout-POSTimage-sort" onclick="cancelTryOut('POSTimage-sort');" hidden="">Cancel 🛑 </button> <button
type="submit" style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-executetryout-POSTimage-sort" hidden="">Send Request 💥 </button>
</h3>
<p>
<small class="badge badge-black">POST</small>
<b><code>image/sort</code></b>
</p>
<h4 class="fancy-heading-panel"><b>Query Parameters</b></h4>
<p>
<b><code>api_token</code></b> <small>string</small> <input type="text" name="api_token" data-endpoint="POSTimage-sort" value="{YOUR_AUTH_KEY}" data-component="query" hidden="">
<br>
</p>
<p>Authentication key.</p>
<p></p>
<p>
<b><code>imageId</code></b> <small>string</small> <input type="text" name="imageId" data-endpoint="POSTimage-sort" value="adipisci" data-component="query" hidden="">
<br>
</p>
<p>
<b><code>ordering</code></b> <small>number</small> <input type="number" name="ordering" data-endpoint="POSTimage-sort" value="73158163.349" data-component="query" hidden="">
<br>
</p>
</form><form id="form-DELETEimage--id-" data-method="DELETE" data-path="image/{id}" data-authed="1" data-hasfiles="0" data-isarraybody="0"
data-headers="{"Content-Type":"application\/xml","Accept":"application\/json"}" autocomplete="off" onsubmit="event.preventDefault(); executeTryOut('DELETEimage--id-', this);">
<h3> Request <button type="button" style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-tryout-DELETEimage--id-" onclick="tryItOut('DELETEimage--id-');">Try it out ⚡ </button>
<button type="button" style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-canceltryout-DELETEimage--id-" onclick="cancelTryOut('DELETEimage--id-');" hidden="">Cancel 🛑 </button>
<button type="submit" style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-executetryout-DELETEimage--id-" hidden="">Send Request 💥 </button>
</h3>
<p>
<small class="badge badge-red">DELETE</small>
<b><code>image/{id}</code></b>
</p>
<h4 class="fancy-heading-panel"><b>URL Parameters</b></h4>
<p>
<b><code>id</code></b> <small>string</small> <input type="text" name="id" data-endpoint="DELETEimage--id-" value="quasi" data-component="url" hidden="">
<br>
</p>
<h4 class="fancy-heading-panel"><b>Query Parameters</b></h4>
<p>
<b><code>api_token</code></b> <small>string</small> <input type="text" name="api_token" data-endpoint="DELETEimage--id-" value="{YOUR_AUTH_KEY}" data-component="query" hidden="">
<br>
</p>
<p>Authentication key.</p>
<p></p>
</form><form id="form-POSTimage--id-" data-method="POST" data-path="image/{id}" data-authed="1" data-hasfiles="1" data-isarraybody="0"
data-headers="{"Content-Type":"multipart\/form-data","Accept":"application\/json"}" autocomplete="off" onsubmit="event.preventDefault(); executeTryOut('POSTimage--id-', this);">
<h3> Request <button type="button" style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-tryout-POSTimage--id-" onclick="tryItOut('POSTimage--id-');">Try it out ⚡ </button>
<button type="button" style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-canceltryout-POSTimage--id-" onclick="cancelTryOut('POSTimage--id-');" hidden="">Cancel 🛑 </button> <button
type="submit" style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-executetryout-POSTimage--id-" hidden="">Send Request 💥 </button>
</h3>
<p>
<small class="badge badge-black">POST</small>
<b><code>image/{id}</code></b>
</p>
<h4 class="fancy-heading-panel"><b>URL Parameters</b></h4>
<p>
<b><code>id</code></b> <small>string</small> <input type="text" name="id" data-endpoint="POSTimage--id-" value="sint" data-component="url" hidden="">
<br>
</p>
<h4 class="fancy-heading-panel"><b>Query Parameters</b></h4>
<p>
<b><code>api_token</code></b> <small>string</small> <input type="text" name="api_token" data-endpoint="POSTimage--id-" value="{YOUR_AUTH_KEY}" data-component="query" hidden="">
<br>
</p>
<p>Authentication key.</p>
<p></p>
<h4 class="fancy-heading-panel"><b>Body Parameters</b></h4>
<p>
<b><code>lot_id</code></b> <small>number</small> <input type="number" name="lot_id" data-endpoint="POSTimage--id-" value="659.04728626" data-component="body" hidden="">
<br>
</p>
<p>
<b><code>sort_no</code></b> <small>number</small> <input type="number" name="sort_no" data-endpoint="POSTimage--id-" value="54108" data-component="body" hidden="">
<br>
</p>
<p>
<b><code>image</code></b> <small>file</small> <i>optional</i> <input type="file" name="image" data-endpoint="POSTimage--id-" value="" data-component="body" hidden="">
<br>
</p>
<p>Must be an image. Must not be greater than 50000000 kilobytes.</p>
<p></p>
</form><form id="form-POSTmedia" data-method="POST" data-path="media" data-authed="1" data-hasfiles="0" data-isarraybody="0" data-headers="{"Content-Type":"application\/xml","Accept":"application\/json"}"
autocomplete="off" onsubmit="event.preventDefault(); executeTryOut('POSTmedia', this);">
<h3> Request <button type="button" style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-tryout-POSTmedia" onclick="tryItOut('POSTmedia');">Try it out ⚡ </button>
<button type="button" style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-canceltryout-POSTmedia" onclick="cancelTryOut('POSTmedia');" hidden="">Cancel 🛑 </button> <button
type="submit" style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-executetryout-POSTmedia" hidden="">Send Request 💥 </button>
</h3>
<p>
<small class="badge badge-black">POST</small>
<b><code>media</code></b>
</p>
<h4 class="fancy-heading-panel"><b>Query Parameters</b></h4>
<p>
<b><code>api_token</code></b> <small>string</small> <input type="text" name="api_token" data-endpoint="POSTmedia" value="{YOUR_AUTH_KEY}" data-component="query" hidden="">
<br>
</p>
<p>Authentication key.</p>
<p></p>
<p>
<b><code>systemId</code></b> <small>string</small> <input type="text" name="systemId" data-endpoint="POSTmedia" value="qui" data-component="query" hidden="">
<br>
</p>
<p>
<b><code>tableNo</code></b> <small>number</small> <input type="number" name="tableNo" data-endpoint="POSTmedia" value="13123.9" data-component="query" hidden="">
<br>
</p>
<p>
<b><code>relatedSystemId</code></b> <small>string</small> <input type="text" name="relatedSystemId" data-endpoint="POSTmedia" value="ducimus" data-component="query" hidden="">
<br>
</p>
<p>It has to be an existing lot in the db</p>
<p></p>
<p>
<b><code>entryNo</code></b> <small>number</small> <input type="number" name="entryNo" data-endpoint="POSTmedia" value="0" data-component="query" hidden="">
<br>
</p>
<p>
<b><code>storageType</code></b> <small>string</small> <input type="text" name="storageType" data-endpoint="POSTmedia" value="rerum" data-component="query" hidden="">
<br>
</p>
<p>
<b><code>sortNo</code></b> <small>number</small> <input type="number" name="sortNo" data-endpoint="POSTmedia" value="1873.23686483" data-component="query" hidden="">
<br>
</p>
<p>
<b><code>mediaType</code></b> <small>string</small> <input type="text" name="mediaType" data-endpoint="POSTmedia" value="dolore" data-component="query" hidden="">
<br>
</p>
<p>
<b><code>publicMediaPath</code></b> <small>string</small> <input type="text" name="publicMediaPath" data-endpoint="POSTmedia" value="perspiciatis" data-component="query" hidden="">
<br>
</p>
<p>An active url</p>
<p></p>
<p>
<b><code>code</code></b> <small>string</small> <input type="text" name="code" data-endpoint="POSTmedia" value="quidem" data-component="query" hidden="">
<br>
</p>
<p>
<b><code>filename</code></b> <small>string</small> <input type="text" name="filename" data-endpoint="POSTmedia" value="aut" data-component="query" hidden="">
<br>
</p>
</form><form id="form-POSTmedia-sort" data-method="POST" data-path="media/sort" data-authed="1" data-hasfiles="0" data-isarraybody="0" data-headers="{"Content-Type":"application\/xml","Accept":"application\/json"}"
autocomplete="off" onsubmit="event.preventDefault(); executeTryOut('POSTmedia-sort', this);">
<h3> Request <button type="button" style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-tryout-POSTmedia-sort" onclick="tryItOut('POSTmedia-sort');">Try it out ⚡ </button>
<button type="button" style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-canceltryout-POSTmedia-sort" onclick="cancelTryOut('POSTmedia-sort');" hidden="">Cancel 🛑 </button> <button
type="submit" style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-executetryout-POSTmedia-sort" hidden="">Send Request 💥 </button>
</h3>
<p>
<small class="badge badge-black">POST</small>
<b><code>media/sort</code></b>
</p>
<h4 class="fancy-heading-panel"><b>Query Parameters</b></h4>
<p>
<b><code>api_token</code></b> <small>string</small> <input type="text" name="api_token" data-endpoint="POSTmedia-sort" value="{YOUR_AUTH_KEY}" data-component="query" hidden="">
<br>
</p>
<p>Authentication key.</p>
<p></p>
<p>
<b><code>systemId</code></b> <small>string</small> <input type="text" name="systemId" data-endpoint="POSTmedia-sort" value="qui" data-component="query" hidden="">
<br>
</p>
<p>
<b><code>sortNo</code></b> <small>number</small> <input type="number" name="sortNo" data-endpoint="POSTmedia-sort" value="330070.894" data-component="query" hidden="">
<br>
</p>
</form><form id="form-PUTmedia--id-" data-method="PUT" data-path="media/{id}" data-authed="1" data-hasfiles="0" data-isarraybody="0" data-headers="{"Content-Type":"application\/xml","Accept":"application\/json"}"
autocomplete="off" onsubmit="event.preventDefault(); executeTryOut('PUTmedia--id-', this);">
<h3> Request <button type="button" style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-tryout-PUTmedia--id-" onclick="tryItOut('PUTmedia--id-');">Try it out ⚡ </button>
<button type="button" style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-canceltryout-PUTmedia--id-" onclick="cancelTryOut('PUTmedia--id-');" hidden="">Cancel 🛑 </button> <button
type="submit" style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-executetryout-PUTmedia--id-" hidden="">Send Request 💥 </button>
</h3>
<p>
<small class="badge badge-darkblue">PUT</small>
<b><code>media/{id}</code></b>
</p>
<h4 class="fancy-heading-panel"><b>URL Parameters</b></h4>
<p>
<b><code>id</code></b> <small>string</small> <input type="text" name="id" data-endpoint="PUTmedia--id-" value="distinctio" data-component="url" hidden="">
<br>
</p>
<h4 class="fancy-heading-panel"><b>Query Parameters</b></h4>
<p>
<b><code>api_token</code></b> <small>string</small> <input type="text" name="api_token" data-endpoint="PUTmedia--id-" value="{YOUR_AUTH_KEY}" data-component="query" hidden="">
<br>
</p>
<p>Authentication key.</p>
<p></p>
</form><form id="form-DELETEmedia--id-" data-method="DELETE" data-path="media/{id}" data-authed="1" data-hasfiles="0" data-isarraybody="0"
data-headers="{"Content-Type":"application\/xml","Accept":"application\/json"}" autocomplete="off" onsubmit="event.preventDefault(); executeTryOut('DELETEmedia--id-', this);">
<h3> Request <button type="button" style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-tryout-DELETEmedia--id-" onclick="tryItOut('DELETEmedia--id-');">Try it out ⚡ </button>
<button type="button" style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-canceltryout-DELETEmedia--id-" onclick="cancelTryOut('DELETEmedia--id-');" hidden="">Cancel 🛑 </button>
<button type="submit" style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-executetryout-DELETEmedia--id-" hidden="">Send Request 💥 </button>
</h3>
<p>
<small class="badge badge-red">DELETE</small>
<b><code>media/{id}</code></b>
</p>
<h4 class="fancy-heading-panel"><b>URL Parameters</b></h4>
<p>
<b><code>id</code></b> <small>string</small> <input type="text" name="id" data-endpoint="DELETEmedia--id-" value="vero" data-component="url" hidden="">
<br>
</p>
<h4 class="fancy-heading-panel"><b>Query Parameters</b></h4>
<p>
<b><code>api_token</code></b> <small>string</small> <input type="text" name="api_token" data-endpoint="DELETEmedia--id-" value="{YOUR_AUTH_KEY}" data-component="query" hidden="">
<br>
</p>
<p>Authentication key.</p>
<p></p>
</form><form id="form-POSTuser" data-method="POST" data-path="user" data-authed="1" data-hasfiles="0" data-isarraybody="0" data-headers="{"Content-Type":"application\/json","Accept":"application\/json"}"
autocomplete="off" onsubmit="event.preventDefault(); executeTryOut('POSTuser', this);">
<h3> Request <button type="button" style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-tryout-POSTuser" onclick="tryItOut('POSTuser');">Try it out ⚡ </button>
<button type="button" style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-canceltryout-POSTuser" onclick="cancelTryOut('POSTuser');" hidden="">Cancel 🛑 </button> <button type="submit"
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-executetryout-POSTuser" hidden="">Send Request 💥 </button>
</h3>
<p>
<small class="badge badge-black">POST</small>
<b><code>user</code></b>
</p>
<h4 class="fancy-heading-panel"><b>Query Parameters</b></h4>
<p>
<b><code>api_token</code></b> <small>string</small> <input type="text" name="api_token" data-endpoint="POSTuser" value="{YOUR_AUTH_KEY}" data-component="query" hidden="">
<br>
</p>
<p>Authentication key.</p>
<p></p>
</form><form id="form-PUTuser" data-method="PUT" data-path="user" data-authed="1" data-hasfiles="0" data-isarraybody="0" data-headers="{"Content-Type":"application\/xml","Accept":"application\/json"}"
autocomplete="off" onsubmit="event.preventDefault(); executeTryOut('PUTuser', this);">
<h3> Request <button type="button" style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-tryout-PUTuser" onclick="tryItOut('PUTuser');">Try it out ⚡ </button>
<button type="button" style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-canceltryout-PUTuser" onclick="cancelTryOut('PUTuser');" hidden="">Cancel 🛑 </button> <button type="submit"
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-executetryout-PUTuser" hidden="">Send Request 💥 </button>
</h3>
<p>
<small class="badge badge-darkblue">PUT</small>
<b><code>user</code></b>
</p>
<h4 class="fancy-heading-panel"><b>Query Parameters</b></h4>
<p>
<b><code>api_token</code></b> <small>string</small> <input type="text" name="api_token" data-endpoint="PUTuser" value="{YOUR_AUTH_KEY}" data-component="query" hidden="">
<br>
</p>
<p>Authentication key.</p>
<p></p>
<h4 class="fancy-heading-panel"><b>Body Parameters</b></h4>
<p>
<b><code>websiteID</code></b> <small>number</small> <input type="number" name="websiteID" data-endpoint="PUTuser" value="630043.5" data-component="body" hidden="">
<br>
</p>
<p>
<b><code>customerNo</code></b> <small>string</small> <i>optional</i> <input type="text" name="customerNo" data-endpoint="PUTuser" value="et" data-component="body" hidden="">
<br>
</p>
<p>
<b><code>vendorNo</code></b> <small>string</small> <i>optional</i> <input type="text" name="vendorNo" data-endpoint="PUTuser" value="iste" data-component="body" hidden="">
<br>
</p>
<p>
<b><code>firstName</code></b> <small>string</small> <i>optional</i> <input type="text" name="firstName" data-endpoint="PUTuser" value="placeat" data-component="body" hidden="">
<br>
</p>
<p>
<b><code>middleName</code></b> <small>string</small> <i>optional</i> <input type="text" name="middleName" data-endpoint="PUTuser" value="optio" data-component="body" hidden="">
<br>
</p>
<p>
<b><code>surname</code></b> <small>string</small> <i>optional</i> <input type="text" name="surname" data-endpoint="PUTuser" value="ut" data-component="body" hidden="">
<br>
</p>
<p>
<b><code>companyName</code></b> <small>string</small> <i>optional</i> <input type="text" name="companyName" data-endpoint="PUTuser" value="dolore" data-component="body" hidden="">
<br>
</p>
<p>
<b><code>email</code></b> <small>string</small> <input type="text" name="email" data-endpoint="PUTuser" value="aut" data-component="body" hidden="">
<br>
</p>
<p>
<b><code>address</code></b> <small>string</small> <i>optional</i> <input type="text" name="address" data-endpoint="PUTuser" value="dolores" data-component="body" hidden="">
<br>
</p>
<p>
<b><code>address2</code></b> <small>string</small> <i>optional</i> <input type="text" name="address2" data-endpoint="PUTuser" value="iure" data-component="body" hidden="">
<br>
</p>
<p>
<b><code>city</code></b> <small>string</small> <i>optional</i> <input type="text" name="city" data-endpoint="PUTuser" value="ipsa" data-component="body" hidden="">
<br>
</p>
<p>
<b><code>county</code></b> <small>string</small> <i>optional</i> <input type="text" name="county" data-endpoint="PUTuser" value="occaecati" data-component="body" hidden="">
<br>
</p>
<p>
<b><code>postCode</code></b> <small>string</small> <i>optional</i> <input type="text" name="postCode" data-endpoint="PUTuser" value="illo" data-component="body" hidden="">
<br>
</p>
<p>
<b><code>country</code></b> <small>string</small> <i>optional</i> <input type="text" name="country" data-endpoint="PUTuser" value="perspiciatis" data-component="body" hidden="">
<br>
</p>
<p>
<b><code>phoneNo</code></b> <small>string</small> <i>optional</i> <input type="text" name="phoneNo" data-endpoint="PUTuser" value="quam" data-component="body" hidden="">
<br>
</p>
<p>
<b><code>mobileNo</code></b> <small>string</small> <i>optional</i> <input type="text" name="mobileNo" data-endpoint="PUTuser" value="quae" data-component="body" hidden="">
<br>
</p>
<p>
<b><code>vatNo</code></b> <small>string</small> <i>optional</i> <input type="text" name="vatNo" data-endpoint="PUTuser" value="quia" data-component="body" hidden="">
<br>
</p>
<p>
<b><code>accountType</code></b> <small>string</small> <i>optional</i> <input type="text" name="accountType" data-endpoint="PUTuser" value="officiis" data-component="body" hidden="">
<br>
</p>
<p>
<b><code>blocked</code></b> <small>boolean</small> <i>optional</i> <label data-endpoint="PUTuser" hidden="">
<input type="radio" name="blocked" value="true" data-endpoint="PUTuser" data-component="body">
<code>true</code>
</label>
<label data-endpoint="PUTuser" hidden="">
<input type="radio" name="blocked" value="false" data-endpoint="PUTuser" data-component="body">
<code>false</code>
</label>
<br>
</p>
</form><form id="form-GETuser" data-method="GET" data-path="user" data-authed="1" data-hasfiles="0" data-isarraybody="0" data-headers="{"Content-Type":"application\/json","Accept":"application\/json"}"
autocomplete="off" onsubmit="event.preventDefault(); executeTryOut('GETuser', this);">
<h3> Request <button type="button" style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-tryout-GETuser" onclick="tryItOut('GETuser');">Try it out ⚡ </button>
<button type="button" style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-canceltryout-GETuser" onclick="cancelTryOut('GETuser');" hidden="">Cancel 🛑 </button> <button type="submit"
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-executetryout-GETuser" hidden="">Send Request 💥 </button>
</h3>
<p>
<small class="badge badge-green">GET</small>
<b><code>user</code></b>
</p>
<h4 class="fancy-heading-panel"><b>Query Parameters</b></h4>
<p>
<b><code>api_token</code></b> <small>string</small> <input type="text" name="api_token" data-endpoint="GETuser" value="{YOUR_AUTH_KEY}" data-component="query" hidden="">
<br>
</p>
<p>Authentication key.</p>
<p></p>
<h4 class="fancy-heading-panel"><b>Body Parameters</b></h4>
<p>
<b><code>email</code></b> <small>string</small> <input type="text" name="email" data-endpoint="GETuser" value="quam" data-component="body" hidden="">
<br>
</p>
</form><form id="form-DELETEuser--id-" data-method="DELETE" data-path="user/{id}" data-authed="1" data-hasfiles="0" data-isarraybody="0" data-headers="{"Content-Type":"application\/xml","Accept":"application\/json"}"
autocomplete="off" onsubmit="event.preventDefault(); executeTryOut('DELETEuser--id-', this);">
<h3> Request <button type="button" style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-tryout-DELETEuser--id-" onclick="tryItOut('DELETEuser--id-');">Try it out ⚡ </button>
<button type="button" style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-canceltryout-DELETEuser--id-" onclick="cancelTryOut('DELETEuser--id-');" hidden="">Cancel 🛑 </button> <button
type="submit" style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-executetryout-DELETEuser--id-" hidden="">Send Request 💥 </button>
</h3>
<p>
<small class="badge badge-red">DELETE</small>
<b><code>user/{id}</code></b>
</p>
<h4 class="fancy-heading-panel"><b>URL Parameters</b></h4>
<p>
<b><code>id</code></b> <small>string</small> <input type="text" name="id" data-endpoint="DELETEuser--id-" value="sit" data-component="url" hidden="">
<br>
</p>
<h4 class="fancy-heading-panel"><b>Query Parameters</b></h4>
<p>
<b><code>api_token</code></b> <small>string</small> <input type="text" name="api_token" data-endpoint="DELETEuser--id-" value="{YOUR_AUTH_KEY}" data-component="query" hidden="">
<br>
</p>
<p>Authentication key.</p>
<p></p>
</form>Text Content
MENU
bash javascript php
* Introduction
* Authenticating requests
* Approvals
* Post an registration and credit limit approval.
* Update credit limit
* Undefined
* Catalogue layout management
* Post an registration and credit limit approval.
* Update
* Undefined
* Document management
* Post an registration and credit limit approval.
* PUT document/{id}
* Undefined
* Image management for Non-NAV clients
* Post an image.
* Update sort order.
* Soft delete an image.
* Update an image.
* Media management from NAV
* Post an image.
* Update sort order.
* Update an image.
* Soft delete an image.
* User management
* Post a user record
* PUT user
* Get a user record
* Undefined
* View Postman collection
* View OpenAPI spec
* Documentation powered by Scribe ✍
* Last updated: January 17 2024
INTRODUCTION
This documentation aims to provide all the information you need to work with our
API.
As you scroll, you'll see code examples for working with the API in different
programming languages in the dark area to the right (or as part of the content
on mobile). You can switch the language used with the tabs at the top right (or
from the nav menu at the top left on mobile).
> Base URL
http://localhost
AUTHENTICATING REQUESTS
This API is authenticated by sending a query parameter api_token in the request.
All authenticated endpoints are marked with a requires authentication badge in
the documentation below.
You can retrieve your token by request to devops@auctionmarketer.co.uk.
APPROVALS
APIs for post an registration and credit limit approval
POST AN REGISTRATION AND CREDIT LIMIT APPROVAL.
requires authentication
This endpoint allows you to update a user's credit limit in the AM system.
> Example request:
curl --request POST \
"http://localhost/approval?api_token=%7BYOUR_AUTH_KEY%7D&websiteId=dicta&creditLimit=299118929.75067®isterApproval=asperiores" \
--header "Content-Type: application/xml" \
--header "Accept: application/json"
const url = new URL(
"http://localhost/approval"
);
const params = {
"api_token": "{YOUR_AUTH_KEY}",
"websiteId": "dicta",
"creditLimit": "299118929.75067",
"registerApproval": "asperiores",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Content-Type": "application/xml",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->post(
'http://localhost/approval',
[
'headers' => [
'Content-Type' => 'application/xml',
'Accept' => 'application/json',
],
'query' => [
'api_token'=> '{YOUR_AUTH_KEY}',
'websiteId'=> 'dicta',
'creditLimit'=> '299118929.75067',
'registerApproval'=> 'asperiores',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
> Received response:
> Request failed with error:
REQUEST TRY IT OUT ⚡ CANCEL 🛑 SEND REQUEST 💥
POST approval
QUERY PARAMETERS
api_token string
Authentication key.
websiteId string
* it has to be an existing user in am_users and am_field_values (for credit
limit field)
creditLimit number
registerApproval string
UPDATE CREDIT LIMIT
requires authentication
This endpoint allows you to update a user's credit limit in the AM system.
> Example request:
curl --request PUT \
"http://localhost/approval/aut?api_token=%7BYOUR_AUTH_KEY%7D" \
--header "Content-Type: application/xml" \
--header "Accept: application/json"
const url = new URL(
"http://localhost/approval/aut"
);
const params = {
"api_token": "{YOUR_AUTH_KEY}",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Content-Type": "application/xml",
"Accept": "application/json",
};
fetch(url, {
method: "PUT",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->put(
'http://localhost/approval/aut',
[
'headers' => [
'Content-Type' => 'application/xml',
'Accept' => 'application/json',
],
'query' => [
'api_token'=> '{YOUR_AUTH_KEY}',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
> Received response:
> Request failed with error:
REQUEST TRY IT OUT ⚡ CANCEL 🛑 SEND REQUEST 💥
PUT approval/{id}
URL PARAMETERS
id string
QUERY PARAMETERS
api_token string
Authentication key.
UNDEFINED
requires authentication
> Example request:
curl --request DELETE \
"http://localhost/approval/praesentium?api_token=%7BYOUR_AUTH_KEY%7D" \
--header "Content-Type: application/xml" \
--header "Accept: application/json"
const url = new URL(
"http://localhost/approval/praesentium"
);
const params = {
"api_token": "{YOUR_AUTH_KEY}",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Content-Type": "application/xml",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->delete(
'http://localhost/approval/praesentium',
[
'headers' => [
'Content-Type' => 'application/xml',
'Accept' => 'application/json',
],
'query' => [
'api_token'=> '{YOUR_AUTH_KEY}',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
> Received response:
> Request failed with error:
REQUEST TRY IT OUT ⚡ CANCEL 🛑 SEND REQUEST 💥
DELETE approval/{id}
URL PARAMETERS
id string
QUERY PARAMETERS
api_token string
Authentication key.
CATALOGUE LAYOUT MANAGEMENT
APIs for managing catalogue layouts
POST AN REGISTRATION AND CREDIT LIMIT APPROVAL.
requires authentication
This endpoint allows you to update a user's credit limit in the AM system.
> Example request:
curl --request POST \
"http://localhost/catalogue_layout?api_token=%7BYOUR_AUTH_KEY%7D&websiteId=earum&creditLimit=4084.72196®isterApproval=occaecati" \
--header "Content-Type: application/xml" \
--header "Accept: application/json"
const url = new URL(
"http://localhost/catalogue_layout"
);
const params = {
"api_token": "{YOUR_AUTH_KEY}",
"websiteId": "earum",
"creditLimit": "4084.72196",
"registerApproval": "occaecati",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Content-Type": "application/xml",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->post(
'http://localhost/catalogue_layout',
[
'headers' => [
'Content-Type' => 'application/xml',
'Accept' => 'application/json',
],
'query' => [
'api_token'=> '{YOUR_AUTH_KEY}',
'websiteId'=> 'earum',
'creditLimit'=> '4084.72196',
'registerApproval'=> 'occaecati',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
> Received response:
> Request failed with error:
REQUEST TRY IT OUT ⚡ CANCEL 🛑 SEND REQUEST 💥
POST catalogue_layout
QUERY PARAMETERS
api_token string
Authentication key.
websiteId string
* it has to be an existing user in am_users and am_field_values (for credit
limit field)
creditLimit number
registerApproval string
UPDATE
requires authentication
> Example request:
curl --request PUT \
"http://localhost/catalogue_layout/sed?api_token=%7BYOUR_AUTH_KEY%7D" \
--header "Content-Type: application/xml" \
--header "Accept: application/json"
const url = new URL(
"http://localhost/catalogue_layout/sed"
);
const params = {
"api_token": "{YOUR_AUTH_KEY}",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Content-Type": "application/xml",
"Accept": "application/json",
};
fetch(url, {
method: "PUT",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->put(
'http://localhost/catalogue_layout/sed',
[
'headers' => [
'Content-Type' => 'application/xml',
'Accept' => 'application/json',
],
'query' => [
'api_token'=> '{YOUR_AUTH_KEY}',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
> Received response:
> Request failed with error:
REQUEST TRY IT OUT ⚡ CANCEL 🛑 SEND REQUEST 💥
PUT catalogue_layout/{id}
URL PARAMETERS
id string
QUERY PARAMETERS
api_token string
Authentication key.
UNDEFINED
requires authentication
> Example request:
curl --request DELETE \
"http://localhost/catalogue_layout/repellendus?api_token=%7BYOUR_AUTH_KEY%7D" \
--header "Content-Type: application/xml" \
--header "Accept: application/json"
const url = new URL(
"http://localhost/catalogue_layout/repellendus"
);
const params = {
"api_token": "{YOUR_AUTH_KEY}",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Content-Type": "application/xml",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->delete(
'http://localhost/catalogue_layout/repellendus',
[
'headers' => [
'Content-Type' => 'application/xml',
'Accept' => 'application/json',
],
'query' => [
'api_token'=> '{YOUR_AUTH_KEY}',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
> Received response:
> Request failed with error:
REQUEST TRY IT OUT ⚡ CANCEL 🛑 SEND REQUEST 💥
DELETE catalogue_layout/{id}
URL PARAMETERS
id string
QUERY PARAMETERS
api_token string
Authentication key.
DOCUMENT MANAGEMENT
APIs for managing documents
POST AN REGISTRATION AND CREDIT LIMIT APPROVAL.
requires authentication
This endpoint allows you to update a user's credit limit in the AM system.
> Example request:
curl --request POST \
"http://localhost/document?api_token=%7BYOUR_AUTH_KEY%7D&websiteId=sit&creditLimit=3.512129899®isterApproval=a" \
--header "Content-Type: application/xml" \
--header "Accept: application/json"
const url = new URL(
"http://localhost/document"
);
const params = {
"api_token": "{YOUR_AUTH_KEY}",
"websiteId": "sit",
"creditLimit": "3.512129899",
"registerApproval": "a",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Content-Type": "application/xml",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->post(
'http://localhost/document',
[
'headers' => [
'Content-Type' => 'application/xml',
'Accept' => 'application/json',
],
'query' => [
'api_token'=> '{YOUR_AUTH_KEY}',
'websiteId'=> 'sit',
'creditLimit'=> '3.512129899',
'registerApproval'=> 'a',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
> Received response:
> Request failed with error:
REQUEST TRY IT OUT ⚡ CANCEL 🛑 SEND REQUEST 💥
POST document
QUERY PARAMETERS
api_token string
Authentication key.
websiteId string
* it has to be an existing user in am_users and am_field_values (for credit
limit field)
creditLimit number
registerApproval string
PUT DOCUMENT/{ID}
requires authentication
> Example request:
curl --request PUT \
"http://localhost/document/architecto?api_token=%7BYOUR_AUTH_KEY%7D" \
--header "Content-Type: application/xml" \
--header "Accept: application/json"
const url = new URL(
"http://localhost/document/architecto"
);
const params = {
"api_token": "{YOUR_AUTH_KEY}",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Content-Type": "application/xml",
"Accept": "application/json",
};
fetch(url, {
method: "PUT",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->put(
'http://localhost/document/architecto',
[
'headers' => [
'Content-Type' => 'application/xml',
'Accept' => 'application/json',
],
'query' => [
'api_token'=> '{YOUR_AUTH_KEY}',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
> Received response:
> Request failed with error:
REQUEST TRY IT OUT ⚡ CANCEL 🛑 SEND REQUEST 💥
PUT document/{id}
URL PARAMETERS
id string
QUERY PARAMETERS
api_token string
Authentication key.
UNDEFINED
requires authentication
> Example request:
curl --request DELETE \
"http://localhost/document/qui?api_token=%7BYOUR_AUTH_KEY%7D" \
--header "Content-Type: application/xml" \
--header "Accept: application/json"
const url = new URL(
"http://localhost/document/qui"
);
const params = {
"api_token": "{YOUR_AUTH_KEY}",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Content-Type": "application/xml",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->delete(
'http://localhost/document/qui',
[
'headers' => [
'Content-Type' => 'application/xml',
'Accept' => 'application/json',
],
'query' => [
'api_token'=> '{YOUR_AUTH_KEY}',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
> Received response:
> Request failed with error:
REQUEST TRY IT OUT ⚡ CANCEL 🛑 SEND REQUEST 💥
DELETE document/{id}
URL PARAMETERS
id string
QUERY PARAMETERS
api_token string
Authentication key.
IMAGE MANAGEMENT FOR NON-NAV CLIENTS
APIs for managing images
POST AN IMAGE.
requires authentication
This endpoint allows you to add an image to the AM system linked to a lot.
The relatedSystemId has to be an existing lot in the db
> Example request:
curl --request POST \
"http://localhost/image?api_token=%7BYOUR_AUTH_KEY%7D&lot_id=hic&sort_no=suscipit&media_type=10837460.82&image=et" \
--header "Content-Type: multipart/form-data" \
--header "Accept: application/json" \
--form "lot_id=109366.96487519" \
--form "sort_no=522739287.917" \
--form "image=@/tmp/phpY6WTCH"
const url = new URL(
"http://localhost/image"
);
const params = {
"api_token": "{YOUR_AUTH_KEY}",
"lot_id": "hic",
"sort_no": "suscipit",
"media_type": "10837460.82",
"image": "et",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Content-Type": "multipart/form-data",
"Accept": "application/json",
};
const body = new FormData();
body.append('lot_id', '109366.96487519');
body.append('sort_no', '522739287.917');
body.append('image', document.querySelector('input[name="image"]').files[0]);
fetch(url, {
method: "POST",
headers,
body,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->post(
'http://localhost/image',
[
'headers' => [
'Content-Type' => 'multipart/form-data',
'Accept' => 'application/json',
],
'query' => [
'api_token'=> '{YOUR_AUTH_KEY}',
'lot_id'=> 'hic',
'sort_no'=> 'suscipit',
'media_type'=> '10837460.82',
'image'=> 'et',
],
'multipart' => [
[
'name' => 'lot_id',
'contents' => '109366.96487519'
],
[
'name' => 'sort_no',
'contents' => '522739287.917'
],
[
'name' => 'image',
'contents' => fopen('/tmp/phpY6WTCH', 'r')
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
> Received response:
> Request failed with error:
REQUEST TRY IT OUT ⚡ CANCEL 🛑 SEND REQUEST 💥
POST image
QUERY PARAMETERS
api_token string
Authentication key.
lot_id string
sort_no string
media_type number
image string
BODY PARAMETERS
lot_id number
sort_no number
image file
Must be an image. Must not be greater than 50000000 kilobytes.
UPDATE SORT ORDER.
requires authentication
This endpoint allows to bulk update the sort order of images in the AM system.
The SystemId has to be an existing entry in the db
> Example request:
curl --request POST \
"http://localhost/image/sort?api_token=%7BYOUR_AUTH_KEY%7D&imageId=adipisci&ordering=73158163.349" \
--header "Content-Type: application/xml" \
--header "Accept: application/json"
const url = new URL(
"http://localhost/image/sort"
);
const params = {
"api_token": "{YOUR_AUTH_KEY}",
"imageId": "adipisci",
"ordering": "73158163.349",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Content-Type": "application/xml",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->post(
'http://localhost/image/sort',
[
'headers' => [
'Content-Type' => 'application/xml',
'Accept' => 'application/json',
],
'query' => [
'api_token'=> '{YOUR_AUTH_KEY}',
'imageId'=> 'adipisci',
'ordering'=> '73158163.349',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
> Received response:
> Request failed with error:
REQUEST TRY IT OUT ⚡ CANCEL 🛑 SEND REQUEST 💥
POST image/sort
QUERY PARAMETERS
api_token string
Authentication key.
imageId string
ordering number
SOFT DELETE AN IMAGE.
requires authentication
This endpoint allows you to soft delete an image in the AM system.
> Example request:
curl --request DELETE \
"http://localhost/image/quasi?api_token=%7BYOUR_AUTH_KEY%7D" \
--header "Content-Type: application/xml" \
--header "Accept: application/json"
const url = new URL(
"http://localhost/image/quasi"
);
const params = {
"api_token": "{YOUR_AUTH_KEY}",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Content-Type": "application/xml",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->delete(
'http://localhost/image/quasi',
[
'headers' => [
'Content-Type' => 'application/xml',
'Accept' => 'application/json',
],
'query' => [
'api_token'=> '{YOUR_AUTH_KEY}',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
> Received response:
> Request failed with error:
REQUEST TRY IT OUT ⚡ CANCEL 🛑 SEND REQUEST 💥
DELETE image/{id}
URL PARAMETERS
id string
QUERY PARAMETERS
api_token string
Authentication key.
UPDATE AN IMAGE.
requires authentication
This endpoint allows you to update an image in the AM system.
> Example request:
curl --request POST \
"http://localhost/image/sint?api_token=%7BYOUR_AUTH_KEY%7D" \
--header "Content-Type: multipart/form-data" \
--header "Accept: application/json" \
--form "lot_id=659.04728626" \
--form "sort_no=54108" \
--form "image=@/tmp/phpCOFK2Z"
const url = new URL(
"http://localhost/image/sint"
);
const params = {
"api_token": "{YOUR_AUTH_KEY}",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Content-Type": "multipart/form-data",
"Accept": "application/json",
};
const body = new FormData();
body.append('lot_id', '659.04728626');
body.append('sort_no', '54108');
body.append('image', document.querySelector('input[name="image"]').files[0]);
fetch(url, {
method: "POST",
headers,
body,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->post(
'http://localhost/image/sint',
[
'headers' => [
'Content-Type' => 'multipart/form-data',
'Accept' => 'application/json',
],
'query' => [
'api_token'=> '{YOUR_AUTH_KEY}',
],
'multipart' => [
[
'name' => 'lot_id',
'contents' => '659.04728626'
],
[
'name' => 'sort_no',
'contents' => '54108'
],
[
'name' => 'image',
'contents' => fopen('/tmp/phpCOFK2Z', 'r')
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
> Received response:
> Request failed with error:
REQUEST TRY IT OUT ⚡ CANCEL 🛑 SEND REQUEST 💥
POST image/{id}
URL PARAMETERS
id string
QUERY PARAMETERS
api_token string
Authentication key.
BODY PARAMETERS
lot_id number
sort_no number
image file optional
Must be an image. Must not be greater than 50000000 kilobytes.
MEDIA MANAGEMENT FROM NAV
APIs for managing media from NAV
POST AN IMAGE.
requires authentication
This endpoint allows you to add an image to the AM system linked to a lot.
The relatedSystemId has to be an existing lot in the db
> Example request:
curl --request POST \
"http://localhost/media?api_token=%7BYOUR_AUTH_KEY%7D&systemId=qui&tableNo=13123.9&relatedSystemId=ducimus&entryNo=0&storageType=rerum&sortNo=1873.23686483&mediaType=dolore&publicMediaPath=perspiciatis&code=quidem&filename=aut" \
--header "Content-Type: application/xml" \
--header "Accept: application/json"
const url = new URL(
"http://localhost/media"
);
const params = {
"api_token": "{YOUR_AUTH_KEY}",
"systemId": "qui",
"tableNo": "13123.9",
"relatedSystemId": "ducimus",
"entryNo": "0",
"storageType": "rerum",
"sortNo": "1873.23686483",
"mediaType": "dolore",
"publicMediaPath": "perspiciatis",
"code": "quidem",
"filename": "aut",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Content-Type": "application/xml",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->post(
'http://localhost/media',
[
'headers' => [
'Content-Type' => 'application/xml',
'Accept' => 'application/json',
],
'query' => [
'api_token'=> '{YOUR_AUTH_KEY}',
'systemId'=> 'qui',
'tableNo'=> '13123.9',
'relatedSystemId'=> 'ducimus',
'entryNo'=> '0',
'storageType'=> 'rerum',
'sortNo'=> '1873.23686483',
'mediaType'=> 'dolore',
'publicMediaPath'=> 'perspiciatis',
'code'=> 'quidem',
'filename'=> 'aut',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
> Received response:
> Request failed with error:
REQUEST TRY IT OUT ⚡ CANCEL 🛑 SEND REQUEST 💥
POST media
QUERY PARAMETERS
api_token string
Authentication key.
systemId string
tableNo number
relatedSystemId string
It has to be an existing lot in the db
entryNo number
storageType string
sortNo number
mediaType string
publicMediaPath string
An active url
code string
filename string
UPDATE SORT ORDER.
requires authentication
This endpoint allows to bulk update the sort order of images in the AM system.
The SystemId has to be an existing entry in the db
> Example request:
curl --request POST \
"http://localhost/media/sort?api_token=%7BYOUR_AUTH_KEY%7D&systemId=qui&sortNo=330070.894" \
--header "Content-Type: application/xml" \
--header "Accept: application/json"
const url = new URL(
"http://localhost/media/sort"
);
const params = {
"api_token": "{YOUR_AUTH_KEY}",
"systemId": "qui",
"sortNo": "330070.894",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Content-Type": "application/xml",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->post(
'http://localhost/media/sort',
[
'headers' => [
'Content-Type' => 'application/xml',
'Accept' => 'application/json',
],
'query' => [
'api_token'=> '{YOUR_AUTH_KEY}',
'systemId'=> 'qui',
'sortNo'=> '330070.894',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
> Received response:
> Request failed with error:
REQUEST TRY IT OUT ⚡ CANCEL 🛑 SEND REQUEST 💥
POST media/sort
QUERY PARAMETERS
api_token string
Authentication key.
systemId string
sortNo number
UPDATE AN IMAGE.
requires authentication
This endpoint allows you to update an image in the AM system.
> Example request:
curl --request PUT \
"http://localhost/media/distinctio?api_token=%7BYOUR_AUTH_KEY%7D" \
--header "Content-Type: application/xml" \
--header "Accept: application/json"
const url = new URL(
"http://localhost/media/distinctio"
);
const params = {
"api_token": "{YOUR_AUTH_KEY}",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Content-Type": "application/xml",
"Accept": "application/json",
};
fetch(url, {
method: "PUT",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->put(
'http://localhost/media/distinctio',
[
'headers' => [
'Content-Type' => 'application/xml',
'Accept' => 'application/json',
],
'query' => [
'api_token'=> '{YOUR_AUTH_KEY}',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
> Received response:
> Request failed with error:
REQUEST TRY IT OUT ⚡ CANCEL 🛑 SEND REQUEST 💥
PUT media/{id}
URL PARAMETERS
id string
QUERY PARAMETERS
api_token string
Authentication key.
SOFT DELETE AN IMAGE.
requires authentication
This endpoint allows you to soft delete an image in the AM system.
> Example request:
curl --request DELETE \
"http://localhost/media/vero?api_token=%7BYOUR_AUTH_KEY%7D" \
--header "Content-Type: application/xml" \
--header "Accept: application/json"
const url = new URL(
"http://localhost/media/vero"
);
const params = {
"api_token": "{YOUR_AUTH_KEY}",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Content-Type": "application/xml",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->delete(
'http://localhost/media/vero',
[
'headers' => [
'Content-Type' => 'application/xml',
'Accept' => 'application/json',
],
'query' => [
'api_token'=> '{YOUR_AUTH_KEY}',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
> Received response:
> Request failed with error:
REQUEST TRY IT OUT ⚡ CANCEL 🛑 SEND REQUEST 💥
DELETE media/{id}
URL PARAMETERS
id string
QUERY PARAMETERS
api_token string
Authentication key.
USER MANAGEMENT
APIs for managing images
POST A USER RECORD
requires authentication
This endpoint allows you to create a new AM user record or update an existing
one
> Example request:
curl --request POST \
"http://localhost/user?api_token=%7BYOUR_AUTH_KEY%7D" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
const url = new URL(
"http://localhost/user"
);
const params = {
"api_token": "{YOUR_AUTH_KEY}",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->post(
'http://localhost/user',
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'api_token'=> '{YOUR_AUTH_KEY}',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
> Received response:
> Request failed with error:
REQUEST TRY IT OUT ⚡ CANCEL 🛑 SEND REQUEST 💥
POST user
QUERY PARAMETERS
api_token string
Authentication key.
PUT USER
requires authentication
> Example request:
curl --request PUT \
"http://localhost/user?api_token=%7BYOUR_AUTH_KEY%7D" \
--header "Content-Type: application/xml" \
--header "Accept: application/json" \
--data "{
\"websiteID\": 630043.5,
\"customerNo\": \"et\",
\"vendorNo\": \"iste\",
\"firstName\": \"placeat\",
\"middleName\": \"optio\",
\"surname\": \"ut\",
\"companyName\": \"dolore\",
\"email\": \"aut\",
\"address\": \"dolores\",
\"address2\": \"iure\",
\"city\": \"ipsa\",
\"county\": \"occaecati\",
\"postCode\": \"illo\",
\"country\": \"perspiciatis\",
\"phoneNo\": \"quam\",
\"mobileNo\": \"quae\",
\"vatNo\": \"quia\",
\"accountType\": \"officiis\",
\"blocked\": false
}"
const url = new URL(
"http://localhost/user"
);
const params = {
"api_token": "{YOUR_AUTH_KEY}",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Content-Type": "application/xml",
"Accept": "application/json",
};
let body = {
"websiteID": 630043.5,
"customerNo": "et",
"vendorNo": "iste",
"firstName": "placeat",
"middleName": "optio",
"surname": "ut",
"companyName": "dolore",
"email": "aut",
"address": "dolores",
"address2": "iure",
"city": "ipsa",
"county": "occaecati",
"postCode": "illo",
"country": "perspiciatis",
"phoneNo": "quam",
"mobileNo": "quae",
"vatNo": "quia",
"accountType": "officiis",
"blocked": false
};
fetch(url, {
method: "PUT",
headers,
body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->put(
'http://localhost/user',
[
'headers' => [
'Content-Type' => 'application/xml',
'Accept' => 'application/json',
],
'query' => [
'api_token'=> '{YOUR_AUTH_KEY}',
],
'json' => [
'websiteID' => 630043.5,
'customerNo' => 'et',
'vendorNo' => 'iste',
'firstName' => 'placeat',
'middleName' => 'optio',
'surname' => 'ut',
'companyName' => 'dolore',
'email' => 'aut',
'address' => 'dolores',
'address2' => 'iure',
'city' => 'ipsa',
'county' => 'occaecati',
'postCode' => 'illo',
'country' => 'perspiciatis',
'phoneNo' => 'quam',
'mobileNo' => 'quae',
'vatNo' => 'quia',
'accountType' => 'officiis',
'blocked' => false,
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
> Received response:
> Request failed with error:
REQUEST TRY IT OUT ⚡ CANCEL 🛑 SEND REQUEST 💥
PUT user
QUERY PARAMETERS
api_token string
Authentication key.
BODY PARAMETERS
websiteID number
customerNo string optional
vendorNo string optional
firstName string optional
middleName string optional
surname string optional
companyName string optional
email string
address string optional
address2 string optional
city string optional
county string optional
postCode string optional
country string optional
phoneNo string optional
mobileNo string optional
vatNo string optional
accountType string optional
blocked boolean optional true false
GET A USER RECORD
requires authentication
This endpoint allows you to get AM user record details via the email address
> Example request:
curl --request GET \
--get "http://localhost/user?api_token=%7BYOUR_AUTH_KEY%7D" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"email\": \"quam\"
}"
const url = new URL(
"http://localhost/user"
);
const params = {
"api_token": "{YOUR_AUTH_KEY}",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"email": "quam"
};
fetch(url, {
method: "GET",
headers,
body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
'http://localhost/user',
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'api_token'=> '{YOUR_AUTH_KEY}',
],
'json' => [
'email' => 'quam',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
> Example response (500):
Show headers
cache-control: no-cache, private
content-type: application/json
{
"message": "Server Error"
}
> Received response:
> Request failed with error:
REQUEST TRY IT OUT ⚡ CANCEL 🛑 SEND REQUEST 💥
GET user
QUERY PARAMETERS
api_token string
Authentication key.
BODY PARAMETERS
email string
UNDEFINED
requires authentication
> Example request:
curl --request DELETE \
"http://localhost/user/sit?api_token=%7BYOUR_AUTH_KEY%7D" \
--header "Content-Type: application/xml" \
--header "Accept: application/json"
const url = new URL(
"http://localhost/user/sit"
);
const params = {
"api_token": "{YOUR_AUTH_KEY}",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Content-Type": "application/xml",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->delete(
'http://localhost/user/sit',
[
'headers' => [
'Content-Type' => 'application/xml',
'Accept' => 'application/json',
],
'query' => [
'api_token'=> '{YOUR_AUTH_KEY}',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
> Received response:
> Request failed with error:
REQUEST TRY IT OUT ⚡ CANCEL 🛑 SEND REQUEST 💥
DELETE user/{id}
URL PARAMETERS
id string
QUERY PARAMETERS
api_token string
Authentication key.
bash javascript php