Business units GraphQL

Served by BusinessUnitModule on commercetools, BusinessUnitModule on medusa and BusinessUnitModule on sfcc.

Each operation has its own page with its arguments, an example and the engines that serve it. The types link to their fields on the business units types page.

Operations

Operation	Description	Served by
`businessUnit`Query	Get a specific business unit by ID	commercetoolsmedusasfcc
`businessUnits`Query	Get all business units accessible to the current user	commercetoolsmedusasfcc
`businessUnitAddressCreate`Mutation	Add a new address to a business unit	commercetoolsmedusasfcc
`businessUnitAddressDelete`Mutation	Remove an address from a business unit	commercetoolsmedusasfcc
`businessUnitAddressUpdate`Mutation	Update an existing address in a business unit	commercetoolsmedusasfcc
`businessUnitAssociateActivate`Mutation	Activate a previously deactivated associate, restoring their ability to act within the business unit.	commercetoolsmedusasfcc
`businessUnitAssociateDeactivate`Mutation	Deactivate an associate so they can no longer act within the business unit.	commercetoolsmedusasfcc
`businessUnitAssociateInvite`Mutation	Invite a new associate to the business unit with specified roles	commercetoolsmedusasfcc
`businessUnitAssociateRemove`Mutation	Remove an associate from the business unit	commercetoolsmedusasfcc
`businessUnitAssociateRolesUpdate`Mutation	Update associate roles for an existing associate in the business unit Note: All current roles will be replaced with the provided roles	commercetoolsmedusasfcc
`businessUnitDefaultAddressUpdate`Mutation	Set the business unit's default shipping and/or billing address by referencing an existing address in its address book.	commercetoolsmedusasfcc
`businessUnitSwitch`Mutation	Set the active business context for B2B operations	commercetoolsmedusasfcc

Types

Type	Description
`BusinessUnit`Object
`BusinessUnitAddressCreateError`Union
`BusinessUnitAddressCreateResponse`Object
`BusinessUnitAddressDeleteError`Union
`BusinessUnitAddressDeleteResponse`Object
`BusinessUnitAddressUpdateError`Union
`BusinessUnitAddressUpdateResponse`Object
`BusinessUnitAssociate`Object	Customer associated with a business unit, including their assigned roles
`BusinessUnitAssociateInviteError`Union
`BusinessUnitAssociateInviteResponse`Object
`BusinessUnitAssociateRemoveError`Union
`BusinessUnitAssociateRemoveResponse`Object
`BusinessUnitAssociateResult`Object	Paginated result containing business unit associates
`BusinessUnitAssociateRolesUpdateError`Union
`BusinessUnitAssociateRolesUpdateResponse`Object
`BusinessUnitAssociateStatusType`Enum	Whether an associate is active or has been deactivated within a unit
`BusinessUnitAssociateStatusUpdateError`Union
`BusinessUnitAssociateStatusUpdateResponse`Object
`BusinessUnitCapabilityType`Enum	Normalized, engine-agnostic capabilities a role grants within a business unit.
`BusinessUnitCredit`Object	A company's credit on account, in the currency of its limit.
`BusinessUnitDefaultAddressUpdateError`Union
`BusinessUnitDefaultAddressUpdateResponse`Object
`BusinessUnitError`Object	A change to a business unit the caller may not make.
`BusinessUnitErrorCodeType`Enum	Why a change to a business unit was refused.
`BusinessUnitInvitation`Object	An invitation to someone who has yet to set up their account.
`BusinessUnitInvitationResult`Object	Paginated result containing a business unit's pending invitations
`BusinessUnitPaymentTerms`Object	When a company pays for what it buys on account.
`BusinessUnitRole`Object	Roles that can be assigned to customers in a business unit