Communications, Media, Energy and Utilities (CME) Developer Guide
jObject with Reference Input
Input representation of a list of records to be inserted or updated. To update a
record, specify the record ID.
JSON Example
1{
2 "referenceId": "refOrderItem0",
3 "record": {
4 "attributes": {
5 "type": "OrderItem",
6 "method": "POST"
7 },
8 "OrderId": "@{refOrder.id}",
9 "OrderActionId": "@{refOrderAction.id}",
10 "PricebookEntryId": "01uRM000000igZG",
11 "Quantity": 2
12 }
13}JSON Example
1{
2 "referenceId": "refOrderItem0",
3 "record": {
4 "attributes": {
5 "type": "OrderItem",
6 "method": "PATCH",
7 "id": "402xx000003KY5vJGH"
8 },
9 "OrderId": "@{refOrder.id}",
10 "OrderActionId": "@{refOrderAction.id}",
11 "PricebookEntryId": "01uRM000000igZG",
12 "Quantity": 2,
13 "UnitPrice": 800
14 }
15}Properties
| Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| referenceId | String | Reference ID that maps to the response and can be used as a reference in later subrecords. This property value starts with a letter or number only and can contain letters, numbers, and underscores. It's also case-sensitive when used for referencing. | Required | 66.0 |
| records | Object Input Map | Details of a record to be ingested. | Required | 66.0 |
This is a sample request to create a sales transaction for an order line item.
This is a sample request to update an order line item.