returnRequest
This service will return a part from an invoice. You must call the orderStatus service first. This will give you the proper invoiceNumber, lineNumber, and pid.
WSDL LinkBasic Request elements
| element | Value |
|---|---|
| xmlUser | assigned by Encompass |
| xmlPassword | assigned by Encompass |
| serviceName | XML.RETURN.REQUEST |
| serviceMode | SOAP |
Additional Request elements
| element | required | description | sample data |
|---|---|---|---|
| customerType | n | customer type (not used for all accounts) | SERVICEGROUP |
| customerNumber | y | customer number | 12345 |
| useCustomerCross | n | map your customer number to ours (not available for all accounts) (y/n) | n |
| invoiceNumber | y | invoice number to return items from | 1-234567 |
| returnReferenceNumber | n | your reference number for the return | r12345678 |
| returnServiceLabel | n | request UPS return service label (y/n) | |
| returnTrackingNumber | n | customer provided return tracking #, this is only used if not requesting a return service label | 1Z516646465456 |
| partlist | y | array of parts information | see partlist array elements table |
partlist array elements
| element | required | description | sample data |
|---|---|---|---|
| lineNumber | y | line number from order | 2 |
| pid | y | internal part id used from order | 5937132 |
| returnQuantity | y | quantity of part to return | 1 |
| returnType | y | Type of Return | 1=Good & Un-used Parts 2=Warranty / Replacement 3=Core / Dud |
| reasonCode | n | reason code for return | Required for Warranty / Replacement 1=No power 2=Automatically shuts down 3=Color problem 4=Sound problem 5=Intermittent power issue 6=Picture distortion issue 7=Vertical or horizontal problem 8=Compatibility issue 9=Wrong color 10=Physical Damage |
| modelNumber | n | model # of the product then part is returned from | Required for Warranty / Replacement mx123456 |
| serialNumber | n | serial # of the product the part is returned from | Required for Warranty / Replacement 1s6816383181 |
| replacementOrderNumber | n | replacement order # | Required for Warranty / Replacement if the account is not setup to auto-replace 1-12345 |
Returned elements
| element | description | sample data |
|---|---|---|
| rmaNumber | RMA Number | 7-12345 |
| returnServiceNumber | return service number if requested | 1Z516646465456 |
| returnServiceLabelLink | This is the link to view or print the return service label if requested. This includes the inscrutions, and is ready to print. | https://encompass.com/app/?wwizmstr=WEB.RETURN.LABEL |
| returnServiceLabelImage | This is the link to view or print the return service label if requested. This is a direct link to the image. There are no instructions. This can be used to make you own custom instructions with the label. This is ONLY provided by UPS, and not FedEx. | http://returns.ups.com/123456789 |
| returnServiceLabelReject | If a return service label is requested and we reject the label, but still process the RMA, this will be a 'Y'. This can happen when requesting a label on items that are too large. | N |
| returnCompany | company that the package will be returned to | National Returns Center |
| returnAddress1 | address line 1 where the package will be returned to | 775 TIPTON INDUSTRIAL DRIVE |
| returnAddress2 | address line 1 where the package will be returned to | SUITE E |
| returnCity | city where the package will be returned to | LAWRENCEVILLE |
| returnState | state where the package will be returned to | GA |
| returnZipCode | zip code where the package will be returned to | 30046 |
| returnCountry | country where the package will be returned to | US |
Service errorCode values
| errorCode | errorMessage |
|---|---|
| -200 | files did not open |
| -201 | invalid xmlUser |
| -202 | invalid customer number from customer cross |
| -203 | customer number is required |
| -204 | invalid customer number |
| -205 | invoiceNumber is required |
| -206 | invoiceNumber does not exist |
| -207 | customer number does not match invoice |
| -208 | pid is required |
| -209 | invalid product |
| -210 | invalid lineNumber |
| -211 | pid does not exist on lineNumber |
| -212 | invalid returnQuantity |
| -213 | no items were shipped on this line |
| -214 | only X item(s) were shipped on this line |
| -215 | return good and un-used parts on invoice # |
| -216 | X part(s) were already returned - there are only X left to return |
| -217 | this good and un-used part is X days old |
| -218 | special order products may not be returned |
| -219 | Toshiba computer products may not be returned |
| -220 | return warranty or replacement parts on X |
| -221 | X part(s) were already returned - there are only X left to return |
| -222 | invalid reasonCode |
| -223 | invalid reasonCode |
| -224 | Please contact us with details of the physical damage |
| -225 | a modelNumber is required on warranty or replacement parts |
| -226 | a serialNumber is required on warranty or replacement parts |
| -227 | this warranty or replacement part is X old |
| -228 | this Mitsubishi warranty or replacement part is X old |
| -229 | cores were not billed on this invoice try X |
| -230 | cores were not billed on this invoice |
| -231 | X core(s) were already returned - there are only X left to return |
| -237 | this core is X old |
| -238 | invalid returnType |
| -239 | cannot be returned |
| -240 | cannot be returned |
| -241 | cannot be returned |
| -242 | no valid parts were submitted |
| -243 | A return against this invoice is already in process |
| -244 | invalid carrying branch |
| -245 | invalid return location |
| -246 | return service request error |
| -247 | account does not allow good and un-used part returns |
| -248 | a replacementOrderNumber is required on warranty or replacement parts |
| -249 | invalid replacementOrderNumber |
| -250 | invalid replacementOrderNumber |
| -251 | invalid replacementOrderNumber - customer number does not match |
| -252 | part does not exist on replacementOrderNumber |
| -253 | replacement quantity X is less than return quantity X |
| -254 | is not a replacement order |
| -255 | already placed quantity X against replacement order X |
| -256 | account does not allow return service |
| -257 | pid cannot be returned to stock |
| -258 | good and un-used returns must be at least 15.00 |
| -259 | pid does not allow returnServiceLabel |
This documentation is only designed as a guide for the corresponding WSDL file.