Description
Provides XML-based import for items using BMEcat or orders using openTRANS.
Request Parameters
# |
Name |
Type |
Required |
Example |
Description |
1 |
ChannelRef |
integer |
1 |
123 |
Use pixiImportGetChannels to get a list of channels and references |
2 |
OperationType |
string |
0 |
ITEM |
ITEM for Item import XML or ORDER for order XML |
3 |
XML |
string |
0 |
abcdefg |
Please wrap your XML into CDATA (Additional Information) |
4 |
ParameterXML |
string |
0 |
abcdefg |
This Paramater you can also use for XML but leave XML parameter empty |
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:pixiImportAddXML>
<dem:ChannelRef>123</dem:ChannelRef>
<dem:OperationType>ITEM</dem:OperationType>
<dem:XML>abcdefg</dem:XML>
<dem:ParameterXML>abcdefg</dem:ParameterXML>
</dem:pixiImportAddXML>
</soapenv:Body>
</soapenv:Envelope>Response
Body 1: Result for imported XML
# |
Name |
Type |
Description |
1 |
XMLLogKey |
integer |
Key for created XML |
Body 2: Result for imported XML
# |
Name |
Type |
Description |
1 |
XMLKey |
integer |
Key for created XML |
Additional Notes
This API call allows to import XMLs into pixi which can be validated and checked for status in the pixi Control Center.
At least one import channel needs to be active. For API-based imports, channel URLs do not need to be configured.
Important: Be sure to wrap your XML data in: <![CDATA[ THE_IMPORT_XML ]]>
Depending on import process, carefully study and implement the required/supported XML formats:
OperationType |
Process |
XML Format |
|---|---|---|
ITEM |
Item Import |
|
ORDER |
Order Import |
Example Call
$this->getSoapClient->pixiImportAddXML([
"ChannelRef" => 2,
"OperationType" => "item",
"XML" => <![CDATA[ ADD_YOUR_XML_HERE ]]>,
"ParameterXml" => "" ]);