Purchase Rates
Purchase Rates API.
A purchase rate is the cost and the purchasing terms of a product from one of its suppliers. A product has at most one purchase rate per supplier, and the supplier of one of them can be the primary supplier of the product.
List Purchase Rates
List the purchase rates of the products that are not archived, newest first.
query Parameters
contactsSupplier ids separated by comma.
cursorThe pagination cursor value.
idsPurchase rate ids separated by comma.
limitNumber of results to return per page.
productsProduct ids separated by comma.
List Purchase Rates › Responses
nextpreviousCreate Purchase Rate
Add a supplier to a product by creating its purchase rate, with a cost and shipping cost of 0, a pack size and minimum order quantity of 1 and no tax. Set its values afterwards with the update.
When the product already has a purchase rate from the supplier, it is returned unchanged. The supplier becomes the primary supplier of the product when it has none.
Create Purchase Rate › Request Body
product_idId of the product, which must not be archived.
contact_idId of the supplier.
Create Purchase Rate › Responses
idproduct_idId of the product.
contact_idId of the supplier.
tax_idId of the tax the supplier charges, which purchase order lines take. Null when there is none.
cost_basisPer Pack when the pack size is more than 1, and the costs are per pack, otherwise Per Unit.
cost^-?\d{0,10}(?:\.\d{0… · requiredCost of the product. When the pack size is greater than 1, we consider the cost to be cost per pack. For example, if the pack size is 10 and the cost value stored is 150 the actual cost per unit would be 15.
shipping_cost^-?\d{0,10}(?:\.\d{0… · requiredShipping cost of the product. The cost basis logic is applicable here too as it is for the cost per unit field.
supplier_skuThe supplier's own SKU of the product.
pack_sizeUnits per pack. The costs are per pack when it is more than 1.
moqMinimum order quantity.
uomUnit of measure, such as kg.
notesNotes about the supplier's terms for the product.
Update Purchase Rate
Update the cost and the purchasing terms of a purchase rate. A value left out keeps the saved one, and a null
tax_id clears the tax.
The supplier becomes the primary supplier of the product when it has none.
path Parameters
purchase_rate_idUpdate Purchase Rate › Request Body
cost^-?\d{0,10}(?:\.\d{0…Cost of the product. When the pack size is greater than 1, we consider the cost to be cost per pack. For example, if the pack size is 10 and the cost value stored is 150 the actual cost per unit would be 15.
shipping_cost^-?\d{0,10}(?:\.\d{0…Shipping cost of the product. The cost basis logic is applicable here too as it is for the cost per unit field.
supplier_skuThe supplier's own SKU of the product.
pack_sizeUnits per pack. The costs are per pack when it is more than 1.
moqMinimum order quantity.
tax_idId of a tax. Null clears the tax.
uomUnit of measure, such as kg.
notesNotes about the supplier's terms for the product.
Update Purchase Rate › Responses
idproduct_idId of the product.
contact_idId of the supplier.
tax_idId of the tax the supplier charges, which purchase order lines take. Null when there is none.
cost_basisPer Pack when the pack size is more than 1, and the costs are per pack, otherwise Per Unit.
cost^-?\d{0,10}(?:\.\d{0… · requiredCost of the product. When the pack size is greater than 1, we consider the cost to be cost per pack. For example, if the pack size is 10 and the cost value stored is 150 the actual cost per unit would be 15.
shipping_cost^-?\d{0,10}(?:\.\d{0… · requiredShipping cost of the product. The cost basis logic is applicable here too as it is for the cost per unit field.
supplier_skuThe supplier's own SKU of the product.
pack_sizeUnits per pack. The costs are per pack when it is more than 1.
moqMinimum order quantity.
uomUnit of measure, such as kg.
notesNotes about the supplier's terms for the product.