Get Supplier Products

get

https://{dc-region}.zuperpro.com/api/supplier_provider/{supplier_provider_uid}/master_products

Searches the supplier product catalog that Zuper keeps in sync for SRS, ABC Supply and QXO, limited to products stocked at the supplier branches you have saved as Zuper vendors (or at one branch with filter.vendor_uid). Results are read from Zuper rather than the supplier, so they carry no prices; use Get Supplier Product Details for supplier pricing. Each product's supplier_product_variants is trimmed to the variants stocked at those branches, so a page can hold fewer than limit products while total_records still counts them. ABC Supply lists each length of a dimensional item (supplier_product_is_dimensional) as a separate product. At least one supplier branch must be saved as a vendor; otherwise the request fails with 404. Requires supplier integration to be enabled for the company; otherwise the request fails with 400.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

supplier_provider_uid

string

required

UID of the supplier provider, from Get Supplier Providers.

Query Params

page

integer

≥ 1

Defaults to 1

Page number.

limit

integer

1 to 500

Defaults to 10

Records per page.

sort_by

string

enum

Defaults to created_at

Allowed:

sort_order

string

enum

Defaults to desc

Lowercase. Any value other than asc sorts newest first.

Allowed:

fields_to_select

string

Comma-separated list of product fields to return instead of the default set. Allowed: supplier_provider_type, supplier_product_uid, supplier_product_id, supplier_product_name, supplier_product_category, supplier_product_image_url, supplier_product_image_asset_id, brand, supplier_product_is_dimensional, supplier_product_dimensional_value, supplier_product_last_updated_date, supplier_product_family_name, supplier_product_description, uoms, available_branches, created_at, updated_at. When set, supplier_product_variants is not returned.

filter.keyword

string

Case-insensitive search. Matches products whose name, variant names or brand contain every word of the keyword in any order (common abbreviations such as galv also match galvanized), or whose supplier item number or variant SKU starts with the keyword.

filter.vendor_uid

string

vendor_uid of one supplier branch saved as a Zuper vendor for this provider. Limits results to that branch. Returns 404 if the vendor is not a branch of this provider.

filter.supplier_product_uid

string

Comma-separated supplier_product_uid values.

filter.exact_supplier_product_id

string

Comma-separated supplier item numbers (exact match).

filter.supplier_product_category

string

Comma-separated supplier category names (exact match).

filter.supplier_product_is_dimensional

boolean

Return only dimensional (true) or non-dimensional (false) products.

Responses

Language

Credentials

Header

URL

Loading…

Response

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

application/json

200200

400400

404404