VocalDocscontracts 1.65.0

Read the references without a vendor price in force

GET /v1/platform/vendor-prices/gaps

PropertyValue
Operationget_vendor_price_gaps
GroupPlatform
Scopeplatform:read
Route classread
IdempotencyNo Idempotency-Key
AuditNot audited: A configuration read; price gaps are platform data.
Released in1.42.0
Phase 0 hostServed (the hosted api pins 1.65.0)

The price gaps at the instant of the read (1.42.0, board #134), as the operator command list_price_gaps prints them: each unpriced reference of an active published Agent version, each carrier item a phone Call is rated by, each registry secondary and each enabled inventory item without a vendor price row in force for every unit of its stage, with source, where, stage, provider, model, units and fails, and the count of failing gaps. A version or carrier gap fails the deploy step price-gaps; the others are listed only. Not paginated. Identifiers and units only, no content, so the read is not audited.

Request

Set VOCAL_API to the base URL of your API and VOCAL_API_KEY to an API key with the platform:read scope (Authentication and keys). Replace each placeholder, such as agt_... or <name>, with your own value.

curl "$VOCAL_API/v1/platform/vendor-prices/gaps" \
  -H "Authorization: Bearer $VOCAL_API_KEY"

Responses

StatusContent typeShapeError codes
200application/jsonPriceGapList
400application/jsonErrorEnvelopeinvalid_request
401application/jsonErrorEnvelopeunauthenticated
403application/jsonErrorEnvelopeforbidden
429application/jsonErrorEnveloperate_limited
500application/jsonErrorEnvelopeinternal_error

Fields of the 200 answer

The shape is PriceGapList.

FieldTypeRequiredDescription
failingintegeryesHow many gaps fail (fails true), as the command prints price gaps: <n>, <failing> failing; 0 when the deploy step would pass.
gapsarray of PriceGapyesEvery gap at the read, in the order of the command: the version gaps, the carrier gaps, the registry gaps, then the inventory gaps. Empty when every reference is priced.
object"price_gap_list"yes