COMMERCE SERVICES

Metadata Service

Application

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

Application

The Application entity contains data specific to the current application. An Application belongs to a Client and one Client can have multiple Applications. A common usage is that an Application maps to a market or a domain such as .se, .com and such.

Idinteger or null(int32)

The system wide unique internal Norce Id for this Application.

ParentIdinteger or null(int32)

Id of the parent application, if any. Will be the same as Id if none exists. Applications with the same parentId share products and customers. Some content and navigation can differ.

Keystring or null(uuid)

The system wide unique Key for this Application.

Namestring or null

The Name of this Application.

Urlstring or null

The Url to the Application.

SenderEmailAddressstring or null

The sender e-mail address for all external communication and notifications if Norce email services are used.

Clientobject or null

The Client entity contains data specific to the current client. A Client can have multiple Applications and represents a customer to Norce.

Culturesobject or null

A list of Cultures and a Default. Used in Application. Available Cultures can be used to let the end user select different languages within an Application.

Currenciesobject or null

A list of Currencies and a Default. Used in Application. Available Currencies can be used to let the end user select different currencies within an Application.

Pricelistsobject or null

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

SalesAreasobject or null

A list of SalesAreas and a Default. Used in Application.

Rolesobject or null

A list of Roles and a Default. Used in Application. Available Roles can be used in Account. Roles when creating customers with accounts.

Countriesobject or null

A list of Countries and a Default. Used in Application. Available Countries can be used to populate drop-down lists with countries when the end user enters addresses.

AuthorizationsArray of objects or null(IdValue)

A list of authorizations available for this application. Can be used when creating customer accounts.

{
  "Id": 0,
  "ParentId": 0,
  "Key": "5eb041b0-19c9-4022-bd51-0e723885f5dd",
  "Name": "string",
  "Url": "string",
  "SenderEmailAddress": "string",
  "Client": {
    "Id": 0,
    "Key": "5eb041b0-19c9-4022-bd51-0e723885f5dd",
    "Name": "string"
  },
  "Cultures": {
    "List": [ … ],
    "Default": { … }
  },
  "Currencies": {
    "List": [ … ],
    "Default": { … }
  },
  "Pricelists": {
    "Ids": [ … ],
    "Default": 0
  },
  "SalesAreas": {
    "List": [ … ],
    "Default": { … }
  },
  "Roles": {
    "List": [ … ],
    "Default": { … }
  },
  "Countries": {
    "List": [ … ],
    "Default": { … }
  },
  "Authorizations": [
    { … }
  ]
}

Client

The Client entity contains data specific to the current client. A Client can have multiple Applications and represents a customer to Norce.

Idinteger or null(int32)

The system wide unique internal Norce Id for the Client.

Keystring or null(uuid)

The system wide unique Key for the Client.

Namestring or null

The Name of the Client.

{
  "Id": 0,
  "Key": "5eb041b0-19c9-4022-bd51-0e723885f5dd",
  "Name": "string"
}

Countries

A list of Countries and a Default. Used in Application. Available Countries can be used to populate drop-down lists with countries when the end user enters addresses.

ListArray of objects or null(Country)

A list of countries.

Defaultobject or null

The Country entity contains info about a country.

{
  "List": [
    { … }
  ],
  "Default": {
    "Id": 0,
    "Name": "string",
    "Code": "string"
  }
}