commerce/customer/b2baccounts
The B2B feature includes the primary shared B2B account and a set of user account logins that have access to that primary account. This primary account has its own identifying data and customer attributes, as well as the list of users associated with it. These attributes and users can be managed through other operations of the B2B APIs.
JSON Example
B2BAccount Properties
Property | Description |
---|---|
accountType |
type: string The type of the B2B account. |
attributes |
type: list of customerAttribute Collection of attributes that may be paged list or a list, depending on the usage per object and API type. |
customerAttribute |
type: int Unique identifier of the attribute definition. |
customerAttribute |
type: string Fully qualified name of the attribute for the order or customer. |
customerAttribute |
type: list of object List of value data for objects. |
companyOrOrganization |
type: string The company or organization name entered for a customer account. |
customerSet |
type: string The details of the customer set. |
customerSinceDate |
type: DateTime This property tracks the B2B customer account creation date. |
externalId |
type: string Unique identifier used by an external program to identify a Kibo eCommerce order, customer account, or wish list. |
isActive |
type: bool Indicates if the object or feature is active. |
priceList |
type: string The details of the price list. |
taxExempt |
type: bool If true, this account has tax exempt status. |
taxId |
type: string The tax identification number associated with the account. |
users |
type: list of b2BUser A list of users associated to the B2B account. On initial B2B account creation, one user is required and will be set up as the admin customer. |
b2BUser |
type: bool Indicates if the customer account is opted to receive marketing materials. If true, the customer account is opted in for receiving the content. |
b2BUser |
type: string The email address for the customer account and contact. This email may be used for login to the storefront and for subscription mailing lists. |
b2BUser |
type: string The full first name of a customer or contact name. |
b2BUser |
type: bool Indicates if an external password is set on this account. |
b2BUser |
type: bool Indicates if the object or feature is active. |
b2BUser |
type: bool Indicates if a customer account and associated data is locked. If true, the user account is locked due to multiple failed authentication attempts. The user cannot login until the account is unlocked. |
b2BUser |
type: bool Indicates whether the customer has been removed or not from the available users list. |
b2BUser |
type: string The full last name of a customer or contact name. |
b2BUser |
type: string The two character locale code, per the country code provided. This code determines the localized content to use and display. |
b2BUser |
type: string Unique identifier of the customer account (shopper or system user). System-supplied and read-only. If the shopper user is anonymous, the user ID represents a system-generated user ID string. |
b2BUser |
type: string The user name associated with the user profile. The customer uses the user name to access the account. |
Operations
Operation Name | Request URI | Description |
---|---|---|
AddB2BAccount | POST %3fresponseFields%3d%7bresponseFields%7d |
Create a B2B account that will be shared by multiple users. This API requires one user upon account creation, which will be set as the admin shopper. Adding additional users after that is handled by the AddUser call. |
AddB2BAccountAttribute | POST %7baccountId%7d%2fattributes%3fresponseFields%3d%7bresponseFields%7d |
Add an account attribute to a B2B account in order to configure the display options and other user group-specific details. |
AddUser | POST %7baccountId%7d%2fuser%3fresponseFields%3d%7bresponseFields%7d |
Add an individual login account to the list of users that can access a shared B2B account. |
AddUserRoleAsync | POST %7baccountId%7d%2fuser%2f%7buserId%7d%2froles%2f%7broleId%7d |
Add a user role to a B2B customer account. |
DeleteB2BAccountAttribute | DELETE %7baccountId%7d%2fattributes%2f%7battributeFQN%7d |
Remove an attribute from a B2B customer account. |
GetB2BAccount | GET %7baccountId%7d%3fresponseFields%3d%7bresponseFields%7d |
Retrieve all of the customer account information for a B2B account. |
GetB2BAccountAttribute | GET %7baccountId%7d%2fattributes%2f%7battributeFQN%7d%3fresponseFields%3d%7bresponseFields%7d |
Retrieve attribute information for B2B customer accounts. |
GetB2BAccountAttributes | GET %7baccountId%7d%2fattributes%3fstartIndex%3d%7bstartIndex%7d%26pageSize%3d%7bpageSize%7d%26sortBy%3d%7bsortBy%7d%26filter%3d%7bfilter%7d%26responseFields%3d%7bresponseFields%7d |
Retrieve attribute information for B2B customer accounts. |
GetB2BAccounts | GET %3fstartIndex%3d%7bstartIndex%7d%26pageSize%3d%7bpageSize%7d%26sortBy%3d%7bsortBy%7d%26filter%3d%7bfilter%7d%26fields%3d%7bfields%7d%26q%3d%7bq%7d%26qLimit%3d%7bqLimit%7d%26responseFields%3d%7bresponseFields%7d |
Retrieve all the customer account information for a B2B account. |
GetUserRolesAsync | GET %7baccountId%7d%2fuser%2f%7buserId%7d%2froles%3fresponseFields%3d%7bresponseFields%7d |
Retrieve the user role information of customers on a B2B account. These roles include Admin, Purchaser, and Non-Purchaser. |
GetUsers | GET %7baccountId%7d%2fusers%3fstartIndex%3d%7bstartIndex%7d%26pageSize%3d%7bpageSize%7d%26sortBy%3d%7bsortBy%7d%26filter%3d%7bfilter%7d%26q%3d%7bq%7d%26qLimit%3d%7bqLimit%7d%26responseFields%3d%7bresponseFields%7d |
Retrieve the information of users on a B2B customer account. |
RemoveUser | PUT %7baccountId%7d%2fuser%2f%7buserId%7d%2fremove |
Remove a user login from the list of available users that can access a shared B2B account. |
RemoveUserRoleAsync | DELETE %7baccountId%7d%2fuser%2f%7buserId%7d%2froles%2f%7broleId%7d |
Remove a role from a user associated with a B2B account. For instance, remove the admin role from a user that is no longer an admin, or remove the purchasing permissions from a user that should no longer be allowed to place orders. |
UpdateB2BAccount | PUT %7baccountId%7d%3fresponseFields%3d%7bresponseFields%7d |
Make changes to the overall information for a shared B2B account. |
UpdateB2BAccountAttribute | PUT %7baccountId%7d%2fattributes%2f%7battributeFQN%7d%3fresponseFields%3d%7bresponseFields%7d |
Make changes specifically to the attributes associated to a B2B account. |
UpdateUser | PUT %7baccountId%7d%2fuser%2f%7buserId%7d%3fresponseFields%3d%7bresponseFields%7d |
Make changes to the user-level information of a login associated with a shared B2B account. |