Change Order Summary Input
A change to an order summary. There are some general validations for this input. The
maximum number of changes allowed per request is 100. You must include at least one change for
an entity, and each change that’s associated with an entity counts as one change. You can modify
only order item summaries in Ordered status.
- Root XML tag
- <changeOrderSummaryInput>
- JSON example (Add item with new adjustment and taxes)
-
1{ 2 "changeReason": "Unknown", 3 "orderItemSummaries": [ 4 { 5 "referenceId": "ois_entry1", 6 "changeType": "New", 7 "orderItemSummary": { 8 "attributes": { 9 "type": "OrderItemSummary" 10 }, 11 "orderDeliveryGroupSummaryId": "0ag000000000001AAA", 12 "quantity": 2.0, 13 "listPrice": 75.0, 14 "unitPrice": 75.0, 15 "grossUnitPrice": 75.0, 16 "totalLineAmount": 150.0, 17 "product2Id": "01t000000000001AAA", 18 "pricebookEntryId": "01u000000000001AAA", 19 "name": "New Test Product", 20 "lineNumber": 11, 21 "description": "New product with adjustment and tax", 22 "serviceDate": "2025-08-01", 23 "endDate": "2025-12-31", 24 "earliestEstimatedDeliveryDate": "2025-08-05", 25 "latestEstimatedDeliveryDate": "2025-08-15", 26 "earliestEstimatedDeliveryTime": "10:00", 27 "latestEstimatedDeliveryTime": "17:00", 28 "estimatedDeliveryReference": "EST-REF-NEW-002", 29 "estimatedDeliveryTimeZone": "America/Chicago", 30 "type": "Order Product", 31 "typeCode": "Product" 32 } 33 } 34 ], 35 "orderItemAdjustmentLineSummaries": [ 36 { 37 "referenceId": "new_adjustment1", 38 "changeType": "New", 39 "orderItemAdjustmentLineSummary": { 40 "attributes": { 41 "type": "OrderItemAdjustmentLineSummary" 42 }, 43 "name": "New item discount", 44 "description": "Discount for new product added to order", 45 "amount": -15.00, 46 "orderItemSummaryId": "@{ois_entry1}" 47 } 48 } 49 ], 50 "orderItemTaxLineItemSummaries": [ 51 { 52 "referenceId": "new_tax1", 53 "changeType": "New", 54 "orderItemTaxLineItemSummary": { 55 "attributes": { 56 "type": "OrderItemTaxLineItemSummary" 57 }, 58 "name": "New item tax", 59 "description": "Tax for new product", 60 "amount": 7.5, 61 "rate": 0.05, 62 "type": "Estimated", 63 "taxEffectiveDate": "2025-01-15", 64 "orderItemSummaryId": "@{ois_entry1}" 65 } 66 }, 67 { 68 "referenceId": "new_adjustment_tax1", 69 "changeType": "New", 70 "orderItemTaxLineItemSummary": { 71 "attributes": { 72 "type": "OrderItemTaxLineItemSummary" 73 }, 74 "name": "New adjustment tax", 75 "description": "Tax for new adjustment", 76 "amount": -0.75, 77 "rate": 0.05, 78 "type": "Estimated", 79 "taxEffectiveDate": "2025-01-15", 80 "orderItemAdjustmentLineSummaryId": "@{new_adjustment1}", 81 "orderItemSummaryId": "@{ois_entry1}" 82 } 83 } 84 ] 85} - JSON example (Cancel order item)
-
1{ 2 "changeReason": "Unknown", 3 "orderItemSummaries": [ 4 { 5 "changeType": "Update", 6 "orderItemSummary": { 7 "attributes": { 8 "type": "OrderItemSummary" 9 }, 10 "id": "10u000000000001AAA", 11 "quantity": 0.0, 12 "totalLineAmount": 0.0 13 } 14 } 15 ], 16 "orderItemTaxLineItemSummaries": [ 17 { 18 "changeType": "Update", 19 "orderItemTaxLineItemSummary": { 20 "attributes": { 21 "type": "OrderItemTaxLineItemSummary" 22 }, 23 "id": "0ai000000000001AAA", 24 "orderItemSummaryId": "10u000000000001AAA", 25 "amount": 0.0, 26 "name": "2072100 - Tax [CANCELLED]" 27 } 28 }, 29 { 30 "changeType": "Update", 31 "orderItemTaxLineItemSummary": { 32 "attributes": { 33 "type": "OrderItemTaxLineItemSummary" 34 }, 35 "id": "0ai000000000004AAA", 36 "orderItemSummaryId": "10u000000000001AAA", 37 "orderItemAdjustmentLineSummaryId": "0ah000000000001AAA", 38 "amount": 0.0, 39 "name": "2072100 - Adjustment Tax [CANCELLED]" 40 } 41 } 42 ], 43 "orderItemAdjustmentLineSummaries": [ 44 { 45 "changeType": "Update", 46 "orderItemAdjustmentLineSummary": { 47 "attributes": { 48 "type": "OrderItemAdjustmentLineSummary" 49 }, 50 "id": "0ah000000000001AAA", 51 "orderItemSummaryId": "10u000000000001AAA", 52 "amount": 0.0, 53 "name": "2072100 - 20%offOrderAmountOver100 [CANCELLED]" 54 } 55 } 56 ] 57} - JSON example (Quantity increase)
-
1{ 2 "changeReason": "Unknown", 3 "orderItemSummaries": [ 4 { 5 "referenceId": "ois_entry1", 6 "changeType": "Update", 7 "orderItemSummary": { 8 "attributes": { 9 "type": "OrderItemSummary" 10 }, 11 "id": "10u000000000001AAA", 12 "quantity": 4.0, 13 "totalLineAmount": 1020.8 14 } 15 } 16 ], 17 "orderItemTaxLineItemSummaries": [ 18 { 19 "changeType": "Update", 20 "orderItemTaxLineItemSummary": { 21 "attributes": { 22 "type": "OrderItemTaxLineItemSummary" 23 }, 24 "id": "0ai000000000001AAA", 25 "orderItemSummaryId": "10u000000000001AAA", 26 "amount": 51.02, 27 "name": "4409100 - Tax updated due to quantity decrease from 5 to 4" 28 } 29 }, 30 { 31 "changeType": "Update", 32 "orderItemTaxLineItemSummary": { 33 "attributes": { 34 "type": "OrderItemTaxLineItemSummary" 35 }, 36 "id": "0ai000000000002AAA", 37 "orderItemSummaryId": "10u000000000001AAA", 38 "orderItemAdjustmentLineSummaryId": "0ah000000000001AAA", 39 "amount": -10.20, 40 "name": "4409100 - Adjustment Tax updated due to quantity decrease from 5 to 4" 41 } 42 } 43 ], 44 "orderItemAdjustmentLineSummaries": [ 45 { 46 "changeType": "Update", 47 "orderItemAdjustmentLineSummary": { 48 "attributes": { 49 "type": "OrderItemAdjustmentLineSummary" 50 }, 51 "id": "0ah000000000001AAA", 52 "orderItemSummaryId": "10u000000000001AAA", 53 "amount": -204.08, 54 "name": "4409100 - 20%offOrderAmountOver100 - updated due to quantity decrease from 5 to 4" 55 } 56 } 57 ] 58} - JSON example (Update taxes)
-
1{ 2 "changeReason": "Unknown", 3 "orderItemSummaries": [ 4 { 5 "changeType": "Update", 6 "orderItemSummary": { 7 "attributes": { 8 "type": "OrderItemSummary" 9 }, 10 "id": "10u000000000001AAA", 11 "quantity": 3.0, 12 "totalLineAmount": 765.60, 13 "name": "Updated Item Name", 14 "lineNumber": 1, 15 "serviceDate": "2026-10-15", 16 "endDate": "2026-10-20", 17 "description": "Updated item description", 18 "earliestEstimatedDeliveryDate": "2026-10-18", 19 "latestEstimatedDeliveryDate": "2026-10-22", 20 "earliestEstimatedDeliveryTime": "09:00:00.000Z", 21 "latestEstimatedDeliveryTime": "17:00:00.000Z", 22 "estimatedDeliveryReference": "DEL-REF-12345", 23 "estimatedDeliveryTimeZone": "America/Los_Angeles" 24 } 25 } 26 ], 27 "orderItemTaxLineItemSummaries": [ 28 { 29 "changeType": "Update", 30 "orderItemTaxLineItemSummary": { 31 "attributes": { 32 "type": "OrderItemTaxLineItemSummary" 33 }, 34 "id": "0ai000000000001AAA", 35 "orderItemSummaryId": "10u000000000001AAA", 36 "amount": 38.28, 37 "name": "4409100 - Tax - updated", 38 "description": "Updated tax with new amount", 39 "type": "Actual", 40 "taxEffectiveDate": "2026-10-10" 41 } 42 }, 43 { 44 "changeType": "Update", 45 "orderItemTaxLineItemSummary": { 46 "attributes": { 47 "type": "OrderItemTaxLineItemSummary" 48 }, 49 "id": "0ai000000000002AAA", 50 "orderItemSummaryId": "10u000000000001AAA", 51 "orderItemAdjustmentLineSummaryId": "0ah000000000001AAA", 52 "amount": -7.66, 53 "name": "4409100 - Adjustment Tax - updated", 54 "description": "Updated adjustment tax with new amount", 55 "type": "Actual", 56 "taxEffectiveDate": "2026-10-10" 57 } 58 } 59 ] 60} - Properties
-
Name Type Description Required or Optional Available Version changeOrdersReferenceNumber String The order reference number value for the Change Order associated with the current request. Optional 66.0 changeReason String The reason for the change. It has to be an active Picklist value from the OrderItemSummaryChange entity Reason field. Required 66.0 orderAdjustmentGroupSummaries Change Order Adjustment Group Summary Input[] The list of order adjustment group summaries changes. Optional 66.0 orderDeliveryGroupSummaries Change Order Delivery Group Summary Input[] The list of order delivery group summaries changes. Optional 66.0 orderItemAdjustmentLineSummaries Change Order Item Adjustment Line Summary Input[] The list of order item adjustment line summaries changes. Optional 66.0 orderItemSummaries Change Order Item Summary Input[] The list of order item summaries changes. Optional 66.0 orderItemTaxLineItemSummaries Change Order Item Tax Line Item Summary Input[] The list of order item tax line item summaries changes. Optional 66.0 orderSummary ConnectSObject The order summary sObject representation that contains the changes for the Order Summary. Optional 66.0