pixi Developer & Integration Documentation

pixiReturnCaseUpdate

Description

API call updates return costs for given return id.


Request Parameters

# Name Type Required Example Description
1 ReturnId integer 0 123 Filter: Return Id
2 ReturnCost number 0 9.99 Update return costs for given return Id. Positive price. The maximum value is returned items amount + shipping costs - discount voucher.
3 UserName string 0 abcdefg User updating return costs

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:pixiReturnCaseUpdate>
         <dem:ReturnId>123</dem:ReturnId>
         <dem:ReturnCost>9.99</dem:ReturnCost>
         <dem:UserName>abcdefg</dem:UserName>
      </dem:pixiReturnCaseUpdate>
   </soapenv:Body>
</soapenv:Envelope>

Response


Body 1: Status output

# Name Type Description
1 Status string Execution status (Info/Error)
2 Message string Description of the status

Additional Notes

- Return costs are updated when return is in status Received (REC).
- At Credit creation pop up those return costs are read and used when puting the return to credited (CRE) status.

Possible output messages:
- Return Case updated successfully.
- Return cost must be less then Returned items amount + Shipping costs - Discount voucher.
- Return id 1002 is not in received status.
- Return cost must be greater than 0.
- No return found for return Id: 1003
- Return id and return costs needs to be provided.