Unofficial Pixi-API-Documentation

by koempf24.de

pixiSetItemEan

Pixi-Docs
Old Pixi-Docs

Sets EAN code for Item.

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

Items Stock

Request

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

Request body

Name Type Required Description
NewEan string true

EAN (new)

Type: varchar(13)

Default value:

Example: abcdef

Available from: LOU Official (6.3.0.4452)
OldEan string false

EAN (current)

Type: varchar(13)

Default value: NULL

Example: 123

Available from: LOU Official (6.3.0.4452)
ItemKey integer false

Item Id

Type: int

Default value: NULL

Example: 123

Available from: LOU Official (6.3.0.4452)
ItemNrInt string false

Internal Item Number

Type: varchar(50)

Default value: NULL

Example: 123

Available from: LOU Official (6.3.0.4452)
ItemNrSuppl string false

Supplier Item Number

Type: varchar(50)

Default value: NULL

Example: 123

Available from: LOU Official (6.3.0.4452)
ResultMessage string false

Result message (output)

Type: varchar(256)

Default value: NULL

Example: 123

Available from: LOU Official (6.3.0.4452)
SupressDataset boolean false

Suppres result

Type: bit

Default value: 0

Example: 123

Available from: LOU Official (6.3.0.4452)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiSetItemEan>
      <ItemKey>0</ItemKey>
      <ItemNrInt>string</ItemNrInt>
      <OldEan>string</OldEan>
      <ItemNrSuppl>string</ItemNrSuppl>
      <NewEan>string</NewEan>
      <SupressDataset>true</SupressDataset>
      <ResultMessage>string</ResultMessage>
    </pixiSetItemEan>
  </Body>
</Envelope>

Response

1. Picklist data

Name Type Description
ResultMessage string

The function returns the result dataset unless the parameter SuppressDataset is 1. The result of function can be one of the following messages:
200 Item updated
401 No item ID provided
402 Item not found
403 More than one item is found
404 Unexpected error: (error nr and error messages)
405 Setting BMECatImport_Update_EANUPC is off which is preventing the EAN from being updated

Type: varchar

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiSetItemEanPost200TextXmlResponse>
  <ResultMessage>string</ResultMessage>
</PixiSetItemEanPost200TextXmlResponse>

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:pixiSetItemEan>
            <NewEan xsi:type="xsd:string">abcdef</NewEan> <!-- required -->
            <OldEan xsi:type="xsd:string">123</OldEan>
            <ItemKey xsi:type="xsd:integer">123</ItemKey>
            <ItemNrInt xsi:type="xsd:string">123</ItemNrInt>
            <ItemNrSuppl xsi:type="xsd:string">123</ItemNrSuppl>
            <ResultMessage xsi:type="xsd:string">123</ResultMessage>
            <SupressDataset xsi:type="xsd:boolean">123</SupressDataset>
        </ns1:pixiSetItemEan>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiSetItemEan', [
    'NewEan' => 'abcdef', // string (required)
    'OldEan' => '123', // string
    'ItemKey' => '123', // integer
    'ItemNrInt' => '123', // string
    'ItemNrSuppl' => '123', // string
    'ResultMessage' => '123', // string
    'SupressDataset' => '123', // boolean
]);

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