Features - Connectors Framework - Inbound REST API - Pricelists
Pricelist
Overview
All the API methods available for pricelist.
Parameters
Allows the API to create and view your pricelists. You can retrieve individual pricelists as well as a list of all your pricelists.
description
optional
String
A description of the pricelist
status
optional
String
Custom status of the pricelist if any are defined in pricelist settings
customer
optional
Long
The customer ID this pricelist is for
locationId
optional
Long
The Id of the location this pricelist is for
category
optional
Long
Category ID of the pricelist's categories if any are defined in pricelist settings
assignedTo
optional
String
A pricelist can be assigned to user existing in MobiWork
externalId
required
String
The third-party client's internal ID
dueDate
required
String
The date which the pricelist is due
address
optional
Address Object
The address object associated with this pricelist
contact
optional
Contact Object
The contact object associated with this pricelist
Example
<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>