{
  "opencollection": "1.0.0",
  "info": {
    "name": "VTex Anti-fraud Provider Account Seller Commissions API",
    "version": "1.0"
  },
  "items": [
    {
      "info": {
        "name": "Seller Commissions",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "VTex List Seller Commissions by seller ID",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{providerApiEndpoint}/seller-register/pvt/sellers/:sellerId/commissions",
            "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."
              }
            ]
          },
          "docs": "This endpoint retrieves all comissions configured for a specific seller. It is not necessary to send a request body.\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 the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` e"
        },
        {
          "info": {
            "name": "VTex Upsert Seller Commissions in bulk",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{providerApiEndpoint}/seller-register/pvt/sellers/:sellerId/commissions",
            "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."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This endpoint is used by marketplace operators to define comissions for multiple categories, sending an array with multiple objects in the same call.\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 the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they w"
        },
        {
          "info": {
            "name": "VTex Get Seller Commissions by Category ID",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{providerApiEndpoint}/seller-register/pvt/sellers/:sellerId/commissions/:categoryId",
            "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. All data extracted, and changes added 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."
              },
              {
                "name": "categoryId",
                "value": "",
                "type": "path",
                "description": "ID of the category in which the comission was applied"
              }
            ]
          },
          "docs": "This endpoint retrieves seller comissions applied to the selected category. It is not necessary to send a request body.\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 the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403"
        },
        {
          "info": {
            "name": "VTex Remove Seller Commissions by Category ID",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{providerApiEndpoint}/seller-register/pvt/sellers/:sellerId/commissions/:categoryId",
            "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": "categoryId",
                "value": "",
                "type": "path",
                "description": "ID of the category in which the comission was applied"
              }
            ]
          },
          "docs": "This endpoint removes a seller comission on the selected category.\r\n\r\n >❗This action cannot be undone, to reconfigure the commission it is necessary to use the [Upsert Seller Commissions in Bulk endpoint](https://developers.vtex.com/docs/api-reference/marketplace-apis#put-/seller-register/pvt/sellers/-sellerId-/commissions/categories?endpoint=put-/seller-register/pvt/sellers/-sellerId-/commissions/categories). \r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/g"
        }
      ]
    }
  ],
  "bundled": true
}