pixi Developer & Integration Documentation

pixiOrderGetByTags

Description

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.


Request Parameters

# Name Type Required Example Description
1 TagFilter string 1 See Additional Information for the XML structure Filter operator
2 PartialTagNameMatch boolean 0 0 or 1 Switch: Enables partial matching for tag name
3 StrictANDCondition boolean 0 0/1 Obsolete parameter.
4 RowCount integer 0 123 Number of search results, default 1000 records
5 DateFrom string 0 YYYY-MM-DD hh:mm:ss Filter results by order date from. Default is 6 months back.
6 DateTo string 0 YYYY-MM-DD hh:mm:ss Filter results by order date to. Default is current date and time.

Request body

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:dem="https://api.pixi.eu/soap/demosandbox/">
   <soapenv:Header/>
   <soapenv:Body>
      <dem:pixiOrderGetByTags>
         <dem:TagFilter>See Additional Information for the XML structure</dem:TagFilter>
         <dem:PartialTagNameMatch>0 or 1</dem:PartialTagNameMatch>
         <dem:StrictANDCondition>0/1</dem:StrictANDCondition>
         <dem:RowCount>123</dem:RowCount>
         <dem:DateFrom>YYYY-MM-DD hh:mm:ss</dem:DateFrom>
         <dem:DateTo>YYYY-MM-DD hh:mm:ss</dem:DateTo>
      </dem:pixiOrderGetByTags>
   </soapenv:Body>
</soapenv:Envelope>

Response


Body 1: Orders list

# Name Type Description
1 OrderHeaderId integer Order Id
2 OrderNr integer pixi order number
3 OrderNrExternal string Shop order number

Body 2: Error response

# Name Type Description
1 Operation string Filter operation (AND/OR/NOT)
2 XMLTagId string TagId node value provided in XML
3 XMLTagName string TagName node value provided in XML
4 TagId integer TagId found in the database
5 TagName string TagName found in the database
6 Status string Filter line status (OK/ERROR)
7 StatusMessage string Filter line status description

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>