COMMERCE QUERY
/
Query API 3.0
/
Schemas
/
ProductRelationCulture

Query (v1)

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers

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

Schemas

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)
relatedProduct(Product (object or null))
One of:
{
  "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": {
    "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": [ … ],
    "productRelationRelatedProduct": [ … ],
    "supplierSkus": [ … ],
    "variant": { … }
  },
  "cultures": [
    { … }
  ],
  "relatedProduct": {
    "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": [ … ],
    "productRelationRelatedProduct": [ … ],
    "supplierSkus": [ … ],
    "variant": { … }
  }
}

ProductRelationCulture

relationIdinteger(int32)

The relation identifier.

cultureCodestring or null[ 0 .. 16 ] characters

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

clientIdinteger(int32)

The client identifier.

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.

relation(ProductRelation (object or null))
One of:
{
  "relationId": 0,
  "cultureCode": "string",
  "clientId": 0,
  "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,
  "relation": {
    "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": { … },
    "cultures": [ … ],
    "relatedProduct": { … }
  }
}

SupplierProductSkuPriceList

partNostring or null[ 0 .. 50 ] characters

The supplier part number.

supplierIdinteger(int32)

The internal identifier of the supplier.

supplierPriceListIdinteger(int32)

The supplier price list identifier.

qtyBreakinteger(int32)

The quantity break.

currencyIdinteger(int32)

The currency identifier.

costPurchasenumber or null(decimal)

The cost purchase.

costPurchaseLastCheckedstring or null(date-time)

The cost purchase last checked.

costPurchaseLastUpdatedstring or null(date-time)

The cost purchase last updated.

costPurchaseLastUpdatedByinteger or null(int32)

The cost purchase last updated by.

costPurchaseValidTostring or null(date-time)

The cost purchase valid to. Not commonly used.

priceRecommendednumber or null(decimal)

The price recommended. Can optionally be copied to the client price list.

priceRecommendedLastUpdatedstring or null(date-time)

The price recommended last updated.

priceRecommendedLastUpdatedByinteger or null(int32)

The price recommended last updated by.

priceMaxnumber or null(decimal)

The price max. Not used anymore.

priceMaxLastUpdatedstring or null(date-time)

The price max last updated. Not used anymore.

priceMaxLastUpdatedByinteger or null(int32)

The price max last updated by. Not used anymore.

priceDealernumber or null(decimal)

The price dealer. Not used anymore.

priceDealerLastUpdatedstring or null(date-time)

The price dealer last updated. Not used anymore.

priceDealerLastUpdatedByinteger or null(int32)

The price dealer last updated by. Not used anymore.

isActiveboolean

Indicates whether the supplier product sku price list is active.

isActiveLastUpdatedstring or null(date-time)

The is active last updated.

stoppedDatestring or null(date-time)

The stopped date.

isPromotionboolean or null

Indicates whether the supplier product sku price list is promotion. Not commonly used.

isFocusboolean or null

Indicates whether the supplier product sku price list is focus. Not commonly used.

priceRankinginteger or null(int32)

The price ranking. Not used anymore.

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.

freightCostnumber or null(decimal)

The freight cost. Not commonly used.

costFeenumber or null(decimal)

The cost fee. Not commonly used.

costFeeLastUpdatedstring or null(date-time)

The cost fee last updated. Not commonly used.

costFeeLastUpdatedByinteger or null(int32)

The cost fee last updated by. Not commonly used.

discountPctnumber or null(decimal)

The discount pct. Not commonly used.

discountPctLastUpdatedstring or null(date-time)

The discount pct last updated. Not commonly used.

discountPctLastUpdatedByinteger or null(int32)

The discount pct last updated by. Not commonly used.

priceCatalognumber or null(decimal)

The price catalog. Not commonly used.

priceCatalogLastUpdatedstring or null(date-time)

The price catalog last updated. Not commonly used.

priceCatalogLastUpdatedByinteger or null(int32)

The price catalog last updated by. Not commonly used.

clientIdinteger or null(int32)

The client identifier.

priceList(SupplierPriceList (object or null))
One of:
supplierProductSku(SupplierProductSku (object or null))
One of:
{
  "partNo": "string",
  "supplierId": 0,
  "supplierPriceListId": 0,
  "qtyBreak": 0,
  "currencyId": 0,
  "costPurchase": 0,
  "costPurchaseLastChecked": "2019-08-24T14:15:22Z",
  "costPurchaseLastUpdated": "2019-08-24T14:15:22Z",
  "costPurchaseLastUpdatedBy": 0,
  "costPurchaseValidTo": "2019-08-24T14:15:22Z",
  "priceRecommended": 0,
  "priceRecommendedLastUpdated": "2019-08-24T14:15:22Z",
  "priceRecommendedLastUpdatedBy": 0,
  "priceMax": 0,
  "priceMaxLastUpdated": "2019-08-24T14:15:22Z",
  "priceMaxLastUpdatedBy": 0,
  "priceDealer": 0,
  "priceDealerLastUpdated": "2019-08-24T14:15:22Z",
  "priceDealerLastUpdatedBy": 0,
  "isActive": true,
  "isActiveLastUpdated": "2019-08-24T14:15:22Z",
  "stoppedDate": "2019-08-24T14:15:22Z",
  "isPromotion": true,
  "isFocus": true,
  "priceRanking": 0,
  "created": "2019-08-24T14:15:22Z",
  "createdBy": 0,
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": 0,
  "freightCost": 0,
  "costFee": 0,
  "costFeeLastUpdated": "2019-08-24T14:15:22Z",
  "costFeeLastUpdatedBy": 0,
  "discountPct": 0,
  "discountPctLastUpdated": "2019-08-24T14:15:22Z",
  "discountPctLastUpdatedBy": 0,
  "priceCatalog": 0,
  "priceCatalogLastUpdated": "2019-08-24T14:15:22Z",
  "priceCatalogLastUpdatedBy": 0,
  "clientId": 0,
  "priceList": {
    "id": 0,
    "supplierId": 0,
    "manufacturerId": 0,
    "manufacturerCode": "string",
    "defaultName": "string",
    "code": "string",
    "description": "string",
    "endCustomer": "string",
    "startDate": "2019-08-24T14:15:22Z",
    "endDate": "2019-08-24T14:15:22Z",
    "transferMethodId": 0,
    "transferMethodValue": "string",
    "lastImported": "2019-08-24T14:15:22Z",
    "nextExpectedDate": "2019-08-24T14:15:22Z",
    "isPrimary": true,
    "parentSupplierPriceListId": 0,
    "contact": "string",
    "comment": "string",
    "isSpecialTerms": true,
    "isManuallyMaintained": true,
    "igniteSourceId": 0,
    "igniteSourceLastImported": "2019-08-24T14:15:22Z",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": 0,
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": 0,
    "currencyId": 0,
    "traderaStockCodeSeed": "string",
    "traderaExternalStockCodeSeed": "string",
    "clientId": 0,
    "supplierProductSkuPriceList": [ … ]
  },
  "supplierProductSku": {
    "partNo": "string",
    "supplierId": 0,
    "name": "string",
    "manufacturerId": 0,
    "manufacturerCode": "string",
    "manufacturerPartNo": "string",
    "categoryId": 0,
    "categoryCode": "string",
    "commodityCode": "string",
    "eanCode": "string",
    "grossWeight": 0,
    "netWeight": 0,
    "vatCodeId": 0,
    "unitOfMeasurementId": 0,
    "unitOfMeasurementCount": 0,
    "url": "string",
    "imagePath": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": 0,
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": 0,
    "imagePathLastUpdated": "2019-08-24T14:15:22Z",
    "isUsed": true,
    "logisticWidth": 0,
    "logisticHeight": 0,
    "logisticDepth": 0,
    "clientId": 0,
    "productId": 0,
    "supplierProductSkuClient": [ … ],
    "onHands": [ … ],
    "priceLists": [ … ]
  }
}

Application

Operations

Core

Operations

Customers

Operations

Order

Operations

Products

Operations

Shopping

Operations

Metadata

Operations