Volume Discounts
volume_discount objectA quantity-based discount with tiered percentage rates.
A volume discount reduces the price once the ordered quantity reaches a tier's threshold. The customer group associations scope which customers qualify, and the product line, category, and attribute associations scope which order lines qualify; an empty list on any of them means no restriction on that dimension. Acceptable units are not a scope: they are the units the ordered quantity is measured in, and a discount with none of them never reaches a threshold above zero.
At most one volume discount is applied to a given order line: among the discounts whose scope the line matches and whose thresholds are met, those scoped to a customer group the buyer belongs to take precedence. An account price for the same line overrides the discounted price entirely.
idstringVolume discount ID.
objectstringenumValues:volume_discountResource type identifier.
namestringDisplay name of the volume discount.
Must be unique within the account.
Quantity tiers that define the discount.
Every tier whose threshold the ordered quantity reaches is applied, and their reductions compound. A discount with no tiers never changes a price.
objectstringenumValues:listResource type identifier.
page_infoobjectPagination metadata.
next_page_urlstringnullableRelative URL that fetches the next page of results.
previous_page_urlstringnullableRelative URL that fetches the previous page of results.
has_next_pagebooleanWhether more results exist after this page.
has_prev_pagebooleanWhether results exist before this page.
dataarray of volume_discount_tierResources in this page.
idstringVolume discount tier ID.
objectstringenumValues:volume_discount_tierResource type identifier.
namestringDisplay name of the tier.
discount_percentagestring (decimal)Fraction of the price taken off once the threshold is met, as a decimal string.
This is a multiplier, not a whole percent: 0.05 takes 5% off. When an order meets several tiers of the same discount, their reductions compound: meeting a 0.1 tier and a 0.2 tier multiplies the price by 0.9 × 0.8, a 28% reduction overall.
thresholdstring (decimal)Minimum ordered quantity at which this tier's discount begins to apply, as a decimal string.
The quantity compared against the threshold is the total across every line on the order that falls within the discount's scope, converted into one of the discount's acceptable units — not the quantity of a single line.
created_atstring (date-time)Creation timestamp.
updated_atstring (date-time)Last updated timestamp.
Customer groups this discount is scoped to.
When set, only customers belonging to at least one of these groups qualify; when empty, all customers qualify. A customer belongs to a group either by being assigned to it directly or through the price groups on their customer relationship.
objectstringenumValues:listResource type identifier.
page_infoobjectPagination metadata.
next_page_urlstringnullableRelative URL that fetches the next page of results.
previous_page_urlstringnullableRelative URL that fetches the previous page of results.
has_next_pagebooleanWhether more results exist after this page.
has_prev_pagebooleanWhether results exist before this page.
dataarray of account_groupResources in this page.
idstringAccount group ID.
objectstringenumValues:account_groupResource type identifier.
typestringenumValues:pricing_grouptype_groupHow this account group is used.
pricing_group: used for pricing rules, such as a "Preferred" group that receives a special discount.type_group: used to categorize accounts, such as "Consumers" or "Distributors".
A group's type is fixed when it is created and cannot be changed afterwards.
namestringDisplay name of the account group.
Unique within the account.
descriptionstringnullableFree-form description of the account group.
commission_policystringenumValues:commission_appliedcommission_exemptHow sales commission applies to accounts in this group.
commission_applied: sales commission is calculated on orders from accounts in this group.commission_exempt: orders from accounts in this group are exempt from commission.
freight_policystringenumValues:free_freightbilled_freightHow freight charges apply to orders from accounts in this group.
free_freight: customers within this group will not have to pay for freight.billed_freight: freight will be applied to any order within this account group, unless overridden elsewhere.
default_lead_time_daysintegernullableCalendar days between an order being issued and it being due to ship, inherited by every customer in this group that has neither set its own nor inherited one from a parent account.
created_atstring (date-time)Creation timestamp.
updated_atstring (date-time)Last updated timestamp.
Product lines this discount is scoped to.
When set, only items in one of these product lines qualify; when empty, all product lines qualify.
objectstringenumValues:listResource type identifier.
page_infoobjectPagination metadata.
next_page_urlstringnullableRelative URL that fetches the next page of results.
previous_page_urlstringnullableRelative URL that fetches the previous page of results.
has_next_pagebooleanWhether more results exist after this page.
has_prev_pagebooleanWhether results exist before this page.
dataarray of product_lineResources in this page.
idstringProduct line ID.
objectstringenumValues:product_lineResource type identifier.
namestringDisplay name of the product line.
Unique among the product lines visible to your account, which includes the shared system lines.
descriptionstringnullableFree-form description of the product line.
notesstringnullableFree-form notes about the product line.
commission_policystringenumValues:commission_appliedcommission_exemptDefault commission policy for products in this product line.
commission_exempt: no commission applies to these products.commission_applied: commission applies to these products, unless overridden elsewhere.
freight_policystringenumValues:free_freightbilled_freightDefault freight policy for products in this product line.
free_freight: these products do not incur a freight charge.billed_freight: freight is billed for these products, unless overridden elsewhere.
ownerownernullableOwner of the product line.
System-owned product lines are platform-provided and shared across all accounts; account-owned product lines are custom to your account. Only account-owned product lines can be updated, deleted, or granted to customers and account groups.
null in this endpoint.Unit group associated with this product line.
The unit group determines the set of units available to products in this product line.
null in this endpoint.default_lotquantitynullableThe lot products in this line are made in — a doff, a pallet.
Sizes the campaigns a production schedule plans, and defaults the quantity when a batch is added to a production run. The unit is part of the value — 60 counted in pairs and 60 counted in eaches are different lots — and is drawn from this product line's unit group.
An item's own lot override still takes precedence over the line's. When the line has no lot convention, planning falls back to the lot of the line the item feeds into, and then to the account-wide default lot size.
null in this endpoint.fulfillment_policystringnullableenumValues:make_to_stockmake_to_orderHow products in this line are produced when they do not say for themselves.
make_to_stock: built to the forecast, holding a safety stock against its variability.make_to_order: built only against orders already on the book, holding no buffer.
Null falls through to the account default.
created_atstring (date-time)Creation timestamp.
updated_atstring (date-time)Last-updated timestamp.
Item categories this discount is scoped to.
When set, only items in one of these categories qualify; when empty, all categories qualify.
objectstringenumValues:listResource type identifier.
page_infoobjectPagination metadata.
next_page_urlstringnullableRelative URL that fetches the next page of results.
previous_page_urlstringnullableRelative URL that fetches the previous page of results.
has_next_pagebooleanWhether more results exist after this page.
has_prev_pagebooleanWhether results exist before this page.
dataarray of item_categoryResources in this page.
idstringItem category ID.
objectstringenumValues:item_categoryResource type identifier.
namestringDisplay name of the item category.
notesstringnullableFree-form notes about the item category.
typestringenumValues:material_categoryproduct_categoryWhat kind of items this category groups.
material_category: groups raw materials and components (items of typematerial).product_category: groups finished products and parts (items of typeproductorpart).
An item can only be assigned to a category whose type matches the item's type, and the category's type is fixed at creation.
ownerownernullableProvenance of the item category.
System-owned categories are platform-provided defaults shared across all accounts and cannot be updated or deleted; account-owned categories are custom to your account.
null in this endpoint.Properties associated with this item category, such as Color or Size.
These describe the dimensions along which items in the category vary, and are also what the customer-facing catalog shows for the category. Attach and detach them with the Add Item Category Property and Remove Item Category Property endpoints.
null in this endpoint.Unit group associated with this item category.
Items in this category are measured in units belonging to this group, and can only be ordered in those units unless the item's product line defines its own unit group, which takes precedence.
null in this endpoint.created_atstring (date-time)Creation timestamp.
updated_atstring (date-time)Last updated timestamp.
Attributes this discount is scoped to.
When set, an item qualifies only if it has every listed attribute; when empty, attributes are not considered.
objectstringenumValues:listResource type identifier.
page_infoobjectPagination metadata.
next_page_urlstringnullableRelative URL that fetches the next page of results.
previous_page_urlstringnullableRelative URL that fetches the previous page of results.
has_next_pagebooleanWhether more results exist after this page.
has_prev_pagebooleanWhether results exist before this page.
dataarray of attributeResources in this page.
idstringAttribute ID.
objectstringenumValues:attributeResource type identifier.
valuestringThe selectable value this attribute represents, such as Red for a Color property or Large for a Size property.
colorstringenumValues:bluebrowndefaultSwatch color used to display this attribute in the UI.
The named colors are arbitrary display choices; default is a neutral fallback used when no specific swatch applies.
sort_orderintegerPosition of this attribute relative to its siblings within the property, starting at 1.
Positions are kept contiguous: creating, reordering, or deleting an attribute automatically shifts its siblings.
The property this attribute belongs to.
Populated only when the attribute is returned under an item's or a volume discount's attributes list.
null in this endpoint.created_atstring (date-time)Creation timestamp.
updated_atstring (date-time)Last update timestamp.
Units that ordered quantities are measured in when evaluating tier thresholds.
Quantities ordered in other units are converted to an acceptable unit before being compared against tier thresholds; a quantity that cannot be converted contributes nothing. A discount with no acceptable units always evaluates to a quantity of zero, so it never reaches a threshold above zero.
objectstringenumValues:listResource type identifier.
page_infoobjectPagination metadata.
next_page_urlstringnullableRelative URL that fetches the next page of results.
previous_page_urlstringnullableRelative URL that fetches the previous page of results.
has_next_pagebooleanWhether more results exist after this page.
has_prev_pagebooleanWhether results exist before this page.
dataarray of unitResources in this page.
idstringUnit ID.
objectstringenumValues:unitResource type identifier.
namestringDisplay name of the unit (e.g. "Gram", "Kilogram").
abbreviationstringShort abbreviation for the unit (e.g. "g", "kg").
typestringenumValues:currencyquantitytimeThe dimension this unit measures, such as mass, volume, or currency.
A unit can only be converted to another unit of the same dimension. The quantity dimension is for discrete countable items rather than a physical measure.
ratio_numeratorstring (decimal)Numerator of the ratio that converts a quantity in this unit into the dimension's base unit.
A quantity is converted with value × (ratio_numerator / ratio_denominator) + (offset_numerator / offset_denominator), so a kilogram in a gram-based dimension has a numerator of 1000 and a denominator of 1.
ratio_denominatorstring (decimal)Denominator of the ratio that converts a quantity in this unit into the dimension's base unit.
Cannot be zero.
offset_numeratorstring (decimal)Numerator of the conversion offset, applied after the ratio for scales that do not share a zero point, such as temperature.
Zero for units that convert by ratio alone.
offset_denominatorstring (decimal)Denominator of the conversion offset applied after the ratio.
Never zero; a unit with no offset carries a numerator of 0 over a denominator of 1.
is_base_unitbooleanWhether this is the base unit for its dimension.
Every other unit's conversion ratio is expressed relative to the base unit. Base units are platform-defined; units created through the API are never base units.
ownerownernullableOwner of this resource.
null in this endpoint.created_atstring (date-time)When this unit was created.
updated_atstring (date-time)When this unit was last updated.
created_atstring (date-time)Creation timestamp.
updated_atstring (date-time)Last updated timestamp.