COMMERCE QUERY
/
Application
/
Application
/
Get CategoryStructure

Norce Query API Documentation (2.0)

Norce Query API is an API based on OData V4. It is an API to fill the need for data from Norce in integration services that do not have direct access to Norce’s data and data models.

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers

https://customer-slug.api-se.norce.tech/commerce/query/2.0/

Schemas

Application

Operations

Get CategoryHierarchy

Request

Get CategoryHierarchy

curl -i -X GET \
  https://customer-slug.api-se.norce.tech/commerce/query/2.0/Application/CategoryHierarchy

Responses

Success

Bodyapplication/jsonArray [
CategoryIdinteger(int32)

CategoryId. Nullable. Key property.

ParentCategoryIdinteger(int32)

ParentCategoryId. Key property.

Hierarchyinteger(int32)

Hierarchy. Key property.

Categoryobject(Enferno.Storm.Query.Api.DataContexts.ApplicationModel.Category)(Enferno.Storm.Query.Api.DataContexts.ApplicationModel.Category)
ParentCategoryobject(Enferno.Storm.Query.Api.DataContexts.ApplicationModel.Category)(Enferno.Storm.Query.Api.DataContexts.ApplicationModel.Category)
]
Response
application/json
[
  {
    "CategoryId": 0,
    "ParentCategoryId": 0,
    "Hierarchy": 0,
    "Category": { … },
    "ParentCategory": { … }
  }
]

Get CategoryStructure

Request

Get CategoryStructure

curl -i -X GET \
  https://customer-slug.api-se.norce.tech/commerce/query/2.0/Application/CategoryStructures

Responses

Success

Bodyapplication/jsonArray [
Idinteger(int32)

Id. Key property.

DefaultNamestring

DefaultName. MaxLength: 50. Nullable.

DefaultDescriptionstring

DefaultDescription. MaxLength: 500. Nullable.

TypeIdinteger(int32)

TypeId.

IsPrimaryboolean

IsPrimary.

IsActiveboolean

IsActive.

Createdstring(date-time)

Created.

CreatedByinteger(int32)

CreatedBy.

Updatedstring(date-time)

Updated. Nullable.

UpdatedByinteger(int32)

UpdatedBy. Nullable.

ItemsArray of objects(Enferno.Storm.Query.Api.DataContexts.ApplicationModel.CategoryStructureItem)(Enferno.Storm.Query.Api.DataContexts.ApplicationModel.CategoryStructureItem)

Items.

]
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": [ … ]
  }
]

Get CategoryStructureItem

Request

Get CategoryStructureItem

curl -i -X GET \
  https://customer-slug.api-se.norce.tech/commerce/query/2.0/Application/CategoryStructureItems

Responses

Success

Bodyapplication/jsonArray [
Idinteger(int32)

Id. Key property.

StructureIdinteger(int32)

StructureId.

UseCategoryNameboolean

UseCategoryName.

CategoryIdinteger(int32)

CategoryId. Nullable.

StructureLevelinteger(int32)

StructureLevel.

ParentItemIdinteger(int32)

ParentItemId. Nullable.

IsParentboolean

IsParent.

IsDisplayOnlyboolean

IsDisplayOnly.

SortOrderinteger(int32)

SortOrder.

Createdstring(date-time)

Created.

CreatedByinteger(int32)

CreatedBy.

Updatedstring(date-time)

Updated. Nullable.

UpdatedByinteger(int32)

UpdatedBy. Nullable.

Keystring(guid)

Key.

Categoryobject(Enferno.Storm.Query.Api.DataContexts.ApplicationModel.Category)(Enferno.Storm.Query.Api.DataContexts.ApplicationModel.Category)
Structureobject(Enferno.Storm.Query.Api.DataContexts.ApplicationModel.CategoryStructure)(Enferno.Storm.Query.Api.DataContexts.ApplicationModel.CategoryStructure)
]
Response
application/json
[
  {
    "Id": 0,
    "StructureId": 0,
    "UseCategoryName": true,
    "CategoryId": 0,
    "StructureLevel": 0,
    "ParentItemId": 0,
    "IsParent": true,
    "IsDisplayOnly": true,
    "SortOrder": 0,
    "Created": "2019-08-24T14:15:22Z",
    "CreatedBy": 0,
    "Updated": "2019-08-24T14:15:22Z",
    "UpdatedBy": 0,
    "Key": "string",
    "Category": { … },
    "Structure": { … }
  }
]