COMMERCE QUERY

Query API 3.0

Variant

Query (v1)

Download OpenAPI description

openapi.json

openapi.yaml

Servers

https://norcecommerce.api-se.norce.tech/commerce/query/3.0/

Schemas

VariantGroup

idinteger(int32)

The unique identifier of the variant group.

clientIdinteger(int32)

The client identifier.

defaultNamestring[ 0 .. 50 ] charactersrequired

The default name of the variant group.

defaultDescriptionstring or null[ 0 .. 500 ] characters

The default description of the variant group.

isActiveboolean

Indicates whether the variant group is active.

createdstring(date-time)

The date and time the record was created.

createdByinteger(int32)

The identifier of the user who created the record.

updatedstring or null(date-time)

The date and time the record was last updated.

updatedByinteger or null(int32)

The identifier of the user who last updated the record.

codestring or null[ 0 .. 50 ] characters

The code of the variant group.

variantArray of objects or null(Variant)

culturesArray of objects or null(VariantGroupCulture)

groupTypesArray of objects or null(VariantGroupType)

{
  "id": 0,
  "clientId": 0,
  "defaultName": "string",
  "defaultDescription": "string",
  "isActive": true,
  "created": "2019-08-24T14:15:22Z",
  "createdBy": 0,
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": 0,
  "code": "string",
  "variant": [
    { … }
  ],
  "cultures": [
    { … }
  ],
  "groupTypes": [
    { … }
  ]
}

Variant

idinteger(int32)

The unique identifier of the variant.

clientIdinteger(int32)

The client identifier.

defaultNamestring or null[ 0 .. 255 ] characters

The default name of the variant.

defaultImagePathstring or null[ 0 .. 255 ] characters

The default image path, not used anymore.

defaultThumbnailImagePathstring or null[ 0 .. 255 ] characters

The default thumbnail image path, not used anymore.

defaultCampaignImagePathstring or null[ 0 .. 255 ] characters

The default campaign image path, not used anymore.

defaultLargeImagePathstring or null[ 0 .. 255 ] characters

The default large image path, not used anymore.

groupIdinteger or null(int32)

The VariantGroup identifier.

aliasstring or null[ 0 .. 255 ] characters

The alias. Not used anymore.

defaultTitlestring or null[ 0 .. 255 ] characters

The default title. For SEO purposes.

defaultTagsstring or null

The default tags, not commonly used anymore.

defaultMetaTagsstring or null

The default meta tags, for SEO purposes.

defaultMetaDescriptionstring or null

The default meta description, for SEO purposes.

createdstring(date-time)

The date and time the record was created.

createdByinteger(int32)

The identifier of the user who created the record.

updatedstring or null(date-time)

The date and time the record was last updated.

updatedByinteger or null(int32)

The identifier of the user who last updated the record.

imageKeystring or null(guid)

The image key.

codestring or null[ 0 .. 50 ] characters

The code of the variant. Grouping variants together.

defaultUniqueUrlNamestring[ 0 .. 500 ] charactersrequired

The default unique url name.

keystring(guid)

The key. Not used anymore.

defaultImageAltTextstring or null

The default image alt text.

variantGroup(VariantGroup (object or null))

One of:

productsArray of objects or null(Product)

culturesArray of objects or null(VariantCulture)

{
  "id": 0,
  "clientId": 0,
  "defaultName": "string",
  "defaultImagePath": "string",
  "defaultThumbnailImagePath": "string",
  "defaultCampaignImagePath": "string",
  "defaultLargeImagePath": "string",
  "groupId": 0,
  "alias": "string",
  "defaultTitle": "string",
  "defaultTags": "string",
  "defaultMetaTags": "string",
  "defaultMetaDescription": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": 0,
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": 0,
  "imageKey": "string",
  "code": "string",
  "defaultUniqueUrlName": "string",
  "key": "string",
  "defaultImageAltText": "string",
  "variantGroup": {
    "id": 0,
    "clientId": 0,
    "defaultName": "string",
    "defaultDescription": "string",
    "isActive": true,
    "created": "2019-08-24T14:15:22Z",
    "createdBy": 0,
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": 0,
    "code": "string",
    "variant": [ … ],
    "cultures": [ … ],
    "groupTypes": [ … ]
  },
  "products": [
    { … }
  ],
  "cultures": [
    { … }
  ]
}

VariantCulture

variantIdinteger(int32)

The variant identifier.

cultureCodestring or null[ 0 .. 16 ] characters

The culture code (e.g. en-US).

namestring or null[ 0 .. 255 ] characters

The name of the variant in the specified culture.

imagePathstring or null[ 0 .. 255 ] characters

The image path, not used anymore.

thumbnailImagePathstring or null[ 0 .. 255 ] characters

The thumbnail image path, not used anymore.

campaignImagePathstring or null[ 0 .. 255 ] characters

The campaign image path, not used anymore.

largeImagePathstring or null[ 0 .. 255 ] characters

The large image path, not used anymore.

titlestring or null[ 0 .. 255 ] characters

The title. For SEO purposes.

tagsstring or null

The tags, not commonly used anymore.

metaTagsstring or null

The meta tags, for SEO purposes.

metaDescriptionstring or null

The meta description, for SEO purposes.

updatedstring or null(date-time)

The date and time the record was last updated.

updatedByinteger or null(int32)

The identifier of the user who last updated the record.

uniqueUrlNamestring or null[ 0 .. 500 ] characters

The unique url name. An SEO friendly name that can be used in URLs. Should be unique across variants and products. Called UniqueName in commerce services, UniqueName in admin.

isUniqueUrlNameManuallyMaintainedboolean

Indicates whether the UniqueUrlName is handled by Norce (false) or by the user/integrations (true).

imageKeystring or null(guid)

The image key.

nameLastUpdatedstring or null(date-time)

When the name field was last updated.

nameLastUpdatedByinteger or null(int32)

The identifier of the user who last updated the name.

clientIdinteger or null(int32)

The client identifier.

imageAltTextstring or null

Culture specific image alt text.

variant(Variant (object or null))

One of:

{
  "variantId": 0,
  "cultureCode": "string",
  "name": "string",
  "imagePath": "string",
  "thumbnailImagePath": "string",
  "campaignImagePath": "string",
  "largeImagePath": "string",
  "title": "string",
  "tags": "string",
  "metaTags": "string",
  "metaDescription": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": 0,
  "uniqueUrlName": "string",
  "isUniqueUrlNameManuallyMaintained": true,
  "imageKey": "string",
  "nameLastUpdated": "2019-08-24T14:15:22Z",
  "nameLastUpdatedBy": 0,
  "clientId": 0,
  "imageAltText": "string",
  "variant": {
    "id": 0,
    "clientId": 0,
    "defaultName": "string",
    "defaultImagePath": "string",
    "defaultThumbnailImagePath": "string",
    "defaultCampaignImagePath": "string",
    "defaultLargeImagePath": "string",
    "groupId": 0,
    "alias": "string",
    "defaultTitle": "string",
    "defaultTags": "string",
    "defaultMetaTags": "string",
    "defaultMetaDescription": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": 0,
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": 0,
    "imageKey": "string",
    "code": "string",
    "defaultUniqueUrlName": "string",
    "key": "string",
    "defaultImageAltText": "string",
    "variantGroup": { … },
    "products": [ … ],
    "cultures": [ … ]
  }
}

Application

Operations

Core

Operations

Customers

Operations

Order

Operations

Products

Operations

Shopping

Operations

Metadata

Operations