Get Products

get

https://api.qpilot.cloud/Sites/{siteId}/Products

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

siteId

int64

required

The site identifier

Query Params

availability

string

enum

The product availability

Allowed:

minPrice

float

The minimum product price

maxPrice

float

The maximum product price

addToScheduledOrder

boolean

Products that can be added to scheduled orders

processScheduledOrder

boolean

Products that can be processed within a scheduled order

string

Search criteria

groupIds

array of int64s

Group identifiers that the product may belong to

groupIds

productIds

array of strings

Only get products where the product identifier is contained on the specified product identifiers

productIds

metadataKey

array of strings

A metadata keys array. See Querying by metadata

metadataKey

metadataValue

array of strings

A metadata values array. See Querying by metadata

metadataValue

active

boolean

Defaults to true

Product is active

valid

boolean

Defaults to true

Product is valid

page

int32

Defaults to 1

The one-based page number

pageSize

int32

Defaults to 100

The page size

orderBy

string

Defaults to Id

Order by field

order

string

Defaults to asc

Order asc or desc

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Response

Language

Credentials

Header

Loading…

Response

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

text/plain

application/json

text/json

200Success