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

Territory

Type: object

This is object used to describe the Territory levels and facility details

root eventHeader
Type: object

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 action
Type: enum (of string)

Action to be performed

Must be one of:

  • "UPSERT"
  • "DELETE"

root territories

territories

Type: array

Territories represent the business organization hierarchy used for sales management and reporting

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

root territories territory

territory

Type: object

This object describes a territory within an OpCo which will be having unique ids.

root territories territory id
Type: string

Unique Id for the territories

Must be at least 1 characters long


Example:

"2AE"

root territories territory territoryName
Type: string

Name of the territory

Must be at least 1 characters long


Example:

"Vendee"

root territories territory level
Type: enum (of string)

Level of the territory which can be 1 to 5

Must be one of:

  • "Level 1"
  • "Level 2"
  • "Level 3"
  • "Level 4"
  • "Level 5"

root territories territory status
Type: enum (of string)

Status of the territory which can Active or Inactive. OpCo needs to ensure the updates are also applied to the child records where necessary

Must be one of:

  • "Active"
  • "Inactive"

root territories territory order
Type: number

The order of this item to be evaluated.

Value must be greater or equal to 1 and lesser or equal to 5


Example:

1

root territories territory parentId
Type: string

Will contain the Parent Territory for the current territory.
Example:

"Doe"

root territories territory deactivationDate
Type: stringFormat: date-time

Will populate the De-activation date on the Territory and change status to Inactive.
Examples:

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

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

root territories territory modifiedOn
Type: stringFormat: date-time

Will populate the modified on date on the Territory.
Examples:

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

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

root territories territory defaultTeamEmail
Type: stringFormat: email Default: false

Will populate the email field on the related Default Team of the Territory
Example:

"K123@gmail.com"

root territories territory serviceCenterId
Type: string

A facility id with capability SERVICE_CENTER.A service center is the entity to represent the Sonepar venue in charge of managing the customer relationships for any physical touch point regarding sales or services aspects.Can be represented by a Sonepar Branch for Small or Middle size account or by a Hub for larger accounts.It will be applicable only for last level of the sales org
Example:

"4335"

root territories territory postCodes
Type: array of string

Postcodes related to the territories like SW2001,70123,75003

 No Additional Items

Each item of this array must be:

root territories territory postCodes postCodes items
Type: string

Postcode value