pixiSetOrderShippingInformation · Pixi API documentation

Updates the shipping information of one order in OrderHeader.

The order is looked up with OrderNr = @OrderNr OR OrderNrExternal = @OrderNrExternal. If no order matches (including when both parameters are NULL), a row with Status 400 is returned and nothing is changed.
If an order is found, the order row is read with UPDLOCK, ROWLOCK. OrderNr and OrderNrExternal are taken from the stored order. Each of ShipVendor, DHLProdukt, DHLVerfahren and DHLExtra that is passed as NULL or left out keeps its current value (ShipVendorCode, Product, Verfahren, Extras).
The order is updated by its OrderNr. The update runs in its own transaction, or in a savepoint if the caller already has an open transaction.
The call returns one status row with the current values of the order:
- Status 200 with Data updated in pixi if a row was updated.
- Status 500 with Data could not be updated in pixi if no row was updated, for example because an SQL error occurred.

Notes

A value cannot be reset to NULL with this call: NULL means "keep the current value". An empty string is written as such.
Because the lookup uses OR, passing both OrderNr and OrderNrExternal can match two different orders, or an external number can match several orders. In that case the variables are assigned from one of the matching rows without a defined order, and only that order is updated. Pass only one identifier to avoid ambiguity.
SQL errors are caught, the transaction (or savepoint) is rolled back and the error is logged via log.InsertError (definition not attached). No SqlMessage is returned; the caller only sees Status 500. If the transaction becomes uncommittable, a full ROLLBACK is executed, which also rolls back an outer transaction of the caller.
The existence check and the final status row read OrderHeader with NOLOCK.
The column types of Product, Verfahren and Extras are not visible in the code; values longer than the column size cause an error and therefore Status 500.

Tables used

OrderHeader · Write

Parameter	Type	Default	Description
`OrderNr`	int	NULL	Pixi order number of the order to update. Either this or `OrderNrExternal` must identify the order. Example: `123456`
`OrderNrExternal`	varchar(50) string	NULL	External order number (e.g. from the shop) used to find the order if `OrderNr` is not given. Example: `SHOP-100234`
`ShipVendor`	varchar(3) string	NULL	Shipping vendor code written to `ShipVendorCode`. NULL keeps the current value. Example: `DHL`
`DHLProdukt`	varchar(50) string	NULL	DHL product written to `Product`. NULL keeps the current value. Example: `V01PAK`
`DHLVerfahren`	varchar(50) string	NULL	DHL procedure (Verfahren) written to `Verfahren`. NULL keeps the current value. Example: `01`
`DHLExtra`	varchar(50) string	NULL	DHL extras written to `Extras`. NULL keeps the current value. Example: `Premium`

Result set 1 · Always; one status row (200 on success, 500 if no row was updated, 400 if the order was not found).

Status row with the current shipping information of the order. For status 400 all order columns are NULL.

Column	Type	Description
`Status`	int	200 = updated, 500 = not updated, 400 = order not found.
`Message`	varchar(33) string	Status text.
`OrderNr` Nullable	int	Pixi order number.
`OrderNrExternal` Nullable	string	External order number.
`ShipVendor` Nullable	string	Current shipping vendor code (`ShipVendorCode`).
`DHLProdukt` Nullable	string	Current DHL product (`Product`).
`DHLVerfahren` Nullable	string	Current DHL procedure (`Verfahren`).
`DHLExtra` Nullable	string	Current DHL extras (`Extras`).

Response example

<SqlRowSet1>
  <row>
    <Status>200</Status>
    <Message>Data updated in pixi</Message>
    <OrderNr>123456</OrderNr>
    <OrderNrExternal>SHOP-100234</OrderNrExternal>
    <ShipVendor>DHL</ShipVendor>
    <DHLProdukt>V01PAK</DHLProdukt>
    <DHLVerfahren>01</DHLVerfahren>
    <DHLExtra>Premium</DHLExtra>
  </row>
</SqlRowSet1>

Status	Message	Cause
400	Order could not be found in pixi	No order matches `OrderNr` or `OrderNrExternal`, or both were left empty. Pass an existing order number.
500	Data could not be updated in pixi	The update changed no row, typically because an SQL error (e.g. a value too long for the column, a lock timeout) occurred; the error is logged via `log.InsertError` and the change is rolled back.

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:pixiSetOrderShippingInformation>
      <!-- <OrderNr>123456</OrderNr> -->
      <!-- <OrderNrExternal>SHOP-100234</OrderNrExternal> -->
      <!-- <ShipVendor>DHL</ShipVendor> -->
      <!-- <DHLProdukt>V01PAK</DHLProdukt> -->
      <!-- <DHLVerfahren>01</DHLVerfahren> -->
      <!-- <DHLExtra>Premium</DHLExtra> -->
    </ns1:pixiSetOrderShippingInformation>
  </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:pixiSetOrderShippingInformation>
      <!-- <OrderNr>123456</OrderNr> -->
      <!-- <OrderNrExternal>SHOP-100234</OrderNrExternal> -->
      <!-- <ShipVendor>DHL</ShipVendor> -->
      <!-- <DHLProdukt>V01PAK</DHLProdukt> -->
      <!-- <DHLVerfahren>01</DHLVerfahren> -->
      <!-- <DHLExtra>Premium</DHLExtra> -->
    </ns1:pixiSetOrderShippingInformation>
  </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-100234',
    // 'ShipVendor' => 'DHL',
    // 'DHLProdukt' => 'V01PAK',
    // 'DHLVerfahren' => '01',
    // 'DHLExtra' => 'Premium',
];

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

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