Unofficial Pixi-API-Documentation

by koempf24.de

pixiShowSpecialCommentCustomers

Pixi-Docs
Old Pixi-Docs

Enabled but undocumented

This Call was made for customer REH (PC-95 Ticket in Jira). It returns Customer Account data.

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

Customers

Request

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

Request body

Name Type Required Description
Rows integer false

Number of rows returned.

Type: int

Default value: 300

Example: 123

Available from: LOU Official - Update 46 (6.9.46.27927)
InvoiceNr string false

Invoice number

Type: varchar(64)

Default value: NULL

Example: abcdefg

Available from: LOU Official - Update 46 (6.9.46.27927)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiShowSpecialCommentCustomers>
      <Rows>0</Rows>
      <InvoiceNr>string</InvoiceNr>
    </pixiShowSpecialCommentCustomers>
  </Body>
</Envelope>

Response

1. Customer account data

Name Type Description
SZIP string

SZIP

Type: varchar

Available from: 25.06 (25.6.0.58802)
SCity string

SCity

Type: varchar

Available from: 25.06 (25.6.0.58802)
SName string

SName

Type: varchar

Available from: 25.06 (25.6.0.58802)
total string

total

Type: varchar

Available from: 25.06 (25.6.0.58802)
InvDate string

InvDate

Type: datetime

Available from: 25.06 (25.6.0.58802)
SCareOf string

SCareOf

Type: varchar

Available from: 25.06 (25.6.0.58802)
CHisNote string

CHisNote

Type: varchar

Available from: 25.06 (25.6.0.58802)
InvoiceNr string

InvoiceNr

Type: varchar

Available from: 25.06 (25.6.0.58802)
CurrencyCode string

CurrencyCode

Type: varchar

Available from: 25.06 (25.6.0.58802)
DATEVAccountNr string

DATEVAccountNr

Type: varchar

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiShowSpecialCommentCustomersPost200TextXmlResponse>
  <SName>string</SName>
  <SCareOf>string</SCareOf>
  <SZIP>string</SZIP>
  <SCity>string</SCity>
  <CHisNote>string</CHisNote>
  <InvoiceNr>string</InvoiceNr>
  <total>string</total>
  <InvDate>string</InvDate>
  <DATEVAccountNr>string</DATEVAccountNr>
  <CurrencyCode>string</CurrencyCode>
</PixiShowSpecialCommentCustomersPost200TextXmlResponse>

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:pixiShowSpecialCommentCustomers>
            <Rows xsi:type="xsd:integer">123</Rows>
            <InvoiceNr xsi:type="xsd:string">abcdefg</InvoiceNr>
        </ns1:pixiShowSpecialCommentCustomers>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiShowSpecialCommentCustomers', [
    'Rows' => '123', // integer
    'InvoiceNr' => '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);
}