pixiSupplierOrderLineLocQtyGet

Wrapper around the internal procedure pixi.SupplierOrderLineLocQtyGet. It returns location quantity data (quantities per location) for supplier order lines.

Steps:

Opens its own transaction, or sets a savepoint if the caller already has an open transaction.
Calls pixi.SupplierOrderLineLocQtyGet, passing the parameters this way:
- SupplierOrderIds → @SoIds
- SupplierOrderLinesIds → @SolIds
- SupplierOrderLinesLocQtyIds → @SolLocQtyIds
Returns the result sets of that procedure unchanged to the caller, then commits its own transaction.

If an error occurs, the transaction or savepoint is rolled back and a single row with ReturnCode = ERROR and the SQL error text in ErrorMessage is returned.

AppName is required but is not used by the code.

Notes

The definition of pixi.SupplierOrderLineLocQtyGet is not available. The following points therefore cannot be derived from the code:
- the format of the ID lists (probably comma-separated keys, not confirmed);
- how the three filters are combined;
- what happens when all filters are empty;
- the columns, sort order and number of result sets returned.
The call runs inside a transaction (or savepoint) although it is a read call; the actual reads happen in the inner procedure.
If the inner procedure fails after it has already returned rows, the caller may receive those rows followed by the error row.

Parameter	Type	Default	Description
`AppName` Required	varchar(255) string	–	Name of the calling application. Required, but not used by the code. Example: `MyShopConnector`
`SupplierOrderIds`	varchar(8000) string	–	List of supplier order IDs, passed as `@SoIds` to `pixi.SupplierOrderLineLocQtyGet`. The list format is defined by that procedure, whose code is not available. Example: `1001,1002`
`SupplierOrderLinesIds`	varchar(8000) string	–	List of supplier order line IDs, passed as `@SolIds` to the inner procedure. Example: `50231,50232`
`SupplierOrderLinesLocQtyIds`	varchar(8000) string	–	List of IDs of supplier order line location quantity records, passed as `@SolLocQtyIds` to the inner procedure.

Result set 1 · On success; returned by the inner procedure `pixi.SupplierOrderLineLocQtyGet`.

Location quantity data of the selected supplier order lines. Columns and number of result sets are defined by pixi.SupplierOrderLineLocQtyGet, whose code is not available.

Result set 2 · If an error occurs.

Error row.

Column	Type	Description
`ReturnCode`	varchar(5) string	Always `ERROR`.
`ErrorMessage` Nullable	nvarchar(4000) string	Text of the SQL error (`ERROR_MESSAGE()`).

Status	Message	Cause
ERROR	{ERROR_MESSAGE()}	Any SQL error raised while `pixi.SupplierOrderLineLocQtyGet` runs, for example because of malformed ID lists. The transaction is rolled back and the original error text is returned. Pass well-formed ID lists to avoid it.

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:pixiSupplierOrderLineLocQtyGet>
      <AppName>MyShopConnector</AppName>
      <!-- <SupplierOrderIds>1001,1002</SupplierOrderIds> -->
      <!-- <SupplierOrderLinesIds>50231,50232</SupplierOrderLinesIds> -->
      <!-- <SupplierOrderLinesLocQtyIds>?</SupplierOrderLinesLocQtyIds> -->
    </ns1:pixiSupplierOrderLineLocQtyGet>
  </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:pixiSupplierOrderLineLocQtyGet>
      <AppName>MyShopConnector</AppName>
      <!-- <SupplierOrderIds>1001,1002</SupplierOrderIds> -->
      <!-- <SupplierOrderLinesIds>50231,50232</SupplierOrderLinesIds> -->
      <!-- <SupplierOrderLinesLocQtyIds>?</SupplierOrderLinesLocQtyIds> -->
    </ns1:pixiSupplierOrderLineLocQtyGet>
  </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 = [
    'AppName' => 'MyShopConnector',
    // 'SupplierOrderIds' => '1001,1002',
    // 'SupplierOrderLinesIds' => '50231,50232',
    // 'SupplierOrderLinesLocQtyIds' => '?',
];

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

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

Notes

Result set 1 · On success; returned by the inner procedure pixi.SupplierOrderLineLocQtyGet.

Result set 2 · If an error occurs.

Result set 1 · On success; returned by the inner procedure `pixi.SupplierOrderLineLocQtyGet`.