Skip to main content
GET
/
commerce
/
catalog
/
storefront
/
productsearch
/
siteSearch
Error
A valid request URL is required to generate request examples
{
  "facets": [
    {
      "label": "<string>",
      "facetType": "<string>",
      "field": "<string>",
      "values": [
        {
          "label": "<string>",
          "isApplied": true,
          "count": 123,
          "value": "<string>",
          "filterValue": "<string>",
          "rangeQueryValueStart": "<string>",
          "rangeQueryValueEnd": "<string>",
          "parentFacetValue": "<string>",
          "isDisplayed": true,
          "childrenFacetValues": [
            {}
          ]
        }
      ]
    }
  ],
  "solrDebugInfo": {
    "searchTuningRuleCode": "<string>",
    "boostedProductCodes": [
      "<string>"
    ],
    "blockedProductCodes": [
      "<string>"
    ],
    "boostQueries": [
      "<string>"
    ],
    "boostFunctions": [
      "<string>"
    ],
    "solrUrl": "<string>"
  },
  "searchRedirect": "<string>",
  "searchEngine": "<string>",
  "nextCursorMark": "<string>",
  "spellcheck": {
    "candidateCorrections": [
      {
        "query": "<string>"
      }
    ],
    "autoCorrected": true,
    "originalQuery": "<string>",
    "correctedQuery": "<string>"
  },
  "startIndex": 123,
  "pageSize": 123,
  "pageCount": 123,
  "totalCount": 123,
  "items": [
    {
      "productCode": "<string>",
      "purchaseLocation": "<string>",
      "productSequence": 123,
      "productUsage": "<string>",
      "fulfillmentTypesSupported": [
        "<string>"
      ],
      "goodsType": "<string>",
      "bundledProducts": [
        {
          "productCode": "<string>",
          "goodsType": "<string>",
          "quantity": 123,
          "measurements": {
            "packageHeight": {
              "unit": "<string>",
              "value": 123
            },
            "packageWidth": {
              "unit": "<string>",
              "value": 123
            },
            "packageLength": {
              "unit": "<string>",
              "value": 123
            },
            "packageWeight": {
              "unit": "<string>",
              "value": 123
            }
          },
          "isPackagedStandAlone": true,
          "inventoryInfo": {
            "manageStock": true,
            "outOfStockBehavior": "<string>",
            "onlineStockAvailable": 123,
            "onlineSoftStockAvailable": 123,
            "onlineLocationCode": "<string>",
            "availableDate": "2023-11-07T05:31:56Z",
            "isSubstitutable": true
          },
          "optionAttributeFQN": "<string>",
          "optionValue": "<unknown>",
          "creditValue": 123,
          "productType": "<string>",
          "content": {
            "productName": "<string>",
            "productFullDescription": "<string>",
            "productShortDescription": "<string>",
            "metaTagTitle": "<string>",
            "metaTagDescription": "<string>",
            "metaTagKeywords": "<string>",
            "seoFriendlyUrl": "<string>",
            "productImages": [
              {
                "imageLabel": "<string>",
                "altText": "<string>",
                "imageUrl": "<string>",
                "cmsId": "<string>",
                "videoUrl": "<string>",
                "mediaType": "<string>",
                "sequence": 123,
                "productImageGroupId": "<string>"
              }
            ]
          }
        }
      ],
      "content": {
        "productName": "<string>",
        "productFullDescription": "<string>",
        "productShortDescription": "<string>",
        "metaTagTitle": "<string>",
        "metaTagDescription": "<string>",
        "metaTagKeywords": "<string>",
        "seoFriendlyUrl": "<string>",
        "productImages": [
          {
            "imageLabel": "<string>",
            "altText": "<string>",
            "imageUrl": "<string>",
            "cmsId": "<string>",
            "videoUrl": "<string>",
            "mediaType": "<string>",
            "sequence": 123,
            "productImageGroupId": "<string>"
          }
        ]
      },
      "purchasableState": {
        "isPurchasable": true,
        "messages": [
          {
            "severity": "<string>",
            "source": "<string>",
            "message": "<string>",
            "validationType": "<string>",
            "sourceId": "<string>"
          }
        ]
      },
      "isActive": true,
      "publishState": "<string>",
      "price": {
        "msrp": 123,
        "price": 123,
        "priceType": "<string>",
        "salePrice": 123,
        "salePriceType": "<string>",
        "catalogSalePrice": 123,
        "catalogListPrice": 123,
        "priceListEntryEndDate": "2023-11-07T05:31:56Z",
        "discount": {
          "couponCode": "<string>",
          "discount": {
            "discountId": 123,
            "expirationDate": "2023-11-07T05:31:56Z",
            "name": "<string>",
            "friendlyDescription": "<string>",
            "impact": 123
          },
          "discounts": [
            {
              "discountId": 123,
              "expirationDate": "2023-11-07T05:31:56Z",
              "name": "<string>",
              "friendlyDescription": "<string>",
              "impact": 123
            }
          ],
          "impact": 123
        },
        "creditValue": 123,
        "effectivePricelistCode": "<string>",
        "priceListEntryCode": "<string>",
        "priceListEntryMode": "<string>"
      },
      "priceRange": {
        "lower": {
          "msrp": 123,
          "price": 123,
          "priceType": "<string>",
          "salePrice": 123,
          "salePriceType": "<string>",
          "catalogSalePrice": 123,
          "catalogListPrice": 123,
          "priceListEntryEndDate": "2023-11-07T05:31:56Z",
          "discount": {
            "couponCode": "<string>",
            "discount": {
              "discountId": 123,
              "expirationDate": "2023-11-07T05:31:56Z",
              "name": "<string>",
              "friendlyDescription": "<string>",
              "impact": 123
            },
            "discounts": [
              {
                "discountId": 123,
                "expirationDate": "2023-11-07T05:31:56Z",
                "name": "<string>",
                "friendlyDescription": "<string>",
                "impact": 123
              }
            ],
            "impact": 123
          },
          "creditValue": 123,
          "effectivePricelistCode": "<string>",
          "priceListEntryCode": "<string>",
          "priceListEntryMode": "<string>"
        },
        "upper": {
          "msrp": 123,
          "price": 123,
          "priceType": "<string>",
          "salePrice": 123,
          "salePriceType": "<string>",
          "catalogSalePrice": 123,
          "catalogListPrice": 123,
          "priceListEntryEndDate": "2023-11-07T05:31:56Z",
          "discount": {
            "couponCode": "<string>",
            "discount": {
              "discountId": 123,
              "expirationDate": "2023-11-07T05:31:56Z",
              "name": "<string>",
              "friendlyDescription": "<string>",
              "impact": 123
            },
            "discounts": [
              {
                "discountId": 123,
                "expirationDate": "2023-11-07T05:31:56Z",
                "name": "<string>",
                "friendlyDescription": "<string>",
                "impact": 123
              }
            ],
            "impact": 123
          },
          "creditValue": 123,
          "effectivePricelistCode": "<string>",
          "priceListEntryCode": "<string>",
          "priceListEntryMode": "<string>"
        }
      },
      "volumePriceBands": [
        {
          "isCurrent": true,
          "minQty": 123,
          "maxQty": 123,
          "priceRange": {
            "lower": {
              "msrp": 123,
              "price": 123,
              "priceType": "<string>",
              "salePrice": 123,
              "salePriceType": "<string>",
              "catalogSalePrice": 123,
              "catalogListPrice": 123,
              "priceListEntryEndDate": "2023-11-07T05:31:56Z",
              "discount": {
                "couponCode": "<string>",
                "discount": {
                  "discountId": 123,
                  "expirationDate": "2023-11-07T05:31:56Z",
                  "name": "<string>",
                  "friendlyDescription": "<string>",
                  "impact": 123
                },
                "discounts": [
                  {
                    "discountId": 123,
                    "expirationDate": "2023-11-07T05:31:56Z",
                    "name": "<string>",
                    "friendlyDescription": "<string>",
                    "impact": 123
                  }
                ],
                "impact": 123
              },
              "creditValue": 123,
              "effectivePricelistCode": "<string>",
              "priceListEntryCode": "<string>",
              "priceListEntryMode": "<string>"
            },
            "upper": {
              "msrp": 123,
              "price": 123,
              "priceType": "<string>",
              "salePrice": 123,
              "salePriceType": "<string>",
              "catalogSalePrice": 123,
              "catalogListPrice": 123,
              "priceListEntryEndDate": "2023-11-07T05:31:56Z",
              "discount": {
                "couponCode": "<string>",
                "discount": {
                  "discountId": 123,
                  "expirationDate": "2023-11-07T05:31:56Z",
                  "name": "<string>",
                  "friendlyDescription": "<string>",
                  "impact": 123
                },
                "discounts": [
                  {
                    "discountId": 123,
                    "expirationDate": "2023-11-07T05:31:56Z",
                    "name": "<string>",
                    "friendlyDescription": "<string>",
                    "impact": 123
                  }
                ],
                "impact": 123
              },
              "creditValue": 123,
              "effectivePricelistCode": "<string>",
              "priceListEntryCode": "<string>",
              "priceListEntryMode": "<string>"
            }
          },
          "price": {
            "msrp": 123,
            "price": 123,
            "priceType": "<string>",
            "salePrice": 123,
            "salePriceType": "<string>",
            "catalogSalePrice": 123,
            "catalogListPrice": 123,
            "priceListEntryEndDate": "2023-11-07T05:31:56Z",
            "discount": {
              "couponCode": "<string>",
              "discount": {
                "discountId": 123,
                "expirationDate": "2023-11-07T05:31:56Z",
                "name": "<string>",
                "friendlyDescription": "<string>",
                "impact": 123
              },
              "discounts": [
                {
                  "discountId": 123,
                  "expirationDate": "2023-11-07T05:31:56Z",
                  "name": "<string>",
                  "friendlyDescription": "<string>",
                  "impact": 123
                }
              ],
              "impact": 123
            },
            "creditValue": 123,
            "effectivePricelistCode": "<string>",
            "priceListEntryCode": "<string>",
            "priceListEntryMode": "<string>"
          }
        }
      ],
      "volumePriceRange": {
        "lower": {
          "msrp": 123,
          "price": 123,
          "priceType": "<string>",
          "salePrice": 123,
          "salePriceType": "<string>",
          "catalogSalePrice": 123,
          "catalogListPrice": 123,
          "priceListEntryEndDate": "2023-11-07T05:31:56Z",
          "discount": {
            "couponCode": "<string>",
            "discount": {
              "discountId": 123,
              "expirationDate": "2023-11-07T05:31:56Z",
              "name": "<string>",
              "friendlyDescription": "<string>",
              "impact": 123
            },
            "discounts": [
              {
                "discountId": 123,
                "expirationDate": "2023-11-07T05:31:56Z",
                "name": "<string>",
                "friendlyDescription": "<string>",
                "impact": 123
              }
            ],
            "impact": 123
          },
          "creditValue": 123,
          "effectivePricelistCode": "<string>",
          "priceListEntryCode": "<string>",
          "priceListEntryMode": "<string>"
        },
        "upper": {
          "msrp": 123,
          "price": 123,
          "priceType": "<string>",
          "salePrice": 123,
          "salePriceType": "<string>",
          "catalogSalePrice": 123,
          "catalogListPrice": 123,
          "priceListEntryEndDate": "2023-11-07T05:31:56Z",
          "discount": {
            "couponCode": "<string>",
            "discount": {
              "discountId": 123,
              "expirationDate": "2023-11-07T05:31:56Z",
              "name": "<string>",
              "friendlyDescription": "<string>",
              "impact": 123
            },
            "discounts": [
              {
                "discountId": 123,
                "expirationDate": "2023-11-07T05:31:56Z",
                "name": "<string>",
                "friendlyDescription": "<string>",
                "impact": 123
              }
            ],
            "impact": 123
          },
          "creditValue": 123,
          "effectivePricelistCode": "<string>",
          "priceListEntryCode": "<string>",
          "priceListEntryMode": "<string>"
        }
      },
      "availableShippingDiscounts": [
        {
          "discountId": 123,
          "expirationDate": "2023-11-07T05:31:56Z",
          "name": "<string>",
          "friendlyDescription": "<string>",
          "impact": 123
        }
      ],
      "productType": "<string>",
      "productTypeId": 123,
      "isTaxable": true,
      "isRecurring": true,
      "pricingBehavior": {
        "discountsRestricted": true,
        "discountsRestrictedStartDate": "2023-11-07T05:31:56Z",
        "discountsRestrictedEndDate": "2023-11-07T05:31:56Z"
      },
      "inventoryInfo": {
        "manageStock": true,
        "outOfStockBehavior": "<string>",
        "onlineStockAvailable": 123,
        "onlineSoftStockAvailable": 123,
        "onlineLocationCode": "<string>",
        "availableDate": "2023-11-07T05:31:56Z",
        "isSubstitutable": true
      },
      "createDate": "2023-11-07T05:31:56Z",
      "updateDate": "2023-11-07T05:31:56Z",
      "dateFirstAvailableInCatalog": "2023-11-07T05:31:56Z",
      "catalogStartDate": "2023-11-07T05:31:56Z",
      "catalogEndDate": "2023-11-07T05:31:56Z",
      "daysAvailableInCatalog": 123,
      "upc": "<string>",
      "upCs": [
        "<string>"
      ],
      "mfgPartNumber": "<string>",
      "mfgPartNumbers": [
        "<string>"
      ],
      "variationProductCode": "<string>",
      "categories": [
        {
          "categoryId": 123,
          "parentCategory": {},
          "content": {
            "categoryImages": [
              {
                "imageLabel": "<string>",
                "altText": "<string>",
                "imageUrl": "<string>",
                "cmsId": "<string>",
                "videoUrl": "<string>",
                "mediaType": "<string>",
                "sequence": 123
              }
            ],
            "name": "<string>",
            "description": "<string>",
            "pageTitle": "<string>",
            "metaTagTitle": "<string>",
            "metaTagDescription": "<string>",
            "metaTagKeywords": "<string>",
            "slug": "<string>"
          },
          "childrenCategories": [
            {}
          ],
          "sequence": 123,
          "isDisplayed": true,
          "categoryCode": "<string>",
          "count": 123,
          "updateDate": "2023-11-07T05:31:56Z",
          "shouldSlice": true,
          "attributes": [
            {
              "fullyQualifiedName": "<string>",
              "dataType": 123,
              "values": [
                "<unknown>"
              ]
            }
          ]
        }
      ],
      "productRules": [
        "<string>"
      ],
      "measurements": {
        "packageHeight": {
          "unit": "<string>",
          "value": 123
        },
        "packageWidth": {
          "unit": "<string>",
          "value": 123
        },
        "packageLength": {
          "unit": "<string>",
          "value": 123
        },
        "packageWeight": {
          "unit": "<string>",
          "value": 123
        }
      },
      "isPackagedStandAlone": true,
      "properties": [
        {
          "attributeFQN": "<string>",
          "isHidden": true,
          "isMultiValue": true,
          "attributeDetail": {
            "valueType": "<string>",
            "inputType": "<string>",
            "dataType": "<string>",
            "usageType": "<string>",
            "dataTypeSequence": 123,
            "name": "<string>",
            "description": "<string>",
            "validation": {
              "regularExpression": "<string>",
              "minStringLength": 123,
              "maxStringLength": 123,
              "minNumericValue": 123,
              "maxNumericValue": 123,
              "minDateValue": "2023-11-07T05:31:56Z",
              "maxDateValue": "2023-11-07T05:31:56Z"
            },
            "searchableInStorefront": true,
            "searchDisplayValue": true,
            "allowFilteringAndSortingInStorefront": true,
            "indexValueWithCase": true,
            "customWeightInStorefrontSearch": true,
            "displayIntention": "<string>",
            "availableForOrderRouting": true
          },
          "values": [
            {
              "value": "<unknown>",
              "stringValue": "<string>",
              "displayInfo": {
                "cmsId": "<string>",
                "imageUrl": "<string>",
                "colorValue": "<string>"
              }
            }
          ],
          "propertyType": "<string>"
        }
      ],
      "options": [
        {
          "attributeFQN": "<string>",
          "isRequired": true,
          "isMultiValue": true,
          "values": [
            {
              "value": "<unknown>",
              "attributeValueId": 123,
              "stringValue": "<string>",
              "isEnabled": true,
              "isSelected": true,
              "isDefault": true,
              "deltaWeight": 123,
              "deltaPrice": 123,
              "shopperEnteredValue": "<unknown>",
              "bundledProduct": {
                "productCode": "<string>",
                "goodsType": "<string>",
                "quantity": 123,
                "measurements": {
                  "packageHeight": {
                    "unit": "<string>",
                    "value": 123
                  },
                  "packageWidth": {
                    "unit": "<string>",
                    "value": 123
                  },
                  "packageLength": {
                    "unit": "<string>",
                    "value": 123
                  },
                  "packageWeight": {
                    "unit": "<string>",
                    "value": 123
                  }
                },
                "isPackagedStandAlone": true,
                "inventoryInfo": {
                  "manageStock": true,
                  "outOfStockBehavior": "<string>",
                  "onlineStockAvailable": 123,
                  "onlineSoftStockAvailable": 123,
                  "onlineLocationCode": "<string>",
                  "availableDate": "2023-11-07T05:31:56Z",
                  "isSubstitutable": true
                },
                "optionAttributeFQN": "<string>",
                "optionValue": "<unknown>",
                "creditValue": 123,
                "productType": "<string>",
                "content": {
                  "productName": "<string>",
                  "productFullDescription": "<string>",
                  "productShortDescription": "<string>",
                  "metaTagTitle": "<string>",
                  "metaTagDescription": "<string>",
                  "metaTagKeywords": "<string>",
                  "seoFriendlyUrl": "<string>",
                  "productImages": [
                    {
                      "imageLabel": "<string>",
                      "altText": "<string>",
                      "imageUrl": "<string>",
                      "cmsId": "<string>",
                      "videoUrl": "<string>",
                      "mediaType": "<string>",
                      "sequence": 123,
                      "productImageGroupId": "<string>"
                    }
                  ]
                }
              },
              "displayInfo": {
                "cmsId": "<string>",
                "imageUrl": "<string>",
                "colorValue": "<string>"
              }
            }
          ],
          "attributeDetail": {
            "valueType": "<string>",
            "inputType": "<string>",
            "dataType": "<string>",
            "usageType": "<string>",
            "dataTypeSequence": 123,
            "name": "<string>",
            "description": "<string>",
            "validation": {
              "regularExpression": "<string>",
              "minStringLength": 123,
              "maxStringLength": 123,
              "minNumericValue": 123,
              "maxNumericValue": 123,
              "minDateValue": "2023-11-07T05:31:56Z",
              "maxDateValue": "2023-11-07T05:31:56Z"
            },
            "searchableInStorefront": true,
            "searchDisplayValue": true,
            "allowFilteringAndSortingInStorefront": true,
            "indexValueWithCase": true,
            "customWeightInStorefrontSearch": true,
            "displayIntention": "<string>",
            "availableForOrderRouting": true
          },
          "isProductImageGroupSelector": true
        }
      ],
      "variations": [
        {
          "productCode": "<string>",
          "upc": "<string>",
          "options": [
            {
              "valueSequence": 123,
              "attributeFQN": "<string>",
              "value": "<unknown>"
            }
          ],
          "inventoryInfo": {
            "manageStock": true,
            "outOfStockBehavior": "<string>",
            "onlineStockAvailable": 123,
            "onlineSoftStockAvailable": 123,
            "onlineLocationCode": "<string>",
            "availableDate": "2023-11-07T05:31:56Z",
            "isSubstitutable": true
          }
        }
      ],
      "validPriceLists": [
        "<string>"
      ],
      "locationsInStock": [
        "<string>"
      ],
      "slicingAttributeFQN": "<string>",
      "productImageGroups": [
        {
          "productImageGroupId": "<string>",
          "productImageGroupTags": [
            {
              "attributeFqn": "<string>",
              "value": "<string>"
            }
          ]
        }
      ],
      "sliceValue": "<string>",
      "productCollections": [
        {
          "productCode": "<string>",
          "isPrimary": true
        }
      ],
      "productCollectionMembers": [
        {
          "memberKey": {
            "value": "<string>"
          }
        }
      ],
      "collectionMembersProductContent": [
        {
          "productName": "<string>",
          "productFullDescription": "<string>",
          "productShortDescription": "<string>",
          "metaTagTitle": "<string>",
          "metaTagDescription": "<string>",
          "metaTagKeywords": "<string>",
          "seoFriendlyUrl": "<string>",
          "productImages": [
            {
              "imageLabel": "<string>",
              "altText": "<string>",
              "imageUrl": "<string>",
              "cmsId": "<string>",
              "videoUrl": "<string>",
              "mediaType": "<string>",
              "sequence": 123,
              "productImageGroupId": "<string>"
            }
          ]
        }
      ],
      "score": 123,
      "personalizationScore": 123,
      "costPriceMargin": 123
    }
  ]
}

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Query Parameters

query
string

The terms to search on.

collapse
boolean
default:true
filter
string

A set of filter expressions representing the search parameters for a query: eq=equals, ne=not equals, gt=greater than, lt = less than or equals, gt = greater than or equals, lt = less than or equals, sw = starts with, or cont = contains. Optional.

facetTemplate
string

Identifier of the current category, in the format of either categoryCode:{categoryCode} or categoryId:{categoryId}. In the example of no category being selected, the root will be used instead. Refer to the corresponding Catalog Admin call.

facetTemplateSubset
string

Use if you only want to return a subset of the facets defined in the template such has category, price, rating.

facet
string

The additional facets to use (comma delimited) that are not already defined in the facet template in the Product Admin API.

facetFieldRangeQuery
string
facetHierPrefix
string

Allows you to skip these levels on a hierarchical facet.

facetHierValue
string

The current level to pull categories from, in the format of categoryId:{categoryId}.

facetHierDepth
string

The number of levels to return such as category:1.

facetStartIndex
string
facetPageSize
string
facetSettings
string

May be deprecated.

facetValueFilter
string

A comma delimited list of applied facetsValues (such as tenant~brand-name-attribute%3abroil+king). If the facet is part of the search results facet template as a “range” display style, then you can specify a min and max that doesn't have to match the predefined ranges (such as &facetValueFilter=price:[38 to 105]).

sortBy
string

The element to sort the results by and the order in which the results appear. Either ascending (a-z) or descending (z-a) order. Optional.

pageSize
integer<int32>

Used to page results from a query. Indicates the maximum number of entities to return from a query. The default value is 12 and the maximum value is 200. Optional.

startIndex
integer<int32>
default:0

Used to page results from a query. Indicates the zero-based offset in the complete result set where the returned entities begin. The default value is 0. Optional.

searchSettings
string

Use this to override search settings for testing purposes in the format of &searchSettings=testConfig1.

enableSearchTuningRules
boolean
default:true

Whether or not to enable search tuning rules.

searchTuningRuleContext
string

Deprecated or internal-only, do not use.

searchTuningRuleCode
string

Deprecated or internal-only, do not use.

responseGroups
string

Deprecated or internal-only, do not use.

facetTemplateExclude
string
facetPrefix
string
responseOptions
string

Deprecated or internal-only, do not use.

cursorMark
string

Pass in * to begin a deep page operation. The response will include a nextCursorMark value. Pass this into the next call. Continue with this pattern until nextCursorMark is null.

facetValueSort
string

Sorts the values array in a facet. Valid values are Count,Index, CountAscending, CountDescending, ValuesAscending, ValuesDescending, AttributeDefinition, and AttributeDefinitionDescending.

defaultSort
string

Deprecated or internal-only, do not use.

shouldSlice
boolean

Whether or not to slice products.

mid
string

This is the customer identifier for personalization. This value can be found in the Monetate cookie (mt.v) that is uniquely set for each visitor so that personalization of the search results can use all Monetate functionality.

fieldList
string

Explicitly request any field or attribute you want in the response. Only product codes are returned by default. Some common values include productName, priceL (price low), priceH (price high), product attribute by name, product image URLs, product category names, category IDs and codes, product short/long descriptions, and score (the relevancy score).

omitNamespace
boolean

Allows you to drop the tenant~ or similar prefix.

includeAllImages
boolean
default:false

Optional. If true return all images instead of default images.

spellcorrectOverride
string
default:Default

Valid values are Default, SkipAutocorrect, SkipDidyoumean, and SkipAll.

useSubscriptionPricing
boolean
default:false

Whether or not to use subscription pricing instead of the default product pricing.

merchandizingRuleCode
string

Optional. Use a specific search-merchandizing-rule code if provided.

responseFields
string

limits which fields are returned in the response body

Response

Success

Products and facets returned from search criteria supplied in a ProductSearch query.

facets
object[] | null
solrDebugInfo
object
searchRedirect
string | null
searchEngine
string | null
nextCursorMark
string | null
spellcheck
object

Spellcheck related results

startIndex
integer<int32>
pageSize
integer<int32>
pageCount
integer<int32>
totalCount
integer<int32>
items
object[] | null