Unofficial Pixi-API-Documentation

by koempf24.de

pixiSupplierOrderLineLocQtyGet

Pixi-Docs
Old Pixi-Docs

Recommended

Get data for one or more supplier order lines location quantity.

Since pixi version: AVA Official - Update 7 (8.4.7.23158) Additional notes:

Suppliers

Request

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

Request body

Name Type Required Description
AppName string false

Type: varchar(255)

Default value:

Example:

Available from: AVA Official - Update 7 (8.4.7.23158)
SupplierOrderIds string false

(optional parameter) Ids of (more) supplier orders in strings separated with comma. Example: @SupplierOrderIds = ('13','25')

Type: varchar(8000)

Default value:

Example:

Available from: AVA Official - Update 7 (8.4.7.23158)
SupplierOrderLinesIds string false

(optional parameter) Ids of (more) supplier order lines in strings separated with comma. Example: @SupplierOrderLinesIds = ('13','25')

Type: varchar(8000)

Default value:

Example:

Available from: AVA Official - Update 7 (8.4.7.23158)
SupplierOrderLinesLocQtyIds string false

(optional parameter) Ids of (more) supplier order lines location quantity in strings separated with comma. Example: @SupplierOrderLinesLocQtyIds = ('13','25')

Type: varchar(8000)

Default value:

Example:

Available from: AVA Official - Update 7 (8.4.7.23158)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiSupplierOrderLineLocQtyGet>
      <AppName>string</AppName>
      <SupplierOrderIds>string</SupplierOrderIds>
      <SupplierOrderLinesIds>string</SupplierOrderLinesIds>
      <SupplierOrderLinesLocQtyIds>string</SupplierOrderLinesLocQtyIds>
    </pixiSupplierOrderLineLocQtyGet>
  </Body>
</Envelope>

Response

1. Result Set.

Name Type Description
Id integer

Supplier order line location quantity Id.

Type: int

Available from: 25.06 (25.6.0.58802)
Qty integer

Type: int

Available from: 25.06 (25.6.0.58802)
LocationId integer

Type: int

Available from: 25.06 (25.6.0.58802)
RowVersion integer

Row version

Type: int

Available from: 25.06 (25.6.0.58802)
DeliveredQty integer

Delivered Quantity

Type: int

Available from: 25.06 (25.6.0.58802)
UndeliveredQty integer

Undelivered Quantity

Type: int

Available from: 25.06 (25.6.0.58802)
RecordCreatedOn string

Create date

Type: datetime

Available from: 25.06 (25.6.0.58802)
RecordModifiedOn string

Update Date

Type: datetime

Available from: 25.06 (25.6.0.58802)
SupplierOrderLineId integer

Supplier orderline Id

Type: int

Available from: 25.06 (25.6.0.58802)
RecordCreatedByUserId integer

Created by user Id

Type: int

Available from: 25.06 (25.6.0.58802)
RecordModifiedByUserId integer

Updated by User Id

Type: int

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiSupplierOrderLineLocQtyGetPost400TextXmlResponse>
  <Id>0</Id>
  <RecordCreatedOn>string</RecordCreatedOn>
  <RecordCreatedByUserId>0</RecordCreatedByUserId>
  <RecordModifiedOn>string</RecordModifiedOn>
  <RecordModifiedByUserId>0</RecordModifiedByUserId>
  <RowVersion>0</RowVersion>
  <SupplierOrderLineId>0</SupplierOrderLineId>
  <LocationId>0</LocationId>
  <Qty>0</Qty>
  <DeliveredQty>0</DeliveredQty>
  <UndeliveredQty>0</UndeliveredQty>
</PixiSupplierOrderLineLocQtyGetPost400TextXmlResponse>

2. �Error Result Set.

Name Type Description
ReturnCode string

Return code. (SUCCESS, ERROR, WARNING)

Type: varchar (10)

Available from: 25.06 (25.6.0.58802)
ErrorMessage string

Description of the error.

Type: varchar (300)

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiSupplierOrderLineLocQtyGetPost400TextXmlResponse>
  <Id>0</Id>
  <RecordCreatedOn>string</RecordCreatedOn>
  <RecordCreatedByUserId>0</RecordCreatedByUserId>
  <RecordModifiedOn>string</RecordModifiedOn>
  <RecordModifiedByUserId>0</RecordModifiedByUserId>
  <RowVersion>0</RowVersion>
  <SupplierOrderLineId>0</SupplierOrderLineId>
  <LocationId>0</LocationId>
  <Qty>0</Qty>
  <DeliveredQty>0</DeliveredQty>
  <UndeliveredQty>0</UndeliveredQty>
</PixiSupplierOrderLineLocQtyGetPost400TextXmlResponse>

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:pixiSupplierOrderLineLocQtyGet>
            <AppName xsi:type="xsd:string"></AppName>
            <SupplierOrderIds xsi:type="xsd:string"></SupplierOrderIds>
            <SupplierOrderLinesIds xsi:type="xsd:string"></SupplierOrderLinesIds>
            <SupplierOrderLinesLocQtyIds xsi:type="xsd:string"></SupplierOrderLinesLocQtyIds>
        </ns1:pixiSupplierOrderLineLocQtyGet>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiSupplierOrderLineLocQtyGet', [
    'AppName' => '', // string
    'SupplierOrderIds' => '', // string
    'SupplierOrderLinesIds' => '', // string
    'SupplierOrderLinesLocQtyIds' => '', // 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);
}