COMMERCE QUERY

Query API 3.0

ClientProductSkuCulture

Query (v1)

Download OpenAPI description

openapi.json

openapi.yaml

Servers

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

Schemas

ClientProductSku

partNostring or null[ 0 .. 50 ] characters

The part number.

clientIdinteger(int32)

The client identifier.

productIdinteger(int32)

The product identifier.

statusIdinteger(int32)

The status identifier, Active (1), Coming (2), Expiring (3), Hidden (4), Inactive (5).

statusLastUpdatedstring or null(date-time)

The status last updated.

statusLastUpdatedByinteger or null(int32)

The status last updated by.

typeIdinteger(int32)

The type identifier, a value from the ClientProductSkuType.

integrationPartNostring or null[ 0 .. 50 ] characters

The integration part number, used when ERP has a different part number or a shared part number for many products in the Norce.

erpNamestring or null[ 0 .. 255 ] characters

The ERP name.

defaultCommentstring or null[ 0 .. 255 ] characters

The default comment.

commodityCodestring or null[ 0 .. 50 ] characters

The commodity code.

eanCodestring or null[ 0 .. 50 ] characters

The EAN code.

trackingCodestring or null[ 0 .. 50 ] characters

The tracking code.

grossWeightnumber or null(decimal)

The gross weight, called Actual weight in the admin tool and is used by shipping calculations.

netWeightnumber or null(decimal)

The net weight, not commonly used, set up parametrics instead.

freightClassIdinteger or null(int32)

The freight class identifier, not used anymore.

unitOfMeasurementIdinteger or null(int32)

The unit of measurement identifier.

unitOfMeasurementCountnumber(decimal)

The unit of measurement count.

packageIdinteger or null(int32)

The package identifier, not used anymore.

trackingCodeTypeIdinteger or null(int32)

The tracking code type identifier, not used anymore.

urlstring or null[ 0 .. 255 ] characters

The URL.

imagePathstring or null[ 0 .. 255 ] characters

The image path, not used anymore.

isDropShipOnlyboolean or null

Indicates whether the client product sku is drop ship only.

isPublishedboolean

Indicates whether the client product sku is published, not used anymore.

publishedLastUpdatedstring or null(date-time)

The published last updated.

publishedLastUpdatedByinteger or null(int32)

The published last updated by.

isBlockedboolean

Indicates whether the client product sku is blocked, 1 can force block a sku from being shown outside the system, but is not used anymore.

blockedLastUpdatedstring or null(date-time)

The blocked last updated.

blockedLastUpdatedByinteger or null(int32)

The blocked last updated by.

populationRuleIdinteger or null(int32)

The population rule identifier, 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.

lastCheckedstring or null(date-time)

The last checked.

trackingModeTypeIdinteger or null(int32)

The tracking mode type identifier, not used anymore.

isStatusLockedboolean

Indicates whether the client product sku is status locked, can be set manually in the admin tool.

statusLockedDatestring or null(date-time)

The status locked date.

statusLockedByinteger or null(int32)

The status locked by.

recommendedSalesQtynumber or null(decimal)

The recommended sales quantity.

logisticWidthnumber or null(decimal)

The logistic width, used in logistics calculations.

logisticHeightnumber or null(decimal)

The logistic height, used in logistics calculations.

logisticDepthnumber or null(decimal)

The logistic depth, used in logistics calculations.

isBuyableboolean

Indicates whether the client product sku is buyable, if 0 the cannot be added to baskets.

buyableLastUpdatedstring or null(date-time)

The buyable last updated.

buyableLastUpdatedByinteger or null(int32)

The buyable last updated by.

discountClassstring or null[ 0 .. 50 ] characters

The discount class, not used anymore.

isRecommendedSalesQtyFixedboolean or null

Indicates whether the client product sku is recommended sales quantity fixed.

startDatestring or null(date-time)

The start date, indicated when a coming product switches to active.

endDatestring or null(date-time)

The end date, indicated when an expiring product switches to inactive.

culturesArray of objects or null(ClientProductSkuCulture)

onHandsArray of objects or null(ClientProductSkuOnHand)

priceListsArray of objects or null(ClientProductSkuPriceList)

salesAreasArray of objects or null(ClientProductSkuSalesArea)

structureItemsArray of objects or null(ClientProductSkuStructureItem)

bestPricesArray of objects or null(ClientProductSkuBestPrice)

product(Product (object or null))

One of:

{
  "partNo": "string",
  "clientId": 0,
  "productId": 0,
  "statusId": 0,
  "statusLastUpdated": "2019-08-24T14:15:22Z",
  "statusLastUpdatedBy": 0,
  "typeId": 0,
  "integrationPartNo": "string",
  "erpName": "string",
  "defaultComment": "string",
  "commodityCode": "string",
  "eanCode": "string",
  "trackingCode": "string",
  "grossWeight": 0,
  "netWeight": 0,
  "freightClassId": 0,
  "unitOfMeasurementId": 0,
  "unitOfMeasurementCount": 0,
  "packageId": 0,
  "trackingCodeTypeId": 0,
  "url": "string",
  "imagePath": "string",
  "isDropShipOnly": true,
  "isPublished": true,
  "publishedLastUpdated": "2019-08-24T14:15:22Z",
  "publishedLastUpdatedBy": 0,
  "isBlocked": true,
  "blockedLastUpdated": "2019-08-24T14:15:22Z",
  "blockedLastUpdatedBy": 0,
  "populationRuleId": 0,
  "created": "2019-08-24T14:15:22Z",
  "createdBy": 0,
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": 0,
  "lastChecked": "2019-08-24T14:15:22Z",
  "trackingModeTypeId": 0,
  "isStatusLocked": true,
  "statusLockedDate": "2019-08-24T14:15:22Z",
  "statusLockedBy": 0,
  "recommendedSalesQty": 0,
  "logisticWidth": 0,
  "logisticHeight": 0,
  "logisticDepth": 0,
  "isBuyable": true,
  "buyableLastUpdated": "2019-08-24T14:15:22Z",
  "buyableLastUpdatedBy": 0,
  "discountClass": "string",
  "isRecommendedSalesQtyFixed": true,
  "startDate": "2019-08-24T14:15:22Z",
  "endDate": "2019-08-24T14:15:22Z",
  "cultures": [
    { … }
  ],
  "onHands": [
    { … }
  ],
  "priceLists": [
    { … }
  ],
  "salesAreas": [
    { … }
  ],
  "structureItems": [
    { … }
  ],
  "bestPrices": [
    { … }
  ],
  "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": { … }
  }
}

ClientProductSkuCulture

partNostring or null[ 0 .. 50 ] characters

The part number.

clientIdinteger(int32)

The client identifier.

cultureCodestring or null[ 0 .. 16 ] characters

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

erpNamestring or null[ 0 .. 255 ] characters

The culture specific ERP name.

commentstring or null[ 0 .. 255 ] characters

A comment or note.

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.

clientProductSku(ClientProductSku (object or null))

One of:

{
  "partNo": "string",
  "clientId": 0,
  "cultureCode": "string",
  "erpName": "string",
  "comment": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": 0,
  "clientProductSku": {
    "partNo": "string",
    "clientId": 0,
    "productId": 0,
    "statusId": 0,
    "statusLastUpdated": "2019-08-24T14:15:22Z",
    "statusLastUpdatedBy": 0,
    "typeId": 0,
    "integrationPartNo": "string",
    "erpName": "string",
    "defaultComment": "string",
    "commodityCode": "string",
    "eanCode": "string",
    "trackingCode": "string",
    "grossWeight": 0,
    "netWeight": 0,
    "freightClassId": 0,
    "unitOfMeasurementId": 0,
    "unitOfMeasurementCount": 0,
    "packageId": 0,
    "trackingCodeTypeId": 0,
    "url": "string",
    "imagePath": "string",
    "isDropShipOnly": true,
    "isPublished": true,
    "publishedLastUpdated": "2019-08-24T14:15:22Z",
    "publishedLastUpdatedBy": 0,
    "isBlocked": true,
    "blockedLastUpdated": "2019-08-24T14:15:22Z",
    "blockedLastUpdatedBy": 0,
    "populationRuleId": 0,
    "created": "2019-08-24T14:15:22Z",
    "createdBy": 0,
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": 0,
    "lastChecked": "2019-08-24T14:15:22Z",
    "trackingModeTypeId": 0,
    "isStatusLocked": true,
    "statusLockedDate": "2019-08-24T14:15:22Z",
    "statusLockedBy": 0,
    "recommendedSalesQty": 0,
    "logisticWidth": 0,
    "logisticHeight": 0,
    "logisticDepth": 0,
    "isBuyable": true,
    "buyableLastUpdated": "2019-08-24T14:15:22Z",
    "buyableLastUpdatedBy": 0,
    "discountClass": "string",
    "isRecommendedSalesQtyFixed": true,
    "startDate": "2019-08-24T14:15:22Z",
    "endDate": "2019-08-24T14:15:22Z",
    "cultures": [ … ],
    "onHands": [ … ],
    "priceLists": [ … ],
    "salesAreas": [ … ],
    "structureItems": [ … ],
    "bestPrices": [ … ],
    "product": { … }
  }
}

ClientProductSkuOnHand

partNostring or null[ 0 .. 50 ] characters

The part number.

clientIdinteger(int32)

The client identifier.

warehouseIdinteger(int32)

The warehouse identifier.

locationIdinteger(int32)

The location identifier.

onHandValuenumber(decimal)

The on hand value, from the inventory system.

onHandLastCheckedstring or null(date-time)

The on hand last checked.

onHandLastUpdatedstring or null(date-time)

The on hand last updated.

onHandLastUpdatedByinteger or null(int32)

The on hand last updated by.

incomingValuenumber or null(decimal)

The incoming value.

incomingLastCheckedstring or null(date-time)

The incoming last checked.

incomingLastUpdatedstring or null(date-time)

The incoming last updated.

incomingLastUpdatedByinteger or null(int32)

The incoming last updated by.

nextDeliveryDatestring or null(date-time)

The next delivery date, to the warehouse (when incoming > 0).

nextDeliveryLastCheckedstring or null(date-time)

The next delivery last checked.

nextDeliveryLastUpdatedstring or null(date-time)

The next delivery last updated.

nextDeliveryLastUpdatedByinteger or null(int32)

The next delivery last updated by.

isReturnableboolean

Indicates whether the client product sku on hand is returnable.

leadTimeDayCountinteger or null(int32)

The lead time day count, overrides the location or warehouse setting.

onOrderValuenumber or null(decimal)

The on order value, not used anymore.

minimumValuenumber or null(decimal)

The minimum value, optional value, when procuring should be considered.

maximumValuenumber or null(decimal)

The maximum value, optional value, target amount when procuring.

isActiveboolean

Indicates whether the client product sku on hand is active.

stoppedDatestring or null(date-time)

The stopped date.

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.

reservationValuenumber(decimal)

The reservation value, reserved value based on orders through the system, deducts onhand value in the admin tool and commerce service API, and is cleared by a new update from the inventory system.

isActiveLastUpdatedstring or null(date-time)

The is active last updated.

isActiveLastUpdatedByinteger or null(int32)

The is active last updated by.

clientProductSku(ClientProductSku (object or null))

One of:

infoArray of objects or null(ClientProductSkuOnHandInfo)

warehouse(Warehouse (object or null))

One of:

{
  "partNo": "string",
  "clientId": 0,
  "warehouseId": 0,
  "locationId": 0,
  "onHandValue": 0,
  "onHandLastChecked": "2019-08-24T14:15:22Z",
  "onHandLastUpdated": "2019-08-24T14:15:22Z",
  "onHandLastUpdatedBy": 0,
  "incomingValue": 0,
  "incomingLastChecked": "2019-08-24T14:15:22Z",
  "incomingLastUpdated": "2019-08-24T14:15:22Z",
  "incomingLastUpdatedBy": 0,
  "nextDeliveryDate": "2019-08-24T14:15:22Z",
  "nextDeliveryLastChecked": "2019-08-24T14:15:22Z",
  "nextDeliveryLastUpdated": "2019-08-24T14:15:22Z",
  "nextDeliveryLastUpdatedBy": 0,
  "isReturnable": true,
  "leadTimeDayCount": 0,
  "onOrderValue": 0,
  "minimumValue": 0,
  "maximumValue": 0,
  "isActive": true,
  "stoppedDate": "2019-08-24T14:15:22Z",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": 0,
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": 0,
  "reservationValue": 0,
  "isActiveLastUpdated": "2019-08-24T14:15:22Z",
  "isActiveLastUpdatedBy": 0,
  "clientProductSku": {
    "partNo": "string",
    "clientId": 0,
    "productId": 0,
    "statusId": 0,
    "statusLastUpdated": "2019-08-24T14:15:22Z",
    "statusLastUpdatedBy": 0,
    "typeId": 0,
    "integrationPartNo": "string",
    "erpName": "string",
    "defaultComment": "string",
    "commodityCode": "string",
    "eanCode": "string",
    "trackingCode": "string",
    "grossWeight": 0,
    "netWeight": 0,
    "freightClassId": 0,
    "unitOfMeasurementId": 0,
    "unitOfMeasurementCount": 0,
    "packageId": 0,
    "trackingCodeTypeId": 0,
    "url": "string",
    "imagePath": "string",
    "isDropShipOnly": true,
    "isPublished": true,
    "publishedLastUpdated": "2019-08-24T14:15:22Z",
    "publishedLastUpdatedBy": 0,
    "isBlocked": true,
    "blockedLastUpdated": "2019-08-24T14:15:22Z",
    "blockedLastUpdatedBy": 0,
    "populationRuleId": 0,
    "created": "2019-08-24T14:15:22Z",
    "createdBy": 0,
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": 0,
    "lastChecked": "2019-08-24T14:15:22Z",
    "trackingModeTypeId": 0,
    "isStatusLocked": true,
    "statusLockedDate": "2019-08-24T14:15:22Z",
    "statusLockedBy": 0,
    "recommendedSalesQty": 0,
    "logisticWidth": 0,
    "logisticHeight": 0,
    "logisticDepth": 0,
    "isBuyable": true,
    "buyableLastUpdated": "2019-08-24T14:15:22Z",
    "buyableLastUpdatedBy": 0,
    "discountClass": "string",
    "isRecommendedSalesQtyFixed": true,
    "startDate": "2019-08-24T14:15:22Z",
    "endDate": "2019-08-24T14:15:22Z",
    "cultures": [ … ],
    "onHands": [ … ],
    "priceLists": [ … ],
    "salesAreas": [ … ],
    "structureItems": [ … ],
    "bestPrices": [ … ],
    "product": { … }
  },
  "info": [
    { … }
  ],
  "warehouse": {
    "id": 0,
    "defaultName": "string",
    "isActive": true,
    "created": "2019-08-24T14:15:22Z",
    "createdBy": 0,
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": 0,
    "clientProductSkuOnHand": [ … ],
    "clientWarehouse": [ … ],
    "clientWarehouseLocation": [ … ],
    "supplierProductSkuOnHand": [ … ]
  }
}

Application

Operations

Core

Operations

Customers

Operations

Order

Operations

Products

Operations

Shopping

Operations

Metadata

Operations