Price List

Delete a specific price list

Delets a price list by priceListId.

delete/api-offers/price-list/{priceListId}

Request

Path parameters

priceListIdnumber required
Example:10000003

Price list ID

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

priceListIdnumber

Price list ID. This is the system generated unique ID of the pricelist.

namestring

PricelList name

isDefaultboolean

true: This is the default price list<br /> false: This is the not default price list

currencystring iso-4217

3 letter currency code, as defined by ISO-4217, of the price specified in the price list

startDatestring date-time

Start date of the price list if any

endDatestring date-time

End date of the price list if any

deletedboolean

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

createdAtstring date-time

Creation date of the record

updatedAtstring date-time

Last updated date of the record

Example response

{
  "_id": "614b58924e92f6861ac9d43b",
  "priceListId": 10000003,
  "name": "BuildMuscles-CONTRACT123",
  "currency": "CAD",
  "startDate": "2021-05-04T09:23:51.459Z",
  "endDate": "2021-06-09T09:23:51.459Z",
  "deleted": true,
  "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.