VTEX · Example Payload

Vtex Specificationsinsertfieldupdate Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Specificationsinsertfieldupdate Example is an example object payload from VTEX, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathsummaryrequestExamplesresponseExamples

Example Payload

Raw ↑ 
{
  "operationId": "SpecificationsInsertFieldUpdate",
  "method": "PUT",
  "path": "/api/catalog_system/pvt/specification/field",
  "summary": "VTex Update specification field",
  "requestExamples": [
    {
      "contentType": "application/json",
      "example": {
        "FieldId": 89,
        "Name": "Material",
        "CategoryId": 4,
        "IsActive": true,
        "IsRequired": true,
        "FieldTypeId": 1,
        "Description": "Composition of the product.",
        "IsStockKeepingUnit": false,
        "IsFilter": true,
        "IsOnProductDetails": true,
        "Position": 1,
        "IsWizard": false,
        "IsTopMenuLinkActive": false,
        "IsSideMenuLinkActive": false,
        "DefaultValue": "Cotton",
        "FieldGroupId": 20,
        "FieldGroupName": "Clothes specifications"
      }
    }
  ],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": 89
    }
  ]
}