VTEX · Example Payload

Vtex Uploadfile Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Uploadfile 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": "UploadFile",
  "method": "POST",
  "path": "/api/b2b/import/buyer-orgs",
  "summary": "VTex Upload file",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "accountName": "accountName",
        "importId": "3c3cba0a-8355-4812-ad4d-f4c0b32e2613",
        "importState": "Uploaded",
        "percentage": "0",
        "lastUpdateDate": "2023-10-05T16:40:11+00:00",
        "fileName": "file.xlsx"
      }
    }
  ]
}