COMMERCE QUERY

Query API 3.0

ProductFamily

Commerce Query API (v3.0)

Download OpenAPI description

openapi.json

openapi.yaml

Servers

Playground

https://{slug}.api-se.playground.norce.tech/commerce/query/3.0/

Stage

https://{slug}.api-se.stage.norce.tech/commerce/query/3.0/

Production

https://{slug}.api-se.norce.tech/commerce/query/3.0/

Schemas

ProductCulture

productIdinteger(int32)

The product identifier.

cultureCodestring or null[ 0 .. 16 ] characters

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

namestring or null[ 0 .. 255 ] characters

The culture specific name of the product.

nameLastUpdatedstring or null(date-time)

The name last updated.

nameLastUpdatedByinteger or null(int32)

The name last updated by.

subHeaderstring or null[ 0 .. 255 ] characters

The culture specific sub header of the product.

subHeaderLastUpdatedstring or null(date-time)

The sub header last updated.

subHeaderLastUpdatedByinteger or null(int32)

The sub header last updated by.

subDescriptionstring or null

The culture specific sub description of the product.

subDescriptionLastUpdatedstring or null(date-time)

The sub description last updated.

subDescriptionLastUpdatedByinteger or null(int32)

The sub description last updated by.

descriptionHeaderstring or null[ 0 .. 255 ] characters

The culture specific description header of the product.

descriptionHeaderLastUpdatedstring or null(date-time)

The description header last updated.

descriptionHeaderLastUpdatedByinteger or null(int32)

The description header last updated by.

descriptionstring or null

The culture specific description of the product.

descriptionLastUpdatedstring or null(date-time)

The description last updated.

descriptionLastUpdatedByinteger or null(int32)

The description last updated by.

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.

imageLastUpdatedstring or null(date-time)

The image last updated.

imageLastUpdatedByinteger or null(int32)

The image last updated by.

synonymsstring or null[ 0 .. 500 ] characters

The synonyms, commonly comma or blank space separated list of words.

synonymsLastUpdatedstring or null(date-time)

The synonyms last updated.

synonymsLastUpdatedByinteger or null(int32)

The synonyms last updated by.

titlestring or null[ 0 .. 255 ] characters

The title of the product, for SEO purposes.

tagsstring or null

The tags of the product, not 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, a unique URL friendly name for the product, called UniqueName in the admin tool.

isUniqueUrlNameManuallyMaintainedboolean

Indicates whether the product culture's unique url name is manually maintained.

imageKeystring or null(guid)

The image key.

externalDescriptionstring or null

The external description, not commonly used.

clientIdinteger or null(int32)

The client identifier.

imageAltTextstring or null

The image alt text.

{
  "productId": 0,
  "cultureCode": "string",
  "name": "string",
  "nameLastUpdated": "2019-08-24T14:15:22Z",
  "nameLastUpdatedBy": 0,
  "subHeader": "string",
  "subHeaderLastUpdated": "2019-08-24T14:15:22Z",
  "subHeaderLastUpdatedBy": 0,
  "subDescription": "string",
  "subDescriptionLastUpdated": "2019-08-24T14:15:22Z",
  "subDescriptionLastUpdatedBy": 0,
  "descriptionHeader": "string",
  "descriptionHeaderLastUpdated": "2019-08-24T14:15:22Z",
  "descriptionHeaderLastUpdatedBy": 0,
  "description": "string",
  "descriptionLastUpdated": "2019-08-24T14:15:22Z",
  "descriptionLastUpdatedBy": 0,
  "imagePath": "string",
  "thumbnailImagePath": "string",
  "campaignImagePath": "string",
  "largeImagePath": "string",
  "imageLastUpdated": "2019-08-24T14:15:22Z",
  "imageLastUpdatedBy": 0,
  "synonyms": "string",
  "synonymsLastUpdated": "2019-08-24T14:15:22Z",
  "synonymsLastUpdatedBy": 0,
  "title": "string",
  "tags": "string",
  "metaTags": "string",
  "metaDescription": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": 0,
  "uniqueUrlName": "string",
  "isUniqueUrlNameManuallyMaintained": true,
  "imageKey": "string",
  "externalDescription": "string",
  "clientId": 0,
  "imageAltText": "string"
}

ProductFamily

productIdinteger(int32)

The product identifier.

familyIdinteger(int32)

The family identifier.

isPrimaryboolean

Indicates whether the product family is primary.

sortOrderinteger or null(int32)

The sort order for display purposes.

isActiveboolean

Indicates whether the product family 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.

{
  "productId": 0,
  "familyId": 0,
  "isPrimary": true,
  "sortOrder": 0,
  "isActive": true,
  "created": "2019-08-24T14:15:22Z",
  "createdBy": 0,
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": 0
}

Family

idinteger(int32)

The unique identifier of the productfamily.

clientIdinteger(int32)

The client identifier.

codestring or null[ 0 .. 50 ] characters

The code of the product family.

defaultNamestring[ 0 .. 50 ] charactersrequired

The default name of the product family.

defaultDescriptionstring or null

The default description of the product family.

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.

isActiveboolean

Indicates whether the product family 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.

imageKeystring or null(guid)

The image key.

culturesArray of objects or null(FamilyCulture)

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

Application

Operations

Core

Operations

Customers

Operations

Order

Operations

Products

Operations

Shopping

Operations

Metadata

Operations