ExecuteQuery

Handles the execute query request.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
enum

Allowed values: Products (100), ProductCodes (101), ProductDimensions (102), ProductDocuments (103), ProductDocumentTags (104), ProductOptions (105), ProductPictures (106), ProductProperties (107), ProductPropertyTranslations (108), ProductRelations (109), ProductRelationTranslations (110), ProductTags (111), ProductTranslations (112), RelatedProducts (113), Categories (200), CategoryDimensions (201), CategoryFilters (202), CategoryFilterOptions (203), CategoryPictures (204), CategoryProducts (205), CategoryProperties (206), CategoryTags (207), CategoryTranslations (208), CategoryVariantLists (209), Trademarks (300), TrademarkFilters (301), TrademarkFilterOptions (302), TrademarkPictures (303), TrademarkProducts (304), TrademarkProperties (305), TrademarkTags (306), TrademarkTranslations (307), TrademarkVariantLists (308), Currencies (400), CurrencyTranslations (401), CustomLists (500), CustomListDocuments (501), CustomListPictures (502), CustomListTags (503), CustomListProperties (504), CustomListPropertyTranslations (505), CustomListTranslations (506), CustomListItems (507), CustomListItemPictures (508), CustomListItemProperties (509), CustomListItemTags (510), CustomListFilters (511), CustomListFilterOptions (512), DataFeeds (700), FeedCategories (701), FeedCustomLists (702), FeedSalesEvents (703), FeedTrademarks (704), DataPools (800), DataPoolTags (801), DataPoolProperties (802), DataPoolItem (803), DataPoolItemTags (804), DataPoolItemFieldValues (805), DataSchemas (900), DataSchemaCategories (901), DataSchemaFields (902), DataSchemaTemplates (903), DataSchemaDocuments (904), Languages (1000), MeasurementUnits (1100), MeasurementUnitTranslations (1101), MeasurementGroups (1102), MeasurementGroupTranslations (1103), Options (1200), OptionTranslations (1201), OptionGroups (1202), OptionGroupTranslations (1203), OptionValues (1204), OptionValueTranslations (1205), OptionValueGroups (1206), OptionValueGroupTranslations (1207), Packagings (1300), PackagingDimensions (1301), Prices (1400), PriceLists (1401), Properties (1500), PropertyTranslations (1501), PropertyGroups (1502), PropertyGroupTranslations (1503), SalesEvents (1600), SalesEventTags (1601), SalesEventProperties (1602), SalesEventItems (1603), Segments (1700), SegmentTranslations (1701), Tags (1800), TagTranslations (1801), Variants (1900), VariantTags (1901), VariantProperties (1902), VariantTranslations (1903), VariantPropertyTranslations (1904), VariantOptionValues (1905), RelatedVariants (1906), Warranties (2000), DataLocks (2100), DataLockBlocks (2101), DataLockConditions (2102).

subQueries
array of objects | null

Gets or sets the sub queries.

subQueries
string
enum

Allowed values: MSSQL (0), Mongo (1), PostgreSQL (2).

Allowed:
filters
array of objects | null

Gets or sets the filters.

filters
fields
array of strings | null

Gets or sets the fields.

fields
string | null

Gets or sets the environment name (e.g. dev, test, prod).

string | null

Gets or sets the IP address of the calling application.

string
^-?(?:0|[1-9]\d*)$

Gets or sets the tenant identifier.

string | null

Gets or sets the authentication token of the calling user.

string | null

Gets or sets the session identifier of the calling user.

string
^-?(?:0|[1-9]\d*)$

Gets or sets the user identifier.

string | null

Gets or sets the IP address of the calling user.

string | null

Gets or sets the request envelope payload data.

string | null

Gets or sets the unique thread tracking identifier.

includes
array of strings | null

Gets or sets the collection of navigation properties or relationships to include in the query.

includes
string | null

Gets or sets the keyword to perform global search operations.

string
^-?(?:0|[1-9]\d*)$

Gets or sets the zero-based index of the page to retrieve.

string
^-?(?:0|[1-9]\d*)$

Gets or sets the maximum number of items to retrieve in a single page.

string | null

Gets or sets the sorting criteria string (e.g. 'FieldName DESC').

status
array of objects | null

Gets or sets the collection of statuses to filter entities by.

status
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json-patch+json

Generated from available request content types

Allowed:
Response

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json