Skip to main content

CreateSalesOrderItemInput

A line on a sales order being created.

input CreateSalesOrderItemInput {
  acceptAlternativeIfUnavailable: Boolean
  discountPercent: Float!
  inventoryUOMId: String
  notes: String
  overrideReason: String
  priceOverride: Boolean
  productId: String!
  quantity: Float!
  taxAmount: Float!
  taxBreakdown: JSON
  taxGroupId: String
  taxRate: Float!
  taxRateIds: [String!]
  unitPrice: Float
  uomId: String!
  variantId: String!
  warehouseId: String
}

Fields

`CreateSalesOrderItemInput.acceptAlternativeIfUnavailable` ● `Boolean` scalar

Whether the buyer accepts a substitute if this item is unavailable.

`CreateSalesOrderItemInput.discountPercent` ● `Float!` non-null scalar

Line discount as a percentage, from 0 to 100.

`CreateSalesOrderItemInput.inventoryUOMId` ● `String` scalar

The ID of the inventory unit of measure, used to convert the ordered quantity into stock units.

`CreateSalesOrderItemInput.notes` ● `String` scalar

Note shown on the order line.

`CreateSalesOrderItemInput.overrideReason` ● `String` scalar

Why the price was overridden.

`CreateSalesOrderItemInput.priceOverride` ● `Boolean` scalar

Set to true to keep your unitPrice instead of the resolved price. Needs the line price-override permission when pricing authority is enforced.

`CreateSalesOrderItemInput.productId` ● `String!` non-null scalar

The ID of the product. The variant decides the product, so this is accepted but the variant wins.

`CreateSalesOrderItemInput.quantity` ● `Float!` non-null scalar

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

`CreateSalesOrderItemInput.taxAmount` ● `Float!` non-null scalar

Tax amount for the line.

`CreateSalesOrderItemInput.taxBreakdown` ● `JSON` scalar

Tax split by component, as JSON.

`CreateSalesOrderItemInput.taxGroupId` ● `String` scalar

The ID of the tax group that decides the line's tax rates.

`CreateSalesOrderItemInput.taxRate` ● `Float!` non-null scalar

Tax rate applied to the line.

`CreateSalesOrderItemInput.taxRateIds` ● `[String!]` list scalar

The IDs of the tax rates to apply to the line.

`CreateSalesOrderItemInput.unitPrice` ● `Float` scalar

Price per unit. Optional: when omitted the server resolves the price itself.

`CreateSalesOrderItemInput.uomId` ● `String!` non-null scalar

The ID of the unit of measure for the quantity.

`CreateSalesOrderItemInput.variantId` ● `String!` non-null scalar

The ID of the product variant being ordered.

`CreateSalesOrderItemInput.warehouseId` ● `String` scalar

The ID of the warehouse that supplies this line.

Member Of

CreateSalesOrderInput input ● UpdateSalesOrderInput input

Fields
Member Of