Unofficial Pixi-API-Documentation

by koempf24.de

pixiOrderSetGdprPollingExportFlag

Pixi-Docs
Old Pixi-Docs

Set GDPR polling export flag on Order

Since pixi version: 20.01 (9.0.11.45931) Additional notes:

Orderlines Orders

Request

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

Request body

Name Type Required Description
User string false

Record modified by - User name

Type: varchar(50)

Default value: NULL

Example:

Available from: 20.01 (9.0.11.45931)
OrderNr integer false

Order number from table OrderHeader

Type: int

Default value: NULL

Example:

Available from: 20.01 (9.0.11.45931)
OrderNrExternal string false

Order number external from table OrderHeader

Type: varchar(50)

Default value: NULL

Example:

Available from: 20.01 (9.0.11.45931)
ExportGdprDataForPolling boolean true

GDPR polling export flag value

Type: bit

Default value:

Example:

Available from: 20.01 (9.0.11.45931)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiOrderSetGdprPollingExportFlag>
      <OrderNr>0</OrderNr>
      <OrderNrExternal>string</OrderNrExternal>
      <ExportGdprDataForPolling>true</ExportGdprDataForPolling>
      <User>string</User>
    </pixiOrderSetGdprPollingExportFlag>
  </Body>
</Envelope>

Response

1. Success and status/error message

Name Type Description
Status string

Result of API Call

Type: varchar(10)

Available from: 25.06 (25.6.0.58802)
Message string

Extended Result of API Call

Type: varchar(100)

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiOrderSetGdprPollingExportFlagPost200TextXmlResponse>
  <Status>string</Status>
  <Message>string</Message>
</PixiOrderSetGdprPollingExportFlagPost200TextXmlResponse>

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:pixiOrderSetGdprPollingExportFlag>
            <User xsi:type="xsd:string"></User>
            <OrderNr xsi:type="xsd:integer"></OrderNr>
            <OrderNrExternal xsi:type="xsd:string"></OrderNrExternal>
            <ExportGdprDataForPolling xsi:type="xsd:boolean"></ExportGdprDataForPolling> <!-- required -->
        </ns1:pixiOrderSetGdprPollingExportFlag>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiOrderSetGdprPollingExportFlag', [
    'User' => '', // string
    'OrderNr' => '', // integer
    'OrderNrExternal' => '', // string
    'ExportGdprDataForPolling' => '', // boolean (required)
]);

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);
}