pixiReadCustomerAccountMatch

API call returns customer account match records

Since pixi version: 21.01 (9.0.23.54983) Additional notes:

Orderlines Orders

Request

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

Request body

Name	Type	Required	Description
CustRef	integer	false	Customer reference (CustKey). Filters to match records where either side belongs to a customer account of this customer. Type: int Default value: NULL Example: 12345 Available from: (26.6.0.11854)
RowCount	integer	false	Maximum number of records returned Type: int Default value: 1000 Example: 123 Available from: 21.01 (9.0.23.54983)
CreateDateTo	string	false	Create Date to (excluding) Type: datetime Default value: NULL Example: YYYY-MM-DD hh:mm:ss Available from: 21.01 (9.0.23.54983)
UpdateDateTo	string	false	Update Date To (excluding) Type: datetime Default value: NULL Example: YYYY-MM-DD hh:mm:ss Available from: 21.01 (9.0.23.54983)
CreateDateFrom	string	false	Create Date from (including) Type: datetime Default value: NULL Example: YYYY-MM-DD hh:mm:ss Available from: 21.01 (9.0.23.54983)
UpdateDateFrom	string	false	Update Date from (including) Type: datetime Default value: NULL Example: YYYY-MM-DD hh:mm:ss Available from: 21.01 (9.0.23.54983)
CustomerAccountKey	integer	false	Customer account key. Filters to match records where CAref1 or CAref2 equals this value. Type: int Default value: NULL Example: 67890 Available from: (26.6.0.11854)
CreateAndUpdateDateTo	string	false	Create or Update Date to (excluding) Type: datetime Default value: NULL Example: YYYY-MM-DD hh:mm:ss Available from: 21.01 (9.0.23.54983)
CreateAndUpdateDateFrom	string	false	Create or Update Date from (including) Type: datetime Default value: NULL Example: YYYY-MM-DD hh:mm:ss Available from: 21.01 (9.0.23.54983)
CustomerAccountMatchKey	integer	false	Customer account match id. If @RowCount is NULL then it returns only this row, otherwise next @RowCount records. Type: int Default value: NULL Example: 123 Available from: 21.01 (9.0.23.54983)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiReadCustomerAccountMatch>
      <CustomerAccountMatchKey>0</CustomerAccountMatchKey>
      <CreateDateFrom>string</CreateDateFrom>
      <CreateDateTo>string</CreateDateTo>
      <UpdateDateFrom>string</UpdateDateFrom>
      <UpdateDateTo>string</UpdateDateTo>
      <CreateAndUpdateDateFrom>string</CreateAndUpdateDateFrom>
      <CreateAndUpdateDateTo>string</CreateAndUpdateDateTo>
      <RowCount>0</RowCount>
      <CustRef>0</CustRef>
      <CustomerAccountKey>0</CustomerAccountKey>
    </pixiReadCustomerAccountMatch>
  </Body>
</Envelope>

Response

1. Customer account match information

Name	Type	Description
CAref1	integer	Customer account refference ID Type: int Available from: / (26.6.0.11854)
CAref2	integer	Customer account refference ID Type: int Available from: / (26.6.0.11854)
CreateEmp	string	Creator of the recodr (pixi* user) Type: varchar Available from: / (26.6.0.11854)
UpdateEmp	string	User who last updated the record Type: varchar Available from: / (26.6.0.11854)
CreateDate	string	Create date Type: datetime Available from: / (26.6.0.11854)
UpdateDate	string	Last update date of the record Type: datetime Available from: / (26.6.0.11854)
AbsoluteMatchAmount	number	Absolute match amount Type: money Available from: / (26.6.0.11854)
CustomerAccountMatchKey	integer	Customer account match ID Type: int Available from: / (26.6.0.11854)

Response Example

<PixiReadCustomerAccountMatchPost200TextXmlResponse>
  <CustomerAccountMatchKey>0</CustomerAccountMatchKey>
  <CAref1>0</CAref1>
  <CAref2>0</CAref2>
  <AbsoluteMatchAmount>0</AbsoluteMatchAmount>
  <CreateEmp>string</CreateEmp>
  <CreateDate>string</CreateDate>
  <UpdateEmp>string</UpdateEmp>
  <UpdateDate>string</UpdateDate>
</PixiReadCustomerAccountMatchPost200TextXmlResponse>

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:pixiReadCustomerAccountMatch>
            <CustRef xsi:type="xsd:integer">12345</CustRef>
            <RowCount xsi:type="xsd:integer">123</RowCount>
            <CreateDateTo xsi:type="xsd:string">YYYY-MM-DD hh:mm:ss</CreateDateTo>
            <UpdateDateTo xsi:type="xsd:string">YYYY-MM-DD hh:mm:ss</UpdateDateTo>
            <CreateDateFrom xsi:type="xsd:string">YYYY-MM-DD hh:mm:ss</CreateDateFrom>
            <UpdateDateFrom xsi:type="xsd:string">YYYY-MM-DD hh:mm:ss</UpdateDateFrom>
            <CustomerAccountKey xsi:type="xsd:integer">67890</CustomerAccountKey>
            <CreateAndUpdateDateTo xsi:type="xsd:string">YYYY-MM-DD hh:mm:ss</CreateAndUpdateDateTo>
            <CreateAndUpdateDateFrom xsi:type="xsd:string">YYYY-MM-DD hh:mm:ss</CreateAndUpdateDateFrom>
            <CustomerAccountMatchKey xsi:type="xsd:integer">123</CustomerAccountMatchKey>
        </ns1:pixiReadCustomerAccountMatch>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiReadCustomerAccountMatch', [
    'CustRef' => '12345', // integer
    'RowCount' => '123', // integer
    'CreateDateTo' => 'YYYY-MM-DD hh:mm:ss', // string
    'UpdateDateTo' => 'YYYY-MM-DD hh:mm:ss', // string
    'CreateDateFrom' => 'YYYY-MM-DD hh:mm:ss', // string
    'UpdateDateFrom' => 'YYYY-MM-DD hh:mm:ss', // string
    'CustomerAccountKey' => '67890', // integer
    'CreateAndUpdateDateTo' => 'YYYY-MM-DD hh:mm:ss', // string
    'CreateAndUpdateDateFrom' => 'YYYY-MM-DD hh:mm:ss', // string
    'CustomerAccountMatchKey' => '123', // 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);
}

Unofficial Pixi-API-Documentation

by koempf24.de