The search queries include:
The search term `sellerId` can be paired with any of the other terms to limit contracts by seller.
`sellerId` is a required querystring parameter.
## Query parameters - `typeFilter` 'pcrs' | 'shipping_protection' | 'category' | 'pcrs,shipping_protection' | 'shipping_protection,pcrs' | 'pcrs,shipping_protection,category' | 'shipping_protection,category' | 'pcrs,category' - `contractId` string, uuid - `customerEmail` string, string - `customerPhone` string, string - `merchantCustomerId` string - `productSerialNumber` string - `productTransactionId` string - `sellerId` string, uuid - `status` 'cancelled' | 'created' | 'expired' | 'fulfilled' | 'live' | 'refund_accepted' | 'refund_denied' | 'refund_paid' | 'refund_requested' | 'terminated' | 'pending_termination' | 'voided' - `transactionId` string - `showAll` boolean ## Headers - `Content-Type` string, required - `X-Extend-Access-Token` string, required - `Accept` string, required ## Response `200` Successfully returned search result. Note - This is an example response for an extended warranty contract. - object - `contracts` object[], required - `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. - `merchantCustomerId` string — Unique identifier for the customer in the merchant’s system. - `cancelledAt` number — Cancelation date of the Extend contract. NOTE - This field is formatted as a 13 digit Epoch timestamp. - `createdAt` number, required — Creation date of the Extend contract. NOTE - This field is formatted as a 13 digit Epoch timestamp. - `consumerProfileId` string — Unique identifier for the consumer profile in Extend’s system. - `coverage` object - `starts` number, 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` number, 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. - `amount` number — Coverage amount of the Extend contract. - `amountRemaining` number — Coverage amount remaining on the Extend contract after any approved claims. - `status` 'covered_by_manufacturers_warranty' | 'covered_for_adh_only_by_extend' | 'covered_for_base_protection_only_by_extend' | 'covered_by_adh_and_base_protection_by_extend' | 'expired' | 'fulfilled' | 'cancelled' — Status of the coverage associated to the customer’s contract. - `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 — 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` number — 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` number — Expected retail price of the Extend plan associated to the contract purchased. - `orderId` string — Unique identifier for an Extend order. - `lineItemTransactionId` string — Unique identifier for an Extend order line item's transaction, provided by the merchant. - `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` number — Version number of the Extend plan. - `poNumber` string — An optional merchant generated purchase order number used for reconciliation - `product` object, required - `fulfillmentDate` number, 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` number, required — Retail price of the product purchased. - `manufacturerWarrantyLengthLabor` number, required — Length of manufacturer warranty on labor for the product, expressed in number of months. - `manufacturerWarrantyLengthParts` number, required — Length of manufacturer warranty on parts for the product, expressed in number of months. - `purchaseDate` number, required — Purchase date of the product. NOTE - This field is formatted as a 13 digit Epoch timestamp. - `purchasePrice` number, required — Purchase price of the product purchased - `referenceId` string, required — Unique identifier provided by the merchant for the product. - `reimbursementAmount` number — 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` number, required — Purchase date of the contract. NOTE - This field is formatted as a 13 digit Epoch timestamp. - `purchasePrice` number, required — Purchase price of the plan purchased. - `refundedAt` number — 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. - `saleOrigin` object - `agentId` string — An identifier for an individual agent for tracking their sales. - `channel` string — Sales channel - `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. - `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' | 'pending_termination' | '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` number, required — Date the contract was last updated at. NOTE - This field is formatted as a 13 digit Epoch timestamp. - `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. - `name` string — Name of the charity organization. - `donationAmount` number, required — Amount donated to the charity organization. - `cancellationReason` 'fraud_identified' | 'merchant_refund' | 'sp_claim' | 'correction_needed' | 'customer_requested' | 'merchant_requested' | 'created_in_error' | 'goodwill_escalation' — Why the contract was cancelled. - `refundMethod` 'extend_ach' | 'merchant_issued' | 'no_refund_issued' — The method by which a contract was refunded to the customer. - `refundPayment` object - `source` string, required - `refundRequestId` string, required - `refundSourceId` string, required - `refundId` string, required - `rewardId` string, required - `status` 'pending' | 'canceled' | 'complete' | 'failed', required - `failureReason` string - `payment` object, required - `value` number, required - `currency` string, required - `recipient` object, required - `name` string, required — Recipient's name. - `email` string — Recipient's email address. - `phone` string — Recipient's phone number. - `invoiceId` string - `createdAt` number, required - `updatedAt` number, required - `delivery` object, required - `method` 'email' | 'sms', required - `status` 'scheduled' | 'failed' | 'complete' | 'pending', required - `deliverAt` number, required - `customFields` object[] - `contractTermsLink` string — URL to the customer portal plan details page for this contract. - `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` number, 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` 'repair' | '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` number, required — Term length of the plan, expressed in number of months. ## Other responses - `400` — The request to the endpoint was invalid - `403` — Forbidden - `404` — The specified resource was not found --- [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)