Skip to content
Developers
Pilot. The API is open to a small number of organisations and may change — every change is in the changelog.

Reference · Categories

Get a category

GET/v1/sites/{siteId}/categories/{code}

One category, by its code. A retired category is returned too, with active false.

Needs Catalogue: read

Path

  • siteIdrequired

    The site, from GET /v1/sites.

    string

  • coderequired

    The record's code.

    string

Headers

  • Authorizationrequired

    An API key from Automation > Access in the Dnero portal, sent as Authorization: Bearer <key>.

    string

Responses

200 OK

  • activerequired

    False for a retired category, which is listed only with includeInactive.

    boolean

  • coderequired

    The category's code, the same at every site that has it.

    string

  • namerequired

    The category's name.

    string

  • orderrequired

    Where the category sits among the site's others, lowest first.

    integer

  • defaultCourseCode

    The course a product in this category goes to the kitchen with, unless the product says otherwise.

    string

  • updatedAt

    When the category last changed. Absent for one that has not changed since this was recorded.

    string · date-time