HubSpot · Schema
BatchReadRequest
Request body for batch reading commerce payments
AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales
Properties
| Name | Type | Description |
|---|---|---|
| inputs | array | List of payment identifiers to read |
| properties | array | Properties to return for each payment |
| propertiesWithHistory | array | Properties to return with history |
| idProperty | string | The property to use as the identifier |
JSON Schema
{
"type": "object",
"description": "Request body for batch reading commerce payments",
"properties": {
"inputs": {
"type": "array",
"description": "List of payment identifiers to read",
"example": [
{
"id": "500123"
}
],
"items": {
"type": "object",
"description": "A single input item for batch read",
"properties": {
"id": {
"type": "string",
"description": "The ID of the payment to read",
"example": "500123"
}
},
"required": [
"id"
]
}
},
"properties": {
"type": "array",
"description": "Properties to return for each payment",
"example": [
"example-value"
],
"items": {
"type": "string"
}
},
"propertiesWithHistory": {
"type": "array",
"description": "Properties to return with history",
"example": [
"example-value"
],
"items": {
"type": "string"
}
},
"idProperty": {
"type": "string",
"description": "The property to use as the identifier",
"example": "500123"
}
},
"required": [
"inputs",
"properties"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "BatchReadRequest"
}