List Sales Order Returns

Overview
Retrieve sales order return list based on provided criteria

URL Format
https://{domain}.mobiwork.com/api/rest/{clientId}/{versionNumber}/salesOrderReturn/list.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
userId optional	If provided, this User ID will be taken as a logged in user

Filter or Search Criteria

salesOrderId	By ID of sales order return
createdBy	By the creator's user name of the sales order return
createdFromDate	By the creation date of the sales order return
createdToDate	By the upper bound of the creation date
customerId	By the customerId of the sales order return
customerName	By the customer's name of the sales order return
customStatusName	By the custom status name of the sales order return
integrationStatus	By the integration status of the sales order.

Return
Returns a list of Sales Order Return Object(s) if valid arguments and search criteria are provided. If no search criteria is provided the list of a maximum 200 salesorders will be returned. Returns an error if not a valid request

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="createdBy"/>
        <xs:element ref="createdFromDate"/>
        <xs:element ref="createdToDate"/>
        <xs:element ref="customerId"/>
        <xs:element ref="customerName"/>
        <xs:element ref="customStatusName"/>
        <xs:element ref="integrationStatus"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="createdBy" type="xs:string" minOccurs="0"/>
  <xs:element name="createdFromDate" type="xs:string" minOccurs="0"/>
  <xs:element name="createdToDate" type="xs:string" minOccurs="0"/>
  <xs:element name="customerId" type="xs:integer" minOccurs="0"/>
  <xs:element name="customerName" type="xs:NCName" minOccurs="0"/>
  <xs:element name="customStatusName" type="xs:NCName" minOccurs="0"/>
  <xs:element name="integrationStatus" type="xs:NCName" minOccurs="0"/>
</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>
        <xs:element ref="salesOrderReturnList"/>
      </xs:sequence>
      <xs:attribute name="statusCode" use="required" type="xs:integer"/>
      <xs:attribute name="version" use="required" type="xs:NMTOKEN"/>
    </xs:complexType>
  </xs:element>
  <xs:element name="salesOrderReturnList">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="totalAvailableCount"/>
        <xs:element ref="count"/>
        <xs:element ref="salesOrderReturn"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="totalAvailableCount" type="xs:integer"/>
  <xs:element name="count" type="xs:integer"/>
  <xs:element name="salesOrderReturn">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="customerName"/>
        <xs:element ref="createdById"/>
        <xs:element ref="createdByName"/>
        <xs:element ref="createdDate"/>
        <xs:element ref="customStatus"/>
        <xs:element ref="customer"/>
        <xs:element ref="customerId"/>
        <xs:element ref="externalId"/>
        <xs:element ref="integrationStatus"/>
        <xs:element ref="name"/>
        <xs:element ref="returnTotalAmount"/>
        <xs:element ref="salesOrderId"/>
        <xs:element ref="salesOrderReturnId"/>
        <xs:element ref="userId"/>
        <xs:element ref="userName"/>
        <xs:element ref="salesOrderReturnItemList"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="customerName">
    <xs:complexType/>
  </xs:element>
  <xs:element name="createdById" type="xs:integer"/>
  <xs:element name="createdByName" type="xs:string"/>
  <xs:element name="customStatus" type="xs:NCName"/>
  <xs:element name="customer">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="status"/>
        <xs:element ref="address"/>
        <xs:element ref="assignedTo"/>
        <xs:element ref="companyName"/>
        <xs:element ref="externalCustomerId"/>
        <xs:element ref="primaryContact"/>
        <xs:element ref="taxable"/>
        <xs:element ref="typeId"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="status" type="xs:integer"/>
  <xs:element name="address">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="address1"/>
        <xs:element ref="address2"/>
        <xs:element ref="city"/>
        <xs:element ref="countryId"/>
        <xs:element ref="latitude"/>
        <xs:element ref="longitude"/>
        <xs:element ref="name"/>
        <xs:element ref="state"/>
        <xs:element ref="zipCode"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="address1" type="xs:string"/>
  <xs:element name="address2" type="xs:string"/>
  <xs:element name="city" type="xs:string"/>
  <xs:element name="countryId" type="xs:integer"/>
  <xs:element name="latitude" type="xs:decimal"/>
  <xs:element name="longitude" type="xs:decimal"/>
  <xs:element name="state" type="xs:NCName"/>
  <xs:element name="zipCode" type="xs:NCName"/>
  <xs:element name="assignedTo" type="xs:integer"/>
  <xs:element name="companyName" type="xs:string"/>
  <xs:element name="externalCustomerId" type="xs:integer"/>
  <xs:element name="primaryContact">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="altPhoneExt"/>
        <xs:element ref="altPhoneNumber"/>
        <xs:element ref="email"/>
        <xs:element ref="fax"/>
        <xs:element ref="firstName"/>
        <xs:element ref="lastName"/>
        <xs:element ref="PhoneExt"/>
        <xs:element ref="PhoneNumber"/>
        <xs:element ref="title"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="altPhoneExt">
    <xs:complexType/>
  </xs:element>
  <xs:element name="altPhoneNumber">
    <xs:complexType/>
  </xs:element>
  <xs:element name="email" type="xs:string"/>
  <xs:element name="fax">
    <xs:complexType/>
  </xs:element>
  <xs:element name="firstName" type="xs:NCName"/>
  <xs:element name="lastName" type="xs:NCName"/>
  <xs:element name="PhoneExt">
    <xs:complexType/>
  </xs:element>
  <xs:element name="PhoneNumber" type="xs:integer"/>
  <xs:element name="title">
    <xs:complexType/>
  </xs:element>
  <xs:element name="typeId" type="xs:NCName"/>
  <xs:element name="customerId" type="xs:integer"/>
  <xs:element name="integrationStatus" type="xs:NCName"/>
  <xs:element name="returnTotalAmount">
    <xs:complexType/>
  </xs:element>
  <xs:element name="salesOrderId" type="xs:integer"/>
  <xs:element name="userId" type="xs:integer"/>
  <xs:element name="userName">
    <xs:complexType/>
  </xs:element>
  <xs:element name="salesOrderReturnItemList">
    <xs:complexType>
      <xs:sequence>
        <xs:element maxOccurs="unbounded" ref="salesOrderReturnItem"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="salesOrderReturnItem">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="createdDate"/>
        <xs:element ref="comments"/>
        <xs:element ref="createdBy"/>
        <xs:element ref="invoiceItem"/>
        <xs:element ref="invoiceItemId"/>
        <xs:element ref="modifiedBy"/>
        <xs:element ref="modifiedDate"/>
        <xs:element ref="product"/>
        <xs:element ref="productId"/>
        <xs:element ref="qty"/>
        <xs:element ref="salesOrderItemStatus"/>
        <xs:element ref="salesOrderReturnId"/>
        <xs:element ref="salesOrderReturnItemId"/>
        <xs:element ref="serialNumbers"/>
        <xs:element ref="totalAmount"/>
        <xs:element ref="updateToStock"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="comments">
    <xs:complexType/>
  </xs:element>
  <xs:element name="createdBy" type="xs:integer"/>
  <xs:element name="invoiceItem">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="quantity"/>
        <xs:element ref="cost"/>
        <xs:element ref="createdDate"/>
        <xs:element ref="description"/>
        <xs:element ref="invoiceItemId"/>
        <xs:element ref="price"/>
        <xs:element ref="product"/>
        <xs:element ref="rebate"/>
        <xs:element ref="rebatePercent"/>
        <xs:element ref="subTotal"/>
        <xs:element ref="tax"/>
        <xs:element ref="total"/>
        <xs:element ref="totalCost"/>
        <xs:element ref="uomName"/>
        <xs:element ref="uomQty"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="rebate" type="xs:decimal"/>
  <xs:element name="rebatePercent" type="xs:decimal"/>
  <xs:element name="subTotal" type="xs:decimal"/>
  <xs:element name="total" type="xs:decimal"/>
  <xs:element name="totalCost" type="xs:decimal"/>
  <xs:element name="uomName">
    <xs:complexType/>
  </xs:element>
  <xs:element name="uomQty" type="xs:decimal"/>
  <xs:element name="modifiedBy" type="xs:integer"/>
  <xs:element name="modifiedDate" type="xs:string"/>
  <xs:element name="productId" type="xs:integer"/>
  <xs:element name="qty" type="xs:decimal"/>
  <xs:element name="salesOrderItemStatus" type="xs:integer"/>
  <xs:element name="salesOrderReturnItemId" type="xs:integer"/>
  <xs:element name="serialNumbers">
    <xs:complexType/>
  </xs:element>
  <xs:element name="totalAmount" type="xs:decimal"/>
  <xs:element name="updateToStock" type="xs:boolean"/>
  <xs:element name="createdDate" type="xs:string"/>
  <xs:element name="name" type="xs:string"/>
  <xs:element name="taxable" type="xs:boolean"/>
  <xs:element name="externalId" type="xs:string"/>
  <xs:element name="salesOrderReturnId" type="xs:integer"/>
  <xs:element name="quantity" type="xs:decimal"/>
  <xs:element name="cost" type="xs:decimal"/>
  <xs:element name="description" type="xs:string"/>
  <xs:element name="invoiceItemId" type="xs:integer"/>
  <xs:element name="price" type="xs:decimal"/>
  <xs:element name="product">
    <xs:complexType>
      <xs:sequence minOccurs="0">
        <xs:element ref="externalId"/>
        <xs:element ref="categoryName"/>
        <xs:element ref="competitorProduct"/>
        <xs:element ref="cost"/>
        <xs:element ref="description"/>
        <xs:element ref="discountPercentAllowed"/>
        <xs:element ref="enabled"/>
        <xs:element ref="hasSerialNumbers"/>
        <xs:element ref="maxDiscountPercent"/>
        <xs:element ref="mobiworkProductId"/>
        <xs:element ref="modelNumber"/>
        <xs:element ref="name"/>
        <xs:element ref="points"/>
        <xs:element ref="price"/>
        <xs:element ref="priceIncludesTax"/>
        <xs:element ref="productType"/>
        <xs:element ref="quantity"/>
        <xs:element ref="sku"/>
        <xs:element ref="subCategoryName"/>
        <xs:element ref="tax"/>
        <xs:element ref="taxable"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="categoryName">
    <xs:complexType/>
  </xs:element>
  <xs:element name="competitorProduct" type="xs:boolean"/>
  <xs:element name="discountPercentAllowed" type="xs:boolean"/>
  <xs:element name="enabled" type="xs:boolean"/>
  <xs:element name="hasSerialNumbers" type="xs:boolean"/>
  <xs:element name="maxDiscountPercent" type="xs:decimal"/>
  <xs:element name="mobiworkProductId" type="xs:integer"/>
  <xs:element name="modelNumber" type="xs:NMTOKEN"/>
  <xs:element name="points" type="xs:decimal"/>
  <xs:element name="priceIncludesTax" type="xs:boolean"/>
  <xs:element name="productType" type="xs:NCName"/>
  <xs:element name="sku" type="xs:integer"/>
  <xs:element name="subCategoryName">
    <xs:complexType/>
  </xs:element>
  <xs:element name="tax" type="xs:decimal"/>
</xs:schema>

Curl Example

HTTP Method:	GET
Request:	curl -k -X GET 'https://www.mobiwork.com/api/rest/17800/10.0.80/salesOrderReturn/list.html?token=XSYY4BWSKQHGUYOIR2TV' \ --header 'Content-Type: application/xml' \ --header 'Cookie: JSESSIONID=D803E077C30A8B409BEE54A1B16DE550' \ --data-raw '<request><createdBy>Alkin Kiroglu</createdBy><createdFromDate>06/20/2020</createdFromDate><createdToDate>06/20/2022</createdToDate><customerId>3473387</customerId><customerName>Test</customerName><customStatusName>Test</customStatusName><integrationStatus>READY_FOR_INTEGRATION</integrationStatus></request>'
Response:	<?xml version="1.0" encoding="UTF-8" ?> <response version="10.0.80" statusCode="1"> <salesOrderReturnList> <totalAvailableCount>1</totalAvailableCount> <count>1</count> <salesOrderReturn> <customerName></customerName> <createdById>84328</createdById> <createdByName>Alkin Kiroglu</createdByName> <createdDate>2021/06/24</createdDate> <customStatus>Test</customStatus> <customer> <status>771</status> <address> <address1>160 Congress Park Dr</address1> <address2>Ste 205</address2> <city>Delray Beach</city> <countryId>0</countryId> <latitude>26.4581805</latitude> <longitude>-80.0940717</longitude> <name></name> <state>FL</state> <zipCode>null</zipCode> </address> <assignedTo>0</assignedTo> <companyName>Another User Test Company 8462</companyName> <externalCustomerId>236987</externalCustomerId> <primaryContact> <altPhoneExt></altPhoneExt> <altPhoneNumber></altPhoneNumber> <email>jdoe@gmail.com</email> <fax></fax> <firstName>John</firstName> <lastName>Doe</lastName> <PhoneExt></PhoneExt> <PhoneNumber>12345678901</PhoneNumber> <title></title> </primaryContact> <taxable>true</taxable> <typeId>BUSINESS</typeId> </customer> <customerId>3473387</customerId> <externalId></externalId> <integrationStatus>READY_FOR_INTEGRATION</integrationStatus> <name></name> <returnTotalAmount></returnTotalAmount> <salesOrderId>285895</salesOrderId> <salesOrderReturnId>163</salesOrderReturnId> <userId>0</userId> <userName></userName> <salesOrderReturnItemList> <salesOrderReturnItem> <createdDate>2021/06/24</createdDate> <comments></comments> <createdBy>84328</createdBy> <invoiceItem> <quantity>1.0</quantity> <cost>75.0</cost> <createdDate>null</createdDate> <description></description> <invoiceItemId>4345179</invoiceItemId> <price>149.99</price> <product></product> <rebate>0.0</rebate> <rebatePercent>0.0</rebatePercent> <subTotal>0.0</subTotal> <tax>0.0</tax> <total>0.0</total> <totalCost>0.0</totalCost> <uomName></uomName> <uomQty>1.0</uomQty> </invoiceItem> <invoiceItemId>4345179</invoiceItemId> <modifiedBy>84328</modifiedBy> <modifiedDate>2021/06/24</modifiedDate> <product> <externalId>1</externalId> <categoryName></categoryName> <competitorProduct>false</competitorProduct> <cost>75.0</cost> <description>Description</description> <discountPercentAllowed>false</discountPercentAllowed> <enabled>true</enabled> <hasSerialNumbers>false</hasSerialNumbers> <maxDiscountPercent>-1.0</maxDiscountPercent> <mobiworkProductId>1446153</mobiworkProductId> <modelNumber>207-1524</modelNumber> <name>Product 01</name> <points>0.0</points> <price>149.99</price> <priceIncludesTax>false</priceIncludesTax> <productType>PRODUCT</productType> <quantity>1001</quantity> <sku>04900015241</sku> <subCategoryName></subCategoryName> <tax>0.0</tax> <taxable>true</taxable> </product> <productId>1446153</productId> <qty>1.0</qty> <salesOrderItemStatus>0</salesOrderItemStatus> <salesOrderReturnId>163</salesOrderReturnId> <salesOrderReturnItemId>249</salesOrderReturnItemId> <serialNumbers></serialNumbers> <totalAmount>0.0</totalAmount> <updateToStock>true</updateToStock> </salesOrderReturnItem> <salesOrderReturnItem> <createdDate>2021/06/24</createdDate> <comments></comments> <createdBy>84328</createdBy> <invoiceItem> <quantity>1.0</quantity> <cost>45.0</cost> <createdDate>null</createdDate> <description></description> <invoiceItemId>4345180</invoiceItemId> <price>89.99</price> <product></product> <rebate>0.0</rebate> <rebatePercent>0.0</rebatePercent> <subTotal>0.0</subTotal> <tax>0.0</tax> <total>0.0</total> <totalCost>0.0</totalCost> <uomName></uomName> <uomQty>1.0</uomQty> </invoiceItem> <invoiceItemId>4345180</invoiceItemId> <modifiedBy>84328</modifiedBy> <modifiedDate>2021/06/24</modifiedDate> <product> <externalId>2</externalId> <categoryName></categoryName> <competitorProduct>false</competitorProduct> <cost>45.0</cost> <description>Description</description> <discountPercentAllowed>false</discountPercentAllowed> <enabled>true</enabled> <hasSerialNumbers>false</hasSerialNumbers> <maxDiscountPercent>-1.0</maxDiscountPercent> <mobiworkProductId>1446154</mobiworkProductId> <modelNumber>7N-7445</modelNumber> <name>Product 02</name> <points>0.0</points> <price>89.99</price> <priceIncludesTax>false</priceIncludesTax> <productType>PRODUCT</productType> <quantity>1001</quantity> <sku>04900074451</sku> <subCategoryName></subCategoryName> <tax>0.0</tax> <taxable>true</taxable> </product> <productId>1446154</productId> <qty>1.0</qty> <salesOrderItemStatus>0</salesOrderItemStatus> <salesOrderReturnId>163</salesOrderReturnId> <salesOrderReturnItemId>250</salesOrderReturnItemId> <serialNumbers></serialNumbers> <totalAmount>0.0</totalAmount> <updateToStock>true</updateToStock> </salesOrderReturnItem> </salesOrderReturnItemList> </salesOrderReturn> </salesOrderReturnList> </response>