List Pricelists

Overview
Retrieve pricelist List of the client

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

productExternalId	By product's External ID.
productName	By name of the product
customerExternalId	By external ID of customer
customerName	By the name of customer.
customerCategory	By customer category.

Return
Returns a list of pricelist Object(s) if valid arguments and search criteria are provided. If no search criteria is provided the list of a maximum 200 pricelists 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="productExternalId"/>
        <xs:element ref="productName"/>
        <xs:element ref="customerExternalId"/>
        <xs:element ref="customerName"/>
        <xs:element ref="customerCategory"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="productExternalId" type="xs:NCName" minOccurs="0"/>
  <xs:element name="productName" type="xs:string" minOccurs="0"/>
  <xs:element name="customerExternalId" type="xs:integer" minOccurs="0"/>
  <xs:element name="customerName" type="xs:string" minOccurs="0"/>
  <xs:element name="customerCategory" 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="priceLists"/>
      </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="priceLists">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="totalAvailableCount"/>
        <xs:element ref="count"/>
        <xs:element maxOccurs="unbounded" ref="productPriceList"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="totalAvailableCount" type="xs:integer"/>
  <xs:element name="count" type="xs:integer"/>
  <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 minOccurs="0" 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:string"/>
  <xs:element name="productPriceListCustomerCategoryId" type="xs:integer"/>
  <xs:element name="customerList">
    <xs:complexType>
      <xs:sequence>
        <xs:element minOccurs="0" 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 minOccurs="0" 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:NMTOKEN"/>
  <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 GET 'https://www.mobiwork.com/api/rest/17800/10.0.80/pricelist/list.html?token=WPOQVYCVAZZMUZ6QCUUR' \ --header 'Content-Type: application/xml' \ --data-raw '<request> <productExternalId>API1114</productExternalId> <productName>Test Product 15</productName> <customerExternalId>333444</customerExternalId> <customerName>Testing Company 789798</customerName> <customerCategory>Testing</customerCategory> </request>'
Response:	<?xml version="1.0" encoding="UTF-8" ?> <response version="10.0.80" statusCode="1"> <priceLists> <totalAvailableCount>11</totalAvailableCount> <count>11</count> <productPriceList> <createdDate>05/10/2021</createdDate> <categoryId>0</categoryId> <categoryName></categoryName> <createdBy>Alkin Kiroglu</createdBy> <createdById>84328</createdById> <customStatusId>0</customStatusId> <customStatusName></customStatusName> <customerCategoryList> <priceListCustomerCategory> <productPriceListId>859</productPriceListId> <customerCategoryId>2092</customerCategoryId> <customerCategoryName>Price To Pay</customerCategoryName> <productPriceListCustomerCategoryId>89</productPriceListCustomerCategoryId> </priceListCustomerCategory> </customerCategoryList> <customerList></customerList> <discountAmount>0.0</discountAmount> <discountPercent>0.0</discountPercent> <externalId></externalId> <mobiworkProductPriceListId>859</mobiworkProductPriceListId> <name></name> <priceListCustomerType>CUSTOMER_LIST</priceListCustomerType> <priceListPriceType></priceListPriceType> <productList> <priceListProduct> <productPriceListId>859</productPriceListId> <price>0.0</price> <productExternalId>API1114</productExternalId> <productId>1450607</productId> <productName>Test Product 15</productName> <productPriceListProductId>249844</productPriceListProductId> </priceListProduct> </productList> </productPriceList> <productPriceList> <createdDate>05/10/2021</createdDate> <categoryId>0</categoryId> <categoryName></categoryName> <createdBy>Alkin Kiroglu</createdBy> <createdById>84328</createdById> <customStatusId>0</customStatusId> <customStatusName></customStatusName> <customerCategoryList></customerCategoryList> <customerList> <priceListCustomer> <productPriceListId>858</productPriceListId> <customerExternalId>333444</customerExternalId> <customerId>3473576</customerId> <customerName>Testing Company 789798</customerName> <productPriceListCustomerId>8453334</productPriceListCustomerId> </priceListCustomer> </customerList> <discountAmount>0.0</discountAmount> <discountPercent>0.0</discountPercent> <externalId></externalId> <mobiworkProductPriceListId>858</mobiworkProductPriceListId> <name></name> <priceListCustomerType>CUSTOMER_LIST</priceListCustomerType> <priceListPriceType></priceListPriceType> <productList> <priceListProduct> <productPriceListId>858</productPriceListId> <price>0.0</price> <productExternalId>API1114</productExternalId> <productId>1450607</productId> <productName>Test Product 15</productName> <productPriceListProductId>249843</productPriceListProductId> </priceListProduct> </productList> </productPriceList> <productPriceList> <createdDate>05/10/2021</createdDate> <categoryId>0</categoryId> <categoryName></categoryName> <createdBy>Alkin Kiroglu</createdBy> <createdById>84328</createdById> <customStatusId>0</customStatusId> <customStatusName></customStatusName> <customerCategoryList></customerCategoryList> <customerList></customerList> <discountAmount>0.0</discountAmount> <discountPercent>0.0</discountPercent> <externalId></externalId> <mobiworkProductPriceListId>857</mobiworkProductPriceListId> <name></name> <priceListCustomerType>CUSTOMER_LIST</priceListCustomerType> <priceListPriceType></priceListPriceType> <productList> <priceListProduct> <productPriceListId>857</productPriceListId> <price>0.0</price> <productExternalId>API1114</productExternalId> <productId>1450607</productId> <productName>Test Product 15</productName> <productPriceListProductId>249842</productPriceListProductId> </priceListProduct> </productList> </productPriceList> <productPriceList> <createdDate>05/10/2021</createdDate> <categoryId>0</categoryId> <categoryName></categoryName> <createdBy>Alkin Kiroglu</createdBy> <createdById>84328</createdById> <customStatusId>0</customStatusId> <customStatusName></customStatusName> <customerCategoryList></customerCategoryList> <customerList></customerList> <discountAmount>0.0</discountAmount> <discountPercent>0.0</discountPercent> <externalId></externalId> <mobiworkProductPriceListId>856</mobiworkProductPriceListId> <name></name> <priceListCustomerType>CUSTOMER_LIST</priceListCustomerType> <priceListPriceType></priceListPriceType> <productList> <priceListProduct> <productPriceListId>856</productPriceListId> <price>0.0</price> <productExternalId>API1114</productExternalId> <productId>1450607</productId> <productName>Test Product 15</productName> <productPriceListProductId>249841</productPriceListProductId> </priceListProduct> </productList> </productPriceList> <productPriceList> <createdDate>05/10/2021</createdDate> <categoryId>0</categoryId> <categoryName></categoryName> <createdBy>Alkin Kiroglu</createdBy> <createdById>84328</createdById> <customStatusId>0</customStatusId> <customStatusName></customStatusName> <customerCategoryList></customerCategoryList> <customerList></customerList> <discountAmount>0.0</discountAmount> <discountPercent>0.0</discountPercent> <externalId></externalId> <mobiworkProductPriceListId>855</mobiworkProductPriceListId> <name></name> <priceListCustomerType>CUSTOMER_LIST</priceListCustomerType> <priceListPriceType></priceListPriceType> <productList> <priceListProduct> <productPriceListId>855</productPriceListId> <price>0.0</price> <productExternalId>API1114</productExternalId> <productId>1450607</productId> <productName>Test Product 15</productName> <productPriceListProductId>249840</productPriceListProductId> </priceListProduct> </productList> </productPriceList> <productPriceList> <createdDate>05/10/2021</createdDate> <categoryId>0</categoryId> <categoryName></categoryName> <createdBy>Alkin Kiroglu</createdBy> <createdById>84328</createdById> <customStatusId>0</customStatusId> <customStatusName></customStatusName> <customerCategoryList></customerCategoryList> <customerList></customerList> <discountAmount>0.0</discountAmount> <discountPercent>0.0</discountPercent> <externalId></externalId> <mobiworkProductPriceListId>854</mobiworkProductPriceListId> <name></name> <priceListCustomerType>CUSTOMER_LIST</priceListCustomerType> <priceListPriceType></priceListPriceType> <productList> <priceListProduct> <productPriceListId>854</productPriceListId> <price>0.0</price> <productExternalId>API1114</productExternalId> <productId>1450607</productId> <productName>Test Product 15</productName> <productPriceListProductId>249839</productPriceListProductId> </priceListProduct> </productList> </productPriceList> <productPriceList> <createdDate>05/06/2021</createdDate> <categoryId>0</categoryId> <categoryName></categoryName> <createdBy>Alkin Kiroglu</createdBy> <createdById>84328</createdById> <customStatusId>0</customStatusId> <customStatusName></customStatusName> <customerCategoryList></customerCategoryList> <customerList></customerList> <discountAmount>0.0</discountAmount> <discountPercent>0.0</discountPercent> <externalId></externalId> <mobiworkProductPriceListId>853</mobiworkProductPriceListId> <name></name> <priceListCustomerType>CUSTOMER_LIST</priceListCustomerType> <priceListPriceType></priceListPriceType> <productList> <priceListProduct> <productPriceListId>853</productPriceListId> <price>0.0</price> <productExternalId>API1114</productExternalId> <productId>1450607</productId> <productName>Test Product 15</productName> <productPriceListProductId>249838</productPriceListProductId> </priceListProduct> </productList> </productPriceList> <productPriceList> <createdDate>05/06/2021</createdDate> <categoryId>0</categoryId> <categoryName></categoryName> <createdBy>Alkin Kiroglu</createdBy> <createdById>84328</createdById> <customStatusId>0</customStatusId> <customStatusName></customStatusName> <customerCategoryList></customerCategoryList> <customerList></customerList> <discountAmount>0.0</discountAmount> <discountPercent>0.0</discountPercent> <externalId></externalId> <mobiworkProductPriceListId>852</mobiworkProductPriceListId> <name></name> <priceListCustomerType>CUSTOMER_LIST</priceListCustomerType> <priceListPriceType></priceListPriceType> <productList> <priceListProduct> <productPriceListId>852</productPriceListId> <price>0.0</price> <productExternalId>API1114</productExternalId> <productId>1450607</productId> <productName>Test Product 15</productName> <productPriceListProductId>249837</productPriceListProductId> </priceListProduct> </productList> </productPriceList> <productPriceList> <createdDate>05/06/2021</createdDate> <categoryId>0</categoryId> <categoryName></categoryName> <createdBy>Alkin Kiroglu</createdBy> <createdById>84328</createdById> <customStatusId>0</customStatusId> <customStatusName></customStatusName> <customerCategoryList> <priceListCustomerCategory> <productPriceListId>851</productPriceListId> <customerCategoryId>2091</customerCategoryId> <customerCategoryName>Testing Category</customerCategoryName> <productPriceListCustomerCategoryId>88</productPriceListCustomerCategoryId> </priceListCustomerCategory> </customerCategoryList> <customerList></customerList> <discountAmount>0.0</discountAmount> <discountPercent>0.0</discountPercent> <externalId></externalId> <mobiworkProductPriceListId>851</mobiworkProductPriceListId> <name></name> <priceListCustomerType>CUSTOMER_LIST</priceListCustomerType> <priceListPriceType></priceListPriceType> <productList> <priceListProduct> <productPriceListId>851</productPriceListId> <price>0.0</price> <productExternalId>API1114</productExternalId> <productId>1450607</productId> <productName>Test Product 15</productName> <productPriceListProductId>249836</productPriceListProductId> </priceListProduct> </productList> </productPriceList> <productPriceList> <createdDate>05/06/2021</createdDate> <categoryId>0</categoryId> <categoryName></categoryName> <createdBy>Alkin Kiroglu</createdBy> <createdById>84328</createdById> <customStatusId>0</customStatusId> <customStatusName></customStatusName> <customerCategoryList></customerCategoryList> <customerList> <priceListCustomer> <productPriceListId>850</productPriceListId> <customerExternalId>928416</customerExternalId> <customerId>3462211</customerId> <customerName>Test Company 007</customerName> <productPriceListCustomerId>8453333</productPriceListCustomerId> </priceListCustomer> </customerList> <discountAmount>0.0</discountAmount> <discountPercent>0.0</discountPercent> <externalId></externalId> <mobiworkProductPriceListId>850</mobiworkProductPriceListId> <name></name> <priceListCustomerType>CUSTOMER_LIST</priceListCustomerType> <priceListPriceType></priceListPriceType> <productList> <priceListProduct> <productPriceListId>850</productPriceListId> <price>0.0</price> <productExternalId>API1114</productExternalId> <productId>1450607</productId> <productName>Test Product 15</productName> <productPriceListProductId>249835</productPriceListProductId> </priceListProduct> </productList> </productPriceList> <productPriceList> <createdDate>05/06/2021</createdDate> <categoryId>0</categoryId> <categoryName></categoryName> <createdBy>Alkin Kiroglu</createdBy> <createdById>84328</createdById> <customStatusId>0</customStatusId> <customStatusName></customStatusName> <customerCategoryList></customerCategoryList> <customerList></customerList> <discountAmount>0.0</discountAmount> <discountPercent>0.0</discountPercent> <externalId></externalId> <mobiworkProductPriceListId>849</mobiworkProductPriceListId> <name></name> <priceListCustomerType>CUSTOMER_LIST</priceListCustomerType> <priceListPriceType></priceListPriceType> <productList></productList> </productPriceList> </priceLists> </response>