FUfulcrumpro
Item PriceBreaks

List sales price breaks for an item, including the item's base price, customer-specific price breaks, and customer-tier price breaks.

Changed on
post/api/items/{itemId}/sales-price-breaks/list

Request

  • Base URL
    https://api.fulcrumpro.com
  • URL
    https://api.fulcrumpro.com/api/items/{itemId}/sales-price-breaks/list
  • Auth
    none declared

Path parameters

itemIdstring required

The id of the item.

Request body

customerIdstring nullable

Restrict to price breaks for the given customer.

customerTierIdstring nullable

Restrict to price breaks for the given customer tier.

currencyCodestring nullable

Restrict to price breaks in the given currency.

baseOnlyboolean nullable

When true, include only the item's base price (no customer or customer tier).

Response

List of sales price breaks for the given item.

idstring required

Identifier of the price break.

itemIdstring required

Identifier of the item this price break applies to.

customerIdstring nullable

Identifier of the customer this price break applies to. Mutually exclusive with FulcrumProduct.PublicApi.Dto.PriceBreak.SalesPriceBreakDto.CustomerTierId; null on both means this is the item's base price.

customerTierIdstring nullable

Identifier of the customer tier this price break applies to. Mutually exclusive with FulcrumProduct.PublicApi.Dto.PriceBreak.SalesPriceBreakDto.CustomerId; null on both means this is the item's base price.

currencyCodestring nullable

ISO 4217 currency code. Null indicates the company's primary currency.

unitOfMeasureNamestring nullable

Sales unit of measure for this price break. Null indicates the item's default sales unit of measure.

pricingType'price' | 'margin' required

How a sales price break is calculated.

unitPricenumber double nullable

The unit price at quantity 1. Populated when FulcrumProduct.PublicApi.Dto.PriceBreak.SalesPriceBreakDto.PricingType is Price.

marginnumber double nullable

The margin percentage applied at quantity 1. Populated when FulcrumProduct.PublicApi.Dto.PriceBreak.SalesPriceBreakDto.PricingType is Margin.

showOnPdfboolean

Whether the unit/base price should be displayed on customer-facing PDFs.

modifiedUtcstring date-time

When this price break was last modified.

Changes