Skip to main content

OrderItemInput

The input object for an order item.

input OrderItemInput {
  delete: Boolean
  discount: Decimal
  externalId: String
  id: ID
  price: Decimal
  productId: ID
  quantity: Int
  sku: String
}

Fields​

OrderItemInput.delete ● Boolean scalar common​

If this is set to true, the system will delete the order item. If this is provided, the id field must be provided as well and other fields will be ignored.

OrderItemInput.discount ● Decimal scalar common​

The discount amount for the order item.

OrderItemInput.externalId ● String scalar common​

The external ID of the order item from the source system. Used to match line items on subsequent updates from the same integration.

OrderItemInput.id ● ID scalar common​

The order item ID. If this is provided, the system will update the existing order item. If this is not provided, the system will create a new order item.

OrderItemInput.price ● Decimal scalar common​

The price of the product.

OrderItemInput.productId ● ID scalar common​

The product ID.

OrderItemInput.quantity ● Int scalar common​

The quantity of the product.

OrderItemInput.sku ● String scalar common​

The product SKU.

Member Of​

CreateDraftOrderInput input ● CreateOrderInput input ● CreatePendingOrderInput input ● SaveDraftOrderInput input ● UpdateOrderInput input ● UpdateOrderItemsInput input