Read Sales Transaction (POST)

Retrieve sales transaction data efficiently from an initialized or a hydrated context.

Resource

1/connect/revenue/transaction-management/sales-transactions/actions/read

Resource Example

1https://{yourInstance}.salesforce.com/services/data/v68.0/connect/revenue/transaction-management/sales-transactions/actions/read

Available Version

65.0

HTTP Methods

POST

Request Body for POST

JSON Examples

1{
2  "contextId": "008d27d7-e004-4906-a949-ee7d7c323c77",
3  "batchIndices": [
4    0,
5    1
6  ],
7  "sobjectFieldMap": {
8    "Quote": [],
9    "QuoteLineItem": [
10      "Quantity",
11      "Product2Id"
12    ]
13  },
14  "filters": [
15    {
16      "sobjectName": "Quote",
17      "fieldName": "Status",
18      "operator": "Equals",
19      "operands": [
20        {
21          "value": "Draft",
22          "type": "STRING"
23        }
24      ]
25    }
26  ]
27}

1{
2  "contextId": "0RSxx0000004C92GAE",
3  "queryTags": [
4    "QuoteLineItem"
5  ],
6  "filters": [
7    {
8      "nodeName": "SalesTransactionItem",
9      "attributeName": "DmlStatus",
10      "operator": "In",
11      "operands": [
12        {
13          "value": "Inserted",
14          "type": "STRING"
15        },
16        {
17          "value": "Updated",
18          "type": "STRING"
19        }
20      ]
21    }
22  ]
23}

1{
2  "contextId": "0RSxx0000004C92GAE",
3  "shouldReturnMetadataOnly": true
4}

Properties

Name	Type	Description	Required or Optional	Available Version
`batchIndices`	List<Integer>	List of batch indices to fetch. The indices are zero-based. If you include this property, the API returns only the specified batches. This property supports fetching multiple batches in parallel.	Optional	68.0
`contextId`	String	ID of the context to retrieve the data records.	Required	65.0
`filters`	List<Sales Transaction Filter Condition>	Filter conditions to query the context data.	Optional	67.0
`queryTags`	List<String>	List of objects that must be retrieved from the context.	Optional	65.0
`shouldReturnMetadataOnly`	Boolean	Indicates whether to return only batch metadata without fetching batch data (`true`) or not (`false`).	Optional	68.0
`sobjectFieldMap`	Map<String, List<String>>	Mapping of an sObject name to a list. The list includes the sObject field names on the object or can be an empty list. An empty list specifies that all fields on the object must be queried.	Optional	67.0

Response Body for POST

Read Sales Transaction