DELETE
/
api-price
/
price
/
{priceId}
curl --request DELETE \
  --url https://prod01-apigw.{customer_name}.fabric.zone/api-price/price/{priceId} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-site-context: <x-site-context>'
{
  "_id": "616e011037a3810008cfb256",
  "priceListId": 100000,
  "isSoftDeleted": true,
  "itemId": 1000011218,
  "itemSku": "1234XYZ",
  "offerId": 371922,
  "offers": [
    {
      "kind": 12,
      "channel": 12,
      "startDate": "2021-12-30T02:05:00.000Z",
      "endDate": "2099-12-31T00:00:00.000Z",
      "price": {
        "base": 2000,
        "sale": 1000,
        "cost": 800,
        "currency": "USD"
      }
    }
  ],
  "createdAt": "2021-10-18T23:19:44.852Z",
  "updatedAt": "2021-10-19T00:40:30.341Z",
  "job": true
}

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

The mongo objectID, itemId or itemSku of the price to be retrieved

Query Parameters

​
priceListId
string
required

PriceListId to get the price from.

​
type
enum<string>

The type of id that is provided in path for priceId.

Available options:
id,
itemId,
itemSku

Response

200
application/json
Returns the deleted price

Create Price Response

​
_id
string

ID

Example:

"616e011037a3810008cfb256"

​
priceListId
number

Price List ID

Example:

100000

​
isSoftDeleted
boolean

Has been soft deleted

Example:

true

​
itemId
number

Internal Item ID

Example:

1000011218

​
itemSku
string

Product SKU

Example:

"1234XYZ"

​
offerId
number

Offer ID

Example:

371922

​
offers
object[]

Offers

Item in Offer

​
createdAt
string

Date and time of creation

Example:

"2021-10-18T23:19:44.852Z"

​
updatedAt
string

Date and time of updated

Example:

"2021-10-19T00:40:30.341Z"

​
job
boolean

Job

Was this page helpful?