HubSpot · JSON Structure

Hubspot Commerce Payments Search Request Structure

Request body for searching commerce payments

Type: object Properties: 6

AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales

SearchRequest is a JSON Structure definition published by HubSpot, describing 6 properties. It conforms to the https://json-structure.org/draft/2020-12/schema meta-schema.

Properties

query limit after sorts properties filterGroups

Meta-schema: https://json-structure.org/draft/2020-12/schema

JSON Structure

{
  "type": "object",
  "description": "Request body for searching commerce payments",
  "name": "SearchRequest",
  "properties": {
    "query": {
      "type": "string",
      "description": "Search query string"
    },
    "limit": {
      "type": "integer",
      "description": "Maximum number of results"
    },
    "after": {
      "type": "string",
      "description": "Pagination cursor"
    },
    "sorts": {
      "type": "array",
      "description": "Sort order for results",
      "items": {
        "type": "object",
        "description": "A sort option for ordering results",
        "properties": {
          "propertyName": {
            "type": "string",
            "description": "The property to sort by"
          },
          "direction": {
            "type": "string",
            "description": "The sort direction",
            "enum": [
              "ASCENDING",
              "DESCENDING"
            ]
          }
        },
        "required": [
          "propertyName",
          "direction"
        ]
      }
    },
    "properties": {
      "type": "array",
      "description": "Properties to return",
      "items": {
        "type": "string"
      }
    },
    "filterGroups": {
      "type": "array",
      "description": "Filter groups for the search",
      "items": {
        "type": "object",
        "description": "A group of filters combined with AND logic",
        "properties": {
          "filters": {
            "type": "array",
            "items": {
              "type": "object",
              "description": "A single filter criterion",
              "properties": {
                "propertyName": {
                  "type": "string",
                  "description": "The property to filter on"
                },
                "operator": {
                  "type": "string",
                  "description": "The comparison operator",
                  "enum": [
                    "EQ",
                    "NEQ",
                    "LT",
                    "LTE",
                    "GT",
                    "GTE",
                    "BETWEEN",
                    "IN",
                    "NOT_IN",
                    "HAS_PROPERTY",
                    "NOT_HAS_PROPERTY",
                    "CONTAINS_TOKEN",
                    "NOT_CONTAINS_TOKEN"
                  ]
                },
                "value": {
                  "type": "string",
                  "description": "The value to compare against"
                },
                "values": {
                  "type": "array",
                  "description": "Values for IN/NOT_IN operators",
                  "items": {
                    "type": "object"
                  }
                },
                "highValue": {
                  "type": "string",
                  "description": "Upper bound for BETWEEN operator"
                }
              },
              "required": [
                "propertyName",
                "operator"
              ]
            }
          }
        },
        "required": [
          "filters"
        ]
      }
    }
  },
  "$schema": "https://json-structure.org/draft/2020-12/schema"
}