Skip to main content
GET
/
stores
/
{storeId}
/
orders
/
search
/
{query}
Search for orders
curl --request GET \
  --url https://api.komerza.com/stores/{storeId}/orders/search/{query} \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "pages": 123,
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "dateCreated": "2023-11-07T05:31:56Z",
      "items": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "dateCreated": "2023-11-07T05:31:56Z",
          "productName": "<string>",
          "productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "variantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "variantName": "<string>",
          "amount": 123,
          "lineTotal": 123,
          "additionalFeePercentage": 123,
          "additionalFeeAmount": 123,
          "quantity": 123
        }
      ],
      "gateway": "<string>",
      "customerEmail": "<string>",
      "status": "<string>",
      "currencyCode": "<string>",
      "amountPaid": 123,
      "amount": 123,
      "coupon": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "dateCreated": "2023-11-07T05:31:56Z",
        "netDecrease": 123,
        "code": "<string>",
        "couponId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "percentageDecrease": 123
      }
    }
  ]
}

Authorizations

Authorization
string
header
required

Your API key goes here

Path Parameters

storeId
string<uuid>
required

The ID of the store to search orders in.

query
string
required

The search term (order ID or customer email).

Query Parameters

dateFrom
string<date-time>

Gets or sets the starting date for filtering orders.

dateTo
string<date-time>

Represents the end date/time filter for an order.

status
string

Gets or sets the status of the order for filtering.

gateway
string

Gets or sets the gateway of the order for filtering.

email
string

Represents an email address to be used as a filter criteria.

Filters
string
Sorts
string
Page
integer<int32>
Required range: 1 <= x <= 2147483647
PageSize
integer<int32>
Required range: 1 <= x <= 2147483647

Response

The object was successfully returned.

Represents a paginated response returned from API endpoints, which contains the paginated data and metadata about the pagination.

success
boolean
required

Indicates whether the operation was successful

pages
integer<int32>
required

The total number of pages available in the paginated response.

data
object[]
required

Represents the collection of items within a paginated response