{ "opencollection": "1.0.0", "info": { "name": "VTex Anti-fraud Provider Account Bulk Import API", "version": "1.0" }, "items": [ { "info": { "name": "Bulk Import", "type": "folder" }, "items": [ { "info": { "name": "VTex Upload file", "type": "http" }, "http": { "method": "POST", "url": "https://{providerApiEndpoint}/api/b2b/import/buyer-orgs", "headers": [ { "name": "Content-Type", "value": "" } ], "params": [ { "name": "an", "value": "", "type": "query", "description": "Name of your VTEX account." } ], "body": { "type": "multipart-form", "data": [ { "name": "file", "type": "text", "value": "" } ] } }, "docs": "Uploads a file for bulk import of Buyer Organizations, Cost Centers and Members. The uploaded file should be in `XLSX` format and have less than 50MB. For more information on the file structure and how to fill it out, access the [Bulk Import Spreadsheet](https://developers.vtex.com/docs/guides/bulk-import-buyer-organizations-spreadsheet) guide.\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 " }, { "info": { "name": "VTex Check progress", "type": "http" }, "http": { "method": "GET", "url": "https://{providerApiEndpoint}/api/b2b/import/buyer-orgs/:importId", "headers": [ { "name": "Content-Type", "value": "" } ], "params": [ { "name": "an", "value": "", "type": "query", "description": "Name of your VTEX account." }, { "name": "importId", "value": "", "type": "path", "description": "Unique identifier of the import." } ] }, "docs": "Checks the progress of a started file validation or import process. After initiating validation using [Validate file](https://developers.vtex.com/docs/api-reference/buyer-organizations#post-/api/b2b/import/buyer-orgs/validate/-importId-) or import using [Start import](https://developers.vtex.com/docs/api-reference/buyer-organizations#post-/api/b2b/import/buyer-orgs/-importId-), you can track progress by sending a request to this endpoint. \r\n\r\n## Permissions\r\n\r\nAny user or [application key](https" }, { "info": { "name": "VTex Start import", "type": "http" }, "http": { "method": "POST", "url": "https://{providerApiEndpoint}/api/b2b/import/buyer-orgs/:importId", "headers": [ { "name": "Content-Type", "value": "" } ], "params": [ { "name": "an", "value": "", "type": "query", "description": "Name of your VTEX account." }, { "name": "importId", "value": "", "type": "path", "description": "Unique identifier of the import." } ] }, "docs": "Once the file is successfully uploaded and validated, you can call this endpoint to start the import. Provide the `importId` returned by the [Validate file](https://developers.vtex.com/docs/api-reference/buyer-organizations#post-/api/b2b/import/buyer-orgs/validate/-importId-) or [Upload file](https://developers.vtex.com/docs/api-reference/buyer-organizations#post-/api/b2b/import/buyer-orgs) endpoints. \r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api" }, { "info": { "name": "VTex Validate file", "type": "http" }, "http": { "method": "POST", "url": "https://{providerApiEndpoint}/api/b2b/import/buyer-orgs/validate/:importId", "headers": [ { "name": "Content-Type", "value": "" } ], "params": [ { "name": "an", "value": "", "type": "query", "description": "Name of your VTEX account." }, { "name": "importId", "value": "", "type": "path", "description": "Unique identifier of the import." } ] }, "docs": "Starts the bulk import file content validation. Once the the file is successfully uploaded, you can start the validation using the `importId` returned by the [Upload file](https://developers.vtex.com/docs/api-reference/buyer-organizations#post-/api/b2b/import/buyer-orgs) endpoint. \n\n## Permissions\n\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" } ] } ], "bundled": true }