Get Price Book Items

get

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

Use to retrieve a list of items within a specific price book. This API supports filtering, searching, and ordering 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

Use to filter items by specific IDs.

offset

integer

≥ 0

Defaults to 0

Use to retrieve a specific batch of records. By default, this is set to 0.

limit

integer

0 to 101

Defaults to 10

Use to specify the maximum number of records to return. By default, 10 records are returned.

title

string

length between 1 and 255

Use to filter items by title.

pb_tag

array of strings

Use to filter items by price book tags.

Price Book Tag

currency

string

Use to specify currency code for price conversion.

string

Use to search items by keyword.

tag

array of strings

Use to filter items by tags.

Tag

ordering

array of strings

Use to specify ordering of items.

Ordering

is_semantic

boolean

Defaults to true

Use to 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

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