SAP S/4HANA payloads and details
| The constants are to be set against the fields available on different tabs under SAP S/4HANA Connector . Navigate to Extension → Marketplace → Settings. |
Send Engineering Item
{
"Product": "<Product Name>",
"ProductType": "<Data_Settings_Tab # Product Type>",
"ProductIsConfigurable": <Data_Settings_Tab # Product Configurable>,
"NetWeight": "<Product attribute Net Weight>",
"WeightUnit": "<Product attribute Weight Unit>",
"ProductGroup": "<Data_Settings_Tab # Product Group>",
"BaseUnit": "<Product attribute Unit of Measure>",
"MaterialRevisionLevel": "<Product Revision>",
"to_Description": {
"results": [
{
"Product": "<Product Name>",
"Language": "<Data_Settings_Tab # Language>",
"ProductDescription": "<Product Description>"
}
]
},
"to_ProductBasicText": {
"results": [
{
"Product": "<Product Name>",
"Language": "<Data_Settings_Tab # Language>",
"LongText": "<Product Description>"
}
]
},
"to_Plant": {
"results": [
{
"Product": "<Product Name>",
"Plant": "<Connection_Tab # Plant number>"
}
]
},
"to_Valuation": {
"results": [
{
"Product": "<Product Name>",
"ValuationArea": "<Connection_Tab # Plant number>",
"StandardPrice": "<Product attribute Estimated Cost>",
"PriceUnitQty": "<Product attribute Price Unit Quantity>",
"InventoryValuationProcedure": "<Data_Settings_Tab # Inventory Valuation Procedure>"
}
]
}
}Send CA
{
"ChangeNumber": "<Change Action Name>",
"ChangeNumberValidFromDate": "/Date(1697454630349)/",(1)
"ReasonForChangeText": "<Change Action Description>",
"ChangeNumberDescription": "<Change Action Description>",
"to_ObjTypeAssignment": {
"results": [
{
"ChangeNumber": "<Change Action Name>",
"SAPObjectType": "<Data_Settings_Tab # Material BOM>",
"IsActiveForChangeNumber": true,
"IsLockedForChanges": "",
"IsPartiallyDisplayed": "",
"ObjMgmtRecdIsRequired": true,
"ObjMgmtRecdIsGenerated": true,
"ObjMgmtRecdIsAutomlyCrted": "",
"ObjMgmtRecdIsAutomlyCrtedByDlg": ""
},
{
"ChangeNumber": "<Change Action Name>",
"SAPObjectType": "<Data_Settings_Tab # Material>",
"IsActiveForChangeNumber": true,
"IsLockedForChanges": "",
"IsPartiallyDisplayed": "",
"ObjMgmtRecdIsRequired": true,
"ObjMgmtRecdIsGenerated": true,
"ObjMgmtRecdIsAutomlyCrted": "",
"ObjMgmtRecdIsAutomlyCrtedByDlg": ""
}
]
},
"ChangeNumberStatus": "1",
"ChangeNumberReleaseKey": "0",
"IsUsedForDataDefinition": true,
"ChangeNumberIsMrkdForDeletion": false
}| 1 | Change Action - Actual Start Date in epoch (UNIX) |
Send BOM
{
"Material": "<Product Name>",
"HeaderValidityStartDate": "/Date(1697173430185)/", (1)
"BOMHeaderBaseUnit": "<Parent product atttribute Unit of Measure>",
"BillOfMaterialVariant": "<Product Revision>",
"Plant": "<Connection_Tab # Plant number>",
"BillOfMaterialVariantUsage": "<Connection_Tab # BOM Variant Usage>",
"BillOfMaterialCategory": "<Data_Settings_Tab # BOM Category>",
"IsMultipleBOMAlt": <Data_Settings_Tab # Multiple BOM Alt>,
"BOMHeaderQuantityInBaseUnit": "<Data_Settings_Tab # BOM Header Qty Base unit>",
"DocumentIsCreatedByCAD": <Data_Settings_Tab # Document Created by CAD>,
"to_BillOfMaterialItem": {
"results": [
{
"ValidityStartDate": "/Date(1697173430419)/",(2)
"BillOfMaterialItemCategory": "<Data_Settings_Tab # BOM Item Category>",
"BillOfMaterialItemNumber": "<Child product attribute Find Number>",
"BillOfMaterialItemUnit": "<Child product atttribute Unit of Measure>",
"BillOfMaterialItemQuantity": "<Child product attribute quantity>",
"BillOfMaterialComponent": "<Child Product Name>"
},
{
"ValidityStartDate": "/Date(1697173430633)/",(3)
"BillOfMaterialItemCategory": "<Data_Settings_Tab # BOM Item Category>",
"BillOfMaterialItemNumber": "<Child product attribute Find Number>",
"BillOfMaterialItemUnit": "<Child product atttribute Unit of Measure>",
"BillOfMaterialItemQuantity": "<Child product attribute quantity>",
"BillOfMaterialComponent": "<Child Product Name>"
}
]
}
}| 1 | BOM Head (Parent product) created date in epoch (UNIX) |
| 2 | BOM Line (Child product) created date in epoch (UNIX) |
| 3 | BOM Line (Child product) created date in epoch (UNIX) |
Details for use case - Send Document
| Only Business Object Type Name is to be set on Data Settings tab. |
{
"documentName": "Admin_Report.pdf",
"documentType": "application/pdf",
"fileData": {},
"businessObjectTypeName": "<Data_Settings_Tab # Business Object Type Name>",
"linkedSAPObjectKey": "<Product Name>"
}Send CA with BOM
{
"Material": "<Parent product Name>",
"HeaderValidityStartDate": "/Date(1697454926807)/",(1)
"EngineeringChangeDocForEdit": "<Change Action Name>",
"BOMHeaderBaseUnit": "<Parent product atttribute Unit of Measure>",
"BillOfMaterialVariant": "<Parent product Revision>",
"Plant": "<Connection_Tab # Plant number>",
"BillOfMaterialVariantUsage": "<Connection_Tab # BOM Variant Usage>",
"BillOfMaterialCategory": "<Data_Settings_Tab # BOM Category>",
"IsMultipleBOMAlt": <Data_Settings_Tab # Multiple BOM Alt>,
"BOMHeaderQuantityInBaseUnit": "<Data_Settings_Tab # BOM Header Qty Base unit>",
"DocumentIsCreatedByCAD": <Data_Settings_Tab # Document Created by CAD>,
"to_BillOfMaterialItem": {
"results": [
{
"ValidityStartDate": "/Date(1697454927977)/",(2)
"BillOfMaterialItemCategory": "<Data_Settings_Tab # BOM Item Category>",
"BillOfMaterialItemNumber": "<Child product attribute Find Number>",
"BillOfMaterialItemUnit": "<Child product atttribute Unit of Measure>",
"BillOfMaterialItemQuantity": "<Child product attribute quantity>",
"BillOfMaterialComponent": "<Child product Name>"
},
{
"ValidityStartDate": "/Date(1697454928198)/",(3)
"BillOfMaterialItemCategory": "<Data_Settings_Tab # BOM Item Category>",
"BillOfMaterialItemNumber": "<Child attribute Find Number>",
"BillOfMaterialItemUnit": "<Child atttribute Unit of Measure>",
"BillOfMaterialItemQuantity": "<Child attribute quantity>",
"BillOfMaterialComponent": "<Child product Name>"
},
{
"ValidityStartDate": "/Date(1697454928407)/",(4)
"BillOfMaterialItemCategory": "<Data_Settings_Tab # BOM Item Category>",
"BillOfMaterialItemNumber": "<Child attribute Find Number>",
"BillOfMaterialItemUnit": "<Child atttribute Unit of Measure>",
"BillOfMaterialItemQuantity": "<Child attribute quantity>",
"BillOfMaterialComponent": "<Child product Name>"
}
]
}
}| 1 | BOM Head (Parent product) created date in epoch (UNIX) |
| 2 | BOM Line (Child product) created date in epoch (UNIX) |
| 3 | BOM Line (Child product) created date in epoch (UNIX) |
| 4 | BOM Line (Child product) created date in epoch (UNIX) |
Revise Engineering Item
{
"ChangeNumber": "<Change Action Name>",
"Product": "<Product Name>",
"ProductType": "<Data_Settings_Tab # Product Type>",
"ProductIsConfigurable": <Data_Settings_Tab # Product Configurable,
"NetWeight": "<Product atttribute Net Weight>",
"WeightUnit": "<Product atttribute Weight unit>",
"ProductGroup": "<Data_Settings_Tab # Product Group>",
"BaseUnit": "<Product atttribute Unit of Measure>",
"MaterialRevisionLevel": "<Product Revision>"
}Sync Attributes
{
"NetWeight": "<Product attribute Net Weight>",
"WeightUnit": "<Product attribute Weight Unit>"
}Send Manufacturing Item
{
"Product": "<Product Name>",
"ProductType": "<Data_Settings_Tab # Product Type>",
"ProductIsConfigurable": <Data_Settings_Tab # Product Configurable>,
"NetWeight": "<Product attribute Net Weight>",
"WeightUnit": "<Product attribute Weight Unit>",
"ProductGroup": "<Data_Settings_Tab # Product Group>",
"BaseUnit": "<Product attribute Unit of Measure>",
"MaterialRevisionLevel": "<Product Revision>",
"to_Description": {
"results": [
{
"Product": "<Product Name>",
"Language": "<Data_Settings_Tab # Language>",
"ProductDescription": "<Product Description>"
}
]
},
"to_ProductBasicText": {
"results": [
{
"Product": "<Product Name>",
"Language": "<Data_Settings_Tab # Language>",
"LongText": "<Product Description>"
}
]
},
"to_Plant": {
"results": [
{
"Product": "<Product Name>",
"Plant": "<Connection_Tab # Plant number>"
}
]
},
"to_Valuation": {
"results": [
{
"Product": "<Product Name>",
"ValuationArea": "<Connection_Tab # Plant number>",
"StandardPrice": "<Product attribute Estimated Cost>",
"PriceUnitQty": "<Product attribute Price Unit Quantity>",
"InventoryValuationProcedure": "<Data_Settings_Tab # Inventory Valuation Procedure>"
}
]
}
}Send MBOM
{
"Material": "<Product Name>",
"HeaderValidityStartDate": "/Date(1697173430185)/", (1)
"BOMHeaderBaseUnit": "<Parent product atttribute Unit of Measure>",
"BillOfMaterialVariant": "<Product Revision>",
"Plant": "<Connection_Tab # Plant number>",
"BillOfMaterialVariantUsage": "<Connection_Tab # MBOM Variant Usage>",
"BillOfMaterialCategory": "<Data_Settings_Tab # BOM Category>",
"IsMultipleBOMAlt": <Data_Settings_Tab # Multiple BOM Alt>,
"BOMHeaderQuantityInBaseUnit": "<Data_Settings_Tab # BOM Header Qty Base unit>",
"DocumentIsCreatedByCAD": <Data_Settings_Tab # Document Created by CAD>,
"to_BillOfMaterialItem": {
"results": [
{
"ValidityStartDate": "/Date(1697173430419)/",(2)
"BillOfMaterialItemCategory": "<Data_Settings_Tab # BOM Item Category>",
"BillOfMaterialItemNumber": "<Child product attribute Find Number>",
"BillOfMaterialItemUnit": "<Child product atttribute Unit of Measure>",
"BillOfMaterialItemQuantity": "<Child product attribute quantity>",
"BillOfMaterialComponent": "<Child Product Name>"
},
{
"ValidityStartDate": "/Date(1697173430633)/",(3)
"BillOfMaterialItemCategory": "<Data_Settings_Tab # BOM Item Category>",
"BillOfMaterialItemNumber": "<Child product attribute Find Number>",
"BillOfMaterialItemUnit": "<Child product atttribute Unit of Measure>",
"BillOfMaterialItemQuantity": "<Child product attribute quantity>",
"BillOfMaterialComponent": "<Child Product Name>"
}
]
}
}| 1 | MBOM Head (Parent product) created date in epoch (UNIX) |
| 2 | MBOM Line (Child product) created date in epoch (UNIX) |
| 3 | MBOM Line (Child product) created date in epoch (UNIX) |
Send CA With Applicabilty Date
{
"ChangeNumber": "<Change Action Name>",
"ChangeNumberValidFromDate": "/Date(1697454630349)/",(1)
"ReasonForChangeText": "<Change Action Description>",
"ChangeNumberDescription": "<Change Action Description>",
"to_ObjTypeAssignment": {
"results": [
{
"ChangeNumber": "<Change Action Name>",
"SAPObjectType": "<Data_Settings_Tab # Material BOM>",
"IsActiveForChangeNumber": true,
"IsLockedForChanges": "",
"IsPartiallyDisplayed": "",
"ObjMgmtRecdIsRequired": true,
"ObjMgmtRecdIsGenerated": true,
"ObjMgmtRecdIsAutomlyCrted": "",
"ObjMgmtRecdIsAutomlyCrtedByDlg": ""
},
{
"ChangeNumber": "<Change Action Name>",
"SAPObjectType": "<Data_Settings_Tab # Material>",
"IsActiveForChangeNumber": true,
"IsLockedForChanges": "",
"IsPartiallyDisplayed": "",
"ObjMgmtRecdIsRequired": true,
"ObjMgmtRecdIsGenerated": true,
"ObjMgmtRecdIsAutomlyCrted": "",
"ObjMgmtRecdIsAutomlyCrtedByDlg": ""
}
]
},
"ChangeNumberStatus": "1",
"ChangeNumberReleaseKey": "0",
"IsUsedForDataDefinition": true,
"ChangeNumberIsMrkdForDeletion": false
}| 1 | Change Action - Fetch from Change Action applicability start date in epoch (UNIX) |
Update BOM Head with New Change Number
{
"EngineeringChangeDocForEdit": "<New Change Action Name>"
}Add/Replace BOM Items with New Change Number
{
"BillOfMaterialItemCategory": "<Data_Settings_Tab # BOM Item Category>",
"BillOfMaterialItemUnit": "<Child product atttribute Unit of Measure>",
"BillOfMaterialItemQuantity": "<Child product attribute quantity>",
"BillOfMaterialComponent": "<Child Product Name>"
"EngineeringChangeDocForEdit": "<New Change Action Name>"
}Send Resource Item
{
"WorkCenter": "407607",
"WorkCenterDesc": "User Defined Resource00007607",
"Plant": "1010",
"WorkCenterCategoryCode": "0001",
"WorkCenterResponsible": "",
"WorkCenterResponsibleName": "",
"SupplyArea": "",
"WorkCenterUsage": "",
"CapacityInternalID": "0",
"WorkCenterIsToBeDeleted": false,
"ValidityStartDate": "2024-12-31",
"ValidityEndDate": "9999-12-31",
"WorkCenterFormulaParam1": "",
"WorkCenterFormulaParam2": "",
"WorkCenterFormulaParam3": "",
"WorkCenterFormulaParam4": "",
"WorkCenterFormulaParam5": "",
"WorkCenterFormulaParam6": "",
"WorkCenterFmlaParamUnit1": "",
"WorkCenterFmlaParamUnit2": "",
"WorkCenterFmlaParamUnit3": "",
"WorkCenterFmlaParamUnit4": "",
"WorkCenterFmlaParamUnit5": "",
"WorkCenterFmlaParamUnit6": "",
"StandardWorkFormulaParamGroup": "SAP1",
"WrkCtrStdValMaintRule1": "",
"WrkCtrStdValMaintRule2": "",
"WrkCtrStdValMaintRule3": "",
"WrkCtrStdValMaintRule4": "",
"WrkCtrStdValMaintRule5": "",
"WrkCtrStdValMaintRule6": "",
"WorkCenterStandardWorkQtyUnit1": "",
"WorkCenterStandardWorkQtyUnit2": "",
"WorkCenterStandardWorkQtyUnit3": "",
"WorkCenterStandardWorkQtyUnit4": "",
"WorkCenterStandardWorkQtyUnit5": "",
"WorkCenterStandardWorkQtyUnit6": "",
"OperationControlProfile": "",
"MatlCompIsMarkedForBackflush": false,
"WorkCenterLocation": "",
"WorkCenterLocationGroup": "",
"WrkCtrSetupSchedgFmla": "",
"WrkCtrProcgSchedgFmla": "",
"WrkCtrTeardownSchedgFmla": "",
"WrkCtrIntProcgSchedgFmla": "",
"_Description": [
{
"Language": "EN",
"WorkCenterDesc": "User Defined Resource00007607",
"WorkCenter": "407607",
"Plant": "1010",
"WorkCenterCategoryCode": "0001"
}
]
}Send Bill Of Process(BOP)
{
"Plant": "1010",
"BillOfOperationsDesc": "Workplan 00000095",
"BillOfOperationsStatus": "1",
"BillOfOperationsUsage": "1",
"ResponsiblePlannerGroup": "01",
"MinimumLotSizeQuantity": "1",
"MaximumLotSizeQuantity": "999999",
"BillOfOperationsUnit": "kg",
"to_MatlAssgmt": [
{
"Product": "400247"
}
],
"to_Sequence": [
{
"ProductionRoutingSequence": "",
"SequenceCategory": "0",
"to_Operation": [
{
"OperationText": "Header Operation00000089",
"Operation": "100",
"WorkCenterInternalID": "10000324",
"OperationControlProfile": "YBM1",
"OperationUnit": "EA",
"OpQtyToBaseQtyNmrtr": "1",
"OpQtyToBaseQtyDnmntr": "1",
"OperationReferenceQuantity": "1",
"to_SubOp": [
{
"OperationText": "Transfer Operation00000011",
"Operation": "101",
"WorkCenterInternalID": "10000334",
"OperationControlProfile": "YBM1",
"OperationUnit": "EA",
"OpQtyToBaseQtyNmrtr": "1",
"OpQtyToBaseQtyDnmntr": "1",
"OperationReferenceQuantity": "1"
},
{
"OperationText": "Remove Material Operation00000026",
"Operation": "102",
"WorkCenterInternalID": "10000326",
"OperationControlProfile": "YBM1",
"OperationUnit": "EA",
"OpQtyToBaseQtyNmrtr": "1",
"OpQtyToBaseQtyDnmntr": "1",
"OperationReferenceQuantity": "1"
},
{
"OperationText": "General Operation00000082",
"Operation": "103",
"WorkCenterInternalID": "10000330", //queried from SAP by it workcenter number
"OperationControlProfile": "YBM1",
"OperationUnit": "EA",
"OpQtyToBaseQtyNmrtr": "1",
"OpQtyToBaseQtyDnmntr": "1",
"OperationReferenceQuantity": "1"
}
],
"to_OpCompAlloc": []
},
{
"OperationText": "Header Operation00000091",
"Operation": "200",
"WorkCenterInternalID": "10000336",
"OperationControlProfile": "YBM1",
"OperationUnit": "EA",
"OpQtyToBaseQtyNmrtr": "1",
"OpQtyToBaseQtyDnmntr": "1",
"OperationReferenceQuantity": "1",
"to_SubOp": [
{
"OperationText": "Loading Operation00000048",
"Operation": "201",
"WorkCenterInternalID": "10000328",
"OperationControlProfile": "YBM1",
"OperationUnit": "EA",
"OpQtyToBaseQtyNmrtr": "1",
"OpQtyToBaseQtyDnmntr": "1",
"OperationReferenceQuantity": "1"
},
{
"OperationText": "Unloading Operation00000042",
"Operation": "202",
"WorkCenterInternalID": "10000338",
"OperationControlProfile": "YBM1",
"OperationUnit": "EA",
"OpQtyToBaseQtyNmrtr": "1",
"OpQtyToBaseQtyDnmntr": "1",
"OperationReferenceQuantity": "1"
}
],
"to_OpCompAlloc": []
}
]
}
]
}Send BOP Product Version
{
"Material": "400247",
"Plant": "1010",
"ProductionVersion": "1",
"ProductionVersionText": "Workplan 00000095",
"BillOfOperationsType": "N",
"BillOfOperationsGroup": "50000191",
"BillOfOperationsVariant": "",
"BillOfMaterialVariantUsage": "",
"BillOfMaterialVariant": "",
"ProductionLine": "",
"ProductionSupplyArea": "",
"ProductionVersionGroup": "",
"MainProduct": "",
"MaterialCostApportionmentStruc": "",
"IssuingStorageLocation": "",
"ReceivingStorageLocation": "",
"OriginalBatchReferenceMaterial": "",
"QuantityDistributionKey": "",
"ProductionVersionStatus": "",
"ProductionVersionLastCheckDate": null,
"RateBasedPlanningStatus": "",
"PreliminaryPlanningStatus": "",
"BOMCheckStatus": "",
"ValidityStartDate": "2025-07-22",
"ValidityEndDate": "9999-12-31",
"ProductionVersionLock": "",
"ProdnVersIsAllowedForRptvMfg": false,
"HasVersionCtrldBOMAndRouting": false,
"PlanningAndExecutionBOMIsDiff": false,
"ExecBillOfMaterialVariantUsage": "",
"ExecBillOfMaterialVariant": "",
"ExecBillOfOperationsType": "",
"ExecBillOfOperationsGroup": "",
"ExecBillOfOperationsVariant": "",
"EWMWarehouse": "",
"DestinationStorageBin": "",
"ProcurementType": "",
"MaterialProcurementProfile": "",
"UsgeProbltyWthVersCtrlInPct": 0,
"MaterialBaseUnit": "EA",
"MaterialMinLotSizeQuantity": 1,
"MaterialMaxLotSizeQuantity": 999999,
"CostingLotSize": 0,
"TargetProductionSupplyArea": "",
"MRPController": "THK",
"MaterialName": "",
"MRPResponsible": "THK",
"RoutingCheckStatusText": "Not yet checked",
"ProductionVersionLockText": "Not locked",
"BillOfOperationsTypeName": ""
}