--- title: "Search Line Items" method: GET path: "/line-items/search" tags: ["Line Items"] --- # Search Line Items `GET /line-items/search` 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. ## Query parameters - `transactionId` string - `lineItemTransactionId` string, uuid - `status` 'fulfilled' | 'unfulfilled' | 'contract_failed' | 'contract_pending' | 'canceled' | 'cancel_failed' | 'lead_failed' | 'pending' | 'refunded' - `cursor` string - `limit` string ## Headers - `Content-Type` string, required - `X-Extend-Access-Token` string, required - `Accept` string, required ## Response `200` Successful line items search. - object - `nextPageCursor` string — Cursor used to retrieve the next page of results, which should be provided in the search response (if applicable). - `limit` integer — The maximum number of items to search and filter through for results. - `lineItems` union[] - union - object — Line item model required to create an Extended Warranty contract. - `type` 'contract', required - `contractId` string — Unique identifier associating a generated contract to a line item. This field can be optionally generated by the merchant as a GUID. NOTE: You must be an approved merchant to send a unique identifier for Extend contracts. Please reach out to your merchant success manager for more details. - `lineItemTransactionId` string — Unique identifier provided by the merchant for querying. - `offerId` string — Unique identifier of the offer made for a product or cart identifier for the order line item. This will be be used for analytics like AB testing experiments. - `offerPlanId` string — Unique identifier for the offer used for a contract. - `plan` object, required — Information about the plan being purchased. - `id` string, required — Unique identifier for Extend plan. - `purchasePrice` integer, required — Purchase price of the Extend contract purchased.

Amount should be expressed in terms of the smallest currency unit. - `termsId` string — Unique identifier for the terms associated to the Extend plan. - `termsVersion` string — Version number for the terms associated to the Extend plan. - `version` string — Version number for the Extend plan. - `product` object - `deliveryStatus` 'awaiting_shipment' | 'shipped' — Various shipping statuses - `id` string, required — Unique ID of product created in Extend during product catalog mapping. - `purchasePrice` integer, required — Price paid for the product by the customer.

Amount should be expressed in terms of the smallest currency unit. - `serialNumber` string — Merchant-assigned product serial number. - `purchaseDate` integer — Purchase date of the original product (10 or 13 digit timestamp). - `fulfillmentDate` integer — Fulfillment date of the product (10 or 13 digit timestamp). - `listPrice` integer — Original list price of the product (before any discounts). - `name` string — Name of product given by the merchant. - `mfrWarranty` object — Manufacturer warranty information. - `parts` integer — manufacturer warranty parts in months - `labor` integer — manufacturer warranty labor in months - `url` string — manufacturer warranty URL - `parentReferenceId` string — The parent reference ID of the product. - `leadToken` string — Unique identifier for the lead associated to a line item. - `id` string, required — Unique identifier for line item in Extend's system. - `accountId` string, required — Unique identifier for the account associated with the order line item creation. - `status` 'canceled' | 'cancel_failed' | 'contract_failed' | 'contract_pending' | 'fulfilled' | 'lead_failed' | 'quote_failed' | 'pending' | 'refunded' | 'unfulfilled', required — Status of the line item. - `storeId` string, required — Unique identifier for merchant’s store in Extend’s system. - `orderId` string, required — Unique identifier provided by merchant for transaction associated to Extend order. - `transactionId` string, required — Unique identifier provided by merchant for transaction associated to Extend order. - `isProductWarrantabilityVerified` boolean — Indicates whether our system skipped product warrantability validation when creating a contract. - `fulfilledAt` integer — Date the line item was fulfilled. NOTE - This field is formatted as a 13 digit Epoch timestamp - `refundedAt` integer — Date the line item was refunded. NOTE - This field is formatted as a 13 digit Epoch timestamp - `cancelledAt` integer — Date the line item was cancelled. NOTE - This field is formatted as a 13 digit Epoch timestamp - `createdAt` integer, required — Date the line item was created. NOTE - This field is formatted as a 13 digit Epoch timestamp - `updatedAt` integer, required — Date the line item was updated. NOTE - This field is formatted as a 13 digit Epoch timestamp - `discountAmount` integer — Discount amount applied for the product line item. NOTE - If you have multiple quantities for this line item, only provide the amount for a single quantity of this product.

Amount should be expressed in terms of the smallest currency unit. - `taxCost` integer — Tax cost associated to the product line item. NOTE - If you have multiple quantities for this line item, only provide the cost for a single quantity of this product.

Amount should be expressed in terms of the smallest currency unit. - `adjustments` object — Contains different fields related to adjustments made that should be tracked for analytics purposes. - `calculatedListPrice` integer — The calculated expected list price for a contract on the order that may need to be referenced during order line item fulfillment. - `originalPlanId` string — A unique identifier for the original plan that was used to create a contract. - `contractFailedReasons` string[] — List of reasons of why the contract failed to be created. - `analytics` object — Contains additional information about an order line item that helps with reporting and analytics. - `fulfillmentMethod` string — The method used to fulfill the order. F.e., BOPIS, DoorDash Delivery, Ship To Home - `finalSalesPrice` integer — The line item final sales price charged to the customer, inclusive of any line item tax costs, other costs for the product, and any discounts applied to the line item. Amount should be expressed in terms of the smallest currency unit. - `perUnitFinalSalesPrice` integer — The per unit final sales price, inclusive of any tax costs, other costs for the product, and any discounts applied to the product. Amount should be expressed in terms of the smallest currency unit. - `perUnitDiscountAmount` integer — The per unit discount amount applicable to a single quantity of the order line. Amount should be expressed in terms of the smallest currency unit. - `perUnitTaxCost` integer — The per unit tax amount applicable to a single quantity of the order line. Amount should be expressed in terms of the smallest currency unit. - object — Line item model required to create a Shipping Protection contract. - `quoteId` string, required — Unique identifier for the quote provided when a shipping protection offer is made. - `premium` integer — Purchase price or premium of shipping protection - `shipmentInfo` object[], required - `destination` object — Destination location of the shipment associated to the package. - `address1` string, required — Address line 1. - `address2` string — Address line 2. - `city` string, required — Address city. - `companyName` string — Address company name. - `countryCode` string, required — Address country code. NOTE - This should be in a two letter format (e.g. United States = US). - `personName` string — Contact full name. - `phone` string — Phone number. - `postalCode` string, required — Address postal code. - `provinceCode` string — Address state or province code. - `lineItemId` string — Unique identifier for the Extend order line item. - `lineItemTransactionId` string — Unique identifier for the Extend order line item. - `productIds` string[], required — List of Extend Product IDs associated to the shipment. - `shipmentDate` integer, required — Date package was shipped by the shipping provider. NOTE - This will be automatically updated with a valid Shipping Provider and Tracking ID on the shipment. - `shippingProvider` string, required — Shipping provider code associated to the package. Merchants must provide this shipping provider code to properly track the statuses of the shipment. NOTE - This is the current list of codes that we support shipment tracking updates for: 'fedex', 'ups', 'usps'. If a different code value is sent, the shipment will be created but we will not be able to automatically track shipment updates. - `source` object — Source location of the shipment associated to the package. - `address1` string, required — Address line 1. - `address2` string — Address line 2. - `city` string, required — Address city. - `companyName` string — Address company name. - `countryCode` string, required — Address country code. NOTE - This should be in a two letter format (e.g. United States = US). - `personName` string — Contact full name. - `phone` string — Phone number. - `postalCode` string, required — Address postal code. - `provinceCode` string — Address state or province code. - `trackingId` string, required — Tracking number from the shipping provider. Merchants must provide this tracking number to properly track the statuses of the shipment. - `trackingUrl` string — URL generated by the shipping provider for the associated tracking number. NOTE - This will be automatically updated with a valid Shipping Provider and Tracking ID on the shipment. - `shipmentId` string — Unique uuid identifier for the shipment. - `contractId` string — Unique identifier associating a generated contract to a line item. This field can be optionally generated by the merchant as a GUID. NOTE: You must be an approved merchant to send a unique identifier for Extend contracts. Please reach out to your merchant success manager for more details. - `charitableDonation` object — An object that stores data related to a charitable donation that a customer made. - `id` string, required — Unique identifier for the charity organization. - `donationAmount` integer, required — Amount donated to the charity organization.

Should be expressed in terms of the smallest currency unit.

- `name` string — Name of the charity organization. - `lineItemTransactionId` string — Unique identifier from the merchant’s system for the order line item. - `discountAmount` integer — Discount amount applied for the product line item. NOTE - If you have multiple quantities for this line item, only provide the amount for a single quantity of this product.

Amount should be expressed in terms of the smallest currency unit. - `taxCost` integer — Tax cost associated to the product line item. NOTE - If you have multiple quantities for this line item, only provide the cost for a single quantity of this product.

Amount should be expressed in terms of the smallest currency unit. - `type` 'shipments', required - `lineItemIds` string[] - `offerId` string — Unique identifier of the offer made for a product or cart identifier for the order line item. This will be be used for analytics like AB testing experiments. - `offerPlanId` string — Unique identifier for the offer used for a contract. - `accountId` string — Unique identifier for the account associated with the order line item creation. - `orderId` string — Unique identifier provided by merchant for transaction associated to Extend order. - `id` string — Unique identifier for line item in Extend's system. - `transactionId` string — Unique identifier provided by merchant for transaction associated to Extend order. - `storeId` string — Unique identifier for merchant’s store in Extend’s system. - `status` 'canceled' | 'cancel_failed' | 'contract_failed' | 'contract_pending' | 'fulfilled' | 'lead_failed' | 'quote_failed' | 'pending' | 'refunded' | 'unfulfilled' — Status of the line item. - `fulfilledAt` integer — Date the line item was fulfilled. NOTE - This field is formatted as a 13 digit Epoch timestamp - `createdAt` integer — Date the line item was created. NOTE - This field is formatted as a 13 digit Epoch timestamp - `updatedAt` integer — Date the line item was updated. NOTE - This field is formatted as a 13 digit Epoch timestamp - `adjustments` object — Contains different fields related to adjustments made that should be tracked for analytics purposes. - `adjustedQuoteId` string — A new Quote ID that was generated by the Orders service when a product mismatch or other discrepancy was detected from the original Quote ID. - `calculatedListPrice` integer — The calculated expected list price for a contract on the order that may need to be referenced during order line item fulfillment. - `isCreateQuote` boolean — A flag that indicates no Quote ID was provided for a shipping protection contract and one was generated automatically by the Orders service. - `previousContracts` string[] - `productsRemoved` object[] - `quantity` integer - `referenceId` string - `newPremium` integer — Premium of new shipping quote if partially refunded. - `isCreateQuote` boolean — A flag that indicates no Quote ID was provided for a shipping protection contract and one was generated automatically by the Orders service. - `contractFailedReasons` string[] — List of reasons of why the contract failed to be created. - `analytics` object — Contains additional information about an order line item that helps with reporting and analytics. - `fulfillmentMethod` string — The method used to fulfill the order. F.e., BOPIS, DoorDash Delivery, Ship To Home - object — Line item model required to track shipments on an order. NOTE - this does not create a Shipping Protection Contract. - `shipmentInfo` object[], required - `destination` object — Destination location of the shipment associated to the package. - `address1` string, required — Address line 1. - `address2` string — Address line 2. - `city` string, required — Address city. - `companyName` string — Address company name. - `countryCode` string, required — Address country code. NOTE - This should be in a two letter format (e.g. United States = US). - `personName` string — Contact full name. - `phone` string — Phone number. - `postalCode` string, required — Address postal code. - `provinceCode` string — Address state or province code. - `lineItemId` string — Unique identifier for the Extend order line item. - `lineItemTransactionId` string — Unique identifier for the Extend order line item. - `productIds` string[], required — List of Extend Product IDs associated to the shipment. - `shipmentDate` integer, required — Date package was shipped by the shipping provider. NOTE - This will be automatically updated with a valid Shipping Provider and Tracking ID on the shipment. - `shippingProvider` string, required — Shipping provider code associated to the package. Merchants must provide this shipping provider code to properly track the statuses of the shipment. NOTE - This is the current list of codes that we support shipment tracking updates for: 'fedex', 'ups', 'usps'. If a different code value is sent, the shipment will be created but we will not be able to automatically track shipment updates. - `source` object — Source location of the shipment associated to the package. - `address1` string, required — Address line 1. - `address2` string — Address line 2. - `city` string, required — Address city. - `companyName` string — Address company name. - `countryCode` string, required — Address country code. NOTE - This should be in a two letter format (e.g. United States = US). - `personName` string — Contact full name. - `phone` string — Phone number. - `postalCode` string, required — Address postal code. - `provinceCode` string — Address state or province code. - `trackingId` string, required — Tracking number from the shipping provider. Merchants must provide this tracking number to properly track the statuses of the shipment. - `trackingUrl` string — URL generated by the shipping provider for the associated tracking number. NOTE - This will be automatically updated with a valid Shipping Provider and Tracking ID on the shipment. - `shipmentId` string — Unique uuid identifier for the shipment. - `lineItemTransactionId` string — Unique identifier from the merchant’s system for the order line item. - `offerId` string — Unique identifier of the offer made for a product or cart identifier for the order line item. This will be be used for analytics like AB testing experiments. - `offerPlanId` string — Unique identifier for the offer used for a contract. - `type` 'shipments' - `accountId` string — Unique identifier for the account associated with the order line item creation. - `orderId` string — Unique identifier provided by merchant for transaction associated to Extend order. - `id` string — Unique identifier for line item in Extend's system. - `transactionId` string — Unique identifier provided by merchant for transaction associated to Extend order. - `storeId` string — Unique identifier for merchant’s store in Extend’s system. - `status` 'canceled' | 'cancel_failed' | 'contract_failed' | 'contract_pending' | 'fulfilled' | 'lead_failed' | 'quote_failed' | 'pending' | 'refunded' | 'unfulfilled' — Status of the line item. - `createdAt` integer — Date the line item was created. NOTE - This field is formatted as a 13 digit Epoch timestamp - `updatedAt` integer — Date the line item was updated. NOTE - This field is formatted as a 13 digit Epoch timestamp - `discountAmount` integer — Discount amount applied for the product line item. NOTE - If you have multiple quantities for this line item, only provide the amount for a single quantity of this product.

Amount should be expressed in terms of the smallest currency unit. - `taxCost` integer — Tax cost associated to the product line item. NOTE - If you have multiple quantities for this line item, only provide the cost for a single quantity of this product.

Amount should be expressed in terms of the smallest currency unit. - `analytics` object — Contains additional information about an order line item that helps with reporting and analytics. - `fulfillmentMethod` string — The method used to fulfill the order. F.e., BOPIS, DoorDash Delivery, Ship To Home - object - `isCollapsed` boolean — Flag indicating if line item was collapsed - `type` 'non_warrantable', required - `product` object - `deliveryStatus` 'awaiting_shipment' | 'shipped' — Various shipping statuses - `id` string, required — Unique ID of product created in Extend during product catalog mapping. - `purchasePrice` integer, required — Price paid for the product by the customer.

Amount should be expressed in terms of the smallest currency unit. - `serialNumber` string — Merchant-assigned product serial number. - `purchaseDate` integer — Purchase date of the original product (10 or 13 digit timestamp). - `fulfillmentDate` integer — Fulfillment date of the product (10 or 13 digit timestamp). - `listPrice` integer — Original list price of the product (before any discounts). - `name` string — Name of product given by the merchant. - `mfrWarranty` object — Manufacturer warranty information. - `parts` integer — manufacturer warranty parts in months - `labor` integer — manufacturer warranty labor in months - `url` string — manufacturer warranty URL - `parentReferenceId` string — The parent reference ID of the product. - `id` string, required — Unique identifier for line item in Extend's system. - `accountId` string, required — Unique identifier for the account associated with the order line item creation. - `storeId` string, required — Unique identifier for merchant’s store in Extend’s system. - `orderId` string, required — Unique identifier provided by merchant for transaction associated to Extend order. - `offerId` string — Unique identifier of the offer made for a product or cart identifier for the order line item. This will be be used for analytics like AB testing experiments. - `offerPlanId` string — Unique identifier for the offer used for a contract. - `transactionId` string, required — Unique identifier provided by merchant for transaction associated to Extend order. - `lineItemTransactionId` string — Unique identifier provided by the merchant for querying. - `status` 'canceled' | 'cancel_failed' | 'contract_failed' | 'contract_pending' | 'fulfilled' | 'lead_failed' | 'quote_failed' | 'pending' | 'refunded' | 'unfulfilled', required — Status of the line item. - `discountAmount` integer — Discount amount applied for the product line item. NOTE - If you have multiple quantities for this line item, only provide the amount for a single quantity of this product.

Amount should be expressed in terms of the smallest currency unit. - `fulfilledAt` integer — Date the line item was fulfilled. NOTE - This field is formatted as a 13 digit Epoch timestamp - `refundedAt` integer — Date the line item was refunded. NOTE - This field is formatted as a 13 digit Epoch timestamp - `cancelledAt` integer — Date the line item was cancelled. NOTE - This field is formatted as a 13 digit Epoch timestamp - `createdAt` integer, required — Date the line item was created. NOTE - This field is formatted as a 13 digit Epoch timestamp - `updatedAt` integer, required — Date the line item was updated. NOTE - This field is formatted as a 13 digit Epoch timestamp - `taxCost` integer — Tax cost associated to the product line item. NOTE - If you have multiple quantities for this line item, only provide the cost for a single quantity of this product.

Amount should be expressed in terms of the smallest currency unit. - `analytics` object — Contains additional information about an order line item that helps with reporting and analytics. - `fulfillmentMethod` string — The method used to fulfill the order. F.e., BOPIS, DoorDash Delivery, Ship To Home - `finalSalesPrice` integer — The line item final sales price charged to the customer, inclusive of any line item tax costs, other costs for the product, and any discounts applied to the line item. Amount should be expressed in terms of the smallest currency unit. - `perUnitFinalSalesPrice` integer — The per unit final sales price, inclusive of any tax costs, other costs for the product, and any discounts applied to the product. Amount should be expressed in terms of the smallest currency unit. - `perUnitDiscountAmount` integer — The per unit discount amount applicable to a single quantity of the order line. Amount should be expressed in terms of the smallest currency unit. - `perUnitTaxCost` integer — The per unit tax amount applicable to a single quantity of the order line. Amount should be expressed in terms of the smallest currency unit. - object - `type` 'category_contract', required - `product` object - `deliveryStatus` 'awaiting_shipment' | 'shipped' — Various shipping statuses - `id` string, required — Unique ID of product created in Extend during product catalog mapping. - `purchasePrice` integer, required — Price paid for the product by the customer.

Amount should be expressed in terms of the smallest currency unit. - `serialNumber` string — Merchant-assigned product serial number. - `purchaseDate` integer — Purchase date of the original product (10 or 13 digit timestamp). - `fulfillmentDate` integer — Fulfillment date of the product (10 or 13 digit timestamp). - `listPrice` integer — Original list price of the product (before any discounts). - `name` string — Name of product given by the merchant. - `mfrWarranty` object — Manufacturer warranty information. - `parts` integer — manufacturer warranty parts in months - `labor` integer — manufacturer warranty labor in months - `url` string — manufacturer warranty URL - `parentReferenceId` string — The parent reference ID of the product. - `id` string, required — Unique identifier for line item in Extend's system. - `accountId` string, required — Unique identifier for the account associated with the order line item creation. - `storeId` string, required — Unique identifier for merchant’s store in Extend’s system. - `orderId` string, required — Unique identifier provided by merchant for transaction associated to Extend order. - `offerId` string — Unique identifier of the offer made for a product or cart identifier for the order line item. This will be be used for analytics like AB testing experiments. - `offerPlanId` string — Unique identifier for the offer used for a contract. - `contractId` string, required — Unique identifier associating a generated contract to a line item. This field can be optionally generated by the merchant as a GUID. NOTE: You must be an approved merchant to send a unique identifier for Extend contracts. Please reach out to your merchant success manager for more details. - `transactionId` string, required — Unique identifier provided by merchant for transaction associated to Extend order. - `lineItemIds` string[] — List of line item ids that are covered by the category contract line. - `lineItemTransactionId` string — Unique identifier provided by the merchant for querying. - `status` 'canceled' | 'cancel_failed' | 'contract_failed' | 'contract_pending' | 'fulfilled' | 'lead_failed' | 'quote_failed' | 'pending' | 'refunded' | 'unfulfilled', required — Status of the line item. - `discountAmount` integer — Discount amount applied for the product line item. NOTE - If you have multiple quantities for this line item, only provide the amount for a single quantity of this product.

Amount should be expressed in terms of the smallest currency unit. - `fulfilledAt` integer — Date the line item was fulfilled. NOTE - This field is formatted as a 13 digit Epoch timestamp - `refundedAt` integer — Date the line item was refunded. NOTE - This field is formatted as a 13 digit Epoch timestamp - `cancelledAt` integer — Date the line item was cancelled. NOTE - This field is formatted as a 13 digit Epoch timestamp - `createdAt` integer, required — Date the line item was created. NOTE - This field is formatted as a 13 digit Epoch timestamp - `updatedAt` integer, required — Date the line item was updated. NOTE - This field is formatted as a 13 digit Epoch timestamp - `taxCost` integer — Tax cost associated to the product line item. NOTE - If you have multiple quantities for this line item, only provide the cost for a single quantity of this product.

Amount should be expressed in terms of the smallest currency unit. - `contractFailedReasons` string[] — List of reasons of why the contract failed to be created. - `analytics` object — Contains additional information about an order line item that helps with reporting and analytics. - `fulfillmentMethod` string — The method used to fulfill the order. F.e., BOPIS, DoorDash Delivery, Ship To Home - object - `type` 'category_product', required - `product` object - `deliveryStatus` 'awaiting_shipment' | 'shipped' — Various shipping statuses - `id` string, required — Unique ID of product created in Extend during product catalog mapping. - `purchasePrice` integer, required — Price paid for the product by the customer.

Amount should be expressed in terms of the smallest currency unit. - `serialNumber` string — Merchant-assigned product serial number. - `purchaseDate` integer — Purchase date of the original product (10 or 13 digit timestamp). - `fulfillmentDate` integer — Fulfillment date of the product (10 or 13 digit timestamp). - `listPrice` integer — Original list price of the product (before any discounts). - `name` string — Name of product given by the merchant. - `mfrWarranty` object — Manufacturer warranty information. - `parts` integer — manufacturer warranty parts in months - `labor` integer — manufacturer warranty labor in months - `url` string — manufacturer warranty URL - `parentReferenceId` string — The parent reference ID of the product. - `id` string, required — Unique identifier for line item in Extend's system. - `accountId` string, required — Unique identifier for the account associated with the order line item creation. - `storeId` string, required — Unique identifier for merchant’s store in Extend’s system. - `orderId` string, required — Unique identifier provided by merchant for transaction associated to Extend order. - `offerId` string — Unique identifier of the offer made for a product or cart identifier for the order line item. This will be be used for analytics like AB testing experiments. - `offerPlanId` string — Unique identifier for the offer used for a contract. - `transactionId` string, required — Unique identifier provided by merchant for transaction associated to Extend order. - `lineItemTransactionId` string — Unique identifier provided by the merchant for querying. - `status` 'canceled' | 'cancel_failed' | 'contract_failed' | 'contract_pending' | 'fulfilled' | 'lead_failed' | 'quote_failed' | 'pending' | 'refunded' | 'unfulfilled', required — Status of the line item. - `discountAmount` integer — Discount amount applied for the product line item. NOTE - If you have multiple quantities for this line item, only provide the amount for a single quantity of this product.

Amount should be expressed in terms of the smallest currency unit. - `fulfilledAt` integer — Date the line item was fulfilled. NOTE - This field is formatted as a 13 digit Epoch timestamp - `refundedAt` integer — Date the line item was refunded. NOTE - This field is formatted as a 13 digit Epoch timestamp - `cancelledAt` integer — Date the line item was cancelled. NOTE - This field is formatted as a 13 digit Epoch timestamp - `createdAt` integer, required — Date the line item was created. NOTE - This field is formatted as a 13 digit Epoch timestamp - `updatedAt` integer, required — Date the line item was updated. NOTE - This field is formatted as a 13 digit Epoch timestamp - `taxCost` integer — Tax cost associated to the product line item. NOTE - If you have multiple quantities for this line item, only provide the cost for a single quantity of this product.

Amount should be expressed in terms of the smallest currency unit. - `analytics` object — Contains additional information about an order line item that helps with reporting and analytics. - `fulfillmentMethod` string — The method used to fulfill the order. F.e., BOPIS, DoorDash Delivery, Ship To Home - `finalSalesPrice` integer — The line item final sales price charged to the customer, inclusive of any line item tax costs, other costs for the product, and any discounts applied to the line item. Amount should be expressed in terms of the smallest currency unit. - `perUnitFinalSalesPrice` integer — The per unit final sales price, inclusive of any tax costs, other costs for the product, and any discounts applied to the product. Amount should be expressed in terms of the smallest currency unit. - `perUnitDiscountAmount` integer — The per unit discount amount applicable to a single quantity of the order line. Amount should be expressed in terms of the smallest currency unit. - `perUnitTaxCost` integer — The per unit tax amount applicable to a single quantity of the order line. Amount should be expressed in terms of the smallest currency unit. - object — Line item model required to create an Category contract. - `type` 'bundle_contract', required — Field used to indicate the type of line item that should be created. Note - Only 'bundle_contract' is supported in this field. - `contractId` string — Unique identifier associating a generated contract to a line item. This field can be optionally generated by the merchant as a GUID. NOTE: You must be an approved merchant to send a unique identifier for Extend contracts. Please reach out to your merchant success manager for more details. - `lineItemIds` string[], required - `plan` object, required — Information about the plan being purchased. - `id` string, required — Unique identifier for Extend plan. - `purchasePrice` integer, required — Purchase price of the Extend contract purchased.

Amount should be expressed in terms of the smallest currency unit. - `termsId` string — Unique identifier for the terms associated to the Extend plan. - `termsVersion` string — Version number for the terms associated to the Extend plan. - `version` string — Version number for the Extend plan. - `contractFailedReasons` string[] — List of reasons of why the contract failed to be created. - `id` string — Unique identifier for line item in Extend's system. - `analytics` object — Contains additional information about an order line item that helps with reporting and analytics. - `fulfillmentMethod` string — The method used to fulfill the order. F.e., BOPIS, DoorDash Delivery, Ship To Home - object - `bundleInfo` object - `id` string, required - `name` string — Name of product given by the merchant. - `imageUrl` string - `category` string - `listPrice` number - `purchasePrice` number, required - `quantity` number - `purchaseDate` integer — Purchase date of the original product (10 or 13 digit timestamp). - `fulfillmentDate` integer — Fulfillment date of the product (10 or 13 digit timestamp). - `type` 'bundle_component', required - `product` object - `deliveryStatus` 'awaiting_shipment' | 'shipped' — Various shipping statuses - `id` string, required — Unique ID of product created in Extend during product catalog mapping. - `purchasePrice` integer, required — Price paid for the product by the customer.

Amount should be expressed in terms of the smallest currency unit. - `serialNumber` string — Merchant-assigned product serial number. - `purchaseDate` integer — Purchase date of the original product (10 or 13 digit timestamp). - `fulfillmentDate` integer — Fulfillment date of the product (10 or 13 digit timestamp). - `listPrice` integer — Original list price of the product (before any discounts). - `name` string — Name of product given by the merchant. - `mfrWarranty` object — Manufacturer warranty information. - `parts` integer — manufacturer warranty parts in months - `labor` integer — manufacturer warranty labor in months - `url` string — manufacturer warranty URL - `parentReferenceId` string — The parent reference ID of the product. - `id` string — Unique identifier for line item in Extend's system. - `accountId` string — Unique identifier for the account associated with the order line item creation. - `storeId` string — Unique identifier for merchant’s store in Extend’s system. - `orderId` string — Unique identifier provided by merchant for transaction associated to Extend order. - `offerId` string — Unique identifier of the offer made for a product or cart identifier for the order line item. This will be be used for analytics like AB testing experiments. - `offerPlanId` string — Unique identifier for the offer used for a contract. - `transactionId` string — Unique identifier provided by merchant for transaction associated to Extend order. - `lineItemTransactionId` string — Unique identifier provided by the merchant for querying. - `status` 'canceled' | 'cancel_failed' | 'contract_failed' | 'contract_pending' | 'fulfilled' | 'lead_failed' | 'quote_failed' | 'pending' | 'refunded' | 'unfulfilled' — Status of the line item. - `discountAmount` integer — Discount amount applied for the product line item. NOTE - If you have multiple quantities for this line item, only provide the amount for a single quantity of this product.

Amount should be expressed in terms of the smallest currency unit. - `fulfilledAt` integer — Date the line item was fulfilled. NOTE - This field is formatted as a 13 digit Epoch timestamp - `refundedAt` integer — Date the line item was refunded. NOTE - This field is formatted as a 13 digit Epoch timestamp - `cancelledAt` integer — Date the line item was cancelled. NOTE - This field is formatted as a 13 digit Epoch timestamp - `createdAt` integer — Date the line item was created. NOTE - This field is formatted as a 13 digit Epoch timestamp - `updatedAt` integer — Date the line item was updated. NOTE - This field is formatted as a 13 digit Epoch timestamp - `taxCost` integer — Tax cost associated to the product line item. NOTE - If you have multiple quantities for this line item, only provide the cost for a single quantity of this product.

Amount should be expressed in terms of the smallest currency unit. - `analytics` object — Contains additional information about an order line item that helps with reporting and analytics. - `fulfillmentMethod` string — The method used to fulfill the order. F.e., BOPIS, DoorDash Delivery, Ship To Home - `finalSalesPrice` integer — The line item final sales price charged to the customer, inclusive of any line item tax costs, other costs for the product, and any discounts applied to the line item. Amount should be expressed in terms of the smallest currency unit. - `perUnitFinalSalesPrice` integer — The per unit final sales price, inclusive of any tax costs, other costs for the product, and any discounts applied to the product. Amount should be expressed in terms of the smallest currency unit. - `perUnitDiscountAmount` integer — The per unit discount amount applicable to a single quantity of the order line. Amount should be expressed in terms of the smallest currency unit. - `perUnitTaxCost` integer — The per unit tax amount applicable to a single quantity of the order line. Amount should be expressed in terms of the smallest currency unit. --- [API](https://skmtc.dev/extend/apis/leads-api.md) · [All operations](https://skmtc.dev/extend/apis/leads-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/extend/leads-api/revisions/76403e33d7d6/schema)