Description

Query Complete BOM Structure.

Request Specification

Method: POST + application/json

Endpoint: https://${Cloud Domain}/cgi/crm/v2/bom/service/querybomtree?thirdTraceId=${Random String}

Headers: Refer to Common Parameters

Request Parameters

Parameter	Type	Required	Description
data	Map	Yes	Data map
bom_core_id	String	Yes	ID of the product combination
need_sub_bom	Boolean	Yes	Whether to return reused BOM data; not returned if not provided
bom_amount	Int	Yes	Defaults to the quantity of one package; for another positive integer n, if the default component quantity is m, the returned component quantity is: n*m

Request Example

{
  "data": {
    "bom_core_id": "6645d00c39b33f0007bba8fe",
    "need_sub_bom": true,
    "bom_amount": 1.0
  }
}

Response Parameters

Parameter	Type	Description
dataId	String	Data ID
traceId	string	Unique request ID
errorDescription	string	Error description
errorMessage	string	Error message
errorCode	Int	Error Codes

Response Example

{
	"traceId": "E-O.722037_sandbox.1001-20240521154630-5f331e",
	"data": {
		"dataMapList": [{
			"describeApiName": "BOMObj",
			"dataList": [{
					"lock_rule": "default_lock_rule",
					"price_editable": true,
					"new_bom_path": "6645d00c39b33f0007bba8f7",
					"extend_obj_data_id": "6645d00f39b33f0007bbaa57",
					"amount_any": false,
					"life_status_before_invalid": null,
					"product_id": "6645cf7639b33f0007bb9a50",
					"owner_department_id": "1000",
					"owner_department": "R&D",
					"searchAfterId": [
						"1715851281236",
						"6645d00c39b33f0007bba8f7"
					],
					"price_mode": "2",
					"lock_status": "0",
					"package": "CRM",
					"create_time": 1715851279771,
					"min_amount": "0",
					"order_field": "0",
					"parent_product_id__relation_ids": "6645cf7639b33f0007bb9a50",
					"product_life_status": "normal",
					"share_rate": null,
					"version": "2",
					"created_by": [
						"1000"
					],
					"relevant_team": null,
					"bom_path": "6645d00c39b33f0007bba8f7",
					"data_own_department": [
						"1000"
					],
					"name": "20240516005725",
					"_id": "6645d00c39b33f0007bba8f7",
					"related_core_id": null,
					"tenant_id": "82909",
					"root_prod_pkg_key": "6645de2f444ef38743ef717e",
					"selected_by_default": false,
					"increment": "0",
					"product_status": "1",
					"remark": null,
					"origin_source": null,
					"core_id__relation_ids": "6645d00c39b33f0007bba8fe",
					"lock_user": null,
					"product_id__relation_ids": "6645cf7639b33f0007bb9a50",
					"parent_product_id": "6645cf7639b33f0007bb9a50",
					"adjust_price": "0.00",
					"core_id": "6645d00c39b33f0007bba8fe",
					"is_deleted": false,
					"is_required": false,
					"object_describe_api_name": "BOMObj",
					"root_id": "6645d00c39b33f0007bba8f7",
					"out_owner": null,
					"node_bom_core_version": null,
					"field_5hqwS__c": "1.00",
					"prod_pkg_key": "6645de2f444ef38743ef717d",
					"owner": [
						"1000"
					],
					"amount": 1,
					"is_package": false,
					"last_modified_time": 1715851281236,
					"quantity": 1,
					"life_status": "normal",
					"enabled_status": true,
					"last_modified_by": [
						"-10000"
					],
					"out_tenant_id": null,
					"amount_editable": false,
					"record_type": "default__c",
					"product_group_id": null,
					"parent_bom_id": null,
					"node_bom_core_type": null,
					"max_amount": "0",
					"order_by": "10"
				},
				{
					"lock_rule": "default_lock_rule",
					"price_editable": true,
					"new_bom_path": "6645d00c39b33f0007bba8f7.6645d00c39b33f0007bba8f8.6645d00c39b33f0007bba8fb",
					"extend_obj_data_id": "6645d00f39b33f0007bbaa53",
					"amount_any": false,
					"life_status_before_invalid": null,
					"product_id": "65eff3bcc285c9000725d08d",
					"owner_department_id": "1000",
					"owner_department": "R&D",
					"searchAfterId": [
						"1715851281236",
						"6645d00c39b33f0007bba8fb"
					],
					"price_mode": "2",
					"lock_status": "0",
					"package": "CRM",
					"create_time": 1715851279767,
					"min_amount": null,
					"order_field": "2",
					"parent_product_id__relation_ids": "660d03f970b62900078e4dec",
					"product_life_status": "normal",
					"share_rate": null,
					"version": "2",
					"created_by": [
						"1000"
					],
					"relevant_team": null,
					"bom_path": "6645d00c39b33f0007bba8f7.6645d00c39b33f0007bba8f8.6645d00c39b33f0007bba8fb",
					"data_own_department": [
						"1000"
					],
					"name": "20240516005721",
					"_id": "6645d00c39b33f0007bba8fb",
					"parent_prod_pkg_key": "6645de2f444ef38743ef7180",
					"related_core_id": null,
					"tenant_id": "82909",
					"root_prod_pkg_key": "6645de2f444ef38743ef717e",
					"selected_by_default": false,
					"increment": "1",
					"product_status": "1",
					"remark": null,
					"origin_source": null,
					"core_id__relation_ids": "6645d00c39b33f0007bba8fe",
					"lock_user": null,
					"product_id__relation_ids": "65eff3bcc285c9000725d08d",
					"parent_product_id": "660d03f970b62900078e4dec",
					"adjust_price": null,
					"core_id": "6645d00c39b33f0007bba8fe",
					"is_deleted": false,
					"is_required": false,
					"object_describe_api_name": "BOMObj",
					"root_id": "6645d00c39b33f0007bba8f7",
					"out_owner": null,
					"node_bom_core_version": null,
					"field_5hqwS__c": "3.00",
					"prod_pkg_key": "6645de2f444ef38743ef717f",
					"owner": [
						"1000"
					],
					"amount": "3.000",
					"is_package": false,
					"last_modified_time": 1715851281236,
					"quantity": "3.000",
					"life_status": "normal",
					"enabled_status": true,
					"last_modified_by": [
						"-10000"
					],
					"out_tenant_id": null,
					"amount_editable": false,
					"product_group_id__relation_ids": "6645d00c39b33f0007bba8f9",
					"record_type": "default__c",
					"product_group_id": "6645d00c39b33f0007bba8f9",
					"parent_bom_id": "6645d00c39b33f0007bba8f8",
					"node_bom_core_type": "product",
					"order_by": "20",
					"max_amount": null
				}
			]
		}]

	},
	"errorDescription": "success",
	"errorMessage": "success",
	"errorCode": 0
}

Notes

• Do not use the message field in the response for logical judgments, as errorMessage may change.