v2

latestOpenAPI 3.0.42026-08-084694591.6 MB
Item PriceBreaks

Create or update a sales price break for an item. The price break is identified by the combination of (item, customer, customer tier, currency, sales unit of measure): if a match exists it is replaced, otherwise a new price break is created. Customer and customer tier are mutually exclusive. Leaving both null upserts the item's base price.

put/api/items/{itemId}/sales-price-breaks

Path parameters

itemIdstring required

The id of the item.

Request body

customerIdstring nullable

Identifier of the customer this price break applies to. Mutually exclusive with FulcrumProduct.PublicApi.Dto.PriceBreak.SalesPriceBreakUpsertDto.CustomerTierId. Leave both null to upsert the item's base price.

customerTierIdstring nullable

Identifier of the customer tier this price break applies to. Mutually exclusive with FulcrumProduct.PublicApi.Dto.PriceBreak.SalesPriceBreakUpsertDto.CustomerId. Leave both null to upsert the item's base price.

currencyCodestring nullable

ISO 4217 currency code. Null indicates the company's primary currency. Null and the explicit primary currency code are treated as equivalent for identity matching; when matching an existing break, that break's stored CurrencyCode is preserved (legacy records may hold null even after primary is set, and downstream code distinguishes them). On insert, the value is stored exactly as supplied.

unitOfMeasureNamestring nullable

Sales unit of measure. Null indicates the item's default sales unit of measure. Same null/default-equivalence rules as FulcrumProduct.PublicApi.Dto.PriceBreak.SalesPriceBreakUpsertDto.CurrencyCode.

pricingType'price' | 'margin' required

How a sales price break is calculated.

unitPricenumber double nullable

The unit price at quantity 1. Required when FulcrumProduct.PublicApi.Dto.PriceBreak.SalesPriceBreakUpsertDto.PricingType is Price.

marginnumber double nullable

The margin percentage at quantity 1. Required when FulcrumProduct.PublicApi.Dto.PriceBreak.SalesPriceBreakUpsertDto.PricingType is Margin.

showOnPdfboolean

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

Response

The upserted price break.

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.