Unofficial Pixi-API-Documentation

by koempf24.de

pixiReadItemTagMatching

Pixi-Docs
Old Pixi-Docs

API call to get all available item tag matchings

Since pixi version: LOU Official - Update 46 (6.9.46.27927) Additional notes: System tags ids have negative values

Raw-Read

Request

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

Request body

Name Type Required Description
Start integer false

Start tag match id (last id from your last request)

Type: int

Default value: 0

Example: 123

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

Amount of rows to be returned

Type: int

Default value: 1000

Example: 123

Available from: LOU Official - Update 46 (6.9.46.27927)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiReadItemTagMatching>
      <Start>0</Start>
      <RowCount>0</RowCount>
    </pixiReadItemTagMatching>
  </Body>
</Envelope>

Response

1. Result set

Name Type Description
TagRef integer

TagRef

Type: int

Available from: 25.06 (25.6.0.58802)
ItemRef integer

ItemRef

Type: int

Available from: 25.06 (25.6.0.58802)
ItemMatchKey integer

ItemMatchKey

Type: int

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiReadItemTagMatchingPost200TextXmlResponse>
  <ItemMatchKey>0</ItemMatchKey>
  <TagRef>0</TagRef>
  <ItemRef>0</ItemRef>
</PixiReadItemTagMatchingPost200TextXmlResponse>

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:pixiReadItemTagMatching>
            <Start xsi:type="xsd:integer">123</Start>
            <RowCount xsi:type="xsd:integer">123</RowCount>
        </ns1:pixiReadItemTagMatching>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiReadItemTagMatching', [
    'Start' => '123', // integer
    'RowCount' => '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);
}