Skip to main content

CreateSalesOrderItemInput

productIdstringrequired

Id of the product the variant belongs to. An empty string lets the server take it from the variant; a product that does not match the variant is refused.

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

Variant id, from the products list.

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

Warehouse this line ships from.

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

Quantity ordered, in the unit given by uomId. Must be greater than zero.

Example: 2
unitPricenumber

Unit price in the order currency. Leave it off to use the catalogue price. A price you send can be refused, depending on the workspace's pricing settings and the permissions of the user who created the key.

Example: 12.5
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

taxRatenumber

Tax rate percent for the line, used in place of the product's configured tax.

Example: 10
discountPercentnumber

Line discount, from 0 to 100 percent.

Possible values: >= 0 and <= 100

Example: 0
notesstring

Notes on the line.

uomIdstring<uuid>required

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

Example: 9d2f6b1c-8e47-4a30-b5c2-0e1f3a4b5c6d
taxGroupIdstring<uuid>

Tax group to use for the line, in place of the product's configured tax.

Example: 9d2f6b1c-8e47-4a30-b5c2-0e1f3a4b5c6d
CreateSalesOrderItemInput
{
  "productId": "9d2f6b1c-8e47-4a30-b5c2-0e1f3a4b5c6d",
  "variantId": "9d2f6b1c-8e47-4a30-b5c2-0e1f3a4b5c6d",
  "warehouseId": "9d2f6b1c-8e47-4a30-b5c2-0e1f3a4b5c6d",
  "quantity": 2,
  "unitPrice": 12.5,
  "priceOverride": true,
  "overrideReason": "string",
  "taxRate": 10,
  "discountPercent": 0,
  "notes": "string",
  "uomId": "9d2f6b1c-8e47-4a30-b5c2-0e1f3a4b5c6d",
  "taxGroupId": "9d2f6b1c-8e47-4a30-b5c2-0e1f3a4b5c6d"
}