--- title: "Batch Create Orders" method: POST path: "/orders/batch" tags: ["Orders"] --- # Batch Create Orders `POST /orders/batch` This endpoint allows the creation of multiple orders through a single API request. For more details and information on creating orders, please refer to the Orders introduction or the Create an Order page. NOTE - This endpoint currently only supports creating 10 orders with each request. ## Request body - object[] - `cartId` string - `currency` '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 - `storeId` string, required — Unique identifier for merchant’s store in Extend’s system. - `transactionId` string, required — Unique identifier provided by merchant for transaction associated to Extend order. - `analytics` object — Contains additional information about an order that helps with reporting and analytics. - `contractPlanCategory` string — This is intended to categorize the type of contract associated to the order. NOTE - This has been replaced by order line item type categories. - `customerStatus` string — Status of the customer with the merchant's eCommerce store. This would reflect if the customer is a newly registered customer or an existing customer that was previously registered prior to the order. - `customerType` string — Type of customer for this order. This helps distinguish if the customer is another business or a consumer. This is defaulted to 'Consumer'. - `discountSource` string — Source of the discount associated to the order. - `fileName` string — The file used to process the order transaction. - `loyaltyStatus` string — Loyalty status of a registered customer for the merchant's store. - `paymentMethod` string — Method of payment used by the customer for the order. Examples include Credit, Debit, or ACH. - `paymentInstrument` string — Instrument of payment used by the customer for the order. Examples include AMEX, Visa, MC, Affirm, etc. - `totalDiscounts` integer — The total number of discounts applied to the customer's order. - `marketingOptIn` boolean — Whether the customer has opted into receiving marketing emails/materials. - `checkoutId` string — Checkout session identifier that can be used for analytics. - `browserIp` string — The IP address of the customer's browser. - `quoteId` string — Shipping quote identifier of the order. - `discounts` object[] — Array of discounts applied to the order - `discountCode` string — The discount code applied to the order. - `discountType` string — The type of discount applied (e.g., percentage, fixed amount). - `amountValue` number — The value of the discount amount. - `description` string — A description of the discount applied. - `discountAmountTotal` integer — Total discount amount for the order.

Amount should be expressed in terms of the smallest currency unit.

- `formId` string — This field is used for Jewelry orders where merchants need to provide additional reporting and analytics context for the order. - `isHistorical` boolean — Denotes whether or not the order was created through the historical orders endpoint. - `isTest` boolean — 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. - `merchantCustomerId` string — Unique identifier for the customer in the merchant’s system. - `poNumber` string — Purchase order number in merchant's system. - `productCostTotal` integer — Total purchase cost of all products (and their quantities) included on the order, not including shipping, tax, or discount amounts.

Amount should be expressed in terms of the smallest currency unit.

- `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. - `customerReturnPolicyId` string — Unique identifier for the return policy associated with this order. - `shippingCostTotal` integer — The total shipping cost for the order.

Amount should be expressed in terms of the smallest currency unit.

- `shippingTaxCostTotal` integer — Total shipping tax amount for the order.

Amount should be expressed in terms of the smallest currency unit.

- `status` 'pending' | 'open' | 'voided' | 'closed' | 'canceled' — The state of the order in Extend DB (needed for auditing).

Note - When line items are fulfilled, the product protection contract is created. By default, line items will be set to a fulfilled status if the field or no field value is provided in the request.

- `storeName` string — Merchant's store name in Extend. - `taxCostTotal` integer — The total tax cost for the order.

Amount should be expressed in terms of the smallest currency unit.

- `total` integer — Total amount paid for entire order.

Amount should be expressed in terms of the smallest currency unit.

- `transactionDate` integer — Transaction date when customer placed order (13 digit timestamp). - `waitPeriod` number — Number of days that should be applied before a contract is created from an order. This is typically used to confirm a payment was successfully captured or to wait a period of time to ensure a transaction isn’t fraudulent. NOTE - This field accepts the number of days and does not have to be a whole number (e.g. half a day can be sent as 0.5). - `customer` object, required — The customer who made a purchase. - `billingAddress` object, required — Customer's billing address. - `address1` string — Customer's address. - `address2` string — Customer's PO or Unit #. - `city` string — Customer's city. - `countryCode` string — Customer’s address country code. NOTE - This should be in a two letter format (e.g. United States = US). - `postalCode` string — Customer's postal code. - `province` string — Customer's state / province. - `email` string, required — Customer's email address. - `name` string, required — Customer's full name. - `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). - `loyaltyStatus` string — The loyalty status of the customer which must be set to create orders for loyalty customers. Confirmed loyalty customers should have a loyaltyStatus of `member`. - `phone` string — Customer's primary phone number. - `region` string — Region of the customer's location when an order is processed by the merchant (an ISO 3166-1 alpha -2 region code). This value is the country of the customer's location. - `shippingAddress` object — Customer's shipping address. - `address1` string — Customer's address. - `address2` string — Customer's PO or Unit #. - `city` string — Customer's city. - `countryCode` string — Customer’s address country code. NOTE - This should be in a two letter format (e.g. United States = US). - `postalCode` string — Customer's postal code. - `province` string — Customer's state / province. - `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. - `saleOrigin` object — Critical sales data indicated where the order was processed (e.g. web, store) that allows Extend to optimize warranty attach rates and improve program performance. - `agentId` string — An identifier for an individual agent for tracking their sales. - `channel` string, required — Important field that indicates where an order was processed. This is used to determine warranty attach rates and other important metrics based on where the sale occurred (e.g. web, store). - `integratorId` string — An identifier for an individual integrator - `locationId` string — The specific location that the sale originated from. - `platform` string — Ecommerce platform sale came from - `storeAddress` object - `address1` string — Customer's address. - `address2` string — Customer's PO or Unit #. - `city` string — Customer's city. - `countryCode` string — Customer’s address country code. NOTE - This should be in a two letter format (e.g. United States = US). - `postalCode` string — Customer's postal code. - `province` string — Customer's state / province. ## Response `200` Successful batch creation of Orders - object[] - `analytics` object — Contains additional information about an order that helps with reporting and analytics. - `contractPlanCategory` string — This is intended to categorize the type of contract associated to the order. NOTE - This has been replaced by order line item type categories. - `customerStatus` string — Status of the customer with the merchant's eCommerce store. This would reflect if the customer is a newly registered customer or an existing customer that was previously registered prior to the order. - `customerType` string — Type of customer for this order. This helps distinguish if the customer is another business or a consumer. This is defaulted to 'Consumer'. - `discountSource` string — Source of the discount associated to the order. - `fileName` string — The file used to process the order transaction. - `loyaltyStatus` string — Loyalty status of a registered customer for the merchant's store. - `paymentMethod` string — Method of payment used by the customer for the order. Examples include Credit, Debit, or ACH. - `paymentInstrument` string — Instrument of payment used by the customer for the order. Examples include AMEX, Visa, MC, Affirm, etc. - `totalDiscounts` integer — The total number of discounts applied to the customer's order. - `marketingOptIn` boolean — Whether the customer has opted into receiving marketing emails/materials. - `checkoutId` string — Checkout session identifier that can be used for analytics. - `browserIp` string — The IP address of the customer's browser. - `quoteId` string — Shipping quote identifier of the order. - `discounts` object[] — Array of discounts applied to the order - `discountCode` string — The discount code applied to the order. - `discountType` string — The type of discount applied (e.g., percentage, fixed amount). - `amountValue` number — The value of the discount amount. - `description` string — A description of the discount applied. - `cartId` string — Unique identifier for the cart in the merchant’s system. - `currency` '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 - `createdAt` integer — Date the order was created (generated by Extend). - `customer` object, required — The customer who made a purchase. - `billingAddress` object — Customer's billing address. - `address1` string — Customer's address. - `address2` string — Customer's PO or Unit #. - `city` string — Customer's city. - `countryCode` string — Customer’s address country code. NOTE - This should be in a two letter format (e.g. United States = US). - `postalCode` string — Customer's postal code. - `province` string — Customer's state / province. - `email` string — Customer's email address. - `name` string, required — Customer's full name. - `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). - `loyaltyStatus` string — The loyalty status of the customer which must be set to create orders for loyalty customers. Confirmed loyalty customers should have a loyaltyStatus of `member`. - `phone` string — Customer's primary phone number. - `region` string — Region of the customer's location when an order is processed by the merchant (an ISO 3166-1 alpha -2 region code). This value is the country of the customer's location. - `shippingAddress` object — Customer's shipping address. - `address1` string — Customer's address. - `address2` string — Customer's PO or Unit #. - `city` string — Customer's city. - `countryCode` string — Customer’s address country code. NOTE - This should be in a two letter format (e.g. United States = US). - `postalCode` string — Customer's postal code. - `province` string — Customer's state / province. - `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. - `discountAmountTotal` integer — Total discount amount for the order. - `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 ID used to identify the Extend order. - `consumerProfileId` string — The consumer profile ID associated with the order. - `isTest` boolean — 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. - `lineItems` union[], required —

Order Line Items should include all items purchased on the order regardless of contract status. Lines will automatically be categorize based on the properties included in the request.

- union - object — Line item model required to create an Extended Warranty contract. - `type` 'contract', required - `contractId` string — Unique identifier associating a generated contract to a line item. This field can be optionally generated by the merchant as a GUID. NOTE: You must be an approved merchant to send a unique identifier for Extend contracts. Please reach out to your merchant success manager for more details. - `lineItemTransactionId` string — Unique identifier provided by the merchant for querying. - `offerId` string — Unique identifier of the offer made for a product or cart identifier for the order line item. This will be be used for analytics like AB testing experiments. - `offerPlanId` string — Unique identifier for the offer used for a contract. - `plan` object, required — Information about the plan being purchased. - `id` string, required — Unique identifier for Extend plan. - `purchasePrice` integer, required — Purchase price of the Extend contract purchased.

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

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

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

Amount should be expressed in terms of the smallest currency unit. - `adjustments` object — Contains different fields related to adjustments made that should be tracked for analytics purposes. - `calculatedListPrice` integer — The calculated expected list price for a contract on the order that may need to be referenced during order line item fulfillment. - `originalPlanId` string — A unique identifier for the original plan that was used to create a contract. - `contractFailedReasons` string[] — List of reasons of why the contract failed to be created. - `analytics` object — Contains additional information about an order line item that helps with reporting and analytics. - `fulfillmentMethod` string — The method used to fulfill the order. F.e., BOPIS, DoorDash Delivery, Ship To Home - `finalSalesPrice` integer — The line item final sales price charged to the customer, inclusive of any line item tax costs, other costs for the product, and any discounts applied to the line item. Amount should be expressed in terms of the smallest currency unit. - `perUnitFinalSalesPrice` integer — The per unit final sales price, inclusive of any tax costs, other costs for the product, and any discounts applied to the product. Amount should be expressed in terms of the smallest currency unit. - `perUnitDiscountAmount` integer — The per unit discount amount applicable to a single quantity of the order line. Amount should be expressed in terms of the smallest currency unit. - `perUnitTaxCost` integer — The per unit tax amount applicable to a single quantity of the order line. Amount should be expressed in terms of the smallest currency unit. - object — Line item model required to create an Extended Warranty contract. - `type` 'partial_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 — Information about the plan being purchased. - `id` string, required — Unique identifier for Extend plan. - `purchasePrice` integer, required — Purchase price of the Extend contract purchased.

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

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

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

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

Should be expressed in terms of the smallest currency unit.

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

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

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

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

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

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

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

Amount should be expressed in terms of the smallest currency unit. - `analytics` object — Contains additional information about an order line item that helps with reporting and analytics. - `fulfillmentMethod` string — The method used to fulfill the order. F.e., BOPIS, DoorDash Delivery, Ship To Home - `finalSalesPrice` integer — The line item final sales price charged to the customer, inclusive of any line item tax costs, other costs for the product, and any discounts applied to the line item. Amount should be expressed in terms of the smallest currency unit. - `perUnitFinalSalesPrice` integer — The per unit final sales price, inclusive of any tax costs, other costs for the product, and any discounts applied to the product. Amount should be expressed in terms of the smallest currency unit. - `perUnitDiscountAmount` integer — The per unit discount amount applicable to a single quantity of the order line. Amount should be expressed in terms of the smallest currency unit. - `perUnitTaxCost` integer — The per unit tax amount applicable to a single quantity of the order line. Amount should be expressed in terms of the smallest currency unit. - object - `type` 'bundle_component', required - `product` object — Information about the product purchased. Note - Products can be created and updated directly from the order for configured merchants. Please work with your merchant success manager for more information. - `id` string, required — This is the unique identifier that identifies the product. This can be a product SKU, or variant id. A referenceId may contain special characters except for the following: `%`, `\`, `"`. Special characters should not be at the end of a referenceId. Note - This field must contain a value when attempting to create or update a product through an Extend order. - `category` string — Product category. Can be any value and may be used by Extend to map the product to warranty plans. Note - This field must contain a value when attempting to create or update a product through an Extend order. - `title` string — Product name. Note - This field must contain a value when attempting to create or update a product through an Extend order. - `listPrice` integer — The base retail price of the product (in cents for USD). Amount should be expressed in terms of the smallest currency unit. Note - This field must contain a value when attempting to create or update a product through an Extend order. - `brand` string — The Product Brand, Manufacturer or Vendor. - `condition` 'new' | 'used' | 'refurbished' - `deliveryStatus` 'awaiting_shipment' | 'shipped' — Various shipping statuses - `description` string — The product description. - `identifiers` object — Additional identifiers for the product. - `asin` string — Product ASIN. - `barcode` string — Product barcode. - `gtin` string — Product GTIN. - `isbn` string — Product ISBN. - `sku` string — Product SKU. - `upc` string — Product UPC. - `imageUrl` string — A url pointing to the primary image for the product. - `itemDimensions` object — The product’s item dimensions. - `height` number — The product's height. - `width` number — The product's width. - `length` number — The product's length. - `unit` 'inch' | 'centimeter' | 'millimeter' | 'foot' — The unit that represents the product’s dimension values. - `itemWeight` object — The product’s weight. - `value` number — The value of the product's weight. - `unit` 'pound' | 'ounce' | 'gram' | 'kilogram' — The unit that represents the product’s weight. - `mfrWarranty` object — Information about the manufacturer's warranty. This is optional, but if you can provide it please do as it can significantly speed up the warranty matching process. - `labor` integer — Manufacturer warranty length for labor, in number of months. - `parts` integer — Manufacturer warranty length for parts, in number of months. - `url` string — URL that links to the manufacturer warranty details for the product. - `modelNumber` string — The product’s model number. - `name` string — Name of product given by the merchant. - `parentReferenceId` string — The parent reference ID of the product. - `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). - `purchasePrice` integer, required — Price paid for the product by the customer. - `serialNumber` string — Merchant-assigned product serial number. - `subCategories` string[] — An array of additional product categories. - `bundleInfo` object — Information about the product purchased. Note - Products can be created and updated directly from the order for configured merchants. Please work with your merchant success manager for more information. - `id` string, required — This is the unique identifier that identifies the product. This can be a product SKU, or variant id. A referenceId may contain special characters except for the following: `%`, `\`, `"`. Special characters should not be at the end of a referenceId. Note - This field must contain a value when attempting to create or update a product through an Extend order. - `category` string — Product category. Can be any value and may be used by Extend to map the product to warranty plans. Note - This field must contain a value when attempting to create or update a product through an Extend order. - `title` string — Product name. Note - This field must contain a value when attempting to create or update a product through an Extend order. - `listPrice` integer — The base retail price of the product (in cents for USD). Amount should be expressed in terms of the smallest currency unit. Note - This field must contain a value when attempting to create or update a product through an Extend order. - `brand` string — The Product Brand, Manufacturer or Vendor. - `condition` 'new' | 'used' | 'refurbished' - `deliveryStatus` 'awaiting_shipment' | 'shipped' — Various shipping statuses - `description` string — The product description. - `identifiers` object — Additional identifiers for the product. - `asin` string — Product ASIN. - `barcode` string — Product barcode. - `gtin` string — Product GTIN. - `isbn` string — Product ISBN. - `sku` string — Product SKU. - `upc` string — Product UPC. - `imageUrl` string — A url pointing to the primary image for the product. - `itemDimensions` object — The product’s item dimensions. - `height` number — The product's height. - `width` number — The product's width. - `length` number — The product's length. - `unit` 'inch' | 'centimeter' | 'millimeter' | 'foot' — The unit that represents the product’s dimension values. - `itemWeight` object — The product’s weight. - `value` number — The value of the product's weight. - `unit` 'pound' | 'ounce' | 'gram' | 'kilogram' — The unit that represents the product’s weight. - `mfrWarranty` object — Information about the manufacturer's warranty. This is optional, but if you can provide it please do as it can significantly speed up the warranty matching process. - `labor` integer — Manufacturer warranty length for labor, in number of months. - `parts` integer — Manufacturer warranty length for parts, in number of months. - `url` string — URL that links to the manufacturer warranty details for the product. - `modelNumber` string — The product’s model number. - `name` string — Name of product given by the merchant. - `parentReferenceId` string — The parent reference ID of the product. - `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). - `purchasePrice` integer, required — Price paid for the product by the customer. - `serialNumber` string — Merchant-assigned product serial number. - `subCategories` string[] — An array of additional product categories. - `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. - `quantity` integer — Quantity of product purchased. - `fulfilledQuantity` number — Number of products that have been fulfilled. - `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. - `nonReturnable` boolean — Indicates whether a return and exchange resolution entitlement should be created. - `analytics` object — Contains additional information about an order line item that helps with reporting and analytics. - `fulfillmentMethod` string — The method used to fulfill the order. F.e., BOPIS, DoorDash Delivery, Ship To Home - `finalSalesPrice` integer — The line item final sales price charged to the customer, inclusive of any line item tax costs, other costs for the product, and any discounts applied to the line item. Amount should be expressed in terms of the smallest currency unit. - `perUnitFinalSalesPrice` integer — The per unit final sales price, inclusive of any tax costs, other costs for the product, and any discounts applied to the product. Amount should be expressed in terms of the smallest currency unit. - `perUnitDiscountAmount` integer — The per unit discount amount applicable to a single quantity of the order line. Amount should be expressed in terms of the smallest currency unit. - `perUnitTaxCost` integer — The per unit tax amount applicable to a single quantity of the order line. Amount should be expressed in terms of the smallest currency unit. - object - `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 — Unique identifier associating a generated contract to a line item. This field can be optionally generated by the merchant as a GUID. NOTE: You must be an approved merchant to send a unique identifier for Extend contracts. Please reach out to your merchant success manager for more details. - `transactionId` string, required — Unique identifier provided by merchant for transaction associated to Extend order. - `lineItemIds` string[] — List of line item ids that are covered by the category contract line. - `lineItemTransactionId` string — Unique identifier provided by the merchant for querying. - `status` 'canceled' | 'cancel_failed' | 'contract_failed' | 'contract_pending' | 'fulfilled' | 'lead_failed' | 'quote_failed' | 'pending' | 'refunded' | 'unfulfilled', required — Status of the line item. - `discountAmount` integer — Discount amount applied for the product line item. NOTE - If you have multiple quantities for this line item, only provide the amount for a single quantity of this product.

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

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

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

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

Amount should be expressed in terms of the smallest currency unit. - `analytics` object — Contains additional information about an order line item that helps with reporting and analytics. - `fulfillmentMethod` string — The method used to fulfill the order. F.e., BOPIS, DoorDash Delivery, Ship To Home - `finalSalesPrice` integer — The line item final sales price charged to the customer, inclusive of any line item tax costs, other costs for the product, and any discounts applied to the line item. Amount should be expressed in terms of the smallest currency unit. - `perUnitFinalSalesPrice` integer — The per unit final sales price, inclusive of any tax costs, other costs for the product, and any discounts applied to the product. Amount should be expressed in terms of the smallest currency unit. - `perUnitDiscountAmount` integer — The per unit discount amount applicable to a single quantity of the order line. Amount should be expressed in terms of the smallest currency unit. - `perUnitTaxCost` integer — The per unit tax amount applicable to a single quantity of the order line. Amount should be expressed in terms of the smallest currency unit. - object — Line item model required to create an Category contract. - `type` 'bundle_contract', required — Field used to indicate the type of line item that should be created. Note - Only 'bundle_contract' is supported in this field. - `contractId` string — Unique identifier associating a generated contract to a line item. This field can be optionally generated by the merchant as a GUID. NOTE: You must be an approved merchant to send a unique identifier for Extend contracts. Please reach out to your merchant success manager for more details. - `lineItemIds` string[] - `plan` object — 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 - `merchantCustomerId` string — Unique identifier for the customer in the merchant’s system. - `parentReferenceId` string — The parent reference ID of the order. - `poNumber` string — Purchase order number in merchant's system. - `productCostTotal` integer — Total purchase cost of all products (and their quantities) included on the order, not including shipping, tax, or discount amounts. - `refundedAt` integer — Date the order was refunded (generated by Extend). - `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. - `customerReturnPolicyId` string — Unique identifier for the return policy associated with this order. - `saleOrigin` object — Critical sales data indicated where the order was processed (e.g. web, store) that allows Extend to optimize warranty attach rates and improve program performance. - `agentId` string — An identifier for an individual agent for tracking their sales. - `channel` string — Important field that indicates where an order was processed. This is used to determine warranty attach rates and other important metrics based on where the sale occurred (e.g. web, store). - `integratorId` string — An identifier for an individual integrator - `locationId` string — The specific location that the sale originated from. - `platform` string — Ecommerce platform sale came from - `storeAddress` object - `address1` string — Customer's address. - `address2` string — Customer's PO or Unit #. - `city` string — Customer's city. - `countryCode` string — Customer’s address country code. NOTE - This should be in a two letter format (e.g. United States = US). - `postalCode` string — Customer's postal code. - `province` string — Customer's state / province. - `shippingCostTotal` integer — The total shipping cost for the order. - `shippingTaxCostTotal` integer — Total shipping tax amount for the order. - `status` 'pending' | 'open' | 'voided' | 'closed' | 'canceled' | 'refunded' | 'inactive', required —

Status of the order in Extend’s system.

- `storeId` string, required — Unique identifier for merchant’s store in Extend’s system. - `storeName` string, required — Merchant's store name in Extend. - `taxCostTotal` integer — The total tax cost for the order. - `total` integer — Total amount paid for entire order. - `transactionDate` integer — Order's transaction date. No default will be set if no value is provided. - `transactionId` string, required — Merchant supplied unique transaction identifier, which may be used for querying. - `updatedAt` integer — Extend-generated timestamp indicating the last update performed. - `waitPeriod` number — Number of days that should be applied before a contract is created from an order. This is typically used to confirm a payment was successfully captured or to wait a period of time to ensure a transaction isn't fraudulent. NOTE - This field accepts the number of days and does not have to be a whole number (e.g. half a day can be sent as 0.5). - `coveredProducts` object[] — Object for each product and the corresponding quantity that should be covered by a contract. - `productId` string, required — This is the unique identifier that identifies the product. - `quantity` integer, required — Quantity of product that should be covered by contract. If no value is provided, all quantities for the product will be covered. - `lineItemTransactionId` string — Unique identifier for the line item transaction. ## 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)