pixiSetSupplierStockMultiple

Takes a list of supplier item numbers with target quantities and tries to make the stock of the given bin match it.

The XML in Items is parsed: each /ITEMS/ITEM node gives ItemNrSuppl and Quantity.
The bin is looked up in InvBin by Location (BinLocID) and BinName. If no bin is found, a single row with Code = 500 and Message = Bin Not Found is returned and nothing else happens.
The items to change are determined:
- Items from the XML whose ItemNrSuppl matches an AddItems entry of supplier SupplNr, whose article is enabled (Items.Enabled = 1), and whose target quantity differs from the current total quantity on the bin (missing stock counts as 0).
- Items of the same supplier that currently have stock on the bin but are not listed in the XML. Their target quantity is 0, so they are meant to be cleared from the bin. The Enabled flag is not checked for these.
For every such item, pixiSetStock is executed with the article's EANUPC, the BinName, the target quantity and Username.
Finally one row per article is returned with the supplier item number and the total quantity that is now on the bin, restricted to articles that have an AddItems entry for SupplNr.

Notes

Stock is in practice not changed. A comment in the code states that the call to pixiSetStock always fails because no SMORef is passed. pixiSetStock raises Error Message: API pipiSetStockMultiple: SMO is not assigned to API! whenever SMORef is NULL, writes an entry to LogTable and re-raises the error. The outer procedure has no error handling, so it continues with the next item and the error messages reach the caller as SqlMessage entries next to the final result set.
If the setting API_Stock_Movements is disabled, pixiSetStock returns an extra status row (Status/StatusMessage) for every item to change instead of raising an error. These rows arrive as additional result sets before the final stock list, which shifts the numbering of SqlRowSet.
pixiSetStock is called without a location. It looks up the bin by BinName only, so if the same bin name exists in several locations, a different bin than the one checked here may be used.
Articles are passed to pixiSetStock by EANUPC. Articles without an EAN or with a duplicate EAN cannot be addressed reliably.
If any ITEM in the XML has no ItemNrSuppl, the NOT IN check returns no rows, so no items are cleared from the bin.
Items whose Quantity is missing or not numeric are ignored for the update.
All reads use NOLOCK. There is no transaction around the loop.

pixiSetStock

Tables used

InvBin · Read InvBinItem · Read AddItems · Read Items · Read LogTable · Write

Parameter	Type	Default	Description
`Items` Required	xml	–	List of supplier item numbers with target quantities for the bin. Root `ITEMS`, one `ITEM` per article with `ItemNrSuppl` and `Quantity` (integer). Example: `<ITEMS> <ITEM> <ItemNrSuppl>mad566</ItemNrSuppl> <Quantity>50</Quantity> </ITEM> <ITEM> <ItemNrSuppl>mad602</ItemNrSuppl> <Quantity>30</Quantity> </ITEM> </ITEMS>`
`SupplNr`	varchar(4) string	MGS	Supplier number (`AddItems.SupplNr`) used to resolve the supplier item numbers and to restrict the items on the bin. Example: `MGS`
`Location`	varchar(3) string	001	Location ID (`InvBin.BinLocID`) used to find the bin. It is not passed on to `pixiSetStock`. Example: `001`
`BinName` Required	varchar(50) string	–	Name of the bin (`InvBin.BinName`) whose stock is synchronised. Example: `A-10-A-1`
`Username`	varchar(50) string	pipiSetSupplierStockMultiple	User name passed to `pixiSetStock` for the stock movements. Example: `shopsync`

Result set 1 · If the bin was found (after all item updates have been attempted).

Current stock on the bin, one row per article that has an AddItems entry for SupplNr.

Column	Type	Description
`ItemNrSuppl` Nullable	string	Supplier item number of the article (`MAX(AddItems.ItemNrSuppl)` per article).
`Quantity` Nullable	int	Total quantity of the article on the bin (`SUM(InvBinItem.BinItemQTY)`).

Result set 2 · If no bin with `BinName` exists in `Location`.

Error row. No stock is processed.

Column	Type	Description
`Code`	varchar(3) string	Always `500`.
`Message`	varchar(13) string	Always `Bin Not Found`.

Result set 3 · Once per item to change, before the stock list, if the setting `API_Stock_Movements` is disabled (returned by `pixiSetStock`).

Status row of the nested pixiSetStock call reporting that API stock movements are disabled.

Column	Type	Description
`Status`	varchar(5) string	Always `ERROR`.
`StatusMessage`	varchar(73) string	Error text about the disabled setting.

Response example

<SqlRowSet1>
  <row>
    <ItemNrSuppl>mad566</ItemNrSuppl>
    <Quantity>50</Quantity>
  </row>
  <row>
    <ItemNrSuppl>mad602</ItemNrSuppl>
    <Quantity>30</Quantity>
  </row>
</SqlRowSet1>

Status	Message	Cause
500	Bin Not Found	No bin with the given `BinName` exists in `Location`. Check the bin name and location ID.
ERROR	Setting "API Calls Stock Movements" (API_Stock_Movements) is not enabled.	Returned by the nested `pixiSetStock` call for each item to change when the setting `API_Stock_Movements` is disabled. Enable the setting in Pixi.
RAISERROR	Error Message: API pipiSetStockMultiple: SMO is not assigned to API!	Raised by the nested `pixiSetStock` call for each item to change when the setting is enabled, because this procedure never passes an `SMORef`. The error is logged to `LogTable`. It cannot be avoided through this call; use `pixiSetStock` directly with a valid `SMORef` instead.

POST https://apigateway.descartes.com/tms/pixi/
Content-Type: text/xml; charset=utf-8
Authorization: Basic BASE64(USERNAME:PASSWORD)

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://apigateway.descartes.com/tms/pixi/">
  <SOAP-ENV:Body>
    <ns1:pixiSetSupplierStockMultiple>
      <Items><![CDATA[<ITEMS><ITEM><ItemNrSuppl>mad566</ItemNrSuppl><Quantity>50</Quantity></ITEM><ITEM><ItemNrSuppl>mad602</ItemNrSuppl><Quantity>30</Quantity></ITEM></ITEMS>]]></Items>
      <!-- <SupplNr>MGS</SupplNr> -->
      <!-- <Location>001</Location> -->
      <BinName>A-10-A-1</BinName>
      <!-- <Username>shopsync</Username> -->
    </ns1:pixiSetSupplierStockMultiple>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

curl -X POST 'https://apigateway.descartes.com/tms/pixi/' \
  --user 'USERNAME:PASSWORD' \
  --header 'Content-Type: text/xml; charset=utf-8' \
  --data-binary @- <<'XML'
<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://apigateway.descartes.com/tms/pixi/">
  <SOAP-ENV:Body>
    <ns1:pixiSetSupplierStockMultiple>
      <Items><![CDATA[<ITEMS><ITEM><ItemNrSuppl>mad566</ItemNrSuppl><Quantity>50</Quantity></ITEM><ITEM><ItemNrSuppl>mad602</ItemNrSuppl><Quantity>30</Quantity></ITEM></ITEMS>]]></Items>
      <!-- <SupplNr>MGS</SupplNr> -->
      <!-- <Location>001</Location> -->
      <BinName>A-10-A-1</BinName>
      <!-- <Username>shopsync</Username> -->
    </ns1:pixiSetSupplierStockMultiple>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
XML

<?php

$soapClient = new SoapClient(null, [
    'login' => 'USERNAME',
    'password' => 'PASSWORD',
    'location' => 'https://apigateway.descartes.com/tms/pixi/',
    'uri' => 'https://apigateway.descartes.com/tms/pixi/',
]);

$arguments = [
    'Items' => '<ITEMS><ITEM><ItemNrSuppl>mad566</ItemNrSuppl><Quantity>50</Quantity></ITEM><ITEM><ItemNrSuppl>mad602</ItemNrSuppl><Quantity>30</Quantity></ITEM></ITEMS>',
    // 'SupplNr' => 'MGS',
    // 'Location' => '001',
    'BinName' => 'A-10-A-1',
    // 'Username' => 'shopsync',
];

$soapArguments = [];
foreach ($arguments as $name => $value) {
    $soapArguments[] = new SoapVar($value, XSD_STRING, '', '', $name);
}

$response = $soapClient->__soapCall('pixiSetSupplierStockMultiple', $soapArguments);

Notes

Related calls

Tables used

Result set 1 · If the bin was found (after all item updates have been attempted).

Result set 2 · If no bin with BinName exists in Location.

Result set 3 · Once per item to change, before the stock list, if the setting API_Stock_Movements is disabled (returned by pixiSetStock).

Response example

Result set 2 · If no bin with `BinName` exists in `Location`.

Result set 3 · Once per item to change, before the stock list, if the setting `API_Stock_Movements` is disabled (returned by `pixiSetStock`).