PriceListClient

ClientProductSkuBestPrice

idinteger(int32)

The unique identifier of the client product sku best price.

partNostring[ 0 .. 50 ] charactersrequired

The part number.

applicationIdinteger(int32)

The application identifier.

qtyBreakinteger(int32)

The quantity break.

clientIdinteger(int32)

The client identifier.

priceListIdinteger(int32)

The price list identifier.

currencyIdinteger(int32)

The currency identifier.

priceSalenumber(decimal)

The price sale.

timeStampstring(date-time)

The time stamp.

clientProductSku(ClientProductSku (object or null))

One of:

{
  "id": 0,
  "partNo": "string",
  "applicationId": 0,
  "qtyBreak": 0,
  "clientId": 0,
  "priceListId": 0,
  "currencyId": 0,
  "priceSale": 0,
  "timeStamp": "2019-08-24T14:15:22Z",
  "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": { … }
  }
}

PriceListClient

priceListIdinteger(int32)

The price list identifier.

clientIdinteger(int32)

The client identifier.

namestring or null[ 0 .. 50 ] characters

The name of the price list client.

descriptionstring or null

The description of the price list client.

imagePathstring or null[ 0 .. 255 ] characters

The image path, not used anymore.

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 and time.

endDatestring or null(date-time)

The end date and time.

currencyIdinteger(int32)

The currency identifier.

defaultPriceRuleIdinteger or null(int32)

The default price rule. Cost plus for purchase cost (1), fixed price (2), Margin for purchase cost (3), use recommended price (4), cost plus for unit cost (5), margin for unit cost (6), use standard price with discount in percent (7), competitive price based on purchase cost (8), competitive price based on unit cost (9), use standard price with discount in nominal value (10), and use catalog price (12), lastly structure calculation rule (11) is not allowed as default price rule.

defaultPriceRuleValuenumber or null(decimal)

The default price rule value. Unit depends on the default price rule, for cost plus is represents an uplift in percent, for margin based rules it represents the margin in percent, for fixed price it represents the price (commonly 0), for use recommended price and use catalog price it represents the discount percentage, for competitive price based on purchase cost or unit cost it represents the target margin in percent, for use standard price with discount in percent it represents the discount percentage, and for use standard price with discount in nominal value it represents the nominal value.

defaultSupplementChargePercentagenumber(decimal)

The default supplement charge percentage. An additional charge added to the cost before the price rule calculation is applied. Only used when cost is a part of the price rule calculation, for example cost plus or margin based price rules, but also when minimum product margin is set.

defaultKickbackPercentagenumber or null(decimal)

The default kickback percentage, not used anymore.

defaultMinimumProductMarginPercentagenumber or null(decimal)

The default minimum product margin percentage, the calculated price is compared to the minimum margin sale price and if the calculated price is lower than the minimum margin sale price, the minimum margin sale price is used.

parentPriceListIdinteger or null(int32)

The parent price list identifier.

populationRuleIdinteger(int32)

The population rule identifier, Include (2), Exclude (4).

chosenWarehouseIdinteger or null(int32)

The chosen warehouse identifier, marked as standard in the admin tool, gets the reservations from orders on this price list.

chosenLocationIdinteger or null(int32)

The chosen location identifier, marked as standard in the admin tool, gets the reservations from orders on this price list.

isErpUpdateableboolean

Indicates whether the price list client is erp updateable, not used anymore.

isErpIntegratedboolean

Indicates whether the price list client is erp integrated, not used anymore.

isPrimaryboolean

Indicates whether the price list client is primary, can only be one primary price list per application.

isPublicboolean or null

Indicates whether the price list client is public on the application.

isLimitedToStockboolean or null

Indicates whether the price list client is limited to stock, not used anymore.

isBidboolean or null

Indicates whether the price list client is bid, not used anymore.

isStakoboolean or null

Indicates whether the price list client is stako, not used anymore.

isActiveboolean

Indicates whether the price list client is active.

stoppedDatestring or null(date-time)

The stopped date.

stoppedByinteger or null(int32)

The stopped by.

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.

imageKeystring or null(guid)

The image key, not used anymore.

typeIdinteger(int32)

The price list type identifier.

imageExtensionstring or null[ 0 .. 16 ] characters

The image extension, not used anymore.

defaultSupplementChargenumber or null(decimal)

The default supplement charge. An additional charge added to the cost before the price rule calculation is applied. Only used when cost is a part of the price rule calculation, for example cost plus or margin based price rules, but also when minimum product margin is set. Only used if DefaultSupplementChargePercentage is not set.

defaultLimitToPriceRecommendedboolean or null

Indicates whether limit to price recommended is enabled by default. Restricts the price from being higher thant the price recommended by the system, commonly used in consumer retail scenarios.

isVirtualboolean

Indicates whether the price list client is virtual.

salesAreaIdinteger or null(int32)

The sales area identifier.

inheritStructureCalculationRuleinteger(int32)

The inherit structure calculation rule, an option for deciding how structure calculation is inherited to this price list from its parent. Default the system will divide a discount proportionally between the different child items in the structure. The only other option is to apply the discount to the standard price for each item.

applicationPriceListArray of objects or null(ApplicationPriceList)

priceList(PriceList (object or null))

One of:

{
  "priceListId": 0,
  "clientId": 0,
  "name": "string",
  "description": "string",
  "imagePath": "string",
  "agreement": "string",
  "startDate": "2019-08-24T14:15:22Z",
  "endDate": "2019-08-24T14:15:22Z",
  "currencyId": 0,
  "defaultPriceRuleId": 0,
  "defaultPriceRuleValue": 0,
  "defaultSupplementChargePercentage": 0,
  "defaultKickbackPercentage": 0,
  "defaultMinimumProductMarginPercentage": 0,
  "parentPriceListId": 0,
  "populationRuleId": 0,
  "chosenWarehouseId": 0,
  "chosenLocationId": 0,
  "isErpUpdateable": true,
  "isErpIntegrated": true,
  "isPrimary": true,
  "isPublic": true,
  "isLimitedToStock": true,
  "isBid": true,
  "isStako": true,
  "isActive": true,
  "stoppedDate": "2019-08-24T14:15:22Z",
  "stoppedBy": 0,
  "created": "2019-08-24T14:15:22Z",
  "createdBy": 0,
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": 0,
  "imageKey": "string",
  "typeId": 0,
  "imageExtension": "string",
  "defaultSupplementCharge": 0,
  "defaultLimitToPriceRecommended": true,
  "isVirtual": true,
  "salesAreaId": 0,
  "inheritStructureCalculationRule": 0,
  "applicationPriceList": [
    { … }
  ],
  "priceList": {
    "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,
    "applicationPriceList": [ … ],
    "clientProductSkuPriceList": [ … ],
    "priceListClient": [ … ]
  }
}

ApplicationSalesArea

applicationIdinteger(int32)

The application identifier.

salesAreaIdinteger(int32)

The sales area identifier.

isPrimaryboolean

Indicates whether the application sales area is primary, only one primary sales area is allowed per application.

isActiveboolean

Indicates whether the application sales area 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.

clientIdinteger or null(int32)

The client identifier.

{
  "applicationId": 0,
  "salesAreaId": 0,
  "isPrimary": true,
  "isActive": true,
  "created": "2019-08-24T14:15:22Z",
  "createdBy": 0,
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": 0,
  "clientId": 0
}

Query (v1)

Schemas

ClientProductSkuBestPrice

PriceListClient

ApplicationSalesArea

Application

Core

Customers

Order

Products

Shopping

Metadata