HubSpot · JSON Structure

Commerce Payments Api Sort Option Structure

A sort option for ordering results

Type: object Properties: 2 Required: 2
AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales

SortOption is a JSON Structure definition published by HubSpot, describing 2 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

propertyName direction

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/hubspot/refs/heads/main/json-structure/commerce-payments-api-sort-option-structure.json",
  "name": "SortOption",
  "description": "A sort option for ordering results",
  "type": "object",
  "properties": {
    "propertyName": {
      "type": "string",
      "description": "The property to sort by",
      "example": "Example Record"
    },
    "direction": {
      "type": "string",
      "enum": [
        "ASCENDING",
        "DESCENDING"
      ],
      "description": "The sort direction",
      "example": "ASCENDING"
    }
  },
  "required": [
    "propertyName",
    "direction"
  ]
}