OrderCreateLineItemInput - admin-graphql - INPUT_OBJECT

Version: 2024-10

Description:

The input fields for a line item to create for an order.

Access Scopes

Fields

  • fulfillmentService: String - The handle of a fulfillment service that stocks the product variant belonging to a line item. This is a third-party fulfillment service in the following scenarios: **Scenario 1** - The product variant is stocked by a single fulfillment service. - The [FulfillmentService](/api/admin-graphql/latest/objects/FulfillmentService) is a third-party fulfillment service. Third-party fulfillment services don't have a handle with the value `manual`. **Scenario 2** - Multiple fulfillment services stock the product variant. - The last time that the line item was unfulfilled, it was awaiting fulfillment by a third-party fulfillment service. Third-party fulfillment services don't have a handle with the value `manual`. If none of the above conditions are met, then the fulfillment service has the `manual` handle.
  • giftCard: Boolean - Whether the item is a gift card. If true, then the item is not taxed or considered for shipping charges.
  • priceSet: MoneyBagInput - The price of the item before discounts have been applied in the shop currency.
  • productId: ID - The ID of the product that the line item belongs to. Can be `null` if the original product associated with the order is deleted at a later date.
  • properties: OrderCreateLineItemPropertyInput - An array of custom information for the item that has been added to the cart. Often used to provide product customization options.
  • quantity: Int! - The number of items that were purchased.
  • requiresShipping: Boolean - Whether the item requires shipping.
  • sku: String - The item's SKU (stock keeping unit).
  • taxLines: OrderCreateTaxLineInput - A list of tax line objects, each of which details a tax applied to the item.
  • taxable: Boolean - Whether the item was taxable.
  • title: String - The title of the product.
  • variantId: ID - The ID of the product variant. If both `productId` and `variantId` are provided, then the product ID that corresponds to the `variantId` is used.
  • variantTitle: String - The title of the product variant.
  • vendor: String - The name of the item's supplier.

Input objects with this input object

  • OrderCreateOrderInput

Examples