VTEX · Example Payload

Vtex Listpickupppointsbylocation Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Listpickupppointsbylocation 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": "ListPickupPpointsByLocation",
  "method": "GET",
  "path": "/api/checkout/pub/pickup-points",
  "summary": "VTex List pickup points by location",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "paging": {
          "page": 1,
          "pageSize": 30,
          "total": 1,
          "pages": 1
        },
        "items": [
          {
            "distance": 0.8469786518616546,
            "pickupPoint": {
              "friendlyName": "physical-store-02",
              "address": {
                "addressType": "pickup",
                "receiverName": null,
                "addressId": "physical-store-02",
                "isDisposable": true,
                "postalCode": "23450-070",
                "city": "Rio de Janeiro",
                "state": "RJ",
                "country": "BRA",
                "street": "Praia de Botafogo",
                "number": "132",
                "neighborhood": "Botafogo",
                "complement": "Apto 101",
                "reference": null,
                "geoCoordinates": [
                  -47.924747467041016,
                  -15.832582473754883
                ]
              },
              "additionalInfo": null,
              "id": "02_Physical",
              "businessHours": [
                {
                  "DayOfWeek": 0,
                  "OpeningTime": "00:00:00",
                  "ClosingTime": "23:59:00"
                },
                {
                  "DayOfWeek": 1,
                  "OpeningTime": "00:00:00",
                  "ClosingTime": "23:59:00"
                },
                {
                  "DayOfWeek": 2,
                  "OpeningTime": "00:00:00",
                  "ClosingTime": "23:59:00"
                },
                {
                  "DayOfWeek": 3,
                  "OpeningTime": "00:00:00",
                  "ClosingTime": "23:59:00"
                },
                {
                  "DayOfWeek": 4,
                  "OpeningTime": "00:00:00",
                  "ClosingTime": "23:50:00"
                },
                {
                  "DayOfWeek": 5,
                  "OpeningTime": "00:00:00",
                  "ClosingTime": "23:59:00"
                },
                {
                  "DayOfWeek": 6,
                  "OpeningTime": "00:00:00",
                  "ClosingTime": "23:59:00"
                }
              ]
            }
          }
        ]
      }
    }
  ]
}