Get all prices

Authentication v1

Identity APIs
User
Address
Auth

User Self Service APIs

Introduction
User Self Service APIs
Authentication APIs

Experiences v2 (XM v2)

XM
Pages
Global Components
Menu

Experiences v1 (XM v1)

XM
Pages
Global Components
Menu

Product Catalog

Product Catalog
Category
Product
Attributes
Bulk Import

Orders v2 (OMS v2)

Order Management System
Order
Order Attribute
Developer Guide
Order Return
Payment Status
Package Tracking
Cross Border
Order Cancellation
Appeasement
Allocation
Configuration
Fraud Configuration
Target Configuration
Location
Location Attribute
Inventory Network
Inventory
Inventory Counter
Inventory Bulk Operation
Inventory Attribute
Inventory Upload Log
Shipment
Shipping Method
Webhook
Notification
Export
Invoice
Fraud
Backorder Preorder Reservation
List

Orders v1 (OMS v1)

Order Management System
Cart
Bill To
Ship To
Wishlist
Cart Decoupled
Warehouse
Inventory
Attributes
List
Tax/Address Validate
Shipping
Payments
Order

Offers v2

Offers
Developer Guide
Promotion
Price Kind
Dynamic Pricing Engine
Segment
Coupon
Coupon Codes
Product
Price List
Attributes
Item
Price Guard
Global Exclusion
Upload Price CSV
Pricing
Redemption
Exports

Offers v1

Offers
Login API
Promotions
Pricing

Subscriptions (SMT API)

Subscriptions API
Cancellation Reasons
Subscription Discounts
Subscriptions
Subscribers
Orders

Loyalty (Member)

Member APIs
Inquire
Discounts
Redeem
Earn
Members

Dropship

Dropship API
Shipments
Products
Invoices
Connections
Inventory
Developer Guide
Returns
Orders

Cart API

Cart
Order Draft
Attribute
Adjustments
Shipping
Cart

Checkout API

Checkout
Checkout

Customer

Core Concepts
Customer Service
Organization
User Party
Organization Group Addresses
User Internal Party
Organization Contracts
Party
Party Contracts
Contracts
User
Search
User Trait
Organization Users
Address
User Address
Trait
Party Address
Party Trait
Organization Group Users
Internal Party
Contract Pricelist
Internal Parties Party
Account
Party Account
Organization Addresses
Organization Groups
Individual Addresses
Users Organization
Individual

GET

api-offers

price

Authorizations

Authorization

string

headerrequired

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.

Query Parameters

limit

number

default: 10

The maximum number of records per page.

Required range: 1 < x < 100

page

number

default: 1

Page number you want to get the record for.

Required range: x > 1

priceListId

number

ID of the price list for which you want to get the price details

sortBy

enum<string>

default: updatedAt

Field by which you want to sort the records

Available options:

itemId,

priceListId,

updatedAt

sortOrder

enum<string>

default: desc

Sorting order the records- ascending or descending

Available options:

asc,

desc

Response

200 - application/json

query

object

Object containing the size, count and number of pages in the response.

prices

object[]

An array containing all the prices in service

prices._id

string

fabric internal unique ID

prices.isSoftDeleted

boolean

true: Price is deleted false: Price is not deleted

prices.itemId

number

Item ID

prices.itemSku

string

Item SKU

prices.offerId

number

ID of the created offer for the itemId or itemSku

prices.createdAt

string

Creation date of the record

prices.updatedAt

string

Last update date of the record

prices.job

boolean

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

prices.priceListId

number

Price list ID that contains the updated or created price

prices.offers

object[]

prices.offers.kind

number

Pricekind ID. This ID helps to identify if the price is base price or clearance price or any other additional price.

prices.offers.channel

number

Sales channel ID

prices.offers.startDate

string

Start date of the price if any

prices.offers.endDate

string

End date of the price if any

prices.offers.price

object

prices.offers.offerCode

number

Unique code associated with the created offer price

prices.offers.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.

prices.offers.priceAttributes

object[]

prices.offers.priceMethodType

string

Type of method for calculating the price. Range-Base: Uses the quantity of sold items to determine which price to use. Base price (minimum fixed price) is ignored in this method. 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. 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.

Was this page helpful?

Create or update price Get price by priceId