Unofficial Pixi-API-Documentation

by koempf24.de

pixiImportFindXML

Pixi-Docs
Old Pixi-Docs

Since pixi version: LOU Official - Update 46 (6.9.46.27927) Additional notes: Available Xml Status in pixi* :

    "COC"	- CONSTRAINTS CHECKED
    
    "Err"	- ERROR
    
    "NEI"	- Non-existing Item in Order XML
    
    "NOX"	- No valid response
    
    "OK" 	- OK
    
    "RTE"	- READY TO EXPORT
    
    "SRR"	- SHOP ERROR
    
    "XEC"	- Error codes in XML
    
    "XER"	- XML ERROR
    
    "XIM"	- XML IMPORTED
    
    "XNI"	- XML HAS NO ITEMS
    
    "XPA"	- XML PARSED
    
    "XPR"	- XML PROCESSED (all imported or updated)
General

Request

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

Request body

Name Type Required Description
Id string true

Id you want to search for. For "order" it will search for ORDER_ID, for "item" it will search for SUPPLIER_AID

Type: varchar(50)

Default value:

Example: abcdefg1234

Available from: LOU Official - Update 46 (6.9.46.27927)
Type string true

You can use either "order" or "item"

Type: varchar(10)

Default value:

Example: abcdefg

Available from: LOU Official - Update 46 (6.9.46.27927)
Channel integer false

ChannelKey

Type: int

Default value: NULL

Example: 123

Available from: LOU Official - Update 46 (6.9.46.27927)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiImportFindXML>
      <Type>string</Type>
      <Id>string</Id>
      <Channel>0</Channel>
    </pixiImportFindXML>
  </Body>
</Envelope>

Response

Name Type Description
Error string

Xml error message

Type: varchar (8000)

Available from: 25.06 (25.6.0.58802)
Status string

Status of Xml. (additional Info)

Type: varchar (3)

Available from: 25.06 (25.6.0.58802)
Request string

Shows the request Xml that were sent

Type: varchar (-1)

Available from: 25.06 (25.6.0.58802)
Response string

Shows the response Xml

Type: varchar (-1)

Available from: 25.06 (25.6.0.58802)
XMLLogKey integer

ID of the XML

Type: int

Available from: 25.06 (25.6.0.58802)
CreateDate string

Create date

Type: datetime

Available from: 25.06 (25.6.0.58802)
UpdateDate string

Last update date of the record

Type: datetime

Available from: 25.06 (25.6.0.58802)
XmlResponseCastErrorNr integer

Error code

Type: int

Available from: 25.06 (25.6.0.58802)
XmlResponseCastErrorMessage string

Error message

Type: varchar (255)

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiImportFindXMLPost200TextXmlResponse>
  <XMLLogKey>0</XMLLogKey>
  <Request>string</Request>
  <Response>string</Response>
  <Status>string</Status>
  <CreateDate>string</CreateDate>
  <UpdateDate>string</UpdateDate>
  <Error>string</Error>
  <XmlResponseCastErrorNr>0</XmlResponseCastErrorNr>
  <XmlResponseCastErrorMessage>string</XmlResponseCastErrorMessage>
</PixiImportFindXMLPost200TextXmlResponse>

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:pixiImportFindXML>
            <Id xsi:type="xsd:string">abcdefg1234</Id> <!-- required -->
            <Type xsi:type="xsd:string">abcdefg</Type> <!-- required -->
            <Channel xsi:type="xsd:integer">123</Channel>
        </ns1:pixiImportFindXML>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiImportFindXML', [
    'Id' => 'abcdefg1234', // string (required)
    'Type' => 'abcdefg', // string (required)
    'Channel' => '123', // integer
]);

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