Organization Units API

The Organization Units API enables you to manage B2B functionalities in your VTEX store, focusing on users and organization units. This API provides endpoints for managing users, organization units, and their associated scopes.

This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts.

Index

Users

• GET Get user scopes: Retrieves the scopes assigned to a user.
• GET Get user's organization unit: Retrieves the organization unit associated with a specific user.

Organization Units

• POST Create organization unit: Creates a new organization unit at the root level of the organizational hierarchy.
• GET Search organization units: Searches for organization units based on query parameters, with pagination support.
• GET Get organization unit: Retrieves details of a specific organization unit by its unique identifier.
• DELETE Delete organization unit: Deletes an organization unit.
• PATCH Rename organization unit: Updates the name of an existing organization unit.
• GET Get all children organization units: Retrieves child organization units.
• GET Get root organization units: Retrieves all root-level organization units.
• PUT Move organization unit: Moves an organization unit to a different parent.
• POST Add user to organization unit: Adds a user to an organization unit.
• DELETE Remove users from organization unit: Removes a user from an organization unit.
• GET List users from organization unit: Lists users in an organization unit.
• GET Find all organization units with scope value: Retrieves all organization units that have a specific scope value.

Scopes

• GET Get organization unit scopes: Retrieves all scopes for an organization unit.
• DELETE Delete all scopes: Removes all scopes from an organization unit.
• POST Create organization unit scope: Creates a new scope for an organization unit.
• PUT Update organization unit scope: Updates an existing scope.
• DELETE Delete organization unit scope: Deletes a specific scope.
• DELETE Remove values from organization unit scope: Removes specific values from a scope.

Common parameters

Parameter name	Description	Type
accountName	Name of the VTEX account. Used as part of the URL.	Server variable.
environment	Environment to use. Used as part of the URL.	Server variable.
VtexIdclientAutCookie	User token, valid for 24 hours.	Authentication header.