input CreateLineItemInput
Fields
| Field | Type | Description |
|---|---|---|
sku | String! | SKU. SKU matching is case-insensitive and ignores surrounding whitespace. |
partner_line_item_id | String! | External line item identifier from the store or upstream system; unique across the order's line items and preferably across the store. |
quantity | Int! | Quantity as a whole-unit count. |
price | String! | Customer-facing charge amount as a decimal monetary value in the order currency; distinct from value/customs_value used for declared value. |
product_name | String | Product name for this line item. |
option_title | String | Option title for this line item. |
fulfillment_status | String | Current fulfillment status; use the API status values returned by this field when filtering or updating. |
quantity_pending_fulfillment | Int | Quantity pending fulfillment as a whole-unit count. |
custom_options | GenericScalar | Arbitrary JSON custom options for the line item; stored as name/value pairs when possible. |
custom_barcode | String | Barcode value for the line item. |
eligible_for_return | Boolean | Whether this line item is eligible to be returned. |
customs_value | String | Declared customs value as a decimal monetary amount; distinct from line-item price. |
barcode | String | Barcode value for the line item. |
warehouse_id | String | Set to lock to that warehouse. The item will not be moved in any multi-warehouse processing. |
Referenced By
- AddLineItemsInput Type
- CreateOrderInput Type
Example
{
"sku": "BLUE-TEE-M",
"partner_line_item_id": "SHOPIFY-LINE-1",
"quantity": 2,
"price": "19.99",
"product_name": "Blue Tee",
"option_title": "Size: Medium",
"fulfillment_status": "pending",
"quantity_pending_fulfillment": 2,
"custom_options": {"reference_id": "REF-100045", "notes": "Fragile"},
"custom_barcode": "012345678905",
"eligible_for_return": true,
"customs_value": "19.99",
"barcode": "012345678905",
"warehouse_id": "V2FyZWhvdXNlOjEyMzQ="
}