Skip to main content

CreateQuoteItemInput

productIdstringrequired

Id of the product, from the products list.

Example: 9d2f6b1c-8e47-4a30-b5c2-0e1f3a4b5c6d
variantIdstringrequired

Variant id, from the products list.

Example: 9d2f6b1c-8e47-4a30-b5c2-0e1f3a4b5c6d
productNamestringrequired

Name to show on the line.

Example: Sample Widget
productSkustring

Stock keeping unit to show on the line.

Example: SKU-1001
descriptionstring

Longer description to show on the line.

quantitynumberrequired

Quantity quoted. Must be greater than zero.

Example: 2
uomIdstring

Id of the unit of measure the quantity is in, from the units list.

Example: 9d2f6b1c-8e47-4a30-b5c2-0e1f3a4b5c6d
uomNamestring

Name of the unit, to show on the line.

Example: Each
unitPricenumberrequired

Unit price in the quote currency. Required.

Possible values: >= 0

Example: 12.5
salePricenumber

The variant's sale price, when it has one.

priceOverrideboolean

Set to true when unitPrice deliberately differs from the catalogue price. The user who created the key may need the price-override permission.

overrideReasonstring

Why the price was overridden.

Possible values: <= 500 characters

discountnumberrequired

Line discount, a percent or an amount according to the line's discountType. Required; use 0 for none.

Possible values: >= 0

Example: 0
discountTypestringrequired

How discount is read: as a percent or as an amount.

Possible values: [PERCENTAGE, AMOUNT]

discountAmountnumber

Line discount as an amount in the quote currency.

Possible values: >= 0

taxRatenumberrequired

Tax rate percent for the line. Required.

Example: 10
taxAmountnumberrequired

Tax on the line in the quote currency, as your system computed it. Required.

Example: 2.5
taxCalculationMethodstring

Whether the line price includes tax (INCLUSIVE) or tax is added on top (EXCLUSIVE).

Possible values: [INCLUSIVE, EXCLUSIVE]

totalPricenumber

Line total in the quote currency.

Example: 27.5
warehouseIdstring

Warehouse this line ships from.

Example: 9d2f6b1c-8e47-4a30-b5c2-0e1f3a4b5c6d
CreateQuoteItemInput
{
  "productId": "9d2f6b1c-8e47-4a30-b5c2-0e1f3a4b5c6d",
  "variantId": "9d2f6b1c-8e47-4a30-b5c2-0e1f3a4b5c6d",
  "productName": "Sample Widget",
  "productSku": "SKU-1001",
  "description": "string",
  "quantity": 2,
  "uomId": "9d2f6b1c-8e47-4a30-b5c2-0e1f3a4b5c6d",
  "uomName": "Each",
  "unitPrice": 12.5,
  "salePrice": 0,
  "priceOverride": true,
  "overrideReason": "string",
  "discount": 0,
  "discountType": "PERCENTAGE",
  "discountAmount": 0,
  "taxRate": 10,
  "taxAmount": 2.5,
  "taxCalculationMethod": "INCLUSIVE",
  "totalPrice": 27.5,
  "warehouseId": "9d2f6b1c-8e47-4a30-b5c2-0e1f3a4b5c6d"
}