Advanced Query DSL

By referencing most popular programming languages and technical frameworks, we have developed the Advanced Query DSL for advanced data querying. We describe the data filtering scheme using a multi-layer filter format.

The Advanced Query DSL requires the following query parameters:

• filter: Conditions for data filtering.
• offset: For pagination
• limit: For pagination

Filter Format

• FieldName: For the fields in specific API objects, please refer to the definitions in the corresponding API documentation.
• OP: For the types of data filtering conditions, please see the list below.

https://api-full-url-path?filter[$Field_Name][$OP]=value1&filter[$Field_Name][$OP]=value2

# All of paid order and initial_total >= 100
filter[initial_total][_gte]=100&filter[correspondence_state][_eq]=paid

info

1. use 0 or 1 for boolean field.
2. use 2026-01-05T15:43:18+08:00 time format for datetime field.

Filter OP List

Op Name	Comment
_eq	equal to
_neq	not equal to
_gt	greater than
_gte	greater than or equal to
_lt	less than
_lte	less than or equal to
_contains	LIKE
_not_contains	NOT LIKE

Pagination

• offset: The starting record offset
• limit: The pagination size. how many records will be returned. up to 1000.