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

SparkProductCustomerRef

Type: object

The customer reference for a product by account.
Examples:

{
    "action": "UPSERT",
    "productCustomerReferenceRequest": {
        "accountId": "12345678",
        "productId": "3456789",
        "customerRef": "fascinatingReference"
    }
}

{
    "action": "DELETE",
    "productCustomerReferenceRequest": {
        "accountId": "45454545",
        "productId": "3456789"
    }
}

root action
Type: enum (of string)

The action to perform with the customer reference (UPSERT or DELETE)
Spark sends an event to the OpCo when the user is requesting for customer ref edit
- if the user is creating or updating a customer ref you will receive an upsert action
- if the user is deleting a customer ref you will receive a delete action

Must be one of:

  • "UPSERT"
  • "DELETE"

root productCustomerReferenceRequest
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 productCustomerReferenceRequest if
Type: object

root productCustomerReferenceRequest if action
Type: const
Specific value: "UPSERT"
root productCustomerReferenceRequest then
Type: object

The following properties are required:

  • customerRef

root productCustomerReferenceRequest accountId
Type: string

The identifier of the account

root productCustomerReferenceRequest customerRef
Type: string

The customer ref for the product, Supported by all special chars respecting the pattern.

Must match regular expression: [a-zA-Z0-9_.+@() /$"=#,;'£\\:°*&%-]+

root productCustomerReferenceRequest productId
Type: string

The product identifier, Supported by all special chars respecting the pattern.

Must match regular expression: [a-zA-Z0-9_.-]+