POST
/
api-offers
/
price-guard
curl --request POST \
  --url https://live.copilot.fabric.inc/api-offers/price-guard \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-site-context: <x-site-context>' \
  --data '{
  "itemId": 10000000123,
  "itemSku": "DEF-SKU-1",
  "priceListId": 100000,
  "MSRP": 299,
  "MAP": 299,
  "ceiling": 299,
  "floor": 299
}'
{
  "_id": "614b58924e92f6861ac9d43b",
  "itemId": 10000000123,
  "itemSku": "DEF-SKU-1",
  "priceListId": 100000,
  "MSRP": 299,
  "MAP": 299,
  "ceiling": 299,
  "floor": 299,
  "deleted": false,
  "createdAt": "2020-12-14T12:15:43.646Z",
  "updatedAt": "2021-12-14T12:15:43.646Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
x-site-context
string
required

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.

Example:

"{\"date\": \"2023-01-01T00:00:00.000Z\", \"channel\": 12, \"account\": \"1234abcd5678efgh9ijklmno\",\"stage\":\"production\"}"

Body

application/json
​
itemId
integer
required

Item ID

Example:

10000000123

​
priceListId
integer
required

PriceList ID

Example:

100000

​
itemSku
string

Item SKU

Example:

"DEF-SKU-1"

​
MSRP
number

Manufacturer suggested retail price

Example:

299

​
MAP
number

Minimum advertised price

Example:

299

​
ceiling
number

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.

Example:

299

​
floor
number

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:

299

Response

200
application/json
OK
​
_id
string

fabric database ObjectId of the record

Example:

"614b58924e92f6861ac9d43b"

​
itemId
integer

Item ID

Example:

10000000123

​
itemSku
string

Item SKU

Example:

"DEF-SKU-1"

​
priceListId
integer

ID of the pricelist under which the price kinds are created

Example:

100000

​
MSRP
number

Manufacturer suggested retail price

Example:

299

​
MAP
number

Minimum advertised price

Example:

299

​
ceiling
number

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.

Example:

299

​
floor
number

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:

299

​
deleted
boolean

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

Example:

false

​
createdAt
string

Creation date of the record

Example:

"2020-12-14T12:15:43.646Z"

​
updatedAt
string

Last updated date of the record

Example:

"2021-12-14T12:15:43.646Z"

Was this page helpful?

Delete a specific price guardUpdate a specific price guard