Unofficial Pixi-API-Documentation

by koempf24.de

pixiUpdateSupplier

Pixi-Docs
Old Pixi-Docs

API call to update supplier details

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

General

Request

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

Request body

Name Type Required Description
eMail string false

Update E-Mail address

Type: varchar(60)

Default value: NULL

Example: abcd

Available from: AVA Official - Update 23 (8.4.23.27873)
CustNR string false

Update Customer number

Type: varchar(20)

Default value: NULL

Example: abcd

Available from: AVA Official - Update 23 (8.4.23.27873)
SupZip string false

Update supplier ZIP

Type: varchar(20)

Default value: NULL

Example: abcd

Available from: AVA Official - Update 23 (8.4.23.27873)
SupCity string false

Update supplier city

Type: varchar(50)

Default value: NULL

Example: abcd

Available from: AVA Official - Update 23 (8.4.23.27873)
SupplNr string false

Filter: Update supplier by supplier number (code)

Type: varchar(4)

Default value: NULL

Example: abcd

Available from: LOU Official (6.3.0.4452)
IsLocked boolean false

Lock Supplier

Type: bit

Default value: NULL

Example: 0 or 1

Available from: 22.03 (22.3.0.25600)
SupName2 string false

Update second supplier name

Type: varchar(60)

Default value: NULL

Example: abcd

Available from: AVA Official - Update 23 (8.4.23.27873)
SupAnrede string false

Update supplier title

Type: varchar(20)

Default value: NULL

Example: abcd

Available from: AVA Official - Update 23 (8.4.23.27873)
SupPhone1 string false

Update supplier phone

Type: varchar(50)

Default value: NULL

Example: abcd

Available from: AVA Official - Update 23 (8.4.23.27873)
SupPhone2 string false

Update supplier 2nd phone number

Type: varchar(50)

Default value: NULL

Example: abcd

Available from: AVA Official - Update 23 (8.4.23.27873)
SupplCtry string false

Update supplier country

Type: varchar(3)

Default value: NULL

Example: abcd

Available from: AVA Official - Update 23 (8.4.23.27873)
SupplName string false

Update supplier name

Type: varchar(60)

Default value: NULL

Example: abcd

Available from: LOU Official (6.3.0.4452)
CurrencyId string false

Update currency ID

Type: smallint

Default value: NULL

Example: abcd

Available from: AVA Official - Update 23 (8.4.23.27873)
IsDisabled boolean false

Disable Supplier

Type: bit

Default value: NULL

Example: 0 or 1

Available from: 22.03 (22.3.0.25600)
SupAddress string false

Update supplier address

Type: varchar(50)

Default value: NULL

Example: abcd

Available from: AVA Official - Update 23 (8.4.23.27873)
SupplFaxNR string false

Update fax Number

Type: varchar(100)

Default value: NULL

Example: abcd

Available from: AVA Official - Update 23 (8.4.23.27873)
SupplGroup string false

Update supplier group

Type: varchar(4)

Default value: NULL

Example: abcd

Available from: LOU Official (6.3.0.4452)
HomePageUrl string false

Update supplier home page URL

Type: nvarchar

Default value: NULL

Example: abcd

Available from: AVA Official - Update 23 (8.4.23.27873)
SupplNameExt string false

Update external supplier name

Type: varchar(50)

Default value: NULL

Example: abcd

Available from: LOU Official (6.3.0.4452)
SupplierNote string false

Update supplier note

Type: varchar(8000)

Default value: NULL

Example: abcd

Available from: 22.03 (22.3.0.25600)
MainContact_Fax string false

Update main contact fax number

Type: nvarchar

Default value: NULL

Example: abcd

Available from: AVA Official - Update 23 (8.4.23.27873)
SupplierComment string false

Update supplier description

Type: varchar(8000)

Default value: NULL

Example: abcd

Available from: 19.02 (8.4.50.37001)
eMailSupplOrder string false

Update E-mail where to send the supplier order

Type: varchar(255)

Default value: NULL

Example: abcd

Available from: AVA Official - Update 23 (8.4.23.27873)
MainContact_Email string false

Update main contact e-mail address

Type: nvarchar

Default value: NULL

Example: abcd

Available from: AVA Official - Update 23 (8.4.23.27873)
MainContact_Phone string false

Update main contact phone number

Type: varchar(200)

Default value: NULL

Example: abcd

Available from: AVA Official - Update 23 (8.4.23.27873)
MainContact_Title string false

Update main contact title

Type: nvarchar

Default value: NULL

Example: abcd

Available from: AVA Official - Update 23 (8.4.23.27873)
DefaultDeliveryDays integer false

Update default delivery days

Type: int

Default value: NULL

Example: abcd

Available from: AVA Official - Update 23 (8.4.23.27873)
MainContact_JobTitle string false

Update main contact job title

Type: nvarchar

Default value: NULL

Example: abcd

Available from: AVA Official - Update 23 (8.4.23.27873)
MainContact_LastName string false

Update main contact last name

Type: nvarchar

Default value: NULL

Example: abcd

Available from: AVA Official - Update 23 (8.4.23.27873)
MainContact_FirstName string false

Update main contact first name

Type: nvarchar

Default value: NULL

Example: abcd

Available from: AVA Official - Update 23 (8.4.23.27873)
CanDoDirectFulfillment string false

Update indicator if supplier can do direct fulfillment

Type: varchar(1)

Default value: NULL

Example: abcd

Available from: AVA Official - Update 23 (8.4.23.27873)
MainContact_JobFunction string false

Update main contact job function

Type: nvarchar

Default value: NULL

Example: abcd

Available from: AVA Official - Update 23 (8.4.23.27873)
MainContact_MobilePhone string false

Update main cotact mobile phone number

Type: varchar(200)

Default value: NULL

Example: abcd

Available from: AVA Official - Update 23 (8.4.23.27873)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiUpdateSupplier>
      <SupplNr>string</SupplNr>
      <SupplName>string</SupplName>
      <SupplNameExt>string</SupplNameExt>
      <SupplGroup>string</SupplGroup>
      <DefaultDeliveryDays>0</DefaultDeliveryDays>
      <SupplFaxNR>string</SupplFaxNR>
      <CustNR>string</CustNR>
      <eMail>string</eMail>
      <SupAnrede>string</SupAnrede>
      <SupName2>string</SupName2>
      <SupAddress>string</SupAddress>
      <SupZip>string</SupZip>
      <SupPhone1>string</SupPhone1>
      <CanDoDirectFulfillment>string</CanDoDirectFulfillment>
      <SupCity>string</SupCity>
      <SupPhone2>string</SupPhone2>
      <SupplCtry>string</SupplCtry>
      <CurrencyId>string</CurrencyId>
      <eMailSupplOrder>string</eMailSupplOrder>
      <HomePageUrl>string</HomePageUrl>
      <MainContact_Title>string</MainContact_Title>
      <MainContact_FirstName>string</MainContact_FirstName>
      <MainContact_LastName>string</MainContact_LastName>
      <MainContact_JobTitle>string</MainContact_JobTitle>
      <MainContact_JobFunction>string</MainContact_JobFunction>
      <MainContact_Phone>string</MainContact_Phone>
      <MainContact_MobilePhone>string</MainContact_MobilePhone>
      <MainContact_Fax>string</MainContact_Fax>
      <MainContact_Email>string</MainContact_Email>
      <SupplierComment>string</SupplierComment>
      <SupplierNote>string</SupplierNote>
      <IsDisabled>true</IsDisabled>
      <IsLocked>true</IsLocked>
    </pixiUpdateSupplier>
  </Body>
</Envelope>

Response

1. Return status for update Supplier

Name Type Description
Message string

Error message, when something unexpected happened

Type: VARCHAR

Available from: 25.06 (25.6.0.58802)
ReturnCode string

Return code - Error or Success

Type: VARCHAR

Available from: 25.06 (25.6.0.58802)
ErrorMessage string

System error message (in case of error)

Type: NVARCHAR

Available from: 25.06 (25.6.0.58802)
RowsAffected integer

Number of updated records

Type: INT

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiUpdateSupplierPost200TextXmlResponse>
  <RowsAffected>0</RowsAffected>
  <ReturnCode>string</ReturnCode>
  <Message>string</Message>
  <ErrorMessage>string</ErrorMessage>
</PixiUpdateSupplierPost200TextXmlResponse>

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:pixiUpdateSupplier>
            <eMail xsi:type="xsd:string">abcd</eMail>
            <CustNR xsi:type="xsd:string">abcd</CustNR>
            <SupZip xsi:type="xsd:string">abcd</SupZip>
            <SupCity xsi:type="xsd:string">abcd</SupCity>
            <SupplNr xsi:type="xsd:string">abcd</SupplNr>
            <IsLocked xsi:type="xsd:boolean">0 or 1</IsLocked>
            <SupName2 xsi:type="xsd:string">abcd</SupName2>
            <SupAnrede xsi:type="xsd:string">abcd</SupAnrede>
            <SupPhone1 xsi:type="xsd:string">abcd</SupPhone1>
            <SupPhone2 xsi:type="xsd:string">abcd</SupPhone2>
            <SupplCtry xsi:type="xsd:string">abcd</SupplCtry>
            <SupplName xsi:type="xsd:string">abcd</SupplName>
            <CurrencyId xsi:type="xsd:string">abcd</CurrencyId>
            <IsDisabled xsi:type="xsd:boolean">0 or 1</IsDisabled>
            <SupAddress xsi:type="xsd:string">abcd</SupAddress>
            <SupplFaxNR xsi:type="xsd:string">abcd</SupplFaxNR>
            <SupplGroup xsi:type="xsd:string">abcd</SupplGroup>
            <HomePageUrl xsi:type="xsd:string">abcd</HomePageUrl>
            <SupplNameExt xsi:type="xsd:string">abcd</SupplNameExt>
            <SupplierNote xsi:type="xsd:string">abcd</SupplierNote>
            <MainContact_Fax xsi:type="xsd:string">abcd</MainContact_Fax>
            <SupplierComment xsi:type="xsd:string">abcd</SupplierComment>
            <eMailSupplOrder xsi:type="xsd:string">abcd</eMailSupplOrder>
            <MainContact_Email xsi:type="xsd:string">abcd</MainContact_Email>
            <MainContact_Phone xsi:type="xsd:string">abcd</MainContact_Phone>
            <MainContact_Title xsi:type="xsd:string">abcd</MainContact_Title>
            <DefaultDeliveryDays xsi:type="xsd:integer">abcd</DefaultDeliveryDays>
            <MainContact_JobTitle xsi:type="xsd:string">abcd</MainContact_JobTitle>
            <MainContact_LastName xsi:type="xsd:string">abcd</MainContact_LastName>
            <MainContact_FirstName xsi:type="xsd:string">abcd</MainContact_FirstName>
            <CanDoDirectFulfillment xsi:type="xsd:string">abcd</CanDoDirectFulfillment>
            <MainContact_JobFunction xsi:type="xsd:string">abcd</MainContact_JobFunction>
            <MainContact_MobilePhone xsi:type="xsd:string">abcd</MainContact_MobilePhone>
        </ns1:pixiUpdateSupplier>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiUpdateSupplier', [
    'eMail' => 'abcd', // string
    'CustNR' => 'abcd', // string
    'SupZip' => 'abcd', // string
    'SupCity' => 'abcd', // string
    'SupplNr' => 'abcd', // string
    'IsLocked' => '0 or 1', // boolean
    'SupName2' => 'abcd', // string
    'SupAnrede' => 'abcd', // string
    'SupPhone1' => 'abcd', // string
    'SupPhone2' => 'abcd', // string
    'SupplCtry' => 'abcd', // string
    'SupplName' => 'abcd', // string
    'CurrencyId' => 'abcd', // string
    'IsDisabled' => '0 or 1', // boolean
    'SupAddress' => 'abcd', // string
    'SupplFaxNR' => 'abcd', // string
    'SupplGroup' => 'abcd', // string
    'HomePageUrl' => 'abcd', // string
    'SupplNameExt' => 'abcd', // string
    'SupplierNote' => 'abcd', // string
    'MainContact_Fax' => 'abcd', // string
    'SupplierComment' => 'abcd', // string
    'eMailSupplOrder' => 'abcd', // string
    'MainContact_Email' => 'abcd', // string
    'MainContact_Phone' => 'abcd', // string
    'MainContact_Title' => 'abcd', // string
    'DefaultDeliveryDays' => 'abcd', // integer
    'MainContact_JobTitle' => 'abcd', // string
    'MainContact_LastName' => 'abcd', // string
    'MainContact_FirstName' => 'abcd', // string
    'CanDoDirectFulfillment' => 'abcd', // string
    'MainContact_JobFunction' => 'abcd', // string
    'MainContact_MobilePhone' => 'abcd', // 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);
}