{
  "opencollection": "1.0.0",
  "info": {
    "name": "VTex Anti-fraud Provider Account Notification API",
    "version": "1.0"
  },
  "items": [
    {
      "info": {
        "name": "Notification",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "VTex Notify marketplace of price update",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{providerApiEndpoint}/notificator/:sellerId/changenotification/:skuId/price",
            "headers": [
              {
                "name": "Accept",
                "value": ""
              },
              {
                "name": "Content-Type",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "accountName",
                "value": "",
                "type": "path",
                "description": "Name of the VTEX account that belongs to the marketplace. The notification will be posted into this account."
              },
              {
                "name": "environment",
                "value": "",
                "type": "path",
                "description": "Environment to use. Used as part of the URL."
              },
              {
                "name": "sellerId",
                "value": "",
                "type": "path",
                "description": "A string that identifies the seller in the marketplace. This ID must be created by the marketplace and informed to the seller before the integration is built."
              },
              {
                "name": "skuId",
                "value": "",
                "type": "path",
                "description": "A string that identifies the seller's SKU that suffered the change. This is the ID that the marketplace will use for all  references to this SKU, such as price and inventory notifications."
              }
            ]
          },
          "docs": "This endpoint is used by *sellers* to notify marketplaces that the price has changed for one of their SKUs. \n\nThere is no request body in this call, indicating the new price value, for instance. It only notifies a specific marketplace (`accountName`) that a seller (`sellerId`) has changed the price of an SKU (`skuId`). \n\n*Marketplaces* will then call the [fulfillment endpoint](https://developers.vtex.com/vtex-rest-api/reference/fulfillment-simulation) provided in the seller registration form to "
        },
        {
          "info": {
            "name": "VTex Notify marketplace of inventory update",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{providerApiEndpoint}/notificator/:sellerId/changenotification/:skuId/inventory",
            "headers": [
              {
                "name": "Accept",
                "value": ""
              },
              {
                "name": "Content-Type",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "accountName",
                "value": "",
                "type": "path",
                "description": "Name of the VTEX account that belongs to the marketplace. The notification will be posted into this account."
              },
              {
                "name": "environment",
                "value": "",
                "type": "path",
                "description": "Environment to use. Used as part of the URL."
              },
              {
                "name": "sellerId",
                "value": "",
                "type": "path",
                "description": "A string that identifies the seller in the marketplace. This ID must be created by the marketplace and informed to the seller before the integration is built."
              },
              {
                "name": "skuId",
                "value": "",
                "type": "path",
                "description": "A string that identifies the seller's SKU that suffered the change. This is the ID that the marketplace will use for all  references to this SKU, such as price and inventory notifications."
              }
            ]
          },
          "docs": "This endpoint is used by *sellers* to notify marketplaces that the inventory level has changed for one of their SKUs. \n\nThere is no request body in this call, indicating the new inventory level, for instance. It only notifies a specific marketplace (`accountName`) that a seller (`sellerId`) has changed the inventory level of an SKU (`skuId`). \n\n*Marketplaces* will then call the [fulfillment endpoint](https://developers.vtex.com/vtex-rest-api/reference/fulfillment-simulation) provided in the sell"
        },
        {
          "info": {
            "name": "VTex Notify carrier with app",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{providerApiEndpoint}/:app_name/v:app_version/:account/:workspace/notify",
            "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 notifies the carrier about a dispatch order by calling the `vtex.carrier-notifier app`. When the call is made, the following data is sent: \n\n- Dispatched packages information. \n\n- Fiscal information about the carrier notified. \n\n- Carrier's contact email. \n\nThe call's response includes all tracking data and each package's ID generated by the notification made to the carrier. \r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authenticati"
        }
      ]
    }
  ],
  "bundled": true
}