pixiAddOrderComment · Pixi API documentation

Writes a comment into the shop note field of an order.

The order is looked up in OrderHeader by OrderNr. If no order exists, the call returns a row with ReturnMessage = 0 and stops.
The call checks whether the order is editable. An order counts as not editable (masked) if it has an order header attribute of type 2 with value 2. For a masked order the call returns ReturnMessage = 0 and changes nothing.
Otherwise Shop_Note of the order is set to @Comment and the call returns ReturnMessage = 1.

Despite the name, the comment is not appended: the existing content of Shop_Note is replaced completely.

Notes

The existing shop note is overwritten. To keep previous text, read the current note first and send the combined text.
If Comment is NULL or omitted in the XML as nil, the note is set to an empty string (the blacklist function currently only replaces NULL with '').
ReturnMessage = 0 does not distinguish between "order not found" and "order masked".
The lookups of the order and its attributes use NOLOCK.
The update runs in its own transaction, or in a savepoint if the caller already has an open transaction. On an error the transaction is rolled back and the error is logged via log.InsertError (definition not attached); in that case no ReturnMessage row is returned by this procedure, and whether an error is passed on to the caller depends on log.InsertError.
The order lookup by OrderNr is outside the error handling; if several orders shared the same OrderNr, the subquery would fail with a SQL error.

Tables used

OrderHeader · Write OrderHeaderAttribute · Read

Parameter	Type	Default	Description
`OrderNr` Required	int	–	Order number of the order whose shop note is set. Example: `100245`
`Comment` Required	nvarchar(max) string	–	Text written into `Shop_Note`. Replaces the previous note completely; `NULL` results in an empty note. Example: `Customer requests delivery after 2 pm.`

Result set 1 · Always, unless an error occurs during the update

Single status row indicating whether the note was written.

Column	Type	Description
`ReturnMessage`	int	`1` = shop note updated; `0` = order not found or order is masked (not editable).

Response example

<SqlRowSet1>
  <row>
    <ReturnMessage>1</ReturnMessage>
  </row>
</SqlRowSet1>

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:pixiAddOrderComment>
      <OrderNr>100245</OrderNr>
      <Comment>Customer requests delivery after 2 pm.</Comment>
    </ns1:pixiAddOrderComment>
  </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:pixiAddOrderComment>
      <OrderNr>100245</OrderNr>
      <Comment>Customer requests delivery after 2 pm.</Comment>
    </ns1:pixiAddOrderComment>
  </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 = [
    'OrderNr' => '100245',
    'Comment' => 'Customer requests delivery after 2 pm.',
];

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

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