Skip to main content

List business categories

API operation: Open the endpoint in Scalar

Use GET /business/{business_id}/categories to list categories for a business. The operation is Category.findAll.

The ordinary read is public. Returned categories and relations depend on business visibility, enabled state, query values, hierarchy mode, and project configuration.

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

This SDK syntax is historical. Confirm the package and version before using it. See Category product expansion for params=products.

OpenAPI reference​

Operation: GET /business/{business_id}/categories

Path parameters

NameTypeRequiredDescription
business_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.
menu_idintegerNo—
timestampintegerNo—
typeintegerNo—
user_idintegerNo—
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