--- title: "Update Line Item Fulfillment Status" method: POST path: "/line-items/fulfill" tags: ["Line Items"] --- # Update Line Item Fulfillment Status `POST /line-items/fulfill` Updates the status of a Line Item to 'fulfilled', if applicable creation of associated contracts is triggered using the product and plan information associated with the Line Item.

Important:

A Line Item Fulfillment Status can only be updated from 'unfulfilled' to 'fulfilled'. Once updated to 'fulfilled', a Contract is created immediately and can only be undone by refunding the Contract.
## Query parameters - `fulfillAll` string ## Headers - `Content-Type` string, required - `X-Extend-Access-Token` string, required - `Accept` string, required ## Request body - union - object - `lineItemId` string, required - object - `lineItemTransactionId` string, required ## Response `200` Successful line item fulfillment. - 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. - `contract` object - `accountId` string, required — Account ID for the merchant in Extend’s system. - `adminContractId` string — Unique identifier for the Extend contract that is generated in PCRS. NOTE - This is only applicable for the PCRS contract type. - `adminSyncError` string — Error message from PCRS when an Extend contract cannot be successfully synced. - `adminSyncStatus` 'sync_error' | 'synced' | 'unsynced' | 'resync_required', required — Status of contract syncing to PCRS system. NOTE - This is only applicable for the PCRS contract type. - `cancelledAt` integer — Cancelation date of the Extend contract. NOTE - This field is formatted as a 13 digit Epoch timestamp. - `createdAt` integer, required — Creation date of the Extend contract. NOTE - This field is formatted as a 13 digit Epoch timestamp. - `coverage` object - `starts` integer, required — Coverage start date of the Extend contract. NOTE - This field is formatted as a 13 digit Epoch timestamp. This value is dynamically calculated based on the Product Transaction Date and Manufacturer Warranty Length (parts and labor) values. - `ends` integer, required — Coverage end date of the Extend contract. NOTE - This field is formatted as a 13 digit Epoch timestamp. This value is dynamically calculated based on the Product Transaction Date and Manufacturer Warranty Length (parts and labor) values. - `customer` object, required - `billingAddress` object — Customer’s billing address. - `address1` string, required — Customer’s address line 1. - `address2` string — Customer’s address line 2. - `city` string, required — Customer’s address city - `countryCode` string, required — Customer’s address country code. NOTE - This should be in a two letter format (e.g. United States = US). - `postalCode` string, required — Customer’s address postal code. - `provinceCode` string — Customer’s address state or province code. - `email` string, required — Customer’s email address. - `name` string, required — Customer’s full name. - `phone` string — Customer’s primary phone number. - `shippingAddress` object — Customer’s shipping address. - `address1` string, required — Customer’s address line 1. - `address2` string — Customer’s address line 2. - `city` string, required — Customer’s address city - `countryCode` string, required — Customer’s address country code. NOTE - This should be in a two letter format (e.g. United States = US). - `postalCode` string, required — Customer’s address postal code. - `provinceCode` string — Customer’s address state or province code. - `type` 'consumer', required — Type of customer on the contract sold. - `locale` string — The locale of the customer. Locale is used to determine the language of the offer marketing content. Locale is formatted as xx-XX: the first two letters denote language, (ISO 639-1 standards) and the last two letters denote region (ISO 3166 standards). - `region` string — Region of the customer's location when an order is processed by the merchant (an ISO 3166-1 region code). This value is the country of the customer's location. - `subdivision` string — Subdivision of the customer's location when an order is processed by the merchant. This value is the state or province of the customer's location. - `formId` string — This field is used for Jewelry orders where merchants need to provide additional reporting and analytics context for the order. - `id` string, required — Unique identifier for an Extend contract. - `isProductWarrantabilityVerified` boolean — Indicates whether our system skipped product warrantability validation when creating a contract. - `isTest` boolean, required — Flag that tracks whether the transaction was created as a test or not. NOTE - This is defaulted to false and should be used only under special circumstances. - `limitOfLiabilityAmount` integer — Limit of liability amount of the contract. - `limitOfLiabilityAmountType` 'product_purchase_price' | 'product_list_price' — Price that the contract limit of liability is based on. - `listPrice` integer — Expected retail price of the Extend plan associated to the contract purchased. - `orderId` string — Unique identifier for an Extend order. - `plan` object, required - `category` 'service_contract' | 'shipping_contract', required — Plan category type. - `id` string, required — Unique identifier for Extend plan. - `skuId` string — Unique identifier for SKU that is used by merchants when selling Extend plans. - `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` integer — Version number of the Extend plan. - `product` object, required - `fulfillmentDate` integer, required — Date when a customer has received a product. This can be applicable for any instance where the customer receives a product on a date after the order is placed. NOTE - This field is formatted as a 13 digit Epoch timestamp. - `imageUrl` string — URL specifying the location of the primary image for the product. - `listPrice` integer, required — Retail price of the product purchased. - `manufacturerWarrantyLengthLabor` integer, required — Length of manufacturer warranty on labor for the product, expressed in number of months. - `manufacturerWarrantyLengthParts` integer, required — Length of manufacturer warranty on parts for the product, expressed in number of months. - `purchaseDate` integer, required — Purchase date of the product. NOTE - This field is formatted as a 13 digit Epoch timestamp. - `purchasePrice` integer, required — Purchase price of the product purchased - `referenceId` string, required — Unique identifier provided by the merchant for the product. - `reimbursementAmount` integer — Amount that Extend will reimburse on approved claims for the product if it is different from the product’s list price. - `serialNumber` string — Product serial number. - `name` string, required — Name or title of the product. - `transactionId` string, required — Unique identifier provided by the merchant of the original order when the product is purchased. NOTE - This ID is automatically passed to a contract from Transaction ID that is provided on an Extend order. - `purchaseCurrency` 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLE' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VED' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL', required — Currency code used when contract was purchased. NOTE - This is an ISO-4217 currency code. - `purchaseDate` integer, required — Purchase date of the contract. NOTE - This field is formatted as a 13 digit Epoch timestamp. - `purchasePrice` integer, required — Purchase price of the plan purchased. - `refundedAt` integer — Date the contract was refunded at. NOTE - This field is formatted as a 13 digit Epoch timestamp. - `resellerMerchant` object — Data related to reseller merchants. This can be used by merchants when different store information from the merchant’s Extend store must be displayed to customers. - `id` string — Unique identifier from merchant’s system for the reseller merchant account. - `name` string — Reseller merchant store name. - `domain` string — Main website URL for reseller merchant store. - `sellerId` string, required — Unique identifier for the merchant’s Extend store (i.e. the merchant’s Extend Store ID). - `sellerName` string, required — Merchant’s company or store name. - `status` 'cancelled' | 'created' | 'delivered' | 'expired' | 'fulfilled' | 'live' | 'refund_accepted' | 'refund_denied' | 'refund_paid' | 'refund_requested' | 'voided' | 'terminated', required — Contract status. - `transactionId` string, required — Unique identifier provided by the merchant of the transaction when the contract is purchased. - `type` 'pcrs', required — Filter for including contract types. NOTE - PCRS is the contract type for extended warranty contracts. - `updatedAt` integer, required — Date the contract was last updated at. NOTE - This field is formatted as a 13 digit Epoch timestamp. - object — Line item model required to track shipments on an order - `quoteId` string — Unique identifier for the quote provided when a shipping protection offer is made. - `premium` integer — Purchase price or premium of shipping protection - `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. - `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. - `lineItemIds` string[] - `fulfilledAt` integer — Date the line item was fulfilled. NOTE - This field is formatted as a 13 digit Epoch timestamp - `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', required - `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, required — 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 - `cancelledAt` integer — Date the line item was cancelled. 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. - `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 - `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 - `contract` object - `accountId` string, required — Account ID for the merchant in Extend’s system. - `createdAt` integer, required — Creation date of the Extend contract. NOTE - This field is formatted as a 13 digit Epoch timestamp. - `customer` object, required - `billingAddress` object — Customer’s billing address. - `address1` string, required — Customer’s address line 1. - `address2` string — Customer’s address line 2. - `city` string, required — Customer’s address city - `countryCode` string, required — Customer’s address country code. NOTE - This should be in a two letter format (e.g. United States = US). - `postalCode` string, required — Customer’s address postal code. - `provinceCode` string — Customer’s address state or province code. - `email` string, required — Customer’s email address. - `name` string, required — Customer’s full name. - `phone` string — Customer’s primary phone number. - `shippingAddress` object — Customer’s shipping address. - `address1` string, required — Customer’s address line 1. - `address2` string — Customer’s address line 2. - `city` string, required — Customer’s address city - `countryCode` string, required — Customer’s address country code. NOTE - This should be in a two letter format (e.g. United States = US). - `postalCode` string, required — Customer’s address postal code. - `provinceCode` string — Customer’s address state or province code. - `type` 'consumer', required — Type of customer on the contract sold. - `locale` string — The locale of the customer. Locale is used to determine the language of the offer marketing content. Locale is formatted as xx-XX: the first two letters denote language, (ISO 639-1 standards) and the last two letters denote region (ISO 3166 standards). - `region` string — Region of the customer's location when an order is processed by the merchant (an ISO 3166-1 region code). This value is the country of the customer's location. - `subdivision` string — Subdivision of the customer's location when an order is processed by the merchant. This value is the state or province of the customer's location. - `formId` string — This field is used for Jewelry orders where merchants need to provide additional reporting and analytics context for the order. - `id` string, required — Unique identifier for an Extend contract. - `isTest` boolean, required — Flag that tracks whether the transaction was created as a test or not. NOTE - This is defaulted to false and should be used only under special circumstances. - `limitOfLiabilityAmount` integer — Limit of liability amount of the contract. - `limitOfLiabilityAmountType` 'product_purchase_price' | 'product_list_price' — Price that the contract limit of liability is based on. - `lineItemId` string, required — Unique identifier for an Extend order line item. - `orderId` string, required — Unique identifier for an Extend order. - `plan` object, required - `category` 'service_contract' | 'shipping_contract', required — Plan category type. - `id` string, required — Unique identifier for Extend plan. - `skuId` string — Unique identifier for SKU that is used by merchants when selling Extend plans. - `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` integer — Version number of the Extend plan. - `productsList` object[], required — List of products that are covered by the category contract. - `contractId` string — Unique identifier for an Extend contract. - `coverage` object - `starts` integer, required — Coverage start date of the Extend contract. NOTE - This field is formatted as a 13 digit Epoch timestamp. This value is dynamically calculated based on the Product Transaction Date and Manufacturer Warranty Length (parts and labor) values. - `ends` integer, required — Coverage end date of the Extend contract. NOTE - This field is formatted as a 13 digit Epoch timestamp. This value is dynamically calculated based on the Product Transaction Date and Manufacturer Warranty Length (parts and labor) values. - `email` string, required — Purchase price of the product purchased. - `fulfillmentDate` integer — Date when a customer has received a product. This can be applicable for any instance where the customer receives a product on a date after the order is placed. NOTE - This field is formatted as a 13 digit Epoch timestamp. - `imageUrl` string — URL specifying the location of the primary image for the product. - `limitOfLiability` number, required - `lineItemId` string, required — Unique line item ID associated with the Contract (generated by Extend) - `listPrice` integer, required — Retail price of the product purchased. - `manufacturerWarrantyLengthLabor` integer, required — Length of manufacturer warranty on labor for the product, expressed in number of months. - `manufacturerWarrantyLengthParts` integer, required — Length of manufacturer warranty on parts for the product, expressed in number of months. - `purchasePrice` integer, required — Purchase price of the product purchased - `referenceId` string, required — Unique identifier provided by the merchant for the product. - `serialNumber` string — Product serial number. - `title` string, required — Name or title of the product. - `transactionDate` integer, required - `transactionId` string, required — Unique identifier provided by the merchant of the original order when the product is purchased. NOTE - This ID is automatically passed to a contract from Transaction ID that is provided on an Extend order. - `status` 'live' | 'canceled', required — Category product status - `createdAt` integer, required — Creation date of the Extend contract product. NOTE - This field is formatted as a 13 digit Epoch timestamp. - `updatedAt` integer, required — Date the contract product was last updated at. NOTE - This field is formatted as a 13 digit Epoch timestamp. - `purchaseCurrency` 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLE' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VED' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL', required — Currency code used when contract was purchased. NOTE - This is an ISO-4217 currency code. - `purchaseDate` integer, required — Purchase date of the contract. NOTE - This field is formatted as a 13 digit Epoch timestamp. - `purchasePrice` number, required — Purchase price of the contract. - `expectedPrice` integer — Expected price of the contract. - `resellerMerchant` object - `id` string — Unique identifier from merchant’s system for the reseller merchant account. - `name` string — Reseller merchant store name. - `domain` string — Main website URL for reseller merchant store. - `refundedAt` integer — Date that merchant reported the refund on the contract. NOTE - This field is formatted as a 13 digit Epoch timestamp. - `refundAmount` object - `amount` integer, required — Amount refunded on the contract. - `currencyCode` 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLE' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VED' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL' — Currency code used when contract was refunded. NOTE - This is an ISO-4217 currency code. - `formattedAmount` string — Format that should be used when displaying the amount field. - `sellerId` string, required — Unique identifier for the merchant’s Extend store (i.e. the merchant’s Extend Store ID). - `sellerName` string, required — Merchant’s company or store name. - `status` 'cancelled' | 'created' | 'delivered' | 'expired' | 'fulfilled' | 'live' | 'refund_accepted' | 'refund_denied' | 'refund_paid' | 'refund_requested' | 'voided' | 'terminated', required — Contract status. - `transactionId` string, required — Unique identifier provided by the merchant of the transaction when the contract is purchased. - `type` 'category', required - `updatedAt` integer, required — Date the contract was last updated at. NOTE - This field is formatted as a 13 digit Epoch timestamp. - `planDetails` object - `category` string, required — Plan category (e.g. indoor_furniture, consumer_electronics). - `coverage_includes` string, required — Indicates whether plan includes Accidental Damage from Handling (ADH) or only base coverage (e.g. ‘adh', 'base’). - `coverage_starts` string, required — Indicates whether plan starts immediately when contract is purchased or after the manufacturer’s warranty period ends (e.g. ‘immediate', 'after’). - `deductible` integer, required — Deductible the customer is responsible for on plan when a claim is placed. - `pcmi_category` string, required — Category associated to the plan in PCRS (e.g. Furniture, Household Goods). - `pcmi_subcategory` string, required — Subcategory associated to the plan in PCRS (e.g. Mattress, Area Rug). - `servicer_ids` string[], required — Servicer IDs in PCRS that are associated to the plan. - `replacement_type` string, required — Indicates whether the replacement sourced must be a new or used product (e.g. ‘new’, 'used’). - `service_type` 'replace' | 'repair_depot' | 'repair_onsite' | 'repair_irobot', required — Indicates the type of service that the plan is eligible for when a claim is placed. This primarily determines if the product under the plan will be repaired or replaced. If repaired, this field will indicate the type of repair that will be attempted (e.g. on-site, depot, etc.). - `term_length` integer, required — Term length of the plan, expressed in number of months. - 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 - `bundleInfo` object, required - `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, required - `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, required — 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 - 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. - `contract` object - `accountId` string, required — Account ID for the merchant in Extend’s system. - `adminContractId` string — Unique identifier for the Extend contract that is generated in PCRS. NOTE - This is only applicable for the PCRS contract type. - `adminSyncError` string — Error message from PCRS when an Extend contract cannot be successfully synced. - `adminSyncStatus` 'sync_error' | 'synced' | 'unsynced' | 'resync_required', required — Status of contract syncing to PCRS system. NOTE - This is only applicable for the PCRS contract type. - `cancelledAt` integer — Cancelation date of the Extend contract. NOTE - This field is formatted as a 13 digit Epoch timestamp. - `createdAt` integer, required — Creation date of the Extend contract. NOTE - This field is formatted as a 13 digit Epoch timestamp. - `coverage` object - `starts` integer, required — Coverage start date of the Extend contract. NOTE - This field is formatted as a 13 digit Epoch timestamp. This value is dynamically calculated based on the Product Transaction Date and Manufacturer Warranty Length (parts and labor) values. - `ends` integer, required — Coverage end date of the Extend contract. NOTE - This field is formatted as a 13 digit Epoch timestamp. This value is dynamically calculated based on the Product Transaction Date and Manufacturer Warranty Length (parts and labor) values. - `customer` object, required - `billingAddress` object — Customer’s billing address. - … - `email` string, required — Customer’s email address. - `name` string, required — Customer’s full name. - `phone` string — Customer’s primary phone number. - `shippingAddress` object — Customer’s shipping address. - … - `type` 'consumer', required — Type of customer on the contract sold. - `locale` string — The locale of the customer. Locale is used to determine the language of the offer marketing content. Locale is formatted as xx-XX: the first two letters denote language, (ISO 639-1 standards) and the last two letters denote region (ISO 3166 standards). - `region` string — Region of the customer's location when an order is processed by the merchant (an ISO 3166-1 region code). This value is the country of the customer's location. - `subdivision` string — Subdivision of the customer's location when an order is processed by the merchant. This value is the state or province of the customer's location. - `formId` string — This field is used for Jewelry orders where merchants need to provide additional reporting and analytics context for the order. - `id` string, required — Unique identifier for an Extend contract. - `isProductWarrantabilityVerified` boolean — Indicates whether our system skipped product warrantability validation when creating a contract. - `isTest` boolean, required — Flag that tracks whether the transaction was created as a test or not. NOTE - This is defaulted to false and should be used only under special circumstances. - `limitOfLiabilityAmount` integer — Limit of liability amount of the contract. - `limitOfLiabilityAmountType` 'product_purchase_price' | 'product_list_price' — Price that the contract limit of liability is based on. - `listPrice` integer — Expected retail price of the Extend plan associated to the contract purchased. - `orderId` string — Unique identifier for an Extend order. - `plan` object, required - `category` 'service_contract' | 'shipping_contract', required — Plan category type. - `id` string, required — Unique identifier for Extend plan. - `skuId` string — Unique identifier for SKU that is used by merchants when selling Extend plans. - `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` integer — Version number of the Extend plan. - `product` object, required - `fulfillmentDate` integer, required — Date when a customer has received a product. This can be applicable for any instance where the customer receives a product on a date after the order is placed. NOTE - This field is formatted as a 13 digit Epoch timestamp. - `imageUrl` string — URL specifying the location of the primary image for the product. - `listPrice` integer, required — Retail price of the product purchased. - `manufacturerWarrantyLengthLabor` integer, required — Length of manufacturer warranty on labor for the product, expressed in number of months. - `manufacturerWarrantyLengthParts` integer, required — Length of manufacturer warranty on parts for the product, expressed in number of months. - `purchaseDate` integer, required — Purchase date of the product. NOTE - This field is formatted as a 13 digit Epoch timestamp. - `purchasePrice` integer, required — Purchase price of the product purchased - `referenceId` string, required — Unique identifier provided by the merchant for the product. - `reimbursementAmount` integer — Amount that Extend will reimburse on approved claims for the product if it is different from the product’s list price. - `serialNumber` string — Product serial number. - `name` string, required — Name or title of the product. - `transactionId` string, required — Unique identifier provided by the merchant of the original order when the product is purchased. NOTE - This ID is automatically passed to a contract from Transaction ID that is provided on an Extend order. - `purchaseCurrency` 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLE' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VED' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL', required — Currency code used when contract was purchased. NOTE - This is an ISO-4217 currency code. - `purchaseDate` integer, required — Purchase date of the contract. NOTE - This field is formatted as a 13 digit Epoch timestamp. - `purchasePrice` integer, required — Purchase price of the plan purchased. - `refundedAt` integer — Date the contract was refunded at. NOTE - This field is formatted as a 13 digit Epoch timestamp. - `resellerMerchant` object — Data related to reseller merchants. This can be used by merchants when different store information from the merchant’s Extend store must be displayed to customers. - `id` string — Unique identifier from merchant’s system for the reseller merchant account. - `name` string — Reseller merchant store name. - `domain` string — Main website URL for reseller merchant store. - `sellerId` string, required — Unique identifier for the merchant’s Extend store (i.e. the merchant’s Extend Store ID). - `sellerName` string, required — Merchant’s company or store name. - `status` 'cancelled' | 'created' | 'delivered' | 'expired' | 'fulfilled' | 'live' | 'refund_accepted' | 'refund_denied' | 'refund_paid' | 'refund_requested' | 'voided' | 'terminated', required — Contract status. - `transactionId` string, required — Unique identifier provided by the merchant of the transaction when the contract is purchased. - `type` 'pcrs', required — Filter for including contract types. NOTE - PCRS is the contract type for extended warranty contracts. - `updatedAt` integer, required — Date the contract was last updated at. NOTE - This field is formatted as a 13 digit Epoch timestamp. - object — Line item model required to track shipments on an order - `quoteId` string — Unique identifier for the quote provided when a shipping protection offer is made. - `premium` integer — Purchase price or premium of shipping protection - `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. - `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. - `lineItemIds` string[] - `fulfilledAt` integer — Date the line item was fulfilled. NOTE - This field is formatted as a 13 digit Epoch timestamp - `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', required - `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, required — 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 - `cancelledAt` integer — Date the line item was cancelled. 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. - `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 - `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 - `contract` object - `accountId` string, required — Account ID for the merchant in Extend’s system. - `createdAt` integer, required — Creation date of the Extend contract. NOTE - This field is formatted as a 13 digit Epoch timestamp. - `customer` object, required - `billingAddress` object — Customer’s billing address. - … - `email` string, required — Customer’s email address. - `name` string, required — Customer’s full name. - `phone` string — Customer’s primary phone number. - `shippingAddress` object — Customer’s shipping address. - … - `type` 'consumer', required — Type of customer on the contract sold. - `locale` string — The locale of the customer. Locale is used to determine the language of the offer marketing content. Locale is formatted as xx-XX: the first two letters denote language, (ISO 639-1 standards) and the last two letters denote region (ISO 3166 standards). - `region` string — Region of the customer's location when an order is processed by the merchant (an ISO 3166-1 region code). This value is the country of the customer's location. - `subdivision` string — Subdivision of the customer's location when an order is processed by the merchant. This value is the state or province of the customer's location. - `formId` string — This field is used for Jewelry orders where merchants need to provide additional reporting and analytics context for the order. - `id` string, required — Unique identifier for an Extend contract. - `isTest` boolean, required — Flag that tracks whether the transaction was created as a test or not. NOTE - This is defaulted to false and should be used only under special circumstances. - `limitOfLiabilityAmount` integer — Limit of liability amount of the contract. - `limitOfLiabilityAmountType` 'product_purchase_price' | 'product_list_price' — Price that the contract limit of liability is based on. - `lineItemId` string, required — Unique identifier for an Extend order line item. - `orderId` string, required — Unique identifier for an Extend order. - `plan` object, required - `category` 'service_contract' | 'shipping_contract', required — Plan category type. - `id` string, required — Unique identifier for Extend plan. - `skuId` string — Unique identifier for SKU that is used by merchants when selling Extend plans. - `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` integer — Version number of the Extend plan. - `productsList` object[], required — List of products that are covered by the category contract. - `contractId` string — Unique identifier for an Extend contract. - `coverage` object - … - `email` string, required — Purchase price of the product purchased. - `fulfillmentDate` integer — Date when a customer has received a product. This can be applicable for any instance where the customer receives a product on a date after the order is placed. NOTE - This field is formatted as a 13 digit Epoch timestamp. - `imageUrl` string — URL specifying the location of the primary image for the product. - `limitOfLiability` number, required - `lineItemId` string, required — Unique line item ID associated with the Contract (generated by Extend) - `listPrice` integer, required — Retail price of the product purchased. - `manufacturerWarrantyLengthLabor` integer, required — Length of manufacturer warranty on labor for the product, expressed in number of months. - `manufacturerWarrantyLengthParts` integer, required — Length of manufacturer warranty on parts for the product, expressed in number of months. - `purchasePrice` integer, required — Purchase price of the product purchased - `referenceId` string, required — Unique identifier provided by the merchant for the product. - `serialNumber` string — Product serial number. - `title` string, required — Name or title of the product. - `transactionDate` integer, required - `transactionId` string, required — Unique identifier provided by the merchant of the original order when the product is purchased. NOTE - This ID is automatically passed to a contract from Transaction ID that is provided on an Extend order. - `status` 'live' | 'canceled', required — Category product status - `createdAt` integer, required — Creation date of the Extend contract product. NOTE - This field is formatted as a 13 digit Epoch timestamp. - `updatedAt` integer, required — Date the contract product was last updated at. NOTE - This field is formatted as a 13 digit Epoch timestamp. - `purchaseCurrency` 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLE' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VED' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL', required — Currency code used when contract was purchased. NOTE - This is an ISO-4217 currency code. - `purchaseDate` integer, required — Purchase date of the contract. NOTE - This field is formatted as a 13 digit Epoch timestamp. - `purchasePrice` number, required — Purchase price of the contract. - `expectedPrice` integer — Expected price of the contract. - `resellerMerchant` object - `id` string — Unique identifier from merchant’s system for the reseller merchant account. - `name` string — Reseller merchant store name. - `domain` string — Main website URL for reseller merchant store. - `refundedAt` integer — Date that merchant reported the refund on the contract. NOTE - This field is formatted as a 13 digit Epoch timestamp. - `refundAmount` object - `amount` integer, required — Amount refunded on the contract. - `currencyCode` 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLE' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VED' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL' — Currency code used when contract was refunded. NOTE - This is an ISO-4217 currency code. - `formattedAmount` string — Format that should be used when displaying the amount field. - `sellerId` string, required — Unique identifier for the merchant’s Extend store (i.e. the merchant’s Extend Store ID). - `sellerName` string, required — Merchant’s company or store name. - `status` 'cancelled' | 'created' | 'delivered' | 'expired' | 'fulfilled' | 'live' | 'refund_accepted' | 'refund_denied' | 'refund_paid' | 'refund_requested' | 'voided' | 'terminated', required — Contract status. - `transactionId` string, required — Unique identifier provided by the merchant of the transaction when the contract is purchased. - `type` 'category', required - `updatedAt` integer, required — Date the contract was last updated at. NOTE - This field is formatted as a 13 digit Epoch timestamp. - `planDetails` object - `category` string, required — Plan category (e.g. indoor_furniture, consumer_electronics). - `coverage_includes` string, required — Indicates whether plan includes Accidental Damage from Handling (ADH) or only base coverage (e.g. ‘adh', 'base’). - `coverage_starts` string, required — Indicates whether plan starts immediately when contract is purchased or after the manufacturer’s warranty period ends (e.g. ‘immediate', 'after’). - `deductible` integer, required — Deductible the customer is responsible for on plan when a claim is placed. - `pcmi_category` string, required — Category associated to the plan in PCRS (e.g. Furniture, Household Goods). - `pcmi_subcategory` string, required — Subcategory associated to the plan in PCRS (e.g. Mattress, Area Rug). - `servicer_ids` string[], required — Servicer IDs in PCRS that are associated to the plan. - `replacement_type` string, required — Indicates whether the replacement sourced must be a new or used product (e.g. ‘new’, 'used’). - `service_type` 'replace' | 'repair_depot' | 'repair_onsite' | 'repair_irobot', required — Indicates the type of service that the plan is eligible for when a claim is placed. This primarily determines if the product under the plan will be repaired or replaced. If repaired, this field will indicate the type of repair that will be attempted (e.g. on-site, depot, etc.). - `term_length` integer, required — Term length of the plan, expressed in number of months. - 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 - `bundleInfo` object, required - `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, required - `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, required — 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 ## Other responses - `404` — The specified resource was not found - `500` — Internal server error --- [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)