List Price Book Items

get

https://staging.fairmarkit.com/services/self-service/api/v4/price-books/{price_book_id}/items

Returns a list of price book items.

Path Params

price_book_id

string

required

The UUID or External ID of the price book to retrieve items from.

Query Params

array of strings

Filter items by specific IDs.

offset

integer

≥ 0

Defaults to 0

Zero-based offset of the first record to return. Defaults to 0.

limit

integer

0 to 101

Defaults to 10

Maximum number of records to return. Defaults to 10.

title

string

length between 1 and 255

Filter items by title.

pb_tag

array of strings

Filter items by price book tags.

Price Book Tag

currency

string

Currency code used for price conversion.

string

Search term used to filter results.

tag

array of strings

Filter items by tags.

Tag

ordering

array of strings

Ordering field. Prefix with '-' for descending order.

Ordering

is_semantic

boolean

Defaults to true

Enable semantic search for filtering.

Headers

X-FM-API-KEY

string

Fairmarkit API Key

string

enum

Defaults to application/json; charset=utf-8

Generated from available response content types

Allowed:

Responses

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json; charset=utf-8

application/json

200Successful Response

422Validation Error