Query (v1)

Download OpenAPI description
Languages
Servers

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

Schemas

ParametricList

idinteger(int32)

The unique identifier of the list item.

parametricIdinteger(int32)

The parametric identifier.

defaultVarcharValuestring[ 0 .. 255 ] charactersrequired

The default varchar value.

defaultDescriptionstring or null

The default description of the parametric list item.

sortOrderinteger or null(int32)

The sort order for display purposes.

isActiveboolean

Indicates whether the parametric list 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 list item.

imageKeystring or null(guid)

The image key.

imagePathstring or null[ 0 .. 255 ] characters

The image path, not used anymore.

clientIdinteger or null(int32)

The client identifier.

parametric(Parametric (object or null))
One of:
culturesArray of objects or null(ParametricListCulture)
productParametricArray of objects or null(ProductParametric)
{ "id": 0, "parametricId": 0, "defaultVarcharValue": "string", "defaultDescription": "string", "sortOrder": 0, "isActive": true, "created": "2019-08-24T14:15:22Z", "createdBy": 0, "updated": "2019-08-24T14:15:22Z", "updatedBy": 0, "code": "string", "imageKey": "string", "imagePath": "string", "clientId": 0, "parametric": { "id": 0, "clientId": 0, "defaultName": "string", "defaultDescription": "string", "defaultUom": "string", "typeId": 0, "hasListValues": true, "hasMultipleValues": true, "isVariantType": true, "isRequired": true, "isHidden": true, "isActive": true, "created": "2019-08-24T14:15:22Z", "createdBy": 0, "updated": "2019-08-24T14:15:22Z", "updatedBy": 0, "code": "string", "codeListKey": "string", "isReadOnly": true, "editor": "string", "isFavorite": true, "isPublic": true, "groupId": 0, "defaultIsVariantUnique": true, "showOnTextTab": true, "showInList": true, "categoryParametric": [], "group": {}, "cultures": [], "parametricList": [], "parametricMultiple": [], "productParametric": [], "variantType": [] }, "cultures": [ {} ], "productParametric": [ {} ] }

ParametricListCulture

listIdinteger(int32)

The list item identifier.

cultureCodestring or null[ 0 .. 16 ] characters

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

varcharValuestring or null[ 0 .. 255 ] characters

The culture specific varchar value.

descriptionstring or null

The culture specific description of the parametric list item.

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.

clientIdinteger or null(int32)

The client identifier.

list(ParametricList (object or null))
One of:
{ "listId": 0, "cultureCode": "string", "varcharValue": "string", "description": "string", "updated": "2019-08-24T14:15:22Z", "updatedBy": 0, "clientId": 0, "list": { "id": 0, "parametricId": 0, "defaultVarcharValue": "string", "defaultDescription": "string", "sortOrder": 0, "isActive": true, "created": "2019-08-24T14:15:22Z", "createdBy": 0, "updated": "2019-08-24T14:15:22Z", "updatedBy": 0, "code": "string", "imageKey": "string", "imagePath": "string", "clientId": 0, "parametric": {}, "cultures": [], "productParametric": [] } }

ProductParametric

productIdinteger(int32)

The product identifier.

clientIdinteger(int32)

The client identifier.

parametricIdinteger(int32)

The parametric identifier.

defaultVarcharValuestring or null[ 0 .. 255 ] characters

The default varchar value, if the parametric is of type text.

defaultHtmlValuestring or null

The default html value, if the parametric is of type html.

integerValueinteger or null(int32)

The integer value, if the parametric is of type integer.

decimalValuenumber or null(decimal)

The decimal value, if the parametric is of type decimal.

booleanValueboolean or null

Indicates whether the boolean value is enabled, if the parametric is of type boolean.

dateValuestring or null(date-time)

The date value, if the parametric is of type date.

listIdinteger or null(int32)

The list identifier, if the parametric is of type list.

normalizedValuenumber or null(decimal)

The normalized value, if the parametric is of a number type.

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.

isVariantUniqueboolean

Indicates whether the product parametric is on the variant level.

list(ParametricList (object or null))
One of:
parametric(Parametric (object or null))
One of:
product(Product (object or null))
One of:
culturesArray of objects or null(ProductParametricCulture)
productParametricMultipleArray of objects or null(ProductParametricMultiple)
{ "productId": 0, "clientId": 0, "parametricId": 0, "defaultVarcharValue": "string", "defaultHtmlValue": "string", "integerValue": 0, "decimalValue": 0, "booleanValue": true, "dateValue": "2019-08-24T14:15:22Z", "listId": 0, "normalizedValue": 0, "created": "2019-08-24T14:15:22Z", "createdBy": 0, "updated": "2019-08-24T14:15:22Z", "updatedBy": 0, "isVariantUnique": true, "list": { "id": 0, "parametricId": 0, "defaultVarcharValue": "string", "defaultDescription": "string", "sortOrder": 0, "isActive": true, "created": "2019-08-24T14:15:22Z", "createdBy": 0, "updated": "2019-08-24T14:15:22Z", "updatedBy": 0, "code": "string", "imageKey": "string", "imagePath": "string", "clientId": 0, "parametric": {}, "cultures": [], "productParametric": [] }, "parametric": { "id": 0, "clientId": 0, "defaultName": "string", "defaultDescription": "string", "defaultUom": "string", "typeId": 0, "hasListValues": true, "hasMultipleValues": true, "isVariantType": true, "isRequired": true, "isHidden": true, "isActive": true, "created": "2019-08-24T14:15:22Z", "createdBy": 0, "updated": "2019-08-24T14:15:22Z", "updatedBy": 0, "code": "string", "codeListKey": "string", "isReadOnly": true, "editor": "string", "isFavorite": true, "isPublic": true, "groupId": 0, "defaultIsVariantUnique": true, "showOnTextTab": true, "showInList": true, "categoryParametric": [], "group": {}, "cultures": [], "parametricList": [], "parametricMultiple": [], "productParametric": [], "variantType": [] }, "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": [ {} ], "productParametricMultiple": [ {} ] }

Application

Operations

Core

Operations

Customers

Operations

Order

Operations

Products

Operations

Shopping

Operations

Metadata

Operations