{
  "opencollection": "1.0.0",
  "info": {
    "name": "VTex Anti-fraud Provider Account Tracking API",
    "version": "1.0"
  },
  "items": [
    {
      "info": {
        "name": "Tracking",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "VTex Update order tracking status",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{providerApiEndpoint}/api/oms/pvt/orders/:orderId/invoice/:invoiceNumber/tracking",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              },
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "orderId",
                "value": "1172452900788-01",
                "type": "path",
                "description": "Order ID is a unique code that identifies an order."
              },
              {
                "name": "invoiceNumber",
                "value": "000030711",
                "type": "path",
                "description": "Number that identifies the invoice."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This endpoint sends a tracking event to an order that already has a tracking number registered to its invoice.\r\n\r\nThis request is not meant to send a tracking number and URL to the invoice. If you wish to send a tracking number and URL to an order, use the [Update order's partial invoice](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/oms/pvt/orders/-orderId-/invoice/-invoiceNumber-) endpoint. For more information, see [Partial invoice](https://help.vtex.com/en/tracks/parti"
        },
        {
          "info": {
            "name": "VTex Tracking events with app",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{providerApiEndpoint}/:app_name/v:app_version/:account/:workspace/tracking",
            "params": [
              {
                "name": "app_name",
                "value": "",
                "type": "path",
                "description": "Name of the app developed by the carrier's integration."
              },
              {
                "name": "app_version",
                "value": "",
                "type": "path",
                "description": "Version of the app developed by the carrier's integration."
              },
              {
                "name": "account",
                "value": "",
                "type": "path",
                "description": "VTEX account dispatching the package."
              },
              {
                "name": "workspace",
                "value": "",
                "type": "path",
                "description": "Workspace used in VTEX IO. "
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This endpoint is called by the hub to  obtain the tracking events of a series of tracking numbers. This call's request updates the events of a list of tracking codes, for packages that are still pending delivery. The expected response is an object contaning the tracking information and the package's notification ID for every `packageID`. \r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of"
        }
      ]
    }
  ],
  "bundled": true
}