COMMERCE SERVICES
/
Metadata Service
/
Stores

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
Languages
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

List store info types

Request

Lists the info types that can be set on the Store.Info property.

Query
cultureCodestring

(Optional) Specifies in which language to display culture specific information. If none is supplied, value is resolved from Application.

curl -i -X GET \
  https://customer-slug.api-se.playground.norce.tech/commerce/metadata/1.1/ListStoreInfoTypes \
  -H 'ApplicationId: YOUR_API_KEY_HERE' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/jsonArray [
Idinteger or null(int32)

The internal Id of the Entity. This Id might be different in different tiers such as Stage and Production. Use Code if hard coding is required.

Valuestring or null

The Value of the Entity.

Codestring or null

The Code of the Entity, if existing. Use this value when hard coding is required.

]
Response
application/json
[
  {
    "Id": 0,
    "Value": "string",
    "Code": "string"
  }
]

Get store item

Request

Gets a StoreItem by Id. Should be used to display details about a StoreItem or when just data for a single StoreItem is needed. Returns null if the StoreItem does not exist.

Query
idinteger(int32)

The internal Id of the Store to fetch.

partNostring

(Optional) If supplied, the returned StoreItem will have information about onHand.

cultureCodestring

(Optional) Specifies in which language to display culture specific information. If none is supplied, value is resolved from Application.

curl -i -X GET \
  https://customer-slug.api-se.playground.norce.tech/commerce/metadata/1.1/GetStoreItem \
  -H 'ApplicationId: YOUR_API_KEY_HERE' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
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
Response
application/json
{
  "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"
}

Get store item by unique name

Request

Gets a StoreItem by its unique url name. Should be used to display details about a StoreItem or when just data for a single StoreItem is needed. Returns null if the StoreItem does not exist.

Query
uniqueNamestring

The unique name of the Store to fetch.

partNostring

(Optional) If supplied, the returned StoreItem will have information about onHand.

cultureCodestring

(Optional) Specifies in which language to display culture specific information. If none is supplied, value is resolved from Application.

curl -i -X GET \
  https://customer-slug.api-se.playground.norce.tech/commerce/metadata/1.1/GetStoreItemByUniqueName \
  -H 'ApplicationId: YOUR_API_KEY_HERE' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
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
Response
application/json
{
  "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"
}

Get store item by country and zipcode

Request

Gets a StoreItem by country and zip code. Should be used to display details about a StoreItem or when just data for a single StoreItem is needed. Returns null if the StoreItem does not exist.

Query
zipCodeinteger(int32)

The zip code of the end user. The StoreItem is resolved by looking at deliveryMethod locations as set up in Norce Admin.

countryIdstring

(Optional) Specifies in which countryId. If none is supplied, value is resolved from Application default. Valid countryIds can be found in Application.Countries.

partNostring

(Optional) If supplied, the returned StoreItem will have information about onHand.

cultureCodestring

(Optional) Specifies in which language to display culture specific information. If none is supplied, value is resolved from Application.

curl -i -X GET \
  https://customer-slug.api-se.playground.norce.tech/commerce/metadata/1.1/GetStoreItemByCountryAndZipCode \
  -H 'ApplicationId: YOUR_API_KEY_HERE' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
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
Response
application/json
{
  "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"
}

List store items

Request

Lists StoreItems as a PagedList.

Query
partNostring

(Optional) If supplied, the returned StoreItem will have information about onHand.

longitudestring

(Optional) Longitude for current position. StoreItems will calculate the Distance if supplied together with latitude. Format: decimal.

latitudestring

(Optional) Latitude for current position. StoreItems will calculate the Distance if supplied together with longitude. Format: decimal.

pageNostring

(Optional) Page numbers start with 1. Default is 1. If you specify a pageNo outside the range of items, an empty list will be returned. PageSize is mandatory for pageNo to work.

pageSizestring

(Optional) Number of items to display per page. Mandatory if using pageNo.

cultureCodestring

(Optional) Specifies in which language to display culture specific information. If none is supplied, value is resolved from Application.

curl -i -X GET \
  https://customer-slug.api-se.playground.norce.tech/commerce/metadata/1.1/ListStoreItems \
  -H 'ApplicationId: YOUR_API_KEY_HERE' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
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.

Response
application/json
{
  "ItemCount": 0,
  "Items": [
    { … }
  ]
}

List store info

Request

Lists StoreInfo as a PagedList. This will list info for all Stores.

Query
pageNostring

(Optional) Page numbers start with 1. Default is 1. If you specify a pageNo outside the range of items, an empty list will be returned. PageSize is mandatory for pageNo to work.

pageSizestring

(Optional) Number of items to display per page. Mandatory if using pageNo.

cultureCodestring

(Optional) Specifies in which language to display culture specific information. If none is supplied, value is resolved from Application.

curl -i -X GET \
  https://customer-slug.api-se.playground.norce.tech/commerce/metadata/1.1/ListStoreInfo \
  -H 'ApplicationId: YOUR_API_KEY_HERE' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
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.

Response
application/json
{
  "ItemCount": 0,
  "Items": [
    { … }
  ]
}

Get store

Request

Gets a Store by Id. Should be used to display details about a Store or when just data for a single Store is needed. Returns null if the Store does not exist.

Query
idinteger(int32)

The internal Id of the Store to fetch.

longitudestring

(Optional) Longitude for current position. Store will calculate the Distance if supplied together with latitude. Format: decimal.

latitudestring

(Optional) Latitude for current position. Store will calculate the Distance if supplied together with longitude. Format: decimal.

cultureCodestring

(Optional) Specifies in which language to display culture specific information. If none is supplied, value is resolved from Application.

curl -i -X GET \
  https://customer-slug.api-se.playground.norce.tech/commerce/metadata/1.1/GetStore \
  -H 'ApplicationId: YOUR_API_KEY_HERE' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
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.

Response
application/json
{
  "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"
}

Get store by unique name

Request

Gets a Store by its unique url name. Should be used to display details about a Store or when just data for a single Store is needed. Returns null if the Store does not exist.

Query
uniqueNamestring

The unique name of the Store to fetch.

longitudestring

(Optional) Longitude for current position. Store will calculate the Distance if supplied together with latitude. Format: decimal.

latitudestring

(Optional) Latitude for current position. Store will calculate the Distance if supplied together with longitude. Format: decimal.

cultureCodestring

(Optional) Specifies in which language to display culture specific information. If none is supplied, value is resolved from Application.

curl -i -X GET \
  https://customer-slug.api-se.playground.norce.tech/commerce/metadata/1.1/GetStoreByUniqueName \
  -H 'ApplicationId: YOUR_API_KEY_HERE' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
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.

Response
application/json
{
  "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"
}

List stores (v2)

Request

Lists all stores. Any distance calculations should be made by the client application for caching reasons or the Distance field will be null.

Query
cultureCodestring

(Optional) Specifies in which language to display culture specific information. If none is supplied, value is resolved from Application.

curl -i -X GET \
  https://customer-slug.api-se.playground.norce.tech/commerce/metadata/1.1/ListStores2 \
  -H 'ApplicationId: YOUR_API_KEY_HERE' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/jsonArray [
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.

]
Response
application/json
[
  {
    "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": { … },
    "Code": "string",
    "Description": "string",
    "ImageKey": "9afa8b7e-ca15-438f-a9d6-f679c437e59c",
    "UniqueName": "string"
  }
]

Update division information

Request

Updates the given info for a division.

Query
idinteger(int32)

The internal id of the division.

typeIdinteger(int32)

The id of the info type. For reference, use ListInfoTypes.

valuestring

The value to set.

updatedBystring

(Optional) The accountId of the user making the update. If none is supplied, value is resolved from Application.

curl -i -X POST \
  https://customer-slug.api-se.playground.norce.tech/commerce/metadata/1.1/UpdateDivisionInfo \
  -H 'ApplicationId: YOUR_API_KEY_HERE' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Schemas