VTEX · Schema

SpecificationsUpdateFieldValueRequest

CommerceE-CommerceRetailMarketplacePayments

Properties

Name	Type	Description
FieldId	integer	Specification field ID.
Name	string	Specification field value name.
Text	string	Specification field value description.
IsActive	boolean	Defines if the specification field value is active (`true`) or inactive (`false`).
Position	integer	Specification field position.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SpecificationsUpdateFieldValueRequest",
  "title": "SpecificationsUpdateFieldValueRequest",
  "required": [
    "FieldId",
    "Name",
    "Text",
    "IsActive",
    "Position"
  ],
  "type": "object",
  "properties": {
    "FieldId": {
      "type": "integer",
      "nullable": true,
      "description": "Specification field ID."
    },
    "Name": {
      "type": "string",
      "description": "Specification field value name."
    },
    "Text": {
      "type": "string",
      "nullable": true,
      "description": "Specification field value description."
    },
    "IsActive": {
      "type": "boolean",
      "description": "Defines if the specification field value is active (`true`) or inactive (`false`)."
    },
    "Position": {
      "type": "integer",
      "format": "int32",
      "description": "Specification field position."
    }
  },
  "example": {
    "FieldId": 1,
    "FieldValueId": 143,
    "Name": "Cotton",
    "Text": "Cotton fibers",
    "IsActive": true,
    "Position": 100
  }
}