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

Create a category

POST/v1/sites/{siteId}/categories

Adds a category to a site, after its others. It starts on the site's default sales and purchase accounts. The response is the category, with the code to use from then on.

Needs Catalogue: writeChanges live data

Path

  • siteIdrequired

    The site, from GET /v1/sites.

    string

Headers

  • Authorizationrequired

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

    string

  • Idempotency-Key

    A value you choose, unique to what this request creates: a UUID, or your own id for it. Sending it again with the same body returns the first response and creates nothing more. Required.

    string · at most 255 characters

Body

  • namerequired

    The category's name. Unique among the site's categories.

    string · 1–200 characters

  • active

    False to create it retired. Defaults to true.

    boolean

Responses

201 Created

  • 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