pixiOrderSetInfo

Sets informational fields in the header of an existing order.

Order lookup: The procedure searches Orderlines for rows where OrderNrExternal equals @OrderNrExternal or OrderNr equals @OrderNr, and takes the OrderNr from a matching row. If no row matches, @OrderNr keeps the value that was passed in.
Check: If there is not exactly one OrderHeader record with the resulting OrderNr, an error row with ErrorNr 404 is returned and nothing is changed.
Update: Otherwise the OrderHeader record is updated:
- SubShopName is set to @SubShopName,
- SubShopLogo is set to @SubShopLogo,
- Referrer is set to @Referrer.
A parameter that is omitted or NULL leaves the existing value unchanged. This allows partial updates.
If the update fails, an error row with ErrorNr 500 is returned.

On success the call returns no result set.

Notes

The lookup by @OrderNrExternal goes through Orderlines, not OrderHeader. An order without order lines cannot be found by its external number and returns 404. Lookup by @OrderNr alone still works in that case, because the passed value is kept.
If both @OrderNr and @OrderNrExternal are passed and they point to different orders, the code does not detect the conflict, although the error text suggests it does. The lookup then takes the OrderNr from one of the matching order lines, and the row that is used is not defined. That order is updated. Pass only one of the two identifiers.
The lookup reads with NOLOCK.
An empty string is not NULL. It overwrites the field with an empty value. Only NULL or an omitted parameter keeps the existing value.
Values longer than 50 characters can make the update fail, which returns the 500 row. Whether this happens depends on the column sizes in OrderHeader, which are not visible in the code.
The error texts mention an "invoice", but the call works on orders.
No transaction is opened explicitly. The update is a single statement.

Tables used

Orderlines · Read OrderHeader · Write

Parameter	Type	Default	Description
`OrderNr`	int	NULL	Pixi order number. Alternative to `OrderNrExternal`. Example: `123456`
`OrderNrExternal`	varchar(50) string	NULL	External order number, for example from the shop. It is resolved through `Orderlines`. Alternative to `OrderNr`. Example: `SHOP-100023`
`SubShopName`	varchar(50) string	NULL	New sub-shop name. `NULL` keeps the current value. Example: `Outlet Shop`
`SubShopLogo`	varchar(50) string	NULL	New sub-shop logo reference. `NULL` keeps the current value. Example: `outlet_logo.png`
`Referrer`	varchar(50) string	NULL	New referrer, i.e. the source of the order. `NULL` keeps the current value. Example: `google-ads`

Result set 1 · Only on error: order not found or not unique (`404`), or the update failed (`500`). No result set on success.

Error row with an error number and a message.

Column	Type	Description
`ErrorNr`	varchar(3) string	Error number: `404` or `500`.
`ErrorMessage`	varchar(75) string	Error text.

Response example

<SqlRowSet1>
  <row>
    <ErrorNr>404</ErrorNr>
    <ErrorMessage>Invoice does not exist or two different invoice parameters were specified.</ErrorMessage>
  </row>
</SqlRowSet1>

Status	Message	Cause
404	Invoice does not exist or two different invoice parameters were specified.	The resolved order number does not match exactly one record in `OrderHeader`. This happens if no identifier was passed, if the order does not exist, or if `OrderNrExternal` cannot be found in `Orderlines`. Pass a valid `OrderNr` or `OrderNrExternal`.
500	Technical problems during update of the order information	The update of `OrderHeader` raised an error, for example because a value is too long for the column or a constraint was violated. Check the length and content of the passed values.

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:pixiOrderSetInfo>
      <!-- <OrderNr>123456</OrderNr> -->
      <!-- <OrderNrExternal>SHOP-100023</OrderNrExternal> -->
      <!-- <SubShopName>Outlet Shop</SubShopName> -->
      <!-- <SubShopLogo>outlet_logo.png</SubShopLogo> -->
      <!-- <Referrer>google-ads</Referrer> -->
    </ns1:pixiOrderSetInfo>
  </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:pixiOrderSetInfo>
      <!-- <OrderNr>123456</OrderNr> -->
      <!-- <OrderNrExternal>SHOP-100023</OrderNrExternal> -->
      <!-- <SubShopName>Outlet Shop</SubShopName> -->
      <!-- <SubShopLogo>outlet_logo.png</SubShopLogo> -->
      <!-- <Referrer>google-ads</Referrer> -->
    </ns1:pixiOrderSetInfo>
  </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' => '123456',
    // 'OrderNrExternal' => 'SHOP-100023',
    // 'SubShopName' => 'Outlet Shop',
    // 'SubShopLogo' => 'outlet_logo.png',
    // 'Referrer' => 'google-ads',
];

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

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

Notes

Tables used

Result set 1 · Only on error: order not found or not unique (404), or the update failed (500). No result set on success.

Response example

Result set 1 · Only on error: order not found or not unique (`404`), or the update failed (`500`). No result set on success.