Unofficial Pixi-API-Documentation

by koempf24.de

pixiSupplierOrderLineLocQtyUpdate

Pixi-Docs
Old Pixi-Docs

Recommended

Update one supplier order line location quantity.

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

Suppliers

Request

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

Request body

Name Type Required Description
Qty integer false

(optional parameter) Update quantity.

Type: int

Default value:

Example:

Available from: AVA Official - Update 7 (8.4.7.23158)
UserId integer false

(optional parameter) Id of user who execute API call.

Type: int

Default value:

Example:

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

Name of application which execute API call.

Type: varchar(255)

Default value:

Example:

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

User name of user who execute API call.

Type: varchar(50)

Default value:

Example:

Available from: AVA Official - Update 7 (8.4.7.23158)
UndeliveredQty integer false

(optional parameter) Update only undelivered quantity. In case parameter sent as NULL nothing will change, otherwise existed value will be overwritten with sent value.

Type: int

Default value:

Example:

Available from: AVA Official - Update 7 (8.4.7.23158)
ConsiderMinOrderQty boolean false

(optional parameter - default 0) Same functionality as at supplier order suggestions, apply (0 no, 1 yes) minimum order quantity.

Type: bit

Default value:

Example:

Available from: AVA Official - Update 7 (8.4.7.23158)
ConsiderPackageUnits boolean false

(optional parameter - default 0) Same functionality as at supplier order suggestions, apply (0 no, 1 yes) packing units.

Type: bit

Default value:

Example:

Available from: AVA Official - Update 7 (8.4.7.23158)
SupplierOrderLineLocQtyId integer false

(optional parameter - must be provided if you wish to update ordered or undelivered quantity) Supplier order line location quantity Id.

Type: int

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="">
    <pixiSupplierOrderLineLocQtyUpdate>
      <AppName>string</AppName>
      <UserId>0</UserId>
      <UserName>string</UserName>
      <SupplierOrderLineLocQtyId>0</SupplierOrderLineLocQtyId>
      <ConsiderPackageUnits>true</ConsiderPackageUnits>
      <ConsiderMinOrderQty>true</ConsiderMinOrderQty>
      <Qty>0</Qty>
      <UndeliveredQty>0</UndeliveredQty>
    </pixiSupplierOrderLineLocQtyUpdate>
  </Body>
</Envelope>

Response

1. Result Set.

Name Type Description
Updated_SupplierOrderLineLocQtyId integer

Supplier order line location quantity Id.

Type: int

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiSupplierOrderLineLocQtyUpdatePost400TextXmlResponse>
  <Updated_SupplierOrderLineLocQtyId>0</Updated_SupplierOrderLineLocQtyId>
</PixiSupplierOrderLineLocQtyUpdatePost400TextXmlResponse>

2. �Error Result Set.

Name Type Description
ReturnCode string

Return code. (ERROR)

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

<PixiSupplierOrderLineLocQtyUpdatePost400TextXmlResponse>
  <Updated_SupplierOrderLineLocQtyId>0</Updated_SupplierOrderLineLocQtyId>
</PixiSupplierOrderLineLocQtyUpdatePost400TextXmlResponse>

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:pixiSupplierOrderLineLocQtyUpdate>
            <Qty xsi:type="xsd:integer"></Qty>
            <UserId xsi:type="xsd:integer"></UserId>
            <AppName xsi:type="xsd:string"></AppName>
            <UserName xsi:type="xsd:string"></UserName>
            <UndeliveredQty xsi:type="xsd:integer"></UndeliveredQty>
            <ConsiderMinOrderQty xsi:type="xsd:boolean"></ConsiderMinOrderQty>
            <ConsiderPackageUnits xsi:type="xsd:boolean"></ConsiderPackageUnits>
            <SupplierOrderLineLocQtyId xsi:type="xsd:integer"></SupplierOrderLineLocQtyId>
        </ns1:pixiSupplierOrderLineLocQtyUpdate>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiSupplierOrderLineLocQtyUpdate', [
    'Qty' => '', // integer
    'UserId' => '', // integer
    'AppName' => '', // string
    'UserName' => '', // string
    'UndeliveredQty' => '', // integer
    'ConsiderMinOrderQty' => '', // boolean
    'ConsiderPackageUnits' => '', // boolean
    'SupplierOrderLineLocQtyId' => '', // integer
]);

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