Pricing

Delete price by priceId

Deletes a price based on priceListID, and priceId or itemSku or itemId.

delete/api-offers/price/{priceId}/priceList/{priceListId}

Request

Path parameters

priceIdstring required
Example:SKU123456

Value for this field can be database ID (_id) of the price or itemSku or itemId based on the type mentioned in the type query parameter.<br /> If a type is not specified in the type query parameter, you must provide itemSku in this priceId field.

priceListIdnumber required
Example:100000

ID of the priceList to search the price for.

Query parameters

type'itemSku' | 'itemId' | '_id'
Example:itemId

The priceId path parameter will be treated as itemSku, itemId or databse ID (_id) depending on this field. The default search will be done by itemSku.

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.

Response

OK

_idstring

fabric internal unique ID

isSoftDeletedboolean

true: Price is deleted<br /> false: Price is not deleted

itemIdnumber

Item ID

itemSkustring

Item SKU

offerIdnumber

ID of the created offer for the itemId or itemSku

createdAtstring date-time

Creation date of the record

updatedAtstring date-time

Last update date of the record

jobboolean

true: Job is running either to create, update, or delete the record<br /> false: Job is either completed or not running for some reason

priceListIdnumber

Price list ID that contains the updated or created price

offersobject[]

Example response

{
  "_id": "616e011037a3810012345678",
  "isSoftDeleted": true,
  "itemId": 1000000051,
  "itemSku": "SKU123456",
  "offerId": 2386,
  "createdAt": "2020-02-02T17:22:48.570Z",
  "updatedAt": "2020-02-02T17:22:48.570Z",
  "priceListId": 100000,
  "offers": []
}

Changes

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