Map company catalog items
Submit items, review candidates, inspect current mapping and history, and follow server-advertised actions.
Customer Testing. Every operation documented here is available to the Customer Testing group. Production is not available. Access, credentials, and base URLs are provided during onboarding and never appear in this documentation.
REST API · version 1
Build material catalog integrations on one stable HPH boundary.
Search and identify catalog items, retrieve product information, pricing and licensed labor hours, manage mappings, and connect company workflows through bounded REST and MCP contracts.
Start here
Choose a task, then confirm its status
Every operation is part of the versioned public v1 contract and available in Customer Testing. Every request is authenticated and authorized again; a listed operation never grants authority on its own.
Read the getting-started guide Explore synthetic examples Understand status labels
Explore by task
Search Material Catalog Items
Search the represented Company's catalog or the HPH catalog by text, identifier, or refinement.
Retrieve product details
Use explicit company or HPH item selectors to retrieve disclosure-reduced product information.
Get pricing and labor hours
Retrieve Manufacturer list price and independently licensed labor content through bounded task operations.
Add a company catalog item
Add one governed HPH Item Code to the represented direct company's Material Catalog with idempotency and capacity enforcement.
Inspect company context
Review current public capabilities and bounded API usage without selecting a Company in the request.
List material vendors
Retrieve the represented Company's active material-vendor directory.
API reference
GET
/v1/capabilitiesInspect effective capabilities
List the public operation codes this API deployment serves, as a connectivity check and a map of what is available.
POST
/v1/item-mapping-requestsSubmit one item for mapping
Submit one customer or partner item and receive a synchronous minimized mapping result with no more than five candidates.
GET
/v1/item-mapping-requests/{operation_reference}Retrieve the current mapping result
Retrieve the latest disclosed result, result revision, mapping revision, candidates, and currently advertised follow-up actions.
POST
/v1/item-mapping-requests/{operation_reference}/candidate-expansionsExpand mapping candidates
Request the next ten candidates, expanding the cumulative result from five to fifteen and then to a maximum of twenty-five.
POST
/v1/item-mapping-requests/{operation_reference}/review-proposalsAccept a candidate for review
Persist a review proposal for one candidate without approving, publishing, releasing, or activating a mapping.
POST
/v1/item-mapping-requests/{operation_reference}/ignore-decisionsIgnore a mapping request
Record that this mapping request is ignored without deleting, deactivating, replacing, or changing any existing active mapping.
POST
/v1/item-mapping-requests/{operation_reference}/production-releasesRelease a mapping to production
Release one eligible reviewed candidate. This is the only follow-up action that may activate a mapping and advance its mapping revision.
GET
/v1/catalog/items/mappingRetrieve a company item's current mapping
Retrieve the owning Company's catalog-item SKEY, current mapping status, per-item mapping revision, complete association count, and navigation links for one exact company catalog item.
PUT
/v1/catalog/items/mappingSet a company item's mapping
Set the desired HPH Item Code for one existing item in the represented Company's catalog. One desired-state request handles an initial mapping, an already-current no-op, and a replacement.
GET
/v1/catalog/items/mapping/associationsList current mapping associations
Retrieve the complete current HPH parent association for one company catalog item: either an empty collection or exactly one association.
GET
/v1/catalog/items/mapping/historyList mapping history revisions
Traverse immutable per-item mapping revisions, including active, superseded, and previously mapped empty states.
GET
/v1/catalog/items/mapping/history/{mapping_revision}/associationsList a historical association snapshot
Retrieve the complete empty-or-one HPH parent association recorded for one immutable positive mapping revision.
POST
/v1/catalog/items/mapping/restorationsRestore a company item's previous mapping
Restore the immediately preceding immutable mapping snapshot for one company item by appending it as a new current revision.
POST
/v1/hph/catalog/items/detailsGet HPH item details
Retrieve disclosure-reduced product details and the represented Company's exact catalog-usage count for one through ten exact HPH Item Codes.
POST
/v1/hph/catalog/items/catalog-usageList company items using an HPH Item Code
List one bounded page of the represented Company's catalog items currently using one exact HPH Item Code.
POST
/v1/catalog/items/detailsGet company item details
Retrieve disclosure-reduced product details for one through ten company catalog items.
POST
/v1/catalog/items/price-laborGet company item price and default labor
Retrieve current Manufacturer list price and at most one authorized Company-applicable default labor hour for one through ten items.
POST
/v1/catalog/items/labor-hoursGet company item labor hours
Retrieve authorized labor hours for one through ten company catalog items using optional provider, method, and default-selection filters.
POST
/v1/catalog/itemsAdd a company catalog item
Add one exact governed HPH Item Code to the represented direct Company's Material Catalog.
POST
/v1/hph/catalog/items/alternativesGet HPH Catalog Item alternatives
Compare up to 49 eligible alternatives for one exact caller-known HPH Item Code.
POST
/v1/catalog/items/alternativesGet alternatives for a Company catalog item
Compare up to 49 eligible alternatives for one represented-Company item without disclosing its mapped HPH Item Code.
POST
/v1/catalog/items/alternative-selectionsSelect an HPH Catalog Item alternative
Confirm one current opaque alternative option for the represented direct Company's catalog.
POST
/v1/autodesk-fabrication/item-mapping-requestsSubmit an Autodesk Fabrication item for mapping
Submit one Autodesk Fabrication item and receive a synchronous mapping result for the matching company item, with no more than five HPH Catalog Item candidates.
GET
/v1/meGet the current actor
Inspect the represented organization, actor type, and bounded effective public permissions for the current request context.
GET
/v1/company/capabilitiesGet company capabilities
Inspect the bounded public content capabilities currently available to the represented Company.
GET
/v1/company/usageGet company API usage
Retrieve bounded API usage, protected-content delivery counts, and current quota status for the represented Company.
GET
/v1/catalog/items/searchSearch Material Catalog Items
Search one explicitly selected catalog source, the represented Company's Material Catalog or the HPH Catalog, and receive one bounded page of item summaries.
GET
/v1/vendorsList material vendors
List up to 50 active material vendors attached to the represented Company's account.
GET
/v1/vendors/{vendor_skey}/accountsList material vendor accounts
List up to 50 active accounts attached to one represented-Company material vendor.
REST and MCP
MCP tools are thin task-oriented adapters over the same approved application operations, represented-company authority, disclosure policy, quotas, and usage accounting as REST. Review the MCP tools.
Authentication and environments
Customer Testing access is arranged during onboarding: you receive your credentials and base URLs directly. This documentation deliberately contains no credentials, token examples, tenant identifiers, or server addresses. Production is not available. Read about authentication and caller authority.