Update Sales Order Return Custom Status

Overview
Updates sales order return's custom status

URL Format
https://{domain}.mobiwork.com/api/rest/{clientId}/{versionNumber}/salesOrderReturn/{salesOrderReturnId}/updateCustomStatus.html?token=XXXXXXXX&userId={userId}

Arguments

clientId required	MobiWork assigned unique ID of the company
versionNumber required	Version number of MobiWork API SDK release. Current version is: 10.0.78
token required	Part of URL as a request parameter and is required in every call to verify access to API calls
salesorderReturnId optional	The identifier of the sales order return to be updated
userId required	If provided, this User ID will be taken as a logged in user. If not provided we use an active global administrator ID

Return
Returns status update success message if valid arguments are provided. Returns an error if not a valid request. An error could occur when a salesorder is associated to work order(s).

Request Body XSD

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified">
  <xs:element name="request">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="customStatusApiName"/>
        <xs:element ref="salesOrderReturnId"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="customStatusApiName" type="xs:NCName"/>
  <xs:element name="salesOrderReturnId" type="xs:integer"/>
</xs:schema>

Response Body XSD

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified">
  <xs:element name="response">
    <xs:complexType>
      <xs:sequence minOccurs="0">
        <xs:element ref="response"/>
        <xs:element ref="statusCode"/>
        <xs:element ref="statusDetails"/>
      </xs:sequence>
      <xs:attribute name="statusCode" type="xs:integer"/>
      <xs:attribute name="version" type="xs:NMTOKEN"/>
    </xs:complexType>
  </xs:element>
  <xs:element name="statusCode" type="xs:integer"/>
  <xs:element name="statusDetails" type="xs:NCName"/>
</xs:schema>

Curl Example

HTTP Method:	POST
Request:	curl -k -X POST 'https://www.mobiwork.com/api/rest/17800/10.0.80/salesOrderReturn/163/updateCustomStatus.html?token=XSYY4BWSKQHGUYOIR2TV' \ --header 'Content-Type: application/xml' \ --header 'Cookie: JSESSIONID=D803E077C30A8B409BEE54A1B16DE550' \ --data-raw '<request> <customStatusApiName>Test</customStatusApiName> <salesOrderReturnId>163</salesOrderReturnId> </request>'
Response:	<?xml version="1.0" encoding="UTF-8" ?> <response version="10.0.80" statusCode="1"> <response> <statusCode>1</statusCode> <statusDetails>success</statusDetails> </response> </response>