Features - Connectors Framework - Inbound REST API - Products
View Product By External ID
Overview
Retrieve a product information of the client by the External ID
URL Format
https://{domain}/api/rest/{clientId}/{versionNumber}/product/view.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
invoiceId
required
The identifier of the product to be retrieved
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 product Object if valid arguments are provided. Returns an error if not a valid request
Request Body XSD
None
Response Body XSD
Curl Example
HTTP Method: GET
Request: curl -k -X GET "https://www.mobiwork.com/api/rest/12014/10.0.78/product/view.html?token=COJL8X2FKSLMMRTYCH2B" --header 'content-type: application/xml' --data '<request>
<externalId>test</externalId>
</request>'
Response: <?xml encoding="UTF-8" ?>
<response version="10.0.78" statusCode="1">
<product>
<mobiworkProductId>118669</mobiworkProductId>
<externalId>null</externalId>
<name>110 Bend 90 RIB UG UBR42</name>
<description>110 Bend 90 RIB UG UBR42</description>
<type>PARTS_MATERIALS</type>
<price>77.76</price>
<cost>38.88</cost>
<quantity>127</quantity>
<sku></sku>
<modelNumber>1502</modelNumber>
<hasSerialNumbers>false</hasSerialNumbers>
<priceIncludesTax>false</priceIncludesTax>
<taxable>true</taxable>
<tax>0.14</tax>
<enabled>true</enabled>
<createdDate>2014/04/02</createdDate>
<categoryId>969</categoryId>
<category>Under ground fittings</category>
<customFieldList>
<customField>
<apiName>ProductImg</apiName>
<fieldType>25</fieldType>
<value></value>
<name>Product Img</name>
</customField>
<customField>
<apiName>Field1</apiName>
<fieldType>1</fieldType>
<value></value>
<name>Field1</name>
</customField>
</customFieldList>
</product>
</response>