---
title: "Get all prices"
method: GET
path: "/api-offers/price"
tags: ["Pricing"]
---

# Get all prices

`GET /api-offers/price`

## Request

- Base URL: `https://live.copilot.fabric.inc`
- URL: `https://live.copilot.fabric.inc/api-offers/price`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/fabric/apis/offers-v2/docs/api-offers/price/get.ts> (a function with typed inputs; its response is checked against the schema)

Gets a paginated list of all prices.

## Query parameters

- `limit` number
- `page` number
- `priceListId` number
- `sortBy` 'itemId' | 'priceListId' | 'updatedAt'
- `sortOrder` 'asc' | 'desc'

## Headers

- `x-site-context` string, required

## Response `200`

OK

- GetPriceResponse
  - `query` object: Object containing the size, count and number of pages in the response.
  - `prices` object[]: An array containing all the prices in service
    - `_id` string: fabric internal unique ID
    - `isSoftDeleted` boolean: true: Price is deleted<br /> false: Price is not deleted
    - `itemId` number: Item ID
    - `itemSku` string: Item SKU
    - `offerId` number: ID of the created offer for the itemId or itemSku
    - `createdAt` string, date-time: Creation date of the record
    - `updatedAt` string, date-time: Last update date of the record
    - `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
    - `priceListId` number: Price list ID that contains the updated or created price
    - `offers` object[]
      - `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: Sales channel ID
      - `startDate` string, date-time: Start date of the price if any
      - `endDate` string, date-time: End date of the price if any
      - `price` Price
        - `base` number: Base price (Minimum fixed price) of item
        - `sale` number: Price at which the product is offered for sale
        - `cost` number: Cost of the item
        - `currency` string: The 3 letter currency code as defined by ISO-4217
      - `offerCode` number: Unique code associated with the created offer price
      - `range` object[]: Price range, based on quantity of items sold. If price range of an item is setup using the *Price Range* APIs, this array should not be empty.
        - `minQuantity` number: Minimum quantity to be sold for the range price to be applied
        - `price` number: Range price of item to be applied for each item if quantity meets the minQuantity requirement
        - `maxQuantity` union: Maximum quantity to get offer price.
          - string: The maximum quantity of items that can be sold to apply the price range.
          - number: Set the maximum quantity to get offer price.
        - `width` object[]: Only for 2 dimensional price calculations, meaning when price-method-type is `SurfaceArea_Square_Increment_2Dim`.
          - `minQuantity` number, required: Minimum quantity to get offer price.
          - `maxQuantity` union, required: Maximum quantity to get offer price
            - string: The maximum quantity value `Infinity`.
            - number: Set the maximum quantity to get offer price
          - `price` number, required: Unit price for the width range
      - `priceAttributes` object[]
      - `priceMethodType` string: 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`.

## Other responses

- `400`: Bad Request
- `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)
