Product Feed API (v1.0)

Download OpenAPI description

openapi.json

openapi.yaml

Servers

Playground

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

Stage

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

Production

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

Schemas

Family

Represents a Family value. A family is a grouping of products that does not have to share common attributes. Families can be used to group products for various purposes, such as categorization, or filtering. Used for series or common branding of products for display purposes. Not commonly used anymore.

Codestring or null<= 50 characters

The unique identifier of the Family.

CulturesArray of objects(FamilyCulture)

The localized names of the Family.

{
  "Code": "string",
  "Cultures": [
    { … }
  ]
}

FamilyCulture

Localized Family information.

CultureCodestring or null

Represents language corresponding with ISO 639-1 (e.g. "en") alone or together with localization corresponding with ISO 3166-1 (e.g. "GB"). Valid values can be both "en" or "en-GB". Most commonly used format is "xx-XX".

Namestring or null<= 50 characters

The name of the Family.

{
  "CultureCode": "string",
  "Name": "string"
}

File

Represents a File, a reference to an asset in Norce Commerce or external reference (e.g. Youtube url)

Typestring(FileType)

Specifies the type of a specific File.

Enum"external""asset"

Codestring or null<= 255 characters

The unique identifier of this specific instance of a file. Called "ExternalCode" in Connect. This can be null, but common practice is to have a unique code for each file. Used for removing or updating from api´s. The Code can be set by the user or from Norce, in admin, when uploading a new asset, usually based on the oridiginal file name or url.

FileCodestring or null<= 50 characters

The unique identifier for the file type. e.g. "PrimaryImage", "Additional image", "Winter images", "Data sheets". For primary images the code is always set to "PrimaryImage".

Keystring or null(uuid)

The reference to the File if Type is Asset.

MimeTypestring or null

The MimeType of the File, omitted if Type is External. For example: "image/jpeg" or "application/pdf"

Urlstring or null

The url reference to the File. Having the "Key" as part of the Url path.

SortOrderinteger or null(int32)

The sort order within the type of files, if any.

CulturesArray of objects or null(FileCulture)

The localized meta data for each culture.

{
  "Type": "external",
  "Code": "string",
  "FileCode": "string",
  "Key": "5eb041b0-19c9-4022-bd51-0e723885f5dd",
  "MimeType": "string",
  "Url": "string",
  "SortOrder": 0,
  "Cultures": [
    { … }
  ]
}

Exports

Operations

Jobs

Operations