COMMERCE SERVICES

Metadata Service

StoreInfo

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

Store

Represents a Store, Workshop or such. It is called Division in Norce Admin. The Store entity is a bit more heavy weight than it's counter part StoreItem and should be used to display a detail page for the Store.

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.

Phonestring or null

The PhoneNumber to the Store.

Faxstring or null

The FaxNumber to the Store.

OpeningWeekdaysstring or null

Defines the opening hours for the Store during week days.

OpeningSaturdaysstring or null

Defines the opening hours for the Store during on Saturdays.

OpeningSundaysstring or null

Defines the opening hours for the Store during on Sundays.

Longitudenumber or null(double)

The longitude part of the location of the Store. Can be used to calculate distances to the Store.

Latitudenumber or null(double)

The latitude part of the location of the Store. Can be used to calculate distances to the Store.

Distancenumber or null(decimal)

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

Keystring or null(uuid)

The system wide unique Key for 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.

InfoArray of objects or null(IdValue)

Contains a list of id-value pairs specific to the client for this Store. Use ApplicationService.ListStoreInfoTypes(string) for id lookup.

Pricelistsobject or null

A list of public PriceListIds and a Default. Used in Application.

Codestring or null

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

Descriptionstring or null

The Description of the Store.

ImageKeystring or null(uuid)

A unique id for the image at our image server. Url for images are formed like http://[client specific CDN]/{ImageKey}. Preset, height and width can be sent as parameters.

UniqueNamestring or null

A unique name that can be used in Urls and to get this entity. GetStore and GetStoreByUniqueName gets the same Store.

{
  "Id": 0,
  "Name": "string",
  "Address": "string",
  "PostalAddress": "string",
  "Phone": "string",
  "Fax": "string",
  "OpeningWeekdays": "string",
  "OpeningSaturdays": "string",
  "OpeningSundays": "string",
  "Longitude": 0.1,
  "Latitude": 0.1,
  "Distance": 0,
  "Key": "5eb041b0-19c9-4022-bd51-0e723885f5dd",
  "Type": "string",
  "SubType": "string",
  "Info": [
    { … }
  ],
  "Pricelists": {
    "Ids": [ … ],
    "Default": 0
  },
  "Code": "string",
  "Description": "string",
  "ImageKey": "9afa8b7e-ca15-438f-a9d6-f679c437e59c",
  "UniqueName": "string"
}

StoreInfo

StoreInfo contains all info fields for a given Store.

Idinteger or null(int32)

The internal id of the Store.

InfoArray of objects or null(IdValue)

Contains a list of id-value pairs specific to the client for this store. Use ApplicationService.ListStoreInfoTypes(string) for id lookup.

{
  "Id": 0,
  "Info": [
    { … }
  ]
}

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