pixi Developer & Integration Documentation

pixiGetCustomersToRefund

Description

The API call returns list of Customers which should be refunded.


Request Parameters

# Name Type Required Example Description
1 ShopId string 0 ABC Limit results by Shop id.
2 AmountFrom number 0 1.1 Limit results by minimal amount to be refunded.
3 AmountTo number 0 1000.5 Limit results by maximal amount to be refunded
4 IsAccountMatched boolean 0 1 Limit results to only matched / not matched or all accounts.

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:pixiGetCustomersToRefund>
         <dem:ShopId>ABC</dem:ShopId>
         <dem:AmountFrom>1.1</dem:AmountFrom>
         <dem:AmountTo>1000.5</dem:AmountTo>
         <dem:IsAccountMatched>1</dem:IsAccountMatched>
      </dem:pixiGetCustomersToRefund>
   </soapenv:Body>
</soapenv:Envelope>

Response


Body 1: List of customers which should be refunded

# Name Type Description
1 CustKey integer Customer Id
2 ShopId string Shop code
3 IsMatched boolean Is customer account matched
4 SuggestedRefund number Amount suggested to be refunded
5 FinancialBalance number Financal balance
6 OpenOrders number Open orders amount
7 OpenToMatch number Amount which is open to match
8 CurrencyId integer Currency Id

Additional Notes