Customer Testing. This page uses synthetic reviewed examples only. It cannot send a request, accept a credential, or connect to an API.
Local JSON preview
Explore synthetic API examples safely.
Choose a documented operation, edit its synthetic request, and check JSON syntax. The response remains a fixed reviewed example; it is not a prediction of how edited input would behave.
Example request and response
Synthetic request body
Fixed synthetic success response
What this explorer does not do It does not validate the complete operation schema. It does not know your Company, licenses, permissions, data restrictions, quotas, or current item data. It does not store input or transmit it anywhere. It does not replace the operation reference or an approved sandbox.
Item identifiers Data disclosure Endpoint status MCP tools
[
{
"operation_id": "SubmitSingleItemMapping",
"title": "Submit one item for mapping",
"status": "Customer Testing",
"method": "POST",
"path": "/v1/item-mapping-requests",
"request": {
"company_item_id": "CUSTOMER-1001",
"description": "Synthetic copper elbow",
"mfr_name": "Synthetic Manufacturer",
"mfr_part": "SYN-90",
"size": "2 in",
"weight": 1.25,
"list_price": 12.34
},
"response": {
"contract_version": "v1",
"operation_reference": "mapop_0123456789abcdef0123456789abcdef",
"correlation_id": "example-correlation",
"company_item_id": "CUSTOMER-1001",
"result_revision": 1,
"status": "review_required",
"reason_codes": [
"candidate_review_required"
],
"candidates": [
{
"candidate_token": "candidate_0123456789abcdef0123456789abcdef",
"rank": 1,
"manufacturer": "Synthetic Manufacturer",
"description": "Synthetic candidate",
"product": "Synthetic Product",
"material": "Synthetic Material",
"size": "2 in",
"item_status": "active",
"match_strength": "strong",
"evidence": [
{
"type": "description",
"outcome": "consistent"
}
],
"warnings": []
}
],
"next_action": "review_candidates",
"available_actions": [
{
"action": "get_current_result",
"title": "Retrieve current mapping result",
"description": "Retrieves the latest disclosed result and currently available follow-up actions. It does not change the mapping operation.",
"operation_id": "GetSingleItemMappingCurrentResult",
"method": "GET",
"href": "/v1/item-mapping-requests/mapop_0123456789abcdef0123456789abcdef",
"request_body_required": false,
"idempotency_key_required": false,
"confirmation_required": false
},
{
"action": "expand_candidates",
"title": "Expand mapping candidates",
"description": "Requests up to ten additional candidates and advances the result revision. It does not approve or activate a mapping.",
"operation_id": "ExpandSingleItemMappingCandidates",
"method": "POST",
"href": "/v1/item-mapping-requests/mapop_0123456789abcdef0123456789abcdef/candidate-expansions",
"request_body_required": true,
"idempotency_key_required": true,
"confirmation_required": true
}
],
"completed_at": "2026-10-12T12:00:00Z",
"reused": false
}
},
{
"operation_id": "SetCompanyItemMapping",
"title": "Set a company item's mapping",
"status": "Customer Testing",
"method": "PUT",
"path": "/v1/catalog/items/mapping",
"request": {
"company_item_id": "COMPANY-1001",
"hph_item_code": "012NI0044",
"expected_mapping_revision": 3,
"reason": "Corrected parent association"
},
"response": {
"operation_reference": "directmap_1123456789abcdef0123456789abcdef",
"item_skey": "11111111-1111-4111-8111-111111111111",
"company_item_id": "COMPANY-1001",
"transition": "replaced",
"mapping_status": "active",
"previous_mapping": {
"mapping_revision": 3,
"hph_item_code": "012NI0032"
},
"mapping_revision": 4,
"hph_item_code": "012NI0044",
"reused": false,
"validation": {
"outcome": "mapped",
"warnings": []
},
"available_actions": [
{
"action": "get_current_mapping",
"title": "Get current mapping",
"description": "Retrieve the current mapping under the caller's present authority.",
"operation_id": "GetCompanyItemCurrentMapping",
"method": "GET",
"href": "/v1/catalog/items/mapping?company_item_id=COMPANY-1001",
"request_body_required": false,
"idempotency_key_required": false,
"confirmation_required": false
},
{
"action": "set_mapping",
"title": "Set mapping",
"description": "Set the desired HPH Item Code for this company item.",
"operation_id": "SetCompanyItemMapping",
"method": "PUT",
"href": "/v1/catalog/items/mapping",
"request_body_required": true,
"idempotency_key_required": true,
"confirmation_required": true
},
{
"action": "restore_previous_mapping",
"title": "Restore previous mapping",
"description": "Restore the immediately previous complete mapping snapshot by appending a new revision.",
"operation_id": "RestorePreviousCompanyItemMapping",
"method": "POST",
"href": "/v1/catalog/items/mapping/restorations",
"request_body_required": true,
"idempotency_key_required": true,
"confirmation_required": true
},
{
"action": "get_mapping_history",
"title": "Get mapping history",
"description": "Retrieve immutable mapping revisions under the caller's present authority.",
"operation_id": "ListCompanyItemMappingHistory",
"method": "GET",
"href": "/v1/catalog/items/mapping/history?company_item_id=COMPANY-1001",
"request_body_required": false,
"idempotency_key_required": false,
"confirmation_required": false
}
]
}
},
{
"operation_id": "RestorePreviousCompanyItemMapping",
"title": "Restore a company item's previous mapping",
"status": "Customer Testing",
"method": "POST",
"path": "/v1/catalog/items/mapping/restorations",
"request": {
"company_item_id": "COMPANY-1001",
"restore_from_revision": 3,
"expected_mapping_revision": 4
},
"response": {
"operation_reference": "directmap_2123456789abcdef0123456789abcdef",
"item_skey": "11111111-1111-4111-8111-111111111111",
"company_item_id": "COMPANY-1001",
"transition": "mapping_restored",
"mapping_status": "active",
"restored_from_revision": 3,
"mapping_revision": 5,
"hph_item_code": "012NI0032",
"reused": false,
"validation": {
"outcome": "mapped",
"warnings": []
},
"available_actions": [
{
"action": "get_current_mapping",
"title": "Get current mapping",
"description": "Retrieve the current mapping under the caller's present authority.",
"operation_id": "GetCompanyItemCurrentMapping",
"method": "GET",
"href": "/v1/catalog/items/mapping?company_item_id=COMPANY-1001",
"request_body_required": false,
"idempotency_key_required": false,
"confirmation_required": false
},
{
"action": "set_mapping",
"title": "Set mapping",
"description": "Set the desired HPH Item Code for this company item.",
"operation_id": "SetCompanyItemMapping",
"method": "PUT",
"href": "/v1/catalog/items/mapping",
"request_body_required": true,
"idempotency_key_required": true,
"confirmation_required": true
},
{
"action": "get_mapping_history",
"title": "Get mapping history",
"description": "Retrieve immutable mapping revisions under the caller's present authority.",
"operation_id": "ListCompanyItemMappingHistory",
"method": "GET",
"href": "/v1/catalog/items/mapping/history?company_item_id=COMPANY-1001",
"request_body_required": false,
"idempotency_key_required": false,
"confirmation_required": false
}
]
}
},
{
"operation_id": "GetHphItemDetailsByCodeBatch",
"title": "Get HPH item details",
"status": "Customer Testing",
"method": "POST",
"path": "/v1/hph/catalog/items/details",
"request": {
"items": [
{
"request_key": "line-1",
"hph_item_code": "012NI0018"
}
]
},
"response": {
"contract_version": "v1",
"results": [
{
"outcome": "available",
"request_index": 0,
"request_key": "line-1",
"item": {
"item_ids": {
"hph_item_code": "012NI0018",
"manufacturer_part_number": "SYN-607",
"manufacturer_order_number": "SYN-9055750",
"manufacturer_upc": "000000000001"
},
"company_item_count": 2,
"lifecycle": "active",
"availability_status": "A",
"size": "1 in",
"descriptions": {
"company": null,
"hph_long": "Synthetic copper elbow",
"hph_short": "Synthetic elbow",
"manufacturer": null
},
"manufacturer": {
"manufacturer_id": "org-0000-1411",
"name": "Synthetic Manufacturer",
"short_name": null
},
"categorization": {
"category": "Synthetic Fittings",
"subcategory": "Synthetic Elbows"
},
"weight": {
"value": 0.177,
"unit_of_measure": "LB"
}
}
}
]
}
},
{
"operation_id": "ListCompanyItemsByHphItemCode",
"title": "List company items using an HPH Item Code",
"status": "Customer Testing",
"method": "POST",
"path": "/v1/hph/catalog/items/catalog-usage",
"request": {
"hph_item_code": "012NI0018",
"page_size": 50
},
"response": {
"contract_version": "v1",
"hph_item_code": "012NI0018",
"company_item_count": 1,
"company_items": [
{
"item_skey": "11111111-1111-4111-8111-111111111111",
"company_item_id": "SYNTHETIC-1001",
"company_item_alt_id": null,
"description": "Synthetic catalog elbow",
"lifecycle": "active",
"mapping_revision": 3,
"effective_at": "2026-10-27T12:00:00Z"
}
]
}
},
{
"operation_id": "GetCompanyItemDetailsBatch",
"title": "Get company item details",
"status": "Customer Testing",
"method": "POST",
"path": "/v1/catalog/items/details",
"request": {
"items": [
{
"request_key": "line-1",
"selector": {
"company_item_identifier": "SYNTHETIC-1001"
}
}
]
},
"response": {
"contract_version": "v1",
"results": [
{
"outcome": "available",
"request_index": 0,
"request_key": "line-1",
"details": {
"item_skey": "b0f01d82-b996-11e0-b635-00137268a1bf",
"item_ids": {
"hph_item_code": "012NI0018",
"company_item_id": "SYNTHETIC-1001",
"company_item_alt_id": null
},
"size": "1 in",
"descriptions": {
"company": null,
"hph_long": "Synthetic copper elbow",
"hph_short": "Synthetic elbow",
"manufacturer": null
},
"manufacturer": {
"manufacturer_id": "org-0000-1411",
"name": "Synthetic Manufacturer",
"short_name": null
},
"availability_status": "A",
"categorization": {
"category": "Synthetic Fittings",
"subcategory": "Synthetic Elbows"
},
"weight": {
"value": 0.177,
"unit_of_measure": "LB"
},
"notices": []
}
}
]
}
},
{
"operation_id": "GetCompanyItemPriceLaborBatch",
"title": "Get company item price and default labor",
"status": "Customer Testing",
"method": "POST",
"path": "/v1/catalog/items/price-labor",
"request": {
"items": [
{
"request_key": "line-1",
"selector": {
"item_skey": "b0f01d82-b996-11e0-b635-00137268a1bf"
}
}
]
},
"response": {
"contract_version": "v1",
"results": [
{
"outcome": "available",
"request_index": 0,
"request_key": "line-1",
"item": {
"item_skey": "b0f01d82-b996-11e0-b635-00137268a1bf",
"manufacturer_list_price": {
"price_sheet_skey": "3d4c7bfc-49b0-11e9-9891-00137268a1bf",
"price": 18.11,
"currency": "USD",
"unit_of_measure": "E",
"effective_date": "2026-10-01",
"price_sheet_number": "SYN-2026-10",
"price_sheet_name": "Synthetic price sheet"
},
"labor_hours": [
{
"hph_labor_code": "L-SYN-001",
"provider": "MCAA",
"method": "COMPONENT",
"description": "Synthetic component installation",
"hours": 0.57,
"unit_of_measure": "HOUR",
"effective_date": "2026-10-01",
"is_default": true
}
],
"notices": []
}
}
]
}
},
{
"operation_id": "GetCompanyItemLaborHours",
"title": "Get company item labor hours",
"status": "Customer Testing",
"method": "POST",
"path": "/v1/catalog/items/labor-hours",
"request": {
"items": [
{
"request_key": "line-1",
"selector": {
"hph_item_code": "012NI0018"
}
}
],
"labor_hours_filter": {
"provider": "MCAA",
"method": "COMPONENT",
"selection": "item_defaults"
}
},
"response": {
"contract_version": "v1",
"results": [
{
"outcome": "available",
"request_index": 0,
"request_key": "line-1",
"item": {
"item_skey": "b0f01d82-b996-11e0-b635-00137268a1bf",
"labor_hours": [
{
"hph_labor_code": "L-SYN-001",
"provider": "MCAA",
"method": "COMPONENT",
"description": "Synthetic component installation",
"hours": 0.57,
"unit_of_measure": "HOUR",
"effective_date": "2026-10-01",
"is_default": true
}
],
"notices": []
}
}
]
}
},
{
"operation_id": "CreateCompanyCatalogItem",
"title": "Add a company catalog item",
"status": "Customer Testing",
"method": "POST",
"path": "/v1/catalog/items",
"request": {
"hph_item_code": "780TA5241",
"company_item_id": "COMPANY-1001",
"alternate_company_item_id": "ALT-1001",
"company_description": "Synthetic catalog item",
"reason": "Add the governed item to the company material catalog"
},
"response": {
"contract_version": "v1",
"operation_reference": "catalogcreate_0123456789abcdef0123456789abcdef",
"outcome": "already_present",
"item": {
"item_skey": "11111111-1111-4111-8111-111111111111",
"company_item_id": "COMPANY-1001",
"alternate_company_item_id": "ALT-1001",
"company_description": "Synthetic catalog item",
"lifecycle": "active",
"item_history_revision": 7,
"observed_at": "2026-11-05T12:00:00Z"
},
"reused": true
}
},
{
"operation_id": "GetHphItemAlternatives",
"title": "Get HPH Catalog Item alternatives",
"status": "Customer Testing",
"method": "POST",
"path": "/v1/hph/catalog/items/alternatives",
"request": {
"hph_item_code": "012NI0018",
"include": [
"manufacturer_list_price"
]
},
"response": {
"contract_version": "v1",
"outcome": "available",
"alternatives": [
{
"option_reference": "opaque-short-lived-option-reference",
"manufacturer": {
"name": "Synthetic Manufacturer"
},
"description": "Synthetic alternative description",
"size": "1 inch",
"manufacturer_part_number": "SYN-100",
"availability_status": "A",
"manufacturer_list_price": {
"price_sheet_skey": "3d4c7bfc-49b0-11e9-9891-00137268a1bf",
"price": 18.11,
"currency": "USD",
"unit_of_measure": "E",
"effective_date": "2026-10-01",
"price_sheet_number": "SYN-2026-10",
"price_sheet_name": "Synthetic price sheet"
}
}
],
"notices": []
}
},
{
"operation_id": "GetHphItemAlternativesByCompanyItem",
"title": "Get alternatives for a Company catalog item",
"status": "Customer Testing",
"method": "POST",
"path": "/v1/catalog/items/alternatives",
"request": {
"company_item_id": "SYNTHETIC-ITEM-100",
"alternate_company_item_id": null,
"include": [
"manufacturer_list_price"
]
},
"response": {
"contract_version": "v1",
"outcome": "available",
"alternatives": [
{
"option_reference": "opaque-short-lived-option-reference",
"manufacturer": {
"name": "Synthetic Manufacturer"
},
"description": "Synthetic alternative description",
"size": "1 inch",
"manufacturer_part_number": "SYN-100",
"availability_status": "A",
"manufacturer_list_price": null
}
],
"notices": []
}
},
{
"operation_id": "SelectHphItemAlternative",
"title": "Select an HPH Catalog Item alternative",
"status": "Customer Testing",
"method": "POST",
"path": "/v1/catalog/items/alternative-selections",
"request": {
"option_reference": "opaque-short-lived-option-reference",
"company_item_id": "SYNTHETIC-ITEM-100",
"alternate_company_item_id": null,
"company_description": "Synthetic selected alternative",
"reason": "Selected for the represented company catalog.",
"confirmed": true
},
"response": {
"contract_version": "v1",
"operation_reference": "alternative_select_0123456789abcdef0123456789abcdef",
"outcome": "selected",
"item_skey": "11111111-1111-4111-8111-111111111111",
"company_item_id": "SYNTHETIC-ITEM-100",
"catalog_revision": 2,
"reused": false
}
},
{
"operation_id": "SubmitAutodeskFabricationItemMapping",
"title": "Submit an Autodesk Fabrication item for mapping",
"status": "Customer Testing",
"method": "POST",
"path": "/v1/autodesk-fabrication/item-mapping-requests",
"request": {
"fabrication_item": {
"id": "FAB-SYN-100",
"description": "Synthetic 1/2 in. bronze ball valve",
"manufacturer": "Synthetic Manufacturing",
"product": "Valve",
"size": "1/2 IN",
"material": "Bronze"
}
},
"response": {
"contract_version": "v1",
"operation_reference": "mapop_0123456789abcdef0123456789abcdef",
"correlation_id": "corr_synthetic_fab_01",
"fabrication_item_id": "FAB-SYN-100",
"company_item": {
"resolution": "resolved",
"company_item_id": "ACME-1001",
"mapping_revision": 3
},
"request_revision": 1,
"result_revision": 1,
"mapping_revision": 3,
"status": "review_required",
"existing_mapping": null,
"claimed_hph_item_code_status": null,
"candidates": [
{
"candidate_token": "ct_synthetic_0001",
"rank": 1,
"hph_item_code": "123AB4567",
"manufacturer": "Synthetic Manufacturing",
"description": "Synthetic 1/2 in. bronze ball valve",
"product": "Valve",
"material": "Bronze",
"size": "1/2 IN",
"item_status": "A",
"review_classification": "strong",
"reasons": [
"description_consistent",
"size_consistent"
],
"warnings": []
}
],
"available_actions": [
"accept_for_review",
"ignore"
],
"next_action": "accept_for_review",
"completed_at": "2026-11-11T15:00:00Z",
"reused": false
}
}
]