COMMERCE QUERY

Query API 3.0

ClientProductSkuOnHandInfo

Query (v1)

Download OpenAPI description

openapi.json

openapi.yaml

Servers

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

Schemas

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": [ … ]
  }
}

ClientProductSkuOnHandInfo

idinteger(int64)

The unique identifier of the client product sku on hand info type.

partNostring[ 0 .. 50 ] charactersrequired

The part number.

clientIdinteger(int32)

The client identifier.

warehouseIdinteger(int32)

The warehouse identifier.

locationIdinteger(int32)

The location identifier.

typeIdinteger(int32)

The type identifier.

valuestring[ 0 .. 255 ] charactersrequired

The value.

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.

clientProductSkuOnHand(ClientProductSkuOnHand (object or null))

One of:

type(ProductInfoType (object or null))

One of:

{
  "id": 0,
  "partNo": "string",
  "clientId": 0,
  "warehouseId": 0,
  "locationId": 0,
  "typeId": 0,
  "value": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": 0,
  "clientProductSkuOnHand": {
    "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": { … },
    "info": [ … ],
    "warehouse": { … }
  },
  "type": {
    "id": 0,
    "clientId": 0,
    "groupId": 0,
    "defaultName": "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",
    "clientProductSkuOnHandInfo": [ … ],
    "clientProductSkuPriceListInfo": [ … ],
    "cultures": [ … ]
  }
}

ProductInfoType

idinteger(int32)

The unique identifier of the product info type.

clientIdinteger(int32)

The client identifier.

groupIdinteger(int32)

The info type group identifier, OnHandInfo (2), PriceListInfo (3).

defaultNamestring[ 0 .. 50 ] charactersrequired

The default name of the product info type.

defaultDescriptionstring or null[ 0 .. 500 ] characters

The default description of the product info type.

sortOrderinteger(int32)

The sort order for display purposes.

isActiveboolean

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

clientProductSkuOnHandInfoArray of objects or null(ClientProductSkuOnHandInfo)

clientProductSkuPriceListInfoArray of objects or null(ClientProductSkuPriceListInfo)

culturesArray of objects or null(ProductInfoTypeCulture)

{
  "id": 0,
  "clientId": 0,
  "groupId": 0,
  "defaultName": "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",
  "clientProductSkuOnHandInfo": [
    { … }
  ],
  "clientProductSkuPriceListInfo": [
    { … }
  ],
  "cultures": [
    { … }
  ]
}

Application

Operations

Core

Operations

Customers

Operations

Order

Operations

Products

Operations

Shopping

Operations

Metadata

Operations