COMMERCE SERVICES

Metadata Service

StoreItem

Norce Commerce Metadata v1.1 service (1.1)

The Metadata namespace has Entities and Operations concerned with the Application and similar context. It contains the Application entity, Stores and other data for lookups.

Download OpenAPI description

openapi-v1.json

openapi-v1.yaml

Servers

Playground

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

Stage

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

Production

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

Flags

Contains endpoints for viewing flags on the application. Any flags except product flags.

Operations

InfoTypes

Contains endpoints for viewing metadata for extended fields, specifically for Stores.

Operations

Location

Contains endpoints for looking up location information from the application.

Operations

Application

Contains endpoints for viewing metadata for application configurations.

Operations

Stores

Contains endpoints for viewing Store information and its metadata.

Operations

Schemas

StoreInfoPagedList

The StoreInfoPagedList is a PagedList. The Items property contains all current items, depending on paging, and the ItemCount the total number of items.

ItemCountinteger or null(int32)

The total item count. Can be used to manage paging. This will always be the total number of available items, regardless of paging. Use PageSize to calculate number of pages.

ItemsArray of objects or null(StoreInfo)

Items contains the current list of StoreInfo for the current page if paging is used. Otherwise all items will be in the list.

{
  "ItemCount": 0,
  "Items": [
    { … }
  ]
}

StoreItem

Represents a Store, Workshop or such. It is called Division in Norce Admin. The StoreItem entity is a bit less heavy weight than it's counter part Store and is fetched in a list.

Idinteger or null(int32)

The internal Id of the Store.

Namestring or null

The Name of the Store.

Addressstring or null

The Address of the Store.

PostalAddressstring or null

The PostalAddress of the Store. Zip and City.

Distancenumber or null(decimal)

Used when fetching Stores and we have a specified current location from which to calculate a distance to the Store.

Typestring or null

The Type of the Store. Taken from Norce's Division.GroupName.

SubTypestring or null

The SubType of the Store. Taken from Norce's Division.SubGroupName.

Codestring or null

The external code. Usually the id in the erp system.

OnHandobject or null

Information about OnHand for a given SKU. There are generally three different types of OnHand in Norce. One for the Web, one for the chosen supplier and one for any specified Store.

OnHandDemoobject or null

Information about OnHand for a given SKU. There are generally three different types of OnHand in Norce. One for the Web, one for the chosen supplier and one for any specified Store.

UniqueNamestring or null

A unique name that can be used in Urls and to get this entity. GetStoreItem and GetStoreItemByUniqueName gets the same StoreItem.

OnHandValuenumber or null(decimal)Deprecated

IncomingValuenumber or null(decimal)Deprecated

NextDeliveryDatestring or null(date-time)Deprecated

{
  "Id": 0,
  "Name": "string",
  "Address": "string",
  "PostalAddress": "string",
  "OnHandValue": 0,
  "IncomingValue": 0,
  "NextDeliveryDate": "2019-08-24T14:15:22Z",
  "Distance": 0,
  "Type": "string",
  "SubType": "string",
  "Code": "string",
  "OnHand": {
    "Value": 0,
    "IncomingValue": 0,
    "NextDeliveryDate": "2019-08-24T14:15:22Z",
    "LeadtimeDayCount": 0,
    "LastChecked": "2019-08-24T14:15:22Z",
    "IsActive": true,
    "IsReturnable": true,
    "Info": [ … ]
  },
  "OnHandDemo": {
    "Value": 0,
    "IncomingValue": 0,
    "NextDeliveryDate": "2019-08-24T14:15:22Z",
    "LeadtimeDayCount": 0,
    "LastChecked": "2019-08-24T14:15:22Z",
    "IsActive": true,
    "IsReturnable": true,
    "Info": [ … ]
  },
  "UniqueName": "string"
}

StoreItemPagedList

The StoreItemPagedList is a PagedList. The Items property contains all current items, depending on paging, and the ItemCount the total number of items.

ItemCountinteger or null(int32)

The total item count. Can be used to manage paging. This will always be the total number of available items, regardless of paging. Use PageSize to calculate number of pages.

ItemsArray of objects or null(StoreItem)

Items contains the current list of StoreItems for the current page if paging is used. Otherwise all items will be in the list.

{
  "ItemCount": 0,
  "Items": [
    { … }
  ]
}