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

Facility


a facility is a place, building, piece of equipment etc. with a particular purpose. It can be a Branch, CDC, LOCAL, NATIONAL LOCKER...

root allOf logisticMethods required for LOGISTIC capability

logisticMethods required for LOGISTIC capability

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 logisticMethods required for LOGISTIC capability if
Type: object

root allOf logisticMethods required for LOGISTIC capability if capabilities
Type: array
No Additional Items

At least one of the items must be:

root allOf logisticMethods required for LOGISTIC capability if capabilities contains
Type: const
Specific value: "LOGISTIC"
root allOf logisticMethods required for LOGISTIC capability then
Type: object

logisticMethods is required when capabilities include LOGISTIC

The following properties are required:

  • logisticMethods
root allOf SERVICE_CENTER capability can be used for BRANCH or HUB

SERVICE_CENTER capability can be used for BRANCH or HUB

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 SERVICE_CENTER capability can be used for BRANCH or HUB if
Type: object

root allOf SERVICE_CENTER capability can be used for BRANCH or HUB if capabilities
Type: array
No Additional Items

At least one of the items must be:

root allOf SERVICE_CENTER capability can be used for BRANCH or HUB if capabilities contains
Type: const
Specific value: [ "SERVICE_CENTER" ]
root allOf SERVICE_CENTER capability can be used for BRANCH or HUB then
Type: object

root allOf SERVICE_CENTER capability can be used for BRANCH or HUB then facilityType
Type: enum (of string)

Must be one of:

  • "BRANCH"
  • "HUB"
root allOf parent required for all LOGISTIC capabilities other then `CDC`

parent required for all LOGISTIC capabilities other then `CDC`

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 parent required for all LOGISTIC capabilities other then `CDC` if
Type: object

root allOf parent required for all LOGISTIC capabilities other then `CDC` if facilityType
Type: enum (of string)

Must be one of:

  • "BRANCH"
  • "LOCAL_LOCKER"
  • "NATIONAL_LOCKER"
root allOf parent required for all LOGISTIC capabilities other then `CDC` then
Type: object

parent is now required

The following properties are required:

  • parent

root eventHeader
Type: object

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

{
    "source": "SPARK",
    "version": "v1"
}

root eventHeader source
Type: enum (of string)

If the event header is not sent then by default it is produced by the opco and should be consumed both by Spark CX and Spark AX, but if the event source is SPARK, it will be consumed by Spark AX only

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 facilityId
Type: string

this field is intended to be the operating company's identifier of the facility
Example:

"B01234567"

root facilityType
Type: enum (of string)

This field allows to distinguish the different type of facilities: 1. CDC - the central distribution center, neither displayed nor could be selected on SPARK, 2. Branch - A store or a physical shop where PICK_UP could be done, In SPARK every account has a default branch and customer can change his branch, 3. National Locker - Have an independent address and could be selected as a facility on Spark and the fulfillment always is done from a CDC, 4. Local Locker - Attached to a branch and could not be selected as facility and the fulfillment could be done by both Branch and CDC

Must be one of:

  • "BRANCH"
  • "CDC"
  • "LOCAL_LOCKER"
  • "NATIONAL_LOCKER"
  • "HUB"

Example:

"BRANCH"

root orgIds
Type: array of string

The list of organizations to which this ficility can be associated. Needed by OpCo organised with a regional model or commercial organisation. It will be used to filter store locator.

 No Additional Items

Each item of this array must be:

root orgIds orgIds items
Type: string

Example:

[
    "org123",
    "SNE",
    "OVCA"
]

root name

Multilingual Object

Type: object

name of the Facility
Example:

{
    "fr-BE": "Marché de gros Sonepar Connect Paris",
    "nl-BE": "Groothandelsmarkt Sonepar Connect Parijs"
}

Each additional property must conform to the following schema

root name additionalProperties
Type: string

root description

Multilingual Object

Type: object

the description of the facility
Example:

{
    "fr-BE": "Marché de gros Sonepar Connect avec service de coupe de câbles",
    "nl-BE": "Sonepar Connect-groothandelsmarkt met kabelknipservice"
}

Each additional property must conform to the following schema

root description additionalProperties
Type: string

root contactInfo

ContactInfo

Type: object

A sub object that regroup contact informations
Example:

{
    "phoneNumber": "01 44 52 03 41",
    "faxNumber": "01 44 52 03 41",
    "email": "contact@example.com"
}

root contactInfo phoneNumber
Type: string

this field is intended to be the phone of the facility
Example:

"01 44 52 03 41"

root contactInfo faxNumber
Type: string

this field is intended to be the fax of the facility
Example:

"01 44 52 03 41"

root contactInfo email
Type: stringFormat: email

this field is intended to be the email of the facility
Example:

"contact@example.com"

root address

Address

Type: object

The address of a facility.
Example:

{
    "addressLine1": {
        "fr-BE": "Viale dell'Artigianato, 14",
        "nl-BE": "14 straat de la République"
    },
    "postalcode": "12051",
    "city": {
        "fr-BE": "Bruges",
        "nl-BE": "Brugge"
    },
    "region": {
        "fr-BE": "Grand-Bigard",
        "nl-BE": "Groot-Bijgaarden"
    },
    "country": "BEL"
}

root address addressLine1

Multilingual Object

Type: object

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

{
    "fr-BE": "14 rue de la République",
    "nl-BE": "14 straat de la République"
}

Each additional property must conform to the following schema

root address addressLine1 additionalProperties
Type: string

root address addressLine2

Multilingual Object

Type: object

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

{
    "de-CH": "ein Text in Schweizerdeutsch",
    "fr-CH": "un texte en français suisse"
}

Each additional property must conform to the following schema

root address addressLine2 additionalProperties
Type: string

root address addressLine3

Multilingual Object

Type: object

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

{
    "de-CH": "ein Text in Schweizerdeutsch",
    "fr-CH": "un texte en français suisse"
}

Each additional property must conform to the following schema

root address addressLine3 additionalProperties
Type: string

root address postalCode
Type: string

The postal code
Example:

"V7P 1E2"

root address city

Multilingual Object

Type: object

The city in which the street address is, and which is in the adminDevison(region)
Example:

{
    "fr-BE": "Bruges",
    "nl-BE": "Brugge"
}

Each additional property must conform to the following schema

root address city additionalProperties
Type: string

root address region

Multilingual Object

Type: object

The region in which the locality is, and which is in the country.
Example:

{
    "fr-BE": "Grand-Bigard",
    "nl-BE": "Groot-Bijgaarden"
}

Each additional property must conform to the following schema

root address region additionalProperties
Type: string

root address department
Type: string

department
Example:

"JURA"

root address country
Type: string

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

"CAN"

root location

Location

Type: object

Geo coordinates of a facility
Example:

{
    "latitude": -33.866651,
    "longitude": 151.195827
}

root location latitude
Type: number

The latitude of a location
Example:

-33.866651

root location longitude
Type: number

The longitude of a location
Example:

151.195827

root globalLocationNumber
Type: string

The Global Location Number (GLN, sometimes also referred to as International Location Number or ILN) of the respective organization, person, or place. The GLN is a 13-digit number used to identify parties and physical locations.

root services
Type: array

A list of service available for this facility

 No Additional Items

Each item of this array must be:

root services Service

Service

Type: object

A service that available at the facility

root services Service serviceCode
Type: string

An unique identifier of the service
Example:

"PURCHASE_ADVICE"

root services Service serviceTitle

Multilingual Object

Type: object

A human readable service title. Should be translated into all available languages of the OpCo
Example:

{
    "fr-BE": "conseils d'achat",
    "nl-BE": "Kaufberatung"
}

Each additional property must conform to the following schema

root services Service serviceTitle additionalProperties
Type: string

Example:

[
    {
        "serviceCode": "PURCHASE_ADVICE",
        "serviceTitle": {
            "fr-BE": "conseils d'achat",
            "nl-BE": "Kaufberatung"
        }
    },
    {
        "serviceCode": "SELF_SERVICE",
        "serviceTitle": {
            "fr-BE": "libre service",
            "nl-BE": "Selbstbedienung"
        }
    }
]

root openingHours
Type: array

this field is intended to be the opening hours of the facility

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

root openingHours openingHours items

root openingHours openingHours items allOf item 0
Type: object

root openingHours openingHours items allOf item 0 dayOfWeek
Type: enum (of string)

The day of the week

Must be one of:

  • "MONDAY"
  • "TUESDAY"
  • "WEDNESDAY"
  • "THURSDAY"
  • "FRIDAY"
  • "SATURDAY"
  • "SUNDAY"

Example:

"MONDAY"
root openingHours openingHours items allOf OpeningInfo

OpeningInfo

Type: object

The opening facility info line

root openingHours openingHours items allOf OpeningInfo isOpen
Type: boolean

True if the facility is open, false otherwise
Example:

true

root openingHours openingHours items allOf OpeningInfo periods
Type: array

Opening period of time

 No Additional Items

Each item of this array must be:

root openingHours openingHours items allOf OpeningInfo periods Period

Period

Type: object

Period of time

root openingHours openingHours items allOf OpeningInfo periods Period openTime
Type: string

The opening time may contain a time of day in 24-hour hhmm format. Values are in the range 0000–2359. The time will be reported in the place’s time zone.
Example:

"07:00"

root openingHours openingHours items allOf OpeningInfo periods Period closeTime
Type: string

The closing time (hh:mm)
Example:

"13:00"

Example:

[
    {
        "openTime": "06:30",
        "closeTime": "12:00"
    },
    {
        "openTime": "13:00",
        "closeTime": "17:00"
    }
]

Example:

[
    {
        "dayOfWeek": "MONDAY",
        "isOpen": true,
        "periods": [
            {
                "openTime": "06:30",
                "closeTime": "12:00"
            },
            {
                "openTime": "13:00",
                "closeTime": "17:00"
            }
        ]
    },
    {
        "dayOfWeek": "TUESDAY",
        "isOpen": true,
        "periods": [
            {
                "openTime": "06:30",
                "closeTime": "12:00"
            },
            {
                "openTime": "13:00",
                "closeTime": "17:00"
            }
        ]
    }
]

root exceptionalOpeningHours
Type: array

A list of exceptional opening or closing hours to override the default opening hours

 No Additional Items

Each item of this array must be:

root exceptionalOpeningHours exceptionalOpeningHours items

root exceptionalOpeningHours exceptionalOpeningHours items allOf item 0
Type: object
root exceptionalOpeningHours exceptionalOpeningHours items allOf OpeningInfo

OpeningInfo

Type: object

The opening facility info line

root exceptionalOpeningHours exceptionalOpeningHours items allOf OpeningInfo isOpen
Type: boolean

True if the facility is open, false otherwise
Example:

true

root exceptionalOpeningHours exceptionalOpeningHours items allOf OpeningInfo periods
Type: array

Opening period of time

 No Additional Items

Each item of this array must be:

root exceptionalOpeningHours exceptionalOpeningHours items allOf OpeningInfo periods Period

Period

Type: object

Period of time

root exceptionalOpeningHours exceptionalOpeningHours items allOf OpeningInfo periods Period openTime
Type: string

The opening time may contain a time of day in 24-hour hhmm format. Values are in the range 0000–2359. The time will be reported in the place’s time zone.
Example:

"07:00"

root exceptionalOpeningHours exceptionalOpeningHours items allOf OpeningInfo periods Period closeTime
Type: string

The closing time (hh:mm)
Example:

"13:00"

Example:

[
    {
        "openTime": "06:30",
        "closeTime": "12:00"
    },
    {
        "openTime": "13:00",
        "closeTime": "17:00"
    }
]

Example:

[
    {
        "date": "25-12-2020",
        "isOpen": false
    },
    {
        "date": "01-01-2020",
        "isOpen": true,
        "periods": [
            {
                "openTime": "06:30",
                "closeTime": "12:00"
            }
        ]
    }
]

root logisticMethods
Type: array of object

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

root logisticMethods logisticMethods items
Type: object

A logistic method is a high level proposition of fulfiment of the order by the supplier. It translates into an expected notion of service (including standard delivery promise and cut off tine)

root logisticMethods logisticMethods items mode
Type: enum (of string)

The code of the logistic method

Must be one of:

  • "DELIVERY"
  • "PICK_UP"

Example:

"DELIVERY"

root logisticMethods logisticMethods items standardDays
Type: array of object

the standard values of cutOffTime, leadTime, preparationTime, averageDeliveryTime by day of the week

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

root logisticMethods logisticMethods items standardDays standardDays items

root logisticMethods logisticMethods items standardDays standardDays items allOf item 0
Type: object

root logisticMethods logisticMethods items standardDays standardDays items allOf item 0 dayOfWeek
Type: enum (of string)

The day of the week

Must be one of:

  • "MONDAY"
  • "TUESDAY"
  • "WEDNESDAY"
  • "THURSDAY"
  • "FRIDAY"
  • "SATURDAY"
  • "SUNDAY"

Example:

"MONDAY"
root logisticMethods logisticMethods items standardDays standardDays items allOf LogisticMethodDetails
Type: object

Group details about logisticMethod like cutOffTime, leadTime, preparationTime, averageDeliveryTime (required in case of delivery from cdc)

root logisticMethods logisticMethods items standardDays standardDays items allOf item 1 cutOffTime
Type: string

Cutoff Time is used to define what time orders stop dispatched next day.
Example:

"15:30"

root logisticMethods logisticMethods items standardDays standardDays items allOf item 1 leadTime
Type: number

How much hours CDC take to deliver stock to Branch or how much time suppliers take to deliver to CDC
Example:

48

root logisticMethods logisticMethods items standardDays standardDays items allOf item 1 preparationTime
Type: number

The average amount of time need to prepare a product in minutes
Example:

30

root logisticMethods logisticMethods items standardDays standardDays items allOf item 1 averageDeliveryTime
Type: number

The average delivery time to customer from a CDC for mvp scope, Only true in case of delivery to customer, Required to compute the delivery promise, Keeping it optional as same could be used for delivery from branch for some opcos if the facility type is branch
Example:

48

The following properties are required:

  • dayOfWeek

root logisticMethods logisticMethods items exceptionalDays
Type: array of object

the exceptional values of cutOffTime, leadTime, preparationTime and averageDeliveryTime for spicial dates

 No Additional Items

Each item of this array must be:

root logisticMethods logisticMethods items exceptionalDays exceptionalDays items

root logisticMethods logisticMethods items exceptionalDays exceptionalDays items allOf item 0
Type: object
root logisticMethods logisticMethods items exceptionalDays exceptionalDays items allOf LogisticMethodDetails
Type: object

Group details about logisticMethod like cutOffTime, leadTime, preparationTime, averageDeliveryTime (required in case of delivery from cdc)

root logisticMethods logisticMethods items exceptionalDays exceptionalDays items allOf item 1 cutOffTime
Type: string

Cutoff Time is used to define what time orders stop dispatched next day.
Example:

"15:30"

root logisticMethods logisticMethods items exceptionalDays exceptionalDays items allOf item 1 leadTime
Type: number

How much hours CDC take to deliver stock to Branch or how much time suppliers take to deliver to CDC
Example:

48

root logisticMethods logisticMethods items exceptionalDays exceptionalDays items allOf item 1 preparationTime
Type: number

The average amount of time need to prepare a product in minutes
Example:

30

root logisticMethods logisticMethods items exceptionalDays exceptionalDays items allOf item 1 averageDeliveryTime
Type: number

The average delivery time to customer from a CDC for mvp scope, Only true in case of delivery to customer, Required to compute the delivery promise, Keeping it optional as same could be used for delivery from branch for some opcos if the facility type is branch
Example:

48

Example:

[
    {
        "mode": "DELIVERY",
        "standardDays": [
            {
                "dayOfWeek": "MONDAY",
                "cutOffTime": "15:30",
                "leadTime": "48",
                "preparationTime": "30",
                "averageDeliveryTime": "48"
            },
            {
                "dayOfWeek": "TUESDAY",
                "cutOffTime": "15:30",
                "leadTime": "48",
                "preparationTime": "30",
                "averageDeliveryTime": "36"
            },
            {
                "dayOfWeek": "WEDNESDAY",
                "cutOffTime": "15:30",
                "leadTime": "48",
                "preparationTime": "30",
                "averageDeliveryTime": "24"
            },
            {
                "dayOfWeek": "THURSDAY",
                "cutOffTime": "15:30",
                "leadTime": "48",
                "preparationTime": "30",
                "averageDeliveryTime": "48"
            },
            {
                "dayOfWeek": "FRIDAY",
                "cutOffTime": "11:30",
                "leadTime": "48",
                "preparationTime": "30",
                "averageDeliveryTime": "36"
            }
        ],
        "exceptionalDays": [
            {
                "date": "2020-12-24",
                "cutOffTime": "10:30",
                "leadTime": "48",
                "preparationTime": "30",
                "averageDeliveryTime": "48"
            }
        ]
    },
    {
        "mode": "PICK_UP",
        "standardDays": [
            {
                "dayOfWeek": "MONDAY",
                "cutOffTime": "15:30",
                "leadTime": "48",
                "preparationTime": "30"
            },
            {
                "dayOfWeek": "TUESDAY",
                "cutOffTime": "15:30",
                "leadTime": "48",
                "preparationTime": "30"
            },
            {
                "dayOfWeek": "WEDNESDAY",
                "cutOffTime": "15:30",
                "leadTime": "48",
                "preparationTime": "30"
            },
            {
                "dayOfWeek": "THURSDAY",
                "cutOffTime": "15:30",
                "leadTime": "48",
                "preparationTime": "30"
            },
            {
                "dayOfWeek": "FRIDAY",
                "cutOffTime": "11:30",
                "leadTime": "48",
                "preparationTime": "30"
            }
        ],
        "exceptionalDays": [
            {
                "date": "2020-12-24",
                "cutOffTime": "10:30",
                "leadTime": "48",
                "preparationTime": "30"
            }
        ]
    }
]

root parent
Type: string

Parent child relation to another facility. Mandatory when facility type is Branch or Locker. This will be used to represent for example the relation - branch to CDC and locker to branch.
Example:

"CDC1"

root activationDate
Type: stringFormat: date-time

The activation date of the facility. Optional field used to schedule the activation of future facility. If is not set the facility is considered as active
Example:

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

root deactivationDate
Type: stringFormat: date-time

The deactivation date of the facility. Optional field used to schedule the deactivation facility. If is not set the facility is considered as active
Example:

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

root extendedDeliveryFacilities
Type: array of string

The list of facility IDs that are linked with this facility for extended delivery (multi-CDC)

 No Additional Items

Each item of this array must be:

root extendedDeliveryFacilities extendedDeliveryFacilities items
Type: string

Example:

[
    "3A1",
    "CDC2",
    "AF2"
]

root capabilities
Type: array of enum (of string) Default: ["LOGISTIC"]

All items must be unique

No Additional Items

Each item of this array must be:

root capabilities capabilities items
Type: enum (of string)

Must be one of:

  • "SERVICE_CENTER"
  • "LOGISTIC"