/v1/workspaces/{workspace_id}/data/line

string

required

length ≥ 1

The ID of the line item.

order_id

string | null

The ID of the order.

cost

string | null

The per-line cost of goods sold (COGS) for the line item. Currency is implied by the order-level currency.

fulfillable_quantity

number | null

The number of items from the line item that have been fulfilled.

fulfillment_service

string | null

The fulfillment service for the vartiant associated with the line item.

fulfillment_status

string | null

The fulfillment status of the checkout.

gift_card

boolean | null

Represents an issued gift card.

inventory_item_id

string | null

The ID of the inventory item associated with the line item. Optional; lets non-Shopify shops carry the inventory item identifier even when it equals variant_id.

name

string | null

The name of the product associated.

price

string | null

The price of the product associated.

product_exists

boolean | null

Whether the product exists.

product_id

string | null

The ID of the line item's product.

properties

array of objects or null | null

The properties of the line item.

properties

quantity

number | null

The quantity of the line item.

requires_shipping

boolean | null

Whether the product requires shipping.

sku

string | null

The sku of the variant associated with the line item.

taxable

boolean | null

Whether the product is taxable.

title

string | null

The title of the line item.

total_discount

string | null

The total amount, in the currency's subunit, of any discounts applied to the line item.

variant_id

string | null

The ID of the line item's variant.

variant_inventory_management

string | null

The inventory management service of the variant.

variant_title

string | null

A concatenation of each variant option, separated by a /

vendor

string | null

The vendor of the variant associated with the line item.

additional_fields

array of objects | null

Extra properties.

additional_fields

201Default Response