VTEX · Example Payload

Vtex Createupdatepickuppoint Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Createupdatepickuppoint 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": "CreateUpdatePickupPoint",
  "method": "PUT",
  "path": "/api/logistics/pvt/configuration/pickuppoints/{pickupPointId}",
  "summary": "VTex Create/update pickup point",
  "requestExamples": [
    {
      "contentType": "application/json; charset=utf-8",
      "example": {
        "id": "1a227d3",
        "name": "Loja Copacabana",
        "description": "",
        "instructions": "Obrigat\u251c\u2502rio apresentar documento de identifica\u251c\u00ba\u251c\u00fao",
        "formatted_address": "undefined",
        "address": {
          "postalCode": "22070002",
          "country": {
            "acronym": "BRA",
            "name": "Brazil"
          },
          "city": "Rio de Janeiro",
          "state": "RJ",
          "neighborhood": "Copacabana",
          "street": "Avenida Atl\u251c\u00f3ntica",
          "number": "",
          "complement": "",
          "reference": "Grey building",
          "location": {
            "latitude": -22.974477767944336,
            "longitude": -43.18672561645508
          }
        },
        "isActive": true,
        "businessHours": [
          {
            "dayOfWeek": 1,
            "openingTime": "08:00:00",
            "closingTime": "20:00:00"
          },
          {
            "dayOfWeek": 2,
            "openingTime": "08:00:00",
            "closingTime": "20:00:00"
          },
          {
            "dayOfWeek": 3,
            "openingTime": "08:00:00",
            "closingTime": "20:00:00"
          },
          {
            "dayOfWeek": 4,
            "openingTime": "08:00:00",
            "closingTime": "20:00:00"
          },
          {
            "dayOfWeek": 5,
            "openingTime": "08:00:00",
            "closingTime": "20:00:00"
          }
        ],
        "tagsLabel": [
          "zonasul",
          "rio de janeiro"
        ]
      }
    }
  ],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json; charset=utf-8",
      "example": {
        "id": "rteste",
        "name": "Loja Copacabana",
        "description": "",
        "instructions": "Obrigat\u251c\u2502rio apresentar documento de identifica\u251c\u00ba\u251c\u00fao",
        "formatted_address": "undefined",
        "address": {
          "postalCode": "22070002",
          "country": {
            "acronym": "BRA",
            "name": "Brazil"
          },
          "city": "Rio de Janeiro",
          "state": "RJ",
          "neighborhood": "Copacabana",
          "street": "Avenida Atl\u251c\u00f3ntica",
          "number": "",
          "complement": "",
          "reference": null,
          "location": {
            "latitude": -22.974477767944336,
            "longitude": -43.18672561645508
          }
        },
        "isActive": true,
        "businessHours": [
          {
            "dayOfWeek": 1,
            "openingTime": "08:00:00",
            "closingTime": "20:00:00"
          },
          {
            "dayOfWeek": 2,
            "openingTime": "08:00:00",
            "closingTime": "20:00:00"
          },
          {
            "dayOfWeek": 3,
            "openingTime": "08:00:00",
            "closingTime": "20:00:00"
          },
          {
            "dayOfWeek": 4,
            "openingTime": "08:00:00",
            "closingTime": "20:00:00"
          },
          {
            "dayOfWeek": 5,
            "openingTime": "08:00:00",
            "closingTime": "20:00:00"
          }
        ],
        "tagsLabel": [
          "zonasul",
          "rio de janeiro"
        ],
        "pickupHolidays": []
      }
    }
  ]
}