pixiDFSetSupplierNotifiedFlag · Pixi API documentation

Marks order lines as notified (or not notified) to the supplier in a direct-fulfillment (drop-shipping) process.

Candidate order lines are selected from Orderlines where OrderlineKey = @OrderlineKey or OrderNr = @OrderNr. Lines with status HAL are excluded.
Each candidate is checked for editability: a line is editable only if it has no entry in OrderHistory whose status is outside HAL, ANG, BES, FUT, NEW. Lines that already have any other history status are skipped.
For every editable line, the OrderHistory entry with the highest OrderHistKey among its entries with status FUT is updated: ClientNotified is set to Y if @IsNotified = 1, otherwise to N.

Lines without a FUT history entry are not changed. The call returns no result set and no status row.

Notes

The two filter parameters are combined with OR: if both are passed, lines matching either the order line key or the order number are processed. If neither is passed, nothing is updated.
The check IF @IsNotified = NULL never evaluates to true under standard ANSI_NULLS settings. Passing IsNotified explicitly as NULL therefore does not fall back to 1; the flag is set to N. Omit the parameter to get the default 1.
Despite the call name, the column written is OrderHistory.ClientNotified.
No feedback is given about how many rows were updated (SET NOCOUNT ON, no result set); the caller cannot tell whether a line was skipped as not editable.
Candidate selection reads with NOLOCK; the update uses ROWLOCK. No explicit transaction.

Tables used

Orderlines · Read OrderHistory · Write

Parameter Type Default Description

Parameter	Type	Default	Description
`OrderlineKey`	int	NULL	Key of a single order line to process. Combined with `OrderNr` via OR. Example: `123456`
`OrderNr`	int	NULL	Order number; all order lines of this order (except status `HAL`) are processed. Combined with `OrderlineKey` via OR. Example: `98765`
`IsNotified`	bit boolean	1	Value of the notified flag to set. Allowed values `1` – Set `ClientNotified` to `Y` (notified). `0` – Set `ClientNotified` to `N` (not notified). Example: `1`

OrderlineKey

int

NULL

Key of a single order line to process. Combined with OrderNr via OR.

Example: 123456

OrderNr

int

NULL

Order number; all order lines of this order (except status HAL) are processed. Combined with OrderlineKey via OR.

Example: 98765

IsNotified

bit
boolean

1

Value of the notified flag to set.

Allowed values

1 – Set `ClientNotified` to `Y` (notified).
0 – Set `ClientNotified` to `N` (not notified).

Example: 1

This call returns no result set.

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:pixiDFSetSupplierNotifiedFlag>
      <!-- <OrderlineKey>123456</OrderlineKey> -->
      <!-- <OrderNr>98765</OrderNr> -->
      <!-- <IsNotified>1</IsNotified> -->
    </ns1:pixiDFSetSupplierNotifiedFlag>
  </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:pixiDFSetSupplierNotifiedFlag>
      <!-- <OrderlineKey>123456</OrderlineKey> -->
      <!-- <OrderNr>98765</OrderNr> -->
      <!-- <IsNotified>1</IsNotified> -->
    </ns1:pixiDFSetSupplierNotifiedFlag>
  </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 = [
    // 'OrderlineKey' => '123456',
    // 'OrderNr' => '98765',
    // 'IsNotified' => '1',
];

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

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