Documentation
Feedback
Guides
API Reference

API Reference
Filter By
Post
Get
Put
Delete
Patch

Buyer Organizations (B2B Suite)

This API documentation applies to B2B Suite only.

The Buyer Organizations API facilitates the bulk import of Buyer Organizations, Cost Centers, and Members. By allowing spreadsheet import, this API simplifies the management of buyer organizations and allows easy updating and maintenance of information in B2B stores.

️Only .xlsx files under 50MB in size can be imported. You can download the template file as an example. For more information on the file structure and how to fill it out, access the Bulk Import Buyer Organizations Spreadsheet guide.

Common parameters in the documentation

Parameter name Description
{{accountName}} Name of the VTEX account. Used as part of the URL.
{{environment}} Environment to use. Used as part of the URL.
{{X-VTEX-API-AppKey}} Unique identifier of the API key.
{{X-VTEX-API-AppToken}} Secret token of the API key.

Endpoints

Bulk Import

SummaryMethodPath
Upload filePOST/api/b2b/import/buyer-orgs
Check progressGET/api/b2b/import/buyer-orgs/{importId}
Start importPOST/api/b2b/import/buyer-orgs/{importId}
Validate filePOST/api/b2b/import/buyer-orgs/validate/{importId}

Loading API specification...