pixiCanMergeOrders · Pixi API documentation

Validates whether the source order (SourceOrderNr) can be merged into the target order (TargetOrderNr). The call does not change any data.

The checks run in this order. The first check that fails sets CanMerge = 0 and the matching reason. The remaining checks are then skipped:

Both orders exist: exactly two rows must exist in OrderHeader for the two order numbers. Otherwise the reason is 401.
Same customer: CustRef of both orders must be equal. Otherwise the reason is 402.
Orderline status: no orderline of either order may have a status other than ANG. Otherwise the reason is 403.
Payment type: APayment of the addresses referenced by the orders (AddrRef) must be equal and must not be K (credit card). Otherwise the reason is 404.
Picklists: no orderline of either order may be on a picklist whose PLHexpiryDate is in the future and whose ReservedOrderNr is empty or 0. Otherwise the reason is 405.
Currency and order type: CurrencyId must match, otherwise the reason is 406. Then OrderType must match, otherwise the reason is 407.

If all checks pass, the call returns CanMerge = 1 and Reason = '200 OK'. It always returns one row with CanMerge and Reason. The same values are set in the output parameters, and CanMerge is also the procedure's return value.

Notes

All reads use NOLOCK, so the result can be based on uncommitted data. Re-check right before the actual merge.
If TargetOrderNr and SourceOrderNr are equal, only one header row is found, so the result is 401.
A NULL value in CustRef, APayment, CurrencyId or OrderType makes the comparison fail and leads to the corresponding error code.
Orders without orderlines pass the status check (403).
If an order's address (AddrRef) is not found in Addresses, the join returns no row and the payment check (404) is effectively skipped.
The column ReservedOrderNr in the picklist check is not qualified with a table name. From the code it is not clear whether it belongs to PLitem or plheader.
The reason text starts with an HTTP-like numeric code (200, 401–407), which is useful for programmatic evaluation.

Tables used

OrderHeader · Read Orderlines · Read Addresses · Read PLitem · Read plheader · Read

Parameter	Type	Default	Description
`TargetOrderNr` Required	int	–	Order number of the target order into which the source order would be merged. Example: `100234`
`SourceOrderNr` Required	int	–	Order number of the source order that would be merged into the target order. Example: `100235`
`CanMerge` OUTPUT	int	NULL	Output: 1 if the orders can be merged, otherwise 0. An input value is ignored. Allowed values `1` – Orders can be merged `0` – Orders cannot be merged, see Reason
`Reason` OUTPUT	varchar(128) string	NULL	Output: reason code with text, e.g. `200 OK` or `402 Orders must belong to the same customer`. An input value is ignored.

Result set 1 · Always

One row with the result of the merge check.

Column	Type	Description
`CanMerge`	int	1 = orders can be merged, 0 = they cannot.
`Reason`	varchar(128) string	`200 OK` on success, otherwise the code and text of the first failed check (401–407).

Response example

<SqlRowSet1>
  <row>
    <CanMerge>0</CanMerge>
    <Reason>403 All involved orderlines must have status ANG</Reason>
  </row>
</SqlRowSet1>

Status	Message	Cause
0	401 Both orders must exist	One or both order numbers do not exist in `OrderHeader`, or both parameters contain the same order number. Pass two different, existing order numbers.
0	402 Orders must belong to the same customer	The orders have different (or NULL) `CustRef` values. Only orders of the same customer can be merged.
0	403 All involved orderlines must have status ANG	At least one orderline of either order has a status other than `ANG`.
0	404 Payment types on both orders must match and not be a creditcard type	The payment types (`APayment`) of the order addresses differ, are NULL, or are `K` (credit card).
0	405 None of the orderlines in either orders can be on picklists	At least one orderline is on a picklist that has not expired and has no reserved order number.
0	406 Orders must have same currency	The orders have different `CurrencyId` values.
0	407 Orders must have same order type	The orders have the same currency but different `OrderType` 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:pixiCanMergeOrders>
      <TargetOrderNr>100234</TargetOrderNr>
      <SourceOrderNr>100235</SourceOrderNr>
      <!-- <CanMerge>?</CanMerge> -->
      <!-- <Reason>?</Reason> -->
    </ns1:pixiCanMergeOrders>
  </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:pixiCanMergeOrders>
      <TargetOrderNr>100234</TargetOrderNr>
      <SourceOrderNr>100235</SourceOrderNr>
      <!-- <CanMerge>?</CanMerge> -->
      <!-- <Reason>?</Reason> -->
    </ns1:pixiCanMergeOrders>
  </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 = [
    'TargetOrderNr' => '100234',
    'SourceOrderNr' => '100235',
    // 'CanMerge' => '?',
    // 'Reason' => '?',
];

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

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