DELETE
/
api-offers
/
price
/
{priceId}
/
priceList
/
{priceListId}
curl --request DELETE \
  --url https://live.copilot.fabric.inc/api-offers/price/{priceId}/priceList/{priceListId} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-site-context: <x-site-context>'
{
  "_id": "616e011037a3810012345678",
  "isSoftDeleted": true,
  "itemId": 1000000051,
  "itemSku": "SKU123456",
  "offerId": 2386,
  "createdAt": "2020-02-02T17:22:48.570Z",
  "updatedAt": "2020-02-02T17:22:48.570Z",
  "job": false,
  "priceListId": 100000,
  "offers": []
}

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\"}"

Path Parameters

​
priceId
string
required

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.

Example:

"SKU123456"

​
priceListId
number
required

ID of the priceList to search the price for.

Example:

100000

Query Parameters

​
type
enum<string>

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.

Available options:
itemSku,
itemId,
_id
Example:

"itemId"

Response

200
application/json
OK
​
_id
string

fabric internal unique ID

Example:

"616e011037a3810012345678"

​
isSoftDeleted
boolean

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

Example:

true

​
itemId
number

Item ID

Example:

1000000051

​
itemSku
string

Item SKU

Example:

"SKU123456"

​
offerId
number

ID of the created offer for the itemId or itemSku

Example:

2386

​
createdAt
string

Creation date of the record

Example:

"2020-02-02T17:22:48.570Z"

​
updatedAt
string

Last update date of the record

Example:

"2020-02-02T17:22:48.570Z"

​
job
boolean

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

Example:

false

​
priceListId
number

Price list ID that contains the updated or created price

Example:

100000

​
offers
object[]
Example:
[]

Was this page helpful?

Get price by priceIdOverview