Skip to content

Purchase offers

View as Markdown

A Purchase offer records the cost price of a Variant from a Supplier, for a given Country and validity period. Like a Sale offer it carries a taxExcludedPrice and a Tax reference, but it is the buying side: where a sale offer is what a customer pays, a purchase offer is what you pay your supplier.

Purchase offers feed cost and margin reporting, and let you track price changes from a supplier over time through their startsAt / endsAt windows.

PropertyTypeRequiredDescription
idstring-The unique identifier of the purchase offer.
statusstring-The status of the offer.
taxExcludedPriceEmbeddedMoneyResourcerequiredThe price set for the offer, excluding tax.
Show taxExcludedPrice fields
PropertyTypeRequiredDescription
amountstringrequiredThe monetary amount, as a decimal string.
currencystringrequiredThe ISO 4217 currency code (e.g. EUR).
taxExcludedPricePerUnitEmbeddedPricePerUnitResource | null-The tax-excluded price expressed per measurement reference unit.
Show taxExcludedPricePerUnit fields
PropertyTypeRequiredDescription
amountstringrequiredThe monetary amount, as a decimal string.
currencystringrequiredThe ISO 4217 currency code (e.g. EUR).
unit"ml" | "cl" | "l" | "mg" | "g" | "kg" | "mm" | "cm" | "m" | "m2" | "unit"requiredThe reference unit the amount is expressed per.
valueintegerrequiredThe number of reference units the amount applies to.
priceEmbeddedMoneyResource-The tax-included price, computed from taxExcludedPrice and the referenced Tax rate.
Show price fields
PropertyTypeRequiredDescription
amountstringrequiredThe monetary amount, as a decimal string.
currencystringrequiredThe ISO 4217 currency code (e.g. EUR).
pricePerUnitEmbeddedPricePerUnitResource | null-The tax-included price expressed per measurement reference unit.
Show pricePerUnit fields
PropertyTypeRequiredDescription
amountstringrequiredThe monetary amount, as a decimal string.
currencystringrequiredThe ISO 4217 currency code (e.g. EUR).
unit"ml" | "cl" | "l" | "mg" | "g" | "kg" | "mm" | "cm" | "m" | "m2" | "unit"requiredThe reference unit the amount is expressed per.
valueintegerrequiredThe number of reference units the amount applies to.
discountPriceEmbeddedMoneyResource | null-The discounted tax-included price, when a discount applies.
Show discountPrice fields
PropertyTypeRequiredDescription
amountstringrequiredThe monetary amount, as a decimal string.
currencystringrequiredThe ISO 4217 currency code (e.g. EUR).
discountPricePerUnitEmbeddedPricePerUnitResource | null-The discounted tax-included price per measurement reference unit, when a discount applies.
Show discountPricePerUnit fields
PropertyTypeRequiredDescription
amountstringrequiredThe monetary amount, as a decimal string.
currencystringrequiredThe ISO 4217 currency code (e.g. EUR).
unit"ml" | "cl" | "l" | "mg" | "g" | "kg" | "mm" | "cm" | "m" | "m2" | "unit"requiredThe reference unit the amount is expressed per.
valueintegerrequiredThe number of reference units the amount applies to.
discountTaxExcludedPriceEmbeddedMoneyResource | null-The discounted tax-excluded price, when a discount applies.
Show discountTaxExcludedPrice fields
PropertyTypeRequiredDescription
amountstringrequiredThe monetary amount, as a decimal string.
currencystringrequiredThe ISO 4217 currency code (e.g. EUR).
discountTaxExcludedPricePerUnitEmbeddedPricePerUnitResource | null-The discounted tax-excluded price per measurement reference unit, when a discount applies.
Show discountTaxExcludedPricePerUnit fields
PropertyTypeRequiredDescription
amountstringrequiredThe monetary amount, as a decimal string.
currencystringrequiredThe ISO 4217 currency code (e.g. EUR).
unit"ml" | "cl" | "l" | "mg" | "g" | "kg" | "mm" | "cm" | "m" | "m2" | "unit"requiredThe reference unit the amount is expressed per.
valueintegerrequiredThe number of reference units the amount applies to.
startsAtstring-Start date of the offer. Defaults to the current date/time if not provided.
endsAtstring | null-End date of the offer.
countrystringrequiredThe country resource it belongs to.
taxstringrequiredThe tax resource it belongs to.
variantstringrequiredThe variant resource it belongs to.
supplierstringrequiredThe supplier resource it belongs to.
createdAtstring-The date and time when the resource was created (ISO 8601 format).
updatedAtstring-The date and time when the resource was last modified (ISO 8601 format).
  • Record a supplier cost. Create a purchase offer for a variant with a supplier, country, tax, taxExcludedPrice and startsAt.
  • Track a cost change. Close the current offer with an endsAt and create a new one with the updated price.
  • Compare suppliers. Keep concurrent offers from different suppliers for the same variant.

All requests require an OAuth 2.0 bearer token and the organization scope header:

Authorization: Bearer <token>
X-Flowkiwi-Organization-Id: <organization-id>

PATCH uses JSON Merge Patch with Content-Type: application/merge-patch+json.