Record Tax Transaction Action

Records tax transactions from an order summary to an external system such as Stripe.

This action is available in API version 62.0 and later with these licenses:

B2B Commerce, or D2C Commerce
Salesforce Order Management

Only store administrators can access this action.

Supported REST HTTP Methods

URI: /services/data/vXX.X/actions/standard/recordTaxTransaction

Formats: JSON, XML

HTTP Methods: POST

Authentication: Authorization: Bearer token

Inputs

Input	Type	Description
`orderSummaryId`	string	Required. The ID of the order summary to record tax transaction for.

Outputs

Output	Type	Description
`taxTransactionResult`	Apex-defined	An `commercestoretax__TaxTransactionResult` record that contains details about the tax transactions recorded.

Example

Sample Request

1{
2   "inputs": [
3      {
4         "orderSummaryId": "1Osxx0000004CVcCAM"
5      }
6   ]
7}

Sample Response

1[
2  {
3    "actionName": "RECORD_TAX_TRANSACTION",
4    "errors": null,
5    "invocationId": null,
6    "isSuccess": true,
7    "outputValues": {
8      "taxTransactionResult": {
9        "success": true,
10        "resultItems": [
11          {
12            "transactionReferenceNumber": "tax_1PcknrITDqIkouLURfR4pNAM",
13            "success": true,
14            "orderItemSummaryId": "10uxx0000004EicAAE",
15            "errorMessage": null,
16            "calculationReferenceNumber": null
17          },
18          {
19            "transactionReferenceNumber": "tax_1PcknrITDqIkouLURfR4pNAM",
20            "success": true,
21            "oderItemSummaryId": "10uxx0000004EibAAE",
22            "errorMessage": null,
23            "calculationReferenceNumber": null
24          }
25        ],
26        "orderSummaryId": "1Osxx0000004CVc",
27        "errorMessage": null
28      }
29    },
30    "sortOrder": -1,
31    "version": 1
32  }
33]