Document toolboxDocument toolbox

Objects Pricing Object

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

3.16.0

The Pricing object contains pricing information that is associated with either an account for account specific pricing or a tier for tier level pricing. 

  • It is assumed that account specific pricing is priced in local currency
  • It is assumed that tier specific pricing is priced in the local currency of the accounts the tier will be associated with


On this page:

Related pages:

Pricing Object Formats

JSON Format 
{
    "{$ProdNum}" : {
        "Price" : 0.0,
		"Delete" : false
    }
}

Pricing Object Properties

(info) Required properties are in Bold.

PropertyTypeDescription
{$ProdNum}stringThe property contains the actual product number who's price is to be set.
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.

Pricedecimal

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

Example 

{
	"1001" : {
		"Price" : 29.99
	},
	"1002" : {
		"Price" : 19.99
	}
}

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

Pricing Logic

When calculating the pricing:

  • If an account-specific price is found, that price will be used as the base price.
  • If no account-specific pricing exists, the API will then check for tier-specific pricing (if the account is associated with a pricing tier); if a tier-specific price is found, that price will be used as the base price.
  • If no tier-specific pricing exists, the API will then check for price list pricing (if the supplied service area has a price list).
  • If no price-list exists, the retail price will be used as the base price.