Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Resourcly Items API

The Items API from Resourcly — 15 operation(s) for items.

Resourcly Items API is one of 22 APIs that Resourcly publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Items. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 16 operations across 15 paths, and defines 43 schemas. It is described by OpenAPI 2.0, at version 1.0.0.

Requests are made against the base URL https://api.resourcly.com/v1.

16 operations 15 paths 43 schemas 1 DELETE10 GET3 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
1.0.0
Base URL
https://api.resourcly.com/v1
Authentication
API Key
License
Proprietary
Terms of Service
Resource Areas
1

Authentication & Security 1

Resourcly Items API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (BearerAuth).

  • BearerAuth — Firebase JWT token. Format: "Bearer {token}"

Paths & Operations 16

Across 15 paths, the API surfaces 16 operations — 1 DELETE, 10 GET, 3 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Items 16
DELETE
/items/{id}/hs-code
Remove an item's HS code decision
1 param → 204401404
POST
/items/{id}/hs-code/override
Overwrite an item's HS code
2 params → 200400401404
POST
/items/{id}/hs-code/verify
Verify an item's HS code
2 params → 200400401404
GET
/items
List items with pagination
4 params → 200400401403
POST
/items/comparison-status/batch
Get comparison review statuses for multiple item pairs
1 param → 200400401
GET
/items/similarity
List items by similarity score range
4 params → 200400401503
GET
/items/similarity-clusters
List item clusters by AI classification
1 param → 200400401503
GET
/items/similarity-counts
Get similarity out-degree counts for items
2 params → 200400401503
GET
/items/{id1}/compare/{id2}
Compare two items side-by-side
2 params → 200400401404
GET
/items/{id1}/compare/{id2}/ai-analysis
Get AI-powered engineering analysis for two items
2 params → 200400401404500
GET
/items/{id1}/comparison-status/{id2}
Get comparison review status for two items
2 params → 200400401404
PUT
/items/{id1}/comparison-status/{id2}
Update comparison review status for two items
3 params → 200400401
GET
/items/{id}
Get item details
1 param → 200400401404
GET
/items/{id}/source-url
Get signed source document URL for an item
1 param → 200400401404500
GET
/items/{id}/visual-similar
Get visually similar items
3 params → 200400401404503
PUT
/v1/items/{id}/preferred
Mark an item as a preferred part
2 params → 200400404

Schemas 43

The contract defines 43 schemas that model the data the API accepts and returns. The most detailed are models.MatchedSpec (27 properties), models.HSCodeSuggestion (22 properties), models.ItemDetailsResponse (16 properties), models.ItemHSCode (16 properties). Each schema is shown below with its type and property counts.

models.HSCodeVerifyRequest
object
2 properties
services.ItemListEntry
object
13 properties
models.PairClassFactor
object
2 properties
models.AIItemComparisonResponse
object
6 properties
models.AIAnalysisVerdict
object
10 properties
models.DataGovernanceConditionSpec
object
6 properties
models.AIAnalysisResult
object
8 properties
models.MatchedSpec
object
27 properties
models.SpecDiff
object
11 properties
models.ItemValidationConfig
object
2 properties
handlers.SimilarityClustersResponse
object
3 properties
models.AIAnalysisSimilarityScores
object
6 properties
models.VisualSimilarResponse
object
3 properties
services.ClusterItem
object
4 properties
models.DocumentTable
object
5 properties
models.ComparisonStatusResponse
object
9 properties
services.SimilarityListItem
object
9 properties
models.ComparisonStatusBatchRequest
object
1 property
models.ItemComparisonResponse
object
12 properties
models.ItemHSCode
object
16 properties
models.ComparisonStatusBatchResponse
object
1 property
models.HSCodeSuggestion
object
22 properties
models.ItemPair
object
2 properties
models.SourceDocumentInfo
object
11 properties
models.PairClassComparison
object
5 properties
models.AIAnalysisItemSummary
object
4 properties
models.UpdateComparisonStatusRequest
object
1 property
models.HSCodeAlternative
object
3 properties
handlers.SimilarityItemsResponse
object
5 properties
models.ItemComparisonSide
object
12 properties
services.ItemCluster
object
3 properties
models.SuggestedCatalogAttribute
object
6 properties
models.AIAnalysisCatalogActions
object
4 properties
models.AIAnalysisSideBySideRow
object
6 properties
models.PairClassComparisonRow
object
5 properties
handlers.ItemListResponse
object
5 properties
models.VisualSimilarItem
object
8 properties
models.ErrorResponse
object
3 properties
models.SimilarityScores
object
11 properties
models.ItemDetailsResponse
object
16 properties
models.UpdateItemPreferredRequest
object
1 property
models.DataGovernanceStatementSpec
object
3 properties
models.HSCodeOverrideRequest
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

resourcly-items-api-openapi.yml Raw ↑

Other APIs Resourcly publishes across the network.

Resourcly analytics API
Resourcly auth API
Resourcly bom-comparisons API
Resourcly boms API
Resourcly business API
Resourcly datasources API
Resourcly documents API
Resourcly drive API
Resourcly duplicates API
Resourcly email API
Resourcly feedback API
Resourcly health API