List products

get

https://api-sandbox.buyingfreedom.app/api/products

Gets a list of products from an inventory.

Use this endpoint to apply filters, sorting, pagination, and include related resources such as inventory or brand information.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

sort

string

Specifies the field to sort by. To sort in descending order, add "-" in the beginning. Allowed values:

id
title
UPC
SKU
model_number
company_id
company (sort by company name)
msrp_price
map_price
upp_price
bfg_price
base_cost
mtp_price
created_at
updated_at
deleted_at
deactivated_at

Defaults to created_at.

page

integer

Page number for pagination. Must be a positive integer.

page_size

integer

Number of results on a page. Defaults to 10.

include

string

Comma-separated list of related resources to include.

filter[field]

string

Filters results by a specific field. Allowed values:

title
UPC
upcs - filters products by multiple UPCs (comma-separated exact match). Example: 123456,789012,345678
SKU
model_number
company_id
account_id
msrp_price
map_price
bfg_price
bfg_price_min - filters products with BFG price greater than or equal to the provided value
company_feature_flags - filters products by companies that have specific feature flags enabled (comma-separated list). Example: direct-sell,map-pricing
all

Use a specific field to get more product information.

filter[trashed]

string

Filters results by deactivated records. Allowed values:

only - inactive records
with - all records, both active and inactive
any other value - active records

Default is without.

include_inventory

boolean

Whether to include inventory counts in the response.

include_shipping_fee

boolean

Include shipping fee settings in response.

filter[with_inventory]

boolean

Only filters products with inventory.

filter[retailer_ids]

array of strings

Filters products by one or more retailer IDs.

filter[retailer_ids]

filter[inventory_sources]

array of strings

Filters products by one or more source company IDs.

filter[inventory_sources]

filter[product_ids]

array of strings

Filters products by one or more product IDs.

filter[product_ids]

filter[has_images]

boolean

Filters products by image presence.

filter[has_categories]

boolean

Filters products by category assignment.

filter[manufacturer_categories]

array of strings

Filters products by one or more manufacturer category IDs (leaf nodes only).

filter[manufacturer_categories]

filter[has_description]

boolean

Filters products by description presence.

filter[has_facets]

boolean

Filters products by facet assignment.

filter[has_manufacturer]

boolean

Filters products by valid manufacturer.

filter[upc_valid]

boolean

Filters products by UPC validity.

filter[include_manufacturer_availability]

boolean

Include manufacturer's available inventory count (total - reserved).

Responses

200

401Unauthenticated

403Unauthorized access

422Unprocessable entity