Skip to content
COMMERCE SERVICES
/
Product Service
/
/
NavigationStructure

Documentation ProductService (1.1)

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
https://customer-slug.api-se.norce.tech/commerce/product/1.1/

Schemas

Schemas

NavigationNode

Keystring(guid)

Key is unique for the NavigationNode and used when listing the content displayed for the node.

Hierarchystring

Hierarchy represents the current navigation path within the NavigationNode structure. Hierarchy is used to get the sub nodes for current node. MaxLength: 4000.

TypeIdinteger(int32)

TypeId defines the content type of the NavigationNode.

Namestring

The display name of the NavigationNode. MaxLength: 50.

TargetPathstring

The target path, if any, for the NavigationNode. This can be a direct link to any page that defines the content for the node. Depending on TypeId. MaxLength: 500.

ManufacturerSeedstring

The manufacturer seed, if any, for the NavigationNode. MaxLength: 255.

CategorySeedstring

The category seed, if any, for the NavigationNode. MaxLength: 255.

FlagIdSeedstring

A comma separated list of flag internal ids, if any, for the NavigationNode. MaxLength: 255.

ImageKeystring or null(guid)

The image key for the first underlying category, if any. Url for images are formed like http://[client specific CDN]/{ImageKey}. Preset, height and width can be sent as parameters.

Descriptionstring

The description for the first underlying category, if any. MaxLength: max.

ProductCountinteger or null(int32)

A count of existing products under this node. It will have a value if fetched from an operation which calculates the value, null otherwise.

{
  "Key": "string",
  "Hierarchy": "string",
  "TypeId": 0,
  "Name": "string",
  "TargetPath": "string",
  "ManufacturerSeed": "string",
  "CategorySeed": "string",
  "FlagIdSeed": "string",
  "ImageKey": "string",
  "Description": "string",
  "ProductCount": 0
}

NavigationStructure

Idinteger(int32)

The internal Id is used to get the NavigationNodeList for this structure.

Namestring

The Name of the NavigationStructure. MaxLength: 50.

Descriptionstring

The Description of the NavigationStructure. MaxLength: 500.

IsDefaultboolean

Indicates if the NavigationStructure is a default structure or not.

{
  "Id": 0,
  "Name": "string",
  "Description": "string",
  "IsDefault": true
}

OnHand

Valuenumber(decimal)

The aggregated value from all warehouses and locations in the current context (Web, Supplier or Store).

IncomingValuenumber(decimal)

The incoming quantity on the next delivery.

NextDeliveryDatestring or null(date-time)

The next delivery data from supplier to client warehouse.

LeadtimeDayCountinteger or null(int32)

The number of days it takes to ship from the supplier.

LastCheckedstring or null(date-time)

When onHand info was last checked. Null if never.

IsActiveboolean

Indicate if the product is stocked in a store.

IsReturnableboolean

Indicate if the product is returnable in a store.

InfoArray of objects(IdValue)(IdValue)

List of IdValues for the OnHand data for this sku warehouse location combination. This will always be null unless fetched with any of the ProductOnHand methods.

{
  "Value": 0,
  "IncomingValue": 0,
  "NextDeliveryDate": "2019-08-24T14:15:22Z",
  "LeadtimeDayCount": 0,
  "LastChecked": "2019-08-24T14:15:22Z",
  "IsActive": true,
  "IsReturnable": true,
  "Info": [
    { … }
  ]
}

Assortments

Operations

Categories

Operations

Configurations

Operations

Families

Operations

Files

Operations

Filters

Operations

Flags

Operations

InfoTypes

Operations

Manufacturers

Operations

OnHand

Operations

Parametric

Operations

PriceLists

Operations

Products

Operations

Promotions

Operations

Relations

Operations

Reviews

Operations

SkuTypes

Operations

Status

Operations

Variants

Operations

Warehouses

Operations