pixiImportProcessXML · Pixi API documentation

Triggers the processing of one imported XML, identified by XMLLogKey, right away.

Validation: the XML must exist in C_XMLLog, its operation type (C_OperationTypes.OperationType) must be ItemImport or OrderImport, and its Status must be one of COC, ERR, NEI, XER, XIM or XPA. Otherwise a status row with ReturnCode = ERROR API is returned.
Item XML (ItemImport):
- If the application lock PixiItemImport is currently held (the item import agent job is running), only the parse step Pixi_C_ParseAndCheckXMLsFromItemImport is executed for this XML, and the call ends with an ERROR API row saying the XML is already in process and has been parsed.
- Otherwise the call takes the lock itself, runs the parse/check step and then Pixi_C_ApplyItemsToMainTables for this XML, and releases the lock.
Order XML (OrderImport): same logic with lock PixiOrderImport, the parse step Pixi_C_ParseAndCheckXMLsFromOrderImport and the apply step Pixi_C_ApplyOrdersToMainTables.
At the end a status row with ReturnCode = OK is returned.

All called procedures run with the user name API.

Because the called procedures return their own rows, the caller receives several result sets: the Success row of the parse step, possibly rows of the apply step, and finally the ReturnCode/ErrorMessage status row. Always evaluate the last result set for the outcome.

Notes

Errors in parse/apply are swallowed: the parse and apply steps run in an inner TRY/CATCH that only releases the application lock. If one of them fails, the call still returns ReturnCode = OK. Check C_XMLLog.Status/Error afterwards to verify the real result.
The informational message XML with XMLLogKey {XMLLogKey} has been processed. is raised with severity 1 and may appear as SqlMessage; it is not an error.
In the "already in process" case the XML has been parsed although ReturnCode is ERROR API.
The application locks PixiItemImport / PixiOrderImport (session owner) are shared with the SQL Agent import jobs; while the call holds the lock, the agent job cannot process at the same time.
The called procedures respect the settings C_ItemImportEnabled, C_ItemImport_ParseAndCheckData_Enabled, C_OrderImportEnabled, C_OrderImport_ParseAndCheckData_Enabled, C_OrderImport_ApplyToMainTables_Enabled and per-channel-type settings. If they are disabled, the steps do nothing, but the call still returns OK.
The parse steps only parse XMLs of channel type URL whose Error column is empty. XMLs of channel types PlentyREST or ShipRush are only reset to status XIM (with AttemptsToProcess = 0) so that the Integration Service parses them again.
The parse steps also do global work (e.g. pixi_C_UpdateXMLsAsParsed, exchange rate import for orders), and the order apply step calls Pixi_AmazonOrdersMarkOrders.
The setting C_ParseAndImportDataIntervalMinutes is read but not used.
Pixi_C_ApplyItemsToMainTables is not attached; its exact behaviour and returned rows are unknown.
Existence and status checks use NOLOCK.

Tables used

C_XMLLog · Write C_OperationTypes · Read Settings · Read C_Channels · Read C_ChannelTypes · Read C_Int_Items · Write TontrArten · Read C_Int_OrderHeader · Read C_Int_Orderlines · Read C_ConstraintCheckErrors · Read

Parameter	Type	Default	Description
`XMLLogKey` Required	int	–	Key of the imported XML in `C_XMLLog` that is to be (re-)processed. Must be an item or order import XML in status `COC`, `ERR`, `NEI`, `XER`, `XIM` or `XPA`. Example: `123456`

Result set 1 · If the XML is valid and the import parse settings are enabled (returned by the parse procedure)

Confirmation row of the parse/check step (Pixi_C_ParseAndCheckXMLsFromItemImport or Pixi_C_ParseAndCheckXMLsFromOrderImport).

Column	Type	Description
`Success`	varchar(7) string	Constant `Success`.

Result set 2 · If the lock was free and the apply step returns rows (orders: when apply settings are enabled; items: unknown)

Rows of the apply step. Pixi_C_ApplyOrdersToMainTables returns one Success row; the output of Pixi_C_ApplyItemsToMainTables is not known.

Column	Type	Description
`Success`	varchar(7) string	Constant `Success` (order apply step).

Result set 3 · Always, as the last result set

Status row with the overall result of the call.

Column	Type	Description
`ReturnCode`	varchar(9) string	`OK` on success, `ERROR API` on error.
`ErrorMessage` Nullable	nvarchar(4000) string	On success `XML with XMLLogKey {XMLLogKey} has been reprocessed.`; on error the error text followed by `-` and the name of the procedure that raised it.

Response example

<SqlRowSet1>
  <row>
    <Success>Success</Success>
  </row>
</SqlRowSet1>

Status	Message	Cause
ERROR API	XML with XMLLogKey {XMLLogKey} does not exist or has not the right status or type of XML. Only XMLs in Status COC, ERR, NEI, XER, XIM or XPA and Item / Order XMLs can be (re-)processed. - pipiImportProcessXML	The XML does not exist, is not an `ItemImport`/`OrderImport` XML, or its status is not one of the allowed values. Check the key and the status in `C_XMLLog`.
ERROR API	XML with XMLLogKey {XMLLogKey} already in process by import. Has been parsed. - pipiImportProcessXML	The import agent job (or another call) currently holds the lock `PixiItemImport` or `PixiOrderImport`. The XML was only parsed; it will be applied by the running import, or the call can be repeated later.
ERROR API	{error message} - {procedure name}	Any other SQL error outside the inner parse/apply block, e.g. an error raised by the parse procedure in the "already in process" branch or by releasing the lock.

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:pixiImportProcessXML>
      <XMLLogKey>123456</XMLLogKey>
    </ns1:pixiImportProcessXML>
  </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:pixiImportProcessXML>
      <XMLLogKey>123456</XMLLogKey>
    </ns1:pixiImportProcessXML>
  </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 = [
    'XMLLogKey' => '123456',
];

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

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