How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

VTEX Specification Field Value API

The Specification Field Value API from VTEX — 3 operation(s) for specification field value.

VTEX Specification Field Value API is one of 142 APIs that VTEX publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Specification Field Value. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 4 operations across 3 paths, and defines 3 schemas. It is described by OpenAPI 3.0.0, at version 1.0.

Requests are made against a single base URL, https://{providerApiEndpoint}.

4 operations 3 paths 3 schemas 2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0
Base URL
https://{providerApiEndpoint}
Authentication
API Key
Resource Areas
1

Authentication & Security 1

VTEX Specification Field Value API declares 1 security scheme for authenticating requests. An API key is passed in the header as VtexIdclientAutCookie (VtexIdclientAutCookie).

  • VtexIdclientAutCookie — [User token](https://developers.vtex.com/docs/guides/api-authentication-using-user-tokens), valid for 24 hours.

Paths & Operations 4

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

Specification Field Value 4
GET
/api/catalog_system/pvt/specification/fieldValue/{fieldValueId}
VTex Get specification field value
SpecificationsGetFieldValue 3 params → 200
GET
/api/catalog_system/pub/specification/fieldvalue/{fieldId}
VTex Get specification values by specification field ID
SpecificationsValuesByFieldId 3 params → 200
POST
/api/catalog_system/pvt/specification/fieldValue
VTex Create specification field value
SpecificationsInsertFieldValue 2 params body → 200
PUT
/api/catalog_system/pvt/specification/fieldValue
VTex Update specification field value
SpecificationsUpdateFieldValue 2 params body → 200

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are SpecificationsInsertFieldValueRequest (5 properties), SpecificationsUpdateFieldValueRequest (5 properties), GetSpecFieldValue (4 properties). Each schema is shown below with its type and property counts.

SpecificationsUpdateFieldValueRequest
object
5 properties 5 required
SpecificationsInsertFieldValueRequest
object
5 properties 5 required
GetSpecFieldValue
object
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vtex-specification-field-value-api-openapi.yml Raw ↑

Other APIs VTEX publishes across the network.

VTEX Account API
VTEX Addresses API
VTEX Anti-Fraud Flow API
VTEX App Keys API
VTEX Attachment API
VTEX Authentication API
VTEX Autocomplete API
VTEX Brand API
VTEX Bulk Import API
VTEX Carriers API
VTEX Cart Attachments API
VTEX Category API
Where this information came from

This is an independent, third-party profile of VTEX Specification Field Value API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.