Description

Returns the list of created return cases for the specified, or default criteria.

Request Parameters

#	Name	Type	Required	Example	Description
1	StatusId	integer	0	1	Filter: Status id; 1=New; 2=Received; 3=Refunded; 4=Rejected
2	ChangeDateFrom	string	0	YYYY-MM-DD hh:mm:ss	Filter: Start of time frame of last record update. If not specified, set 1 month in past from today.
3	ChangeDateTo	string	0	YYYY-MM-DD hh:mm:ss	Filter: End of time frame of last record update. If not specified, set until current time.
4	InvoiceNr	string	0	SHO00012345	Filter: Returns for specific invoice number.
5	Offset	integer	0	100	Pagination: record offset
6	RowCount	integer	0	100	Pagination: maximum results per page

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:pixiGetReturns>
         <dem:StatusId>1</dem:StatusId>
         <dem:ChangeDateFrom>YYYY-MM-DD hh:mm:ss</dem:ChangeDateFrom>
         <dem:ChangeDateTo>YYYY-MM-DD hh:mm:ss</dem:ChangeDateTo>
         <dem:InvoiceNr>SHO00012345</dem:InvoiceNr>
         <dem:Offset>100</dem:Offset>
         <dem:RowCount>100</dem:RowCount>
      </dem:pixiGetReturns>
   </soapenv:Body>
</soapenv:Envelope>

Response

Body 1: List of Returns

#	Name	Type	Description
1	Id	integer	Row ID.
2	StatusId	integer	Status ID (1=New; 2=Received; 3=Refunded; 4=Rejected)
3	StatusCode	string	Return status code
4	InvoiceId	integer	Invoice ID
5	InvoiceNumber	string	pixi invoice number
6	CustomerId	integer	Customer ID that Return got created for.
7	RecordCreatedByUserId	integer	ID of the user that created the record.
8	RecordCreatedByUserName	string	Username of the user that created the record.
9	RecordModifiedByUserId	integer	ID of the user that last updated the record.
10	RecordModifiedByUserName	string	Username of the user that last modified the record.
11	CreditNumber	string	pixi credit number.
12	CreditedAmount	number	Credited amount.

Additional Notes

If "ChangeDateFrom" argumet is not specified, API call will use one month since today. Similarly, if "ChangeDateTo" is not specified, date until today is used.