Description
Use this function to change the shipment or buyer address on a given order in pixi*.
Request Parameters
# |
Name |
Type |
Required |
Example |
Description |
1 |
OrderNr |
integer |
0 |
123456 |
pixi* order number (when used, make sure that "OrderNrExternal" parameter is left empty) |
2 |
OrderNrExternal |
string |
0 |
abc123 |
Shop order number (when used, make sure that "OrderNr" parameter is left empty) |
3 |
AddrType |
string |
1 |
B |
The type of address that you are attempting to change. "B" = buyer address, "S" = shipment address |
4 |
Anrede |
string |
0 |
Sample text |
Parameter within the address block |
5 |
FirstName |
string |
0 |
Sample text |
Parameter within the address block |
6 |
LastName |
string |
0 |
Sample text |
Parameter within the address block |
7 |
CareOf |
string |
0 |
Sample text |
Parameter within the address block |
8 |
Street |
string |
0 |
Sample text |
Parameter within the address block |
9 |
HouseNr |
string |
0 |
Sample text |
Parameter within the address block |
10 |
City |
string |
0 |
Sample text |
Parameter within the address block |
11 |
State |
string |
0 |
Sample text |
Parameter within the address block |
12 |
ZIP |
string |
0 |
Sample text |
Parameter within the address block |
13 |
Country |
string |
0 |
Sample text |
Parameter within the address block |
14 |
Phone |
string |
0 |
Sample text |
Parameter within the address block |
15 |
Phone2 |
string |
0 |
Sample text |
Parameter within the address block |
16 |
Fax |
string |
0 |
Sample text |
Parameter within the address block |
17 |
Fax2 |
string |
0 |
Sample text |
Parameter within the address block |
18 |
string |
0 |
Sample text |
Parameter within the address block |
|
19 |
Account |
string |
0 |
Sample text |
Account number for bank or other payments |
20 |
BLZ |
string |
0 |
Sample text |
Bankleitzahl = Wire code |
21 |
BankName |
string |
0 |
Sample text |
Name of the bank |
22 |
AccName |
string |
0 |
Sample text |
Name of the owner of the account |
23 |
BIC |
string |
0 |
Sample text |
BIC = Bank Identifier Code |
24 |
IBAN |
string |
0 |
Sample text |
IBAN = International Bank Account Nr |
25 |
ASlocked |
string |
0 |
Sample text |
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. |
26 |
FunctionResult |
string |
0 |
Sample text |
OUTPUT parameter |
27 |
CardHolderName |
string |
0 |
Sample text |
Parameter within the address block |
28 |
Note |
string |
0 |
Sample text |
Parameter within the address block |
29 |
VatId |
string |
0 |
Sample text |
Parameter within the address block |
Request body
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:dem="https://api.pixi.eu/soap/demosandbox/">
<soapenv:Header/>
<soapenv:Body>
<dem:pixiChangeAddress>
<dem:OrderNr>123456</dem:OrderNr>
<dem:OrderNrExternal>abc123</dem:OrderNrExternal>
<dem:AddrType>B</dem:AddrType>
<dem:Anrede>Sample text</dem:Anrede>
<dem:FirstName>Sample text</dem:FirstName>
<dem:LastName>Sample text</dem:LastName>
<dem:CareOf>Sample text</dem:CareOf>
<dem:Street>Sample text</dem:Street>
<dem:HouseNr>Sample text</dem:HouseNr>
<dem:City>Sample text</dem:City>
<dem:State>Sample text</dem:State>
<dem:ZIP>Sample text</dem:ZIP>
<dem:Country>Sample text</dem:Country>
<dem:Phone>Sample text</dem:Phone>
<dem:Phone2>Sample text</dem:Phone2>
<dem:Fax>Sample text</dem:Fax>
<dem:Fax2>Sample text</dem:Fax2>
<dem:eMail>Sample text</dem:eMail>
<dem:Account>Sample text</dem:Account>
<dem:BLZ>Sample text</dem:BLZ>
<dem:BankName>Sample text</dem:BankName>
<dem:AccName>Sample text</dem:AccName>
<dem:BIC>Sample text</dem:BIC>
<dem:IBAN>Sample text</dem:IBAN>
<dem:ASlocked>Sample text</dem:ASlocked>
<dem:FunctionResult>Sample text</dem:FunctionResult>
<dem:CardHolderName>Sample text</dem:CardHolderName>
<dem:Note>Sample text</dem:Note>
<dem:VatId>Sample text</dem:VatId>
</dem:pixiChangeAddress>
</soapenv:Body>
</soapenv:Envelope>Response
Body 1: Result status output
# |
Name |
Type |
Description |
1 |
Result |
string |
Result status: "200 OK", "402 Address not found", ... |
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)