pixiEmillGetOrderStates · Pixi API documentation

Returns all entries of the order state table OrderStates.

No parameters, no filters: every defined order state is returned.
Each row contains the state code (orderStatus) and its text (StateDesc).
Rows are sorted alphabetically by the state text.

Use the result to translate the status codes returned by other order calls into readable descriptions, or to fill selection lists.

Notes

The table is read with NOLOCK, so uncommitted changes may be visible.
The procedure was originally written for the eMill integration (tags Tech_eMill), but it is a generic lookup.
The language of StateDesc depends on the content of OrderStates; the code does not translate it.

Tables used

OrderStates · Read

This call has no parameters.

Result set 1 · Always

One row per order state, sorted by state text.

Column	Type	Description
`orderStatus`	string	Order state code (`OrderStates.State`).
`StateDesc` Nullable	string	Description of the order state (`OrderStates.StateText`).

Response example

<SqlRowSet1>
  <row>
    <orderStatus>AU</orderStatus>
    <StateDesc>Auftrag</StateDesc>
  </row>
  <row>
    <orderStatus>ST</orderStatus>
    <StateDesc>Storniert</StateDesc>
  </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:pixiEmillGetOrderStates/>
  </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:pixiEmillGetOrderStates/>
  </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 = [
];

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

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