Get Supplier Product Details

Returns one supplier product with its options, units of measure and variants, plus supplier prices for the branch in price_fetch_preferred_vendor. Without that parameter Zuper prices at the provider's default branch; if none is set, it picks your oldest saved branch and saves it as the default. Each variant's vendor_cost has one entry per unit of measure: availability comes from the branch stocking data Zuper syncs from each supplier, and a variant the branch does not stock is not sent to the supplier: its entry has cost 0, is_available false and the message "Not stocked at this branch". QXO can also return an available option with cost 0 and status "Call for availability" when the branch stocks it but QXO gave no price. Rely on is_available rather than the supplier-specific status text. Zuper may reuse a supplier price answer for up to 15 minutes, so a price can be that old. If the supplier returns no price lines for the product at that branch, or cannot be reached, the product is still returned but its variants have no vendor_cost; if it prices some options and not others, each unpriced one gets an entry with cost 0 and a message such as "QXO did not quote a price for this option in EA". Returns 403 when the product is not stocked at any of your connected branches and 404 when it is unknown or inactive. Requires supplier integration to be enabled for the company; otherwise the request fails with 400.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

UID of the supplier provider, from Get Supplier Providers.

string
required

The product's supplier_product_uid.

Query Params
string

vendor_uid of the supplier branch (saved as a Zuper vendor for this provider) to price at. Defaults to the provider's default branch.

boolean
Defaults to false

When true, drops variants the pricing branch does not stock and vendor_cost entries with is_available: false, removes variants left with no entries, and trims uoms to the units still offered.

string

Comma-separated list of product fields to return. 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, created_at, updated_at. supplier_provider and vendor_details are always returned; variants and prices are not returned when this is set.

Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json