Unofficial Pixi-API-Documentation

by koempf24.de

pixiGetItemSuppliers

Pixi-Docs

API Call to get item-supplier rows for a specific item, or all item-supplier rows for a specific supplier.

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

Items Stock

Request

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

Request body

Name Type Required Description
EAN string false

EANUPC to Load Item

Type: varchar(13)

Default value:

Example:

Available from: LOU Official (6.3.0.4452)
ItemKey integer false

ItemKey to Load Item

Type: int

Default value:

Example:

Available from: LOU Official (6.3.0.4452)
SupplNr string false

Filter by supplier number. Returns all items for this supplier.

Type: varchar(4)

Default value:

Example:

Available from: (26.6.0.11854)
ItemNrInt string false

ItemNrInt to Load Item

Type: varchar(50)

Default value:

Example:

Available from: LOU Official (6.3.0.4452)
ItemNrSuppl string false

ItemNrSuppl to Load Item

Type: varchar(50)

Default value:

Example:

Available from: LOU Official (6.3.0.4452)
OnlyActiveSuppliers boolean false

Show only active suppliers. Default is 0 (off)

Type: bit

Default value:

Example:

Available from: LOU Official - Update 46 (6.9.46.27927)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiGetItemSuppliers>
      <ItemKey>0</ItemKey>
      <EAN>string</EAN>
      <ItemNrSuppl>string</ItemNrSuppl>
      <ItemNrInt>string</ItemNrInt>
      <OnlyActiveSuppliers>true</OnlyActiveSuppliers>
      <SupplNr>string</SupplNr>
    </pixiGetItemSuppliers>
  </Body>
</Envelope>

Response

1. List of Item suppliers.

Name Type Description
EANUPC string

Item barcode

Type: varchar

Available from: / (26.6.0.11854)
OnlyPU boolean

Only package unit

Type: BIT

Available from: / (26.6.0.11854)
ItemKey integer

pixi* item ID

Type: int

Available from: / (26.6.0.11854)
SupplNr string

Supplier number code

Type: varchar

Available from: / (26.6.0.11854)
ItemNrInt string

Shop item number

Type: varchar

Available from: / (26.6.0.11854)
SupplPrice number

Supplier price for the item

Type: money

Available from: / (26.6.0.11854)
ItemNrSuppl string

Supplier item number

Type: varchar

Available from: / (26.6.0.11854)
MinOrderQty integer

Min order quantity

Type: INT

Available from: / (26.6.0.11854)
DeliveryTime integer

Delivery Time

Type: INT

Available from: / (26.6.0.11854)
ItemDeliveryTime integer

Item Delivery Time

Type: INT

Available from: / (26.6.0.11854)
SupplierDisabled boolean

Flag if supplier is disabled

Type: bit

Available from: / (26.6.0.11854)

Response Example

<PixiGetItemSuppliersPost200TextXmlResponse>
  <ItemKey>0</ItemKey>
  <EANUPC>string</EANUPC>
  <ItemNrSuppl>string</ItemNrSuppl>
  <ItemNrInt>string</ItemNrInt>
  <SupplNr>string</SupplNr>
  <SupplPrice>0</SupplPrice>
  <SupplierDisabled>true</SupplierDisabled>
  <MinOrderQty>0</MinOrderQty>
  <OnlyPU>true</OnlyPU>
  <ItemDeliveryTime>0</ItemDeliveryTime>
  <DeliveryTime>0</DeliveryTime>
</PixiGetItemSuppliersPost200TextXmlResponse>

2. Error response

Name Type Description
Error string

Error status

Type: varchar

Available from: / (26.6.0.11854)
ErrorMsg string

Error description

Type: varchar

Available from: / (26.6.0.11854)

Response Example

<PixiGetItemSuppliersPost400TextXmlResponse>
  <Error>string</Error>
  <ErrorMsg>string</ErrorMsg>
</PixiGetItemSuppliersPost400TextXmlResponse>

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:pixiGetItemSuppliers>
            <EAN xsi:type="xsd:string"></EAN>
            <ItemKey xsi:type="xsd:integer"></ItemKey>
            <SupplNr xsi:type="xsd:string"></SupplNr>
            <ItemNrInt xsi:type="xsd:string"></ItemNrInt>
            <ItemNrSuppl xsi:type="xsd:string"></ItemNrSuppl>
            <OnlyActiveSuppliers xsi:type="xsd:boolean"></OnlyActiveSuppliers>
        </ns1:pixiGetItemSuppliers>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiGetItemSuppliers', [
    'EAN' => '', // string
    'ItemKey' => '', // integer
    'SupplNr' => '', // string
    'ItemNrInt' => '', // string
    'ItemNrSuppl' => '', // string
    'OnlyActiveSuppliers' => '', // 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);
}