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

Address

Type: object

This is object used to describe account addresses details

root opCoAccountId
Type: string

OpCo's organizatinal customer number that uniquely identifies its account.
Example:

"1234567"

root billingAddress

Base 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 Base Address

Base Address

Type: object

A common definition of an address

root deliveryAddress allOf Base Address opCoAddressId
Type: string

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

"237564557868778"

root deliveryAddress allOf Base 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 Base Address addressLine2
Type: string

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

root deliveryAddress allOf Base Address addressLine3
Type: string

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

root deliveryAddress allOf Base Address city
Type: string

City.
Example:

"Montesson"

root deliveryAddress allOf Base Address country
Type: string

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

"FRA"

root deliveryAddress allOf Base Address postalCode
Type: string

Zip code.
Example:

"78360"

root deliveryAddress allOf Base Address department
Type: string

department
Example:

"JURA"

root deliveryAddress allOf Base Address region
Type: string

region
Example:

"Bretagne"
root deliveryAddress allOf DeliveryAddressExtension

DeliveryAddressExtension

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 deliveryAddress allOf DeliveryAddressExtension if
Type: object

root deliveryAddress allOf DeliveryAddressExtension then
Type: object

root deliveryAddress allOf DeliveryAddressExtension then eventHeader
Type: object

The following properties are required:

  • requestType

root deliveryAddress allOf DeliveryAddressExtension eventHeader
Type: object

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

root deliveryAddress allOf DeliveryAddressExtension eventHeader source
Type: enum (of string)

The application source of this event

Must be one of:

  • "SPARK"
  • "OPCO"

root deliveryAddress allOf DeliveryAddressExtension eventHeader version
Type: enum (of string)

The version of the json format event

Must be one of:

  • "v1"

root deliveryAddress allOf DeliveryAddressExtension eventHeader requestType
Type: enum (of string)

The type of the request

Must be one of:

  • "CREATION_REQUEST"
  • "UPDATE_REQUEST"
  • "DELETION_REQUEST"

root deliveryAddress allOf DeliveryAddressExtension addressName
Type: string

Extra description about the address
Example:

"Building site #1"

root deliveryAddress allOf DeliveryAddressExtension sparkAddressId
Type: string

The address identifier from Spark system
Example:

"50169486938114"

root deliveryAddress allOf DeliveryAddressExtension companyName
Type: string

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

"Easy Electric"

root deliveryAddress allOf DeliveryAddressExtension contactPhoneNumber
Type: string

Address contact's Phone number
Example:

"+330287345678"

root deliveryAddress allOf DeliveryAddressExtension contactFirstName
Type: string

Contact's firstname.
Example:

"John"

root deliveryAddress allOf DeliveryAddressExtension contactLastName
Type: string

Contact's lastname.
Example:

"Doe"

root deliveryAddress allOf DeliveryAddressExtension editable
Type: boolean Default: true

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

false

root deliveryAddress allOf DeliveryAddressExtension deliveryIndication
Type: string

Optional indications or instructions about the delivery
Example:

"Please leave the parcel next the front door."

root deliveryAddress allOf DeliveryAddressExtension customerReference
Type: string

Optional reference about the customer delivery
Example:

"Reference #123"

root deliveryAddress allOf DeliveryAddressExtension default
Type: boolean Default: false

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

false

root deliveryAddress allOf DeliveryAddressExtension isActive
Type: boolean Default: true

a boolean to say if the address is active and could be used as a delivery address for an order (e.g. if the address is not active, it means that the address is in validation on opcos side)
Example:

false

root deliveryAddress allOf DeliveryAddressExtension isDeleted
Type: boolean Default: false

a boolean to say if the address is to be deleted. Only used in events coming from OpCo. When deleted is set to true, address will be deleted from Spark system
Example:

false

Example:

{
    "eventHeader": {
        "source": "SPARK",
        "version": "v1",
        "requestType": "CREATION_REQUEST"
    },
    "isActive": false,
    "isDeleted": false,
    "addressName": "Building site #1",
    "companyName": "Easy Electric",
    "opCoAddressId": "12345654",
    "addressLine1": "Belleboslaan 17",
    "city": "Ajaccio",
    "country": "FRA",
    "postalCode": "20090",
    "department": "Corse",
    "region": "Corse"
}