Get Products

post

https://{yourLidiaUrl}/metadata/query/products

Handles the get products request.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

productIds

array | null

productIds

parentIds

array | null

parentIds

categoryIds

array | null

categoryIds

excludesCategoryIds

array | null

excludesCategoryIds

excludesTrademarkIds

array | null

excludesTrademarkIds

excludesVariantIds

array | null

excludesVariantIds

trademarkIds

array | null

trademarkIds

variantIds

array | null

variantIds

integrationCodes

array of strings | null

integrationCodes

includeVariantCode

array of strings | null

includeVariantCode

names

array of strings | null

Gets or sets the names.

names

includeTrademarkNames

array of strings | null

includeTrademarkNames

includeCategoryNames

array of strings | null

includeCategoryNames

includesNames

array of strings | null

includesNames

excludesNames

array of strings | null

Gets or sets the excludes names.

excludesNames

codes

array of strings | null

Gets or sets the codes.

codes

includesCodes

array of strings | null

includesCodes

excludesCodes

array of strings | null

Gets or sets the excludes codes.

excludesCodes

productProperties

array of objects | null

Gets or sets the product properties.

productProperties

productTags

array of objects | null

Gets or sets the product tags.

productTags

excludesProductTags

array of objects | null

Gets or sets the excludes product tags.

excludesProductTags

optionIds

array | null

optionIds

excludesOptionIds

array | null

excludesOptionIds

variantProperties

array of objects | null

Gets or sets the variant properties.

variantProperties

variantTags

array of objects | null

Gets or sets the variant tags.

variantTags

excludesVariantTags

array of objects | null

Gets or sets the excludes variant tags.

excludesVariantTags

optionValueIds

array | null

optionValueIds

excludesOptionValueIds

array | null

excludesOptionValueIds

fromDate

date-time | null

Gets or sets the from date.

toDate

date-time | null

Gets or sets the to date.

environment

string | null

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

applicationIP

string | null

Gets or sets the IP address of the calling application.

tenantId

string

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

Gets or sets the tenant identifier.

userToken

string | null

Gets or sets the authentication token of the calling user.

sessionId

string | null

Gets or sets the session identifier of the calling user.

userId

string

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

Gets or sets the user identifier.

userIP

string | null

Gets or sets the IP address of the calling user.

envelope

string | null

Gets or sets the request envelope payload data.

threadId

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

searchKey

string | null

Gets or sets the keyword to perform global search operations.

pageIndex

int32 | null

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

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

pageSize

int32 | null

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

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

sorting

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:

content-type

string

enum

Defaults to application/json-patch+json

Generated from available request content types

Allowed:

Response

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

text/plain

application/json

text/json

200OK