VTEX · Example Payload

Vtex Createupdatedock Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Createupdatedock 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": "Create/UpdateDock",
  "method": "POST",
  "path": "/api/logistics/pvt/configuration/docks",
  "summary": "VTex Create/update dock",
  "requestExamples": [
    {
      "contentType": "application/json; charset=utf-8",
      "example": {
        "id": "catete",
        "name": "Loja Catete",
        "priority": 0,
        "dockTimeFake": "00:00:00",
        "timeFakeOverhead": "00:00:00",
        "salesChannels": [
          "1"
        ],
        "salesChannel": null,
        "freightTableIds": [],
        "wmsEndPoint": "",
        "address": {
          "postalCode": "22220070",
          "country": {
            "acronym": "BRA",
            "name": "Brazil"
          },
          "city": "Rio de Janeiro",
          "state": "RJ",
          "neighborhood": "Catete",
          "street": "Artur Bernardes Street",
          "number": "100",
          "complement": "",
          "coordinates": [
            [
              -43.18228090000002,
              -22.9460398
            ]
          ]
        }
      }
    }
  ],
  "responseExamples": []
}