Search for orders

Retrieves orders based on a keyword search.

get/orders/search

Request

  • Base URL
    https://api.ecommerceapi.uk/v1
  • URL
    https://api.ecommerceapi.uk/v1/orders/search
  • Auth
    HTTP basic

Query parameters

keywordsstring

Keyword(s) to search for (e.g., order reference, customer name).

sort'score' | 'title_asc' | 'title_desc'

Sort order.

offsetinteger

Number of records to skip.

countinteger

Number of records to retrieve.

session_idinteger

Ensures consistent search results in subsequent calls.

Response

A list of orders that match the search.

totalItemsinteger

Total number of matching orders.

Changes

No recorded changes to this operation across all 1 revision of this API.