{
  "opencollection": "1.0.0",
  "info": {
    "name": "VTex Anti-fraud Provider Account Collection Beta API",
    "version": "1.0"
  },
  "items": [
    {
      "info": {
        "name": "Collection Beta",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "VTex Get all collections",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{providerApiEndpoint}/api/catalog_system/pvt/collection/search",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              },
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Page number."
              },
              {
                "name": "pageSize",
                "value": "",
                "type": "query",
                "description": "Number of the items of the page."
              },
              {
                "name": "orderByAsc",
                "value": "",
                "type": "query",
                "description": "Defines if the items of the page are in ascending order."
              }
            ]
          },
          "docs": "Retrieves a list of all collections matching a filter.\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` error. These are the applicable resources for this endpoint:\r\n\r"
        },
        {
          "info": {
            "name": "VTex Get all inactive collections",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{providerApiEndpoint}/api/catalog/pvt/collection/inactive",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              },
              {
                "name": "Accept",
                "value": ""
              }
            ]
          },
          "docs": "Retrieves a list of Collection IDs of the inactive collections.\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` error. These are the applicable resources for this end"
        },
        {
          "info": {
            "name": "VTex Create Collection",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{providerApiEndpoint}/api/catalog/pvt/collection/",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              },
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a new collection.\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` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category**"
        },
        {
          "info": {
            "name": "VTex Get Collections by search terms",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{providerApiEndpoint}/api/catalog_system/pvt/collection/search/:searchTerms",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              },
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "searchTerms",
                "value": "",
                "type": "path",
                "description": "String that will search for a collection related to it."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Page number."
              },
              {
                "name": "pageSize",
                "value": "",
                "type": "query",
                "description": "Number of the items of the page."
              },
              {
                "name": "orderByAsc",
                "value": "",
                "type": "query",
                "description": "Defines if the items of the page are in ascending order."
              }
            ]
          },
          "docs": "Retrieves a list of collections matching a filter.\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` error. These are the applicable resources for this endpoint:\r\n\r\n| *"
        },
        {
          "info": {
            "name": "VTex Import collection file example",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{providerApiEndpoint}/api/catalog/pvt/collection/stockkeepingunit/importfileexample",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              },
              {
                "name": "Accept",
                "value": ""
              }
            ]
          },
          "docs": "Imports a sample of the imported XLS file. You need to save the response file to your device.\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` error. These are the app"
        },
        {
          "info": {
            "name": "VTex Add products to collection by imported file",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{providerApiEndpoint}/api/catalog/pvt/collection/:collectionId/stockkeepingunit/importinsert",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              },
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "collectionId",
                "value": "",
                "type": "path",
                "description": "Collection's unique identifier."
              }
            ],
            "body": {
              "type": "multipart-form",
              "data": [
                {
                  "name": "file",
                  "type": "text",
                  "value": ""
                }
              ]
            }
          },
          "docs": "Adds products to a collection from the request body file. The file must be an imported template.\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` error. These are the "
        },
        {
          "info": {
            "name": "VTex Remove products from collection by imported file",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{providerApiEndpoint}/api/catalog/pvt/collection/:collectionId/stockkeepingunit/importexclude",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              },
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "collectionId",
                "value": "",
                "type": "path",
                "description": "Collection's unique identifier."
              }
            ],
            "body": {
              "type": "multipart-form",
              "data": [
                {
                  "name": "file",
                  "type": "text",
                  "value": ""
                }
              ]
            }
          },
          "docs": "Removes products from a collection from the request body file. The file must be an imported template.\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` error. These are"
        },
        {
          "info": {
            "name": "VTex Get products from a collection",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{providerApiEndpoint}/api/catalog/pvt/collection/:collectionId/products",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              },
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "collectionId",
                "value": "",
                "type": "path",
                "description": "Collection's unique identifier."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Page number."
              },
              {
                "name": "pageSize",
                "value": "",
                "type": "query",
                "description": "Number of the items of the page."
              },
              {
                "name": "Filter",
                "value": "",
                "type": "query",
                "description": "Filter used to refine the collection's products."
              },
              {
                "name": "Active",
                "value": "",
                "type": "query",
                "description": "Defines if the status of the product is active or not."
              },
              {
                "name": "Visible",
                "value": "",
                "type": "query",
                "description": "Defines if the product is visible on the store or not."
              },
              {
                "name": "CategoryId",
                "value": "",
                "type": "query",
                "description": "Product's category unique identifier."
              },
              {
                "name": "BrandId",
                "value": "",
                "type": "query",
                "description": "Product's brand unique identifier."
              },
              {
                "name": "SupplierId",
                "value": "",
                "type": "query",
                "description": "Product's supplier unique identifier."
              },
              {
                "name": "SalesChannelId",
                "value": "",
                "type": "query",
                "description": "Product's trade policy unique identifier."
              },
              {
                "name": "ReleaseFrom",
                "value": "",
                "type": "query",
                "description": "Product past release date."
              },
              {
                "name": "ReleaseTo",
                "value": "",
                "type": "query",
                "description": "Product future release date."
              },
              {
                "name": "SpecificationProduct",
                "value": "",
                "type": "query",
                "description": "Product specification field Value. You must also fill in `SpecificationFieldId` to use this parameter."
              },
              {
                "name": "SpecificationFieldId",
                "value": "",
                "type": "query",
                "description": "Product specification field unique identifier."
              }
            ]
          },
          "docs": "Retrieves information about the products from a collection.\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` error. These are the applicable resources for this endpoin"
        }
      ]
    }
  ],
  "bundled": true
}