An line item report, when returned from the API have the following fields

Field Name Type Description Example value
line_item_name string “French Fries”
line_item_id string(UUID) Unique identifier of the line item de1e3597-b0a0-48a8-8b40-2daf500645ac
quantity int Quantity of the item "Main Inventory Store”
purchased_with_loyalty_points bool Indicates if the line item was purchased using reward points false
loyalty_points_were_awarded bool Indicates if loyalty points were awarded for the purchase false
item item record (see table below) Metadata about the line item `{
"item_id": "70c3b3a8-b1ad-11eb-aaf8-efa7fd3f6d36",
"price": 700,
"sales_tax_basis_points": 600,
"loyalty_reward_amount": 0,
"loyalty_redeem_price": 0
}`

Item Record

An item record has the following fields:

Field Name Type Description Example value
line_item_name string “French Fries”
item_id string(UUID) Unique identifier of the inventory stor de1e3597-b0a0-48a8-8b40-2daf500645ac
price int Price in centavos/cents 1250
sales_tax_basis_points int Sales tax percentage expressed in basis points. Example, 8.5% sales tax is returned as 850 850
loyalty_reward_amount int If the loyalty_points_were_awarded is true, this is the number of loyalty points awarded per quantity . 10
loyalty_redeem_price int If the purchased_with_loyalty_points is true, this is the number of loyalty points redeemed per quantity. 100