List Products

Overview
Retrieve Product List of the client

URL Format
https://{domain}.mobiwork.com/api/rest/{clientId}/{versionNumber}/product/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. If not provided we use an active global administrator ID

Filter or Search Criteria

productId	By productId
name	By product name
productType	By product type - acceptable types are (PRODUCT, PARTS_MATERIALS, SERVICES)
externalId	By externalId of the product
sku	By SKU of the product
modelNumber	By model number of the product
hasSerialNumbers	By hasSerialNumbers flag (true or false) of product
disabled	By disabled flag true, the list will include disabled products
category	By category of the product (accepts categoryId or categoryName)

Return
Returns a list of Product Object(s) if valid arguments and search criteria are provided. If no search criteria is provided the list of a maximum 200 products 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="productId"/>
        <xs:element ref="name"/>
        <xs:element ref="sku"/>
        <xs:element ref="modelNumber"/>
        <xs:element ref="productType"/>
        <xs:element ref="hasSerialNumbers"/>
        <xs:element ref="disabled"/>
        <xs:element ref="category"/>
        <xs:element ref="externalId"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="productId" type="xs:integer" minOccurs="0"/>
  <xs:element name="name" type="xs:string" minOccurs="0"/>
  <xs:element name="sku" type="xs:integer" minOccurs="0"/>
  <xs:element name="modelNumber" type="xs:NMTOKEN" minOccurs="0"/>
  <xs:element name="productType" type="xs:NCName" minOccurs="0"/>
  <xs:element name="hasSerialNumbers" type="xs:boolean" minOccurs="0"/>
  <xs:element name="disabled" type="xs:boolean" minOccurs="0"/>
  <xs:element name="category" type="xs:string" minOccurs="0"/>
  <xs:element name="externalId" type="xs:integer" 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="productList"/>
      </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="productList">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="totalAvailableCount"/>
        <xs:element ref="count"/>
        <xs:element maxOccurs="unbounded" ref="product"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="totalAvailableCount" type="xs:integer"/>
  <xs:element name="count" type="xs:integer"/>
  <xs:element name="product">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="mobiworkProductId"/>
        <xs:element ref="externalId"/>
        <xs:element ref="name"/>
        <xs:element ref="description"/>
        <xs:element ref="type"/>
        <xs:element ref="price"/>
        <xs:element ref="cost"/>
        <xs:element ref="quantity"/>
        <xs:element ref="sku"/>
        <xs:element ref="modelNumber"/>
        <xs:element ref="hasSerialNumbers"/>
        <xs:element ref="priceIncludesTax"/>
        <xs:element ref="taxable"/>
        <xs:element ref="tax"/>
        <xs:element ref="enabled"/>
        <xs:element ref="competitorProduct"/>
        <xs:element ref="genericPart"/>
        <xs:element ref="createdDate"/>
        <xs:element ref="categoryId"/>
        <xs:element ref="category"/>
        <xs:element ref="subCategoryId"/>
        <xs:element ref="subCategory"/>
        <xs:element ref="customFields"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="mobiworkProductId" type="xs:integer"/>
  <xs:element name="externalId" type="xs:integer"/>
  <xs:element name="description" type="xs:string"/>
  <xs:element name="type" type="xs:NCName"/>
  <xs:element name="price" type="xs:decimal"/>
  <xs:element name="cost" type="xs:decimal"/>
  <xs:element name="quantity" type="xs:decimal"/>
  <xs:element name="sku" type="xs:integer"/>
  <xs:element name="modelNumber" type="xs:NMTOKEN"/>
  <xs:element name="hasSerialNumbers" type="xs:boolean"/>
  <xs:element name="priceIncludesTax" type="xs:boolean"/>
  <xs:element name="taxable" type="xs:boolean"/>
  <xs:element name="tax" type="xs:decimal"/>
  <xs:element name="enabled" type="xs:boolean"/>
  <xs:element name="competitorProduct" type="xs:boolean"/>
  <xs:element name="genericPart" type="xs:boolean"/>
  <xs:element name="createdDate" type="xs:string"/>
  <xs:element name="categoryId" type="xs:integer"/>
  <xs:element name="category" type="xs:string"/>
  <xs:element name="subCategoryId" type="xs:integer"/>
  <xs:element name="subCategory" type="xs:string"/>
  <xs:element name="customFields">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="customField"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="customField">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="fieldType"/>
        <xs:element ref="apiName"/>
        <xs:element ref="value"/>
        <xs:element ref="name"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="fieldType" type="xs:integer"/>
  <xs:element name="apiName" type="xs:NCName"/>
  <xs:element name="value">
    <xs:complexType/>
  </xs:element>
  <xs:element name="name" type="xs:string"/>
</xs:schema>

Curl Example

HTTP Method:	POST
Request:	curl -k -X POST -H "https://www.mobiwork.com/api/rest/12014/10.0.78/product/list.html?token=COJL8X2FKSLMMRTYCH2B" --header 'content-type: application/xml' --data '<request><productType>PRODUCT</productType></request>' OR to get limited list curl -k -X POST -H "https://www.mobiwork.com/api/rest/12014/10.0.78/product/list.html?token=COJL8X2FKSLMMRTYCH2B" --header 'content-type: application/xml' --data '<request><startPosition>0</startPosition><maxResults>10</maxResults></request>'
Response:	<?xml encoding="UTF-8" ?> <response version="10.0.78" statusCode="1"> <productList> <totalAvailableCount>206</totalAvailableCount> <count>10</count> <product> <mobiworkProductId>118661</mobiworkProductId> <externalId>PPP1111</externalId> <name>1" Galv. Elbow</name> <description>1" Galv. Elbow</description> <type>PRODUCT</type> <price>17.8</price> <cost>8.9</cost> <quantity>1243</quantity> <sku>04900028911</sku> <modelNumber>1303</modelNumber> <hasSerialNumbers>false</hasSerialNumbers> <priceIncludesTax>false</priceIncludesTax> <taxable>true</taxable> <tax>0.0</tax> <enabled>true</enabled> <createdDate>2014/04/02</createdDate> <categoryId>967</categoryId> <category>Galv. Fittings</category> <customFieldList> <customField> <apiName>ProductImg</apiName> <fieldType>25</fieldType> <value>/clientImagesapi/document/403802/view.html?client=9hjpvpLQip4%3D</value> <name>Product Img</name> </customField> <customField> <apiName>Field1</apiName> <fieldType>1</fieldType> <value>test</value> <name>Field1</name> </customField> </customFieldList> </product> <product> <mobiworkProductId>118659</mobiworkProductId> <externalId>null</externalId> <name>1/2" Galv. Elbow</name> <description>1/2" Galv. Elbow</description> <type>PRODUCT</type> <price>8.18</price> <cost>4.09</cost> <quantity>598</quantity> <sku>1Z2A611R0301576246</sku> <modelNumber>1301</modelNumber> <hasSerialNumbers>false</hasSerialNumbers> <priceIncludesTax>false</priceIncludesTax> <taxable>true</taxable> <tax>0.0</tax> <enabled>true</enabled> <createdDate>2014/04/02</createdDate> <categoryId>967</categoryId> <category>Galv. Fittings</category> <customFieldList> <customField> <apiName>ProductImg</apiName> <fieldType>25</fieldType> <value>/clientImagesapi/document/445197/view.html?client=9hjpvpLQip4%3D</value> <name>Product Img</name> </customField> <customField> <apiName>Field1</apiName> <fieldType>1</fieldType> <value></value> <name>Field1</name> </customField> </customFieldList> </product>