Object with Reference Input

Input representation of a list of records to be inserted or updated. To update a record, specify the record ID.

This is a sample request to create a sales transaction for an order line item.

JSON example
{
  "referenceId": "refOrderItem0",
  "record": {
    "attributes": {
      "type": "OrderItem",
      "method": "POST"
    },
    "OrderId": "@{refOrder.id}",
    "OrderActionId": "@{refOrderAction.id}",
    "PricebookEntryId": "01uRM000000igZG",
    "Quantity": 2
  }
}

This is a sample request to update an order line item.

JSON example
{
  "referenceId": "refOrderItem0",
  "record": {
    "attributes": {
      "type": "OrderItem",
      "method": "PATCH",
      "id": "402xx000003KY5vJGH"
    },
    "OrderId": "@{refOrder.id}",
    "OrderActionId": "@{refOrderAction.id}",
    "PricebookEntryId": "01uRM000000igZG",
    "Quantity": 2,
    "UnitPrice": 800
  }
}
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. Required 60.0
records Object Input Map Details of a record to be ingested. Required 60.0