Skip to main content

List business products

API operation: Open the endpoint in Scalar

Use GET /business/{business_id}/categories/{category_id}/products to list products in a category. The current public operation is Product.findAll.

The ordinary read is public. Returned products can vary with business and category visibility, enabled state, schedules, order type, menu context, pagination, and requested relations.

const response = await ordering.businesses(businessId).categories(categoryId).products().get()

This SDK syntax is historical. Confirm the package and version before using it. See Business product model for representative fields.

OpenAPI reference​

Operation: GET /business/{business_id}/categories/{category_id}/products

Path parameters

NameTypeRequiredDescription
business_idintegerYes—
category_idintegerYes—

Query parameters

NameTypeRequiredDescription
paramsstringNoComma-separated list of fields. It is intersected with the model’s $fillable; an empty or invalid list returns all fields.
orderBystringNoField to sort by, with - prefixed for descending order. Multiple fields can be chained with commas.
wherestringNoJSON filter over the fields the model declares as filterable. Valid fields for each resource are exposed in its x-ordering-whereable schema extension.
pageintegerNoPage number, starting at 1. Applies only to lists that return a pagination block.
page_sizeintegerNoNumber of items per page.
professional_idintegerNo—
menu_idintegerNo—
timestampintegerNo—
typeintegerNo—
versionstringNo—

Responses

CodeDescription
200OK (Envelope)
400Bad Request (ErrorResponse)
401Unauthorized (ProjectAccessErrorResponse)
404Not Found
429Too Many Requests (ErrorResponse)
500Internal Server Error (ErrorResponse)
503Service Unavailable (ErrorResponse)
Open this operation in the API reference