View Pricelist By External ID

Overview
Retrieve a pricelist's information of the client by the External ID

URL Format
https://{domain}/api/rest/{clientId}/{versionNumber}/pricelist/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
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 pricelist Object if valid arguments are provided. 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="externalId"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="externalId" type="xs:NCName"/>
</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="productPriceList"/>
      </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="productPriceList">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="createdDate"/>
        <xs:element ref="categoryId"/>
        <xs:element ref="categoryName"/>
        <xs:element ref="createdBy"/>
        <xs:element ref="createdById"/>
        <xs:element ref="customStatusId"/>
        <xs:element ref="customStatusName"/>
        <xs:element ref="customerCategoryList"/>
        <xs:element ref="customerList"/>
        <xs:element ref="discountAmount"/>
        <xs:element ref="discountPercent"/>
        <xs:element ref="externalId"/>
        <xs:element ref="mobiworkProductPriceListId"/>
        <xs:element ref="name"/>
        <xs:element ref="priceListCustomerType"/>
        <xs:element ref="priceListPriceType"/>
        <xs:element ref="productList"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="createdDate" type="xs:string"/>
  <xs:element name="categoryId" type="xs:integer"/>
  <xs:element name="categoryName">
    <xs:complexType/>
  </xs:element>
  <xs:element name="createdBy" type="xs:string"/>
  <xs:element name="createdById" type="xs:integer"/>
  <xs:element name="customStatusId" type="xs:integer"/>
  <xs:element name="customStatusName">
    <xs:complexType/>
  </xs:element>
  <xs:element name="customerCategoryList">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="priceListCustomerCategory"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="priceListCustomerCategory">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="productPriceListId"/>
        <xs:element ref="customerCategoryId"/>
        <xs:element ref="customerCategoryName"/>
        <xs:element ref="productPriceListCustomerCategoryId"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="customerCategoryId" type="xs:integer"/>
  <xs:element name="customerCategoryName" type="xs:NCName"/>
  <xs:element name="productPriceListCustomerCategoryId" type="xs:integer"/>
  <xs:element name="customerList">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="priceListCustomer"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="priceListCustomer">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="productPriceListId"/>
        <xs:element ref="customerExternalId"/>
        <xs:element ref="customerId"/>
        <xs:element ref="customerName"/>
        <xs:element ref="productPriceListCustomerId"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="customerExternalId" type="xs:integer"/>
  <xs:element name="customerId" type="xs:integer"/>
  <xs:element name="customerName" type="xs:string"/>
  <xs:element name="productPriceListCustomerId" type="xs:integer"/>
  <xs:element name="discountAmount" type="xs:decimal"/>
  <xs:element name="discountPercent" type="xs:decimal"/>
  <xs:element name="externalId">
    <xs:complexType/>
  </xs:element>
  <xs:element name="mobiworkProductPriceListId" type="xs:integer"/>
  <xs:element name="name" type="xs:string"/>
  <xs:element name="priceListCustomerType" type="xs:NCName"/>
  <xs:element name="priceListPriceType">
    <xs:complexType/>
  </xs:element>
  <xs:element name="productList">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="priceListProduct"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="priceListProduct">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="productPriceListId"/>
        <xs:element ref="price"/>
        <xs:element ref="productExternalId"/>
        <xs:element ref="productId"/>
        <xs:element ref="productName"/>
        <xs:element ref="productPriceListProductId"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="price" type="xs:decimal"/>
  <xs:element name="productExternalId" type="xs:integer"/>
  <xs:element name="productId" type="xs:integer"/>
  <xs:element name="productName" type="xs:string"/>
  <xs:element name="productPriceListProductId" type="xs:integer"/>
  <xs:element name="productPriceListId" type="xs:integer"/>
</xs:schema>

Curl Example

HTTP Method:	POST
Request:	curl -k -X POST "https://www.mobiwork.com/api/rest/12014/10.0.78/pricelist/view.html?token=COJL8X2FKSLMMRTYCH2B" --header 'content-type: application/xml' --data '<request> <externalId>test</externalId> </request>'
Response:	<?xml version="1.0" encoding="UTF-8" ?> <response version="6.0.3" statusCode="1"> <priceLists><totalAvailableCount>1</totalAvailableCount><count>1</count> <productPriceList> <createdDate>07/24/2019</createdDate> <categoryId>0</categoryId> <categoryName>null</categoryName> <createdBy>Mobi Admin</createdBy> <createdById>1</createdById> <customStatusId>0</customStatusId> <customStatusName>null</customStatusName> <customerCategoryList></customerCategoryList> <customerList></customerList> <discountAmount>0.0</discountAmount> <discountPercent>0.0</discountPercent> <externalId>null</externalId> <mobiworkProductPriceListId>1</mobiworkProductPriceListId> <name>Test pricelist</name> <priceListCustomerType>CUSTOMER_LIST</priceListCustomerType> <priceListPriceType>INDIVIDUAL_PRODUCT_PRICE</priceListPriceType> <productList> <priceListProduct> <productPriceListId>1</productPriceListId> <price>0.0</price> <productExternalId>A11030</productExternalId> <productId>11</productId> <productName>Fluorescent Desk Lamp</productName> <productPriceListProductId>2</productPriceListProductId> </priceListProduct> <priceListProduct> <productPriceListId>1</productPriceListId> <price>0.0</price> <productExternalId>A11050</productExternalId> <productId>12</productId> <productName>13W Mini Fluorescent Bulb</productName> <productPriceListProductId>3</productPriceListProductId> </priceListProduct> </productList> </productPriceList> </priceLists> </response>