COMMERCE QUERY
/
Query API 3.0
/
Application
/
List category hierarchy

Commerce Query API (v3.0)

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
Playground

https://{slug}.api-se.playground.norce.tech/commerce/query/3.0/

Stage

https://{slug}.api-se.stage.norce.tech/commerce/query/3.0/

Production

https://{slug}.api-se.norce.tech/commerce/query/3.0/

Schemas

Application

Operations

List supplier category mappings

Request

Gets all supplier-to-category mappings.

Headers
ApplicationIdintegerrequired

Application ID

curl -i -X GET \
  https://customer-slug.api-se.playground.norce.tech/commerce/query/3.0/Application/SupplierCategoryMappings \
  -H 'ApplicationId: 0'

Responses

A queryable collection of supplier category mappings.

Bodyapplication/jsonArray [
categorySupplierIdinteger(int32)
codestring
categoryIdinteger or null(int32)
categoryNamestring or null
productCountinteger or null(int32)
isMappedboolean
clientIdinteger(int32)
supplierIdinteger(int32)
isActiveboolean
]
Response
application/json
[
  {
    "categorySupplierId": 0,
    "code": "string",
    "categoryId": 0,
    "categoryName": "string",
    "productCount": 0,
    "isMapped": true,
    "clientId": 0,
    "supplierId": 0,
    "isActive": true
  }
]

List category hierarchy

Request

Gets the category hierarchy as parent-child relationships.

Headers
ApplicationIdintegerrequired

Application ID

curl -i -X GET \
  https://customer-slug.api-se.playground.norce.tech/commerce/query/3.0/Application/CategoryHierarchy \
  -H 'ApplicationId: 0'

Responses

A queryable collection of category hierarchy entries.

Bodyapplication/jsonArray [
categoryIdinteger(int32)

The category identifier.

parentCategoryIdinteger(int32)

The parent category identifier.

hierarchyinteger(int32)

The hierarchy.

category(Category (object or null))
One of:
parentCategory(Category (object or null))
One of:
]
Response
application/json
[
  {
    "categoryId": 0,
    "parentCategoryId": 0,
    "hierarchy": 0,
    "category": { … },
    "parentCategory": { … }
  }
]

List category structures

Request

Gets all category structures.

Headers
ApplicationIdintegerrequired

Application ID

curl -i -X GET \
  https://customer-slug.api-se.playground.norce.tech/commerce/query/3.0/Application/CategoryStructures \
  -H 'ApplicationId: 0'

Responses

A queryable collection of category structures.

Bodyapplication/jsonArray [
idinteger(int32)

The unique identifier of the category structure.

defaultNamestring[ 0 .. 50 ] charactersrequired

The default name of the category structure.

defaultDescriptionstring or null[ 0 .. 500 ] characters

The default description of the category structure.

typeIdinteger(int32)

The type identifier.

isPrimaryboolean

Indicates whether the category structure is primary.

isActiveboolean

Indicates whether the category structure is active.

createdstring(date-time)

The date and time the record was created.

createdByinteger(int32)

The identifier of the user who created the record.

updatedstring or null(date-time)

The date and time the record was last updated.

updatedByinteger or null(int32)

The identifier of the user who last updated the record.

itemsArray of objects or null(CategoryStructureItem)
]
Response
application/json
[
  {
    "id": 0,
    "defaultName": "string",
    "defaultDescription": "string",
    "typeId": 0,
    "isPrimary": true,
    "isActive": true,
    "created": "2019-08-24T14:15:22Z",
    "createdBy": 0,
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": 0,
    "items": [ … ]
  }
]

Core

Operations

Customers

Operations

Order

Operations

Products

Operations

Shopping

Operations

Metadata

Operations