Product categories

Groupings of products into categories

Explore the Commerce Product Categories endpoints in Swagger.

View the coverage for products in the Data Coverage Explorer.

Overview

Product categories are used to classify a group of products together, either by type (eg "Furniture"), or sometimes by tax profile.

Data Model

Field

Type

Description

id

string

The unique identifier of the product category

name

string

The name of the product category

ancestorRefs

array of ancestor Refs

A collection of parent product categories implicitly ordered with the immediate parent last in the list.

hasChildren

boolean

A boolean indicating whether there are other product categories beneath this one in the hierarchy.

modifiedDate

string
See date

The date the record was last updated in Codat's cache.

sourceModifiedDate

string
See date

Date the product was last changed in the commerce or point of sale platform.

Ancestor Refs

Information about the hierarchy the product category sits within.

FieldTypeDescription
idstringThe id of the parent product category
namestringThe name of the parent product category

Example Data

{
    "productCategories": [
        {
            "id": "100",
            "name": "Entertainment",
            "ancestorRefs": [],
            "hasChildren": true,
            "modifiedDate": "2022-01-01T12:00:00Z",
            "sourceModifiedDate": "2021-10-01T12:53:21Z"
        },
        {
            "id": "101",
            "name": "Cinema",
            "ancestorRefs": [
                {
                    "id": "100",
                    "name": "Entertainment"
                }
            ],
            "hasChildren": true,
            "modifiedDate": "2022-01-01T12:00:00Z",
            "sourceModifiedDate": "2021-10-01T12:55:02Z"
        },
        {
            "id": "102",
            "name": "Movie",
            "ancestorRefs": [
                {
                    "id": "100",
                    "name": "Entertainment"
                },
                {
                    "id": "101",
                    "name": "Cinema"
                }
            ],
            "hasChildren": false,
            "modifiedDate": "2022-01-01T12:00:00Z",
            "sourceModifiedDate": "2021-12-25T12:00:00Z"
        }
    ]
}