Unofficial Pixi-API-Documentation

by koempf24.de

pixiGetItemStatus

Pixi-Docs
Old Pixi-Docs

Deprecated

Gets item active / inactive status

Since pixi version: LOU Official (6.3.0.4452) Additional notes:

Items Stock

Request

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

Request body

Name Type Required Description
ItemKey integer false

Item Id

Type: int

Default value: NULL

Example: 123

Available from: LOU Official (6.3.0.4452)
ItemNrInt string false

Item Number (internal)

Type: varchar(50)

Default value: NULL

Example: abc

Available from: LOU Official (6.3.0.4452)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiGetItemStatus>
      <ItemNrInt>string</ItemNrInt>
      <ItemKey>0</ItemKey>
    </pixiGetItemStatus>
  </Body>
</Envelope>

Response

1. Result set

Name Type Description
Enabled boolean

item enabled/active status

Type: bit

Available from: 25.06 (25.6.0.58802)
ItemKey integer

item Id

Type: int

Available from: 25.06 (25.6.0.58802)
ItemNrInt string

internal item number to identify the item (ItemNrInt = ID used to match to the shops items)

Type: varchar

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiGetItemStatusPost200TextXmlResponse>
  <ItemKey>0</ItemKey>
  <ItemNrInt>string</ItemNrInt>
  <Enabled>true</Enabled>
</PixiGetItemStatusPost200TextXmlResponse>

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:pixiGetItemStatus>
            <ItemKey xsi:type="xsd:integer">123</ItemKey>
            <ItemNrInt xsi:type="xsd:string">abc</ItemNrInt>
        </ns1:pixiGetItemStatus>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiGetItemStatus', [
    'ItemKey' => '123', // integer
    'ItemNrInt' => 'abc', // string
]);

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