LineItemMutable object

Version unstable

Represents a single line in a shopping cart.

Required access

read_orders access scope.

Fields

  • customAttributes ([Attribute!]!)

    List of additional information about the line item.

  • discountAllocations ([DiscountAllocation!]!)

    The discounts that have been allocated onto the line item by discount applications.

  • discountedTotalSet (MoneyBag!)

    The total line price after discounts are applied in shop and presentment currencies.

  • discountedUnitPriceSet (MoneyBag!)

    The price of a single variant unit after line item discounts are applied in shop and presentment currencies.

  • fulfillableQuantity (Int!)

    The total number of units to fulfill.

  • fulfillmentService (FulfillmentService!)

    Name of the service provider who fulfilled the order.

    Valid values are either manual or the name of the provider. For example, amazon, shipwire.

  • fulfillmentStatus (String!)

    The line item's fulfillment status. Returns 'fulfilled' if fulfillableQuantity >= quantity, 'partial' if fulfillableQuantity > 0, and 'unfulfilled' otherwise.

  • id (ID!)

    Globally unique identifier.

  • image (Image)

    The Image object associated to the line item's variant.

    Argument Description
    crop ( CropRegion )

    Crops the image according to the specified region. This argument is deprecated: Use crop on Image.transformedSrc instead.

    maxHeight ( Int )

    Image height in pixels between 1 and 2048. This argument is deprecated: Use maxHeight on Image.transformedSrc instead.

    maxWidth ( Int )

    Image width in pixels between 1 and 2048. This argument is deprecated: Use maxWidth on Image.transformedSrc instead.

    scale ( Int )

    Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use scale on Image.transformedSrc instead.
    Default value: 1

  • merchantEditable (Boolean!)

    Whether the line item can be edited or not.

  • name (String!)