Search Orders

get

https://api.helloextend.com/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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

storeId

uuid

Unique identifier for a store on Extend

transactionId

string

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

customerPhone

string

Phone number of customer who purchased the contract.

customerEmail

string

Email of customer who purchased the contract.

merchantCustomerId

string

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

Headers

Content-Type

string

required

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

X-Extend-Access-Token

string

required

An Extend private API key used to authenticate requests.

string

required

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

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful search response.