VTEX · Example Payload

Vtex Starthandling Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Starthandling 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": "StartHandling",
  "method": "POST",
  "path": "/api/oms/pvt/orders/{orderId}/start-handling",
  "summary": "VTex Start handling order",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "401",
      "contentType": "application/json",
      "example": {
        "error": {
          "code": "1",
          "message": "Acesso n\u00e3o autorizado",
          "exception": null
        }
      }
    },
    {
      "status": "409",
      "contentType": "application/json",
      "example": {
        "error": {
          "code": "OMS003",
          "message": "Order status should be ready-for-handling to perform this action",
          "exception": null
        }
      }
    }
  ]
}