FAfabric
Price Guard

Create price guard

Creates a price guard record that can contain various price kinds other than the elemental prices such as base price, sale price, and clearance price.

post/api-offers/price-guard

Request

Headers

x-site-contextstring required
Example:{"date": "2023-01-01T00:00:00.000Z", "channel": 12, "account": "1234abcd5678efgh9ijklmno","stage":"production"}

The x-site-context header is a JSON object that contains information about the source you wish to pull from. The mandatory account is the 24 character identifier found in Copilot. The channel (Sales channel ID), stage (environment name), and date attributes can be used to further narrow the scope of your data source.

Request body

itemIdinteger required

Item ID

itemSkustring

Item SKU

priceListIdinteger required

PriceList ID

MSRPnumber

Manufacturer suggested retail price

MAPnumber

Minimum advertised price

ceilingnumber

Maximum price the seller is allowed to charge for the product. Price created for the item ID or item SKU under the specified pricelist should not exceed the given ceiling price.

floornumber

Lowest price at which the product can be sold. Price created for the item ID or item SKU under the specified pricelist should not be lower than the given floor price.

Example request

{
  "itemId": 10000000123,
  "itemSku": "DEF-SKU-1",
  "priceListId": 100000,
  "MSRP": 299,
  "MAP": 299,
  "ceiling": 299,
  "floor": 299
}

Response

OK

_idstring

fabric database ObjectId of the record

itemIdinteger

Item ID

itemSkustring

Item SKU

priceListIdinteger

ID of the pricelist under which the price kinds are created

MSRPnumber

Manufacturer suggested retail price

MAPnumber

Minimum advertised price

ceilingnumber

Maximum price the seller is allowed to charge for the product. Price created for the item ID or item SKU under the specified pricelist should not exceed the given ceiling price.

floornumber

Lowest price at which the product can be sold. Price created for the item ID or item SKU under the specified pricelist should not be lower than the given floor price.

deletedboolean

true: price guard is deleted<br /> false: price guard is not deleted

createdAtstring date-time

Creation date of the record

updatedAtstring date-time

Last updated date of the record

Example response

{
  "_id": "614b58924e92f6861ac9d43b",
  "itemId": 10000000123,
  "itemSku": "DEF-SKU-1",
  "priceListId": 100000,
  "MSRP": 299,
  "MAP": 299,
  "ceiling": 299,
  "floor": 299,
  "createdAt": "2020-12-14T12:15:43.646Z",
  "updatedAt": "2021-12-14T12:15:43.646Z"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.