Price Overrides

(ms.price_overrides)

Price overrides allow you to have a different set of pricing for different customers.

Fields

EndPoints

Fields

Value

Description

product_id

Type: string

Required

It stores the id of the product whose price is to be overridden.

variant_id

Type: string

It stores the id of the variant of the product, if any.

product_name

Type: string

The name of the product whose price is to be overridden.

conditions

Type: object

The conditions for which you want to override the prices.

substore Type: array	It stores the substores in which you wish to override the selected product's price.
user_id Type: string	It stores the id of the user to show the overridden prices to this specific user only.
user_group Type: string	It stores the specific user group to show the overridden prices.
country Type: string	It stores the country to show the overridden prices.
device Type: string	It stores the device on which the overridden prices will be shown.

override_type

Type: string

Required

The override type is the type of price that is discounted. There are four override types:

Increment fixed: The override type in which a specified amount is added to the actual price of the product.
Discount fixed: The override type in which a specified amount is deducted from the actual price of the product.
Increment percentage: The override type in which a specified percentage of the actual price of the product is added to the price of the product.
Discount percentage: The override type in which a specified percentage of the actual price of the product is deducted from the price of the product.
Plain override: The amount specified simply overrides the actual product's price and becomes the final product's price.

amount

Type: number

Required

The amount which is used under Override Type.

seller

Type: string

It stores the id of the seller if you wish to apply this override rule for a specific seller's products only.

Commands (Endpoints)

POST /api/1.1/entity/ms.price_overrides

Creates a new price override

DEL /api/1.1/entity/ms.price_overrides/{resource_id}

Deletes a price override

PUT /api/1.1/entity/ms.price_overrides/{resource_id}

Updates an existing price override

GET /api/1.1/entity/ms.price_overrides/{resource_id}

Retrieves a single price override

GET /api/1.1/entity/ms.price_overrides

Retrieves a list of price overrides