v1

latestOpenAPI 3.0.12026-07-243902.3 MB

Orders

Search Orders

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.

get/orders/search

Query parameters

storeIdstring uuid

Example:c57ed096-24ef-49a4-a20a-d1b8bf770980

Unique identifier for a store on Extend

transactionIdstring

Example:123EY1

Unique identifier provided by merchant for transaction associated to Extend contract purchased.

customerPhonestring string

Example:415-123-4567

Phone number of customer who purchased the contract.

customerEmailstring string

Example:customer@extend.com

Email of customer who purchased the contract.

merchantCustomerIdstring

Example:c57ed096-24ef-49a4-a20a-d1b8bf770980

Unique identifier for the customer in the merchant’s system.

Headers

Content-Typestring required

Example:application/json

Used to indicate the original media type of the resource (prior to any content encoding applied for sending).

X-Extend-Access-Tokenstring required

Example:ExtendAccessToken

An Extend private API key used to authenticate requests.

Acceptstring required

Example:application/json; version=2022-02-01

Indicates which content types, expressed as MIME types, the client is able to understand, as well as identifies which API version to use in the request.

Response

Successful search response.

nextPageCursorstring

Cursor used to retrieve the next page of results, which should be provided in the search response (if applicable).

limitinteger

The maximum number of items to search and filter through for results.

Example response

{
  "nextPageCursor": "eyJjcmVhdGVkQXQiOjE2MzM3Mjc1NzY2MjMsIml0ZW1JZCI6IkNPTlRSQUNUOjoxNjAyMDRjYi1mZDMxLTRjMmItOWI3MC1kMTczZDljYTJhMzIiLCJzb3J0S2V5IjoiQ09OVFJBQ1Q6OjE2MDIwNGNiLWZkMzEtNGMyYi05YjcwLWQxNzNkOWNhMmEzMiIsInNlbGxlcklkIjoiNjBiNWU3Y2QtMWRiZC00NzczLWI0NzAtMGRmNzIzOTU3ZWNlIn0=",
  "limit": 500,
  "orders": [
    {
      "analytics": {
        "contractPlanCategory": "Service Contract",
        "customerStatus": "existing",
        "customerType": "Consumer",
        "discountSource": "Email promo",
        "loyaltyStatus": "elite",
        "paymentMethod": "Credit",
        "paymentInstrument": "Visa",
        "marketingOptIn": true
      },
      "createdAt": 1557267465,
      "customer": {
        "billingAddress": {
          "address1": "535 Mission Street",
          "address2": "11th Floor",
          "city": "San Francisco",
          "countryCode": "US",
          "postalCode": "94526",
          "province": "CA"
        },
        "email": "customer@gmail.com",
        "name": "John Smith",
        "locale": "en-us",
        "loyaltyStatus": "member",
        "phone": "123-456-7890",
        "region": "US",
        "shippingAddress": {
          "address1": "535 Mission Street",
          "address2": "11th Floor",
          "city": "San Francisco",
          "countryCode": "US",
          "postalCode": "94526",
          "province": "CA"
        },
        "subdivision": "CA"
      },
      "discountAmountTotal": 430,
      "id": "c57ed096-24ef-49a4-a20a-d1b8bf770980",
      "lineItems": [
        "4ae25d7e-0f2d-4d8c-9ca3-67455eb1dd6e"
      ],
      "merchantCustomerId": "c57ed096-24ef-49a4-a20a-d1b8bf770980",
      "poNumber": "PO1403X9",
      "productCostTotal": 19000,
      "refundedAt": 1557267465,
      "resellerMerchant": {
        "id": "154ebea0-6c1b-46a4-b166-032246330526",
        "name": "Acme Reseller Company",
        "domain": "https://acme.reseller.com"
      },
      "saleOrigin": {
        "agentId": "sales agent",
        "channel": "web",
        "integratorId": "vs03jskavj",
        "locationId": "Store #123",
        "platform": "BigCommerce",
        "storeAddress": {
          "address1": "535 Mission Street",
          "address2": "11th Floor",
          "city": "San Francisco",
          "countryCode": "US",
          "postalCode": "94526",
          "province": "CA"
        }
      },
      "shippingCostTotal": 1999,
      "shippingTaxCostTotal": 137,
      "status": "closed",
      "storeId": "c57ed096-24ef-49a4-a20a-d1b8bf770980",
      "storeName": "Bright Jewelers",
      "taxCostTotal": 1299,
      "total": 5999,
      "transactionId": "c57ed096-24ef-49a4-a20a-d1b8bf770980",
      "updatedAt": 1557267465,
      "waitPeriod": 2
    }
  ]
}