POST api/returnments
Genera una devolución de material en el sistema, validando los datos recibidos y asignando un número de autorización
Request Information
URI Parameters
None.
Body Parameters
Petición de generación de devolución con los datos de esta
ReturnmentCreationRequestName | Description | Type | Additional information |
---|---|---|---|
externalReference |
Indica el identificador de MasMovil para la devolución |
string |
None. |
sfid |
Indica el SFID de la tienda que solicita la devolución |
string |
None. |
returnType |
Tipo de la devolución |
ReturnmentTypes |
None. |
returnDate |
Indica la fecha en la que se solicita la devolución |
date |
None. |
packagesNumber |
Cantidad de bultos de los que se compone la devolución |
integer |
None. |
pickUpTime |
Horario preferiodo para la recogida por el transportista |
string |
None. |
contactName |
Nombre de la persona de contacto de la tienda para la gestión de la devolución |
string |
None. |
contactPhone |
Teléfono de contacto de la tienda para la gestión de la devolución |
string |
None. |
returnDetail |
Colección de líneas de la devolución |
Collection of ReturnmentCreationRequestLine |
None. |
Request Formats
application/json, text/json
{ "externalReference": "sample string 1", "sfid": "sample string 2", "returnType": 1, "returnDate": "2025-05-04T10:20:54.4432991+02:00", "packagesNumber": 4, "pickUpTime": "sample string 5", "contactName": "sample string 6", "contactPhone": "sample string 7", "returnDetail": [ { "ean": "sample string 1", "sku": "sample string 2", "units": 3 }, { "ean": "sample string 1", "sku": "sample string 2", "units": 3 } ] }
application/xml, text/xml
<ReturnmentCreationRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MasMovil_API.Model.Entities"> <ContactName>sample string 6</ContactName> <ContactPhone>sample string 7</ContactPhone> <ExternalReference>sample string 1</ExternalReference> <PackagesNumber>4</PackagesNumber> <PickUpTime>sample string 5</PickUpTime> <ReturnDate>2025-05-04T10:20:54.4432991+02:00</ReturnDate> <ReturnDetail> <ReturnmentCreationRequestLine> <EAN>sample string 1</EAN> <SKU>sample string 2</SKU> <Units>3</Units> </ReturnmentCreationRequestLine> <ReturnmentCreationRequestLine> <EAN>sample string 1</EAN> <SKU>sample string 2</SKU> <Units>3</Units> </ReturnmentCreationRequestLine> </ReturnDetail> <ReturnType>DOA</ReturnType> <SFID>sample string 2</SFID> </ReturnmentCreationRequest>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
Respuesta a la petición de generación de devolución
ReturnmentCreationResponseName | Description | Type | Additional information |
---|---|---|---|
result |
Indica si la petición se ha procesado correctamente |
boolean |
None. |
authNumber |
Número de autorización asignado a la devolución |
string |
None. |
message |
Texto del mensaje de respuesta |
string |
None. |
details |
Detalle de la respuesta. Solo se indica en caso de que haya líneas incorrectas en la petición |
Collection of ReturnmentCreationResponseLine |
None. |
Response Formats
application/json, text/json
{ "result": true, "authNumber": "sample string 2", "message": "sample string 3", "details": [ { "ean": "sample string 1", "sku": "sample string 2", "IsValid": true, "message": "sample string 4" }, { "ean": "sample string 1", "sku": "sample string 2", "IsValid": true, "message": "sample string 4" } ] }
application/xml, text/xml
<ReturnmentCreationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MasMovil_API.Model.Entities"> <AuthNumber>sample string 2</AuthNumber> <Details> <ReturnmentCreationResponseLine> <EAN>sample string 1</EAN> <IsValid>true</IsValid> <Message>sample string 4</Message> <SKU>sample string 2</SKU> </ReturnmentCreationResponseLine> <ReturnmentCreationResponseLine> <EAN>sample string 1</EAN> <IsValid>true</IsValid> <Message>sample string 4</Message> <SKU>sample string 2</SKU> </ReturnmentCreationResponseLine> </Details> <Message>sample string 3</Message> <Result>true</Result> </ReturnmentCreationResponse>