Unofficial Pixi-API-Documentation

by koempf24.de

pixiGetSOrderlines

Pixi-Docs
Old Pixi-Docs

Procedure returns supplier orderlines for a given supplier order.

Since pixi version: LOU Official (6.3.0.4452) Additional notes: Important TotalQtyReceived returns the total received item quantity of the item which is matched to a goods receipt document. In case the item of the receipt document is matched to several purchase orders, each order line of the purchase order shows the same total received item quantity value. It is therefore recommended, to only use the column if goods receipt documents are created using purchase order(s) as a template.

General

Request

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

Request body

Name Type Required Description
LocID string false

Filter for pixi* location connected to the supplier order.

Type: char

Default value: 001

Example:

Available from: LOU Official (6.3.0.4452)
SOrderRef integer false

Type: int

Default value: 0

Example:

Available from: LOU Official (6.3.0.4452)
OpenOrderlines boolean false

When set to "1" only lines that have an open delivery quantity will be shown.

Type: bit

Default value: 0

Example:

Available from: LOU Official (6.3.0.4452)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiGetSOrderlines>
      <SOrderRef>0</SOrderRef>
      <LocID>string</LocID>
      <OpenOrderlines>true</OpenOrderlines>
    </pixiGetSOrderlines>
  </Body>
</Envelope>

Response

1. Supplier orderlines that fit the conditions specified by the input parameters.

Name Type Description
L30 integer

Item demand in last 30 days.

Type: int

Available from: 25.06 (25.6.0.58802)
L120 integer

Item demand in last 120 days.

Type: int

Available from: 25.06 (25.6.0.58802)
L365 integer

Item demand in last 365 days.

Type: int

Available from: 25.06 (25.6.0.58802)
Note string

Supplier orderline comment.

Type: varchar

Available from: 25.06 (25.6.0.58802)
ArtNr string

Barcode of the item from corresponding supplier.

Type: varchar

Available from: 25.06 (25.6.0.58802)
Price number

Item price connected to an order line.

Type: money

Available from: 25.06 (25.6.0.58802)
Detail integer

Dummy field. Always returns 0.

Type: int

Available from: 25.06 (25.6.0.58802)
Status string

Supplier order status.

Type: char

Available from: 25.06 (25.6.0.58802)
ArtName string

Name of the item.

Type: varchar

Available from: 25.06 (25.6.0.58802)
Detail2 integer

Dummy field. Always returns 0.

Type: int

Available from: 25.06 (25.6.0.58802)
EKValue number

Supplier price value of supplier orderline.

Type: money

Available from: 25.06 (25.6.0.58802)
EKprice number

Supplier price for the item.

Type: money

Available from: 25.06 (25.6.0.58802)
VATperc string

VAT percent for the item.

Type: float

Available from: 25.06 (25.6.0.58802)
VKPrice number

Current selling price of the item.

Type: money

Available from: 25.06 (25.6.0.58802)
OrderQty integer

Quantity of ordered items.

Type: int

Available from: 25.06 (25.6.0.58802)
SitemRef integer

ID of item.

Type: int

Available from: 25.06 (25.6.0.58802)
StockQty integer

Current stock of the item.

Type: int

Available from: 25.06 (25.6.0.58802)
CreateEmp string

User who created the supplier order.

Type: varchar

Available from: 25.06 (25.6.0.58802)
ItemNrInt string

Shop item number.

Type: varchar

Available from: 25.06 (25.6.0.58802)
OrderUnit string

Specified order unit for the item.

Type: varchar

Available from: 25.06 (25.6.0.58802)
SOrderRef integer

ID of supplier order.

Type: int

Available from: 25.06 (25.6.0.58802)
UpdateEmp string

User who last updated the supplier order line.

Type: varchar

Available from: 25.06 (25.6.0.58802)
CreateDate string

Create date of the supplier order line.

Type: datetime

Available from: 25.06 (25.6.0.58802)
FinalPrice number

Supplier price times quantity minus discount.

Type: money

Available from: 25.06 (25.6.0.58802)
Hal_Cust_O integer

Open customer orders for the item on status "HAL".

Type: int

Available from: 25.06 (25.6.0.58802)
UpdateDate string

Last update date of the supplier order line.

Type: datetime

Available from: 25.06 (25.6.0.58802)
XMLconfirm boolean

DF (Direct Fullfilement) XML confirm flag.

Type: bit

Available from: 25.06 (25.6.0.58802)
ItemNrSuppl string

Supplier item number.

Type: varchar

Available from: 25.06 (25.6.0.58802)
MinOrderQty integer

Minimum order quantity for the item.

Type: int

Available from: 25.06 (25.6.0.58802)
MinStockQty integer

Minimum stock quantity for the item.

Type: int

Available from: 25.06 (25.6.0.58802)
Open_Cust_O integer

Open customer orders for the item on status "ANG".

Type: int

Available from: 25.06 (25.6.0.58802)
QtyReceived integer

Quantity of delivered items.

Type: int

Available from: 25.06 (25.6.0.58802)
ReceiveDate string

Current date.

Type: datetime

Available from: 25.06 (25.6.0.58802)
Open_Suppl_O integer

Item quantity of supplier open supplier orders.

Type: int

Available from: 25.06 (25.6.0.58802)
SOrderlineNr integer

ID of supplier order.

Type: int

Available from: 25.06 (25.6.0.58802)
SOrderlineKey integer

ID of supplier orderline.(key)

Type: int

Available from: 25.06 (25.6.0.58802)
QtyNotDelivered integer

Quantity of items that were not yet delivered.

Type: int

Available from: 25.06 (25.6.0.58802)
SummaryQuantity integer

Current quantity of the item.

Type: int

Available from: 25.06 (25.6.0.58802)
LocationQuantity integer

Current quantity of the item on specified location.

Type: int

Available from: 25.06 (25.6.0.58802)
TotalQtyReceived integer

Real quantity delivered.

Type: int

Available from: 25.06 (25.6.0.58802)
EstimatedDelivery string

Date of estimated delivery.

Type: datetime

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiGetSOrderlinesPost200TextXmlResponse>
  <Detail>0</Detail>
  <Detail2>0</Detail2>
  <ArtNr>string</ArtNr>
  <ArtName>string</ArtName>
  <OrderQty>0</OrderQty>
  <ReceiveDate>string</ReceiveDate>
  <Status>string</Status>
  <CreateDate>string</CreateDate>
  <CreateEmp>string</CreateEmp>
  <UpdateDate>string</UpdateDate>
  <UpdateEmp>string</UpdateEmp>
  <SOrderlineKey>0</SOrderlineKey>
  <SitemRef>0</SitemRef>
  <SOrderRef>0</SOrderRef>
  <XMLconfirm>true</XMLconfirm>
  <SOrderlineNr>0</SOrderlineNr>
  <Note>string</Note>
  <EstimatedDelivery>string</EstimatedDelivery>
  <VKPrice>0</VKPrice>
  <SummaryQuantity>0</SummaryQuantity>
  <LocationQuantity>0</LocationQuantity>
  <QtyReceived>0</QtyReceived>
  <QtyNotDelivered>0</QtyNotDelivered>
  <MinOrderQty>0</MinOrderQty>
  <MinStockQty>0</MinStockQty>
  <OrderUnit>string</OrderUnit>
  <ItemNrSuppl>string</ItemNrSuppl>
  <ItemNrInt>string</ItemNrInt>
  <VATperc>string</VATperc>
  <EKprice>0</EKprice>
  <EKValue>0</EKValue>
  <Hal_Cust_O>0</Hal_Cust_O>
  <Open_Cust_O>0</Open_Cust_O>
  <Open_Suppl_O>0</Open_Suppl_O>
  <L30>0</L30>
  <L120>0</L120>
  <L365>0</L365>
  <StockQty>0</StockQty>
  <Price>0</Price>
  <TotalQtyReceived>0</TotalQtyReceived>
  <FinalPrice>0</FinalPrice>
</PixiGetSOrderlinesPost200TextXmlResponse>

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:pixiGetSOrderlines>
            <LocID xsi:type="xsd:string"></LocID>
            <SOrderRef xsi:type="xsd:integer"></SOrderRef>
            <OpenOrderlines xsi:type="xsd:boolean"></OpenOrderlines>
        </ns1:pixiGetSOrderlines>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiGetSOrderlines', [
    'LocID' => '', // string
    'SOrderRef' => '', // integer
    'OpenOrderlines' => '', // 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);
}