Search Orders

Search for all Orders placed through your application given certain filter critera.

This endpoint will only return completed orders by default (no carts). However it is possible to use this endpoint as a "Search Carts" endpoint by combining two parameters. If you wish to include IN_PROGRESS orders AKA carts you can set the exclude_in_progress query param to false.

If you want to use order search to only search for IN_PROGRESS orders, that is to say, searching for carts, you can include the the following query in your search body: {"bag_status": "IN_PROGRESS"}. You must still set exclude_in_progress to false in this case.

Search Orders

post

Searches for orders matching the specified filter criteria. Supports filtering by order ID, bag ID, order status, bag status, merchant ID, customer name, customer email, SKU name, app order ID, referral ID, total amount, and date ranges (created, submitted, last modified). Results are returned as a paginated VioletPage. When extended=true, app names are included in the response. By default, in-progress orders are excluded. Supports custom sorting via sort_by and sort_direction fields in the request body. Maximum page size is 100.

Query parameters

pageinteger · int32Optional

Page number to retrieve, starting from 1

Default: 1Example: 1

sizeinteger · int32Optional

Number of orders per page (default 20, max 100)

Default: 20Example: 20

extendedbooleanOptional

When true, includes additional app name information in the response

Default: false

exclude_in_progressbooleanOptional

When true (default), excludes orders in IN_PROGRESS status from results

Default: true

Header parameters

X-Violet-TokenstringRequired

API token for authentication

X-Violet-App-SecretstringRequired

Application secret key

X-Violet-App-Idinteger · int32Required

Application ID

Example: 10000

Body

application/json

Order Search Request

user_idinteger · int64Optional

User ID

order_idinteger · int64Optional

Order ID

referral_idstringOptional

Referral ID

bag_idinteger · int64Optional

Bag ID

bag_statusstring · enumOptional

Bag Status

Possible values:

merchant_idinteger · int32Optional

Merchant ID

before_datestring · date-timeOptionalDeprecated

Use date_created:max.

after_datestring · date-timeOptionalDeprecated

Use date_created:min.

app_order_idstringOptional

Order ID in the Channels System

customer_namestringOptional

Full customer name to search by - case insensitive.

customer_emailstringOptional

Customer email to search by - case insensitive.

sku_namestringOptional

Name of an Sku present in the order - case insensitive.

totalinteger · int32Optional

Exact total to search.

statusstring · enumOptional

Order status to search.

Possible values:

sort_bystringOptional

Order property to sort by in camel case.

sort_directionstringOptional

Direction to sort results by.

date_last_modified:minstring · date-timeOptional

Only include orders modified after this date.

Pattern: yyyy-MM-dd'T'HH:mm:ssZ

date_last_modified:maxstring · date-timeOptional

Only include orders modified before this date.

Pattern: yyyy-MM-dd'T'HH:mm:ssZ

date_created:minstring · date-timeOptional

Only include orders created after this date.

Pattern: yyyy-MM-dd'T'HH:mm:ssZ

date_created:maxstring · date-timeOptional

Only include orders created before this date.

Pattern: yyyy-MM-dd'T'HH:mm:ssZ

date_submitted:minstring · date-timeOptional

Only include orders submitted after this date.

Pattern: yyyy-MM-dd'T'HH:mm:ssZ

date_submitted:maxstring · date-timeOptional

Only include orders submitted before this date.

Pattern: yyyy-MM-dd'T'HH:mm:ssZ

Responses

200

success

application/json

lastbooleanOptional

Boolean indicating if this is the last page

total_pagesinteger · int32Optional

The total count of pages available

total_elementsinteger · int32Optional

The total count of objects available

firstbooleanOptional

Boolean indicating if this is the first page of the response

number_of_elementsinteger · int32Optional

The total number of objects in this specific response

sizeinteger · int32Optional

The page size selected at request time

numberinteger · int32Optional

The page number selected at request time

emptybooleanOptional

Boolean indicating if the response content is empty

next_page_cursorstringOptional

Contains the cursor for the next page. This property will only be used for situations where the API does not support the page number/page size paradigm and it will mutually exclusive with the size/number fields in the response. If this property is returned it must be passed when requesting the next page from the API. Does not apply to endpoints that do not have a next_page_cursor query param documented.

400

bad request

application/json

403

forbidden

application/json

404

not found

application/json

500

internal server error

application/json

post

/orders/search

HTTPcURLJavaScriptPython

POST /v1/orders/search HTTP/1.1
Host: sandbox-api.violet.io
X-Violet-Token: text
X-Violet-App-Secret: text
X-Violet-App-Id: 1
Content-Type: application/json
Accept: */*
Content-Length: 22

{
  "status": "COMPLETED"
}

Find all completed ordersFind orders created within a date rangeFind orders by customer email addressLook up a specific order by ID

{
  "content": [
    {
      "id": 10000,
      "token": "fz8x7gksdjsy2p9fdlonw7k9svwjso4b",
      "app_id": 10000,
      "developer_id": 10000,
      "customer": {
        "first_name": "Super",
        "last_name": "Mario",
        "email": "[email protected]"
      },
      "bags": [
        {
          "id": 11111,
          "order_id": 10000,
          "merchant_id": 10000,
          "status": "COMPLETED",
          "fulfillment_status": "FULFILLED",
          "financial_status": "PAID",
          "skus": [
            {
              "id": 10000,
              "sku_id": 99999,
              "name": "Nintendo Entertainment System",
              "quantity": 2,
              "price": 9999,
              "line_price": 19998
            }
          ],
          "sub_total": 19998,
          "shipping_total": 644,
          "tax_total": 2050,
          "total": 22692,
          "platform": "SHOPIFY",
          "bag_id": 11111,
          "bag_status": "COMPLETED",
          "merchant_name": "Legacy Games"
        }
      ],
      "sub_total": 19998,
      "shipping_total": 644,
      "tax_total": 2050,
      "total": 22692,
      "status": "COMPLETED",
      "date_created": "2024-06-28T20:31:56+0000",
      "date_last_modified": "2024-06-28T20:31:56+0000",
      "currency": "USD",
      "order_id": 10000
    }
  ],
  "last": false,
  "total_pages": 3,
  "total_elements": 47,
  "first": true,
  "number_of_elements": 20,
  "size": 20,
  "number": 1,
  "empty": false
}