---
title: "Search Orders"
method: GET
path: "/orders/search"
tags: ["Orders"]
---

# Search Orders

`GET /orders/search`

This endpoint allows the retrieval of multiple orders using the merchant’s Extend Store ID or merchant’s Transaction ID on the order. Useful information can be retrieved for an order with details related to the order (e.g. status, contract ID, shipment information, etc.). For helpful definitions on some of the field values that may be returned from this endpoint, please refer to the Orders introduction or the Create an Order page.

## Query parameters

- `storeId` string, uuid
- `transactionId` string
- `customerPhone` string, string
- `customerEmail` string, string
- `merchantCustomerId` string

## Headers

- `Content-Type` string, required
- `X-Extend-Access-Token` string, required
- `Accept` string, required

## Response `200`

Successful search response.

- object
  - `nextPageCursor` string — Cursor used to retrieve the next page of results, which should be provided in the search response (if applicable).
  - `limit` integer — The maximum number of items to search and filter through for results.
  - `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.
    - `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.
    - `id` string, required — Unique ID used to identify the Extend 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` string[], required
    - `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.
    - `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.
    - `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' — <p>Status of the order in Extend’s system.</p><ul><li><strong>pending</strong> - Order has been created with a wait period value. This is typically used to create an order that requires a certain time period to pass before it is considered a valid order.</li><li><strong>open</strong> - Order has been created with at least one order line item that has not been fulfilled</li><li><strong>voided</strong> - Order was voided due to circumstances that indicate the order was not valid when it was first created. This can be due to a fraudulent order.</li><li><strong>closed</strong> - Order was successfully processed with all order line items fulfilled.</li><li><strong>canceled</strong> - Order was canceled or refunded at the request of a customer or the merchant.</li></ul>
    - `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.
    - `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).

---

[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)