User Request

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 requestType

Type: enum (of string)

Type of the request.

Must be one of:

"NEW_CUSTOMER_ONBOARDING"
"EXISTING_CUSTOMER_ONBOARDING"
"CONTACT"
"RESEND_USER_ACTIVATION_EMAIL"
"MARKETING_FORM"
"EVENT_REGISTRATION"
"WARRANTY"
"CLAIM"

Example:

"NEW_CUSTOMER_ONBOARDING"

root warranty

Type: object

This object is used to describe a warranty request.

root warranty header

Type: object

This object is used to describe the header of the warranty header.

No Additional Properties

root warranty header requestId

Type: string

The unique identifier of the requested as generated by the master system.

Must be at least 1 characters long

Example:

"123456789"

root warranty header referenceId

Type: string

The claim or warranty unique identifier as generated by the OpCo system

Must be at least 1 characters long

Example:

"123456789"

root warranty header requestedDate

Type: stringFormat: date

Is meant to be either the date requested by the customer for pickup or drop off to the branch for a return or requested by the OpCo for a reverse logistic.

Example:

"2023-10-01"

root warranty header logisticDetails

Type: object

Contains the logistic details.

No Additional Properties

root warranty header logisticDetails allOf item 0

Type: object

Conditional Subschema

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.

If
Then

root warranty header logisticDetails allOf item 0 if

Type: object

root warranty header logisticDetails allOf item 0 if logisticMethod

Type: const
Specific value: "DROP_OFF"

root warranty header logisticDetails allOf item 0 then

Type: object

The following properties are required:

dropOffFacilityId

root warranty header logisticDetails allOf item 1

Type: object

Conditional Subschema

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.

If
Then

root warranty header logisticDetails allOf item 1 if

Type: object

root warranty header logisticDetails allOf item 1 if logisticMethod

Type: const
Specific value: "PICK_UP"

root warranty header logisticDetails allOf item 1 then

Type: object

The following properties are required:

pickupAddress

root warranty header logisticDetails logisticMethod

Type: enum (of string)

This is the selected logistic method for the request.
- DROP_OFF when the customer is dropping off the product at a facility.
- PICK_UP when the customer is requesting a pickup from a specific address.

Must be one of:

"DROP_OFF"
"PICK_UP"

root warranty header logisticDetails dropOffFacilityId

Type: string

The facility id used for drop off.

Must be at least 1 characters long

Example:

"1234567"

root warranty header logisticDetails pickupAddress

Address

Type: object

The address used for pickup.

No Additional Properties

root warranty header logisticDetails pickupAddress opCoAddressId

Type: string

OpCo internal system's unique identifier for the address.

Must be at least 1 characters long

Example:

"237564557868778"

root warranty header logisticDetails pickupAddress addressLine1

Type: string

The first line of the address. Should contain Street name, no, street type. Usually the whole address can fit on one line.

Must be at least 1 characters long

Example:

"235 Donaghy Ave"

root warranty header logisticDetails pickupAddress addressLine2

Type: string

The second line of the address. Should complete the address with other details (e.g. floor number)

Must be at least 1 characters long

Example:

"1st floor"

root warranty header logisticDetails pickupAddress addressLine3

Type: string

The third line of the address. Should complete the address with other information. e.g. Apartment no

Must be at least 1 characters long

Example:

"Apt 1"

root warranty header logisticDetails pickupAddress postalCode

Type: string

The postal code

Must be at least 1 characters long

Example:

"V7P 1E2"

root warranty header logisticDetails pickupAddress city

Type: string

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

Must be at least 1 characters long

Example:

"North Vancouver"

root warranty header logisticDetails pickupAddress region

Type: string

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

Must be at least 1 characters long

Example:

"BC"

root warranty header logisticDetails pickupAddress department

Type: string

The department in which the locality is, and which is in the country.

Must be at least 1 characters long

Example:

"BC"

root warranty header logisticDetails pickupAddress country

Type: string

The ISO 3166-1 alpha-3 of the country

Must be at least 3 characters long

Must be at most 3 characters long

Example:

"CAN"

root warranty header logisticDetails returnRequestId

Type: string

The unique identifier of the return as generated by the master system.

Must be at least 1 characters long

Example:

"123456789"

root warranty header logisticDetails facilityContact

ContactInfo

Type: object

Contact information of the facility.

No Additional Properties

root warranty header logisticDetails facilityContact phoneNumber

Type: string

Phone number of the contact.

Must be at least 1 characters long

Example:

"+12345678910"

root warranty header logisticDetails facilityContact email

Type: stringFormat: email

The email of the contact. This is the identifier of the user on spark

Example:

"user@domain.com"

root warranty header logisticDetails facilityContact faxNumber

Type: string

The fax number of the contact.

Must be at least 1 characters long

Example:

"+12345678910"

root warranty header contributors

Type: array

The list of contributors to the logistic issue.

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

root warranty header contributors Contributor

Type: object
No Additional Properties

Example:

[
    {
        "fullName": "John Smith",
        "email": "john.smith@mycompany.com"
    },
    {
        "fullName": "John Validator",
        "email": "john.validator@mycompany.com"
    }
]

root warranty header contributors contributors items fullName

Type: string

The full name of a contributor.

Must be at least 1 characters long

Example:

"John Smith"

root warranty header contributors contributors items email

Type: stringFormat: email

The email of a contributor. This is the identifier of the user on spark

Example:

"john.smith@mycompany.com"

root warranty header contributors contributors items phone

Type: string

The phone number of a contributor.

Must be at least 1 characters long

Example:

"+1234567890"

root warranty header contributors contributors items creator

Type: boolean Default: false

Indicates if the contributor is the creator of the return request.

Example:

true

root warranty lines

Type: array

Array containing the details per each line.

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

root warranty lines RequestLines

Type: object

The line of the logistic issue.

No Additional Properties

root warranty lines lines items salesOrderId

Type: string

The unique identifier of the sales order, as defined by the sales-order universal feed schema.

Must be at least 1 characters long

Example:

"1234567"

root warranty lines lines items salesOrderLineId

Type: string

The unique identifier of the sales order line, as defined by the sales-order universal feed schema.

Must be at least 1 characters long

Example:

"1234567"

root warranty lines lines items billingId

Type: string

The unique identifier of the billing.

Must be at least 1 characters long

Example:

"1234567"

root warranty lines lines items billingLineId

Type: string

The unique identifier of the billing line.

Must be at least 1 characters long

Example:

"1234567"

root warranty lines lines items product

Type: object

The product subject to this request.

No Additional Properties

root warranty lines lines items product id

Type: string

The unique identifier of the product.

Must be at least 1 characters long

Example:

"1234567"

root warranty lines lines items product name

Type: string

The name of the product.

Must be at least 1 characters long

Example:

"Product Name"

root warranty lines lines items product brandName

Type: string

The name of the brand.

Must be at least 1 characters long

Example:

"Brand Name"

root warranty lines lines items product reason

Type: string

From the list of reasons configured for the OpCo.

Must be at least 1 characters long

Example:

"DEFECTIVE_ITEM"

root warranty lines lines items product images

Type: array

The list of images of the product.

No Additional Items

Each item of this array must be:

root warranty lines lines items product images Image

Type: object

The image of the product.

No Additional Properties

root warranty lines lines items product images images items name

Type: string

The name of the image.

Must be at least 1 characters long

Example:

"Image Name"

root warranty lines lines items product images images items url

Type: stringFormat: uri

The URL of the image.

Example:

"https://example.com/image.jpg"

root warranty lines lines items product comment

Type: string

A comment related to the product.

Must be at least 1 characters long

Example:

"Product Comment"

root warranty lines lines items product additionalInformation

Type: array of object

Any additional information related to the product

No Additional Items

Each item of this array must be:

root warranty lines lines items product additionalInformation additionalInformation items

Type: object

A free key value pair field to add any details about the product

root warranty lines lines items product additionalInformation additionalInformation items name

Multilingual Object

Type: object

The name or identifier for the additional information

Example:

{
    "en-GB": "Diameter",
    "fr-FR": "Diamètre"
}

Each additional property must conform to the following schema

root warranty lines lines items product additionalInformation additionalInformation items name additionalProperties

Type: string

root warranty lines lines items product additionalInformation additionalInformation items value

Multilingual Object

Type: object

The value for the named additional information

Example:

{
    "en-GB": "1.2 m",
    "fr-FR": "1.2 mètre"
}

Each additional property must conform to the following schema

root warranty lines lines items product additionalInformation additionalInformation items value additionalProperties

Type: string

root warranty lines lines items status

Type: enum (of string)

The status of the logistic issue line.
- REQUESTED when the return is requested by the customer.
- RETURNED when the line item is returned in full by the customer.
- DELETED when the line item is to be deleted

Must be one of:

"REQUESTED"
"RETURNED"
"DELETED"
"READY_FOR_COLLECTION"
"COMPLETE"
"PARTIALLY_RETURN"

Example:

"COMPLETE"

root warranty lines lines items requestedQuantity

Type: integer

The requested quantity.

Value must be greater or equal to 0

Example:

root warranty lines lines items shipmentId

Type: string

The unique identifier of the shipment associated with the return line item.

Must be at least 1 characters long

Example:

"1234567"

root claim

Type: object

This object is used to describe a warranty request.

root claim header

Type: object

This object is used to describe the header of the warranty header.

No Additional Properties

root claim header requestId

Type: string

The unique identifier of the requested as generated by the master system.

Must be at least 1 characters long

Example:

"123456789"

root claim header referenceId

Type: string

The claim or warranty unique identifier as generated by the OpCo system

Must be at least 1 characters long

Example:

"123456789"

root claim header requestedDate

Type: stringFormat: date

Is meant to be either the date requested by the customer for pickup or drop off to the branch for a return or requested by the OpCo for a reverse logistic.

Example:

"2023-10-01"

root claim header logisticDetails

Type: object

Contains the logistic details.

No Additional Properties

All of

Requirement 1
Requirement 2

root claim header logisticDetails allOf item 0

Type: object

Conditional Subschema

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.

If
Then

root claim header logisticDetails allOf item 0 if

Type: object

root claim header logisticDetails allOf item 0 if logisticMethod

Type: const
Specific value: "DROP_OFF"

root claim header logisticDetails allOf item 0 then

Type: object

The following properties are required:

dropOffFacilityId

root claim header logisticDetails allOf item 1

Type: object

Conditional Subschema

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.

If
Then

root claim header logisticDetails allOf item 1 if

Type: object

root claim header logisticDetails allOf item 1 if logisticMethod

Type: const
Specific value: "PICK_UP"

root claim header logisticDetails allOf item 1 then

Type: object

The following properties are required:

pickupAddress

root claim header logisticDetails logisticMethod

Type: enum (of string)

This is the selected logistic method for the request.
- DROP_OFF when the customer is dropping off the product at a facility.
- PICK_UP when the customer is requesting a pickup from a specific address.

Must be one of:

"DROP_OFF"
"PICK_UP"

root claim header logisticDetails dropOffFacilityId

Type: string

The facility id used for drop off.

Must be at least 1 characters long

Example:

"1234567"

root claim header logisticDetails pickupAddress

Address

Type: object

The address used for pickup.

No Additional Properties

root claim header logisticDetails pickupAddress opCoAddressId

Type: string

OpCo internal system's unique identifier for the address.

Must be at least 1 characters long

Example:

"237564557868778"

root claim header logisticDetails pickupAddress addressLine1

Type: string

The first line of the address. Should contain Street name, no, street type. Usually the whole address can fit on one line.

Must be at least 1 characters long

Example:

"235 Donaghy Ave"

root claim header logisticDetails pickupAddress addressLine2

Type: string

The second line of the address. Should complete the address with other details (e.g. floor number)

Must be at least 1 characters long

Example:

"1st floor"

root claim header logisticDetails pickupAddress addressLine3

Type: string

The third line of the address. Should complete the address with other information. e.g. Apartment no

Must be at least 1 characters long

Example:

"Apt 1"

root claim header logisticDetails pickupAddress postalCode

Type: string

The postal code

Must be at least 1 characters long

Example:

"V7P 1E2"

root claim header logisticDetails pickupAddress city

Type: string

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

Must be at least 1 characters long

Example:

"North Vancouver"

root claim header logisticDetails pickupAddress region

Type: string

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

Must be at least 1 characters long

Example:

"BC"

root claim header logisticDetails pickupAddress department

Type: string

The department in which the locality is, and which is in the country.

Must be at least 1 characters long

Example:

"BC"

root claim header logisticDetails pickupAddress country

Type: string

The ISO 3166-1 alpha-3 of the country

Must be at least 3 characters long

Must be at most 3 characters long

Example:

"CAN"

root claim header logisticDetails returnRequestId

Type: string

The unique identifier of the return as generated by the master system.

Must be at least 1 characters long

Example:

"123456789"

root claim header logisticDetails facilityContact

ContactInfo

Type: object

Contact information of the facility.

No Additional Properties

root claim header logisticDetails facilityContact phoneNumber

Type: string

Phone number of the contact.

Must be at least 1 characters long

Example:

"+12345678910"

root claim header logisticDetails facilityContact email

Type: stringFormat: email

The email of the contact. This is the identifier of the user on spark

Example:

"user@domain.com"

root claim header logisticDetails facilityContact faxNumber

Type: string

The fax number of the contact.

Must be at least 1 characters long

Example:

"+12345678910"

root claim header contributors

Type: array

The list of contributors to the logistic issue.

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

root claim header contributors Contributor

Type: object
No Additional Properties

Example:

[
    {
        "fullName": "John Smith",
        "email": "john.smith@mycompany.com"
    },
    {
        "fullName": "John Validator",
        "email": "john.validator@mycompany.com"
    }
]

root claim header contributors contributors items fullName

Type: string

The full name of a contributor.

Must be at least 1 characters long

Example:

"John Smith"

root claim header contributors contributors items email

Type: stringFormat: email

The email of a contributor. This is the identifier of the user on spark

Example:

"john.smith@mycompany.com"

root claim header contributors contributors items phone

Type: string

The phone number of a contributor.

Must be at least 1 characters long

Example:

"+1234567890"

root claim header contributors contributors items creator

Type: boolean Default: false

Indicates if the contributor is the creator of the return request.

Example:

true

root claim lines

Type: array

Array containing the details per each line.

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

root claim lines RequestLines

Type: object

The line of the logistic issue.

No Additional Properties

root claim lines lines items salesOrderId

Type: string

The unique identifier of the sales order, as defined by the sales-order universal feed schema.

Must be at least 1 characters long

Example:

"1234567"

root claim lines lines items salesOrderLineId

Type: string

The unique identifier of the sales order line, as defined by the sales-order universal feed schema.

Must be at least 1 characters long

Example:

"1234567"

root claim lines lines items billingId

Type: string

The unique identifier of the billing.

Must be at least 1 characters long

Example:

"1234567"

root claim lines lines items billingLineId

Type: string

The unique identifier of the billing line.

Must be at least 1 characters long

Example:

"1234567"

root claim lines lines items product

Type: object

The product subject to this request.

No Additional Properties

root claim lines lines items product id

Type: string

The unique identifier of the product.

Must be at least 1 characters long

Example:

"1234567"

root claim lines lines items product name

Type: string

The name of the product.

Must be at least 1 characters long

Example:

"Product Name"

root claim lines lines items product brandName

Type: string

The name of the brand.

Must be at least 1 characters long

Example:

"Brand Name"

root claim lines lines items product reason

Type: string

From the list of reasons configured for the OpCo.

Must be at least 1 characters long

Example:

"DEFECTIVE_ITEM"

root claim lines lines items product images

Type: array

The list of images of the product.

No Additional Items

Each item of this array must be:

root claim lines lines items product images Image

Type: object

The image of the product.

No Additional Properties

root claim lines lines items product images images items name

Type: string

The name of the image.

Must be at least 1 characters long

Example:

"Image Name"

root claim lines lines items product images images items url

Type: stringFormat: uri

The URL of the image.

Example:

"https://example.com/image.jpg"

root claim lines lines items product comment

Type: string

A comment related to the product.

Must be at least 1 characters long

Example:

"Product Comment"

root claim lines lines items product additionalInformation

Type: array of object

Any additional information related to the product

No Additional Items

Each item of this array must be:

root claim lines lines items product additionalInformation additionalInformation items

Type: object

A free key value pair field to add any details about the product

root claim lines lines items product additionalInformation additionalInformation items name

Multilingual Object

Type: object

The name or identifier for the additional information

Example:

{
    "en-GB": "Diameter",
    "fr-FR": "Diamètre"
}

Each additional property must conform to the following schema

root claim lines lines items product additionalInformation additionalInformation items name additionalProperties

Type: string

root claim lines lines items product additionalInformation additionalInformation items value

Multilingual Object

Type: object

The value for the named additional information

Example:

{
    "en-GB": "1.2 m",
    "fr-FR": "1.2 mètre"
}

Each additional property must conform to the following schema

root claim lines lines items product additionalInformation additionalInformation items value additionalProperties

Type: string

root claim lines lines items status

Type: enum (of string)

The status of the logistic issue line.
- REQUESTED when the return is requested by the customer.
- RETURNED when the line item is returned in full by the customer.
- DELETED when the line item is to be deleted

Must be one of:

"REQUESTED"
"RETURNED"
"DELETED"
"READY_FOR_COLLECTION"
"COMPLETE"
"PARTIALLY_RETURN"

Example:

"COMPLETE"

root claim lines lines items requestedQuantity

Type: integer

The requested quantity.

Value must be greater or equal to 0

Example:

root claim lines lines items shipmentId

Type: string

The unique identifier of the shipment associated with the return line item.

Must be at least 1 characters long

Example:

"1234567"

root contact

Type: object

root contact email

Type: string

User's email.

Example:

"geert@electracontractors.be"

root contact title

Type: string

User's title.

Example:

"Dhr."

root contact firstName

Type: string

User's firstname.

Example:

"Geert"

root contact lastName

Type: string

User's lastname.

Example:

"Corijn"

root contact middleName

Type: string

User's middle name.

Example:

"Van"

root account

Type: object

root account 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

Must be at least 1 characters long

Examples:

"1234567"

"1234567_OVIA"

root account commercialNumber

Type: string

VAT number or Siret number.

Must be at least 1 characters long

Example:

"GM4837192941"

root account accountName

Type: string

Name of the organizational customer.

Must be at least 1 characters long

Example:

"Independent Electric"

root account 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.

Must be at least 1 characters long

Examples:

"org123"

"SNE"

root additionalInformations

Type: array

Must contains the information about the formId setup in CMS if the requestType is equals to MARKETINGFORM. SPARK will use the predefined key FORMID, example: FORM_ID = MARKETING-EVENT-1-REGISTRATION

No Additional Items

Each item of this array must be:

root additionalInformations AdditionalInformation

AdditionalInformation

Type: object

Object representing an additional information of the request.

No Additional Properties

root additionalInformations AdditionalInformation name

Type: string

Name of the additional information

Must be at least 1 characters long

Examples:

"message"

"companyName"

root additionalInformations AdditionalInformation value

Type: string

Value of the additional information

Must be at least 1 characters long

Example:

"Super Elec"

root salesRepresentative

SalesRepresentative

Type: object

The sales representative information.

No Additional Properties

root salesRepresentative firstname

Type: string

firstname of the sale representative

Must be at least 1 characters long

Example:

"John"

root salesRepresentative lastname

Type: string

lastname of the sale representative

Must be at least 1 characters long

Example:

"Doe"

root salesRepresentative phoneNumber

Type: string

phone number of the sale representative

Must be at least 1 characters long

Example:

"0683906389"

root salesRepresentative email

Type: string

email of the sale representative

Must be at least 1 characters long

Example:

"john.doe@standelec.com"

User Request

All of

The following properties are required:

Conditional Subschema

requestType

Must not be:

Must be one of:

The following properties are required:

Conditional Subschema

requestType

The following properties are required:

Conditional Subschema

requestType

The following properties are required:

Conditional Subschema

requestType

warranty

lines

Each item of this array must be:

product

reason

Must be one of:

Conditional Subschema

requestType

claim

lines

Each item of this array must be:

product

reason

Must be one of:

eventHeader

source Required

Must be one of:

version Required

Must be one of:

requestType

Must be one of:

warranty

header

requestId

referenceId

requestedDate

logisticDetails

All of

Conditional Subschema

logisticMethod

The following properties are required:

Conditional Subschema

logisticMethod

The following properties are required:

logisticMethod

Must be one of:

dropOffFacilityId

pickupAddress

Address

opCoAddressId

addressLine1 Required

addressLine2

addressLine3

postalCode Required

city Required

region

department

country Required

returnRequestId

facilityContact

ContactInfo

phoneNumber

email Required

faxNumber

contributors

Each item of this array must be:

fullName Required

email Required

phone

creator

lines

Each item of this array must be:

salesOrderId

salesOrderLineId