List Sales Order

Overview
Retrieve sales order list based on provided criteria

URL Format
https://{domain}.mobiwork.com/api/rest/{clientId}/{versionNumber}/salesOrderId/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
description	By description of the sales order
statusType	By status type of the sales order
customStatusType	By the sales order custom status
customer	By customer of the sales order
salesOrderType	By the type of the sales order
userId	By the sales order user ID

Return
Returns a list of Sales Order 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="salesOrderId"/>
        <xs:element ref="description"/>
        <xs:element ref="statusType"/>
        <xs:element ref="customStatusType"/>
        <xs:element ref="customer"/>
        <xs:element ref="salesOrderType"/>
        <xs:element ref="userId"/>
        <xs:element ref="integrationStatus"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="salesOrderId" type="xs:integer" minOccurs="0"/>
  <xs:element name="description" type="xs:string" minOccurs="0"/>
  <xs:element name="statusType" type="xs:NCName" minOccurs="0"/>
  <xs:element name="customStatusType" type="xs:NCName" minOccurs="0"/>
  <xs:element name="customer" type="xs:string" minOccurs="0"/>
  <xs:element name="salesOrderType" type="xs:NCName" minOccurs="0"/>
  <xs:element name="userId" type="xs:integer" 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="salesOrderList"/>
      </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="salesOrderList">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="totalAvailableCount"/>
        <xs:element ref="count"/>
        <xs:element maxOccurs="unbounded" ref="salesOrder"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="totalAvailableCount" type="xs:integer"/>
  <xs:element name="count" type="xs:integer"/>
  <xs:element name="salesOrder">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="mobiworkSalesOrderId"/>
        <xs:element ref="customerId"/>
        <xs:element ref="customerName"/>
        <xs:element ref="createdDate"/>
        <xs:element ref="createdById"/>
        <xs:element ref="createdByName"/>
        <xs:element ref="externalId"/>
        <xs:element ref="status"/>
        <xs:element ref="comments"/>
        <xs:element ref="salesOrderType"/>
        <xs:element ref="deliveryAddress"/>
        <xs:element ref="deliveryContact"/>
        <xs:element ref="invoice"/>
        <xs:element ref="paymentList"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="mobiworkSalesOrderId" type="xs:integer"/>
  <xs:element name="customerName" type="xs:string"/>
  <xs:element name="createdById" type="xs:integer"/>
  <xs:element name="createdByName" type="xs:string"/>
  <xs:element name="comments">
    <xs:complexType/>
  </xs:element>
  <xs:element name="salesOrderType" type="xs:NCName"/>
  <xs:element name="deliveryAddress">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="addressId"/>
        <xs:element ref="address1"/>
        <xs:element ref="address2"/>
        <xs:element ref="city"/>
        <xs:element ref="state"/>
        <xs:element ref="zipCode"/>
        <xs:element ref="countryId"/>
        <xs:element ref="latitude"/>
        <xs:element ref="longitude"/>
        <xs:element ref="name"/>
        <xs:element ref="baseDistance"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="addressId" type="xs:integer"/>
  <xs:element name="address1" type="xs:string"/>
  <xs:element name="address2" type="xs:string"/>
  <xs:element name="city" type="xs:string"/>
  <xs:element name="state" type="xs:NCName"/>
  <xs:element name="zipCode" 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="name" type="xs:string"/>
  <xs:element name="baseDistance" type="xs:integer"/>
  <xs:element name="deliveryContact">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="contactId"/>
        <xs:element ref="customerId"/>
        <xs:element ref="firstName"/>
        <xs:element ref="lastName"/>
        <xs:element ref="title"/>
        <xs:element ref="email"/>
        <xs:element ref="phoneNumber"/>
        <xs:element ref="altPhoneNumber"/>
        <xs:element ref="officePhone"/>
        <xs:element ref="phoneExt"/>
        <xs:element ref="altPhoneExt"/>
        <xs:element ref="officePhoneExt"/>
        <xs:element ref="pin"/>
        <xs:element ref="enabled"/>
        <xs:element ref="createdDate"/>
        <xs:element ref="fax"/>
        <xs:element ref="admin"/>
        <xs:element ref="employeeId"/>
        <xs:element ref="loginId"/>
        <xs:element ref="password"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="contactId" type="xs:integer"/>
  <xs:element name="firstName" type="xs:NCName"/>
  <xs:element name="lastName" type="xs:NCName"/>
  <xs:element name="title">
    <xs:complexType/>
  </xs:element>
  <xs:element name="email" type="xs:string"/>
  <xs:element name="phoneNumber" type="xs:integer"/>
  <xs:element name="altPhoneNumber">
    <xs:complexType/>
  </xs:element>
  <xs:element name="officePhone">
    <xs:complexType/>
  </xs:element>
  <xs:element name="phoneExt">
    <xs:complexType/>
  </xs:element>
  <xs:element name="altPhoneExt">
    <xs:complexType/>
  </xs:element>
  <xs:element name="officePhoneExt">
    <xs:complexType/>
  </xs:element>
  <xs:element name="pin" type="xs:integer"/>
  <xs:element name="enabled" type="xs:boolean"/>
  <xs:element name="fax">
    <xs:complexType/>
  </xs:element>
  <xs:element name="admin" type="xs:boolean"/>
  <xs:element name="employeeId">
    <xs:complexType/>
  </xs:element>
  <xs:element name="loginId">
    <xs:complexType/>
  </xs:element>
  <xs:element name="password">
    <xs:complexType/>
  </xs:element>
  <xs:element name="invoice">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="invoiceId"/>
        <xs:element ref="customerId"/>
        <xs:element ref="externalId"/>
        <xs:element ref="createdBy"/>
        <xs:element ref="taxAmount"/>
        <xs:element ref="total"/>
        <xs:element ref="balance"/>
        <xs:element ref="status"/>
        <xs:element ref="invoiceDate"/>
        <xs:element ref="invoiceDueDate"/>
        <xs:element ref="invoicePaymentDate"/>
        <xs:element ref="createdDate"/>
        <xs:element ref="invoiceItemList"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="invoiceId" type="xs:integer"/>
  <xs:element name="createdBy" type="xs:integer"/>
  <xs:element name="taxAmount" type="xs:decimal"/>
  <xs:element name="total" type="xs:decimal"/>
  <xs:element name="balance" type="xs:decimal"/>
  <xs:element name="invoiceDate" type="xs:string"/>
  <xs:element name="invoiceDueDate">
    <xs:complexType/>
  </xs:element>
  <xs:element name="invoicePaymentDate">
    <xs:complexType/>
  </xs:element>
  <xs:element name="invoiceItemList">
    <xs:complexType/>
  </xs:element>
  <xs:element name="paymentList">
    <xs:complexType/>
  </xs:element>
  <xs:element name="customerId" type="xs:integer"/>
  <xs:element name="createdDate" type="xs:string"/>
  <xs:element name="externalId">
    <xs:complexType/>
  </xs:element>
  <xs:element name="status" type="xs:NCName"/>
</xs:schema>

Curl Example

HTTP Method:	GET
Request:	curl -k -X GET "https://www.mobiwork.com/api/rest/12014/5.0.141/salesorder/list.html?token=COJL8X2FKSLMMRTYCH2B" --header 'content-type: application/xml' --data'<request><status>Status 1</status></request>'
Response:	<?xml version="1.0" encoding="UTF-8" ?> <response version="5.0.141" statusCode="1"> <salesorderList> <salesorder> <mobiworksalesorderId>123< /mobiworksalesorderId> <externalId>null</externalId> <description>test</description> <status>Status 1</status> <categoryId>4< /categoryId> <category>Category 1</category> <address> <addressId>12345</addressId> <address1>160 Congress Park Dr</address1> < address2>!</address2> <city>Delray Beach</city> <state>Florida</state> <zipCode>33445</zipCode> <countryId>1</countryId> < latitude>26.4582132</latitude> <longitude>-80.0940502</longitude> <name>Primary</name> <baseDistance>123</baseDistance> </address> <quoteNumber>null</quoteNumber> <dueDate>2018/01/04</dueDate> </salesorder> </salesorderList> </response>