Document toolboxDocument toolbox

Copy Price List Object

Owned by Mickey Bushman
Last updated: Apr 06, 2023Version comment

3.30.0

This Copy Price List object contains price adjustments and price overrides information that is to be applied to source price list. Service Area assignments are managed by either Price List REST API or Service Area REST API.

 

On this page:

Related pages:

Copy Price List Object Formats

JSON Format 
 {
	"ISOCurrencySymbol": "USD",
	"Name": "",
	"PriceAdjustments": [{
		"ProdType": "",
		"Operator": "",
		"Value": 10
	}],
	"PriceListID": "",
	"PriceOverride": {
		"{$ProdNum}": {
			"Price": 133
		}
	}
}

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.
NamestringContains the name for the price list
PriceAdjustmentscollection

Contains price adjustments to be applied to source price list.

PropertyTypeDescription
ProdTypestring

Identifies the product item type or category.

See: Product Types System Category

Operatorstring

Identifies the operation to be performed on source price list item prices.

Valid values are:

ValueDescription
+Add
-Subtract
*Multiply
%Percentage
ValuenumberIdentifies the value for price adjustment. This value is used in conjunction with Operator property.
PriceListIDstringThis property uniquely identifies the price list
PriceOverrideobject

Contains the product price overrides 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 to remove specific items.

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


PriceAdjustments or PriceOverride property must be present in the Copy Price List object.

Example 

{
	"ISOCurrencySymbol": "USD",
	"Name": "",
	"PriceAdjustments": [{
		"ProdType": "1001",
		"Operator": "+",
		"Value": 10
	}],
	"PriceListID": "",
	"PriceOverride": {
		"900": {
			"Price": 29.99
		},
		"901": {
			"Delete": true
		}
	}
} 
 

In the above example the price of all the products with ProdType = 1001 will increased by 10.  Price overrides will set the price of the product identified by the product number 901 to 29.99. Product with product number 901 will be removed from price list.