Unofficial Pixi-API-Documentation

by koempf24.de

pixiCustomerInfoSet

Pixi-Docs
Old Pixi-Docs

Set customer information, if 0 for not required parameters will be set, the option will be disabled. Customer is defined with customer Id or shop Id and customer number external/customer email.

Since pixi version: 19.10 (9.0.8.42994) Additional notes:

Orderlines Orders

Request

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

Request body

Name Type Required Description
ShopId string true

Filter: Shop Id

Type: varchar(3)

Default value: NULL

Example: abcdefg

Available from: 19.10 (9.0.8.42994)
CustKey integer true

Filter: Customer Id

Type: int

Default value: NULL

Example: abcdefg

Available from: 19.10 (9.0.8.42994)
ReminderCost number false

Reminder costs

Type: money

Default value: NULL

Example: 9.99

Available from: 19.10 (9.0.8.42994)
CustomerEmail string true

Filter: Customer email

Type: varchar(256)

Default value: NULL

Example: abcdefg

Available from: 19.10 (9.0.8.42994)
InvoiceDueDays string false

Customer invoice due days

Type: smallint

Default value: NULL

Example: 123

Available from: 19.10 (9.0.8.42994)
ReminderAction string false

Reminder action

Type: varchar(20)

Default value: NULL

Example: NONE, PRINT, MAIL, PRINT&MAIL, 0

Available from: 19.10 (9.0.8.42994)
ReminderDueDays string false

Reminder due days

Type: smallint

Default value: NULL

Example: 123

Available from: 19.10 (9.0.8.42994)
CustomerNrExternal string true

Filter: Customer number external

Type: varchar(60)

Default value: NULL

Example: abcdefg

Available from: 19.10 (9.0.8.42994)
DaysForNextReminder string false

Number of days till next reminder

Type: smallint

Default value: NULL

Example: 123

Available from: 19.10 (9.0.8.42994)
DaysForFirstReminder string false

Number of days till first reminder

Type: smallint

Default value: NULL

Example: 123

Available from: 19.10 (9.0.8.42994)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiCustomerInfoSet>
      <CustKey>0</CustKey>
      <CustomerNrExternal>string</CustomerNrExternal>
      <CustomerEmail>string</CustomerEmail>
      <ShopId>string</ShopId>
      <InvoiceDueDays>string</InvoiceDueDays>
      <ReminderAction>string</ReminderAction>
      <DaysForFirstReminder>string</DaysForFirstReminder>
      <DaysForNextReminder>string</DaysForNextReminder>
      <ReminderDueDays>string</ReminderDueDays>
      <ReminderCost>0</ReminderCost>
    </pixiCustomerInfoSet>
  </Body>
</Envelope>

Response

1. Status

Name Type Description
Status string

Status (OK/ERROR)

Type: varchar (50)

Available from: 25.06 (25.6.0.58802)
StatusMessage string

Status description

Type: varchar (2000)

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiCustomerInfoSetPost200TextXmlResponse>
  <Status>string</Status>
  <StatusMessage>string</StatusMessage>
</PixiCustomerInfoSetPost200TextXmlResponse>

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:pixiCustomerInfoSet>
            <ShopId xsi:type="xsd:string">abcdefg</ShopId> <!-- required -->
            <CustKey xsi:type="xsd:integer">abcdefg</CustKey> <!-- required -->
            <ReminderCost xsi:type="xsd:number">9.99</ReminderCost>
            <CustomerEmail xsi:type="xsd:string">abcdefg</CustomerEmail> <!-- required -->
            <InvoiceDueDays xsi:type="xsd:string">123</InvoiceDueDays>
            <ReminderAction xsi:type="xsd:string">NONE, PRINT, MAIL, PRINT&MAIL, 0</ReminderAction>
            <ReminderDueDays xsi:type="xsd:string">123</ReminderDueDays>
            <CustomerNrExternal xsi:type="xsd:string">abcdefg</CustomerNrExternal> <!-- required -->
            <DaysForNextReminder xsi:type="xsd:string">123</DaysForNextReminder>
            <DaysForFirstReminder xsi:type="xsd:string">123</DaysForFirstReminder>
        </ns1:pixiCustomerInfoSet>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiCustomerInfoSet', [
    'ShopId' => 'abcdefg', // string (required)
    'CustKey' => 'abcdefg', // integer (required)
    'ReminderCost' => '9.99', // number
    'CustomerEmail' => 'abcdefg', // string (required)
    'InvoiceDueDays' => '123', // string
    'ReminderAction' => 'NONE, PRINT, MAIL, PRINT&MAIL, 0', // string
    'ReminderDueDays' => '123', // string
    'CustomerNrExternal' => 'abcdefg', // string (required)
    'DaysForNextReminder' => '123', // string
    'DaysForFirstReminder' => '123', // 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);
}