Update VTEX - Marketplace Protocol - External Seller Marketplace.json

vtex · Dec 14, 2023 · 39ac3ae · 39ac3ae
1 parent c29e595
commit 39ac3ae
Showing 1 changed file with 28 additions and 15 deletions.
diff --git a/VTEX - Marketplace Protocol - External Seller Marketplace.json b/VTEX - Marketplace Protocol - External Seller Marketplace.json
@@ -126,9 +126,9 @@
                                 }
                             }
                         }
-                    },
+                    }
+                },
                     "deprecated": false
-                }
             }
         },
         "/pvt/orders/{marketplaceOrderId}/invoice/{invoiceNumber}/tracking": {
@@ -337,23 +337,28 @@
                 "properties": {
                     "type": {
                         "type": "string",
-                        "description": "Indicates the type of the invoice. Use `\"Output\"` for regular orders and `\"Input\"` for returns."
+                        "description": "Indicates the type of the invoice. Use `\"Output\"` for regular orders and `\"Input\"` for returns.",
+                        "example":"Output"
                     },
                     "invoiceNumber": {
                         "type": "string",
-                        "description": "Invoice number."
+                        "description": "Invoice number.",
+                        "example":"NFe-00002"
                     },
                     "courier": {
                         "type": "string",
-                        "description": "Courier, if available on invoice."
+                        "description": "Courier, if available on invoice.",
+                        "example":"courier-example"
                     },
                     "trackingNumber": {
                         "type": "string",
-                        "description": "Tracking number."
+                        "description": "Tracking number.",
+                        "example":"12345678abc"
                     },
                     "trackingUrl": {
                         "type": "string",
-                        "description": "Tracking URL."
+                        "description": "Tracking URL.",
+                        "example": "https://courier-example.com/tracking"
                     },
                     "items": {
                         "type": "array",
@@ -384,11 +389,13 @@
                     },
                     "issuanceDate": {
                         "type": "string",
-                        "description": "Issuance date."
+                        "description": "Issuance date.",
+                        "example": "2021-05-21T10:00:00"
                     },
                     "invoiceValue": {
                         "type": "integer",
-                        "description": "Invoice value."
+                        "description": "Invoice value.",
+                        "example": 6000
                     }
                 },
                 "example": {
@@ -439,19 +446,23 @@
                 "properties": {
                     "courier": {
                         "type": "string",
-                        "description": "Courier."
+                        "description": "Courier.",
+                        "example":"courier-example"
                     },
                     "trackingNumber": {
                         "type": "string",
-                        "description": "Tracking number."
+                        "description": "Tracking number.",
+                        "example": "12345678abc"
                     },
                     "trackingUrl": {
                         "type": "string",
-                        "description": "Tracking URL."
+                        "description": "Tracking URL.",
+                        "example": "https://courier-example.com/tracking"
                     },
                     "dispatchedDate": {
                         "type": "string",
-                        "description": "Date of order dispatch."
+                        "description": "Date of order dispatch.",
+                        "example":"2021-06-09"
                     }
                 },
                 "example": {
@@ -469,7 +480,8 @@
                 "properties": {
                     "isDelivered": {
                         "type": "boolean",
-                        "description": "Indicates if order has been delivered. `false` if it is in transit."
+                        "description": "Indicates if order has been delivered. `false` if it is in transit.",
+                        "example": true
                     },
                     "events": {
                         "type": "array",
@@ -518,7 +530,8 @@
                 "properties": {
                     "reason": {
                         "type": "string",
-                        "description": "Insert here the reason for the order's cancellation."
+                        "description": "Insert here the reason for the order's cancellation.",
+                        "example": "Product is unavailable."
                     }
                 },
                 "example": {