online-help.platform.features.premier_subscription.connectors.inbound-rest-api.endpoints.pricelist.title
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
Response Body XSD
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>