B2b

Actions

Canonical actions for B2B organization accounts, quotes, approvals, and cart sharing

Canonical B2B actions define account and workflow mutations shared by connector apps. Import them from @laioutr-core/canonical-types/b2b.

Available since v0.26.0 in @laioutr-core/canonical-types

Organization context

OrganizationGetMembershipsAction

b2b/organization/get-memberships

Input

Output

organizations

{ id, name, businessUnitName, 1 more }[]required

Throwables

UnauthenticatedError

OrganizationSwitchAction

b2b/organization/switch

Input

organizationId

stringrequired

The ID of the organization to switch to.

Output

unknown

Throwables

UnauthenticatedError OrganizationNotFoundError

OrganizationSetLoginPreferencesAction

b2b/organization/set-login-preferences

Input

defaultOrganizationId

string | null

The organization to enter on login. null means the customer is asked to choose on every login. Omit to leave unchanged.

loginTarget

string

Portal page to land on after login (open coded set, e.g. standard, dashboard, order-overview). Omit to leave unchanged.

Output

unknown

Throwables

UnauthenticatedError OrganizationNotFoundError

Employees

OrganizationEmployeeInviteAction

b2b/organization/employee-invite

Input

stringrequired

formatemail

person

{ firstName, lastName, salutation, 1 more }

jobTitle

string

The employee's job title (EmployeeBase.jobTitle).

roleIds

string[]

IDs of the roles to assign.

customFields

Record<string, unknown>

Custom fields are a way for implementations to pass arbitrary data to actions, queries, etc.

Output

stringrequired

The ID of the created employee.

Throwables

UnauthenticatedError InvalidFieldError NoOrganizationContextError PermissionDeniedError EmployeeAlreadyExistsError

OrganizationEmployeeUpdateAction

b2b/organization/employee-update

Input

employeeId

stringrequired

person

{ firstName, lastName, salutation, 1 more }

jobTitle

string

The employee's job title (EmployeeBase.jobTitle).

roleIds

string[]

IDs of the roles to assign, replacing the current assignment.

status

"active" | "inactive"

customFields

Record<string, unknown>

Custom fields are a way for implementations to pass arbitrary data to actions, queries, etc.

Output

unknown

Throwables

UnauthenticatedError InvalidFieldError NoOrganizationContextError PermissionDeniedError EmployeeNotFoundError

OrganizationEmployeeDeleteAction

b2b/organization/employee-delete

Input

employeeId

stringrequired

Output

unknown

Throwables

UnauthenticatedError NoOrganizationContextError PermissionDeniedError EmployeeNotFoundError EmployeeNotDeletableError

Roles

OrganizationRoleGetAllAction

b2b/organization/role-get-all

Input

Output

roles

{ id, name, scope, 2 more }[]required

Throwables

UnauthenticatedError NoOrganizationContextError PermissionDeniedError

OrganizationRoleCreateAction

b2b/organization/role-create

Input

name

stringrequired

permissions

string[]required

Permission codes to grant (open coded set, seeded with the Shopware Commercial vocabulary).

Output

stringrequired

The ID of the created role.

Throwables

UnauthenticatedError InvalidFieldError NoOrganizationContextError PermissionDeniedError

OrganizationRoleUpdateAction

b2b/organization/role-update

Input

roleId

stringrequired

name

string

permissions

string[]

Permission codes, replacing the current set.

Output

unknown

Throwables

UnauthenticatedError NoOrganizationContextError PermissionDeniedError RoleNotFoundError RoleNotModifiableError

OrganizationRoleDeleteAction

b2b/organization/role-delete

Input

roleId

stringrequired

Output

unknown

Throwables

UnauthenticatedError NoOrganizationContextError PermissionDeniedError RoleNotFoundError RoleNotModifiableError

Organization addresses

OrganizationAddressGetAllAction

b2b/organization/address-get-all

Input

Output

addresses

{ id, address, isDefaultBilling, 2 more }[]required

Throwables

UnauthenticatedError NoOrganizationContextError PermissionDeniedError

OrganizationAddressCreateAction

b2b/organization/address-create

Input

address

MailingAddress { address1, address2, city, 10 more }required

Output

unknown

Throwables

UnauthenticatedError InvalidFieldError NoOrganizationContextError PermissionDeniedError

OrganizationAddressUpdateAction

b2b/organization/address-update

Input

stringrequired

The ID of the address to update.

address

{ address1, address2, city, 10 more }required

Output

unknown

Throwables

UnauthenticatedError InvalidFieldError NoOrganizationContextError PermissionDeniedError OrganizationAddressNotFoundError

OrganizationAddressDeleteAction

b2b/organization/address-delete

Input

stringrequired

The ID of the address to delete.

Output

unknown

Throwables

UnauthenticatedError NoOrganizationContextError PermissionDeniedError OrganizationAddressNotFoundError

OrganizationAddressSetDefaultAction

b2b/organization/address-set-default

Input

stringrequired

The ID of the address to set as default.

type

"shipping" | "billing"required

The type of default to set. Not all backends may support this distinction.

Output

unknown

Throwables

UnauthenticatedError NoOrganizationContextError PermissionDeniedError OrganizationAddressNotFoundError

Cost centers

OrganizationCostCenterCreateAction

b2b/organization/cost-center-create

Input

name

stringrequired

description

string

Free-text description (CostCenterInfo.description).

status

"active" | "inactive"

The status value set — shared with the b2b/organization/cost-center-* actions so the vocabulary has a single source.

Output

stringrequired

The ID of the created cost center.

Throwables

UnauthenticatedError InvalidFieldError NoOrganizationContextError PermissionDeniedError

OrganizationCostCenterUpdateAction

b2b/organization/cost-center-update

Input

costCenterId

stringrequired

name

string

description

string

Free-text description (CostCenterInfo.description).

status

"active" | "inactive"

The status value set — shared with the b2b/organization/cost-center-* actions so the vocabulary has a single source.

Output

unknown

Throwables

UnauthenticatedError InvalidFieldError NoOrganizationContextError PermissionDeniedError CostCenterNotFoundError

OrganizationCostCenterDeleteAction

b2b/organization/cost-center-delete

Input

costCenterId

stringrequired

Output

unknown

Throwables

UnauthenticatedError NoOrganizationContextError PermissionDeniedError CostCenterNotFoundError

Budgets

OrganizationBudgetCreateAction

b2b/organization/budget-create

Input

name

stringrequired

period

stringrequired

limit

Money { amount, currency }required

status

"active" | "inactive"

The status value set — shared with the b2b/organization/budget-* actions so the vocabulary has a single source.

description

string

Free-text description (BudgetInfo.description).

approverEmployeeId

string

notificationThreshold

number

Consumption percentage at which a notification is sent (BudgetAllowance.notificationThreshold).

min0max100

Output

stringrequired

The ID of the created budget.

Throwables

UnauthenticatedError InvalidFieldError NoOrganizationContextError PermissionDeniedError

OrganizationBudgetUpdateAction

b2b/organization/budget-update

Input

budgetId

stringrequired

name

string

period

string

limit

Money { amount, currency }

status

"active" | "inactive"

The status value set — shared with the b2b/organization/budget-* actions so the vocabulary has a single source.

description

string

Free-text description (BudgetInfo.description).

approverEmployeeId

string

notificationThreshold

number

Consumption percentage at which a notification is sent (BudgetAllowance.notificationThreshold).

min0max100

Output

unknown

Throwables

UnauthenticatedError InvalidFieldError NoOrganizationContextError PermissionDeniedError BudgetNotFoundError

OrganizationBudgetDeleteAction

b2b/organization/budget-delete

Input

budgetId

stringrequired

Output

unknown

Throwables

UnauthenticatedError NoOrganizationContextError PermissionDeniedError BudgetNotFoundError

Customer product numbers

OrganizationProductNumberGetAllAction

b2b/organization/product-number-get-all

Input

Output

productNumbers

{ productId, variantId, productNumber, 3 more }[]required

Throwables

UnauthenticatedError NoOrganizationContextError PermissionDeniedError

OrganizationProductNumberSetAction

b2b/organization/product-number-set

Input

productId

string

variantId

stringrequired

The variant the reference is for — the natural key of the mapping.

number

stringrequired

The customer's own product number for this variant (ProductVariantCustomerReference.number; SAP KDMAT).

name

string

The customer's own name for this product, where supported (ProductVariantCustomerReference.name; SAP POSTX).

Output

unknown

Throwables

UnauthenticatedError ProductNotFoundError InvalidFieldError NoOrganizationContextError PermissionDeniedError

OrganizationProductNumberDeleteAction

b2b/organization/product-number-delete

Input

variantId

stringrequired

The variant whose customer product number is removed — the natural key of the mapping.

Output

unknown

Throwables

UnauthenticatedError NoOrganizationContextError PermissionDeniedError ProductNumberNotFoundError

Quotes

QuoteRequestAction

b2b/quote/request

Input

comment

string

Free-text message from the buyer accompanying the request.

purchaseOrderNumber

string

The buyer's purchase order number for this quote.

Output

stringrequired

The ID of the created quote (request).

status

stringrequired

statusLabel

string

Connector-resolved display label for the status.

Throwables

UnauthenticatedError EmptyCartError

QuoteAcceptAction

b2b/quote/accept

Input

quoteId

stringrequired

The ID of the quote to accept.

Output

unknown

Throwables

UnauthenticatedError QuoteNotFoundError QuoteStateError QuoteExpiredError

QuoteDeclineAction

b2b/quote/decline

Input

quoteId

stringrequired

The ID of the quote to decline.

comment

string

Free-text reason for declining.

Output

unknown

Throwables

UnauthenticatedError QuoteNotFoundError QuoteStateError

QuoteRequestChangeAction

b2b/quote/request-change

Input

quoteId

stringrequired

The ID of the quote to renegotiate.

comment

string

Free-text description of the requested change.

Output

unknown

Throwables

UnauthenticatedError QuoteNotFoundError QuoteStateError

QuoteCancelAction

b2b/quote/cancel

Input

quoteId

stringrequired

The ID of the quote request to withdraw.

comment

string

Free-text reason for withdrawing.

Output

unknown

Throwables

UnauthenticatedError QuoteNotFoundError QuoteStateError

QuoteGetCheckoutUrlAction

b2b/quote/get-checkout-url

Input

quoteId

stringrequired

The ID of the (accepted) quote to check out.

Output

checkoutUrl

stringrequired

Throwables

UnauthenticatedError QuoteNotFoundError QuoteStateError

Approval flows

ApprovalFlowDecideAction

b2b/approval-flow/decide

Input

approvalId

stringrequired

decision

"approve" | "reject"required

comment

string

Free-text note by the approver.

Output

unknown

Throwables

UnauthenticatedError NoOrganizationContextError PermissionDeniedError ApprovalNotFoundError ApprovalStateError

CartShareSetAction

b2b/cart/share-set

Input

cartId

string

The cart to share. Absent ⇒ the current session's active cart.

employeeId

stringrequired

The employee to share the cart with — the natural key of the grant.

permission

stringrequired

Output

unknown

Throwables

UnauthenticatedError InvalidFieldError NoOrganizationContextError PermissionDeniedError EmployeeNotFoundError

CartShareGetAllAction

b2b/cart/share-get-all

Input

cartId

string

The cart to inspect. Absent ⇒ the current session's active cart.

Output

{ employeeId, employeeLabel, permission, 1 more }[]required

Throwables

UnauthenticatedError NoOrganizationContextError PermissionDeniedError

CartShareDeleteAction

b2b/cart/share-delete

Input

cartId

string

The cart the share is on. Absent ⇒ the current session's active cart.

employeeId

stringrequired

The employee whose share is revoked — the natural key of the grant.

Output

unknown

Throwables

UnauthenticatedError NoOrganizationContextError PermissionDeniedError CartShareNotFoundError

Edit this pageorReport an issue

Queries

Queries available for implementation in location connector apps

Errors

Canonical errors for B2B organization, quote, approval, and cart-sharing operations