Entities

Organization

Trade-party entity for brands, manufacturers, vendors, suppliers, and distributors

An Organization represents a trade party such as a buyer company, brand, manufacturer, vendor, supplier, or distributor. Its role identifies its purpose without splitting these concepts into separate entities.

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

Components

Base

OrganizationBase

base

Identity, role, slug, source-system identifiers, and custom fields.

Schema

name

stringrequired

Display name of the organization/brand.

role

string

slug

string

Slug for the organization's/brand's page URL.

code

string

Human/ERP code distinct from the internal id.

externalId

string

Identifier of this organization in the source system it was imported from.

customFields

Record<string, unknown>

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

Info

OrganizationInfo

info

Lightweight logo and summary fields for cards and headers.

Schema

logo

MediaImage { type, sources, alt, 2 more }

shortDescription

string

Short plain-text description. Not HTML — see OrganizationContent.

Content

OrganizationContent

content

Rich detail-page content.

Schema

description

HtmlFragment { html }required

Contact

OrganizationContact

contact

Phone, fax, email, and website contact channels.

Schema

phone

string

Represents a phone number. Formatted as a E.164 number.

pattern^\+?[1-9]\d{1,14}$

fax

string

Represents a phone number. Formatted as a E.164 number.

pattern^\+?[1-9]\d{1,14}$

string

formatemail

website

string

formaturi

Address

OrganizationAddress

address

Registered or head-office postal address.

Schema

address

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

Legal

OrganizationLegal

legal

Legal name, tax and registration identifiers, country, and registration date.

Schema

legalName

string

Registered legal name, when it differs from the display name.

vatId

string

VAT identification number.

taxId

string

Generic tax identifier (Emporix taxRegistrationNumber).

registrationNumber

string

Commercial-register / company registration number.

gln

string

GS1 Global Location Number (B2B/EDI).

countryOfRegistration

string

Country of registration, ISO 3166-1 alpha-2.

registrationDate

string

formatdate

Links

An organization can resolve its employees, locations, products, cost centers, budgets, and approval rules through canonical B2B links.

Edit this pageorReport an issue

Product List Item

A product membership and list-specific annotation in a saved product list

Employee

A person acting within a B2B organization