Unofficial Pixi-API-Documentation

by koempf24.de

pixiOrderGetByTags

Pixi-Docs
Old Pixi-Docs

API call for getting a list of orders filtered by assigned item tags. By default list returns orders younger than 6 months, and sorted by OrderHeaderId - oldest orders first.

Since pixi version: 19.09 (9.0.7.42222) Additional notes: XML structure for @TagFilter parameter:

    		<TagFilter>
    			<AND>		
    				<TagName>Reserved Order</TagName>
    				<TagName>Open Order</TagName>
    				<TagId>-30</TagId>
    			</AND>		
    			<OR>
    				<TagName>Rejected Order</TagName>			
    			</OR>
    			<NOT>
    				<TagName>Personalized Order</TagName>			
    			</NOT>
    		</TagFilter>
General

Request

POST https://apigateway.descartes.com/tms/pixi/pixiOrderGetByTags

Request body

Name Type Required Description
DateTo string false

Filter results by order date to. Default is current date and time.

Type: datetime

Default value:

Example:

Available from: 22.07 (22.7.0.28858)
DateFrom string false

Filter results by order date from. Default is 6 months back.

Type: datetime

Default value:

Example:

Available from: 22.07 (22.7.0.28858)
RowCount integer false

Number of search results, default 1000 records

Type: int

Default value: 1000

Example:

Available from: 22.07 (22.7.0.28858)
TagFilter string true

Filter operator

Type: varchar(-1)

Default value:

Example: See Additional Information for the XML structure

Available from: 19.09 (9.0.7.42222)
StrictANDCondition boolean false

Obsolete parameter.

Type: bit

Default value: 0

Example:

Available from: 19.09 (9.0.7.42222)
PartialTagNameMatch boolean false

Switch: Enables partial matching for tag name

Type: bit

Default value: 0

Example: 0 or 1

Available from: 19.09 (9.0.7.42222)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiOrderGetByTags>
      <TagFilter>string</TagFilter>
      <PartialTagNameMatch>true</PartialTagNameMatch>
      <StrictANDCondition>true</StrictANDCondition>
      <RowCount>0</RowCount>
      <DateFrom>string</DateFrom>
      <DateTo>string</DateTo>
    </pixiOrderGetByTags>
  </Body>
</Envelope>

Response

1. Orders list

Name Type Description
OrderNr integer

pixi order number

Type: int

Available from: 25.06 (25.6.0.58802)
OrderHeaderId integer

Order Id

Type: int

Available from: 25.06 (25.6.0.58802)
OrderNrExternal string

Shop order number

Type: varchar

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiOrderGetByTagsPost200TextXmlResponse>
  <OrderHeaderId>0</OrderHeaderId>
  <OrderNr>0</OrderNr>
  <OrderNrExternal>string</OrderNrExternal>
</PixiOrderGetByTagsPost200TextXmlResponse>

2. Error response

Name Type Description
TagId integer

TagId found in the database

Type: int

Available from: 25.06 (25.6.0.58802)
Status string

Filter line status (OK/ERROR)

Type: varchar

Available from: 25.06 (25.6.0.58802)
TagName string

TagName found in the database

Type: varchar

Available from: 25.06 (25.6.0.58802)
XMLTagId string

TagId node value provided in XML

Type: nvarchar

Available from: 25.06 (25.6.0.58802)
Operation string

Filter operation (AND/OR/NOT)

Type: varchar

Available from: 25.06 (25.6.0.58802)
XMLTagName string

TagName node value provided in XML

Type: nvarchar

Available from: 25.06 (25.6.0.58802)
StatusMessage string

Filter line status description

Type: varchar

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiOrderGetByTagsPost400TextXmlResponse>
  <Operation>string</Operation>
  <XMLTagId>string</XMLTagId>
  <XMLTagName>string</XMLTagName>
  <TagId>0</TagId>
  <TagName>string</TagName>
  <Status>string</Status>
  <StatusMessage>string</StatusMessage>
</PixiOrderGetByTagsPost400TextXmlResponse>

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:pixiOrderGetByTags>
            <DateTo xsi:type="xsd:string"></DateTo>
            <DateFrom xsi:type="xsd:string"></DateFrom>
            <RowCount xsi:type="xsd:integer"></RowCount>
            <TagFilter xsi:type="xsd:string">See Additional Information for the XML structure</TagFilter> <!-- required -->
            <StrictANDCondition xsi:type="xsd:boolean"></StrictANDCondition>
            <PartialTagNameMatch xsi:type="xsd:boolean">0 or 1</PartialTagNameMatch>
        </ns1:pixiOrderGetByTags>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiOrderGetByTags', [
    'DateTo' => '', // string
    'DateFrom' => '', // string
    'RowCount' => '', // integer
    'TagFilter' => 'See Additional Information for the XML structure', // string (required)
    'StrictANDCondition' => '', // boolean
    'PartialTagNameMatch' => '0 or 1', // boolean
]);

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);
}