Compare catalog items
Compares 2 to 20 catalog items you name by id. A price meaning the catalog does not state is left out, never guessed. No bearer token needed: the catalog is the same for every caller.
POST
/v1/public-catalog/compareRequest body
requiredapplication/jsoncatalogItemIdsstring[]requiredmin items 2 · max items 20
Responses
200
Conservative catalog comparison
itemsPublicCatalogItem[]requiredmin items 2 · max items 20
Show propertiesHide properties
Array of
PublicCatalogItemcatalogItemIdstringrequiredmatches ^[a-z][a-z0-9_-]{2,127}$
revisionintegerrequiredmin 1 · max 9007199254740991
providerIdstringrequiredmatches ^[a-z][a-z0-9_-]{2,127}$
operationIdstringrequiredmatches ^[a-z][a-z0-9_-]{2,127}$
titlestringrequiredmin length 1 · max length 160
descriptionstringrequiredmin length 1 · max length 2000
categoriesstring[]requiredmin items 1 · max items 30
capabilitiesstring[]requiredmax items 30
inputSchemaDigeststringrequiredmatches ^sha256:[a-f0-9]{64}$
outputSchemaDigeststringrequiredmatches ^sha256:[a-f0-9]{64}$
methodstring | nullrequiredAllowed:
GETPOSTPUTPATCHDELETEnullpathTemplatestring | nullrequiredmin length 1 · max length 1024
parametersobject[]requiredmax items 100
Show propertiesHide properties
Array of
objectnamestringrequiredmin length 1 · max length 120
locationanyrequiredAllowed:
querypathheaderbodyrequiredbooleanrequireddescriptionstringmin length 1 · max length 500
schemaDigeststringmatches ^sha256:[a-f0-9]{64}$
verificationobjectrequiredShow propertiesHide properties
stateanyrequiredAllowed:
unverifiedfixture_verifiedauthenticated_verifiedstaleverifiedAtstring<date-time> | nullrequiredresponseCaptureobjectrequiredShow propertiesHide properties
availablebooleanrequireddigeststring | nullrequiredmatches ^sha256:[a-f0-9]{64}$
referencesobject[]requiredmax items 20
Show propertiesHide properties
Array of
objectkindanyrequiredAllowed:
documentationpricingurlstring<uri>requiredmax length 2048
pricePublicCatalogPricerequiredShow propertiesHide properties
One of:
object
stateanyrequiredamountMicrosintegerrequiredmin 0 · max 9007199254740991
currencystringrequiredmatches ^[A-Z]{3}$
unitstringrequiredmin length 1 · max length 80
effectiveAtstring<date-time>requiredcomparisonBasisobjectShow propertiesHide properties
canonicalMeterstringrequiredmatches ^[a-z][a-z0-9_-]{2,127}$
billingBasisanyrequiredAllowed:
per_callper_resultper_unittierstringrequiredmin length 1 · max length 80
minimumMicrosintegerrequiredmin 0 · max 9007199254740991
roundinganyrequiredAllowed:
exactceilfloorobject
stateanyrequiredAllowed:
unknownuncomputablereasonstringrequiredmin length 1 · max length 300
publishedAtstring<date-time>requireditemDigeststringrequiredmatches ^sha256:[a-f0-9]{64}$
provenanceTieranyrequiredAllowed:
officialverified_partnercommunityprivateunverifiedpriceComparisonobjectrequiredShow propertiesHide properties
One of:
object
stateanyrequiredcurrencystringrequiredmatches ^[A-Z]{3}$
unitstringrequiredmin length 1 · max length 80
amountsobject[]requiredmin items 2 · max items 20
Show propertiesHide properties
Array of
objectcatalogItemIdstringrequiredmatches ^[a-z][a-z0-9_-]{2,127}$
amountMicrosintegerrequiredmin 0 · max 9007199254740991
lowestAmountMicrosintegerrequiredmin 0 · max 9007199254740991
lowestCatalogItemIdsstring[]requiredmin items 1 · max items 20
object
stateanyrequiredreasonanyrequiredAllowed:
price_state_unknown_or_uncomputablecapability_or_contract_mismatchprice_semantics_unverifiedcurrency_or_unit_mismatchcomparisonDigeststringrequiredmatches ^sha256:[a-f0-9]{64}$
400
Invalid selection
401
Only returned for a malformed request; no bearer token is required
403
Catalog read scope required
404
One or more catalog items not found