pixiTagMatchDeleteForOrders
Set Tags for Orders.
Since pixi version: 19.09 (9.0.7.42222) Additional notes: Example of XML: ' <Tags> <Order> <OrderId>12345</OrderId> <TagList> <Tag> <TagId>303</TagId> </Tag> </TagList> </Order> <Order> <OrderNrExternal>P_133353</OrderNrExternal> <TagList> <Tag> <TagId>-33</TagId> </Tag> </TagList> </Order> </Tags>'
Request
Request body
| Name | Type | Required | Description |
|---|---|---|---|
| TagsXML | string | true | XML for Orders. Type: varchar(-1) Default value: NULL Example: Available from: 19.09 (9.0.7.42222) |
Request Example
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
<Body xmlns="">
<pixiTagMatchDeleteForOrders>
<TagsXML>string</TagsXML>
</pixiTagMatchDeleteForOrders>
</Body>
</Envelope>Response
1. Status response
| Name | Type | Description |
|---|---|---|
| TagId | integer | Value of TagId from XML Type: int Available from: 25.06 (25.6.0.58802) |
| Status | string | Status (Error/Warning/Success) Type: varchar Available from: 25.06 (25.6.0.58802) |
| Message | string | Message (Status detail information) Type: varchar Available from: 25.06 (25.6.0.58802) |
| OrderId | integer | Value of OrderId from XML Type: int Available from: 25.06 (25.6.0.58802) |
| OrderHeaderKey | integer | Value of OrderHeaderKey from database Type: int Available from: 25.06 (25.6.0.58802) |
| OrderNrExternal | string | Value of OrderNrExternal from XML Type: varchar Available from: 25.06 (25.6.0.58802) |
Response Example
<PixiTagMatchDeleteForOrdersPost200TextXmlResponse>
<TagId>0</TagId>
<OrderId>0</OrderId>
<OrderNrExternal>string</OrderNrExternal>
<OrderHeaderKey>0</OrderHeaderKey>
<Status>string</Status>
<Message>string</Message>
</PixiTagMatchDeleteForOrdersPost200TextXmlResponse>HTTP Example
POST https://apigateway.descartes.com/tms/pixi/
Content-Type: text/xml; charset=utf-8
# echo -n '{{username}}:{{password}}' | base64 | pbcopy
Authorization: Basic {{token}}
<?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/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<SOAP-ENV:Body>
<ns1:pixiTagMatchDeleteForOrders>
<TagsXML xsi:type="xsd:string"></TagsXML> <!-- required -->
</ns1:pixiTagMatchDeleteForOrders>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>PHP Example
<?php
getPixiSoapClientResponse('pixiTagMatchDeleteForOrders', [
'TagsXML' => '', // string (required)
]);
function getPixiSoapClientResponse(string $method, array $arguments = [])
{
$soapArguments = [];
foreach ($arguments as $key => $value) {
$soapArguments[] = new SoapVar($value, null, '', '', $key);
}
$soapClient = new SoapClient(null, [
'login' => '...',
'password' => '...',
'uri' => 'https://apigateway.descartes.com/tms/pixi/',
'location' => 'https://apigateway.descartes.com/tms/pixi/',
]);
return $soapClient->__call($method, $soapArguments);
}