COMMERCE QUERY

Query API 3.0

ProductRelation

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

ProductFile

idinteger(int32)

The unique identifier of the asset on the product.

productIdinteger(int32)

The product identifier.

clientIdinteger(int32)

The client identifier.

fileIdinteger(int32)

The file type identifier.

defaultNamestring or null[ 0 .. 50 ] characters

The default name of the product file or image.

defaultDescriptionstring or null

The default description of the product file or image.

defaultPathstring or null

The default path, not used anymore.

defaultThumbnailPathstring or null[ 0 .. 255 ] characters

The default thumbnail path, not used anymore.

defaultSizestring or null[ 0 .. 50 ] characters

The default size, not used anymore.

isActiveboolean

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

fileKeystring or null(guid)

The file key identifier, used for finding the asset from the storage.

isVariantUniqueboolean

Indicates whether the product file is variant unique.

codestring or null[ 0 .. 255 ] characters

The code of the product file.

sortOrderinteger or null(int32)

The sort order for display purposes.

defaultAltTextstring or null

The default alt text, only used if the asset is an image.

{
  "id": 0,
  "productId": 0,
  "clientId": 0,
  "fileId": 0,
  "defaultName": "string",
  "defaultDescription": "string",
  "defaultPath": "string",
  "defaultThumbnailPath": "string",
  "defaultSize": "string",
  "isActive": true,
  "created": "2019-08-24T14:15:22Z",
  "createdBy": 0,
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": 0,
  "fileKey": "string",
  "isVariantUnique": true,
  "code": "string",
  "sortOrder": 0,
  "defaultAltText": "string"
}

ProductRelation

idinteger(int32)

The unique identifier of the product relation.

clientIdinteger(int32)

The client identifier.

productIdinteger(int32)

The identifier of the product having the relation.

relatedProductIdinteger(int32)

The identifier of the related product.

typeIdinteger(int32)

The product relation type identifier.

sortOrderinteger or null(int32)

The sort order for display purposes.

populationRuleIdinteger or null(int32)

The population rule identifier, if the relation is automatically created.

isProductVariantUniqueboolean

Indicates whether the product with the relation is a specific variant.

isRelatedProductVariantUniqueboolean

Indicates whether the related product is a specific variant.

defaultNamestring or null[ 0 .. 255 ] characters

The default name of the related product, overrides the related product's name, not commonly used.

defaultSubHeaderstring or null[ 0 .. 255 ] characters

The default sub header of the related product, overrides the related product's sub header, not commonly used.

defaultSubDescriptionstring or null

The default sub description of the related product, overrides the related product's sub description, not commonly used.

defaultDescriptionHeaderstring or null[ 0 .. 255 ] characters

The default description header of the related product, overrides the related product's description header, not commonly used.

defaultDescriptionstring or null

The default description of the related product, overrides the related product's description, not commonly used.

isActiveboolean

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

product(Product (object or null))

One of:

culturesArray of objects or null(ProductRelationCulture)

{
  "id": 0,
  "clientId": 0,
  "productId": 0,
  "relatedProductId": 0,
  "typeId": 0,
  "sortOrder": 0,
  "populationRuleId": 0,
  "isProductVariantUnique": true,
  "isRelatedProductVariantUnique": true,
  "defaultName": "string",
  "defaultSubHeader": "string",
  "defaultSubDescription": "string",
  "defaultDescriptionHeader": "string",
  "defaultDescription": "string",
  "isActive": true,
  "created": "2019-08-24T14:15:22Z",
  "createdBy": 0,
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": 0,
  "product": {
    "popularities": [ … ],
    "id": 0,
    "clientId": 0,
    "manufacturerId": 0,
    "manufacturerPartNo": "string",
    "defaultName": "string",
    "defaultSubHeader": "string",
    "defaultSubDescription": "string",
    "defaultDescriptionHeader": "string",
    "defaultDescription": "string",
    "defaultImagePath": "string",
    "defaultThumbnailImagePath": "string",
    "defaultCampaignImagePath": "string",
    "defaultLargeImagePath": "string",
    "defaultSynonyms": "string",
    "sortOrderValue": 0,
    "assortmentId": 0,
    "assortmentLastUpdated": "2019-08-24T14:15:22Z",
    "assortmentLastUpdatedBy": 0,
    "isVariant": true,
    "variantId": 0,
    "alias": "string",
    "defaultTitle": "string",
    "defaultTags": "string",
    "defaultMetaTags": "string",
    "defaultMetaDescription": "string",
    "hideInTopList": true,
    "isActive": true,
    "stoppedDate": "2019-08-24T14:15:22Z",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": 0,
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": 0,
    "insuranceCurrencyId": 0,
    "insuranceStartPrice": 0,
    "insuranceRunningPercentage": 0,
    "key": "string",
    "manufacturerPartNo2": "string",
    "imageKey": "string",
    "defaultUniqueUrlName": "string",
    "stockDisplayBreakPoint": 0,
    "isDangerousGoods": true,
    "code": "string",
    "isRecurringOrderable": true,
    "defaultExternalDescription": "string",
    "unspscCode": "string",
    "translationRequested": "2019-08-24T14:15:22Z",
    "translationRequestedBy": 0,
    "defaultImageAltText": "string",
    "flags": [ … ],
    "skus": [ … ],
    "categories": [ … ],
    "cultures": [ … ],
    "families": [ … ],
    "files": [ … ],
    "parametrics": [ … ],
    "parametricMultiple": [ … ],
    "productRelations": [ … ],
    "supplierSkus": [ … ],
    "variant": { … }
  },
  "cultures": [
    { … }
  ]
}

ProductRelationCulture

relationIdinteger(int32)

The relation 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 relation, not commonly used.

subHeaderstring or null[ 0 .. 255 ] characters

The culture specific sub header of the product relation, not commonly used.

subDescriptionstring or null

The culture specific sub description of the product relation, not commonly used.

descriptionHeaderstring or null[ 0 .. 255 ] characters

The culture specific description header of the product relation, not commonly used.

descriptionstring or null

The culture specific description of the product relation, not commonly used.

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.

{
  "relationId": 0,
  "cultureCode": "string",
  "name": "string",
  "subHeader": "string",
  "subDescription": "string",
  "descriptionHeader": "string",
  "description": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": 0,
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": 0
}

Application

Operations

Core

Operations

Customers

Operations

Order

Operations

Products

Operations

Shopping

Operations

Metadata

Operations