List products

get

https://api.epicorretailcloud.com/api/inventory/v1/product/

Perform Get HTTP Request

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

category_code

string | null

Enter a code for this category.

create_datetime

date-time

Filter upon the create date/time using ISO8601 format. Assumption is UTC unless TZ offset is specified.

date_added

date | null

The date this item record was added to the system.

is_discontinued

boolean

Is this product discontinued?

limit

integer

Maximum number of results per page. The default is 25.

ordering

string

Fields to order upon. Valid fields include: sku, description, category_code, manufacturer_sku, qoh

overall_ranking

integer

Specify the overall ranking of the product.

page

integer

Page of results to retrieve

qoh

string

^-?\d{0,9}(?:\.\d{0,8})?$

Sellable Quantity On Hand.

retail_price

string | null

^-?\d{0,9}(?:\.\d{0,8})?$

The default price for this item.

string

Term(s) to search for. The following fields will be searched: sku, description, product_tags, upc, serial_number, manufacturer_sku, supplier_sku

show_in_estore

string

length ≥ 1

Filter by e-store availability. Accepts comma-separated values
You can also use 'none' or 'any': none (no stores) any (any store)
Do NOT combine 'none' or 'any' with other values. For example, 'none,dib' or 'any,bigcommerce' will raise an error.
Both 'none' and 'any' must be used alone.

dib
bigcommerce
modernretail
none
any

store_id

integer

The store for this item.

store_number

integer

1 to 999999

The store number.

supplier

string | null

The name of the primary supplier

supplier_id

integer | null

The primary supplier

update_datetime

date-time

Filter upon the update date/time using ISO8601 format. Assumption is UTC unless TZ offset is specified.

Headers

X-Active-Store

integer

required

The id of the active store to be used for this API invocation

Response

200