VTEX · Example Payload

Vtex Getproductdescription Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Getproductdescription 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": "GetProductDescription",
  "method": "GET",
  "path": "/api/catalog-seller-portal/products/{productId}/description",
  "summary": "VTex Get Product Description by Product ID",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "productId": "61",
        "description": "Beautifully handmade laptop case/sleeve made in the Nepal Himalaya. It can be slipped inside your backpack or carried alone with space for all your work bits and pieces!",
        "createdAt": "2022-10-10T19:18:45.612317Z",
        "updatedAt": "2022-10-11T18:12:58.825544Z"
      }
    }
  ]
}