COMMERCE QUERY

Query API 3.0

ProductFlagCulture

Query (v1)

Download OpenAPI description

openapi.json

openapi.yaml

Servers

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

Schemas

ProductFlagGroupCulture

groupIdinteger(int32)

The flag group identifier.

cultureCodestring or null[ 0 .. 16 ] characters

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

namestring or null[ 0 .. 50 ] characters

The culture specific name of the product flag group.

descriptionstring or null[ 0 .. 500 ] characters

The culture specific description of the product flag group.

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.

group(ProductFlagGroup (object or null))

One of:

{
  "groupId": 0,
  "cultureCode": "string",
  "name": "string",
  "description": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": 0,
  "clientId": 0,
  "group": {
    "id": 0,
    "clientId": 0,
    "code": "string",
    "defaultName": "string",
    "defaultDescription": "string",
    "isMultipleChoice": true,
    "isActive": true,
    "created": "2019-08-24T14:15:22Z",
    "createdBy": 0,
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": 0,
    "isDisplay": true,
    "isFavorite": true,
    "productFlag": [ … ],
    "cultures": [ … ]
  }
}

ProductFlagCulture

flagIdinteger(int32)

The flag identifier.

cultureCodestring or null[ 0 .. 16 ] characters

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

namestring or null[ 0 .. 50 ] characters

The culture specific name of the product flag.

descriptionstring or null[ 0 .. 500 ] characters

The culture specific description of the product flag.

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.

flag(ProductFlag (object or null))

One of:

{
  "flagId": 0,
  "cultureCode": "string",
  "name": "string",
  "description": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": 0,
  "clientId": 0,
  "flag": {
    "id": 0,
    "clientId": 0,
    "typeId": 0,
    "groupId": 0,
    "defaultName": "string",
    "defaultDescription": "string",
    "isManuallyEditable": true,
    "sortOrder": 0,
    "isActive": true,
    "created": "2019-08-24T14:15:22Z",
    "createdBy": 0,
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": 0,
    "code": "string",
    "clientProductFlag": [ … ],
    "group": { … },
    "cultures": [ … ]
  }
}

ProductCategory

productIdinteger(int32)

The product identifier.

clientIdinteger(int32)

The client identifier.

categoryIdinteger(int32)

The category identifier.

isPrimaryboolean

Indicates whether the product category is primary, a product can only have one primary category.

sortOrderinteger or null(int32)

The sort order between categories.

productSortOrderinteger or null(int32)

The products sort order within the category.

isActiveboolean

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

category(Category (object or null))

One of:

product(Product (object or null))

One of:

{
  "productId": 0,
  "clientId": 0,
  "categoryId": 0,
  "isPrimary": true,
  "sortOrder": 0,
  "productSortOrder": 0,
  "isActive": true,
  "created": "2019-08-24T14:15:22Z",
  "createdBy": 0,
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": 0,
  "category": {
    "id": 0,
    "clientId": 0,
    "code": "string",
    "defaultName": "string",
    "defaultDescription": "string",
    "defaultSynonyms": "string",
    "defaultImagePath": "string",
    "unspcCode": "string",
    "businessArea": "string",
    "defaultCommodityCode": "string",
    "defaultIntegrationPartNo": "string",
    "defaultTrackingCodeTypeId": 0,
    "freightClassId": 0,
    "defaultGrossWeight": 0,
    "defaultNetWeight": 0,
    "defaultUnitOfMeasurementId": 0,
    "defaultPackageId": 0,
    "defaultIsReturnable": true,
    "defaultIsDropShipOnly": true,
    "insuranceCurrencyId": 0,
    "insuranceStartPrice": 0,
    "insuranceRunningPercentage": 0,
    "populationRuleId": 0,
    "hideInTopList": true,
    "phoneNumber": "string",
    "isActive": true,
    "created": "2019-08-24T14:15:22Z",
    "createdBy": 0,
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": 0,
    "competitivePricingMinPercentage": 0,
    "competitivePricingTargetPercentage": 0,
    "defaultVariantGroupId": 0,
    "defaultRecommendedSalesQty": 0,
    "imageKey": "string",
    "defaultFullName": "string",
    "structureSortOrder": 0,
    "defaultStockDisplayBreakPoint": 0,
    "defaultIsRecommendedSalesQtyFixed": true,
    "defaultIsRecurringOrderable": true,
    "cultures": [ … ],
    "categoryHierarchyCategory": [ … ],
    "categoryHierarchyParentCategory": [ … ],
    "parametrics": [ … ],
    "salesAreas": [ … ],
    "categoryStructureItem": [ … ],
    "productCategory": [ … ]
  },
  "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": { … }
  }
}

Application

Operations

Core

Operations

Customers

Operations

Order

Operations

Products

Operations

Shopping

Operations

Metadata

Operations