Scope: inventory:rates.read https://api.alladdin.com/api/v2/price-lists/{priceListId}

Retrieves the details of a single price list (rate) by its unique identifier.
The response includes the price list name and optional description.

Parameters

Path parameters

priceListId string required

Price List ID (24-char hex ObjectId)

Request

import requests

url = "https://api.alladdin.com/api/v2/price-lists/{priceListId}"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Accept": "application/json",
}

response = requests.get(url, headers=headers)
print(response.json())

Responses

Response

{
  "id": "507f1f77bcf86cd799439011",
  "name": "Wholesale",
  "description": "Discounted prices for wholesale customers"
}

Success responses

200 Price list found application/json object id string

Unique identifier of the price list

name string

Display name of the price list

description string | null

Optional description of the price list

Error responses

401 Invalid or missing API key application/json 403 Insufficient permissions application/json 404 Price list not found application/json

← PreviousList price lists →

Next →Delete a price list →