This endpoint allows the retrieval of all line items on an order using helpful search parameters, with results being returned in paginated form. Order line items are categorized through a type field. Here are type field definitions that may be helpful:
contract - An extended warranty contract has been or will be created from the order line item. This is determined by receiving a Plan ID and Product and will trigger an extended warranty contract to be created.
lead - A lead contract has been created from the order line item. This is determined by receiving no Plan ID on a warrantable Product and will trigger a lead contract to be created.
shipments - A shipping protection contract has been created from the order line item. This is determined by receiving Shipment Info and a Quote ID and will trigger a shipping protection contract to be created.
non_warrantable - The order line item could not be categorized as a contract, lead, or shipments line item type. This is determined by receiving a non-warrantable product.
Order line items can track the delivery status of a product. Here are delivery status definitions that may be helpful:
awaiting_shipment - The product associated to the order line item has not been shipped yet.
shipped - The product associated to the order line item has been shipped.
Order line items also have a status that provides helpful high level insights.
status (at the line item level)
canceled - The order line item has been canceled. When a line item is canceled, this will trigger a cancellation of an associated Extend contract on the line item.
cancel_failed - The attempt to cancel the order line item has failed. This is typically due to logic in Extend’s system preventing the cancelation (e.g. attempt to cancel a line item when there is an associated shipment).
contract_failed - The attempt to create an Extend contract from the order line item has failed. This is typically due to expected fields or values being invalid or incorrect on the order line item, specifically at the product, plan, or offers level.
contract_pending - A contract that will be created from the order line item is pending a wait period provided on the order.
fulfilled - The product on the order line item has been fulfilled (e.g. product is available or will be made available to the customer). Once an order line item is in the fulfilled status, any associated Extend contract to the line item will be created.
lead_failed - The attempt to create an Extend lead contract from the order line item has failed. This is typically due to expected fields or values being invalid or incorrect on the order line item.
quote_failed - The attempt to create a shipping protection contract from the order line item has failed. This is typically due to expected fields or values being invalid or incorrect on the order line item.
pending - An order line item that has been created where the order has a wait period value. This is typically used to create an order that requires a certain time period to pass before it is considered a valid order.
refunded - A successful refund has been made by the merchant to the customer on the order line item.
unfulfilled - An order line item has been created but the product associated has not been fulfilled yet.