pixiCreateReturn
This API call is used to actually create a new credit.
Since pixi version: LOU Official (6.3.0.4452) Additional notes: This API call creates a new credit based on an invoice. The call cannot be used to create a new return that is shown in pixi* Web and that can be worked on with pixi* Mobile!
Request
Request body
Name | Type | Required | Description |
---|---|---|---|
BIC | string | false | BIC Type: varchar(11) Default value: Example: Available from: AVA 17.03 (8.4.27.29272) |
BLZ | string | false | BLZ - Bankleitzahl (bank code) Type: char Default value: Example: Available from: LOU Official (6.3.0.4452) |
IBAN | string | false | IBAN Type: varchar(30) Default value: Example: Available from: AVA 17.03 (8.4.27.29272) |
Note | string | false | Note Type: varchar(255) Default value: Example: Available from: LOU Official (6.3.0.4452) |
Prices | string | true | Returned items prices (always gross). Separator is semicolon. Type: varchar(8000) Default value: Example: 5,99; Available from: LOU Official (6.3.0.4452) |
Account | string | false | Bank account number Type: varchar(10) Default value: Example: Available from: LOU Official (6.3.0.4452) |
ShipCost | number | false | Returned ship costs price, with minus sign. If Ship costs are not set, then inovice ship costs are returned. Type: money Default value: Example: Available from: LOU Official (6.3.0.4452) |
CAComment | string | false | Comment which is saved to Customer Account History (Do not Create DTAUS/SEPA, Do not Refund...) Type: varchar(1000) Default value: Example: Available from: AVA 17.03 (8.4.27.29272) |
CreateEmp | string | false | pixi* user name that creates return Type: varchar(50) Default value: Example: Available from: LOU Official (6.3.0.4452) |
InvoiceNr | string | true | Invoice nr. for which return needs to be created. You can create return only for one invoice per call. Type: varchar(20) Default value: Example: Available from: LOU Official (6.3.0.4452) |
CreateDate | string | false | Create date of the return; despite what was entered, always current datetime is used! Type: datetime Default value: Example: date format: YYYYMMDD hh:mm:ss[.mmm] Available from: LOU Official (6.3.0.4452) |
LanguageId | integer | false | Language ID used when creating history records. Type: int Default value: 2 - German Example: Available from: AVA 17.03 (8.4.27.29272) |
Quantities | string | true | Returned items quantities. Separator is semicolon. Type: varchar(8000) Default value: Example: 1;2;3; Available from: LOU Official (6.3.0.4452) |
AccountName | string | true | Bank account name Type: varchar(27) Default value: Example: Available from: LOU Official (6.3.0.4452) |
CreateDTAUS | boolean | false | Create DTAUS/SEPA when return is done. Bit value, default is true. If @DoNotRefund is true, then create DTAUS/SEPA is false. Type: bit Default value: Example: Available from: AVA 17.03 (8.4.27.29272) |
DoNotRefund | boolean | false | Do not refund. Bit value. Type: bit Default value: False Example: Available from: AVA 17.03 (8.4.27.29272) |
InvoiceDate | string | false | Invoice date; Despite what was entered, always current datetime is used! Type: datetime Default value: Example: date format: YYYYMMDD hh:mm:ss[.mmm] Available from: LOU Official (6.3.0.4452) |
PaymentType | string | true | Payment type code - Payment codes: L (Direct Debit), B (Cash), N (Cash on Delivery), K (Credit Card) Type: char Default value: Example: Available from: LOU Official (6.3.0.4452) |
InvoiceLines | string | true | Invoice line keys for which items return needs to be created. Semicolon as separator is mandatory even only one Key is provided. Type: varchar(8000) Default value: Example: 123; Available from: LOU Official (6.3.0.4452) |
ReturnCaseID | integer | false | Repairs Return Case ID Type: int Default value: Example: Available from: AVA 17.03 (8.4.27.29272) |
ReturnClosed | boolean | false | Return closed. Bit value. Type: bit Default value: True Example: Available from: LOU Official (6.3.0.4452) |
ReturnReason | string | false | Return reason Type: varchar(100) Default value: Example: Available from: LOU Official (6.3.0.4452) |
Voucher_Amount | number | false | Voucher amount Type: money Default value: Voucher amount form connected invoice or 0 Example: 9.78 Available from: 18.07 (8.4.43.34931) |
ReturnCostsAmount | number | false | Charge customers return costs for sending their items back. Positive price. If it is bigger then total returned, return costs are reset to -total and then total is set to 0. Used from Lou Update 26 and Ava Update 2 on. Type: money Default value: Example: Available from: AVA 17.03 (8.4.27.29272) |
MarkReturnDocumentForPrinting | boolean | false | Mark if Document (Credit) has to be printed. Type: bit Default value: 0 Example: 0 Available from: 23.04 (23.4.0.37024) |
Request Example
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
<Body xmlns="">
<pixiCreateReturn>
<InvoiceNr>string</InvoiceNr>
<InvoiceLines>string</InvoiceLines>
<Quantities>string</Quantities>
<Prices>string</Prices>
<PaymentType>string</PaymentType>
<Account>string</Account>
<BLZ>string</BLZ>
<AccountName>string</AccountName>
<ShipCost>0</ShipCost>
<Note>string</Note>
<ReturnReason>string</ReturnReason>
<CreateDate>string</CreateDate>
<CreateEmp>string</CreateEmp>
<InvoiceDate>string</InvoiceDate>
<ReturnClosed>true</ReturnClosed>
<ReturnCaseID>0</ReturnCaseID>
<CreateDTAUS>true</CreateDTAUS>
<DoNotRefund>true</DoNotRefund>
<CAComment>string</CAComment>
<IBAN>string</IBAN>
<BIC>string</BIC>
<LanguageId>0</LanguageId>
<ReturnCostsAmount>0</ReturnCostsAmount>
<Voucher_Amount>0</Voucher_Amount>
<MarkReturnDocumentForPrinting>true</MarkReturnDocumentForPrinting>
</pixiCreateReturn>
</Body>
</Envelope>
Response
1. When a return is created, a complete set of columns fomt the corresponding invoice is returned.
Name | Type | Description |
---|---|---|
1SS | boolean | One scan shipping flag. Type: bit Available from: 25.06 (25.6.0.58802) |
BLZ | string | Type: varchar Available from: 25.06 (25.6.0.58802) |
LSNr | integer | Type: int Available from: 25.06 (25.6.0.58802) |
Note | string | Type: varchar Available from: 25.06 (25.6.0.58802) |
BoxNr | integer | Box number that holds the items of the invoice. Type: int Available from: 25.06 (25.6.0.58802) |
Payed | string | Type: datetime Available from: 25.06 (25.6.0.58802) |
VATNo | string | Type: varchar Available from: 25.06 (25.6.0.58802) |
total | number | Invoice amount. Type: money Available from: 25.06 (25.6.0.58802) |
CardNr | string | Type: varchar Available from: 25.06 (25.6.0.58802) |
LSDate | string | Type: datetime Available from: 25.06 (25.6.0.58802) |
NODRef | integer | Type: int Available from: 25.06 (25.6.0.58802) |
PLHref | integer | Picklist number used for this invoice. Type: int Available from: 25.06 (25.6.0.58802) |
PayDay | string | Type: datetime Available from: 25.06 (25.6.0.58802) |
SUGKTO | string | Type: varchar Available from: 25.06 (25.6.0.58802) |
VATLow | number | Total sum of low VAT. Type: money Available from: 25.06 (25.6.0.58802) |
AccName | string | Type: varchar Available from: 25.06 (25.6.0.58802) |
Account | string | Type: varchar Available from: 25.06 (25.6.0.58802) |
AddrRef | integer | ID of billing address. Type: int Available from: 25.06 (25.6.0.58802) |
CardExp | string | Type: varchar Available from: 25.06 (25.6.0.58802) |
CustRef | integer | ID of customer. Type: int Available from: 25.06 (25.6.0.58802) |
DueDate | string | Type: datetime Available from: 25.06 (25.6.0.58802) |
InvDate | string | Invoice date. Type: datetime Available from: 25.06 (25.6.0.58802) |
IssueNr | string | Type: varchar Available from: 25.06 (25.6.0.58802) |
Payment | string | ID of payment type. Type: varchar Available from: 25.06 (25.6.0.58802) |
Printed | string | Type: varchar Available from: 25.06 (25.6.0.58802) |
RLSCost | number | Type: money Available from: 25.06 (25.6.0.58802) |
RLSDate | string | Type: datetime Available from: 25.06 (25.6.0.58802) |
Summary | number | Type: money Available from: 25.06 (25.6.0.58802) |
VATHigh | number | Total sum of high VAT. Type: money Available from: 25.06 (25.6.0.58802) |
VATType | string | Type: varchar Available from: 25.06 (25.6.0.58802) |
AuszugNr | string | Type: varchar Available from: 25.06 (25.6.0.58802) |
CCAddFee | number | Type: money Available from: 25.06 (25.6.0.58802) |
CardDate | string | Type: datetime Available from: 25.06 (25.6.0.58802) |
CardName | string | Type: varchar Available from: 25.06 (25.6.0.58802) |
CardType | string | Type: varchar Available from: 25.06 (25.6.0.58802) |
Packages | integer | Number of packages for the invoice. Type: int Available from: 25.06 (25.6.0.58802) |
PayedSum | number | Payed amount. Type: money Available from: 25.06 (25.6.0.58802) |
ShipCode | string | Type: varchar Available from: 25.06 (25.6.0.58802) |
VATHText | string | Text representation of high VAT. Type: varchar Available from: 25.06 (25.6.0.58802) |
VATLText | string | Text representation of low VAT. Type: varchar Available from: 25.06 (25.6.0.58802) |
ccpPayID | string | ID of credit card payment. Type: varchar Available from: 25.06 (25.6.0.58802) |
BuchuText | string | Type: varchar Available from: 25.06 (25.6.0.58802) |
CardCheck | string | Type: varchar Available from: 25.06 (25.6.0.58802) |
ChargeVAT | string | The flag that marks if the VAT should be charged. Type: char Available from: 25.06 (25.6.0.58802) |
CreateEmp | string | Employee who created the invoice. Type: varchar Available from: 25.06 (25.6.0.58802) |
GNMcharge | string | Type: varchar Available from: 25.06 (25.6.0.58802) |
InvShopID | string | Shop ID that invoice was created for. Type: varchar Available from: 25.06 (25.6.0.58802) |
InvoiceNr | string | Invoice number. Type: varchar Available from: 25.06 (25.6.0.58802) |
OrderType | string | Type of the order/invoice. Type: varchar Available from: 25.06 (25.6.0.58802) |
PrintDate | string | Type: datetime Available from: 25.06 (25.6.0.58802) |
SkontoAbz | number | Type: money Available from: 25.06 (25.6.0.58802) |
StockNote | string | Type: varchar Available from: 25.06 (25.6.0.58802) |
Supporter | string | Type: varchar Available from: 25.06 (25.6.0.58802) |
Total_Net | number | Type: money Available from: 25.06 (25.6.0.58802) |
UpdateEmp | string | Employee who last updated the invoice. Type: varchar Available from: 25.06 (25.6.0.58802) |
VoucherID | string | ID of the voucher. Type: varchar Available from: 25.06 (25.6.0.58802) |
CreateDate | string | Creation date of the invoice. Type: datetime Available from: 25.06 (25.6.0.58802) |
InvoiceKey | integer | ID of the invoice. Type: int Available from: 25.06 (25.6.0.58802) |
ShipAdrRef | integer | ID of shipping address. Type: int Available from: 25.06 (25.6.0.58802) |
ShipVendor | string | Shipping vendor code. Type: varchar Available from: 25.06 (25.6.0.58802) |
UpdateDate | string | Last update date of the invoice. Type: datetime Available from: 25.06 (25.6.0.58802) |
VATBaseLow | number | Sum of low VAT. Type: money Available from: 25.06 (25.6.0.58802) |
VATLowPerc | number | The VAT percent of low VAT. Type: numeric Available from: 25.06 (25.6.0.58802) |
VoucherSum | number | Total sum of the voucher for the invoice. Type: money Available from: 25.06 (25.6.0.58802) |
ccpTransID | string | ID of credit card transaction. Type: varchar Available from: 25.06 (25.6.0.58802) |
retTrackID | string | Tracking ID of the return. Type: varchar Available from: 25.06 (25.6.0.58802) |
CCPAuthCode | string | Type: varchar Available from: 25.06 (25.6.0.58802) |
CCPReCharge | string | Type: varchar Available from: 25.06 (25.6.0.58802) |
CreateDTAUS | boolean | DTAUS record should be created. Type: bit Available from: 25.06 (25.6.0.58802) |
Fulfillment | boolean | Type: bit Available from: 25.06 (25.6.0.58802) |
InvShipLock | string | Shipping lock activated flag. Type: varchar Available from: 25.06 (25.6.0.58802) |
ScanOutDate | string | Date of the ship out. Type: datetime Available from: 25.06 (25.6.0.58802) |
VATBaseHigh | number | Sum of high VAT. Type: money Available from: 25.06 (25.6.0.58802) |
VATBaseZero | number | Type: money Available from: 25.06 (25.6.0.58802) |
VATHighPerc | number | The VAT percent of high VAT. Type: numeric Available from: 25.06 (25.6.0.58802) |
ReturnClosed | string | Return closed flag. Type: char Available from: 25.06 (25.6.0.58802) |
ReturnReason | string | Return reason text. Type: varchar Available from: 25.06 (25.6.0.58802) |
SupportPhone | string | Type: varchar Available from: 25.06 (25.6.0.58802) |
TimesPrinted | integer | Count of how many times the invoice was printed. Type: int Available from: 25.06 (25.6.0.58802) |
CCFeeCurrency | string | Type: varchar Available from: 25.06 (25.6.0.58802) |
CCPNumOfTries | integer | Number of tries of credit card processing. Type: int Available from: 25.06 (25.6.0.58802) |
DiscountTotal | number | Discount total for the invoice. Type: money Available from: 25.06 (25.6.0.58802) |
ExecutionDate | string | Date of create return execution. Type: datetime Available from: 25.06 (25.6.0.58802) |
InvLocationID | string | Location where invoice was created. Type: varchar Available from: 25.06 (25.6.0.58802) |
IsPackageLost | string | Type: varchar Available from: 25.06 (25.6.0.58802) |
OrderCurrency | string | Invoice currency. Type: varchar Available from: 25.06 (25.6.0.58802) |
Reminder1Date | string | Type: datetime Available from: 25.06 (25.6.0.58802) |
Reminder2Date | string | Type: datetime Available from: 25.06 (25.6.0.58802) |
Reminder3Date | string | Type: datetime Available from: 25.06 (25.6.0.58802) |
ReminderCosts | number | Type: money Available from: 25.06 (25.6.0.58802) |
ReminderLevel | integer | Type: int Available from: 25.06 (25.6.0.58802) |
VATinShipCost | string | VAT is included in shipping costs. Type: varchar Available from: 25.06 (25.6.0.58802) |
skontoprozent | string | Type: smallint Available from: 25.06 (25.6.0.58802) |
BankFeeAmmount | number | Type: money Available from: 25.06 (25.6.0.58802) |
CCFeeProvision | string | Type: float Available from: 25.06 (25.6.0.58802) |
CCPPaymentDone | string | Credit card payment done flag. Type: varchar Available from: 25.06 (25.6.0.58802) |
CostChargeShop | number | Type: money Available from: 25.06 (25.6.0.58802) |
InvTrackNumber | string | Tracking number for the invoice. Type: varchar Available from: 25.06 (25.6.0.58802) |
PaidAtCreation | number | Type: money Available from: 25.06 (25.6.0.58802) |
PaidByCustomer | number | Type: money Available from: 25.06 (25.6.0.58802) |
RefToInvoiceNr | string | Reference to the original invoice number. Type: varchar Available from: 25.06 (25.6.0.58802) |
ReminderReason | string | Type: varchar Available from: 25.06 (25.6.0.58802) |
ReturnSupplier | string | Type: varchar Available from: 25.06 (25.6.0.58802) |
Total_ShipCost | number | The total of ship costs. Type: money Available from: 25.06 (25.6.0.58802) |
TrackingIDsent | string | Date when the tracking ID was sent. Type: datetime Available from: 25.06 (25.6.0.58802) |
retTrackIDhist | string | History of tracking IDs of returns. Type: varchar Available from: 25.06 (25.6.0.58802) |
CCPChargedSoFar | number | Type: money Available from: 25.06 (25.6.0.58802) |
InvCreationMode | string | How was the invoice created. Type: varchar Available from: 25.06 (25.6.0.58802) |
InvoiceMailSent | boolean | Type: bit Available from: 25.06 (25.6.0.58802) |
RefToInvoiceKey | integer | Reference to the original invoice ID. Type: int Available from: 25.06 (25.6.0.58802) |
ShippedByVendor | boolean | Invoice was shipped by shipping vendor flag. Type: bit Available from: 25.06 (25.6.0.58802) |
Total_OrderCurr | number | Invoice amount. Type: money Available from: 25.06 (25.6.0.58802) |
VATLow_ShipCost | number | Total of low VAT in shipping costs. Type: money Available from: 25.06 (25.6.0.58802) |
ccpSetFailTries | integer | Type: int Available from: 25.06 (25.6.0.58802) |
PackageNetWeight | string | Type: float Available from: 25.06 (25.6.0.58802) |
TextIfNoInvlines | string | Type: varchar Available from: 25.06 (25.6.0.58802) |
VATHigh_ShipCost | number | Total of high VAT in shipping costs. Type: money Available from: 25.06 (25.6.0.58802) |
VATLow_OrderCurr | number | Total sum of low VAT. Type: money Available from: 25.06 (25.6.0.58802) |
ReminderProcessed | string | Type: char Available from: 25.06 (25.6.0.58802) |
ReturnCostsAmount | number | Return cost amount. Type: money Available from: 25.06 (25.6.0.58802) |
VATHigh_OrderCurr | number | Total sum of high VAT. Type: money Available from: 25.06 (25.6.0.58802) |
CostChargeCurrency | string | Type: varchar Available from: 25.06 (25.6.0.58802) |
PackageGrossWeight | string | Weight of the package shipped with this invoice. Type: float Available from: 25.06 (25.6.0.58802) |
ShipmentTrackingID | string | ID of shipment tracking. Type: varchar Available from: 25.06 (25.6.0.58802) |
Total_ShipCost_Net | number | Total of shipping costs without VAT. Type: money Available from: 25.06 (25.6.0.58802) |
ccpSetFailLastTime | string | Type: datetime Available from: 25.06 (25.6.0.58802) |
VATBaseLow_ShipCost | number | Total of low VAT in shipping costs. Type: money Available from: 25.06 (25.6.0.58802) |
CCPShipCostChargedYN | string | Type: varchar Available from: 25.06 (25.6.0.58802) |
ShipVendorIncrement1 | integer | Type: int Available from: 25.06 (25.6.0.58802) |
VATBaseHigh_ShipCost | number | Total of high VAT in shipping costs. Type: money Available from: 25.06 (25.6.0.58802) |
VATBaseLow_OrderCurr | number | Type: money Available from: 25.06 (25.6.0.58802) |
VATBaseZero_ShipCost | number | Type: money Available from: 25.06 (25.6.0.58802) |
ReturnCostsAmount_Net | number | Return cost amount without VAT. Type: money Available from: 25.06 (25.6.0.58802) |
VATBaseHigh_OrderCurr | number | Type: money Available from: 25.06 (25.6.0.58802) |
ChargeHighVATInShipCost | boolean | Charge high VAT for shipping costs flag. Type: bit Available from: 25.06 (25.6.0.58802) |
SEPAMandateReferenceRef | integer | ID of SEPA mandante reference. Type: int Available from: 25.06 (25.6.0.58802) |
Total_ShipCost_OrderCurr | number | The total of ship costs. Type: money Available from: 25.06 (25.6.0.58802) |
VATBaseLow_ShipCost_OrderCurr | number | Type: money Available from: 25.06 (25.6.0.58802) |
VATBaseHigh_ShipCost_OrderCurr | number | Type: money Available from: 25.06 (25.6.0.58802) |
DontChargeShipCostOn2ndDelivery | string | Do not charge shipping costs on 2nd delivery flag. Type: varchar Available from: 25.06 (25.6.0.58802) |
Response Example
<PixiCreateReturnPost200TextXmlResponse>
<InvoiceKey>0</InvoiceKey>
<InvoiceNr>string</InvoiceNr>
<InvDate>string</InvDate>
<CustRef>0</CustRef>
<AddrRef>0</AddrRef>
<Summary>0</Summary>
<VATBaseHigh>0</VATBaseHigh>
<VATBaseLow>0</VATBaseLow>
<VATType>string</VATType>
<VATNo>string</VATNo>
<skontoprozent>string</skontoprozent>
<SkontoAbz>0</SkontoAbz>
<total>0</total>
<Payment>string</Payment>
<Printed>string</Printed>
<PrintDate>string</PrintDate>
<Supporter>string</Supporter>
<SupportPhone>string</SupportPhone>
<PayDay>string</PayDay>
<Payed>string</Payed>
<PayedSum>0</PayedSum>
<SUGKTO>string</SUGKTO>
<BuchuText>string</BuchuText>
<AuszugNr>string</AuszugNr>
<Account>string</Account>
<BLZ>string</BLZ>
<AccName>string</AccName>
<LSDate>string</LSDate>
<LSNr>0</LSNr>
<RLSDate>string</RLSDate>
<RLSCost>0</RLSCost>
<Reminder1Date>string</Reminder1Date>
<Reminder2Date>string</Reminder2Date>
<Reminder3Date>string</Reminder3Date>
<CardDate>string</CardDate>
<CardCheck>string</CardCheck>
<CardType>string</CardType>
<CardName>string</CardName>
<CardNr>string</CardNr>
<CardExp>string</CardExp>
<Note>string</Note>
<NODRef>0</NODRef>
<ShipCode>string</ShipCode>
<CreateDate>string</CreateDate>
<CreateEmp>string</CreateEmp>
<UpdateDate>string</UpdateDate>
<UpdateEmp>string</UpdateEmp>
<BoxNr>0</BoxNr>
<Total_OrderCurr>0</Total_OrderCurr>
<Total_ShipCost>0</Total_ShipCost>
<Total_ShipCost_OrderCurr>0</Total_ShipCost_OrderCurr>
<GNMcharge>string</GNMcharge>
<ScanOutDate>string</ScanOutDate>
<OrderCurrency>string</OrderCurrency>
<VATBaseHigh_OrderCurr>0</VATBaseHigh_OrderCurr>
<VATBaseLow_OrderCurr>0</VATBaseLow_OrderCurr>
<VATHighPerc>0</VATHighPerc>
<VATLowPerc>0</VATLowPerc>
<VATHigh>0</VATHigh>
<VATLow>0</VATLow>
<VATHigh_OrderCurr>0</VATHigh_OrderCurr>
<VATLow_OrderCurr>0</VATLow_OrderCurr>
<VATHText>string</VATHText>
<VATLText>string</VATLText>
<RefToInvoiceNr>string</RefToInvoiceNr>
<RefToInvoiceKey>0</RefToInvoiceKey>
<CCFeeProvision>string</CCFeeProvision>
<CCAddFee>0</CCAddFee>
<CCFeeCurrency>string</CCFeeCurrency>
<BankFeeAmmount>0</BankFeeAmmount>
<CostChargeShop>0</CostChargeShop>
<CostChargeCurrency>string</CostChargeCurrency>
<ChargeVAT>string</ChargeVAT>
<IssueNr>string</IssueNr>
<ShipVendor>string</ShipVendor>
<CCPPaymentDone>string</CCPPaymentDone>
<CCPAuthCode>string</CCPAuthCode>
<CCPNumOfTries>0</CCPNumOfTries>
<CCPReCharge>string</CCPReCharge>
<ShipAdrRef>0</ShipAdrRef>
<InvLocationID>string</InvLocationID>
<TimesPrinted>0</TimesPrinted>
<InvShopID>string</InvShopID>
<CCPShipCostChargedYN>string</CCPShipCostChargedYN>
<CCPChargedSoFar>0</CCPChargedSoFar>
<PackageNetWeight>string</PackageNetWeight>
<PackageGrossWeight>string</PackageGrossWeight>
<IsPackageLost>string</IsPackageLost>
<InvShipLock>string</InvShipLock>
<InvTrackNumber>string</InvTrackNumber>
<ShipVendorIncrement1>0</ShipVendorIncrement1>
<VoucherSum>0</VoucherSum>
<VoucherID>string</VoucherID>
<VATinShipCost>string</VATinShipCost>
<ShippedByVendor>true</ShippedByVendor>
<VATBaseLow_ShipCost>0</VATBaseLow_ShipCost>
<VATBaseHigh_ShipCost>0</VATBaseHigh_ShipCost>
<ccpPayID>string</ccpPayID>
<ccpTransID>string</ccpTransID>
<ReminderLevel>0</ReminderLevel>
<ReminderProcessed>string</ReminderProcessed>
<ReminderCosts>0</ReminderCosts>
<ReminderReason>string</ReminderReason>
<ccpSetFailTries>0</ccpSetFailTries>
<ccpSetFailLastTime>string</ccpSetFailLastTime>
<ShipmentTrackingID>string</ShipmentTrackingID>
<ReturnReason>string</ReturnReason>
<StockNote>string</StockNote>
<ReturnSupplier>string</ReturnSupplier>
<ReturnClosed>string</ReturnClosed>
<Fulfillment>true</Fulfillment>
<InvoiceMailSent>true</InvoiceMailSent>
<TrackingIDsent>string</TrackingIDsent>
<PaidByCustomer>0</PaidByCustomer>
<PLHref>0</PLHref>
<Packages>0</Packages>
<DiscountTotal>0</DiscountTotal>
<PaidAtCreation>0</PaidAtCreation>
<TextIfNoInvlines>string</TextIfNoInvlines>
<retTrackID>string</retTrackID>
<retTrackIDhist>string</retTrackIDhist>
<_x0031_SS>true</_x0031_SS>
<DueDate>string</DueDate>
<CreateDTAUS>true</CreateDTAUS>
<InvCreationMode>string</InvCreationMode>
<VATBaseHigh_ShipCost_OrderCurr>0</VATBaseHigh_ShipCost_OrderCurr>
<VATBaseLow_ShipCost_OrderCurr>0</VATBaseLow_ShipCost_OrderCurr>
<VATBaseZero_ShipCost>0</VATBaseZero_ShipCost>
<VATHigh_ShipCost>0</VATHigh_ShipCost>
<VATLow_ShipCost>0</VATLow_ShipCost>
<OrderType>string</OrderType>
<Total_Net>0</Total_Net>
<VATBaseZero>0</VATBaseZero>
<Total_ShipCost_Net>0</Total_ShipCost_Net>
<ChargeHighVATInShipCost>true</ChargeHighVATInShipCost>
<DontChargeShipCostOn2ndDelivery>string</DontChargeShipCostOn2ndDelivery>
<ExecutionDate>string</ExecutionDate>
<SEPAMandateReferenceRef>0</SEPAMandateReferenceRef>
<ReturnCostsAmount>0</ReturnCostsAmount>
<ReturnCostsAmount_Net>0</ReturnCostsAmount_Net>
</PixiCreateReturnPost200TextXmlResponse>
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:pixiCreateReturn>
<BIC xsi:type="xsd:string"></BIC>
<BLZ xsi:type="xsd:string"></BLZ>
<IBAN xsi:type="xsd:string"></IBAN>
<Note xsi:type="xsd:string"></Note>
<Prices xsi:type="xsd:string">5,99;</Prices> <!-- required -->
<Account xsi:type="xsd:string"></Account>
<ShipCost xsi:type="xsd:number"></ShipCost>
<CAComment xsi:type="xsd:string"></CAComment>
<CreateEmp xsi:type="xsd:string"></CreateEmp>
<InvoiceNr xsi:type="xsd:string"></InvoiceNr> <!-- required -->
<CreateDate xsi:type="xsd:string">date format: YYYYMMDD hh:mm:ss[.mmm]</CreateDate>
<LanguageId xsi:type="xsd:integer"></LanguageId>
<Quantities xsi:type="xsd:string">1;2;3;</Quantities> <!-- required -->
<AccountName xsi:type="xsd:string"></AccountName> <!-- required -->
<CreateDTAUS xsi:type="xsd:boolean"></CreateDTAUS>
<DoNotRefund xsi:type="xsd:boolean"></DoNotRefund>
<InvoiceDate xsi:type="xsd:string">date format: YYYYMMDD hh:mm:ss[.mmm]</InvoiceDate>
<PaymentType xsi:type="xsd:string"></PaymentType> <!-- required -->
<InvoiceLines xsi:type="xsd:string">123;</InvoiceLines> <!-- required -->
<ReturnCaseID xsi:type="xsd:integer"></ReturnCaseID>
<ReturnClosed xsi:type="xsd:boolean"></ReturnClosed>
<ReturnReason xsi:type="xsd:string"></ReturnReason>
<Voucher_Amount xsi:type="xsd:number">9.78</Voucher_Amount>
<ReturnCostsAmount xsi:type="xsd:number"></ReturnCostsAmount>
<MarkReturnDocumentForPrinting xsi:type="xsd:boolean">0</MarkReturnDocumentForPrinting>
</ns1:pixiCreateReturn>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
PHP Example
<?php
getPixiSoapClientResponse('pixiCreateReturn', [
'BIC' => '', // string
'BLZ' => '', // string
'IBAN' => '', // string
'Note' => '', // string
'Prices' => '5,99;', // string (required)
'Account' => '', // string
'ShipCost' => '', // number
'CAComment' => '', // string
'CreateEmp' => '', // string
'InvoiceNr' => '', // string (required)
'CreateDate' => 'date format: YYYYMMDD hh:mm:ss[.mmm]', // string
'LanguageId' => '', // integer
'Quantities' => '1;2;3;', // string (required)
'AccountName' => '', // string (required)
'CreateDTAUS' => '', // boolean
'DoNotRefund' => '', // boolean
'InvoiceDate' => 'date format: YYYYMMDD hh:mm:ss[.mmm]', // string
'PaymentType' => '', // string (required)
'InvoiceLines' => '123;', // string (required)
'ReturnCaseID' => '', // integer
'ReturnClosed' => '', // boolean
'ReturnReason' => '', // string
'Voucher_Amount' => '9.78', // number
'ReturnCostsAmount' => '', // number
'MarkReturnDocumentForPrinting' => '0', // boolean
]);
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);
}