Unofficial Pixi-API-Documentation

by koempf24.de

pixiUpdateCustomer

Pixi-Docs
Old Pixi-Docs

API call updates a customer and its corresponding address. All empty or skipped optional parameters will be ignored by the update statement.

Since pixi version: 19.05 (9.0.3.39170) Additional notes:

Orderlines Orders

Request

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

Request body

Name Type Required Description
Zip string false

Postal code of the city.

Type: varchar(10)

Default value: NULL

Example: abcdefg

Available from: 19.05 (9.0.3.39170)
City string false

City name.

Type: varchar(60)

Default value: NULL

Example: abcdefg

Available from: 19.05 (9.0.3.39170)
eMail string false

e-Mail address.

Type: varchar(256)

Default value: NULL

Example: abcdefg

Available from: 19.05 (9.0.3.39170)
Street string false

Street address.

Type: varchar(255)

Default value: NULL

Example: abcdefg

Available from: 19.05 (9.0.3.39170)
CustKey integer true

Customer ID that will be updated.

Type: int

Default value:

Example: 123

Available from: 19.05 (9.0.3.39170)
HouseNr string false

House number.

Type: varchar(10)

Default value: NULL

Example: abcdefg

Available from: 19.05 (9.0.3.39170)
LastName string false

Customers last name.

Type: varchar(60)

Default value: NULL

Example: abcdefg

Available from: 19.05 (9.0.3.39170)
FirstName string false

Customers first name.

Type: varchar(60)

Default value: NULL

Example: abcdefg

Available from: 19.05 (9.0.3.39170)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiUpdateCustomer>
      <CustKey>0</CustKey>
      <Street>string</Street>
      <HouseNr>string</HouseNr>
      <City>string</City>
      <Zip>string</Zip>
      <eMail>string</eMail>
      <FirstName>string</FirstName>
      <LastName>string</LastName>
    </pixiUpdateCustomer>
  </Body>
</Envelope>

Response

1. Return status

Name Type Description
ErrorMsg string

Status description (error/success) message

Type: VARCHAR(512)

Available from: 25.06 (25.6.0.58802)
StatusCode string

Status code

Type: VARCHAR(512)

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiUpdateCustomerPost200TextXmlResponse>
  <StatusCode>string</StatusCode>
  <ErrorMsg>string</ErrorMsg>
</PixiUpdateCustomerPost200TextXmlResponse>

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:pixiUpdateCustomer>
            <Zip xsi:type="xsd:string">abcdefg</Zip>
            <City xsi:type="xsd:string">abcdefg</City>
            <eMail xsi:type="xsd:string">abcdefg</eMail>
            <Street xsi:type="xsd:string">abcdefg</Street>
            <CustKey xsi:type="xsd:integer">123</CustKey> <!-- required -->
            <HouseNr xsi:type="xsd:string">abcdefg</HouseNr>
            <LastName xsi:type="xsd:string">abcdefg</LastName>
            <FirstName xsi:type="xsd:string">abcdefg</FirstName>
        </ns1:pixiUpdateCustomer>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiUpdateCustomer', [
    'Zip' => 'abcdefg', // string
    'City' => 'abcdefg', // string
    'eMail' => 'abcdefg', // string
    'Street' => 'abcdefg', // string
    'CustKey' => '123', // integer (required)
    'HouseNr' => 'abcdefg', // string
    'LastName' => 'abcdefg', // string
    'FirstName' => 'abcdefg', // 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);
}