VTEX · Example Payload

Vtex Createlog Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Createlog 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

{
  "operationId": "CreateLog",
  "method": "POST",
  "path": "/api/sent-offers/feeds/{feedId}/skus/{skuId}/interactions/{interactionId}/logs",
  "summary": "VTex Create Log",
  "requestExamples": [
    {
      "contentType": "application/json",
      "example": {
        "description": "Another log message with some information that is going to be relevant to our users",
        "date": "2020-03-22",
        "type": "information",
        "agent": "broadcaster",
        "evidence": {
          "request": "Explanation 1",
          "response": "Explanation 2"
        },
        "data": {
          "externalOfferId": "123456",
          "inventory": "33",
          "salesPrice": "79.99",
          "currency": "BRL",
          "status": "disabled"
        },
        "errors": {
          "code": "CTLG-001",
          "externalCode": "284692",
          "title": "Description includes HTML",
          "description": "Netshoes does not allow HTML tags in an offer's description. Access the product in your Catalog to remove the HTML tag.",
          "closableOrigins": [
            "catalog",
            "price"
          ]
        }
      }
    }
  ],
  "responseExamples": []
}