COMMERCE QUERY
/
Query API 3.0
/
Schemas
/
PriceList

Commerce Query API (v3.0)

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
Playground

https://{slug}.api-se.playground.norce.tech/commerce/query/3.0/

Stage

https://{slug}.api-se.stage.norce.tech/commerce/query/3.0/

Production

https://{slug}.api-se.norce.tech/commerce/query/3.0/

Schemas

PriceListTypeCulture

typeIdinteger(int32)

The price list type identifier.

cultureCodestring or null[ 0 .. 16 ] characters

The culture code.

namestring or null[ 0 .. 50 ] characters

The localized name of the price list type.

descriptionstring or null[ 0 .. 500 ] characters

The localized description of the price list type.

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.

{
  "typeId": 0,
  "cultureCode": "string",
  "name": "string",
  "description": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": 0
}

PriceList

idinteger(int32)

The unique identifier of the price list.

defaultNamestring[ 0 .. 50 ] charactersrequired

The default name of the price list.

defaultDescriptionstring or null

The default description of the price list.

agreementstring or null[ 0 .. 50 ] characters

The agreement, called Code in the admin tool, and in connect.

startDatestring or null(date-time)

The start date, not used see start date in PriceListClient.

endDatestring or null(date-time)

The end date, not used see end date in PriceListClient.

isPublicboolean

Indicates whether the price list is public, not used see IsPublic in PriceListClient.

isLimitedToStockboolean

Indicates whether the price list is limited to stock, not used see IsLimitedToStock in PriceListClient.

isBidboolean

Indicates whether the price list is bid, not used see IsBid in PriceListClient.

isStakoboolean

Indicates whether the price list is stako, not used see IsStako in PriceListClient.

isActiveboolean

Indicates whether the price list is active, commonly always set, see IsActive in PriceListClient.

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.

{
  "id": 0,
  "defaultName": "string",
  "defaultDescription": "string",
  "agreement": "string",
  "startDate": "2019-08-24T14:15:22Z",
  "endDate": "2019-08-24T14:15:22Z",
  "isPublic": true,
  "isLimitedToStock": true,
  "isBid": true,
  "isStako": true,
  "isActive": true,
  "created": "2019-08-24T14:15:22Z",
  "createdBy": 0,
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": 0
}

ClientProductSkuPriceList

partNostring or null[ 0 .. 50 ] characters

The part number.

priceListIdinteger(int32)

The price list identifier.

qtyBreakinteger(int32)

The quantity break, default is 1.

currencyIdinteger(int32)

The currency identifier.

priceSalenumber(decimal)

The price sale, calculated based on the fields in this record, depending on the price rule.

priceSaleLastUpdatedstring or null(date-time)

The price sale last updated.

priceSaleLastUpdatedByinteger or null(int32)

The price sale last updated by.

priceRuleIdinteger or null(int32)

The price rule identifier.

priceRuleValuenumber or null(decimal)

The price rule value, depending on the price rule can contain like margin or uplift in percent, discount in percent or fixed amount, null when fixed price rule.

costPurchasenumber(decimal)

The cost purchase.

costPurchaseLastUpdatedstring or null(date-time)

The cost purchase last updated.

costPurchaseLastUpdatedByinteger or null(int32)

The cost purchase last updated by.

costUnitnumber(decimal)

The cost unit.

costUnitLastUpdatedstring or null(date-time)

The cost unit last updated.

costUnitLastUpdatedByinteger or null(int32)

The cost unit last updated by.

supplementChargePercentagenumber or null(decimal)

The supplement charge percentage.

priceStandardnumber or null(decimal)

The price standard, inherited from the parent price list record, otherwise null.

priceRecommendednumber or null(decimal)

The price recommended.

priceRecommendedLastUpdatedstring or null(date-time)

The price recommended last updated.

priceRecommendedLastUpdatedByinteger or null(int32)

The price recommended last updated by.

pricePreviousnumber or null(decimal)

The price previous, can contain historical best price, if functionality is enabled for the client.

pricePreviousLastUpdatedstring or null(date-time)

The price previous last updated.

pricePreviousLastUpdatedByinteger or null(int32)

The price previous last updated by.

priceCatalognumber or null(decimal)

The price catalog.

priceCatalogLastUpdatedstring or null(date-time)

The price catalog last updated.

priceCatalogLastUpdatedByinteger or null(int32)

The price catalog last updated by.

isPriceDiscountableboolean

Indicates whether the client product sku price list is price discountable by promotions.

chosenSupplierIdinteger or null(int32)

The chosen supplier identifier.

chosenSupplierPartNostring or null[ 0 .. 50 ] characters

The chosen supplier part number.

chosenSupplierPriceListIdinteger or null(int32)

The chosen supplier price list identifier.

chosenSupplierQtyBreakinteger or null(int32)

The chosen supplier quantity break.

isChosenSupplierLockedboolean

Indicates whether the client product sku price list is chosen supplier locked, not used anymore.

isActiveboolean

Indicates whether the client product sku price list 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.

lastCheckedstring or null(date-time)

The last checked.

minimumMarginPercentagenumber or null(decimal)

The minimum margin percentage.

priceRuleLastUpdatedstring or null(date-time)

The price rule last updated.

priceRuleLastUpdatedByinteger or null(int32)

The price rule last updated by.

pricingIdinteger or null(int32)

The pricing identifier, not used anymore.

supplementChargenumber or null(decimal)

The supplement charge.

limitToPriceRecommendedboolean or null

Indicates whether limit to price recommended is enabled.

isActiveLastUpdatedstring or null(date-time)

The is active last updated.

isActiveLastUpdatedByinteger or null(int32)

The is active last updated by.

sku(ClientProductSku (object or null))
One of:
infoArray of objects or null(ClientProductSkuPriceListInfo)
{
  "partNo": "string",
  "priceListId": 0,
  "qtyBreak": 0,
  "currencyId": 0,
  "priceSale": 0,
  "priceSaleLastUpdated": "2019-08-24T14:15:22Z",
  "priceSaleLastUpdatedBy": 0,
  "priceRuleId": 0,
  "priceRuleValue": 0,
  "costPurchase": 0,
  "costPurchaseLastUpdated": "2019-08-24T14:15:22Z",
  "costPurchaseLastUpdatedBy": 0,
  "costUnit": 0,
  "costUnitLastUpdated": "2019-08-24T14:15:22Z",
  "costUnitLastUpdatedBy": 0,
  "supplementChargePercentage": 0,
  "priceStandard": 0,
  "priceRecommended": 0,
  "priceRecommendedLastUpdated": "2019-08-24T14:15:22Z",
  "priceRecommendedLastUpdatedBy": 0,
  "pricePrevious": 0,
  "pricePreviousLastUpdated": "2019-08-24T14:15:22Z",
  "pricePreviousLastUpdatedBy": 0,
  "priceCatalog": 0,
  "priceCatalogLastUpdated": "2019-08-24T14:15:22Z",
  "priceCatalogLastUpdatedBy": 0,
  "isPriceDiscountable": true,
  "chosenSupplierId": 0,
  "chosenSupplierPartNo": "string",
  "chosenSupplierPriceListId": 0,
  "chosenSupplierQtyBreak": 0,
  "isChosenSupplierLocked": 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,
  "lastChecked": "2019-08-24T14:15:22Z",
  "minimumMarginPercentage": 0,
  "priceRuleLastUpdated": "2019-08-24T14:15:22Z",
  "priceRuleLastUpdatedBy": 0,
  "pricingId": 0,
  "supplementCharge": 0,
  "limitToPriceRecommended": true,
  "isActiveLastUpdated": "2019-08-24T14:15:22Z",
  "isActiveLastUpdatedBy": 0,
  "sku": {
    "partNo": "string",
    "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": [ … ],
    "product": { … },
    "bestPrices": [ … ]
  },
  "info": [
    { … }
  ]
}

Application

Operations

Core

Operations

Customers

Operations

Order

Operations

Products

Operations

Shopping

Operations

Metadata

Operations