This is a html view of the json schema please take the json schema as reference DOWNLOAD THE JSON SCHEMA

Account


This is object used to describe the account details

root allOf item 0
Type: object

If the conditions in the "If" tab are respected, then the conditions in the "Then" tab should be respected. Otherwise, the conditions in the "Else" tab should be respected.

root allOf item 0 if
Type: object

root allOf item 0 if isGuest
Type: const
Specific value: false

root allOf item 0 if roles
Type: array
No Additional Items

At least one of the items must be:

root allOf item 0 if roles contains
Type: const
Specific value: "BILL_TO"
root allOf item 0 then
Type: object

The following properties are required:

  • billingAddress
root allOf item 1
Type: object

If the conditions in the "If" tab are respected, then the conditions in the "Then" tab should be respected. Otherwise, the conditions in the "Else" tab should be respected.

root allOf item 1 if
Type: object

root allOf item 1 if isGuest
Type: const
Specific value: false

root allOf item 1 if roles
Type: array
No Additional Items

At least one of the items must be:

root allOf item 1 if roles contains
Type: const
Specific value: "SOLD_TO"
root allOf item 1 then
Type: object

The following properties are required:

  • deliveryAddress
  • defaultLogisticMethod
  • paymentMethods
root allOf item 2
Type: object

If the conditions in the "If" tab are respected, then the conditions in the "Then" tab should be respected. Otherwise, the conditions in the "Else" tab should be respected.

root allOf item 2 if
Type: object

root allOf item 2 if isGuest
Type: const
Specific value: true

root allOf item 2 if roles
Type: array
No Additional Items

At least one of the items must be:

root allOf item 2 if roles contains
Type: const
Specific value: "SOLD_TO"
root allOf item 2 then
Type: object

The following properties are required:

  • defaultLogisticMethod
  • paymentMethods

root eventHeader
Type: object Default: {"source": "OPCO", "version": "v1"}

This object is used to describe some technical meta information related to the event

root eventHeader source
Type: enum (of string)

The application source of this event

Must be one of:

  • "SPARK"
  • "SPARK_AX"
  • "OPCO"

root eventHeader version
Type: enum (of string)

The version of the json format event

Must be one of:

  • "v1"

root opCoAccountId
Type: string

OpCo's organizatinal customer number that uniquely identifies its account. In the case of OpCo organised with a regional model or commercial organisation this should be suffix by '{orgId}'. if the accountId is 13563 and the orgId is OVIA so this field should contains 13563OVIA
Examples:

"1234567"

"1234567_OVIA"

root accountType
Type: enum (of string)

this field allows to distinguish the different combinations possible within one account.

Must be one of:

  • "ACCOUNT"
  • "SUB_ACCOUNT"
  • "PROJECT"

Example:

"ACCOUNT"

root isGuest
Type: boolean Default: false

Boolean to indicate if the account is a guest account to support view of buy box for non logged in users / When value is true no users should be attached to this account, This account would not have a delivery or billing address, access token generated would not contain userID or email info and would never expire
Example:

true

root orgId
Type: string

Optional field, needed by OpCo organised with a regional model or commercial organisation. It can be used to filter or route based on the orgId.
Examples:

"org123"

"SNE"

root orgName
Type: string

Optional field, needed by OpCo organised with a regional model or commercial organisation. This name will be displayed to the customer into front to make him able to recognise the current commercial org
Examples:

"SONEPAR NORD-EST"

"Sonepar Sud Est"

root divisionId
Type: string

Regional division identifier
Example:

"RD1"

root companyRegistrationID
Type: string

registration ID of the company within its country, like siret number in France.
Example:

"12356894100056"

root commercialNumber
Type: string

VAT number
Example:

"GM4837192941"

root accountName
Type: string

Name of the organizational customer.
Example:

"Independent Electric"

root numberOfEmployees
Type: integer

[Deprecated - Moved to account-customer-relationship].
Number of employees in the company.
Example:

1234

root activationDate
Type: stringFormat: date-time

The date of activation of this account in the opco
Examples:

"2021-10-12T08:30:22.804Z"

"2018-11-13T20:20:39+02:00"

root onbehalfWithoutUser
Type: boolean

A generic user has all accesses to the opco. When true : An associate can access this account using the generic user. When false : An associate cannot access this account using the generic user. If not provided, the default configuration value on OpCo level will be used (feature flag on-behalf-without-user-default).
Example:

true

root withoutProductsExclusion
Type: boolean

true in the case the account doesn't have a products exclusion list. If this field is not present then the default value is false
Example:

true

root billingAddress

Address

Type: object

billing address applied to all users in the same account.

root billingAddress opCoAddressId
Type: string

OpCo internal system's unique identifier for the address
Example:

"237564557868778"

root billingAddress addressLine1
Type: string

According to ISO 19060, this field contains one third of the address. In most cases this usually contains the whole addres though.
Example:

"Belleboslaan 17"

root billingAddress addressLine2
Type: string

According to ISO 19060, this field contains one third of the address. This is an optional field.

root billingAddress addressLine3
Type: string

According to ISO 19060, this field contains one third of the address. This is an optional field.

root billingAddress city
Type: string

City.
Example:

"Montesson"

root billingAddress country
Type: string

The ISO 3166-1 alpha-3 of the country
Example:

"FRA"

root billingAddress postalCode
Type: string

Zip code.
Example:

"78360"

root billingAddress department
Type: string

department
Example:

"JURA"

root billingAddress region
Type: string

region
Example:

"Bretagne"

root deliveryAddress

root deliveryAddress allOf Address

Address

Type: object

A commun definition of an address

root deliveryAddress allOf Address opCoAddressId
Type: string

OpCo internal system's unique identifier for the address
Example:

"237564557868778"

root deliveryAddress allOf Address addressLine1
Type: string

According to ISO 19060, this field contains one third of the address. In most cases this usually contains the whole addres though.
Example:

"Belleboslaan 17"

root deliveryAddress allOf Address addressLine2
Type: string

According to ISO 19060, this field contains one third of the address. This is an optional field.

root deliveryAddress allOf Address addressLine3
Type: string

According to ISO 19060, this field contains one third of the address. This is an optional field.

root deliveryAddress allOf Address city
Type: string

City.
Example:

"Montesson"

root deliveryAddress allOf Address country
Type: string

The ISO 3166-1 alpha-3 of the country
Example:

"FRA"

root deliveryAddress allOf Address postalCode
Type: string

Zip code.
Example:

"78360"

root deliveryAddress allOf Address department
Type: string

department
Example:

"JURA"

root deliveryAddress allOf Address region
Type: string

region
Example:

"Bretagne"
root deliveryAddress allOf item 1
Type: object

root deliveryAddress allOf item 1 addressName
Type: string

Extra description about the address
Example:

"Building site #1"

root deliveryAddress allOf item 1 companyName
Type: string

Company name, it might differ from the account name
Example:

"Easy Electric"

root deliveryAddress allOf item 1 contactPhoneNumber
Type: string

Address contact's Phone number
Example:

"+330287345678"

root deliveryAddress allOf item 1 contactFirstName
Type: string

Contact's firstname.
Example:

"John"

root deliveryAddress allOf item 1 contactLastName
Type: string

Contact's lastname.
Example:

"Doe"

root deliveryAddress allOf item 1 contactMiddleName
Type: string

In Pilot Contact's middle name.
Example:

"Michael"

root deliveryAddress allOf item 1 editable
Type: boolean

Determines whether addessLine1, addessLine2, zipCode, city and country fields are editable or not
Example:

false

root deliveryAddress allOf item 1 default
Type: boolean Default: false

a boolean to say if this address is the default one or not
Example:

false

root deliveryAddress allOf item 1 deliveryIndication
Type: string

Optional indications or instructions about the delivery
Example:

"Please leave the parcel next the front door."

root deliveryAddress allOf item 1 customerReference
Type: string

Optional reference about the customer delivery
Example:

"Reference #123"

root defaultFacilityId
Type: string

The default facility id while registering the account to an opco. If the feature flag - Enable Preferred branch - is enabled, pass preferred branch here. Otherwise use account-customer-relationship data model to pass Service Center/Preferred branch, because then a single branch is serving both roles.
Example:

"4335"

root defaultLogisticMethod
Type: enum (of string)

the default logistic method while registering the account to an opco

Must be one of:

  • "PICK_UP"
  • "DELIVERY"

root defaultPaymentMethod
Type: object

the default payment method while registering the account to an opco

root defaultPaymentMethod paymentCurrency
Type: string

The currency denomination define by ISO 4217
Example:

"EUR"

root defaultPaymentMethod paymentType
Type: enum (of string)

Type of payment

Must be one of:

  • "CASH"
  • "CHEQUE"
  • "CREDIT_LINE"
  • "CREDIT_DEBIT_CARD"
  • "PCB_CARD"

Example:

"CREDIT_DEBIT_CARD"

root defaultPaymentMethod paymentChannel
Type: enum (of string) Default: "ONLINE"

The payment channel

Must be one of:

  • "ONLINE"
  • "OFFLINE"

root opCoAccountStatus
Type: enum (of string)

organisation account status with opco.
- OFFLINE: DEPRECATED if account is conducting business whether it's online or offline, ACTIVE status should be used
- ACTIVE: An account that is conducting business or will conduct business with Sonepar.
- PENDING: Not used yet when the account activation is pending.
- CLOSED: A status used to close the account.
- BLOCKED: Not used yet when the account is temporary disabled for example because of credit limit issue or security issue.
- DELETED: DEPRECATED use CLOSED status instead.

Must be one of:

  • "OFFLINE"
  • "ACTIVE"
  • "PENDING"
  • "CLOSED"
  • "DELETED"
  • "BLOCKED"

Example:

"ACTIVE"

root paymentMethods
Type: array

List of payment methods

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

root paymentMethods PaymentMethod
Type: object

Model used to create a payment method

root paymentMethods paymentMethods items paymentCurrency
Type: string

The currency denomination define by ISO 4217
Example:

"EUR"

root paymentMethods paymentMethods items paymentType
Type: enum (of string)

Type of payment

Must be one of:

  • "CASH"
  • "CHEQUE"
  • "CREDIT_LINE"
  • "CREDIT_DEBIT_CARD"
  • "PCB_CARD"

Example:

"CREDIT_DEBIT_CARD"

root paymentMethods paymentMethods items paymentChannel
Type: enum (of string) Default: "ONLINE"

The payment channel

Must be one of:

  • "ONLINE"
  • "OFFLINE"

Example:

[
    {
        "paymentCurrency": "EUR",
        "paymentType": "CREDIT_LINE"
    }
]

root paymentTerms
Type: string

Payment terms associated with the account. Example when invoices should be paid.
Examples:

"End of month + 15d"

"End of month + 30d"

"Invoice date +45d"

root salesRepresentative
Type: object

[Deprecated - Moved to account-customer-relationship].
The sale representative of the account

root salesRepresentative firstname
Type: string

firstname of the sale representative
Example:

"John"

root salesRepresentative lastname
Type: string

lastname of the sale representative
Example:

"Doe"

root salesRepresentative phoneNumber
Type: string

phone number of the sale representative
Example:

"0683906389"

root salesRepresentative email
Type: string

email of the sale representative
Example:

"john.doe@standelec.com"

root endMarketSegmentation
Type: array

[Deprecated - Moved to account-customer-relationship].
An array containing the different level of the segment where the accounts is attached (installers, medium or large scale). The first element of the arrays is the first level

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

root endMarketSegmentation EndMarketSegmentLevel
Type: object

root endMarketSegmentation endMarketSegmentation items code
Type: string

the code of this segment level

root endMarketSegmentation endMarketSegmentation items label

Multilingual Object

Type: object

the label of this segment level
Example:

{
    "fr-FR": "Installateur résidentiel et commercial - petit",
    "en-US": "Residential & Commercial Installer - Small"
}

Each additional property must conform to the following schema

root endMarketSegmentation endMarketSegmentation items label additionalProperties
Type: string

Examples:

[
    {
        "code": "111-1",
        "label": {
            "fr-FR": "Installateur résidentiel et commercial",
            "en-US": "Residential & Commercial Installer"
        }
    },
    {
        "code": "1be9366881063c8e18457f29b5e1f0db",
        "label": {
            "fr-FR": "Petit",
            "en-US": "Small"
        }
    }
]

[
    {
        "code": "b8f28358d902f28449103518a2464ec2",
        "label": {
            "fr-FR": "Entrepreneurs généraux, Constructeurs, Ingénierie et construction",
            "en-US": "General Contractors, Builders, Engineering & Construction"
        }
    }
]

root purchaseGroup
Type: object

[Deprecated - Moved to account-customer-relationship].

root purchaseGroup id
Type: string

id of the purchase group
Example:

"1234"

root purchaseGroup name
Type: string

name of the purchase group to be displayed
Example:

"Doe"

root accountParentId
Type: string

A reference to parent's account opCoAccountId field. This is used to represent the hierarchy of accounts.

Parent accounts must be sent first. Otherwise, references between parent and children will not be established
Examples:

"1234567"

"1234567_OVIA"

root roles
Type: array of enum (of string) Default: ["BILL_TO", "SOLD_TO"]

In the hierarchy of accounts, an account can have none, one, or both of the following roles: BILLTO, SOLDTO

Must contain a minimum of 0 items

No Additional Items

Each item of this array must be:

root roles roles items
Type: enum (of string)

Must be one of:

  • "BILL_TO"
  • "SOLD_TO"

Examples:

[
    "BILL_TO"
]

[
    "BILL_TO",
    "SOLD_TO"
]

[
    "SOLD_TO"
]

[]

root hideCustomerCreditLine
Type: boolean Default: false

Flag to hide the credit limit to customers in CX. When true, the CREDITLINEVIEW permission will be ignored in Spark CX and credit line will not be displayed to users for this account. Otherwise, CREDITLINEVIEW permission will work as specified.
Example:

true

root isMarketplaceEnabled
Type: boolean Default: true

Flag controling if marketplace is enabled at an account level. By default (if this account attribute is not set and the cp-marketplace feature flag is set then) marketplace is enabled.

root deliveryInstructions
Type: string

In Pilot: Account level delivery instructions

Must be at least 1 characters long


Example:

"YYNNYY"

root defaultLocale
Type: string

In Pilot: Locale code representing the preferred language at an account level. This must match the code defined in the AX language map record

Must match regular expression: ^[a-z]{2}(-[A-Z]{2})?$

Must be at least 2 characters long


Examples:

"en-GB"

"en-US"

root ignoreOpenCatalogProducts
Type: boolean Default: false

Flag defining whether or not open catalog products are available by default to this account. When true, open catalog products are ignored (and need to be explicitly included). When false (default), open catalog products are available by default (but can be individually excluded). The deprecated static configuration inclusion-active-account-list is still taken into account if this attribute is false, but only on search results and not in other areas (i.e. PDP, suggestions).
Example:

true