VTEX · Example Payload

Vtex Invoicenotification2 Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Invoicenotification2 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": "InvoiceNotification2",
  "method": "POST",
  "path": "/api/orders/pvt/document/{orderId}/invoices",
  "summary": "VTex Order invoice notification",
  "requestExamples": [
    {
      "contentType": "application/json",
      "example": {
        "type": "Output",
        "issuanceDate": "2010-01-31",
        "invoiceNumber": "9999",
        "invoiceValue": "10000",
        "invoiceKey": null,
        "invoiceUrl": null,
        "courier": null,
        "trackingNumber": null,
        "trackingUrl": null,
        "dispatchedDate": null,
        "items": [
          {
            "id": "1234",
            "price": 10000,
            "quantity": 1
          }
        ]
      }
    }
  ],
  "responseExamples": []
}