Load Product Inventory

Overview
Load the Product inventory of the product for the client

URL Format
https://{domain}.mobiwork.com/api/rest/{clientId}/{versionNumber}/product/Inventory.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

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="product"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="product">
    <xs:complexType>
      <xs:sequence>
        <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="category"/>
        <xs:element ref="customFields"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="externalId" type="xs:NCName" minOccurs="0"/>
  <xs:element name="description" type="xs:string" minOccurs="0"/>
  <xs:element name="type" type="xs:integer"/>
  <xs:element name="price" type="xs:decimal"/>
  <xs:element name="cost" type="xs:decimal"/>
  <xs:element name="quantity" type="xs:integer" minOccurs="0"/>
  <xs:element name="sku" type="xs:integer" minOccurs="0"/>
  <xs:element name="modelNumber" type="xs:integer" minOccurs="0"/>
  <xs:element name="hasSerialNumbers" type="xs:boolean" minOccurs="0"/>
  <xs:element name="priceIncludesTax" type="xs:boolean" minOccurs="0"/>
  <xs:element name="taxable" type="xs:boolean" minOccurs="0"/>
  <xs:element name="tax" type="xs:decimal"/>
  <xs:element name="enabled" type="xs:boolean" minOccurs="0"/>
  <xs:element name="category" type="xs:string" minOccurs="0"/>
  <xs:element name="customFields" minOccurs="0">
    <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="apiName"/>
        <xs:element ref="fieldType"/>
        <xs:element ref="value"/>
        <xs:element ref="name"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="apiName" type="xs:NCName"/>
  <xs:element name="fieldType" type="xs:integer"/>
  <xs:element name="value" type="xs:string"/>
  <xs:element name="name" type="xs:string"/>
</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="product"/>
      </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="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="customFields"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="mobiworkProductId" type="xs:integer"/>
  <xs:element name="externalId" type="xs:NCName"/>
  <xs:element name="description">
    <xs:complexType/>
  </xs:element>
  <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">
    <xs:complexType/>
  </xs:element>
  <xs:element name="modelNumber">
    <xs:complexType/>
  </xs:element>
  <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="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="index"/>
        <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="index" type="xs:integer"/>
  <xs:element name="value" type="xs:string"/>
  <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/Inventory.html?token=COJL8X2FKSLMMRTYCH2B" --header 'content-type: application/xml' --data '<request><productId>PRODUCT_ID</productId> <productName>PRODUCT_ID</productName></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>