Document toolboxDocument toolbox

Price List Query Object

Owned by Andrew Hill (Deactivated)
Last updated: Oct 03, 2024 by Jason Andrew

3.20.0

This Price List object contains pricing information that is associated with either zero or more service areas. Service Area assignments are managed by either Price List REST API or Service Area REST API.


On this page:

Related pages:

Price List Object Formats

JSON Format
 {
 	"ISOCurrencySymbol": "",
 	"Name": "",
 	"PriceListID": "",
 	"Prices": {
 		"{$ProdNum}": {
 			"Price": 0.0,
 			"Delete": false
 		}
 	},
	"PriceListSize": 100,
	"TotalProducts": 1000
 }

Price List Object Properties

(info) Required properties are in Bold.

PropertyTypeDescription
ISOCurrencySymbolstringThe three-character ISO 4217 currency symbol associated with the price list. The default value is USD if this property is not specified.
NamestringIdentifies the name of the service area
PriceListIDstringIdentifies the price list associated with the service area
Pricesobject

Contains the product prices associated with the price list. This object is keyed on the Product Number.

PropertyTypeDescription
{$ProdNum} string

The property contains the actual product number who's price is to be set.

PropertyTypeDescription
Deleteboolean

Optional property.

This property is used during a PUT request to remove specific items. This property will never be returned during a GET request.

PricedecimalIdentifies the price associated with the product identified by ${ProdNum} field.


PriceListSizeintIdentifies the total number of products in the price list
TotalProductsintIdentifies the total number of products in the product catalog

Example 

 {
 	"ISOCurrencySymbol": "",
 	"Name": "",
 	"PriceListID": "",
 	"Prices": {
 		"900": {
 			"Price": 20.0
 		},
 		"901": {
 			"Price": 29.99
 		},
 		"902": {
 			"Price": 39.99
 		}
 	}
 }

In the above example the price of the product identified by the product number 901 is set to 29.99.