Skip to main content
POST
Create a store department

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
name
string
required

Human-readable department name.

store_id
string
required

The store the department belongs to.

Pattern: ^[0-9]+$
exclude_from_sales_reporting
boolean

Whether sales from this department are omitted from sales reporting. Defaults to false.

parent_department_id
string | null

ID of the parent department, or null for a top-level department. A parent must itself be top-level: departments nest one level deep.

Pattern: ^[0-9]+$

Response

A grouping of products within a store, optionally nested under a parent department.

id
string
required

Unique identifier for the store department.

deactivated_at
string<date-time> | null
required

When the department was deactivated, or null when it is active.

exclude_from_sales_reporting
boolean
required

Whether sales from this department are omitted from sales reporting.

name
string
required

Human-readable department name.

parent_department_id
string | null
required

ID of the parent department, or null for a top-level department.