pixiChangeAddress
Use this function to change the shipment or buyer address on a given order in pixi*.
Since pixi version: LOU Official (6.3.0.4452) Additional notes: Although the function checks whether the address allows itself to be changed at the current stage the order is at, it is sometimes useful to check it beforehand by use of the function pixiCanChangeAddress. Function can accept either pixi* order number or the shop order number. In case both parameters are supplied and denote two different orders, the returned infomation might not be correct, which is why it is recommended to use only one of the parameters. It is possible to change either one of the addresses or both at the same time (see parameter AddrType)
Request
Request body
Name | Type | Required | Description |
---|---|---|---|
BIC | string | false | BIC = Bank Identifier Code Type: varchar(11) Default value: NULL Example: Available from: LOU Official - Update 46 (6.9.46.27927) |
BLZ | string | false | Bankleitzahl = Wire code Type: varchar(8) Default value: NULL Example: Available from: LOU Official - Update 46 (6.9.46.27927) |
Fax | string | false | Parameter within the address block Type: varchar(60) Default value: NULL Example: Available from: LOU Official (6.3.0.4452) |
ZIP | string | false | Parameter within the address block Type: varchar(10) Default value: NULL Example: Available from: LOU Official (6.3.0.4452) |
City | string | false | Parameter within the address block Type: varchar(50) Default value: NULL Example: Available from: LOU Official (6.3.0.4452) |
Fax2 | string | false | Parameter within the address block Type: varchar(60) Default value: NULL Example: Available from: LOU Official (6.3.0.4452) |
IBAN | string | false | IBAN = International Bank Account Nr Type: varchar(35) Default value: NULL Example: Available from: LOU Official - Update 46 (6.9.46.27927) |
Note | string | false | Parameter within the address block Type: varchar(8000) Default value: NULL Example: Available from: AVA 17.07 (8.4.31.30601) |
Phone | string | false | Parameter within the address block Type: varchar(60) Default value: NULL Example: Available from: LOU Official (6.3.0.4452) |
State | string | false | Parameter within the address block Type: varchar(3) Default value: NULL Example: Available from: LOU Official (6.3.0.4452) |
VatId | string | false | Parameter within the address block Type: varchar(20) Default value: NULL Example: Available from: 25.02 (25.2.0.55233) |
string | false | Parameter within the address block Type: varchar(60) Default value: NULL Example: Available from: LOU Official (6.3.0.4452) |
|
Anrede | string | false | Parameter within the address block Type: varchar(60) Default value: NULL Example: Available from: LOU Official (6.3.0.4452) |
CareOf | string | false | Parameter within the address block Type: varchar(60) Default value: NULL Example: Available from: LOU Official (6.3.0.4452) |
Phone2 | string | false | Parameter within the address block Type: varchar(60) Default value: NULL Example: Available from: LOU Official (6.3.0.4452) |
Street | string | false | Parameter within the address block Type: varchar(100) Default value: NULL Example: Available from: LOU Official (6.3.0.4452) |
AccName | string | false | Name of the owner of the account Type: varchar(27) Default value: NULL Example: Available from: LOU Official - Update 46 (6.9.46.27927) |
Account | string | false | Account number for bank or other payments Type: varchar(10) Default value: NULL Example: Available from: LOU Official (6.3.0.4452) |
Country | string | false | Parameter within the address block Type: varchar(3) Default value: NULL Example: Available from: LOU Official (6.3.0.4452) |
HouseNr | string | false | Parameter within the address block Type: varchar(12) Default value: NULL Example: Available from: LOU Official (6.3.0.4452) |
OrderNr | integer | false | pixi* order number (when used, make sure that "OrderNrExternal" parameter is left empty) Type: int Default value: NULL Example: 123456 Available from: LOU Official (6.3.0.4452) |
ASlocked | string | false | By setting this parameter to 0 or 1 you can lock or unlock the order given in either of the parameters OrderNr, or OrderNrExternal. This is the lock only for this given order and not the customer lock. Type: varchar(1) Default value: NULL Example: Available from: LOU Official - Update 46 (6.9.46.27927) |
AddrType | string | true | The type of address that you are attempting to change. "B" = buyer address, "S" = shipment address Type: char Default value: Example: B Available from: LOU Official (6.3.0.4452) |
BankName | string | false | Name of the bank Type: varchar(50) Default value: NULL Example: Available from: LOU Official - Update 46 (6.9.46.27927) |
LastName | string | false | Parameter within the address block Type: varchar(60) Default value: NULL Example: Available from: LOU Official (6.3.0.4452) |
FirstName | string | false | Parameter within the address block Type: varchar(60) Default value: NULL Example: Available from: LOU Official (6.3.0.4452) |
CardHolderName | string | false | Parameter within the address block Type: varchar(60) Default value: NULL Example: Available from: LOU Official - Update 46 (6.9.46.27927) |
FunctionResult | string | false | OUTPUT parameter Type: varchar(128) Default value: NULL Example: Available from: LOU Official - Update 46 (6.9.46.27927) |
OrderNrExternal | string | false | Shop order number (when used, make sure that "OrderNr" parameter is left empty) Type: varchar(50) Default value: NULL Example: abc123 Available from: LOU Official (6.3.0.4452) |
Request Example
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
<Body xmlns="">
<pixiChangeAddress>
<OrderNr>0</OrderNr>
<OrderNrExternal>string</OrderNrExternal>
<AddrType>string</AddrType>
<Anrede>string</Anrede>
<FirstName>string</FirstName>
<LastName>string</LastName>
<CareOf>string</CareOf>
<Street>string</Street>
<HouseNr>string</HouseNr>
<City>string</City>
<State>string</State>
<ZIP>string</ZIP>
<Country>string</Country>
<Phone>string</Phone>
<Phone2>string</Phone2>
<Fax>string</Fax>
<Fax2>string</Fax2>
<eMail>string</eMail>
<Account>string</Account>
<BLZ>string</BLZ>
<BankName>string</BankName>
<AccName>string</AccName>
<BIC>string</BIC>
<IBAN>string</IBAN>
<ASlocked>string</ASlocked>
<FunctionResult>string</FunctionResult>
<CardHolderName>string</CardHolderName>
<Note>string</Note>
<VatId>string</VatId>
</pixiChangeAddress>
</Body>
</Envelope>
Response
1. Result status output
Name | Type | Description |
---|---|---|
Result | string | Result status: "200 OK", "402 Address not found", ... Type: varchar Available from: 25.06 (25.6.0.58802) |
Response Example
<PixiChangeAddressPost200TextXmlResponse>
<Result>string</Result>
</PixiChangeAddressPost200TextXmlResponse>
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:pixiChangeAddress>
<BIC xsi:type="xsd:string"></BIC>
<BLZ xsi:type="xsd:string"></BLZ>
<Fax xsi:type="xsd:string"></Fax>
<ZIP xsi:type="xsd:string"></ZIP>
<City xsi:type="xsd:string"></City>
<Fax2 xsi:type="xsd:string"></Fax2>
<IBAN xsi:type="xsd:string"></IBAN>
<Note xsi:type="xsd:string"></Note>
<Phone xsi:type="xsd:string"></Phone>
<State xsi:type="xsd:string"></State>
<VatId xsi:type="xsd:string"></VatId>
<eMail xsi:type="xsd:string"></eMail>
<Anrede xsi:type="xsd:string"></Anrede>
<CareOf xsi:type="xsd:string"></CareOf>
<Phone2 xsi:type="xsd:string"></Phone2>
<Street xsi:type="xsd:string"></Street>
<AccName xsi:type="xsd:string"></AccName>
<Account xsi:type="xsd:string"></Account>
<Country xsi:type="xsd:string"></Country>
<HouseNr xsi:type="xsd:string"></HouseNr>
<OrderNr xsi:type="xsd:integer">123456</OrderNr>
<ASlocked xsi:type="xsd:string"></ASlocked>
<AddrType xsi:type="xsd:string">B</AddrType> <!-- required -->
<BankName xsi:type="xsd:string"></BankName>
<LastName xsi:type="xsd:string"></LastName>
<FirstName xsi:type="xsd:string"></FirstName>
<CardHolderName xsi:type="xsd:string"></CardHolderName>
<FunctionResult xsi:type="xsd:string"></FunctionResult>
<OrderNrExternal xsi:type="xsd:string">abc123</OrderNrExternal>
</ns1:pixiChangeAddress>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
PHP Example
<?php
getPixiSoapClientResponse('pixiChangeAddress', [
'BIC' => '', // string
'BLZ' => '', // string
'Fax' => '', // string
'ZIP' => '', // string
'City' => '', // string
'Fax2' => '', // string
'IBAN' => '', // string
'Note' => '', // string
'Phone' => '', // string
'State' => '', // string
'VatId' => '', // string
'eMail' => '', // string
'Anrede' => '', // string
'CareOf' => '', // string
'Phone2' => '', // string
'Street' => '', // string
'AccName' => '', // string
'Account' => '', // string
'Country' => '', // string
'HouseNr' => '', // string
'OrderNr' => '123456', // integer
'ASlocked' => '', // string
'AddrType' => 'B', // string (required)
'BankName' => '', // string
'LastName' => '', // string
'FirstName' => '', // string
'CardHolderName' => '', // string
'FunctionResult' => '', // string
'OrderNrExternal' => 'abc123', // 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);
}