---
title: "Get price by priceId"
method: GET
path: "/api-offers/price/{priceId}/priceList/{priceListId}"
tags: ["Pricing"]
---

# Get price by priceId

`GET /api-offers/price/{priceId}/priceList/{priceListId}`

## Request

- Base URL: `https://live.copilot.fabric.inc`
- URL: `https://live.copilot.fabric.inc/api-offers/price/{priceId}/priceList/{priceListId}`
- Auth: HTTP bearer

Retrieves paginated list of price details based on priceListId and priceId or itemSku or itemId.

## Path parameters

- `priceId` string, required
- `priceListId` number, required

## Query parameters

- `type` 'itemSku' | 'itemId' | '_id'
- `limit` number
- `page` number
- `isActive` boolean

## Headers

- `x-site-context` string, required

## Response `200`

OK

- GetByIdPriceResponse
  - `_id` string, required: fabric internal ID
  - `isSoftDeleted` boolean: true: record is deleted<br /> false: record is not deleted
  - `itemId` number, required: Item ID
  - `itemSku` string: SKU of the item
  - `priceListId` number, required: ID of the priceList related to the SKU or item
  - `offers` object[], required: Prices of the SKU/priceListId.
    - `kind` number: Pricekind ID. This ID helps to identify if the price is base price or clearance price or any other additional price.
    - `channel` number, required: Channel ID
    - `startDate` string, date-time, required: Start date of the price
    - `endDate` string, date-time, required: End date of the price
    - `price` object, required: Price data
      - `base` number, required: Minimum fixed price of item.
      - `sale` number: Price at which product is offered for sale
      - `cost` number: Cost price of the item if any.
      - `currency` string, required: Currency code of the price.
    - `range` object[]: Range of prices if any.
      - `minQuantity` number: Minimum quantity to get a specific offer price.
      - `maxQuantity` union: Maximum quantity to get a specific price.
        - string
        - number
      - `price` number: Price for the specific range. This price only exists if width is not provided. That is, when the price method types are `Range-Base` and `SurfaceArea_Square_Increment`.
      - `width` object[]: Only for 2 dimensional price calculations, meaning when price-method-type is `SurfaceArea_Square_Increment_2Dim`. It exists if the above `price` is not sent.
        - `minQuantity` number: Minimum quantity to get a specific offer price.
        - `maxQuantity` union: Maximum quantity to get a specific offer price.
          - string
          - number
        - `price` number: Price for the width range.
    - `priceMethodType` 'Range-Base' | 'SurfaceArea_Square_Increment' | 'SurfaceArea_Square_Increment_2Dim': Type of method for calculating the price. <br /> **Range-Base:** Uses the quantity of sold items to determine which price to use. Base price (minimum fixed price) is ignored in this method.<br /> **SurfaceArea_Square_Increment:** Adds an incremental amount depending on the area of the item. The final price is calculated by adding the area multiplied by the price set for quantity, to the base price. For example, if we sell a rug that is 10x2, final price will be the base price (50, for example), plus an increment of the area (20) times the price range set for min quantity.<br /> **SurfaceArea_Square_Increment_2Dim:** Adds extra price to the base price, determined by the area. The difference with this Square Area method is that in this case the overprice is not calculated, but instead it is looked-up in a table-like structure that is already created, by checking for the range of values provided in `width`.
    - `priceAttributes` object[]: Price attributes/add-ons for the item
      - `blindMotor` number: Price of the attribute/addon
    - `additionalAttributes` object[]: A placeholder for additional attributes, in key-value pairs.
      - `customSkuTitle` string
      - `customCategory` string
  - `createdAt` string, date-time, required: Date of creation of the price.
  - `updatedAt` string, date-time, required: Last updated date of the price.
  - `job` boolean: true: Job is running<br /> false: Job operation is either completed or not running for some reason
  - `offerId` number: ID of the created offer for the itemId or itemSku
  - `query` object: Pagination details of Offers array. This field will only exist if the `isActive` flag is false.
    - `count` number, required: The total number of records.
    - `page` number, required: Page number to return. Always paired with `limit`
    - `limit` number, required: The maximum number of records per page.

## Other responses

- `404`: Not Found
- `500`: Internal Server Error

---

[API](https://skmtc.dev/fabric/apis/offers-v2.md) - [All operations](https://skmtc.dev/fabric/apis/offers-v2/llms.txt) - [OpenAPI document](https://skmtc.dev/fabric/apis/offers-v2/revisions/da2bd742b9bc?raw)