Order Event Definition 0.1.0

Operations

• SEND ebb-{region}-integration-{env}

  The application will send new operation notification messages through this channel.

  Operation IDsend

  Parameters

  Expand all

  object

  env

  required

  string

  The environment from which the event originated from e.g. dev, prod

  Allowed values:
  • "local"
  • "dev"
  • "qa"
  • "qa2"
  • "stg"
  • "prod"

  Accepts one of the following messages:

  • #0

    • application/json

    Message IDOrderConfirmed

    Correlation ID$message.payload#/detail/correlationid

    Default Correlation ID

    The application will send new order confirmed events through this channel.

    Payload

    Expand all

    object

    id

    required

    string

    specversion

    required

    string

    Default value:"1.0"

    env

    string

    The environment from which the event originated from e.g. dev, prod

    Allowed values:
    • "local"
    • "dev"
    • "qa"
    • "qa2"
    • "stg"
    • "prod"

    sourceService

    string

    Const:"com.specsavers/order-service"

    type

    required

    string

    Const:"com.specsavers.order.confirmed"

    correlationid

    string

    The correlation ID of the event. E.g. 1234

    subject

    string

    market

    string

    Derived from locale i.e GB

    Default value:"GB"

    datacontenttype

    string

    Const:"application/json"

    data

    Expand all

    required

    allOf

    Consists of OrderEventBody:

    Expand all

    object [OrderEventBody]

    customer

    Expand all

    required

    object [OrderBaseCustomer]

    id

    required

    string

    title

    string

    firstName

    required

    string

    middleName

    string

    lastName

    required

    string

    dateOfBirth

    required

    string

    gender

    required

    string

    allowMarketing

    required

    boolean

    contactInfo

    Expand all

    required

    object [ContactInfo]

    email

    required

    string

    mobile

    string

    Additional properties are NOT allowed.

    cprNumber

    string

    personnummer

    string

    Additional properties are allowed.

    order

    Expand all

    required

    object [OrderEventBody]

    id

    required

    string

    createdAt

    required

    string

    format: date-time

    createdBy

    Expand all

    required

    object [CreatedBy]

    email

    string

    userType

    string

    Additional properties are allowed.

    locale

    required

    string

    number

    required

    string

    invoice

    Expand all

    object [InvoiceOrCreditNote]

    id

    required

    string

    fileName

    required

    string

    createdAt

    required

    string

    format: date-time

    lastUpdatedAt

    required

    string

    format: date-time

    externalUrl

    required

    string

    storageAccountName

    required

    string

    storageContainerName

    required

    string

    storagePath

    required

    string

    Additional properties are allowed.

    lineItems

    Expand all

    required

    array<allOf>

    Items:

    allOf

    Consists of BaseLineItemType:

    Expand all

    object allOf

    Consists of <anonymous-schema-43>:

    Expand all

    object

    groupId

    required

    number

    id

    required

    string

    itemCategory

    required

    string

    eye

    string

    Allowed values:
    • "L"
    • "R"
    • "LR"

    name

    required

    string

    number

    required

    string

    groupNumber

    required

    string

    quantity

    required

    number

    sku

    required

    string

    state

    string

    style

    string

    Additional properties are allowed.

    And of <anonymous-schema-55>:

    Expand all

    object

    originalLineItem

    Expand all

    allOf

    Consists of <anonymous-schema-43>:

    Expand all

    object

    groupId

    required

    number

    id

    required

    string

    itemCategory

    required

    string

    eye

    string

    Allowed values:
    • "L"
    • "R"
    • "LR"

    name

    required

    string

    number

    required

    string

    groupNumber

    required

    string

    quantity

    required

    number

    sku

    required

    string

    state

    string

    style

    string

    Additional properties are allowed.

    And of <anonymous-schema-57>:

    Expand all

    object

    Additional properties are allowed.

    Additional properties are allowed.

    Additional properties are allowed.

    And of <anonymous-schema-58>:

    Expand all

    object

    quantity

    required

    number

    prescriptionKey

    string

    productDetails

    Expand all

    object

    Additional properties are allowed.

    discount

    Expand all

    object [Discount]

    key

    string

    discountCode

    string

    Additional properties are allowed.

    price

    Expand all

    required

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    taxedPrice

    Expand all

    required

    object [BaseTaxedPriceType]

    totalNet

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    totalGross

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    taxPortions

    Expand all

    array<object [BaseTaxPortionType]>

    object [BaseTaxPortionType]

    rate

    number

    amount

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    name

    string

    Additional properties are NOT allowed.

    totalTax

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

    taxRate

    Expand all

    required

    object [BaseTaxRateType]

    name

    string

    amount

    number

    includedInPrice

    boolean

    country

    string

    subRates

    Expand all

    array<object [BaseTaxSubRateType]>

    object [BaseTaxSubRateType]

    name

    string

    amount

    number

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

    totalPrice

    Expand all

    required

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    unitPrice

    Expand all

    required

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    Additional properties are allowed.

    lineItemGroups

    Expand all

    required

    array<object [LineItemGroupType]>

    object [LineItemGroupType]

    id

    required

    number

    type

    required

    string

    number

    required

    string

    manufacturingData

    Expand all

    object [ManufacturingData]

    requisitionRequestId

    required

    number

    manufacturingData

    string

    frameAvailable

    required

    boolean

    orderType

    required

    string

    errors

    Expand all

    array<string> | null

    Items:

    string

    infos

    Expand all

    array<string> | null

    Items:

    string

    warnings

    Expand all

    array<string> | null

    Items:

    string

    Additional properties are allowed.

    Additional properties are allowed.

    orderState

    required

    string

    Allowed values:
    • "OPEN"
    • "COLLECTED"
    • "PROCESSING"
    • "CONFIRMED"
    • "BACK_ORDERED"
    • "COMPLETE"
    • "SHIPPED"
    • "CANCELLED"
    • "REMORSE"
    • "PENDING_RX_VALIDATION"
    • "PENDING_CANCELLATION"

    origin

    required

    string

    Allowed values:
    • "ONLINE"
    • "INSTORE"
    • "CUSTOMER_SERVICE"

    soldBy

    Expand all

    required

    object [SoldBy]

    eposNumber

    required

    string

    entity

    string

    marketId

    required

    string

    Additional properties are allowed.

    originalOrder

    Expand all

    object [OriginalOrder]

    id

    string

    number

    string

    Additional properties are NOT allowed.

    subscription

    Expand all

    object [BaseSubscription]

    uid: BaseSubscription

    id

    required

    string

    interval

    required

    number

    unit

    required

    string

    Allowed values:
    • "DAYS"
    • "WEEKS"
    • "MONTHS"

    type

    required

    string

    Allowed values:
    • "PREPAY"
    • "POSTPAY"
    • "RECURRING"

    status

    required

    string

    Allowed values:
    • "ACTIVE"
    • "PAUSED"
    • "EXPIRED"
    • "FAILED"
    • "FROZEN"
    • "CANCELLED"
    • "PENDING_CANCELLATION"

    instalments

    Expand all

    array<object [BaseInstalment]>

    object [BaseInstalment]

    id

    required

    string

    amount

    Expand all

    required

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    dueDate

    required

    string

    format: date-time

    paidDate

    Expand all

    oneOf

    Adheres to <anonymous-schema-117>:

    null

    Or to <anonymous-schema-118>:

    string

    format: date-time

    success

    Expand all

    oneOf

    Adheres to <anonymous-schema-120>:

    null

    Or to <anonymous-schema-121>:

    boolean

    Additional properties are allowed.

    Additional properties are allowed.

    type

    required

    string

    Allowed values:
    • "STANDARD"
    • "RECURRING"
    • "REPLACEMENT"
    • "REPAIR"
    • "REMAKE"

    billingAddress

    Expand all

    object [BaseAddress]

    id

    string

    title

    string

    firstName

    string

    lastName

    string

    line1

    string

    line2

    string

    line3

    string

    postalCode

    string

    city

    string

    state

    string

    country

    string

    phone

    string

    email

    string

    Additional properties are allowed.

    payments

    Expand all

    array<object [BasePaymentType]>

    object [BasePaymentType]

    id

    string

    merchantAccount

    string

    merchantReference

    string

    pspReference

    string

    status

    string

    transactions

    Expand all

    array<object [BasePaymentTransaction]>

    object [BasePaymentTransaction]

    id

    string

    interactionId

    string

    state

    string

    pspReference

    string

    type

    string

    amount

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    notes

    string

    Additional properties are allowed.

    paymentInterface

    string

    method

    string

    name

    string

    amount

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    Additional properties are allowed.

    discounts

    Expand all

    array<object [BaseDiscountType]>

    >= 0 items

    object [BaseDiscountType]

    key

    string

    id

    string

    isShippingDiscount

    boolean

    type

    string

    name

    string

    amount

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    Additional properties are allowed.

    discountCodes

    Expand all

    array<string>

    >= 0 items

    Items:

    string

    discountSummary

    Expand all

    array<object [DiscountSummary]>

    object [DiscountSummary]

    id

    required

    string

    type

    required

    string

    name

    required

    string

    isShippingDiscount

    required

    boolean

    discountCode

    string

    amount

    Expand all

    required

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

    prescriptions

    Expand all

    array<object [PrescriptionType]>

    >= 0 items

    object [PrescriptionType]

    key

    string

    type

    string

    date

    string

    format: date

    validFrom

    string

    format: date

    validUntil

    string

    format: date

    hasPrescription

    boolean

    leftEye

    Expand all

    oneOf

    Adheres to <anonymous-schema-180>:

    null

    Or to PrescriptionEyeType:

    Expand all

    object [PrescriptionEyeType]

    key

    required

    string

    add

    string

    addType

    string

    axis

    number

    baseCurve

    string

    cylinder

    string

    diameter

    string

    sphere

    string

    function

    string

    originalPupillaryDistance

    number

    adjustedPupillaryDistance

    number

    Additional properties are allowed.

    rightEye

    Expand all

    oneOf

    Adheres to <anonymous-schema-194>:

    null

    Or to PrescriptionEyeType:

    Expand all

    object [PrescriptionEyeType]

    key

    required

    string

    add

    string

    addType

    string

    axis

    number

    baseCurve

    string

    cylinder

    string

    diameter

    string

    sphere

    string

    function

    string

    originalPupillaryDistance

    number

    adjustedPupillaryDistance

    number

    Additional properties are allowed.

    store

    Expand all

    object [Store]

    id

    required

    string

    name

    required

    string

    Additional properties are allowed.

    externalPrescription

    Expand all

    object [ExternalPrescription]

    id

    required

    string

    fileName

    required

    string

    createdAt

    required

    string

    format: date-time

    lastUpdatedAt

    required

    string

    format: date-time

    storageAccountName

    required

    string

    storageContainerName

    required

    string

    storagePath

    required

    string

    externalUrl

    required

    string

    Additional properties are allowed.

    Additional properties are allowed.

    shippingAddress

    Expand all

    object [BaseAddress]

    id

    string

    title

    string

    firstName

    string

    lastName

    string

    line1

    string

    line2

    string

    line3

    string

    postalCode

    string

    city

    string

    state

    string

    country

    string

    phone

    string

    email

    string

    Additional properties are allowed.

    shippingInfo

    Expand all

    object [BaseShippingInfoType]

    shippingMethodName

    string

    price

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    shippingRate

    Expand all

    object [BaseShippingRateType]

    price

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

    taxRate

    Expand all

    object [BaseTaxRateType]

    name

    string

    amount

    number

    includedInPrice

    boolean

    country

    string

    subRates

    Expand all

    array<object [BaseTaxSubRateType]>

    object [BaseTaxSubRateType]

    name

    string

    amount

    number

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

    taxedPrice

    Expand all

    object [BaseTaxedPriceType]

    totalNet

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    totalGross

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    taxPortions

    Expand all

    array<object [BaseTaxPortionType]>

    object [BaseTaxPortionType]

    rate

    number

    amount

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    name

    string

    Additional properties are NOT allowed.

    totalTax

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

    taxedPrice

    Expand all

    required

    object [BaseTaxedPriceType]

    totalNet

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    totalGross

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    taxPortions

    Expand all

    array<object [BaseTaxPortionType]>

    object [BaseTaxPortionType]

    rate

    number

    amount

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    name

    string

    Additional properties are NOT allowed.

    totalTax

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

    taxedShippingPrice

    Expand all

    object [BaseTaxedPriceType]

    totalNet

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    totalGross

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    taxPortions

    Expand all

    array<object [BaseTaxPortionType]>

    object [BaseTaxPortionType]

    rate

    number

    amount

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    name

    string

    Additional properties are NOT allowed.

    totalTax

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

    subtotalPrice

    Expand all

    required

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    totalPrice

    Expand all

    required

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    lastModifiedAt

    string

    format: date-time

    isExpressReorder

    boolean

    Additional properties are allowed.

    aftercareStore

    Expand all

    object [OrderBaseStore]

    address

    Expand all

    object [OrderBaseStoreAddress]

    city

    string

    country

    string

    line1

    string

    line2

    string

    line3

    string

    name

    string

    postcode

    string

    region

    string

    Additional properties are NOT allowed.

    companyDetails

    Expand all

    object [OrderBaseStoreCompanyDetails]

    name

    string

    registeredAddress

    string

    Additional properties are NOT allowed.

    contactInfo

    Expand all

    object [OrderBaseStoreContactInfo]

    phone

    string

    email

    string

    Additional properties are NOT allowed.

    coordinates

    Expand all

    object [OrderBaseStoreCoordinates]

    latitude

    string

    longitude

    string

    Additional properties are NOT allowed.

    lineOfBusiness

    string

    name

    string

    eposNumber

    string

    storeUrl

    string

    Additional properties are allowed.

    Additional properties are allowed.

    And of <anonymous-schema-239>:

    Expand all

    object

    Additional properties are allowed.

    Extensions

    x-envelope-type

    cloudevent

    Additional properties are allowed.

    • #order

    Examples

    Payload

    {
      "id": "string",
      "specversion": "1.0",
      "env": "local",
      "sourceService": "com.specsavers/order-service",
      "type": "com.specsavers.order.confirmed",
      "correlationid": "string",
      "subject": "string",
      "market": "GB",
      "datacontenttype": "application/json",
      "data": {
        "customer": {
          "id": "string",
          "title": "string",
          "firstName": "string",
          "middleName": "string",
          "lastName": "string",
          "dateOfBirth": "string",
          "gender": "string",
          "allowMarketing": true,
          "contactInfo": {
            "email": "string",
            "mobile": "string"
          },
          "cprNumber": "string",
          "personnummer": "string"
        },
        "order": {
          "id": "string",
          "createdAt": "2019-08-24T14:15:22Z",
          "createdBy": {
            "email": "string",
            "userType": "string"
          },
          "locale": "string",
          "number": "string",
          "invoice": {
            "id": "string",
            "fileName": "string",
            "createdAt": "2019-08-24T14:15:22Z",
            "lastUpdatedAt": "2019-08-24T14:15:22Z",
            "externalUrl": "string",
            "storageAccountName": "string",
            "storageContainerName": "string",
            "storagePath": "string"
          },
          "lineItems": [
            {
              "groupId": 0,
              "id": "string",
              "itemCategory": "string",
              "eye": "L",
              "name": "string",
              "number": "string",
              "groupNumber": "string",
              "quantity": 0,
              "sku": "string",
              "state": "string",
              "style": "string",
              "originalLineItem": {
                "groupId": 0,
                "id": "string",
                "itemCategory": "string",
                "eye": "L",
                "name": "string",
                "number": "string",
                "groupNumber": "string",
                "quantity": 0,
                "sku": "string",
                "state": "string",
                "style": "string"
              },
              "prescriptionKey": "string",
              "productDetails": {},
              "discount": {
                "key": "string",
                "discountCode": "string"
              },
              "price": {
                "currencyCode": "string",
                "centAmount": 0
              },
              "taxedPrice": {
                "totalNet": {
                  "currencyCode": "string",
                  "centAmount": 0
                },
                "totalGross": {
                  "currencyCode": "string",
                  "centAmount": 0
                },
                "taxPortions": [
                  {
                    "rate": 0,
                    "amount": {
                      "currencyCode": "string",
                      "centAmount": 0
                    },
                    "name": "string"
                  }
                ],
                "totalTax": {
                  "currencyCode": "string",
                  "centAmount": 0
                }
              },
              "taxRate": {
                "name": "string",
                "amount": 0,
                "includedInPrice": true,
                "country": "string",
                "subRates": [
                  {
                    "name": "string",
                    "amount": 0
                  }
                ]
              },
              "totalPrice": {
                "currencyCode": "string",
                "centAmount": 0
              },
              "unitPrice": {
                "currencyCode": "string",
                "centAmount": 0
              }
            }
          ],
          "lineItemGroups": [
            {
              "id": 0,
              "type": "string",
              "number": "string",
              "manufacturingData": {
                "requisitionRequestId": 0,
                "manufacturingData": "string",
                "frameAvailable": true,
                "orderType": "string",
                "errors": [
                  "string"
                ],
                "infos": [
                  "string"
                ],
                "warnings": [
                  "string"
                ]
              }
            }
          ],
          "orderState": "OPEN",
          "origin": "ONLINE",
          "soldBy": {
            "eposNumber": "string",
            "entity": "string",
            "marketId": "string"
          },
          "originalOrder": {
            "id": "string",
            "number": "string"
          },
          "subscription": {
            "id": "string",
            "interval": 0,
            "unit": "DAYS",
            "type": "PREPAY",
            "status": "ACTIVE",
            "instalments": [
              {
                "id": "string",
                "amount": {
                  "currencyCode": "string",
                  "centAmount": 0
                },
                "dueDate": "2019-08-24T14:15:22Z",
                "paidDate": {},
                "success": {}
              }
            ]
          },
          "type": "STANDARD",
          "billingAddress": {
            "id": "string",
            "title": "string",
            "firstName": "string",
            "lastName": "string",
            "line1": "string",
            "line2": "string",
            "line3": "string",
            "postalCode": "string",
            "city": "string",
            "state": "string",
            "country": "string",
            "phone": "string",
            "email": "string"
          },
          "payments": [
            {
              "id": "string",
              "merchantAccount": "string",
              "merchantReference": "string",
              "pspReference": "string",
              "status": "string",
              "transactions": [
                {
                  "id": "string",
                  "interactionId": "string",
                  "state": "string",
                  "pspReference": "string",
                  "type": "string",
                  "amount": {
                    "currencyCode": "string",
                    "centAmount": 0
                  },
                  "notes": "string"
                }
              ],
              "paymentInterface": "string",
              "method": "string",
              "name": "string",
              "amount": {
                "currencyCode": "string",
                "centAmount": 0
              }
            }
          ],
          "discounts": [
            {
              "key": "string",
              "id": "string",
              "isShippingDiscount": true,
              "type": "string",
              "name": "string",
              "amount": {
                "currencyCode": "string",
                "centAmount": 0
              }
            }
          ],
          "discountCodes": [
            "string"
          ],
          "discountSummary": [
            {
              "id": "string",
              "type": "string",
              "name": "string",
              "isShippingDiscount": true,
              "discountCode": "string",
              "amount": {
                "currencyCode": "string",
                "centAmount": 0
              }
            }
          ],
          "prescriptions": [
            {
              "key": "string",
              "type": "string",
              "date": "2019-08-24",
              "validFrom": "2019-08-24",
              "validUntil": "2019-08-24",
              "hasPrescription": true,
              "leftEye": {},
              "rightEye": {},
              "store": {
                "id": "string",
                "name": "string"
              },
              "externalPrescription": {
                "id": "string",
                "fileName": "string",
                "createdAt": "2019-08-24T14:15:22Z",
                "lastUpdatedAt": "2019-08-24T14:15:22Z",
                "storageAccountName": "string",
                "storageContainerName": "string",
                "storagePath": "string",
                "externalUrl": "string"
              }
            }
          ],
          "shippingAddress": {
            "id": "string",
            "title": "string",
            "firstName": "string",
            "lastName": "string",
            "line1": "string",
            "line2": "string",
            "line3": "string",
            "postalCode": "string",
            "city": "string",
            "state": "string",
            "country": "string",
            "phone": "string",
            "email": "string"
          },
          "shippingInfo": {
            "shippingMethodName": "string",
            "price": {
              "currencyCode": "string",
              "centAmount": 0
            },
            "shippingRate": {
              "price": {
                "currencyCode": "string",
                "centAmount": 0
              }
            },
            "taxRate": {
              "name": "string",
              "amount": 0,
              "includedInPrice": true,
              "country": "string",
              "subRates": [
                {
                  "name": "string",
                  "amount": 0
                }
              ]
            },
            "taxedPrice": {
              "totalNet": {
                "currencyCode": "string",
                "centAmount": 0
              },
              "totalGross": {
                "currencyCode": "string",
                "centAmount": 0
              },
              "taxPortions": [
                {
                  "rate": 0,
                  "amount": {
                    "currencyCode": "string",
                    "centAmount": 0
                  },
                  "name": "string"
                }
              ],
              "totalTax": {
                "currencyCode": "string",
                "centAmount": 0
              }
            }
          },
          "taxedPrice": {
            "totalNet": {
              "currencyCode": "string",
              "centAmount": 0
            },
            "totalGross": {
              "currencyCode": "string",
              "centAmount": 0
            },
            "taxPortions": [
              {
                "rate": 0,
                "amount": {
                  "currencyCode": "string",
                  "centAmount": 0
                },
                "name": "string"
              }
            ],
            "totalTax": {
              "currencyCode": "string",
              "centAmount": 0
            }
          },
          "taxedShippingPrice": {
            "totalNet": {
              "currencyCode": "string",
              "centAmount": 0
            },
            "totalGross": {
              "currencyCode": "string",
              "centAmount": 0
            },
            "taxPortions": [
              {
                "rate": 0,
                "amount": {
                  "currencyCode": "string",
                  "centAmount": 0
                },
                "name": "string"
              }
            ],
            "totalTax": {
              "currencyCode": "string",
              "centAmount": 0
            }
          },
          "subtotalPrice": {
            "currencyCode": "string",
            "centAmount": 0
          },
          "totalPrice": {
            "currencyCode": "string",
            "centAmount": 0
          },
          "lastModifiedAt": "2019-08-24T14:15:22Z",
          "isExpressReorder": true
        },
        "aftercareStore": {
          "address": {
            "city": "string",
            "country": "string",
            "line1": "string",
            "line2": "string",
            "line3": "string",
            "name": "string",
            "postcode": "string",
            "region": "string"
          },
          "companyDetails": {
            "name": "string",
            "registeredAddress": "string"
          },
          "contactInfo": {
            "phone": "string",
            "email": "string"
          },
          "coordinates": {
            "latitude": "string",
            "longitude": "string"
          },
          "lineOfBusiness": "string",
          "name": "string",
          "eposNumber": "string",
          "storeUrl": "string"
        }
      }
    }
    

    This example has been generated automatically.

  • #1

    • application/json

    Message IDOrderCreated

    Correlation ID$message.payload#/detail/correlationid

    Default Correlation ID

    The application will send new order paid events through this channel.

    Payload

    Expand all

    object

    id

    required

    string

    specversion

    required

    string

    Default value:"1.0"

    source

    required

    string

    time

    required

    string

    format: date-time

    type

    required

    string

    Const:"com.specsavers.order.created"

    correlationid

    required

    string

    The correlation ID of the event. E.g. 1234

    subject

    string

    market

    string

    Derived from locale i.e GB

    Default value:"GB"

    datacontenttype

    string

    Const:"application/json"

    data

    Expand all

    required

    allOf

    Consists of OrderEventBody:

    Expand all

    object [OrderEventBody]

    customer

    Expand all

    required

    object [OrderBaseCustomer]

    id

    required

    string

    title

    string

    firstName

    required

    string

    middleName

    string

    lastName

    required

    string

    dateOfBirth

    required

    string

    gender

    required

    string

    allowMarketing

    required

    boolean

    contactInfo

    Expand all

    required

    object [ContactInfo]

    email

    required

    string

    mobile

    string

    Additional properties are NOT allowed.

    cprNumber

    string

    personnummer

    string

    Additional properties are allowed.

    order

    Expand all

    required

    object [OrderEventBody]

    id

    required

    string

    createdAt

    required

    string

    format: date-time

    createdBy

    Expand all

    required

    object [CreatedBy]

    email

    string

    userType

    string

    Additional properties are allowed.

    locale

    required

    string

    number

    required

    string

    invoice

    Expand all

    object [InvoiceOrCreditNote]

    id

    required

    string

    fileName

    required

    string

    createdAt

    required

    string

    format: date-time

    lastUpdatedAt

    required

    string

    format: date-time

    externalUrl

    required

    string

    storageAccountName

    required

    string

    storageContainerName

    required

    string

    storagePath

    required

    string

    Additional properties are allowed.

    lineItems

    Expand all

    required

    array<allOf>

    Items:

    allOf

    Consists of BaseLineItemType:

    Expand all

    object allOf

    Consists of <anonymous-schema-43>:

    Expand all

    object

    groupId

    required

    number

    id

    required

    string

    itemCategory

    required

    string

    eye

    string

    Allowed values:
    • "L"
    • "R"
    • "LR"

    name

    required

    string

    number

    required

    string

    groupNumber

    required

    string

    quantity

    required

    number

    sku

    required

    string

    state

    string

    style

    string

    Additional properties are allowed.

    And of <anonymous-schema-55>:

    Expand all

    object

    originalLineItem

    Expand all

    allOf

    Consists of <anonymous-schema-43>:

    Expand all

    object

    groupId

    required

    number

    id

    required

    string

    itemCategory

    required

    string

    eye

    string

    Allowed values:
    • "L"
    • "R"
    • "LR"

    name

    required

    string

    number

    required

    string

    groupNumber

    required

    string

    quantity

    required

    number

    sku

    required

    string

    state

    string

    style

    string

    Additional properties are allowed.

    And of <anonymous-schema-57>:

    Expand all

    object

    Additional properties are allowed.

    Additional properties are allowed.

    Additional properties are allowed.

    And of <anonymous-schema-58>:

    Expand all

    object

    quantity

    required

    number

    prescriptionKey

    string

    productDetails

    Expand all

    object

    Additional properties are allowed.

    discount

    Expand all

    object [Discount]

    key

    string

    discountCode

    string

    Additional properties are allowed.

    price

    Expand all

    required

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    taxedPrice

    Expand all

    required

    object [BaseTaxedPriceType]

    totalNet

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    totalGross

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    taxPortions

    Expand all

    array<object [BaseTaxPortionType]>

    object [BaseTaxPortionType]

    rate

    number

    amount

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    name

    string

    Additional properties are NOT allowed.

    totalTax

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

    taxRate

    Expand all

    required

    object [BaseTaxRateType]

    name

    string

    amount

    number

    includedInPrice

    boolean

    country

    string

    subRates

    Expand all

    array<object [BaseTaxSubRateType]>

    object [BaseTaxSubRateType]

    name

    string

    amount

    number

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

    totalPrice

    Expand all

    required

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    unitPrice

    Expand all

    required

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    Additional properties are allowed.

    lineItemGroups

    Expand all

    required

    array<object [LineItemGroupType]>

    object [LineItemGroupType]

    id

    required

    number

    type

    required

    string

    number

    required

    string

    manufacturingData

    Expand all

    object [ManufacturingData]

    requisitionRequestId

    required

    number

    manufacturingData

    string

    frameAvailable

    required

    boolean

    orderType

    required

    string

    errors

    Expand all

    array<string> | null

    Items:

    string

    infos

    Expand all

    array<string> | null

    Items:

    string

    warnings

    Expand all

    array<string> | null

    Items:

    string

    Additional properties are allowed.

    Additional properties are allowed.

    orderState

    required

    string

    Allowed values:
    • "OPEN"
    • "COLLECTED"
    • "PROCESSING"
    • "CONFIRMED"
    • "BACK_ORDERED"
    • "COMPLETE"
    • "SHIPPED"
    • "CANCELLED"
    • "REMORSE"
    • "PENDING_RX_VALIDATION"
    • "PENDING_CANCELLATION"

    origin

    required

    string

    Allowed values:
    • "ONLINE"
    • "INSTORE"
    • "CUSTOMER_SERVICE"

    soldBy

    Expand all

    required

    object [SoldBy]

    eposNumber

    required

    string

    entity

    string

    marketId

    required

    string

    Additional properties are allowed.

    originalOrder

    Expand all

    object [OriginalOrder]

    id

    string

    number

    string

    Additional properties are NOT allowed.

    subscription

    Expand all

    object [BaseSubscription]

    uid: BaseSubscription

    id

    required

    string

    interval

    required

    number

    unit

    required

    string

    Allowed values:
    • "DAYS"
    • "WEEKS"
    • "MONTHS"

    type

    required

    string

    Allowed values:
    • "PREPAY"
    • "POSTPAY"
    • "RECURRING"

    status

    required

    string

    Allowed values:
    • "ACTIVE"
    • "PAUSED"
    • "EXPIRED"
    • "FAILED"
    • "FROZEN"
    • "CANCELLED"
    • "PENDING_CANCELLATION"

    instalments

    Expand all

    array<object [BaseInstalment]>

    object [BaseInstalment]

    id

    required

    string

    amount

    Expand all

    required

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    dueDate

    required

    string

    format: date-time

    paidDate

    Expand all

    oneOf

    Adheres to <anonymous-schema-117>:

    null

    Or to <anonymous-schema-118>:

    string

    format: date-time

    success

    Expand all

    oneOf

    Adheres to <anonymous-schema-120>:

    null

    Or to <anonymous-schema-121>:

    boolean

    Additional properties are allowed.

    Additional properties are allowed.

    type

    required

    string

    Allowed values:
    • "STANDARD"
    • "RECURRING"
    • "REPLACEMENT"
    • "REPAIR"
    • "REMAKE"

    billingAddress

    Expand all

    object [BaseAddress]

    id

    string

    title

    string

    firstName

    string

    lastName

    string

    line1

    string

    line2

    string

    line3

    string

    postalCode

    string

    city

    string

    state

    string

    country

    string

    phone

    string

    email

    string

    Additional properties are allowed.

    payments

    Expand all

    array<object [BasePaymentType]>

    object [BasePaymentType]

    id

    string

    merchantAccount

    string

    merchantReference

    string

    pspReference

    string

    status

    string

    transactions

    Expand all

    array<object [BasePaymentTransaction]>

    object [BasePaymentTransaction]

    id

    string

    interactionId

    string

    state

    string

    pspReference

    string

    type

    string

    amount

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    notes

    string

    Additional properties are allowed.

    paymentInterface

    string

    method

    string

    name

    string

    amount

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    Additional properties are allowed.

    discounts

    Expand all

    array<object [BaseDiscountType]>

    >= 0 items

    object [BaseDiscountType]

    key

    string

    id

    string

    isShippingDiscount

    boolean

    type

    string

    name

    string

    amount

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    Additional properties are allowed.

    discountCodes

    Expand all

    array<string>

    >= 0 items

    Items:

    string

    discountSummary

    Expand all

    array<object [DiscountSummary]>

    object [DiscountSummary]

    id

    required

    string

    type

    required

    string

    name

    required

    string

    isShippingDiscount

    required

    boolean

    discountCode

    string

    amount

    Expand all

    required

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

    prescriptions

    Expand all

    array<object [PrescriptionType]>

    >= 0 items

    object [PrescriptionType]

    key

    string

    type

    string

    date

    string

    format: date

    validFrom

    string

    format: date

    validUntil

    string

    format: date

    hasPrescription

    boolean

    leftEye

    Expand all

    oneOf

    Adheres to <anonymous-schema-180>:

    null

    Or to PrescriptionEyeType:

    Expand all

    object [PrescriptionEyeType]

    key

    required

    string

    add

    string

    addType

    string

    axis

    number

    baseCurve

    string

    cylinder

    string

    diameter

    string

    sphere

    string

    function

    string

    originalPupillaryDistance

    number

    adjustedPupillaryDistance

    number

    Additional properties are allowed.

    rightEye

    Expand all

    oneOf

    Adheres to <anonymous-schema-194>:

    null

    Or to PrescriptionEyeType:

    Expand all

    object [PrescriptionEyeType]

    key

    required

    string

    add

    string

    addType

    string

    axis

    number

    baseCurve

    string

    cylinder

    string

    diameter

    string

    sphere

    string

    function

    string

    originalPupillaryDistance

    number

    adjustedPupillaryDistance

    number

    Additional properties are allowed.

    store

    Expand all

    object [Store]

    id

    required

    string

    name

    required

    string

    Additional properties are allowed.

    externalPrescription

    Expand all

    object [ExternalPrescription]

    id

    required

    string

    fileName

    required

    string

    createdAt

    required

    string

    format: date-time

    lastUpdatedAt

    required

    string

    format: date-time

    storageAccountName

    required

    string

    storageContainerName

    required

    string

    storagePath

    required

    string

    externalUrl

    required

    string

    Additional properties are allowed.

    Additional properties are allowed.

    shippingAddress

    Expand all

    object [BaseAddress]

    id

    string

    title

    string

    firstName

    string

    lastName

    string

    line1

    string

    line2

    string

    line3

    string

    postalCode

    string

    city

    string

    state

    string

    country

    string

    phone

    string

    email

    string

    Additional properties are allowed.

    shippingInfo

    Expand all

    object [BaseShippingInfoType]

    shippingMethodName

    string

    price

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    shippingRate

    Expand all

    object [BaseShippingRateType]

    price

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

    taxRate

    Expand all

    object [BaseTaxRateType]

    name

    string

    amount

    number

    includedInPrice

    boolean

    country

    string

    subRates

    Expand all

    array<object [BaseTaxSubRateType]>

    object [BaseTaxSubRateType]

    name

    string

    amount

    number

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

    taxedPrice

    Expand all

    object [BaseTaxedPriceType]

    totalNet

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    totalGross

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    taxPortions

    Expand all

    array<object [BaseTaxPortionType]>

    object [BaseTaxPortionType]

    rate

    number

    amount

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    name

    string

    Additional properties are NOT allowed.

    totalTax

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

    taxedPrice

    Expand all

    required

    object [BaseTaxedPriceType]

    totalNet

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    totalGross

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    taxPortions

    Expand all

    array<object [BaseTaxPortionType]>

    object [BaseTaxPortionType]

    rate

    number

    amount

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    name

    string

    Additional properties are NOT allowed.

    totalTax

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

    taxedShippingPrice

    Expand all

    object [BaseTaxedPriceType]

    totalNet

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    totalGross

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    taxPortions

    Expand all

    array<object [BaseTaxPortionType]>

    object [BaseTaxPortionType]

    rate

    number

    amount

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    name

    string

    Additional properties are NOT allowed.

    totalTax

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

    subtotalPrice

    Expand all

    required

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    totalPrice

    Expand all

    required

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    lastModifiedAt

    string

    format: date-time

    isExpressReorder

    boolean

    Additional properties are allowed.

    aftercareStore

    Expand all

    object [OrderBaseStore]

    address

    Expand all

    object [OrderBaseStoreAddress]

    city

    string

    country

    string

    line1

    string

    line2

    string

    line3

    string

    name

    string

    postcode

    string

    region

    string

    Additional properties are NOT allowed.

    companyDetails

    Expand all

    object [OrderBaseStoreCompanyDetails]

    name

    string

    registeredAddress

    string

    Additional properties are NOT allowed.

    contactInfo

    Expand all

    object [OrderBaseStoreContactInfo]

    phone

    string

    email

    string

    Additional properties are NOT allowed.

    coordinates

    Expand all

    object [OrderBaseStoreCoordinates]

    latitude

    string

    longitude

    string

    Additional properties are NOT allowed.

    lineOfBusiness

    string

    name

    string

    eposNumber

    string

    storeUrl

    string

    Additional properties are allowed.

    Additional properties are allowed.

    And of <anonymous-schema-249>:

    Expand all

    object

    __meta

    Expand all

    required

    object [OrderBaseMeta]

    key

    required

    string

    language

    required

    string

    loginUrl

    required

    string

    logoUrl

    required

    string

    myAccountUrl

    required

    string

    contactUsUrl

    required

    string

    privacyPolicyUrl

    required

    string

    termsofPurchaseUrl

    required

    string

    legalPoliciesUrl

    required

    string

    name

    required

    string

    supportContactNumber

    required

    string

    supportEmailAddress

    required

    string

    Additional properties are allowed.

    Additional properties are allowed.

    Extensions

    x-envelope-type

    cloudevent

    Additional properties are allowed.

    • #order

    Examples

    Payload

    {
      "id": "string",
      "specversion": "1.0",
      "source": "string",
      "time": "2019-08-24T14:15:22Z",
      "type": "com.specsavers.order.created",
      "correlationid": "string",
      "subject": "string",
      "market": "GB",
      "datacontenttype": "application/json",
      "data": {
        "customer": {
          "id": "string",
          "title": "string",
          "firstName": "string",
          "middleName": "string",
          "lastName": "string",
          "dateOfBirth": "string",
          "gender": "string",
          "allowMarketing": true,
          "contactInfo": {
            "email": "string",
            "mobile": "string"
          },
          "cprNumber": "string",
          "personnummer": "string"
        },
        "order": {
          "id": "string",
          "createdAt": "2019-08-24T14:15:22Z",
          "createdBy": {
            "email": "string",
            "userType": "string"
          },
          "locale": "string",
          "number": "string",
          "invoice": {
            "id": "string",
            "fileName": "string",
            "createdAt": "2019-08-24T14:15:22Z",
            "lastUpdatedAt": "2019-08-24T14:15:22Z",
            "externalUrl": "string",
            "storageAccountName": "string",
            "storageContainerName": "string",
            "storagePath": "string"
          },
          "lineItems": [
            {
              "groupId": 0,
              "id": "string",
              "itemCategory": "string",
              "eye": "L",
              "name": "string",
              "number": "string",
              "groupNumber": "string",
              "quantity": 0,
              "sku": "string",
              "state": "string",
              "style": "string",
              "originalLineItem": {
                "groupId": 0,
                "id": "string",
                "itemCategory": "string",
                "eye": "L",
                "name": "string",
                "number": "string",
                "groupNumber": "string",
                "quantity": 0,
                "sku": "string",
                "state": "string",
                "style": "string"
              },
              "prescriptionKey": "string",
              "productDetails": {},
              "discount": {
                "key": "string",
                "discountCode": "string"
              },
              "price": {
                "currencyCode": "string",
                "centAmount": 0
              },
              "taxedPrice": {
                "totalNet": {
                  "currencyCode": "string",
                  "centAmount": 0
                },
                "totalGross": {
                  "currencyCode": "string",
                  "centAmount": 0
                },
                "taxPortions": [
                  {
                    "rate": 0,
                    "amount": {
                      "currencyCode": "string",
                      "centAmount": 0
                    },
                    "name": "string"
                  }
                ],
                "totalTax": {
                  "currencyCode": "string",
                  "centAmount": 0
                }
              },
              "taxRate": {
                "name": "string",
                "amount": 0,
                "includedInPrice": true,
                "country": "string",
                "subRates": [
                  {
                    "name": "string",
                    "amount": 0
                  }
                ]
              },
              "totalPrice": {
                "currencyCode": "string",
                "centAmount": 0
              },
              "unitPrice": {
                "currencyCode": "string",
                "centAmount": 0
              }
            }
          ],
          "lineItemGroups": [
            {
              "id": 0,
              "type": "string",
              "number": "string",
              "manufacturingData": {
                "requisitionRequestId": 0,
                "manufacturingData": "string",
                "frameAvailable": true,
                "orderType": "string",
                "errors": [
                  "string"
                ],
                "infos": [
                  "string"
                ],
                "warnings": [
                  "string"
                ]
              }
            }
          ],
          "orderState": "OPEN",
          "origin": "ONLINE",
          "soldBy": {
            "eposNumber": "string",
            "entity": "string",
            "marketId": "string"
          },
          "originalOrder": {
            "id": "string",
            "number": "string"
          },
          "subscription": {
            "id": "string",
            "interval": 0,
            "unit": "DAYS",
            "type": "PREPAY",
            "status": "ACTIVE",
            "instalments": [
              {
                "id": "string",
                "amount": {
                  "currencyCode": "string",
                  "centAmount": 0
                },
                "dueDate": "2019-08-24T14:15:22Z",
                "paidDate": {},
                "success": {}
              }
            ]
          },
          "type": "STANDARD",
          "billingAddress": {
            "id": "string",
            "title": "string",
            "firstName": "string",
            "lastName": "string",
            "line1": "string",
            "line2": "string",
            "line3": "string",
            "postalCode": "string",
            "city": "string",
            "state": "string",
            "country": "string",
            "phone": "string",
            "email": "string"
          },
          "payments": [
            {
              "id": "string",
              "merchantAccount": "string",
              "merchantReference": "string",
              "pspReference": "string",
              "status": "string",
              "transactions": [
                {
                  "id": "string",
                  "interactionId": "string",
                  "state": "string",
                  "pspReference": "string",
                  "type": "string",
                  "amount": {
                    "currencyCode": "string",
                    "centAmount": 0
                  },
                  "notes": "string"
                }
              ],
              "paymentInterface": "string",
              "method": "string",
              "name": "string",
              "amount": {
                "currencyCode": "string",
                "centAmount": 0
              }
            }
          ],
          "discounts": [
            {
              "key": "string",
              "id": "string",
              "isShippingDiscount": true,
              "type": "string",
              "name": "string",
              "amount": {
                "currencyCode": "string",
                "centAmount": 0
              }
            }
          ],
          "discountCodes": [
            "string"
          ],
          "discountSummary": [
            {
              "id": "string",
              "type": "string",
              "name": "string",
              "isShippingDiscount": true,
              "discountCode": "string",
              "amount": {
                "currencyCode": "string",
                "centAmount": 0
              }
            }
          ],
          "prescriptions": [
            {
              "key": "string",
              "type": "string",
              "date": "2019-08-24",
              "validFrom": "2019-08-24",
              "validUntil": "2019-08-24",
              "hasPrescription": true,
              "leftEye": {},
              "rightEye": {},
              "store": {
                "id": "string",
                "name": "string"
              },
              "externalPrescription": {
                "id": "string",
                "fileName": "string",
                "createdAt": "2019-08-24T14:15:22Z",
                "lastUpdatedAt": "2019-08-24T14:15:22Z",
                "storageAccountName": "string",
                "storageContainerName": "string",
                "storagePath": "string",
                "externalUrl": "string"
              }
            }
          ],
          "shippingAddress": {
            "id": "string",
            "title": "string",
            "firstName": "string",
            "lastName": "string",
            "line1": "string",
            "line2": "string",
            "line3": "string",
            "postalCode": "string",
            "city": "string",
            "state": "string",
            "country": "string",
            "phone": "string",
            "email": "string"
          },
          "shippingInfo": {
            "shippingMethodName": "string",
            "price": {
              "currencyCode": "string",
              "centAmount": 0
            },
            "shippingRate": {
              "price": {
                "currencyCode": "string",
                "centAmount": 0
              }
            },
            "taxRate": {
              "name": "string",
              "amount": 0,
              "includedInPrice": true,
              "country": "string",
              "subRates": [
                {
                  "name": "string",
                  "amount": 0
                }
              ]
            },
            "taxedPrice": {
              "totalNet": {
                "currencyCode": "string",
                "centAmount": 0
              },
              "totalGross": {
                "currencyCode": "string",
                "centAmount": 0
              },
              "taxPortions": [
                {
                  "rate": 0,
                  "amount": {
                    "currencyCode": "string",
                    "centAmount": 0
                  },
                  "name": "string"
                }
              ],
              "totalTax": {
                "currencyCode": "string",
                "centAmount": 0
              }
            }
          },
          "taxedPrice": {
            "totalNet": {
              "currencyCode": "string",
              "centAmount": 0
            },
            "totalGross": {
              "currencyCode": "string",
              "centAmount": 0
            },
            "taxPortions": [
              {
                "rate": 0,
                "amount": {
                  "currencyCode": "string",
                  "centAmount": 0
                },
                "name": "string"
              }
            ],
            "totalTax": {
              "currencyCode": "string",
              "centAmount": 0
            }
          },
          "taxedShippingPrice": {
            "totalNet": {
              "currencyCode": "string",
              "centAmount": 0
            },
            "totalGross": {
              "currencyCode": "string",
              "centAmount": 0
            },
            "taxPortions": [
              {
                "rate": 0,
                "amount": {
                  "currencyCode": "string",
                  "centAmount": 0
                },
                "name": "string"
              }
            ],
            "totalTax": {
              "currencyCode": "string",
              "centAmount": 0
            }
          },
          "subtotalPrice": {
            "currencyCode": "string",
            "centAmount": 0
          },
          "totalPrice": {
            "currencyCode": "string",
            "centAmount": 0
          },
          "lastModifiedAt": "2019-08-24T14:15:22Z",
          "isExpressReorder": true
        },
        "aftercareStore": {
          "address": {
            "city": "string",
            "country": "string",
            "line1": "string",
            "line2": "string",
            "line3": "string",
            "name": "string",
            "postcode": "string",
            "region": "string"
          },
          "companyDetails": {
            "name": "string",
            "registeredAddress": "string"
          },
          "contactInfo": {
            "phone": "string",
            "email": "string"
          },
          "coordinates": {
            "latitude": "string",
            "longitude": "string"
          },
          "lineOfBusiness": "string",
          "name": "string",
          "eposNumber": "string",
          "storeUrl": "string"
        },
        "__meta": {
          "key": "string",
          "language": "string",
          "loginUrl": "string",
          "logoUrl": "string",
          "myAccountUrl": "string",
          "contactUsUrl": "string",
          "privacyPolicyUrl": "string",
          "termsofPurchaseUrl": "string",
          "legalPoliciesUrl": "string",
          "name": "string",
          "supportContactNumber": "string",
          "supportEmailAddress": "string"
        }
      }
    }
    

    This example has been generated automatically.

  • #2

    • application/json

    Message IDUpcomingOrderCreated

    Correlation ID$message.payload#/detail/correlationid

    Default Correlation ID

    The application will send new upcoming order(i.e recurring order) created events through this channel.

    Payload

    Expand all

    object

    id

    required

    string

    specversion

    required

    string

    Default value:"1.0"

    env

    string

    The environment from which the event originated from e.g. dev, prod

    Allowed values:
    • "local"
    • "dev"
    • "qa"
    • "qa2"
    • "stg"
    • "prod"

    sourceService

    string

    Const:"com.specsavers/order-service"

    type

    required

    string

    Const:"com.specsavers.upcoming.order.created"

    correlationid

    string

    The correlation ID of the event. E.g. 1234

    subject

    string

    market

    string

    Derived from locale i.e GB

    Default value:"GB"

    datacontenttype

    string

    Const:"application/json"

    data

    Expand all

    required

    allOf

    Consists of UpcomingOrderEventBody:

    Expand all

    object [UpcomingOrderEventBody]

    customer

    Expand all

    required

    object [OrderBaseCustomer]

    id

    required

    string

    title

    string

    firstName

    required

    string

    middleName

    string

    lastName

    required

    string

    dateOfBirth

    required

    string

    gender

    required

    string

    allowMarketing

    required

    boolean

    contactInfo

    Expand all

    required

    object [ContactInfo]

    email

    required

    string

    mobile

    string

    Additional properties are NOT allowed.

    cprNumber

    string

    personnummer

    string

    Additional properties are allowed.

    order

    Expand all

    required

    object [UpcomingOrderEventBody]

    id

    required

    string

    createdAt

    required

    string

    format: date-time

    createdBy

    Expand all

    required

    object [CreatedBy]

    email

    string

    userType

    string

    Additional properties are allowed.

    locale

    required

    string

    number

    required

    string

    lineItems

    Expand all

    required

    array<allOf>

    Items:

    allOf

    Consists of BaseLineItemType:

    Expand all

    object allOf

    Consists of <anonymous-schema-43>:

    Expand all

    object

    groupId

    required

    number

    id

    required

    string

    itemCategory

    required

    string

    eye

    string

    Allowed values:
    • "L"
    • "R"
    • "LR"

    name

    required

    string

    number

    required

    string

    groupNumber

    required

    string

    quantity

    required

    number

    sku

    required

    string

    state

    string

    style

    string

    Additional properties are allowed.

    And of <anonymous-schema-55>:

    Expand all

    object

    originalLineItem

    Expand all

    allOf

    Consists of <anonymous-schema-43>:

    Expand all

    object

    groupId

    required

    number

    id

    required

    string

    itemCategory

    required

    string

    eye

    string

    Allowed values:
    • "L"
    • "R"
    • "LR"

    name

    required

    string

    number

    required

    string

    groupNumber

    required

    string

    quantity

    required

    number

    sku

    required

    string

    state

    string

    style

    string

    Additional properties are allowed.

    And of <anonymous-schema-57>:

    Expand all

    object

    Additional properties are allowed.

    Additional properties are allowed.

    Additional properties are allowed.

    And of <anonymous-schema-58>:

    Expand all

    object

    quantity

    required

    number

    prescriptionKey

    string

    productDetails

    Expand all

    object

    Additional properties are allowed.

    discount

    Expand all

    object [Discount]

    key

    string

    discountCode

    string

    Additional properties are allowed.

    price

    Expand all

    required

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    taxedPrice

    Expand all

    required

    object [BaseTaxedPriceType]

    totalNet

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    totalGross

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    taxPortions

    Expand all

    array<object [BaseTaxPortionType]>

    object [BaseTaxPortionType]

    rate

    number

    amount

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    name

    string

    Additional properties are NOT allowed.

    totalTax

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

    taxRate

    Expand all

    required

    object [BaseTaxRateType]

    name

    string

    amount

    number

    includedInPrice

    boolean

    country

    string

    subRates

    Expand all

    array<object [BaseTaxSubRateType]>

    object [BaseTaxSubRateType]

    name

    string

    amount

    number

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

    totalPrice

    Expand all

    required

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    unitPrice

    Expand all

    required

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    Additional properties are allowed.

    lineItemGroups

    Expand all

    required

    array<object [LineItemGroupType]>

    object [LineItemGroupType]

    id

    required

    number

    type

    required

    string

    number

    required

    string

    manufacturingData

    Expand all

    object [ManufacturingData]

    requisitionRequestId

    required

    number

    manufacturingData

    string

    frameAvailable

    required

    boolean

    orderType

    required

    string

    errors

    Expand all

    array<string> | null

    Items:

    string

    infos

    Expand all

    array<string> | null

    Items:

    string

    warnings

    Expand all

    array<string> | null

    Items:

    string

    Additional properties are allowed.

    Additional properties are allowed.

    orderState

    required

    string

    Allowed values:
    • "OPEN"
    • "COLLECTED"
    • "PROCESSING"
    • "CONFIRMED"
    • "BACK_ORDERED"
    • "COMPLETE"
    • "SHIPPED"
    • "CANCELLED"
    • "REMORSE"
    • "PENDING_RX_VALIDATION"
    • "PENDING_CANCELLATION"

    origin

    required

    string

    Allowed values:
    • "ONLINE"
    • "INSTORE"
    • "CUSTOMER_SERVICE"

    soldBy

    Expand all

    required

    object [SoldBy]

    eposNumber

    required

    string

    entity

    string

    marketId

    required

    string

    Additional properties are allowed.

    originalOrder

    Expand all

    object [OriginalOrder]

    id

    string

    number

    string

    Additional properties are NOT allowed.

    subscription

    Expand all

    object [BaseSubscription]

    uid: BaseSubscription

    id

    required

    string

    interval

    required

    number

    unit

    required

    string

    Allowed values:
    • "DAYS"
    • "WEEKS"
    • "MONTHS"

    type

    required

    string

    Allowed values:
    • "PREPAY"
    • "POSTPAY"
    • "RECURRING"

    status

    required

    string

    Allowed values:
    • "ACTIVE"
    • "PAUSED"
    • "EXPIRED"
    • "FAILED"
    • "FROZEN"
    • "CANCELLED"
    • "PENDING_CANCELLATION"

    instalments

    Expand all

    array<object [BaseInstalment]>

    object [BaseInstalment]

    id

    required

    string

    amount

    Expand all

    required

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    dueDate

    required

    string

    format: date-time

    paidDate

    Expand all

    oneOf

    Adheres to <anonymous-schema-117>:

    null

    Or to <anonymous-schema-118>:

    string

    format: date-time

    success

    Expand all

    oneOf

    Adheres to <anonymous-schema-120>:

    null

    Or to <anonymous-schema-121>:

    boolean

    Additional properties are allowed.

    Additional properties are allowed.

    type

    required

    string

    Allowed values:
    • "STANDARD"
    • "RECURRING"
    • "REPLACEMENT"
    • "REPAIR"
    • "REMAKE"

    billingAddress

    Expand all

    object [BaseAddress]

    id

    string

    title

    string

    firstName

    string

    lastName

    string

    line1

    string

    line2

    string

    line3

    string

    postalCode

    string

    city

    string

    state

    string

    country

    string

    phone

    string

    email

    string

    Additional properties are allowed.

    payments

    Expand all

    array<object [BasePaymentType]>

    object [BasePaymentType]

    id

    string

    merchantAccount

    string

    merchantReference

    string

    pspReference

    string

    status

    string

    transactions

    Expand all

    array<object [BasePaymentTransaction]>

    object [BasePaymentTransaction]

    id

    string

    interactionId

    string

    state

    string

    pspReference

    string

    type

    string

    amount

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    notes

    string

    Additional properties are allowed.

    paymentInterface

    string

    method

    string

    name

    string

    amount

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    Additional properties are allowed.

    discounts

    Expand all

    array<object [BaseDiscountType]>

    >= 0 items

    object [BaseDiscountType]

    key

    string

    id

    string

    isShippingDiscount

    boolean

    type

    string

    name

    string

    amount

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    Additional properties are allowed.

    discountCodes

    Expand all

    array<string>

    >= 0 items

    Items:

    string

    discountSummary

    Expand all

    array<object [DiscountSummary]>

    object [DiscountSummary]

    id

    required

    string

    type

    required

    string

    name

    required

    string

    isShippingDiscount

    required

    boolean

    discountCode

    string

    amount

    Expand all

    required

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

    prescriptions

    Expand all

    array<object [PrescriptionType]>

    >= 0 items

    object [PrescriptionType]

    key

    string

    type

    string

    date

    string

    format: date

    validFrom

    string

    format: date

    validUntil

    string

    format: date

    hasPrescription

    boolean

    leftEye

    Expand all

    oneOf

    Adheres to <anonymous-schema-180>:

    null

    Or to PrescriptionEyeType:

    Expand all

    object [PrescriptionEyeType]

    key

    required

    string

    add

    string

    addType

    string

    axis

    number

    baseCurve

    string

    cylinder

    string

    diameter

    string

    sphere

    string

    function

    string

    originalPupillaryDistance

    number

    adjustedPupillaryDistance

    number

    Additional properties are allowed.

    rightEye

    Expand all

    oneOf

    Adheres to <anonymous-schema-194>:

    null

    Or to PrescriptionEyeType:

    Expand all

    object [PrescriptionEyeType]

    key

    required

    string

    add

    string

    addType

    string

    axis

    number

    baseCurve

    string

    cylinder

    string

    diameter

    string

    sphere

    string

    function

    string

    originalPupillaryDistance

    number

    adjustedPupillaryDistance

    number

    Additional properties are allowed.

    store

    Expand all

    object [Store]

    id

    required

    string

    name

    required

    string

    Additional properties are allowed.

    externalPrescription

    Expand all

    object [ExternalPrescription]

    id

    required

    string

    fileName

    required

    string

    createdAt

    required

    string

    format: date-time

    lastUpdatedAt

    required

    string

    format: date-time

    storageAccountName

    required

    string

    storageContainerName

    required

    string

    storagePath

    required

    string

    externalUrl

    required

    string

    Additional properties are allowed.

    Additional properties are allowed.

    shippingAddress

    Expand all

    object [BaseAddress]

    id

    string

    title

    string

    firstName

    string

    lastName

    string

    line1

    string

    line2

    string

    line3

    string

    postalCode

    string

    city

    string

    state

    string

    country

    string

    phone

    string

    email

    string

    Additional properties are allowed.

    shippingInfo

    Expand all

    object [BaseShippingInfoType]

    shippingMethodName

    string

    price

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    shippingRate

    Expand all

    object [BaseShippingRateType]

    price

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

    taxRate

    Expand all

    object [BaseTaxRateType]

    name

    string

    amount

    number

    includedInPrice

    boolean

    country

    string

    subRates

    Expand all

    array<object [BaseTaxSubRateType]>

    object [BaseTaxSubRateType]

    name

    string

    amount

    number

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

    taxedPrice

    Expand all

    object [BaseTaxedPriceType]

    totalNet

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    totalGross

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    taxPortions

    Expand all

    array<object [BaseTaxPortionType]>

    object [BaseTaxPortionType]

    rate

    number

    amount

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    name

    string

    Additional properties are NOT allowed.

    totalTax

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

    taxedPrice

    Expand all

    required

    object [BaseTaxedPriceType]

    totalNet

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    totalGross

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    taxPortions

    Expand all

    array<object [BaseTaxPortionType]>

    object [BaseTaxPortionType]

    rate

    number

    amount

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    name

    string

    Additional properties are NOT allowed.

    totalTax

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

    taxedShippingPrice

    Expand all

    object [BaseTaxedPriceType]

    totalNet

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    totalGross

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    taxPortions

    Expand all

    array<object [BaseTaxPortionType]>

    object [BaseTaxPortionType]

    rate

    number

    amount

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    name

    string

    Additional properties are NOT allowed.

    totalTax

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

    subtotalPrice

    Expand all

    required

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    totalPrice

    Expand all

    required

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    lastModifiedAt

    string

    format: date-time

    isExpressReorder

    boolean

    Additional properties are allowed.

    aftercareStore

    Expand all

    object [OrderBaseStore]

    address

    Expand all

    object [OrderBaseStoreAddress]

    city

    string

    country

    string

    line1

    string

    line2

    string

    line3

    string

    name

    string

    postcode

    string

    region

    string

    Additional properties are NOT allowed.

    companyDetails

    Expand all

    object [OrderBaseStoreCompanyDetails]

    name

    string

    registeredAddress

    string

    Additional properties are NOT allowed.

    contactInfo

    Expand all

    object [OrderBaseStoreContactInfo]

    phone

    string

    email

    string

    Additional properties are NOT allowed.

    coordinates

    Expand all

    object [OrderBaseStoreCoordinates]

    latitude

    string

    longitude

    string

    Additional properties are NOT allowed.

    lineOfBusiness

    string

    name

    string

    eposNumber

    string

    storeUrl

    string

    Additional properties are allowed.

    Additional properties are allowed.

    And of <anonymous-schema-302>:

    Expand all

    object

    __meta

    Expand all

    required

    object [OrderBaseMeta]

    key

    required

    string

    language

    required

    string

    loginUrl

    required

    string

    logoUrl

    required

    string

    myAccountUrl

    required

    string

    contactUsUrl

    required

    string

    privacyPolicyUrl

    required

    string

    termsofPurchaseUrl

    required

    string

    legalPoliciesUrl

    required

    string

    name

    required

    string

    supportContactNumber

    required

    string

    supportEmailAddress

    required

    string

    Additional properties are allowed.

    Additional properties are allowed.

    Extensions

    x-envelope-type

    cloudevent

    Additional properties are allowed.

    • #order

    Examples

    Payload

    {
      "id": "string",
      "specversion": "1.0",
      "env": "local",
      "sourceService": "com.specsavers/order-service",
      "type": "com.specsavers.upcoming.order.created",
      "correlationid": "string",
      "subject": "string",
      "market": "GB",
      "datacontenttype": "application/json",
      "data": {
        "customer": {
          "id": "string",
          "title": "string",
          "firstName": "string",
          "middleName": "string",
          "lastName": "string",
          "dateOfBirth": "string",
          "gender": "string",
          "allowMarketing": true,
          "contactInfo": {
            "email": "string",
            "mobile": "string"
          },
          "cprNumber": "string",
          "personnummer": "string"
        },
        "order": {
          "id": "string",
          "createdAt": "2019-08-24T14:15:22Z",
          "createdBy": {
            "email": "string",
            "userType": "string"
          },
          "locale": "string",
          "number": "string",
          "lineItems": [
            {
              "groupId": 0,
              "id": "string",
              "itemCategory": "string",
              "eye": "L",
              "name": "string",
              "number": "string",
              "groupNumber": "string",
              "quantity": 0,
              "sku": "string",
              "state": "string",
              "style": "string",
              "originalLineItem": {
                "groupId": 0,
                "id": "string",
                "itemCategory": "string",
                "eye": "L",
                "name": "string",
                "number": "string",
                "groupNumber": "string",
                "quantity": 0,
                "sku": "string",
                "state": "string",
                "style": "string"
              },
              "prescriptionKey": "string",
              "productDetails": {},
              "discount": {
                "key": "string",
                "discountCode": "string"
              },
              "price": {
                "currencyCode": "string",
                "centAmount": 0
              },
              "taxedPrice": {
                "totalNet": {
                  "currencyCode": "string",
                  "centAmount": 0
                },
                "totalGross": {
                  "currencyCode": "string",
                  "centAmount": 0
                },
                "taxPortions": [
                  {
                    "rate": 0,
                    "amount": {
                      "currencyCode": "string",
                      "centAmount": 0
                    },
                    "name": "string"
                  }
                ],
                "totalTax": {
                  "currencyCode": "string",
                  "centAmount": 0
                }
              },
              "taxRate": {
                "name": "string",
                "amount": 0,
                "includedInPrice": true,
                "country": "string",
                "subRates": [
                  {
                    "name": "string",
                    "amount": 0
                  }
                ]
              },
              "totalPrice": {
                "currencyCode": "string",
                "centAmount": 0
              },
              "unitPrice": {
                "currencyCode": "string",
                "centAmount": 0
              }
            }
          ],
          "lineItemGroups": [
            {
              "id": 0,
              "type": "string",
              "number": "string",
              "manufacturingData": {
                "requisitionRequestId": 0,
                "manufacturingData": "string",
                "frameAvailable": true,
                "orderType": "string",
                "errors": [
                  "string"
                ],
                "infos": [
                  "string"
                ],
                "warnings": [
                  "string"
                ]
              }
            }
          ],
          "orderState": "OPEN",
          "origin": "ONLINE",
          "soldBy": {
            "eposNumber": "string",
            "entity": "string",
            "marketId": "string"
          },
          "originalOrder": {
            "id": "string",
            "number": "string"
          },
          "subscription": {
            "id": "string",
            "interval": 0,
            "unit": "DAYS",
            "type": "PREPAY",
            "status": "ACTIVE",
            "instalments": [
              {
                "id": "string",
                "amount": {
                  "currencyCode": "string",
                  "centAmount": 0
                },
                "dueDate": "2019-08-24T14:15:22Z",
                "paidDate": {},
                "success": {}
              }
            ]
          },
          "type": "STANDARD",
          "billingAddress": {
            "id": "string",
            "title": "string",
            "firstName": "string",
            "lastName": "string",
            "line1": "string",
            "line2": "string",
            "line3": "string",
            "postalCode": "string",
            "city": "string",
            "state": "string",
            "country": "string",
            "phone": "string",
            "email": "string"
          },
          "payments": [
            {
              "id": "string",
              "merchantAccount": "string",
              "merchantReference": "string",
              "pspReference": "string",
              "status": "string",
              "transactions": [
                {
                  "id": "string",
                  "interactionId": "string",
                  "state": "string",
                  "pspReference": "string",
                  "type": "string",
                  "amount": {
                    "currencyCode": "string",
                    "centAmount": 0
                  },
                  "notes": "string"
                }
              ],
              "paymentInterface": "string",
              "method": "string",
              "name": "string",
              "amount": {
                "currencyCode": "string",
                "centAmount": 0
              }
            }
          ],
          "discounts": [
            {
              "key": "string",
              "id": "string",
              "isShippingDiscount": true,
              "type": "string",
              "name": "string",
              "amount": {
                "currencyCode": "string",
                "centAmount": 0
              }
            }
          ],
          "discountCodes": [
            "string"
          ],
          "discountSummary": [
            {
              "id": "string",
              "type": "string",
              "name": "string",
              "isShippingDiscount": true,
              "discountCode": "string",
              "amount": {
                "currencyCode": "string",
                "centAmount": 0
              }
            }
          ],
          "prescriptions": [
            {
              "key": "string",
              "type": "string",
              "date": "2019-08-24",
              "validFrom": "2019-08-24",
              "validUntil": "2019-08-24",
              "hasPrescription": true,
              "leftEye": {},
              "rightEye": {},
              "store": {
                "id": "string",
                "name": "string"
              },
              "externalPrescription": {
                "id": "string",
                "fileName": "string",
                "createdAt": "2019-08-24T14:15:22Z",
                "lastUpdatedAt": "2019-08-24T14:15:22Z",
                "storageAccountName": "string",
                "storageContainerName": "string",
                "storagePath": "string",
                "externalUrl": "string"
              }
            }
          ],
          "shippingAddress": {
            "id": "string",
            "title": "string",
            "firstName": "string",
            "lastName": "string",
            "line1": "string",
            "line2": "string",
            "line3": "string",
            "postalCode": "string",
            "city": "string",
            "state": "string",
            "country": "string",
            "phone": "string",
            "email": "string"
          },
          "shippingInfo": {
            "shippingMethodName": "string",
            "price": {
              "currencyCode": "string",
              "centAmount": 0
            },
            "shippingRate": {
              "price": {
                "currencyCode": "string",
                "centAmount": 0
              }
            },
            "taxRate": {
              "name": "string",
              "amount": 0,
              "includedInPrice": true,
              "country": "string",
              "subRates": [
                {
                  "name": "string",
                  "amount": 0
                }
              ]
            },
            "taxedPrice": {
              "totalNet": {
                "currencyCode": "string",
                "centAmount": 0
              },
              "totalGross": {
                "currencyCode": "string",
                "centAmount": 0
              },
              "taxPortions": [
                {
                  "rate": 0,
                  "amount": {
                    "currencyCode": "string",
                    "centAmount": 0
                  },
                  "name": "string"
                }
              ],
              "totalTax": {
                "currencyCode": "string",
                "centAmount": 0
              }
            }
          },
          "taxedPrice": {
            "totalNet": {
              "currencyCode": "string",
              "centAmount": 0
            },
            "totalGross": {
              "currencyCode": "string",
              "centAmount": 0
            },
            "taxPortions": [
              {
                "rate": 0,
                "amount": {
                  "currencyCode": "string",
                  "centAmount": 0
                },
                "name": "string"
              }
            ],
            "totalTax": {
              "currencyCode": "string",
              "centAmount": 0
            }
          },
          "taxedShippingPrice": {
            "totalNet": {
              "currencyCode": "string",
              "centAmount": 0
            },
            "totalGross": {
              "currencyCode": "string",
              "centAmount": 0
            },
            "taxPortions": [
              {
                "rate": 0,
                "amount": {
                  "currencyCode": "string",
                  "centAmount": 0
                },
                "name": "string"
              }
            ],
            "totalTax": {
              "currencyCode": "string",
              "centAmount": 0
            }
          },
          "subtotalPrice": {
            "currencyCode": "string",
            "centAmount": 0
          },
          "totalPrice": {
            "currencyCode": "string",
            "centAmount": 0
          },
          "lastModifiedAt": "2019-08-24T14:15:22Z",
          "isExpressReorder": true
        },
        "aftercareStore": {
          "address": {
            "city": "string",
            "country": "string",
            "line1": "string",
            "line2": "string",
            "line3": "string",
            "name": "string",
            "postcode": "string",
            "region": "string"
          },
          "companyDetails": {
            "name": "string",
            "registeredAddress": "string"
          },
          "contactInfo": {
            "phone": "string",
            "email": "string"
          },
          "coordinates": {
            "latitude": "string",
            "longitude": "string"
          },
          "lineOfBusiness": "string",
          "name": "string",
          "eposNumber": "string",
          "storeUrl": "string"
        },
        "__meta": {
          "key": "string",
          "language": "string",
          "loginUrl": "string",
          "logoUrl": "string",
          "myAccountUrl": "string",
          "contactUsUrl": "string",
          "privacyPolicyUrl": "string",
          "termsofPurchaseUrl": "string",
          "legalPoliciesUrl": "string",
          "name": "string",
          "supportContactNumber": "string",
          "supportEmailAddress": "string"
        }
      }
    }
    

    This example has been generated automatically.

  • #3

    • application/json

    Message IDRtpOrderCreated

    Correlation ID$message.payload#/detail/correlationid

    Default Correlation ID

    The application will send new order rtp internal invoice created events through this channel.

    Payload

    Expand all

    object

    id

    required

    string

    specversion

    required

    string

    Default value:"1.0"

    env

    string

    The environment from which the event originated from e.g. dev, prod

    Allowed values:
    • "local"
    • "dev"
    • "qa"
    • "qa2"
    • "stg"
    • "prod"

    sourceService

    string

    Const:"com.specsavers/order-service"

    type

    required

    string

    Const:"com.specsavers.rtp.order.created"

    correlationid

    string

    The correlation ID of the event. E.g. 1234

    subject

    string

    market

    string

    Derived from locale i.e GB

    Default value:"GB"

    datacontenttype

    string

    Const:"application/json"

    data

    Expand all

    required

    object [RtpOrderCreatedData]

    order

    Expand all

    required

    object [order]

    id

    required

    string

    Additional properties are NOT allowed.

    Additional properties are allowed.

    Extensions

    x-envelope-type

    cloudevent

    Additional properties are allowed.

    • #order

    Examples

    Payload

    {
      "id": "string",
      "specversion": "1.0",
      "env": "local",
      "sourceService": "com.specsavers/order-service",
      "type": "com.specsavers.rtp.order.created",
      "correlationid": "string",
      "subject": "string",
      "market": "GB",
      "datacontenttype": "application/json",
      "data": {
        "order": {
          "id": "string"
        }
      }
    }
    

    This example has been generated automatically.

  • #4

    • application/json

    Message IDRtpOrderCancelled

    Correlation ID$message.payload#/detail/correlationid

    Default Correlation ID

    The application will send RTP order cancelled events through this channel.

    Payload

    Expand all

    object

    id

    required

    string

    specversion

    required

    string

    Default value:"1.0"

    env

    required

    string

    The environment from which the event originated from e.g. dev, prod

    Allowed values:
    • "local"
    • "dev"
    • "qa"
    • "qa2"
    • "stg"
    • "prod"

    sourceService

    string

    Const:"com.specsavers/order-service"

    type

    required

    string

    Const:"com.specsavers.rtp.order.cancelled"

    correlationid

    required

    string

    The correlation ID of the event. E.g. 1234

    data

    Expand all

    required

    object

    orderNumber

    required

    string

    The order number

    Additional properties are NOT allowed.

    Extensions

    x-envelope-type

    cloudevent

    Additional properties are allowed.

    • #order

    Examples

    Payload

    {
      "id": "string",
      "specversion": "1.0",
      "env": "local",
      "sourceService": "com.specsavers/order-service",
      "type": "com.specsavers.rtp.order.cancelled",
      "correlationid": "string",
      "data": {
        "orderNumber": "string"
      }
    }
    

    This example has been generated automatically.

  • #5

    • application/json

    Message IDRtpSubscriptionUpdated

    Correlation ID$message.payload#/detail/correlationid

    Default Correlation ID

    The application will send new subscription rtp updated events through this channel.

    Payload

    Expand all

    object

    id

    required

    string

    specversion

    required

    string

    Default value:"1.0"

    env

    string

    The environment from which the event originated from e.g. dev, prod

    Allowed values:
    • "local"
    • "dev"
    • "qa"
    • "qa2"
    • "stg"
    • "prod"

    sourceService

    string

    Const:"com.specsavers/order-service"

    type

    required

    string

    Const:"com.specsavers.rtp.subscription.updated"

    correlationid

    string

    The correlation ID of the event. E.g. 1234

    subject

    string

    market

    string

    Derived from locale i.e GB

    Default value:"GB"

    datacontenttype

    string

    Const:"application/json"

    data

    Expand all

    required

    object [RtpSubscriptionUpdatedData]

    recurringOrder

    Expand all

    required

    object [recurringOrder]

    id

    required

    string

    Additional properties are NOT allowed.

    Additional properties are allowed.

    Extensions

    x-envelope-type

    cloudevent

    Additional properties are allowed.

    • #order

    Examples

    Payload

    {
      "id": "string",
      "specversion": "1.0",
      "env": "local",
      "sourceService": "com.specsavers/order-service",
      "type": "com.specsavers.rtp.subscription.updated",
      "correlationid": "string",
      "subject": "string",
      "market": "GB",
      "datacontenttype": "application/json",
      "data": {
        "recurringOrder": {
          "id": "string"
        }
      }
    }
    

    This example has been generated automatically.

  • #6

    • application/json

    Message IDRtpRemorseCompleted

    Correlation ID$message.payload#/detail/correlationid

    Default Correlation ID

    The application will send new order rtp internal remorse completed events through this channel.

    Payload

    Expand all

    object

    id

    required

    string

    specversion

    required

    string

    Default value:"1.0"

    env

    string

    The environment from which the event originated from e.g. dev, prod

    Allowed values:
    • "local"
    • "dev"
    • "qa"
    • "qa2"
    • "stg"
    • "prod"

    sourceService

    string

    Const:"com.specsavers/order-service"

    type

    required

    string

    Const:"com.specsavers.rtp.remorse.completed"

    correlationid

    string

    The correlation ID of the event. E.g. 1234

    subject

    string

    market

    string

    Derived from locale i.e GB

    Default value:"GB"

    datacontenttype

    string

    Const:"application/json"

    data

    Expand all

    required

    object [RtpRemorseCompletedData]

    order

    Expand all

    required

    object [order]

    id

    required

    string

    Additional properties are NOT allowed.

    Additional properties are allowed.

    Extensions

    x-envelope-type

    cloudevent

    Additional properties are allowed.

    • #order

    Examples

    Payload

    {
      "id": "string",
      "specversion": "1.0",
      "env": "local",
      "sourceService": "com.specsavers/order-service",
      "type": "com.specsavers.rtp.remorse.completed",
      "correlationid": "string",
      "subject": "string",
      "market": "GB",
      "datacontenttype": "application/json",
      "data": {
        "order": {
          "id": "string"
        }
      }
    }
    

    This example has been generated automatically.

  • #7

    • application/json

    Message IDPaymentCaptured

    Correlation ID$message.payload#/detail/correlationid

    Default Correlation ID

    The application will send new payment captured events through this channel.

    Payload

    Expand all

    object

    id

    required

    string

    specversion

    required

    string

    Default value:"1.0"

    env

    string

    The environment from which the event originated from e.g. dev, prod

    Allowed values:
    • "local"
    • "dev"
    • "qa"
    • "qa2"
    • "stg"
    • "prod"

    sourceService

    string

    Const:"com.specsavers/order-service"

    type

    required

    string

    Const:"com.specsavers.payment.captured"

    correlationid

    string

    The correlation ID of the event. E.g. 1234

    subject

    string

    market

    string

    Derived from locale i.e GB

    Default value:"GB"

    datacontenttype

    string

    Const:"application/json"

    data

    Expand all

    required

    object [PaymentStatusData]

    customer

    Expand all

    required

    object [OrderBaseCustomer]

    id

    required

    string

    title

    string

    firstName

    required

    string

    middleName

    string

    lastName

    required

    string

    dateOfBirth

    required

    string

    gender

    required

    string

    allowMarketing

    required

    boolean

    contactInfo

    Expand all

    required

    object [ContactInfo]

    email

    required

    string

    mobile

    string

    Additional properties are NOT allowed.

    cprNumber

    string

    personnummer

    string

    Additional properties are allowed.

    order

    Expand all

    required

    object [PaymentStatusChangeOrder]

    uid: PaymentStatusChangeOrder

    id

    required

    string

    locale

    required

    string

    number

    required

    string

    originalOrder

    Expand all

    object [OriginalOrder]

    id

    string

    number

    string

    Additional properties are NOT allowed.

    orderState

    required

    string

    Allowed values:
    • "OPEN"
    • "COLLECTED"
    • "PROCESSING"
    • "CONFIRMED"
    • "BACK_ORDERED"
    • "COMPLETE"
    • "SHIPPED"
    • "CANCELLED"
    • "REMORSE"
    • "PENDING_RX_VALIDATION"
    • "PENDING_CANCELLATION"

    subscription

    Expand all

    object [BaseSubscription]

    uid: BaseSubscription

    id

    required

    string

    interval

    required

    number

    unit

    required

    string

    Allowed values:
    • "DAYS"
    • "WEEKS"
    • "MONTHS"

    type

    required

    string

    Allowed values:
    • "PREPAY"
    • "POSTPAY"
    • "RECURRING"

    status

    required

    string

    Allowed values:
    • "ACTIVE"
    • "PAUSED"
    • "EXPIRED"
    • "FAILED"
    • "FROZEN"
    • "CANCELLED"
    • "PENDING_CANCELLATION"

    instalments

    Expand all

    array<object [BaseInstalment]>

    object [BaseInstalment]

    id

    required

    string

    amount

    Expand all

    required

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    dueDate

    required

    string

    format: date-time

    paidDate

    Expand all

    oneOf

    Adheres to <anonymous-schema-117>:

    null

    Or to <anonymous-schema-118>:

    string

    format: date-time

    success

    Expand all

    oneOf

    Adheres to <anonymous-schema-120>:

    null

    Or to <anonymous-schema-121>:

    boolean

    Additional properties are allowed.

    Additional properties are allowed.

    lineItems

    Expand all

    required

    array<allOf>

    Items:

    allOf

    Consists of BaseLineItemType:

    Expand all

    object allOf

    Consists of <anonymous-schema-43>:

    Expand all

    object

    groupId

    required

    number

    id

    required

    string

    itemCategory

    required

    string

    eye

    string

    Allowed values:
    • "L"
    • "R"
    • "LR"

    name

    required

    string

    number

    required

    string

    groupNumber

    required

    string

    quantity

    required

    number

    sku

    required

    string

    state

    string

    style

    string

    Additional properties are allowed.

    And of <anonymous-schema-55>:

    Expand all

    object

    originalLineItem

    Expand all

    allOf

    Consists of <anonymous-schema-43>:

    Expand all

    object

    groupId

    required

    number

    id

    required

    string

    itemCategory

    required

    string

    eye

    string

    Allowed values:
    • "L"
    • "R"
    • "LR"

    name

    required

    string

    number

    required

    string

    groupNumber

    required

    string

    quantity

    required

    number

    sku

    required

    string

    state

    string

    style

    string

    Additional properties are allowed.

    And of <anonymous-schema-57>:

    Expand all

    object

    Additional properties are allowed.

    Additional properties are allowed.

    Additional properties are allowed.

    And of <anonymous-schema-351>:

    Expand all

    object

    eye

    string

    quantity

    required

    number

    price

    Expand all

    required

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    totalPrice

    Expand all

    required

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    taxRate

    Expand all

    required

    object [BaseTaxRateType]

    name

    string

    amount

    number

    includedInPrice

    boolean

    country

    string

    subRates

    Expand all

    array<object [BaseTaxSubRateType]>

    object [BaseTaxSubRateType]

    name

    string

    amount

    number

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

    taxedPrice

    Expand all

    required

    object [BaseTaxedPriceType]

    totalNet

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    totalGross

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    taxPortions

    Expand all

    array<object [BaseTaxPortionType]>

    object [BaseTaxPortionType]

    rate

    number

    amount

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    name

    string

    Additional properties are NOT allowed.

    totalTax

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

    unitPrice

    Expand all

    required

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    Additional properties are allowed.

    billingAddress

    Expand all

    object [BaseAddress]

    id

    string

    title

    string

    firstName

    string

    lastName

    string

    line1

    string

    line2

    string

    line3

    string

    postalCode

    string

    city

    string

    state

    string

    country

    string

    phone

    string

    email

    string

    Additional properties are allowed.

    payment

    Expand all

    object [Payment]

    id

    string

    merchantAccount

    string

    merchantReference

    string

    pspReference

    string

    status

    string

    transaction

    Expand all

    object [BasePaymentTransaction]

    id

    string

    interactionId

    string

    state

    string

    pspReference

    string

    type

    string

    amount

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    notes

    string

    Additional properties are allowed.

    paymentInterface

    string

    method

    string

    name

    string

    amount

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    Additional properties are allowed.

    originalPayments

    Expand all

    array<object [Payment]>

    object [Payment]

    id

    string

    merchantAccount

    string

    merchantReference

    string

    pspReference

    string

    status

    string

    transaction

    Expand all

    object [BasePaymentTransaction]

    id

    string

    interactionId

    string

    state

    string

    pspReference

    string

    type

    string

    amount

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    notes

    string

    Additional properties are allowed.

    paymentInterface

    string

    method

    string

    name

    string

    amount

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    Additional properties are allowed.

    refundPayment

    Expand all

    object [Payment]

    id

    string

    merchantAccount

    string

    merchantReference

    string

    pspReference

    string

    status

    string

    transaction

    Expand all

    object [BasePaymentTransaction]

    id

    string

    interactionId

    string

    state

    string

    pspReference

    string

    type

    string

    amount

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    notes

    string

    Additional properties are allowed.

    paymentInterface

    string

    method

    string

    name

    string

    amount

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    Additional properties are allowed.

    totalRefundAmount

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    subtotalPrice

    Expand all

    required

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    totalPrice

    Expand all

    required

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    type

    required

    string

    Allowed values:
    • "STANDARD"
    • "RECURRING"
    • "REPLACEMENT"
    • "REPAIR"
    • "REMAKE"

    creditNote

    Expand all

    object [InvoiceOrCreditNote]

    id

    required

    string

    fileName

    required

    string

    createdAt

    required

    string

    format: date-time

    lastUpdatedAt

    required

    string

    format: date-time

    externalUrl

    required

    string

    storageAccountName

    required

    string

    storageContainerName

    required

    string

    storagePath

    required

    string

    Additional properties are allowed.

    Additional properties are allowed.

    aftercareStore

    Expand all

    object [OrderBaseStore]

    address

    Expand all

    object [OrderBaseStoreAddress]

    city

    string

    country

    string

    line1

    string

    line2

    string

    line3

    string

    name

    string

    postcode

    string

    region

    string

    Additional properties are NOT allowed.

    companyDetails

    Expand all

    object [OrderBaseStoreCompanyDetails]

    name

    string

    registeredAddress

    string

    Additional properties are NOT allowed.

    contactInfo

    Expand all

    object [OrderBaseStoreContactInfo]

    phone

    string

    email

    string

    Additional properties are NOT allowed.

    coordinates

    Expand all

    object [OrderBaseStoreCoordinates]

    latitude

    string

    longitude

    string

    Additional properties are NOT allowed.

    lineOfBusiness

    string

    name

    string

    eposNumber

    string

    storeUrl

    string

    Additional properties are allowed.

    __meta

    Expand all

    required

    object [OrderBaseMeta]

    key

    required

    string

    language

    required

    string

    loginUrl

    required

    string

    logoUrl

    required

    string

    myAccountUrl

    required

    string

    contactUsUrl

    required

    string

    privacyPolicyUrl

    required

    string

    termsofPurchaseUrl

    required

    string

    legalPoliciesUrl

    required

    string

    name

    required

    string

    supportContactNumber

    required

    string

    supportEmailAddress

    required

    string

    Additional properties are allowed.

    Additional properties are allowed.

    Extensions

    x-envelope-type

    cloudevent

    Additional properties are allowed.

    • #order

    Examples

    Payload

    {
      "id": "string",
      "specversion": "1.0",
      "env": "local",
      "sourceService": "com.specsavers/order-service",
      "type": "com.specsavers.payment.captured",
      "correlationid": "string",
      "subject": "string",
      "market": "GB",
      "datacontenttype": "application/json",
      "data": {
        "customer": {
          "id": "string",
          "title": "string",
          "firstName": "string",
          "middleName": "string",
          "lastName": "string",
          "dateOfBirth": "string",
          "gender": "string",
          "allowMarketing": true,
          "contactInfo": {
            "email": "string",
            "mobile": "string"
          },
          "cprNumber": "string",
          "personnummer": "string"
        },
        "order": {
          "id": "string",
          "locale": "string",
          "number": "string",
          "originalOrder": {
            "id": "string",
            "number": "string"
          },
          "orderState": "OPEN",
          "subscription": {
            "id": "string",
            "interval": 0,
            "unit": "DAYS",
            "type": "PREPAY",
            "status": "ACTIVE",
            "instalments": [
              {
                "id": "string",
                "amount": {
                  "currencyCode": "string",
                  "centAmount": 0
                },
                "dueDate": "2019-08-24T14:15:22Z",
                "paidDate": {},
                "success": {}
              }
            ]
          },
          "lineItems": [
            {
              "groupId": 0,
              "id": "string",
              "itemCategory": "string",
              "eye": "string",
              "name": "string",
              "number": "string",
              "groupNumber": "string",
              "quantity": 0,
              "sku": "string",
              "state": "string",
              "style": "string",
              "originalLineItem": {
                "groupId": 0,
                "id": "string",
                "itemCategory": "string",
                "eye": "L",
                "name": "string",
                "number": "string",
                "groupNumber": "string",
                "quantity": 0,
                "sku": "string",
                "state": "string",
                "style": "string"
              },
              "price": {
                "currencyCode": "string",
                "centAmount": 0
              },
              "totalPrice": {
                "currencyCode": "string",
                "centAmount": 0
              },
              "taxRate": {
                "name": "string",
                "amount": 0,
                "includedInPrice": true,
                "country": "string",
                "subRates": [
                  {
                    "name": "string",
                    "amount": 0
                  }
                ]
              },
              "taxedPrice": {
                "totalNet": {
                  "currencyCode": "string",
                  "centAmount": 0
                },
                "totalGross": {
                  "currencyCode": "string",
                  "centAmount": 0
                },
                "taxPortions": [
                  {
                    "rate": 0,
                    "amount": {
                      "currencyCode": "string",
                      "centAmount": 0
                    },
                    "name": "string"
                  }
                ],
                "totalTax": {
                  "currencyCode": "string",
                  "centAmount": 0
                }
              },
              "unitPrice": {
                "currencyCode": "string",
                "centAmount": 0
              }
            }
          ],
          "billingAddress": {
            "id": "string",
            "title": "string",
            "firstName": "string",
            "lastName": "string",
            "line1": "string",
            "line2": "string",
            "line3": "string",
            "postalCode": "string",
            "city": "string",
            "state": "string",
            "country": "string",
            "phone": "string",
            "email": "string"
          },
          "payment": {
            "id": "string",
            "merchantAccount": "string",
            "merchantReference": "string",
            "pspReference": "string",
            "status": "string",
            "transaction": {
              "id": "string",
              "interactionId": "string",
              "state": "string",
              "pspReference": "string",
              "type": "string",
              "amount": {
                "currencyCode": "string",
                "centAmount": 0
              },
              "notes": "string"
            },
            "paymentInterface": "string",
            "method": "string",
            "name": "string",
            "amount": {
              "currencyCode": "string",
              "centAmount": 0
            }
          },
          "originalPayments": [
            {
              "id": "string",
              "merchantAccount": "string",
              "merchantReference": "string",
              "pspReference": "string",
              "status": "string",
              "transaction": {
                "id": "string",
                "interactionId": "string",
                "state": "string",
                "pspReference": "string",
                "type": "string",
                "amount": {
                  "currencyCode": "string",
                  "centAmount": 0
                },
                "notes": "string"
              },
              "paymentInterface": "string",
              "method": "string",
              "name": "string",
              "amount": {
                "currencyCode": "string",
                "centAmount": 0
              }
            }
          ],
          "refundPayment": {
            "id": "string",
            "merchantAccount": "string",
            "merchantReference": "string",
            "pspReference": "string",
            "status": "string",
            "transaction": {
              "id": "string",
              "interactionId": "string",
              "state": "string",
              "pspReference": "string",
              "type": "string",
              "amount": {
                "currencyCode": "string",
                "centAmount": 0
              },
              "notes": "string"
            },
            "paymentInterface": "string",
            "method": "string",
            "name": "string",
            "amount": {
              "currencyCode": "string",
              "centAmount": 0
            }
          },
          "totalRefundAmount": {
            "currencyCode": "string",
            "centAmount": 0
          },
          "subtotalPrice": {
            "currencyCode": "string",
            "centAmount": 0
          },
          "totalPrice": {
            "currencyCode": "string",
            "centAmount": 0
          },
          "type": "STANDARD",
          "creditNote": {
            "id": "string",
            "fileName": "string",
            "createdAt": "2019-08-24T14:15:22Z",
            "lastUpdatedAt": "2019-08-24T14:15:22Z",
            "externalUrl": "string",
            "storageAccountName": "string",
            "storageContainerName": "string",
            "storagePath": "string"
          }
        },
        "aftercareStore": {
          "address": {
            "city": "string",
            "country": "string",
            "line1": "string",
            "line2": "string",
            "line3": "string",
            "name": "string",
            "postcode": "string",
            "region": "string"
          },
          "companyDetails": {
            "name": "string",
            "registeredAddress": "string"
          },
          "contactInfo": {
            "phone": "string",
            "email": "string"
          },
          "coordinates": {
            "latitude": "string",
            "longitude": "string"
          },
          "lineOfBusiness": "string",
          "name": "string",
          "eposNumber": "string",
          "storeUrl": "string"
        },
        "__meta": {
          "key": "string",
          "language": "string",
          "loginUrl": "string",
          "logoUrl": "string",
          "myAccountUrl": "string",
          "contactUsUrl": "string",
          "privacyPolicyUrl": "string",
          "termsofPurchaseUrl": "string",
          "legalPoliciesUrl": "string",
          "name": "string",
          "supportContactNumber": "string",
          "supportEmailAddress": "string"
        }
      }
    }
    

    This example has been generated automatically.

  • #8

    • application/json

    Message IDPaymentFailed

    Correlation ID$message.payload#/detail/correlationid

    Default Correlation ID

    The application will send new payment failed events through this channel.

    Payload

    Expand all

    object

    id

    required

    string

    specversion

    required

    string

    Default value:"1.0"

    env

    string

    The environment from which the event originated from e.g. dev, prod

    Allowed values:
    • "local"
    • "dev"
    • "qa"
    • "qa2"
    • "stg"
    • "prod"

    sourceService

    string

    Const:"com.specsavers/order-service"

    type

    required

    string

    Const:"com.specsavers.payment.failed"

    correlationid

    string

    The correlation ID of the event. E.g. 1234

    subject

    string

    market

    string

    Derived from locale i.e GB

    Default value:"GB"

    datacontenttype

    string

    Const:"application/json"

    data

    Expand all

    required

    object [PaymentStatusData]

    customer

    Expand all

    required

    object [OrderBaseCustomer]

    id

    required

    string

    title

    string

    firstName

    required

    string

    middleName

    string

    lastName

    required

    string

    dateOfBirth

    required

    string

    gender

    required

    string

    allowMarketing

    required

    boolean

    contactInfo

    Expand all

    required

    object [ContactInfo]

    email

    required

    string

    mobile

    string

    Additional properties are NOT allowed.

    cprNumber

    string

    personnummer

    string

    Additional properties are allowed.

    order

    Expand all

    required

    object [PaymentStatusChangeOrder]

    uid: PaymentStatusChangeOrder

    id

    required

    string

    locale

    required

    string

    number

    required

    string

    originalOrder

    Expand all

    object [OriginalOrder]

    id

    string

    number

    string

    Additional properties are NOT allowed.

    orderState

    required

    string

    Allowed values:
    • "OPEN"
    • "COLLECTED"
    • "PROCESSING"
    • "CONFIRMED"
    • "BACK_ORDERED"
    • "COMPLETE"
    • "SHIPPED"
    • "CANCELLED"
    • "REMORSE"
    • "PENDING_RX_VALIDATION"
    • "PENDING_CANCELLATION"

    subscription

    Expand all

    object [BaseSubscription]

    uid: BaseSubscription

    id

    required

    string

    interval

    required

    number

    unit

    required

    string

    Allowed values:
    • "DAYS"
    • "WEEKS"
    • "MONTHS"

    type

    required

    string

    Allowed values:
    • "PREPAY"
    • "POSTPAY"
    • "RECURRING"

    status

    required

    string

    Allowed values:
    • "ACTIVE"
    • "PAUSED"
    • "EXPIRED"
    • "FAILED"
    • "FROZEN"
    • "CANCELLED"
    • "PENDING_CANCELLATION"

    instalments

    Expand all

    array<object [BaseInstalment]>

    object [BaseInstalment]

    id

    required

    string

    amount

    Expand all

    required

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    dueDate

    required

    string

    format: date-time

    paidDate

    Expand all

    oneOf

    Adheres to <anonymous-schema-117>:

    null

    Or to <anonymous-schema-118>:

    string

    format: date-time

    success

    Expand all

    oneOf

    Adheres to <anonymous-schema-120>:

    null

    Or to <anonymous-schema-121>:

    boolean

    Additional properties are allowed.

    Additional properties are allowed.

    lineItems

    Expand all

    required

    array<allOf>

    Items:

    allOf

    Consists of BaseLineItemType:

    Expand all

    object allOf

    Consists of <anonymous-schema-43>:

    Expand all

    object

    groupId

    required

    number

    id

    required

    string

    itemCategory

    required

    string

    eye

    string

    Allowed values:
    • "L"
    • "R"
    • "LR"

    name

    required

    string

    number

    required

    string

    groupNumber

    required

    string

    quantity

    required

    number

    sku

    required

    string

    state

    string

    style

    string

    Additional properties are allowed.

    And of <anonymous-schema-55>:

    Expand all

    object

    originalLineItem

    Expand all

    allOf

    Consists of <anonymous-schema-43>:

    Expand all

    object

    groupId

    required

    number

    id

    required

    string

    itemCategory

    required

    string

    eye

    string

    Allowed values:
    • "L"
    • "R"
    • "LR"

    name

    required

    string

    number

    required

    string

    groupNumber

    required

    string

    quantity

    required

    number

    sku

    required

    string

    state

    string

    style

    string

    Additional properties are allowed.

    And of <anonymous-schema-57>:

    Expand all

    object

    Additional properties are allowed.

    Additional properties are allowed.

    Additional properties are allowed.

    And of <anonymous-schema-351>:

    Expand all

    object

    eye

    string

    quantity

    required

    number

    price

    Expand all

    required

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    totalPrice

    Expand all

    required

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    taxRate

    Expand all

    required

    object [BaseTaxRateType]

    name

    string

    amount

    number

    includedInPrice

    boolean

    country

    string

    subRates

    Expand all

    array<object [BaseTaxSubRateType]>

    object [BaseTaxSubRateType]

    name

    string

    amount

    number

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

    taxedPrice

    Expand all

    required

    object [BaseTaxedPriceType]

    totalNet

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    totalGross

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    taxPortions

    Expand all

    array<object [BaseTaxPortionType]>

    object [BaseTaxPortionType]

    rate

    number

    amount

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    name

    string

    Additional properties are NOT allowed.

    totalTax

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

    unitPrice

    Expand all

    required

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    Additional properties are allowed.

    billingAddress

    Expand all

    object [BaseAddress]

    id

    string

    title

    string

    firstName

    string

    lastName

    string

    line1

    string

    line2

    string

    line3

    string

    postalCode

    string

    city

    string

    state

    string

    country

    string

    phone

    string

    email

    string

    Additional properties are allowed.

    payment

    Expand all

    object [Payment]

    id

    string

    merchantAccount

    string

    merchantReference

    string

    pspReference

    string

    status

    string

    transaction

    Expand all

    object [BasePaymentTransaction]

    id

    string

    interactionId

    string

    state

    string

    pspReference

    string

    type

    string

    amount

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    notes

    string

    Additional properties are allowed.

    paymentInterface

    string

    method

    string

    name

    string

    amount

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    Additional properties are allowed.

    originalPayments

    Expand all

    array<object [Payment]>

    object [Payment]

    id

    string

    merchantAccount

    string

    merchantReference

    string

    pspReference

    string

    status

    string

    transaction

    Expand all

    object [BasePaymentTransaction]

    id

    string

    interactionId

    string

    state

    string

    pspReference

    string

    type

    string

    amount

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    notes

    string

    Additional properties are allowed.

    paymentInterface

    string

    method

    string

    name

    string

    amount

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    Additional properties are allowed.

    refundPayment

    Expand all

    object [Payment]

    id

    string

    merchantAccount

    string

    merchantReference

    string

    pspReference

    string

    status

    string

    transaction

    Expand all

    object [BasePaymentTransaction]

    id

    string

    interactionId

    string

    state

    string

    pspReference

    string

    type

    string

    amount

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    notes

    string

    Additional properties are allowed.

    paymentInterface

    string

    method

    string

    name

    string

    amount

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    Additional properties are allowed.

    totalRefundAmount

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    subtotalPrice

    Expand all

    required

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    totalPrice

    Expand all

    required

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    type

    required

    string

    Allowed values:
    • "STANDARD"
    • "RECURRING"
    • "REPLACEMENT"
    • "REPAIR"
    • "REMAKE"

    creditNote

    Expand all

    object [InvoiceOrCreditNote]

    id

    required

    string

    fileName

    required

    string

    createdAt

    required

    string

    format: date-time

    lastUpdatedAt

    required

    string

    format: date-time

    externalUrl

    required

    string

    storageAccountName

    required

    string

    storageContainerName

    required

    string

    storagePath

    required

    string

    Additional properties are allowed.

    Additional properties are allowed.

    aftercareStore

    Expand all

    object [OrderBaseStore]

    address

    Expand all

    object [OrderBaseStoreAddress]

    city

    string

    country

    string

    line1

    string

    line2

    string

    line3

    string

    name

    string

    postcode

    string

    region

    string

    Additional properties are NOT allowed.

    companyDetails

    Expand all

    object [OrderBaseStoreCompanyDetails]

    name

    string

    registeredAddress

    string

    Additional properties are NOT allowed.

    contactInfo

    Expand all

    object [OrderBaseStoreContactInfo]

    phone

    string

    email

    string

    Additional properties are NOT allowed.

    coordinates

    Expand all

    object [OrderBaseStoreCoordinates]

    latitude

    string

    longitude

    string

    Additional properties are NOT allowed.

    lineOfBusiness

    string

    name

    string

    eposNumber

    string

    storeUrl

    string

    Additional properties are allowed.

    __meta

    Expand all

    required

    object [OrderBaseMeta]

    key

    required

    string

    language

    required

    string

    loginUrl

    required

    string

    logoUrl

    required

    string

    myAccountUrl

    required

    string

    contactUsUrl

    required

    string

    privacyPolicyUrl

    required

    string

    termsofPurchaseUrl

    required

    string

    legalPoliciesUrl

    required

    string

    name

    required

    string

    supportContactNumber

    required

    string

    supportEmailAddress

    required

    string

    Additional properties are allowed.

    Additional properties are allowed.

    Extensions

    x-envelope-type

    cloudevent

    Additional properties are allowed.

    • #order

    Examples

    Payload

    {
      "id": "string",
      "specversion": "1.0",
      "env": "local",
      "sourceService": "com.specsavers/order-service",
      "type": "com.specsavers.payment.failed",
      "correlationid": "string",
      "subject": "string",
      "market": "GB",
      "datacontenttype": "application/json",
      "data": {
        "customer": {
          "id": "string",
          "title": "string",
          "firstName": "string",
          "middleName": "string",
          "lastName": "string",
          "dateOfBirth": "string",
          "gender": "string",
          "allowMarketing": true,
          "contactInfo": {
            "email": "string",
            "mobile": "string"
          },
          "cprNumber": "string",
          "personnummer": "string"
        },
        "order": {
          "id": "string",
          "locale": "string",
          "number": "string",
          "originalOrder": {
            "id": "string",
            "number": "string"
          },
          "orderState": "OPEN",
          "subscription": {
            "id": "string",
            "interval": 0,
            "unit": "DAYS",
            "type": "PREPAY",
            "status": "ACTIVE",
            "instalments": [
              {
                "id": "string",
                "amount": {
                  "currencyCode": "string",
                  "centAmount": 0
                },
                "dueDate": "2019-08-24T14:15:22Z",
                "paidDate": {},
                "success": {}
              }
            ]
          },
          "lineItems": [
            {
              "groupId": 0,
              "id": "string",
              "itemCategory": "string",
              "eye": "string",
              "name": "string",
              "number": "string",
              "groupNumber": "string",
              "quantity": 0,
              "sku": "string",
              "state": "string",
              "style": "string",
              "originalLineItem": {
                "groupId": 0,
                "id": "string",
                "itemCategory": "string",
                "eye": "L",
                "name": "string",
                "number": "string",
                "groupNumber": "string",
                "quantity": 0,
                "sku": "string",
                "state": "string",
                "style": "string"
              },
              "price": {
                "currencyCode": "string",
                "centAmount": 0
              },
              "totalPrice": {
                "currencyCode": "string",
                "centAmount": 0
              },
              "taxRate": {
                "name": "string",
                "amount": 0,
                "includedInPrice": true,
                "country": "string",
                "subRates": [
                  {
                    "name": "string",
                    "amount": 0
                  }
                ]
              },
              "taxedPrice": {
                "totalNet": {
                  "currencyCode": "string",
                  "centAmount": 0
                },
                "totalGross": {
                  "currencyCode": "string",
                  "centAmount": 0
                },
                "taxPortions": [
                  {
                    "rate": 0,
                    "amount": {
                      "currencyCode": "string",
                      "centAmount": 0
                    },
                    "name": "string"
                  }
                ],
                "totalTax": {
                  "currencyCode": "string",
                  "centAmount": 0
                }
              },
              "unitPrice": {
                "currencyCode": "string",
                "centAmount": 0
              }
            }
          ],
          "billingAddress": {
            "id": "string",
            "title": "string",
            "firstName": "string",
            "lastName": "string",
            "line1": "string",
            "line2": "string",
            "line3": "string",
            "postalCode": "string",
            "city": "string",
            "state": "string",
            "country": "string",
            "phone": "string",
            "email": "string"
          },
          "payment": {
            "id": "string",
            "merchantAccount": "string",
            "merchantReference": "string",
            "pspReference": "string",
            "status": "string",
            "transaction": {
              "id": "string",
              "interactionId": "string",
              "state": "string",
              "pspReference": "string",
              "type": "string",
              "amount": {
                "currencyCode": "string",
                "centAmount": 0
              },
              "notes": "string"
            },
            "paymentInterface": "string",
            "method": "string",
            "name": "string",
            "amount": {
              "currencyCode": "string",
              "centAmount": 0
            }
          },
          "originalPayments": [
            {
              "id": "string",
              "merchantAccount": "string",
              "merchantReference": "string",
              "pspReference": "string",
              "status": "string",
              "transaction": {
                "id": "string",
                "interactionId": "string",
                "state": "string",
                "pspReference": "string",
                "type": "string",
                "amount": {
                  "currencyCode": "string",
                  "centAmount": 0
                },
                "notes": "string"
              },
              "paymentInterface": "string",
              "method": "string",
              "name": "string",
              "amount": {
                "currencyCode": "string",
                "centAmount": 0
              }
            }
          ],
          "refundPayment": {
            "id": "string",
            "merchantAccount": "string",
            "merchantReference": "string",
            "pspReference": "string",
            "status": "string",
            "transaction": {
              "id": "string",
              "interactionId": "string",
              "state": "string",
              "pspReference": "string",
              "type": "string",
              "amount": {
                "currencyCode": "string",
                "centAmount": 0
              },
              "notes": "string"
            },
            "paymentInterface": "string",
            "method": "string",
            "name": "string",
            "amount": {
              "currencyCode": "string",
              "centAmount": 0
            }
          },
          "totalRefundAmount": {
            "currencyCode": "string",
            "centAmount": 0
          },
          "subtotalPrice": {
            "currencyCode": "string",
            "centAmount": 0
          },
          "totalPrice": {
            "currencyCode": "string",
            "centAmount": 0
          },
          "type": "STANDARD",
          "creditNote": {
            "id": "string",
            "fileName": "string",
            "createdAt": "2019-08-24T14:15:22Z",
            "lastUpdatedAt": "2019-08-24T14:15:22Z",
            "externalUrl": "string",
            "storageAccountName": "string",
            "storageContainerName": "string",
            "storagePath": "string"
          }
        },
        "aftercareStore": {
          "address": {
            "city": "string",
            "country": "string",
            "line1": "string",
            "line2": "string",
            "line3": "string",
            "name": "string",
            "postcode": "string",
            "region": "string"
          },
          "companyDetails": {
            "name": "string",
            "registeredAddress": "string"
          },
          "contactInfo": {
            "phone": "string",
            "email": "string"
          },
          "coordinates": {
            "latitude": "string",
            "longitude": "string"
          },
          "lineOfBusiness": "string",
          "name": "string",
          "eposNumber": "string",
          "storeUrl": "string"
        },
        "__meta": {
          "key": "string",
          "language": "string",
          "loginUrl": "string",
          "logoUrl": "string",
          "myAccountUrl": "string",
          "contactUsUrl": "string",
          "privacyPolicyUrl": "string",
          "termsofPurchaseUrl": "string",
          "legalPoliciesUrl": "string",
          "name": "string",
          "supportContactNumber": "string",
          "supportEmailAddress": "string"
        }
      }
    }
    

    This example has been generated automatically.

  • #9

    • application/json

    Message IDPaymentRefunded

    Correlation ID$message.payload#/detail/correlationid

    Default Correlation ID

    The application will send new payment refunded events through this channel.

    Payload

    Expand all

    object

    id

    required

    string

    specversion

    required

    string

    Default value:"1.0"

    env

    string

    The environment from which the event originated from e.g. dev, prod

    Allowed values:
    • "local"
    • "dev"
    • "qa"
    • "qa2"
    • "stg"
    • "prod"

    sourceService

    string

    Const:"com.specsavers/order-service"

    type

    required

    string

    Const:"com.specsavers.payment.refunded"

    correlationid

    string

    The correlation ID of the event. E.g. 1234

    subject

    string

    market

    string

    Derived from locale i.e GB

    Default value:"GB"

    datacontenttype

    string

    Const:"application/json"

    data

    Expand all

    required

    object [PaymentStatusData]

    customer

    Expand all

    required

    object [OrderBaseCustomer]

    id

    required

    string

    title

    string

    firstName

    required

    string

    middleName

    string

    lastName

    required

    string

    dateOfBirth

    required

    string

    gender

    required

    string

    allowMarketing

    required

    boolean

    contactInfo

    Expand all

    required

    object [ContactInfo]

    email

    required

    string

    mobile

    string

    Additional properties are NOT allowed.

    cprNumber

    string

    personnummer

    string

    Additional properties are allowed.

    order

    Expand all

    required

    object [PaymentStatusChangeOrder]

    uid: PaymentStatusChangeOrder

    id

    required

    string

    locale

    required

    string

    number

    required

    string

    originalOrder

    Expand all

    object [OriginalOrder]

    id

    string

    number

    string

    Additional properties are NOT allowed.

    orderState

    required

    string

    Allowed values:
    • "OPEN"
    • "COLLECTED"
    • "PROCESSING"
    • "CONFIRMED"
    • "BACK_ORDERED"
    • "COMPLETE"
    • "SHIPPED"
    • "CANCELLED"
    • "REMORSE"
    • "PENDING_RX_VALIDATION"
    • "PENDING_CANCELLATION"

    subscription

    Expand all

    object [BaseSubscription]

    uid: BaseSubscription

    id

    required

    string

    interval

    required

    number

    unit

    required

    string

    Allowed values:
    • "DAYS"
    • "WEEKS"
    • "MONTHS"

    type

    required

    string

    Allowed values:
    • "PREPAY"
    • "POSTPAY"
    • "RECURRING"

    status

    required

    string

    Allowed values:
    • "ACTIVE"
    • "PAUSED"
    • "EXPIRED"
    • "FAILED"
    • "FROZEN"
    • "CANCELLED"
    • "PENDING_CANCELLATION"

    instalments

    Expand all

    array<object [BaseInstalment]>

    object [BaseInstalment]

    id

    required

    string

    amount

    Expand all

    required

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    dueDate

    required

    string

    format: date-time

    paidDate

    Expand all

    oneOf

    Adheres to <anonymous-schema-117>:

    null

    Or to <anonymous-schema-118>:

    string

    format: date-time

    success

    Expand all

    oneOf

    Adheres to <anonymous-schema-120>:

    null

    Or to <anonymous-schema-121>:

    boolean

    Additional properties are allowed.

    Additional properties are allowed.

    lineItems

    Expand all

    required

    array<allOf>

    Items:

    allOf

    Consists of BaseLineItemType:

    Expand all

    object allOf

    Consists of <anonymous-schema-43>:

    Expand all

    object

    groupId

    required

    number

    id

    required

    string

    itemCategory

    required

    string

    eye

    string

    Allowed values:
    • "L"
    • "R"
    • "LR"

    name

    required

    string

    number

    required

    string

    groupNumber

    required

    string

    quantity

    required

    number

    sku

    required

    string

    state

    string

    style

    string

    Additional properties are allowed.

    And of <anonymous-schema-55>:

    Expand all

    object

    originalLineItem

    Expand all

    allOf

    Consists of <anonymous-schema-43>:

    Expand all

    object

    groupId

    required

    number

    id

    required

    string

    itemCategory

    required

    string

    eye

    string

    Allowed values:
    • "L"
    • "R"
    • "LR"

    name

    required

    string

    number

    required

    string

    groupNumber

    required

    string

    quantity

    required

    number

    sku

    required

    string

    state

    string

    style

    string

    Additional properties are allowed.

    And of <anonymous-schema-57>:

    Expand all

    object

    Additional properties are allowed.

    Additional properties are allowed.

    Additional properties are allowed.

    And of <anonymous-schema-351>:

    Expand all

    object

    eye

    string

    quantity

    required

    number

    price

    Expand all

    required

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    totalPrice

    Expand all

    required

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    taxRate

    Expand all

    required

    object [BaseTaxRateType]

    name

    string

    amount

    number

    includedInPrice

    boolean

    country

    string

    subRates

    Expand all

    array<object [BaseTaxSubRateType]>

    object [BaseTaxSubRateType]

    name

    string

    amount

    number

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

    taxedPrice

    Expand all

    required

    object [BaseTaxedPriceType]

    totalNet

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    totalGross

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    taxPortions

    Expand all

    array<object [BaseTaxPortionType]>

    object [BaseTaxPortionType]

    rate

    number

    amount

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    name

    string

    Additional properties are NOT allowed.

    totalTax

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

    unitPrice

    Expand all

    required

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    Additional properties are allowed.

    billingAddress

    Expand all

    object [BaseAddress]

    id

    string

    title

    string

    firstName

    string

    lastName

    string

    line1

    string

    line2

    string

    line3

    string

    postalCode

    string

    city

    string

    state

    string

    country

    string

    phone

    string

    email

    string

    Additional properties are allowed.

    payment

    Expand all

    object [Payment]

    id

    string

    merchantAccount

    string

    merchantReference

    string

    pspReference

    string

    status

    string

    transaction

    Expand all

    object [BasePaymentTransaction]

    id

    string

    interactionId

    string

    state

    string

    pspReference

    string

    type

    string

    amount

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    notes

    string

    Additional properties are allowed.

    paymentInterface

    string

    method

    string

    name

    string

    amount

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    Additional properties are allowed.

    originalPayments

    Expand all

    array<object [Payment]>

    object [Payment]

    id

    string

    merchantAccount

    string

    merchantReference

    string

    pspReference

    string

    status

    string

    transaction

    Expand all

    object [BasePaymentTransaction]

    id

    string

    interactionId

    string

    state

    string

    pspReference

    string

    type

    string

    amount

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    notes

    string

    Additional properties are allowed.

    paymentInterface

    string

    method

    string

    name

    string

    amount

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    Additional properties are allowed.

    refundPayment

    Expand all

    object [Payment]

    id

    string

    merchantAccount

    string

    merchantReference

    string

    pspReference

    string

    status

    string

    transaction

    Expand all

    object [BasePaymentTransaction]

    id

    string

    interactionId

    string

    state

    string

    pspReference

    string

    type

    string

    amount

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    notes

    string

    Additional properties are allowed.

    paymentInterface

    string

    method

    string

    name

    string

    amount

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    Additional properties are allowed.

    totalRefundAmount

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    subtotalPrice

    Expand all

    required

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    totalPrice

    Expand all

    required

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    type

    required

    string

    Allowed values:
    • "STANDARD"
    • "RECURRING"
    • "REPLACEMENT"
    • "REPAIR"
    • "REMAKE"

    creditNote

    Expand all

    object [InvoiceOrCreditNote]

    id

    required

    string

    fileName

    required

    string

    createdAt

    required

    string

    format: date-time

    lastUpdatedAt

    required

    string

    format: date-time

    externalUrl

    required

    string

    storageAccountName

    required

    string

    storageContainerName

    required

    string

    storagePath

    required

    string

    Additional properties are allowed.

    Additional properties are allowed.

    aftercareStore

    Expand all

    object [OrderBaseStore]

    address

    Expand all

    object [OrderBaseStoreAddress]

    city

    string

    country

    string

    line1

    string

    line2

    string

    line3

    string

    name

    string

    postcode

    string

    region

    string

    Additional properties are NOT allowed.

    companyDetails

    Expand all

    object [OrderBaseStoreCompanyDetails]

    name

    string

    registeredAddress

    string

    Additional properties are NOT allowed.

    contactInfo

    Expand all

    object [OrderBaseStoreContactInfo]

    phone

    string

    email

    string

    Additional properties are NOT allowed.

    coordinates

    Expand all

    object [OrderBaseStoreCoordinates]

    latitude

    string

    longitude

    string

    Additional properties are NOT allowed.

    lineOfBusiness

    string

    name

    string

    eposNumber

    string

    storeUrl

    string

    Additional properties are allowed.

    __meta

    Expand all

    required

    object [OrderBaseMeta]

    key

    required

    string

    language

    required

    string

    loginUrl

    required

    string

    logoUrl

    required

    string

    myAccountUrl

    required

    string

    contactUsUrl

    required

    string

    privacyPolicyUrl

    required

    string

    termsofPurchaseUrl

    required

    string

    legalPoliciesUrl

    required

    string

    name

    required

    string

    supportContactNumber

    required

    string

    supportEmailAddress

    required

    string

    Additional properties are allowed.

    Additional properties are allowed.

    Extensions

    x-envelope-type

    cloudevent

    Additional properties are allowed.

    • #order

    Examples

    Payload

    {
      "id": "string",
      "specversion": "1.0",
      "env": "local",
      "sourceService": "com.specsavers/order-service",
      "type": "com.specsavers.payment.refunded",
      "correlationid": "string",
      "subject": "string",
      "market": "GB",
      "datacontenttype": "application/json",
      "data": {
        "customer": {
          "id": "string",
          "title": "string",
          "firstName": "string",
          "middleName": "string",
          "lastName": "string",
          "dateOfBirth": "string",
          "gender": "string",
          "allowMarketing": true,
          "contactInfo": {
            "email": "string",
            "mobile": "string"
          },
          "cprNumber": "string",
          "personnummer": "string"
        },
        "order": {
          "id": "string",
          "locale": "string",
          "number": "string",
          "originalOrder": {
            "id": "string",
            "number": "string"
          },
          "orderState": "OPEN",
          "subscription": {
            "id": "string",
            "interval": 0,
            "unit": "DAYS",
            "type": "PREPAY",
            "status": "ACTIVE",
            "instalments": [
              {
                "id": "string",
                "amount": {
                  "currencyCode": "string",
                  "centAmount": 0
                },
                "dueDate": "2019-08-24T14:15:22Z",
                "paidDate": {},
                "success": {}
              }
            ]
          },
          "lineItems": [
            {
              "groupId": 0,
              "id": "string",
              "itemCategory": "string",
              "eye": "string",
              "name": "string",
              "number": "string",
              "groupNumber": "string",
              "quantity": 0,
              "sku": "string",
              "state": "string",
              "style": "string",
              "originalLineItem": {
                "groupId": 0,
                "id": "string",
                "itemCategory": "string",
                "eye": "L",
                "name": "string",
                "number": "string",
                "groupNumber": "string",
                "quantity": 0,
                "sku": "string",
                "state": "string",
                "style": "string"
              },
              "price": {
                "currencyCode": "string",
                "centAmount": 0
              },
              "totalPrice": {
                "currencyCode": "string",
                "centAmount": 0
              },
              "taxRate": {
                "name": "string",
                "amount": 0,
                "includedInPrice": true,
                "country": "string",
                "subRates": [
                  {
                    "name": "string",
                    "amount": 0
                  }
                ]
              },
              "taxedPrice": {
                "totalNet": {
                  "currencyCode": "string",
                  "centAmount": 0
                },
                "totalGross": {
                  "currencyCode": "string",
                  "centAmount": 0
                },
                "taxPortions": [
                  {
                    "rate": 0,
                    "amount": {
                      "currencyCode": "string",
                      "centAmount": 0
                    },
                    "name": "string"
                  }
                ],
                "totalTax": {
                  "currencyCode": "string",
                  "centAmount": 0
                }
              },
              "unitPrice": {
                "currencyCode": "string",
                "centAmount": 0
              }
            }
          ],
          "billingAddress": {
            "id": "string",
            "title": "string",
            "firstName": "string",
            "lastName": "string",
            "line1": "string",
            "line2": "string",
            "line3": "string",
            "postalCode": "string",
            "city": "string",
            "state": "string",
            "country": "string",
            "phone": "string",
            "email": "string"
          },
          "payment": {
            "id": "string",
            "merchantAccount": "string",
            "merchantReference": "string",
            "pspReference": "string",
            "status": "string",
            "transaction": {
              "id": "string",
              "interactionId": "string",
              "state": "string",
              "pspReference": "string",
              "type": "string",
              "amount": {
                "currencyCode": "string",
                "centAmount": 0
              },
              "notes": "string"
            },
            "paymentInterface": "string",
            "method": "string",
            "name": "string",
            "amount": {
              "currencyCode": "string",
              "centAmount": 0
            }
          },
          "originalPayments": [
            {
              "id": "string",
              "merchantAccount": "string",
              "merchantReference": "string",
              "pspReference": "string",
              "status": "string",
              "transaction": {
                "id": "string",
                "interactionId": "string",
                "state": "string",
                "pspReference": "string",
                "type": "string",
                "amount": {
                  "currencyCode": "string",
                  "centAmount": 0
                },
                "notes": "string"
              },
              "paymentInterface": "string",
              "method": "string",
              "name": "string",
              "amount": {
                "currencyCode": "string",
                "centAmount": 0
              }
            }
          ],
          "refundPayment": {
            "id": "string",
            "merchantAccount": "string",
            "merchantReference": "string",
            "pspReference": "string",
            "status": "string",
            "transaction": {
              "id": "string",
              "interactionId": "string",
              "state": "string",
              "pspReference": "string",
              "type": "string",
              "amount": {
                "currencyCode": "string",
                "centAmount": 0
              },
              "notes": "string"
            },
            "paymentInterface": "string",
            "method": "string",
            "name": "string",
            "amount": {
              "currencyCode": "string",
              "centAmount": 0
            }
          },
          "totalRefundAmount": {
            "currencyCode": "string",
            "centAmount": 0
          },
          "subtotalPrice": {
            "currencyCode": "string",
            "centAmount": 0
          },
          "totalPrice": {
            "currencyCode": "string",
            "centAmount": 0
          },
          "type": "STANDARD",
          "creditNote": {
            "id": "string",
            "fileName": "string",
            "createdAt": "2019-08-24T14:15:22Z",
            "lastUpdatedAt": "2019-08-24T14:15:22Z",
            "externalUrl": "string",
            "storageAccountName": "string",
            "storageContainerName": "string",
            "storagePath": "string"
          }
        },
        "aftercareStore": {
          "address": {
            "city": "string",
            "country": "string",
            "line1": "string",
            "line2": "string",
            "line3": "string",
            "name": "string",
            "postcode": "string",
            "region": "string"
          },
          "companyDetails": {
            "name": "string",
            "registeredAddress": "string"
          },
          "contactInfo": {
            "phone": "string",
            "email": "string"
          },
          "coordinates": {
            "latitude": "string",
            "longitude": "string"
          },
          "lineOfBusiness": "string",
          "name": "string",
          "eposNumber": "string",
          "storeUrl": "string"
        },
        "__meta": {
          "key": "string",
          "language": "string",
          "loginUrl": "string",
          "logoUrl": "string",
          "myAccountUrl": "string",
          "contactUsUrl": "string",
          "privacyPolicyUrl": "string",
          "termsofPurchaseUrl": "string",
          "legalPoliciesUrl": "string",
          "name": "string",
          "supportContactNumber": "string",
          "supportEmailAddress": "string"
        }
      }
    }
    

    This example has been generated automatically.

  • #10

    • application/json

    Message IDRefundFailed

    Correlation ID$message.payload#/detail/correlationid

    Default Correlation ID

    The application will send new payment refund failed events through this channel.

    Payload

    Expand all

    object

    id

    required

    string

    specversion

    required

    string

    Default value:"1.0"

    env

    string

    The environment from which the event originated from e.g. dev, prod

    Allowed values:
    • "local"
    • "dev"
    • "qa"
    • "qa2"
    • "stg"
    • "prod"

    sourceService

    string

    Const:"com.specsavers/order-service"

    type

    required

    string

    Const:"com.specsavers.payment.refund.failed"

    correlationid

    string

    The correlation ID of the event. E.g. 1234

    subject

    string

    market

    string

    Derived from locale i.e GB

    Default value:"GB"

    datacontenttype

    string

    Const:"application/json"

    data

    Expand all

    required

    object [PaymentStatusData]

    customer

    Expand all

    required

    object [OrderBaseCustomer]

    id

    required

    string

    title

    string

    firstName

    required

    string

    middleName

    string

    lastName

    required

    string

    dateOfBirth

    required

    string

    gender

    required

    string

    allowMarketing

    required

    boolean

    contactInfo

    Expand all

    required

    object [ContactInfo]

    email

    required

    string

    mobile

    string

    Additional properties are NOT allowed.

    cprNumber

    string

    personnummer

    string

    Additional properties are allowed.

    order

    Expand all

    required

    object [PaymentStatusChangeOrder]

    uid: PaymentStatusChangeOrder

    id

    required

    string

    locale

    required

    string

    number

    required

    string

    originalOrder

    Expand all

    object [OriginalOrder]

    id

    string

    number

    string

    Additional properties are NOT allowed.

    orderState

    required

    string

    Allowed values:
    • "OPEN"
    • "COLLECTED"
    • "PROCESSING"
    • "CONFIRMED"
    • "BACK_ORDERED"
    • "COMPLETE"
    • "SHIPPED"
    • "CANCELLED"
    • "REMORSE"
    • "PENDING_RX_VALIDATION"
    • "PENDING_CANCELLATION"

    subscription

    Expand all

    object [BaseSubscription]

    uid: BaseSubscription

    id

    required

    string

    interval

    required

    number

    unit

    required

    string

    Allowed values:
    • "DAYS"
    • "WEEKS"
    • "MONTHS"

    type

    required

    string

    Allowed values:
    • "PREPAY"
    • "POSTPAY"
    • "RECURRING"

    status

    required

    string

    Allowed values:
    • "ACTIVE"
    • "PAUSED"
    • "EXPIRED"
    • "FAILED"
    • "FROZEN"
    • "CANCELLED"
    • "PENDING_CANCELLATION"

    instalments

    Expand all

    array<object [BaseInstalment]>

    object [BaseInstalment]

    id

    required

    string

    amount

    Expand all

    required

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    dueDate

    required

    string

    format: date-time

    paidDate

    Expand all

    oneOf

    Adheres to <anonymous-schema-117>:

    null

    Or to <anonymous-schema-118>:

    string

    format: date-time

    success

    Expand all

    oneOf

    Adheres to <anonymous-schema-120>:

    null

    Or to <anonymous-schema-121>:

    boolean

    Additional properties are allowed.

    Additional properties are allowed.

    lineItems

    Expand all

    required

    array<allOf>

    Items:

    allOf

    Consists of BaseLineItemType:

    Expand all

    object allOf

    Consists of <anonymous-schema-43>:

    Expand all

    object

    groupId

    required

    number

    id

    required

    string

    itemCategory

    required

    string

    eye

    string

    Allowed values:
    • "L"
    • "R"
    • "LR"

    name

    required

    string

    number

    required

    string

    groupNumber

    required

    string

    quantity

    required

    number

    sku

    required

    string

    state

    string

    style

    string

    Additional properties are allowed.

    And of <anonymous-schema-55>:

    Expand all

    object

    originalLineItem

    Expand all

    allOf

    Consists of <anonymous-schema-43>:

    Expand all

    object

    groupId

    required

    number

    id

    required

    string

    itemCategory

    required

    string

    eye

    string

    Allowed values:
    • "L"
    • "R"
    • "LR"

    name

    required

    string

    number

    required

    string

    groupNumber

    required

    string

    quantity

    required

    number

    sku

    required

    string

    state

    string

    style

    string

    Additional properties are allowed.

    And of <anonymous-schema-57>:

    Expand all

    object

    Additional properties are allowed.

    Additional properties are allowed.

    Additional properties are allowed.

    And of <anonymous-schema-351>:

    Expand all

    object

    eye

    string

    quantity

    required

    number

    price

    Expand all

    required

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    totalPrice

    Expand all

    required

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    taxRate

    Expand all

    required

    object [BaseTaxRateType]

    name

    string

    amount

    number

    includedInPrice

    boolean

    country

    string

    subRates

    Expand all

    array<object [BaseTaxSubRateType]>

    object [BaseTaxSubRateType]

    name

    string

    amount

    number

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

    taxedPrice

    Expand all

    required

    object [BaseTaxedPriceType]

    totalNet

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    totalGross

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    taxPortions

    Expand all

    array<object [BaseTaxPortionType]>

    object [BaseTaxPortionType]

    rate

    number

    amount

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    name

    string

    Additional properties are NOT allowed.

    totalTax

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

    unitPrice

    Expand all

    required

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    Additional properties are allowed.

    billingAddress

    Expand all

    object [BaseAddress]

    id

    string

    title

    string

    firstName

    string

    lastName

    string

    line1

    string

    line2

    string

    line3

    string

    postalCode

    string

    city

    string

    state

    string

    country

    string

    phone

    string

    email

    string

    Additional properties are allowed.

    payment

    Expand all

    object [Payment]

    id

    string

    merchantAccount

    string

    merchantReference

    string

    pspReference

    string

    status

    string

    transaction

    Expand all

    object [BasePaymentTransaction]

    id

    string

    interactionId

    string

    state

    string

    pspReference

    string

    type

    string

    amount

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    notes

    string

    Additional properties are allowed.

    paymentInterface

    string

    method

    string

    name

    string

    amount

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    Additional properties are allowed.

    originalPayments

    Expand all

    array<object [Payment]>

    object [Payment]

    id

    string

    merchantAccount

    string

    merchantReference

    string

    pspReference

    string

    status

    string

    transaction

    Expand all

    object [BasePaymentTransaction]

    id

    string

    interactionId

    string

    state

    string

    pspReference

    string

    type

    string

    amount

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    notes

    string

    Additional properties are allowed.

    paymentInterface

    string

    method

    string

    name

    string

    amount

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    Additional properties are allowed.

    refundPayment

    Expand all

    object [Payment]

    id

    string

    merchantAccount

    string

    merchantReference

    string

    pspReference

    string

    status

    string

    transaction

    Expand all

    object [BasePaymentTransaction]

    id

    string

    interactionId

    string

    state

    string

    pspReference

    string

    type

    string

    amount

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    notes

    string

    Additional properties are allowed.

    paymentInterface

    string

    method

    string

    name

    string

    amount

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    Additional properties are allowed.

    totalRefundAmount

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    subtotalPrice

    Expand all

    required

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    totalPrice

    Expand all

    required

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    type

    required

    string

    Allowed values:
    • "STANDARD"
    • "RECURRING"
    • "REPLACEMENT"
    • "REPAIR"
    • "REMAKE"

    creditNote

    Expand all

    object [InvoiceOrCreditNote]

    id

    required

    string

    fileName

    required

    string

    createdAt

    required

    string

    format: date-time

    lastUpdatedAt

    required

    string

    format: date-time

    externalUrl

    required

    string

    storageAccountName

    required

    string

    storageContainerName

    required

    string

    storagePath

    required

    string

    Additional properties are allowed.

    Additional properties are allowed.

    aftercareStore

    Expand all

    object [OrderBaseStore]

    address

    Expand all

    object [OrderBaseStoreAddress]

    city

    string

    country

    string

    line1

    string

    line2

    string

    line3

    string

    name

    string

    postcode

    string

    region

    string

    Additional properties are NOT allowed.

    companyDetails

    Expand all

    object [OrderBaseStoreCompanyDetails]

    name

    string

    registeredAddress

    string

    Additional properties are NOT allowed.

    contactInfo

    Expand all

    object [OrderBaseStoreContactInfo]

    phone

    string

    email

    string

    Additional properties are NOT allowed.

    coordinates

    Expand all

    object [OrderBaseStoreCoordinates]

    latitude

    string

    longitude

    string

    Additional properties are NOT allowed.

    lineOfBusiness

    string

    name

    string

    eposNumber

    string

    storeUrl

    string

    Additional properties are allowed.

    __meta

    Expand all

    required

    object [OrderBaseMeta]

    key

    required

    string

    language

    required

    string

    loginUrl

    required

    string

    logoUrl

    required

    string

    myAccountUrl

    required

    string

    contactUsUrl

    required

    string

    privacyPolicyUrl

    required

    string

    termsofPurchaseUrl

    required

    string

    legalPoliciesUrl

    required

    string

    name

    required

    string

    supportContactNumber

    required

    string

    supportEmailAddress

    required

    string

    Additional properties are allowed.

    Additional properties are allowed.

    Extensions

    x-envelope-type

    cloudevent

    Additional properties are allowed.

    • #order

    Examples

    Payload

    {
      "id": "string",
      "specversion": "1.0",
      "env": "local",
      "sourceService": "com.specsavers/order-service",
      "type": "com.specsavers.payment.refund.failed",
      "correlationid": "string",
      "subject": "string",
      "market": "GB",
      "datacontenttype": "application/json",
      "data": {
        "customer": {
          "id": "string",
          "title": "string",
          "firstName": "string",
          "middleName": "string",
          "lastName": "string",
          "dateOfBirth": "string",
          "gender": "string",
          "allowMarketing": true,
          "contactInfo": {
            "email": "string",
            "mobile": "string"
          },
          "cprNumber": "string",
          "personnummer": "string"
        },
        "order": {
          "id": "string",
          "locale": "string",
          "number": "string",
          "originalOrder": {
            "id": "string",
            "number": "string"
          },
          "orderState": "OPEN",
          "subscription": {
            "id": "string",
            "interval": 0,
            "unit": "DAYS",
            "type": "PREPAY",
            "status": "ACTIVE",
            "instalments": [
              {
                "id": "string",
                "amount": {
                  "currencyCode": "string",
                  "centAmount": 0
                },
                "dueDate": "2019-08-24T14:15:22Z",
                "paidDate": {},
                "success": {}
              }
            ]
          },
          "lineItems": [
            {
              "groupId": 0,
              "id": "string",
              "itemCategory": "string",
              "eye": "string",
              "name": "string",
              "number": "string",
              "groupNumber": "string",
              "quantity": 0,
              "sku": "string",
              "state": "string",
              "style": "string",
              "originalLineItem": {
                "groupId": 0,
                "id": "string",
                "itemCategory": "string",
                "eye": "L",
                "name": "string",
                "number": "string",
                "groupNumber": "string",
                "quantity": 0,
                "sku": "string",
                "state": "string",
                "style": "string"
              },
              "price": {
                "currencyCode": "string",
                "centAmount": 0
              },
              "totalPrice": {
                "currencyCode": "string",
                "centAmount": 0
              },
              "taxRate": {
                "name": "string",
                "amount": 0,
                "includedInPrice": true,
                "country": "string",
                "subRates": [
                  {
                    "name": "string",
                    "amount": 0
                  }
                ]
              },
              "taxedPrice": {
                "totalNet": {
                  "currencyCode": "string",
                  "centAmount": 0
                },
                "totalGross": {
                  "currencyCode": "string",
                  "centAmount": 0
                },
                "taxPortions": [
                  {
                    "rate": 0,
                    "amount": {
                      "currencyCode": "string",
                      "centAmount": 0
                    },
                    "name": "string"
                  }
                ],
                "totalTax": {
                  "currencyCode": "string",
                  "centAmount": 0
                }
              },
              "unitPrice": {
                "currencyCode": "string",
                "centAmount": 0
              }
            }
          ],
          "billingAddress": {
            "id": "string",
            "title": "string",
            "firstName": "string",
            "lastName": "string",
            "line1": "string",
            "line2": "string",
            "line3": "string",
            "postalCode": "string",
            "city": "string",
            "state": "string",
            "country": "string",
            "phone": "string",
            "email": "string"
          },
          "payment": {
            "id": "string",
            "merchantAccount": "string",
            "merchantReference": "string",
            "pspReference": "string",
            "status": "string",
            "transaction": {
              "id": "string",
              "interactionId": "string",
              "state": "string",
              "pspReference": "string",
              "type": "string",
              "amount": {
                "currencyCode": "string",
                "centAmount": 0
              },
              "notes": "string"
            },
            "paymentInterface": "string",
            "method": "string",
            "name": "string",
            "amount": {
              "currencyCode": "string",
              "centAmount": 0
            }
          },
          "originalPayments": [
            {
              "id": "string",
              "merchantAccount": "string",
              "merchantReference": "string",
              "pspReference": "string",
              "status": "string",
              "transaction": {
                "id": "string",
                "interactionId": "string",
                "state": "string",
                "pspReference": "string",
                "type": "string",
                "amount": {
                  "currencyCode": "string",
                  "centAmount": 0
                },
                "notes": "string"
              },
              "paymentInterface": "string",
              "method": "string",
              "name": "string",
              "amount": {
                "currencyCode": "string",
                "centAmount": 0
              }
            }
          ],
          "refundPayment": {
            "id": "string",
            "merchantAccount": "string",
            "merchantReference": "string",
            "pspReference": "string",
            "status": "string",
            "transaction": {
              "id": "string",
              "interactionId": "string",
              "state": "string",
              "pspReference": "string",
              "type": "string",
              "amount": {
                "currencyCode": "string",
                "centAmount": 0
              },
              "notes": "string"
            },
            "paymentInterface": "string",
            "method": "string",
            "name": "string",
            "amount": {
              "currencyCode": "string",
              "centAmount": 0
            }
          },
          "totalRefundAmount": {
            "currencyCode": "string",
            "centAmount": 0
          },
          "subtotalPrice": {
            "currencyCode": "string",
            "centAmount": 0
          },
          "totalPrice": {
            "currencyCode": "string",
            "centAmount": 0
          },
          "type": "STANDARD",
          "creditNote": {
            "id": "string",
            "fileName": "string",
            "createdAt": "2019-08-24T14:15:22Z",
            "lastUpdatedAt": "2019-08-24T14:15:22Z",
            "externalUrl": "string",
            "storageAccountName": "string",
            "storageContainerName": "string",
            "storagePath": "string"
          }
        },
        "aftercareStore": {
          "address": {
            "city": "string",
            "country": "string",
            "line1": "string",
            "line2": "string",
            "line3": "string",
            "name": "string",
            "postcode": "string",
            "region": "string"
          },
          "companyDetails": {
            "name": "string",
            "registeredAddress": "string"
          },
          "contactInfo": {
            "phone": "string",
            "email": "string"
          },
          "coordinates": {
            "latitude": "string",
            "longitude": "string"
          },
          "lineOfBusiness": "string",
          "name": "string",
          "eposNumber": "string",
          "storeUrl": "string"
        },
        "__meta": {
          "key": "string",
          "language": "string",
          "loginUrl": "string",
          "logoUrl": "string",
          "myAccountUrl": "string",
          "contactUsUrl": "string",
          "privacyPolicyUrl": "string",
          "termsofPurchaseUrl": "string",
          "legalPoliciesUrl": "string",
          "name": "string",
          "supportContactNumber": "string",
          "supportEmailAddress": "string"
        }
      }
    }
    

    This example has been generated automatically.

  • #11

    • application/json

    Message IDRtpReturnRefunded

    Correlation ID$message.payload#/detail/correlationid

    Default Correlation ID

    The application will send RTP return refunded events when a refund payment is manually refunded through this channel.

    Payload

    Expand all

    object

    id

    required

    string

    specversion

    required

    string

    Default value:"1.0"

    env

    required

    string

    The environment from which the event originated from e.g. dev, prod

    Allowed values:
    • "local"
    • "dev"
    • "qa"
    • "qa2"
    • "stg"
    • "prod"

    sourceService

    string

    Const:"com.specsavers/order-service"

    type

    required

    string

    Const:"com.specsavers.rtp.return.refunded"

    correlationid

    required

    string

    The correlation ID of the event. E.g. 1234

    subject

    string

    market

    string

    Derived from locale i.e GB

    Default value:"GB"

    datacontenttype

    string

    Const:"application/json"

    data

    Expand all

    required

    object

    orderNumber

    required

    string

    The order number

    returnKey

    required

    string

    The key of the return

    paymentId

    required

    string

    The ID of the payment

    transactionId

    required

    string

    The ID of the transaction

    isManualRefund

    required

    boolean

    Indicates if the refund was processed manually

    Additional properties are NOT allowed.

    Extensions

    x-envelope-type

    cloudevent

    Additional properties are allowed.

    • #order

    Examples

    Payload

    {
      "id": "string",
      "specversion": "1.0",
      "env": "local",
      "sourceService": "com.specsavers/order-service",
      "type": "com.specsavers.rtp.return.refunded",
      "correlationid": "string",
      "subject": "string",
      "market": "GB",
      "datacontenttype": "application/json",
      "data": {
        "orderNumber": "string",
        "returnKey": "string",
        "paymentId": "string",
        "transactionId": "string",
        "isManualRefund": true
      }
    }
    

    This example has been generated automatically.

  • #12

    • application/json

    Message IDRtpOrderRefunded

    Correlation ID$message.payload#/detail/correlationid

    Default Correlation ID

    The application will send RTP order refund events through this channel.

    Payload

    Expand all

    object

    id

    required

    string

    specversion

    required

    string

    Default value:"1.0"

    env

    required

    string

    The environment from which the event originated from e.g. dev, prod

    Allowed values:
    • "local"
    • "dev"
    • "qa"
    • "qa2"
    • "stg"
    • "prod"

    sourceService

    string

    Const:"com.specsavers/order-service"

    type

    required

    string

    Const:"com.specsavers.rtp.order.refunded"

    correlationid

    required

    string

    The correlation ID of the event. E.g. 1234

    data

    Expand all

    required

    object

    orderNumber

    required

    string

    The order number

    isCancellation

    required

    boolean

    If the refund is a result of a cancellation

    paymentId

    required

    string

    The ID of the payment

    transactionId

    required

    string

    The ID of the transaction

    isManualRefund

    required

    boolean

    Indicates if the refund was processed manually

    Additional properties are NOT allowed.

    Extensions

    x-envelope-type

    cloudevent

    Additional properties are allowed.

    • #order

    Examples

    Payload

    {
      "id": "string",
      "specversion": "1.0",
      "env": "local",
      "sourceService": "com.specsavers/order-service",
      "type": "com.specsavers.rtp.order.refunded",
      "correlationid": "string",
      "data": {
        "orderNumber": "string",
        "isCancellation": true,
        "paymentId": "string",
        "transactionId": "string",
        "isManualRefund": true
      }
    }
    

    This example has been generated automatically.

  • #13

    • application/json

    Message IDRtpCreditNoteCreated

    Correlation ID$message.payload#/detail/correlationid

    Default Correlation ID

    The application will send RTP credit note created events through this channel.

    Payload

    Expand all

    object

    id

    required

    string

    specversion

    required

    string

    Default value:"1.0"

    env

    required

    string

    The environment from which the event originated from e.g. dev, prod

    Allowed values:
    • "local"
    • "dev"
    • "qa"
    • "qa2"
    • "stg"
    • "prod"

    sourceService

    string

    Const:"com.specsavers/order-service"

    type

    required

    string

    Const:"com.specsavers.rtp.creditnote.created"

    correlationid

    required

    string

    The correlation ID of the event. E.g. 1234

    data

    Expand all

    required

    object

    orderNumber

    required

    string

    The order number

    creditNoteId

    required

    string

    The ID of the credit note

    isCancellation

    required

    boolean

    If the refund is a result of a cancellation

    returnKey

    string

    The key of the return, required if the order refund is linked to a return and not a cancellation

    paymentId

    required

    string

    The ID of the payment

    transactionId

    required

    string

    The ID of the transaction

    Additional properties are NOT allowed.

    Extensions

    x-envelope-type

    cloudevent

    Additional properties are allowed.

    • #order

    Examples

    Payload

    {
      "id": "string",
      "specversion": "1.0",
      "env": "local",
      "sourceService": "com.specsavers/order-service",
      "type": "com.specsavers.rtp.creditnote.created",
      "correlationid": "string",
      "data": {
        "orderNumber": "string",
        "creditNoteId": "string",
        "isCancellation": true,
        "returnKey": "string",
        "paymentId": "string",
        "transactionId": "string"
      }
    }
    

    This example has been generated automatically.

  • #14

    • application/json

    Message IDSubscriptionCreated

    Correlation ID$message.payload#/detail/correlationid

    Default Correlation ID

    The application will send new subscription created events through this channel.

    Payload

    Expand all

    object

    id

    required

    string

    specversion

    required

    string

    Default value:"1.0"

    env

    string

    The environment from which the event originated from e.g. dev, prod

    Allowed values:
    • "local"
    • "dev"
    • "qa"
    • "qa2"
    • "stg"
    • "prod"

    sourceService

    string

    Const:"com.specsavers/order-service"

    type

    required

    string

    Const:"com.specsavers.subscription.created"

    correlationid

    string

    The correlation ID of the event. E.g. 1234

    subject

    string

    market

    string

    Derived from locale i.e GB

    Default value:"GB"

    datacontenttype

    string

    Const:"application/json"

    data

    Expand all

    required

    object [SubscriptionData]

    customer

    Expand all

    required

    object [OrderBaseCustomer]

    id

    required

    string

    title

    string

    firstName

    required

    string

    middleName

    string

    lastName

    required

    string

    dateOfBirth

    required

    string

    gender

    required

    string

    allowMarketing

    required

    boolean

    contactInfo

    Expand all

    required

    object [ContactInfo]

    email

    required

    string

    mobile

    string

    Additional properties are NOT allowed.

    cprNumber

    string

    personnummer

    string

    Additional properties are allowed.

    __meta

    Expand all

    required

    object [OrderBaseMeta]

    key

    required

    string

    language

    required

    string

    loginUrl

    required

    string

    logoUrl

    required

    string

    myAccountUrl

    required

    string

    contactUsUrl

    required

    string

    privacyPolicyUrl

    required

    string

    termsofPurchaseUrl

    required

    string

    legalPoliciesUrl

    required

    string

    name

    required

    string

    supportContactNumber

    required

    string

    supportEmailAddress

    required

    string

    Additional properties are allowed.

    aftercareStore

    Expand all

    object [OrderBaseStore]

    address

    Expand all

    object [OrderBaseStoreAddress]

    city

    string

    country

    string

    line1

    string

    line2

    string

    line3

    string

    name

    string

    postcode

    string

    region

    string

    Additional properties are NOT allowed.

    companyDetails

    Expand all

    object [OrderBaseStoreCompanyDetails]

    name

    string

    registeredAddress

    string

    Additional properties are NOT allowed.

    contactInfo

    Expand all

    object [OrderBaseStoreContactInfo]

    phone

    string

    email

    string

    Additional properties are NOT allowed.

    coordinates

    Expand all

    object [OrderBaseStoreCoordinates]

    latitude

    string

    longitude

    string

    Additional properties are NOT allowed.

    lineOfBusiness

    string

    name

    string

    eposNumber

    string

    storeUrl

    string

    Additional properties are allowed.

    subscription

    Expand all

    required

    allOf

    Consists of BaseSubscription:

    Expand all

    object [BaseSubscription]

    uid: BaseSubscription

    id

    required

    string

    interval

    required

    number

    unit

    required

    string

    Allowed values:
    • "DAYS"
    • "WEEKS"
    • "MONTHS"

    type

    required

    string

    Allowed values:
    • "PREPAY"
    • "POSTPAY"
    • "RECURRING"

    status

    required

    string

    Allowed values:
    • "ACTIVE"
    • "PAUSED"
    • "EXPIRED"
    • "FAILED"
    • "FROZEN"
    • "CANCELLED"
    • "PENDING_CANCELLATION"

    instalments

    Expand all

    array<object [BaseInstalment]>

    object [BaseInstalment]

    id

    required

    string

    amount

    Expand all

    required

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    dueDate

    required

    string

    format: date-time

    paidDate

    Expand all

    oneOf

    Adheres to <anonymous-schema-117>:

    null

    Or to <anonymous-schema-118>:

    string

    format: date-time

    success

    Expand all

    oneOf

    Adheres to <anonymous-schema-120>:

    null

    Or to <anonymous-schema-121>:

    boolean

    Additional properties are allowed.

    Additional properties are allowed.

    And of <anonymous-schema-433>:

    Expand all

    object

    originalOrderId

    required

    string

    originalOrderNumber

    required

    string

    startedAt

    required

    string

    format: date-time

    type

    required

    string

    lineItems

    Expand all

    required

    array<allOf>

    Items:

    allOf

    Consists of BaseLineItemTypeSubscription:

    Expand all

    object allOf

    Consists of <anonymous-schema-441>:

    Expand all

    object

    groupId

    required

    number

    id

    required

    string

    itemCategory

    required

    string

    eye

    string

    Allowed values:
    • "L"
    • "R"
    • "LR"

    name

    required

    string

    number

    string

    groupNumber

    required

    string

    quantity

    required

    number

    sku

    required

    string

    state

    string

    style

    string

    Additional properties are allowed.

    And of <anonymous-schema-453>:

    Expand all

    object

    originalLineItem

    Expand all

    allOf

    Consists of <anonymous-schema-441>:

    Expand all

    object

    groupId

    required

    number

    id

    required

    string

    itemCategory

    required

    string

    eye

    string

    Allowed values:
    • "L"
    • "R"
    • "LR"

    name

    required

    string

    number

    string

    groupNumber

    required

    string

    quantity

    required

    number

    sku

    required

    string

    state

    string

    style

    string

    Additional properties are allowed.

    And of <anonymous-schema-455>:

    Expand all

    object

    Additional properties are allowed.

    Additional properties are allowed.

    Additional properties are allowed.

    And of <anonymous-schema-456>:

    Expand all

    object

    quantity

    required

    number

    prescriptionKey

    string

    productDetails

    Expand all

    object

    Additional properties are allowed.

    discount

    Expand all

    object [Discount]

    key

    string

    discountCode

    string

    Additional properties are allowed.

    price

    Expand all

    required

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    taxedPrice

    Expand all

    required

    object [BaseTaxedPriceType]

    totalNet

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    totalGross

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    taxPortions

    Expand all

    array<object [BaseTaxPortionType]>

    object [BaseTaxPortionType]

    rate

    number

    amount

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    name

    string

    Additional properties are NOT allowed.

    totalTax

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

    taxRate

    Expand all

    required

    object [BaseTaxRateType]

    name

    string

    amount

    number

    includedInPrice

    boolean

    country

    string

    subRates

    Expand all

    array<object [BaseTaxSubRateType]>

    object [BaseTaxSubRateType]

    name

    string

    amount

    number

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

    totalPrice

    Expand all

    required

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    unitPrice

    Expand all

    required

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    Additional properties are allowed.

    taxedPrice

    Expand all

    object [BaseTaxedPriceType]

    totalNet

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    totalGross

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    taxPortions

    Expand all

    array<object [BaseTaxPortionType]>

    object [BaseTaxPortionType]

    rate

    number

    amount

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    name

    string

    Additional properties are NOT allowed.

    totalTax

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

    taxedShippingPrice

    Expand all

    object [BaseTaxedPriceType]

    totalNet

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    totalGross

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    taxPortions

    Expand all

    array<object [BaseTaxPortionType]>

    object [BaseTaxPortionType]

    rate

    number

    amount

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    name

    string

    Additional properties are NOT allowed.

    totalTax

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

    subtotalPrice

    Expand all

    required

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    totalPrice

    Expand all

    required

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    Additional properties are allowed.

    Additional properties are allowed.

    Extensions

    x-envelope-type

    cloudevent

    Additional properties are allowed.

    • #order

    Examples

    Payload

    {
      "id": "string",
      "specversion": "1.0",
      "env": "local",
      "sourceService": "com.specsavers/order-service",
      "type": "com.specsavers.subscription.created",
      "correlationid": "string",
      "subject": "string",
      "market": "GB",
      "datacontenttype": "application/json",
      "data": {
        "customer": {
          "id": "string",
          "title": "string",
          "firstName": "string",
          "middleName": "string",
          "lastName": "string",
          "dateOfBirth": "string",
          "gender": "string",
          "allowMarketing": true,
          "contactInfo": {
            "email": "string",
            "mobile": "string"
          },
          "cprNumber": "string",
          "personnummer": "string"
        },
        "__meta": {
          "key": "string",
          "language": "string",
          "loginUrl": "string",
          "logoUrl": "string",
          "myAccountUrl": "string",
          "contactUsUrl": "string",
          "privacyPolicyUrl": "string",
          "termsofPurchaseUrl": "string",
          "legalPoliciesUrl": "string",
          "name": "string",
          "supportContactNumber": "string",
          "supportEmailAddress": "string"
        },
        "aftercareStore": {
          "address": {
            "city": "string",
            "country": "string",
            "line1": "string",
            "line2": "string",
            "line3": "string",
            "name": "string",
            "postcode": "string",
            "region": "string"
          },
          "companyDetails": {
            "name": "string",
            "registeredAddress": "string"
          },
          "contactInfo": {
            "phone": "string",
            "email": "string"
          },
          "coordinates": {
            "latitude": "string",
            "longitude": "string"
          },
          "lineOfBusiness": "string",
          "name": "string",
          "eposNumber": "string",
          "storeUrl": "string"
        },
        "subscription": {
          "id": "string",
          "interval": 0,
          "unit": "DAYS",
          "type": "string",
          "status": "ACTIVE",
          "instalments": [
            {
              "id": "string",
              "amount": {
                "currencyCode": "string",
                "centAmount": 0
              },
              "dueDate": "2019-08-24T14:15:22Z",
              "paidDate": {},
              "success": {}
            }
          ],
          "originalOrderId": "string",
          "originalOrderNumber": "string",
          "startedAt": "2019-08-24T14:15:22Z",
          "lineItems": [
            {
              "groupId": 0,
              "id": "string",
              "itemCategory": "string",
              "eye": "L",
              "name": "string",
              "number": "string",
              "groupNumber": "string",
              "quantity": 0,
              "sku": "string",
              "state": "string",
              "style": "string",
              "originalLineItem": {
                "groupId": 0,
                "id": "string",
                "itemCategory": "string",
                "eye": "L",
                "name": "string",
                "number": "string",
                "groupNumber": "string",
                "quantity": 0,
                "sku": "string",
                "state": "string",
                "style": "string"
              },
              "prescriptionKey": "string",
              "productDetails": {},
              "discount": {
                "key": "string",
                "discountCode": "string"
              },
              "price": {
                "currencyCode": "string",
                "centAmount": 0
              },
              "taxedPrice": {
                "totalNet": {
                  "currencyCode": "string",
                  "centAmount": 0
                },
                "totalGross": {
                  "currencyCode": "string",
                  "centAmount": 0
                },
                "taxPortions": [
                  {
                    "rate": 0,
                    "amount": {
                      "currencyCode": "string",
                      "centAmount": 0
                    },
                    "name": "string"
                  }
                ],
                "totalTax": {
                  "currencyCode": "string",
                  "centAmount": 0
                }
              },
              "taxRate": {
                "name": "string",
                "amount": 0,
                "includedInPrice": true,
                "country": "string",
                "subRates": [
                  {
                    "name": "string",
                    "amount": 0
                  }
                ]
              },
              "totalPrice": {
                "currencyCode": "string",
                "centAmount": 0
              },
              "unitPrice": {
                "currencyCode": "string",
                "centAmount": 0
              }
            }
          ],
          "taxedPrice": {
            "totalNet": {
              "currencyCode": "string",
              "centAmount": 0
            },
            "totalGross": {
              "currencyCode": "string",
              "centAmount": 0
            },
            "taxPortions": [
              {
                "rate": 0,
                "amount": {
                  "currencyCode": "string",
                  "centAmount": 0
                },
                "name": "string"
              }
            ],
            "totalTax": {
              "currencyCode": "string",
              "centAmount": 0
            }
          },
          "taxedShippingPrice": {
            "totalNet": {
              "currencyCode": "string",
              "centAmount": 0
            },
            "totalGross": {
              "currencyCode": "string",
              "centAmount": 0
            },
            "taxPortions": [
              {
                "rate": 0,
                "amount": {
                  "currencyCode": "string",
                  "centAmount": 0
                },
                "name": "string"
              }
            ],
            "totalTax": {
              "currencyCode": "string",
              "centAmount": 0
            }
          },
          "subtotalPrice": {
            "currencyCode": "string",
            "centAmount": 0
          },
          "totalPrice": {
            "currencyCode": "string",
            "centAmount": 0
          }
        }
      }
    }
    

    This example has been generated automatically.

  • #15

    • application/json

    Message IDSubscriptionUpdated

    Correlation ID$message.payload#/detail/correlationid

    Default Correlation ID

    The application will send new subscription updated events through this channel.

    Payload

    Expand all

    object

    id

    required

    string

    specversion

    required

    string

    Default value:"1.0"

    env

    string

    The environment from which the event originated from e.g. dev, prod

    Allowed values:
    • "local"
    • "dev"
    • "qa"
    • "qa2"
    • "stg"
    • "prod"

    sourceService

    string

    Const:"com.specsavers/order-service"

    type

    required

    string

    Const:"com.specsavers.subscription.updated"

    correlationid

    string

    The correlation ID of the event. E.g. 1234

    subject

    string

    market

    string

    Derived from locale i.e GB

    Default value:"GB"

    datacontenttype

    string

    Const:"application/json"

    data

    Expand all

    required

    object [SubscriptionData]

    customer

    Expand all

    required

    object [OrderBaseCustomer]

    id

    required

    string

    title

    string

    firstName

    required

    string

    middleName

    string

    lastName

    required

    string

    dateOfBirth

    required

    string

    gender

    required

    string

    allowMarketing

    required

    boolean

    contactInfo

    Expand all

    required

    object [ContactInfo]

    email

    required

    string

    mobile

    string

    Additional properties are NOT allowed.

    cprNumber

    string

    personnummer

    string

    Additional properties are allowed.

    __meta

    Expand all

    required

    object [OrderBaseMeta]

    key

    required

    string

    language

    required

    string

    loginUrl

    required

    string

    logoUrl

    required

    string

    myAccountUrl

    required

    string

    contactUsUrl

    required

    string

    privacyPolicyUrl

    required

    string

    termsofPurchaseUrl

    required

    string

    legalPoliciesUrl

    required

    string

    name

    required

    string

    supportContactNumber

    required

    string

    supportEmailAddress

    required

    string

    Additional properties are allowed.

    aftercareStore

    Expand all

    object [OrderBaseStore]

    address

    Expand all

    object [OrderBaseStoreAddress]

    city

    string

    country

    string

    line1

    string

    line2

    string

    line3

    string

    name

    string

    postcode

    string

    region

    string

    Additional properties are NOT allowed.

    companyDetails

    Expand all

    object [OrderBaseStoreCompanyDetails]

    name

    string

    registeredAddress

    string

    Additional properties are NOT allowed.

    contactInfo

    Expand all

    object [OrderBaseStoreContactInfo]

    phone

    string

    email

    string

    Additional properties are NOT allowed.

    coordinates

    Expand all

    object [OrderBaseStoreCoordinates]

    latitude

    string

    longitude

    string

    Additional properties are NOT allowed.

    lineOfBusiness

    string

    name

    string

    eposNumber

    string

    storeUrl

    string

    Additional properties are allowed.

    subscription

    Expand all

    required

    allOf

    Consists of BaseSubscription:

    Expand all

    object [BaseSubscription]

    uid: BaseSubscription

    id

    required

    string

    interval

    required

    number

    unit

    required

    string

    Allowed values:
    • "DAYS"
    • "WEEKS"
    • "MONTHS"

    type

    required

    string

    Allowed values:
    • "PREPAY"
    • "POSTPAY"
    • "RECURRING"

    status

    required

    string

    Allowed values:
    • "ACTIVE"
    • "PAUSED"
    • "EXPIRED"
    • "FAILED"
    • "FROZEN"
    • "CANCELLED"
    • "PENDING_CANCELLATION"

    instalments

    Expand all

    array<object [BaseInstalment]>

    object [BaseInstalment]

    id

    required

    string

    amount

    Expand all

    required

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    dueDate

    required

    string

    format: date-time

    paidDate

    Expand all

    oneOf

    Adheres to <anonymous-schema-117>:

    null

    Or to <anonymous-schema-118>:

    string

    format: date-time

    success

    Expand all

    oneOf

    Adheres to <anonymous-schema-120>:

    null

    Or to <anonymous-schema-121>:

    boolean

    Additional properties are allowed.

    Additional properties are allowed.

    And of <anonymous-schema-433>:

    Expand all

    object

    originalOrderId

    required

    string

    originalOrderNumber

    required

    string

    startedAt

    required

    string

    format: date-time

    type

    required

    string

    lineItems

    Expand all

    required

    array<allOf>

    Items:

    allOf

    Consists of BaseLineItemTypeSubscription:

    Expand all

    object allOf

    Consists of <anonymous-schema-441>:

    Expand all

    object

    groupId

    required

    number

    id

    required

    string

    itemCategory

    required

    string

    eye

    string

    Allowed values:
    • "L"
    • "R"
    • "LR"

    name

    required

    string

    number

    string

    groupNumber

    required

    string

    quantity

    required

    number

    sku

    required

    string

    state

    string

    style

    string

    Additional properties are allowed.

    And of <anonymous-schema-453>:

    Expand all

    object

    originalLineItem

    Expand all

    allOf

    Consists of <anonymous-schema-441>:

    Expand all

    object

    groupId

    required

    number

    id

    required

    string

    itemCategory

    required

    string

    eye

    string

    Allowed values:
    • "L"
    • "R"
    • "LR"

    name

    required

    string

    number

    string

    groupNumber

    required

    string

    quantity

    required

    number

    sku

    required

    string

    state

    string

    style

    string

    Additional properties are allowed.

    And of <anonymous-schema-455>:

    Expand all

    object

    Additional properties are allowed.

    Additional properties are allowed.

    Additional properties are allowed.

    And of <anonymous-schema-456>:

    Expand all

    object

    quantity

    required

    number

    prescriptionKey

    string

    productDetails

    Expand all

    object

    Additional properties are allowed.

    discount

    Expand all

    object [Discount]

    key

    string

    discountCode

    string

    Additional properties are allowed.

    price

    Expand all

    required

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    taxedPrice

    Expand all

    required

    object [BaseTaxedPriceType]

    totalNet

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    totalGross

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    taxPortions

    Expand all

    array<object [BaseTaxPortionType]>

    object [BaseTaxPortionType]

    rate

    number

    amount

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    name

    string

    Additional properties are NOT allowed.

    totalTax

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

    taxRate

    Expand all

    required

    object [BaseTaxRateType]

    name

    string

    amount

    number

    includedInPrice

    boolean

    country

    string

    subRates

    Expand all

    array<object [BaseTaxSubRateType]>

    object [BaseTaxSubRateType]

    name

    string

    amount

    number

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

    totalPrice

    Expand all

    required

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    unitPrice

    Expand all

    required

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    Additional properties are allowed.

    taxedPrice

    Expand all

    object [BaseTaxedPriceType]

    totalNet

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    totalGross

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    taxPortions

    Expand all

    array<object [BaseTaxPortionType]>

    object [BaseTaxPortionType]

    rate

    number

    amount

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    name

    string

    Additional properties are NOT allowed.

    totalTax

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

    taxedShippingPrice

    Expand all

    object [BaseTaxedPriceType]

    totalNet

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    totalGross

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    taxPortions

    Expand all

    array<object [BaseTaxPortionType]>

    object [BaseTaxPortionType]

    rate

    number

    amount

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    name

    string

    Additional properties are NOT allowed.

    totalTax

    Expand all

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

    subtotalPrice

    Expand all

    required

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    totalPrice

    Expand all

    required

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    Additional properties are allowed.

    Additional properties are allowed.

    Extensions

    x-envelope-type

    cloudevent

    Additional properties are allowed.

    • #order

    Examples

    Payload

    {
      "id": "string",
      "specversion": "1.0",
      "env": "local",
      "sourceService": "com.specsavers/order-service",
      "type": "com.specsavers.subscription.updated",
      "correlationid": "string",
      "subject": "string",
      "market": "GB",
      "datacontenttype": "application/json",
      "data": {
        "customer": {
          "id": "string",
          "title": "string",
          "firstName": "string",
          "middleName": "string",
          "lastName": "string",
          "dateOfBirth": "string",
          "gender": "string",
          "allowMarketing": true,
          "contactInfo": {
            "email": "string",
            "mobile": "string"
          },
          "cprNumber": "string",
          "personnummer": "string"
        },
        "__meta": {
          "key": "string",
          "language": "string",
          "loginUrl": "string",
          "logoUrl": "string",
          "myAccountUrl": "string",
          "contactUsUrl": "string",
          "privacyPolicyUrl": "string",
          "termsofPurchaseUrl": "string",
          "legalPoliciesUrl": "string",
          "name": "string",
          "supportContactNumber": "string",
          "supportEmailAddress": "string"
        },
        "aftercareStore": {
          "address": {
            "city": "string",
            "country": "string",
            "line1": "string",
            "line2": "string",
            "line3": "string",
            "name": "string",
            "postcode": "string",
            "region": "string"
          },
          "companyDetails": {
            "name": "string",
            "registeredAddress": "string"
          },
          "contactInfo": {
            "phone": "string",
            "email": "string"
          },
          "coordinates": {
            "latitude": "string",
            "longitude": "string"
          },
          "lineOfBusiness": "string",
          "name": "string",
          "eposNumber": "string",
          "storeUrl": "string"
        },
        "subscription": {
          "id": "string",
          "interval": 0,
          "unit": "DAYS",
          "type": "string",
          "status": "ACTIVE",
          "instalments": [
            {
              "id": "string",
              "amount": {
                "currencyCode": "string",
                "centAmount": 0
              },
              "dueDate": "2019-08-24T14:15:22Z",
              "paidDate": {},
              "success": {}
            }
          ],
          "originalOrderId": "string",
          "originalOrderNumber": "string",
          "startedAt": "2019-08-24T14:15:22Z",
          "lineItems": [
            {
              "groupId": 0,
              "id": "string",
              "itemCategory": "string",
              "eye": "L",
              "name": "string",
              "number": "string",
              "groupNumber": "string",
              "quantity": 0,
              "sku": "string",
              "state": "string",
              "style": "string",
              "originalLineItem": {
                "groupId": 0,
                "id": "string",
                "itemCategory": "string",
                "eye": "L",
                "name": "string",
                "number": "string",
                "groupNumber": "string",
                "quantity": 0,
                "sku": "string",
                "state": "string",
                "style": "string"
              },
              "prescriptionKey": "string",
              "productDetails": {},
              "discount": {
                "key": "string",
                "discountCode": "string"
              },
              "price": {
                "currencyCode": "string",
                "centAmount": 0
              },
              "taxedPrice": {
                "totalNet": {
                  "currencyCode": "string",
                  "centAmount": 0
                },
                "totalGross": {
                  "currencyCode": "string",
                  "centAmount": 0
                },
                "taxPortions": [
                  {
                    "rate": 0,
                    "amount": {
                      "currencyCode": "string",
                      "centAmount": 0
                    },
                    "name": "string"
                  }
                ],
                "totalTax": {
                  "currencyCode": "string",
                  "centAmount": 0
                }
              },
              "taxRate": {
                "name": "string",
                "amount": 0,
                "includedInPrice": true,
                "country": "string",
                "subRates": [
                  {
                    "name": "string",
                    "amount": 0
                  }
                ]
              },
              "totalPrice": {
                "currencyCode": "string",
                "centAmount": 0
              },
              "unitPrice": {
                "currencyCode": "string",
                "centAmount": 0
              }
            }
          ],
          "taxedPrice": {
            "totalNet": {
              "currencyCode": "string",
              "centAmount": 0
            },
            "totalGross": {
              "currencyCode": "string",
              "centAmount": 0
            },
            "taxPortions": [
              {
                "rate": 0,
                "amount": {
                  "currencyCode": "string",
                  "centAmount": 0
                },
                "name": "string"
              }
            ],
            "totalTax": {
              "currencyCode": "string",
              "centAmount": 0
            }
          },
          "taxedShippingPrice": {
            "totalNet": {
              "currencyCode": "string",
              "centAmount": 0
            },
            "totalGross": {
              "currencyCode": "string",
              "centAmount": 0
            },
            "taxPortions": [
              {
                "rate": 0,
                "amount": {
                  "currencyCode": "string",
                  "centAmount": 0
                },
                "name": "string"
              }
            ],
            "totalTax": {
              "currencyCode": "string",
              "centAmount": 0
            }
          },
          "subtotalPrice": {
            "currencyCode": "string",
            "centAmount": 0
          },
          "totalPrice": {
            "currencyCode": "string",
            "centAmount": 0
          }
        }
      }
    }
    

    This example has been generated automatically.

  • #16

    • application/json

    Message IDSubscriptionResumed

    Correlation ID$message.payload#/detail/correlationid

    Default Correlation ID

    The application will send new subscription resumed events through this channel.

    Payload

    Expand all

    object

    id

    required

    string

    specversion

    required

    string

    Default value:"1.0"

    env

    string

    The environment from which the event originated from e.g. dev, prod

    Allowed values:
    • "local"
    • "dev"
    • "qa"
    • "qa2"
    • "stg"
    • "prod"

    sourceService

    string

    Const:"com.specsavers/order-service"

    type

    required

    string

    Const:"com.specsavers.subscription.resumed"

    correlationid

    string

    The correlation ID of the event. E.g. 1234

    subject

    string

    market

    string

    Derived from locale i.e GB

    Default value:"GB"

    datacontenttype

    string

    Const:"application/json"

    data

    Expand all

    required

    object [SubscriptionStatusUpdatedData]

    customer

    Expand all

    required

    object [OrderBaseCustomer]

    id

    required

    string

    title

    string

    firstName

    required

    string

    middleName

    string

    lastName

    required

    string

    dateOfBirth

    required

    string

    gender

    required

    string

    allowMarketing

    required

    boolean

    contactInfo

    Expand all

    required

    object [ContactInfo]

    email

    required

    string

    mobile

    string

    Additional properties are NOT allowed.

    cprNumber

    string

    personnummer

    string

    Additional properties are allowed.

    __meta

    Expand all

    required

    object [OrderBaseMeta]

    key

    required

    string

    language

    required

    string

    loginUrl

    required

    string

    logoUrl

    required

    string

    myAccountUrl

    required

    string

    contactUsUrl

    required

    string

    privacyPolicyUrl

    required

    string

    termsofPurchaseUrl

    required

    string

    legalPoliciesUrl

    required

    string

    name

    required

    string

    supportContactNumber

    required

    string

    supportEmailAddress

    required

    string

    Additional properties are allowed.

    aftercareStore

    Expand all

    object [OrderBaseStore]

    address

    Expand all

    object [OrderBaseStoreAddress]

    city

    string

    country

    string

    line1

    string

    line2

    string

    line3

    string

    name

    string

    postcode

    string

    region

    string

    Additional properties are NOT allowed.

    companyDetails

    Expand all

    object [OrderBaseStoreCompanyDetails]

    name

    string

    registeredAddress

    string

    Additional properties are NOT allowed.

    contactInfo

    Expand all

    object [OrderBaseStoreContactInfo]

    phone

    string

    email

    string

    Additional properties are NOT allowed.

    coordinates

    Expand all

    object [OrderBaseStoreCoordinates]

    latitude

    string

    longitude

    string

    Additional properties are NOT allowed.

    lineOfBusiness

    string

    name

    string

    eposNumber

    string

    storeUrl

    string

    Additional properties are allowed.

    subscription

    Expand all

    required

    allOf

    Consists of BaseSubscription:

    Expand all

    object [BaseSubscription]

    uid: BaseSubscription

    id

    required

    string

    interval

    required

    number

    unit

    required

    string

    Allowed values:
    • "DAYS"
    • "WEEKS"
    • "MONTHS"

    type

    required

    string

    Allowed values:
    • "PREPAY"
    • "POSTPAY"
    • "RECURRING"

    status

    required

    string

    Allowed values:
    • "ACTIVE"
    • "PAUSED"
    • "EXPIRED"
    • "FAILED"
    • "FROZEN"
    • "CANCELLED"
    • "PENDING_CANCELLATION"

    instalments

    Expand all

    array<object [BaseInstalment]>

    object [BaseInstalment]

    id

    required

    string

    amount

    Expand all

    required

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    dueDate

    required

    string

    format: date-time

    paidDate

    Expand all

    oneOf

    Adheres to <anonymous-schema-117>:

    null

    Or to <anonymous-schema-118>:

    string

    format: date-time

    success

    Expand all

    oneOf

    Adheres to <anonymous-schema-120>:

    null

    Or to <anonymous-schema-121>:

    boolean

    Additional properties are allowed.

    Additional properties are allowed.

    And of <anonymous-schema-490>:

    Expand all

    object

    originalOrderId

    required

    string

    originalOrderNumber

    required

    string

    startedAt

    required

    string

    format: date-time

    type

    required

    string

    Additional properties are allowed.

    Additional properties are allowed.

    Extensions

    x-envelope-type

    cloudevent

    Additional properties are allowed.

    • #order

    Examples

    Payload

    {
      "id": "string",
      "specversion": "1.0",
      "env": "local",
      "sourceService": "com.specsavers/order-service",
      "type": "com.specsavers.subscription.resumed",
      "correlationid": "string",
      "subject": "string",
      "market": "GB",
      "datacontenttype": "application/json",
      "data": {
        "customer": {
          "id": "string",
          "title": "string",
          "firstName": "string",
          "middleName": "string",
          "lastName": "string",
          "dateOfBirth": "string",
          "gender": "string",
          "allowMarketing": true,
          "contactInfo": {
            "email": "string",
            "mobile": "string"
          },
          "cprNumber": "string",
          "personnummer": "string"
        },
        "__meta": {
          "key": "string",
          "language": "string",
          "loginUrl": "string",
          "logoUrl": "string",
          "myAccountUrl": "string",
          "contactUsUrl": "string",
          "privacyPolicyUrl": "string",
          "termsofPurchaseUrl": "string",
          "legalPoliciesUrl": "string",
          "name": "string",
          "supportContactNumber": "string",
          "supportEmailAddress": "string"
        },
        "aftercareStore": {
          "address": {
            "city": "string",
            "country": "string",
            "line1": "string",
            "line2": "string",
            "line3": "string",
            "name": "string",
            "postcode": "string",
            "region": "string"
          },
          "companyDetails": {
            "name": "string",
            "registeredAddress": "string"
          },
          "contactInfo": {
            "phone": "string",
            "email": "string"
          },
          "coordinates": {
            "latitude": "string",
            "longitude": "string"
          },
          "lineOfBusiness": "string",
          "name": "string",
          "eposNumber": "string",
          "storeUrl": "string"
        },
        "subscription": {
          "id": "string",
          "interval": 0,
          "unit": "DAYS",
          "type": "string",
          "status": "ACTIVE",
          "instalments": [
            {
              "id": "string",
              "amount": {
                "currencyCode": "string",
                "centAmount": 0
              },
              "dueDate": "2019-08-24T14:15:22Z",
              "paidDate": {},
              "success": {}
            }
          ],
          "originalOrderId": "string",
          "originalOrderNumber": "string",
          "startedAt": "2019-08-24T14:15:22Z"
        }
      }
    }
    

    This example has been generated automatically.

  • #17

    • application/json

    Message IDSubscriptionStatusUpdated

    Correlation ID$message.payload#/detail/correlationid

    Default Correlation ID

    The application will send new subscription updated events through this channel.

    Payload

    Expand all

    object

    id

    required

    string

    specversion

    required

    string

    Default value:"1.0"

    env

    string

    The environment from which the event originated from e.g. dev, prod

    Allowed values:
    • "local"
    • "dev"
    • "qa"
    • "qa2"
    • "stg"
    • "prod"

    sourceService

    string

    Const:"com.specsavers/order-service"

    type

    required

    string

    Const:"com.specsavers.subscription.status.updated"

    correlationid

    string

    The correlation ID of the event. E.g. 1234

    subject

    string

    market

    string

    Derived from locale i.e GB

    Default value:"GB"

    datacontenttype

    string

    Const:"application/json"

    data

    Expand all

    required

    object [SubscriptionStatusUpdatedData]

    customer

    Expand all

    required

    object [OrderBaseCustomer]

    id

    required

    string

    title

    string

    firstName

    required

    string

    middleName

    string

    lastName

    required

    string

    dateOfBirth

    required

    string

    gender

    required

    string

    allowMarketing

    required

    boolean

    contactInfo

    Expand all

    required

    object [ContactInfo]

    email

    required

    string

    mobile

    string

    Additional properties are NOT allowed.

    cprNumber

    string

    personnummer

    string

    Additional properties are allowed.

    __meta

    Expand all

    required

    object [OrderBaseMeta]

    key

    required

    string

    language

    required

    string

    loginUrl

    required

    string

    logoUrl

    required

    string

    myAccountUrl

    required

    string

    contactUsUrl

    required

    string

    privacyPolicyUrl

    required

    string

    termsofPurchaseUrl

    required

    string

    legalPoliciesUrl

    required

    string

    name

    required

    string

    supportContactNumber

    required

    string

    supportEmailAddress

    required

    string

    Additional properties are allowed.

    aftercareStore

    Expand all

    object [OrderBaseStore]

    address

    Expand all

    object [OrderBaseStoreAddress]

    city

    string

    country

    string

    line1

    string

    line2

    string

    line3

    string

    name

    string

    postcode

    string

    region

    string

    Additional properties are NOT allowed.

    companyDetails

    Expand all

    object [OrderBaseStoreCompanyDetails]

    name

    string

    registeredAddress

    string

    Additional properties are NOT allowed.

    contactInfo

    Expand all

    object [OrderBaseStoreContactInfo]

    phone

    string

    email

    string

    Additional properties are NOT allowed.

    coordinates

    Expand all

    object [OrderBaseStoreCoordinates]

    latitude

    string

    longitude

    string

    Additional properties are NOT allowed.

    lineOfBusiness

    string

    name

    string

    eposNumber

    string

    storeUrl

    string

    Additional properties are allowed.

    subscription

    Expand all

    required

    allOf

    Consists of BaseSubscription:

    Expand all

    object [BaseSubscription]

    uid: BaseSubscription

    id

    required

    string

    interval

    required

    number

    unit

    required

    string

    Allowed values:
    • "DAYS"
    • "WEEKS"
    • "MONTHS"

    type

    required

    string

    Allowed values:
    • "PREPAY"
    • "POSTPAY"
    • "RECURRING"

    status

    required

    string

    Allowed values:
    • "ACTIVE"
    • "PAUSED"
    • "EXPIRED"
    • "FAILED"
    • "FROZEN"
    • "CANCELLED"
    • "PENDING_CANCELLATION"

    instalments

    Expand all

    array<object [BaseInstalment]>

    object [BaseInstalment]

    id

    required

    string

    amount

    Expand all

    required

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    dueDate

    required

    string

    format: date-time

    paidDate

    Expand all

    oneOf

    Adheres to <anonymous-schema-117>:

    null

    Or to <anonymous-schema-118>:

    string

    format: date-time

    success

    Expand all

    oneOf

    Adheres to <anonymous-schema-120>:

    null

    Or to <anonymous-schema-121>:

    boolean

    Additional properties are allowed.

    Additional properties are allowed.

    And of <anonymous-schema-490>:

    Expand all

    object

    originalOrderId

    required

    string

    originalOrderNumber

    required

    string

    startedAt

    required

    string

    format: date-time

    type

    required

    string

    Additional properties are allowed.

    Additional properties are allowed.

    Extensions

    x-envelope-type

    cloudevent

    Additional properties are allowed.

    • #order

    Examples

    Payload

    {
      "id": "string",
      "specversion": "1.0",
      "env": "local",
      "sourceService": "com.specsavers/order-service",
      "type": "com.specsavers.subscription.status.updated",
      "correlationid": "string",
      "subject": "string",
      "market": "GB",
      "datacontenttype": "application/json",
      "data": {
        "customer": {
          "id": "string",
          "title": "string",
          "firstName": "string",
          "middleName": "string",
          "lastName": "string",
          "dateOfBirth": "string",
          "gender": "string",
          "allowMarketing": true,
          "contactInfo": {
            "email": "string",
            "mobile": "string"
          },
          "cprNumber": "string",
          "personnummer": "string"
        },
        "__meta": {
          "key": "string",
          "language": "string",
          "loginUrl": "string",
          "logoUrl": "string",
          "myAccountUrl": "string",
          "contactUsUrl": "string",
          "privacyPolicyUrl": "string",
          "termsofPurchaseUrl": "string",
          "legalPoliciesUrl": "string",
          "name": "string",
          "supportContactNumber": "string",
          "supportEmailAddress": "string"
        },
        "aftercareStore": {
          "address": {
            "city": "string",
            "country": "string",
            "line1": "string",
            "line2": "string",
            "line3": "string",
            "name": "string",
            "postcode": "string",
            "region": "string"
          },
          "companyDetails": {
            "name": "string",
            "registeredAddress": "string"
          },
          "contactInfo": {
            "phone": "string",
            "email": "string"
          },
          "coordinates": {
            "latitude": "string",
            "longitude": "string"
          },
          "lineOfBusiness": "string",
          "name": "string",
          "eposNumber": "string",
          "storeUrl": "string"
        },
        "subscription": {
          "id": "string",
          "interval": 0,
          "unit": "DAYS",
          "type": "string",
          "status": "ACTIVE",
          "instalments": [
            {
              "id": "string",
              "amount": {
                "currencyCode": "string",
                "centAmount": 0
              },
              "dueDate": "2019-08-24T14:15:22Z",
              "paidDate": {},
              "success": {}
            }
          ],
          "originalOrderId": "string",
          "originalOrderNumber": "string",
          "startedAt": "2019-08-24T14:15:22Z"
        }
      }
    }
    

    This example has been generated automatically.

  • #18

    • application/json

    Message IDSubscriptionCancelled

    Correlation ID$message.payload#/detail/correlationid

    Default Correlation ID

    The application will send subscription cancelled events through this channel.

    Payload

    Expand all

    object

    id

    required

    string

    specversion

    required

    string

    Default value:"1.0"

    env

    string

    The environment from which the event originated from e.g. dev, prod

    Allowed values:
    • "local"
    • "dev"
    • "qa"
    • "qa2"
    • "stg"
    • "prod"

    sourceService

    string

    Const:"com.specsavers/order-service"

    type

    required

    string

    Const:"com.specsavers.subscription.cancelled"

    correlationid

    string

    The correlation ID of the event. E.g. 1234

    subject

    string

    market

    string

    Derived from locale i.e GB

    Default value:"GB"

    datacontenttype

    string

    Const:"application/json"

    data

    Expand all

    required

    object [SubscriptionCancelledData]

    customer

    Expand all

    required

    object [OrderBaseCustomer]

    id

    required

    string

    title

    string

    firstName

    required

    string

    middleName

    string

    lastName

    required

    string

    dateOfBirth

    required

    string

    gender

    required

    string

    allowMarketing

    required

    boolean

    contactInfo

    Expand all

    required

    object [ContactInfo]

    email

    required

    string

    mobile

    string

    Additional properties are NOT allowed.

    cprNumber

    string

    personnummer

    string

    Additional properties are allowed.

    __meta

    Expand all

    required

    object [OrderBaseMeta]

    key

    required

    string

    language

    required

    string

    loginUrl

    required

    string

    logoUrl

    required

    string

    myAccountUrl

    required

    string

    contactUsUrl

    required

    string

    privacyPolicyUrl

    required

    string

    termsofPurchaseUrl

    required

    string

    legalPoliciesUrl

    required

    string

    name

    required

    string

    supportContactNumber

    required

    string

    supportEmailAddress

    required

    string

    Additional properties are allowed.

    aftercareStore

    Expand all

    object [OrderBaseStore]

    address

    Expand all

    object [OrderBaseStoreAddress]

    city

    string

    country

    string

    line1

    string

    line2

    string

    line3

    string

    name

    string

    postcode

    string

    region

    string

    Additional properties are NOT allowed.

    companyDetails

    Expand all

    object [OrderBaseStoreCompanyDetails]

    name

    string

    registeredAddress

    string

    Additional properties are NOT allowed.

    contactInfo

    Expand all

    object [OrderBaseStoreContactInfo]

    phone

    string

    email

    string

    Additional properties are NOT allowed.

    coordinates

    Expand all

    object [OrderBaseStoreCoordinates]

    latitude

    string

    longitude

    string

    Additional properties are NOT allowed.

    lineOfBusiness

    string

    name

    string

    eposNumber

    string

    storeUrl

    string

    Additional properties are allowed.

    subscription

    Expand all

    required

    allOf

    Consists of BaseSubscription:

    Expand all

    object [BaseSubscription]

    uid: BaseSubscription

    id

    required

    string

    interval

    required

    number

    unit

    required

    string

    Allowed values:
    • "DAYS"
    • "WEEKS"
    • "MONTHS"

    type

    required

    string

    Allowed values:
    • "PREPAY"
    • "POSTPAY"
    • "RECURRING"

    status

    required

    string

    Allowed values:
    • "ACTIVE"
    • "PAUSED"
    • "EXPIRED"
    • "FAILED"
    • "FROZEN"
    • "CANCELLED"
    • "PENDING_CANCELLATION"

    instalments

    Expand all

    array<object [BaseInstalment]>

    object [BaseInstalment]

    id

    required

    string

    amount

    Expand all

    required

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    dueDate

    required

    string

    format: date-time

    paidDate

    Expand all

    oneOf

    Adheres to <anonymous-schema-117>:

    null

    Or to <anonymous-schema-118>:

    string

    format: date-time

    success

    Expand all

    oneOf

    Adheres to <anonymous-schema-120>:

    null

    Or to <anonymous-schema-121>:

    boolean

    Additional properties are allowed.

    Additional properties are allowed.

    And of <anonymous-schema-510>:

    Expand all

    object

    originalOrderId

    required

    string

    originalOrderNumber

    required

    string

    startedAt

    required

    string

    format: date-time

    type

    required

    string

    cancellationInfo

    Expand all

    required

    object [SubscriptionCancellationInfoData]

    uid: SubscriptionCancellationInfoData

    id

    required

    string

    key

    required

    string

    code

    required

    string

    detail

    required

    string

    cancelledAt

    required

    string

    format: date-time

    cancelledBy

    Expand all

    required

    object [CancelledBy]

    id

    required

    string

    userType

    required

    string

    Allowed values:
    • "CUSTOMER"
    • "SYSTEM"
    • "COLLEAGUE"
    • "PARTIAL_CUSTOMER"
    • "ANONYMOUS_CUSTOMER"

    email

    required

    string

    name

    required

    string

    Additional properties are allowed.

    Additional properties are NOT allowed.

    Additional properties are allowed.

    Additional properties are allowed.

    Extensions

    x-envelope-type

    cloudevent

    Additional properties are allowed.

    • #order

    Examples

    Payload

    {
      "id": "string",
      "specversion": "1.0",
      "env": "local",
      "sourceService": "com.specsavers/order-service",
      "type": "com.specsavers.subscription.cancelled",
      "correlationid": "string",
      "subject": "string",
      "market": "GB",
      "datacontenttype": "application/json",
      "data": {
        "customer": {
          "id": "string",
          "title": "string",
          "firstName": "string",
          "middleName": "string",
          "lastName": "string",
          "dateOfBirth": "string",
          "gender": "string",
          "allowMarketing": true,
          "contactInfo": {
            "email": "string",
            "mobile": "string"
          },
          "cprNumber": "string",
          "personnummer": "string"
        },
        "__meta": {
          "key": "string",
          "language": "string",
          "loginUrl": "string",
          "logoUrl": "string",
          "myAccountUrl": "string",
          "contactUsUrl": "string",
          "privacyPolicyUrl": "string",
          "termsofPurchaseUrl": "string",
          "legalPoliciesUrl": "string",
          "name": "string",
          "supportContactNumber": "string",
          "supportEmailAddress": "string"
        },
        "aftercareStore": {
          "address": {
            "city": "string",
            "country": "string",
            "line1": "string",
            "line2": "string",
            "line3": "string",
            "name": "string",
            "postcode": "string",
            "region": "string"
          },
          "companyDetails": {
            "name": "string",
            "registeredAddress": "string"
          },
          "contactInfo": {
            "phone": "string",
            "email": "string"
          },
          "coordinates": {
            "latitude": "string",
            "longitude": "string"
          },
          "lineOfBusiness": "string",
          "name": "string",
          "eposNumber": "string",
          "storeUrl": "string"
        },
        "subscription": {
          "id": "string",
          "interval": 0,
          "unit": "DAYS",
          "type": "string",
          "status": "ACTIVE",
          "instalments": [
            {
              "id": "string",
              "amount": {
                "currencyCode": "string",
                "centAmount": 0
              },
              "dueDate": "2019-08-24T14:15:22Z",
              "paidDate": {},
              "success": {}
            }
          ],
          "originalOrderId": "string",
          "originalOrderNumber": "string",
          "startedAt": "2019-08-24T14:15:22Z",
          "cancellationInfo": {
            "id": "string",
            "key": "string",
            "code": "string",
            "detail": "string",
            "cancelledAt": "2019-08-24T14:15:22Z",
            "cancelledBy": {
              "id": "string",
              "userType": "CUSTOMER",
              "email": "string",
              "name": "string"
            }
          }
        }
      }
    }
    

    This example has been generated automatically.

  • #19

    • application/json

    Message IDSubscriptionProductSubstituted

    Correlation ID$message.payload#/detail/correlationid

    Default Correlation ID

    The application will send subscription product substitution events through this channel.

    Payload

    Expand all

    object

    id

    required

    string

    specversion

    required

    string

    Default value:"1.0"

    env

    string

    The environment from which the event originated from e.g. dev, prod

    Allowed values:
    • "local"
    • "dev"
    • "qa"
    • "qa2"
    • "stg"
    • "prod"

    sourceService

    string

    Const:"com.specsavers/order-service"

    type

    required

    string

    Const:"com.specsavers.rtp.order.subscription.product.substituted"

    correlationid

    string

    The correlation ID of the event. E.g. 1234

    subject

    string

    datacontenttype

    string

    Const:"application/json"

    data

    Expand all

    required

    object [SubscriptionProductSubstitutedData]

    productSubstitution

    Expand all

    required

    object [ProductSubstitution]

    oldSku

    required

    string

    newSku

    required

    string

    sendEmail

    boolean

    Additional properties are allowed.

    Additional properties are allowed.

    Extensions

    x-envelope-type

    cloudevent

    Additional properties are allowed.

    • #order

    Examples

    Payload

    {
      "id": "string",
      "specversion": "1.0",
      "env": "local",
      "sourceService": "com.specsavers/order-service",
      "type": "com.specsavers.rtp.order.subscription.product.substituted",
      "correlationid": "string",
      "subject": "string",
      "datacontenttype": "application/json",
      "data": {
        "productSubstitution": {
          "oldSku": "string",
          "newSku": "string",
          "sendEmail": true
        }
      }
    }
    

    This example has been generated automatically.

  • #20

    • application/json

    Message IDSubscriptionProductSubstitutedBySku

    Correlation ID$message.payload#/detail/correlationid

    Default Correlation ID

    The application will send subscription product substitution by SKU events through this channel.

    Payload

    Expand all

    object

    id

    required

    string

    specversion

    required

    string

    Default value:"1.0"

    env

    string

    The environment from which the event originated from e.g. dev, prod

    Allowed values:
    • "local"
    • "dev"
    • "qa"
    • "qa2"
    • "stg"
    • "prod"

    sourceService

    string

    Const:"com.specsavers/order-service"

    type

    required

    string

    Const:"com.specsavers.rtp.order.subscription.product.substituted-by-sku"

    correlationid

    string

    The correlation ID of the event. E.g. 1234

    subject

    string

    datacontenttype

    string

    Const:"application/json"

    data

    Expand all

    required

    object [SubscriptionProductSubstitutedBySkuData]

    cart

    Expand all

    required

    object [Cart]

    id

    required

    string

    Additional properties are NOT allowed.

    productSubstitution

    Expand all

    required

    object [ProductSubstitution]

    oldSku

    required

    string

    newSku

    required

    string

    sendEmail

    boolean

    Additional properties are allowed.

    Additional properties are allowed.

    Extensions

    x-envelope-type

    cloudevent

    Additional properties are allowed.

    • #order

    Examples

    Payload

    {
      "id": "string",
      "specversion": "1.0",
      "env": "local",
      "sourceService": "com.specsavers/order-service",
      "type": "com.specsavers.rtp.order.subscription.product.substituted-by-sku",
      "correlationid": "string",
      "subject": "string",
      "datacontenttype": "application/json",
      "data": {
        "cart": {
          "id": "string"
        },
        "productSubstitution": {
          "oldSku": "string",
          "newSku": "string",
          "sendEmail": true
        }
      }
    }
    

    This example has been generated automatically.

  • #21

    • application/json

    Message IDOrderCompleted

    Correlation ID$message.payload#/detail/correlationid

    Default Correlation ID

    The application will send new order completed events through this channel.

    Payload

    Expand all

    object

    id

    required

    string

    specversion

    required

    string

    Default value:"1.0"

    env

    string

    The environment from which the event originated from e.g. dev, prod

    Allowed values:
    • "local"
    • "dev"
    • "qa"
    • "qa2"
    • "stg"
    • "prod"

    sourceService

    string

    Const:"com.specsavers/order-service"

    type

    required

    string

    Const:"com.specsavers.order.completed"

    correlationid

    string

    The correlation ID of the event. E.g. 1234

    subject

    string

    market

    string

    Derived from locale i.e GB

    Default value:"GB"

    datacontenttype

    string

    Const:"application/json"

    data

    Expand all

    required

    object [OrderCompletedData]

    __meta

    Expand all

    object [OrderBaseMeta]

    key

    required

    string

    language

    required

    string

    loginUrl

    required

    string

    logoUrl

    required

    string

    myAccountUrl

    required

    string

    contactUsUrl

    required

    string

    privacyPolicyUrl

    required

    string

    termsofPurchaseUrl

    required

    string

    legalPoliciesUrl

    required

    string

    name

    required

    string

    supportContactNumber

    required

    string

    supportEmailAddress

    required

    string

    Additional properties are allowed.

    customer

    Expand all

    required

    object [OrderBaseCustomer]

    id

    required

    string

    title

    string

    firstName

    required

    string

    middleName

    string

    lastName

    required

    string

    dateOfBirth

    required

    string

    gender

    required

    string

    allowMarketing

    required

    boolean

    contactInfo

    Expand all

    required

    object [ContactInfo]

    email

    required

    string

    mobile

    string

    Additional properties are NOT allowed.

    cprNumber

    string

    personnummer

    string

    Additional properties are allowed.

    order

    Expand all

    required

    allOf

    Consists of OrderBaseOrder:

    Expand all

    object [OrderBaseOrder]

    uid: OrderBaseOrder

    id

    required

    string

    createdAt

    required

    string

    format: date-time

    createdBy

    Expand all

    required

    object [CreatedBy]

    email

    string

    userType

    string

    Additional properties are allowed.

    locale

    required

    string

    number

    required

    string

    invoice

    Expand all

    object [InvoiceOrCreditNote]

    id

    required

    string

    fileName

    required

    string

    createdAt

    required

    string

    format: date-time

    lastUpdatedAt

    required

    string

    format: date-time

    externalUrl

    required

    string

    storageAccountName

    required

    string

    storageContainerName

    required

    string

    storagePath

    required

    string

    Additional properties are allowed.

    lineItemGroups

    Expand all

    required

    array<object [LineItemGroupType]>

    object [LineItemGroupType]

    id

    required

    number

    type

    required

    string

    number

    required

    string

    manufacturingData

    Expand all

    object [ManufacturingData]

    requisitionRequestId

    required

    number

    manufacturingData

    string

    frameAvailable

    required

    boolean

    orderType

    required

    string

    errors

    Expand all

    array<string> | null

    Items:

    string

    infos

    Expand all

    array<string> | null

    Items:

    string

    warnings

    Expand all

    array<string> | null

    Items:

    string

    Additional properties are allowed.

    Additional properties are allowed.

    orderState

    required

    string

    Allowed values:
    • "OPEN"
    • "COLLECTED"
    • "PROCESSING"
    • "CONFIRMED"
    • "BACK_ORDERED"
    • "COMPLETE"
    • "SHIPPED"
    • "CANCELLED"
    • "REMORSE"
    • "PENDING_RX_VALIDATION"
    • "PENDING_CANCELLATION"

    origin

    required

    string

    Allowed values:
    • "ONLINE"
    • "INSTORE"
    • "CUSTOMER_SERVICE"

    originalOrder

    Expand all

    object [OriginalOrder]

    id

    string

    number

    string

    Additional properties are NOT allowed.

    subscription

    Expand all

    object [BaseSubscription]

    uid: BaseSubscription

    id

    required

    string

    interval

    required

    number

    unit

    required

    string

    Allowed values:
    • "DAYS"
    • "WEEKS"
    • "MONTHS"

    type

    required

    string

    Allowed values:
    • "PREPAY"
    • "POSTPAY"
    • "RECURRING"

    status

    required

    string

    Allowed values:
    • "ACTIVE"
    • "PAUSED"
    • "EXPIRED"
    • "FAILED"
    • "FROZEN"
    • "CANCELLED"
    • "PENDING_CANCELLATION"

    instalments

    Expand all

    array<object [BaseInstalment]>

    object [BaseInstalment]

    id

    required

    string

    amount

    Expand all

    required

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    dueDate

    required

    string

    format: date-time

    paidDate

    Expand all

    oneOf

    Adheres to <anonymous-schema-117>:

    null

    Or to <anonymous-schema-118>:

    string

    format: date-time

    success

    Expand all

    oneOf

    Adheres to <anonymous-schema-120>:

    null

    Or to <anonymous-schema-121>:

    boolean

    Additional properties are allowed.

    Additional properties are allowed.

    type

    required

    string

    Allowed values:
    • "STANDARD"
    • "RECURRING"
    • "REPLACEMENT"
    • "REPAIR"
    • "REMAKE"

    Additional properties are allowed.

    And of <anonymous-schema-564>:

    Expand all

    object

    deliveries

    Expand all

    array<object [BaseDeliveryType]>

    object [BaseDeliveryType]

    id

    required

    string

    key

    string

    createdAt

    string

    items

    Expand all

    required

    array<object [DeliveryItem]>

    object [DeliveryItem]

    id

    string

    quantity

    number

    Additional properties are allowed.

    state

    string

    Additional properties are allowed.

    lineItems

    Expand all

    required

    array<object allOf>

    Items:

    object allOf

    Consists of <anonymous-schema-577>:

    Expand all

    object

    groupId

    required

    number

    id

    required

    string

    itemCategory

    required

    string

    eye

    string

    Allowed values:
    • "L"
    • "R"
    • "LR"

    name

    required

    string

    number

    required

    string

    groupNumber

    required

    string

    quantity

    required

    number

    sku

    required

    string

    state

    string

    style

    string

    Additional properties are allowed.

    And of <anonymous-schema-589>:

    Expand all

    object

    originalLineItem

    Expand all

    allOf

    Consists of <anonymous-schema-577>:

    Expand all

    object

    groupId

    required

    number

    id

    required

    string

    itemCategory

    required

    string

    eye

    string

    Allowed values:
    • "L"
    • "R"
    • "LR"

    name

    required

    string

    number

    required

    string

    groupNumber

    required

    string

    quantity

    required

    number

    sku

    required

    string

    state

    string

    style

    string

    Additional properties are allowed.

    And of <anonymous-schema-591>:

    Expand all

    object

    Additional properties are allowed.

    Additional properties are allowed.

    Additional properties are allowed.

    Additional properties are allowed.

    aftercareStore

    Expand all

    object [OrderBaseStore]

    address

    Expand all

    object [OrderBaseStoreAddress]

    city

    string

    country

    string

    line1

    string

    line2

    string

    line3

    string

    name

    string

    postcode

    string

    region

    string

    Additional properties are NOT allowed.

    companyDetails

    Expand all

    object [OrderBaseStoreCompanyDetails]

    name

    string

    registeredAddress

    string

    Additional properties are NOT allowed.

    contactInfo

    Expand all

    object [OrderBaseStoreContactInfo]

    phone

    string

    email

    string

    Additional properties are NOT allowed.

    coordinates

    Expand all

    object [OrderBaseStoreCoordinates]

    latitude

    string

    longitude

    string

    Additional properties are NOT allowed.

    lineOfBusiness

    string

    name

    string

    eposNumber

    string

    storeUrl

    string

    Additional properties are allowed.

    Additional properties are allowed.

    Extensions

    x-envelope-type

    cloudevent

    Additional properties are allowed.

    • #order

    Examples

    Payload

    {
      "id": "string",
      "specversion": "1.0",
      "env": "local",
      "sourceService": "com.specsavers/order-service",
      "type": "com.specsavers.order.completed",
      "correlationid": "string",
      "subject": "string",
      "market": "GB",
      "datacontenttype": "application/json",
      "data": {
        "__meta": {
          "key": "string",
          "language": "string",
          "loginUrl": "string",
          "logoUrl": "string",
          "myAccountUrl": "string",
          "contactUsUrl": "string",
          "privacyPolicyUrl": "string",
          "termsofPurchaseUrl": "string",
          "legalPoliciesUrl": "string",
          "name": "string",
          "supportContactNumber": "string",
          "supportEmailAddress": "string"
        },
        "customer": {
          "id": "string",
          "title": "string",
          "firstName": "string",
          "middleName": "string",
          "lastName": "string",
          "dateOfBirth": "string",
          "gender": "string",
          "allowMarketing": true,
          "contactInfo": {
            "email": "string",
            "mobile": "string"
          },
          "cprNumber": "string",
          "personnummer": "string"
        },
        "order": {
          "id": "string",
          "createdAt": "2019-08-24T14:15:22Z",
          "createdBy": {
            "email": "string",
            "userType": "string"
          },
          "locale": "string",
          "number": "string",
          "invoice": {
            "id": "string",
            "fileName": "string",
            "createdAt": "2019-08-24T14:15:22Z",
            "lastUpdatedAt": "2019-08-24T14:15:22Z",
            "externalUrl": "string",
            "storageAccountName": "string",
            "storageContainerName": "string",
            "storagePath": "string"
          },
          "lineItemGroups": [
            {
              "id": 0,
              "type": "string",
              "number": "string",
              "manufacturingData": {
                "requisitionRequestId": 0,
                "manufacturingData": "string",
                "frameAvailable": true,
                "orderType": "string",
                "errors": [
                  "string"
                ],
                "infos": [
                  "string"
                ],
                "warnings": [
                  "string"
                ]
              }
            }
          ],
          "orderState": "OPEN",
          "origin": "ONLINE",
          "originalOrder": {
            "id": "string",
            "number": "string"
          },
          "subscription": {
            "id": "string",
            "interval": 0,
            "unit": "DAYS",
            "type": "PREPAY",
            "status": "ACTIVE",
            "instalments": [
              {
                "id": "string",
                "amount": {
                  "currencyCode": "string",
                  "centAmount": 0
                },
                "dueDate": "2019-08-24T14:15:22Z",
                "paidDate": {},
                "success": {}
              }
            ]
          },
          "type": "STANDARD",
          "deliveries": [
            {
              "id": "string",
              "key": "string",
              "createdAt": "string",
              "items": [
                {
                  "id": "string",
                  "quantity": 0
                }
              ],
              "state": "string"
            }
          ],
          "lineItems": [
            {
              "groupId": 0,
              "id": "string",
              "itemCategory": "string",
              "eye": "L",
              "name": "string",
              "number": "string",
              "groupNumber": "string",
              "quantity": 0,
              "sku": "string",
              "state": "string",
              "style": "string",
              "originalLineItem": {
                "groupId": 0,
                "id": "string",
                "itemCategory": "string",
                "eye": "L",
                "name": "string",
                "number": "string",
                "groupNumber": "string",
                "quantity": 0,
                "sku": "string",
                "state": "string",
                "style": "string"
              }
            }
          ]
        },
        "aftercareStore": {
          "address": {
            "city": "string",
            "country": "string",
            "line1": "string",
            "line2": "string",
            "line3": "string",
            "name": "string",
            "postcode": "string",
            "region": "string"
          },
          "companyDetails": {
            "name": "string",
            "registeredAddress": "string"
          },
          "contactInfo": {
            "phone": "string",
            "email": "string"
          },
          "coordinates": {
            "latitude": "string",
            "longitude": "string"
          },
          "lineOfBusiness": "string",
          "name": "string",
          "eposNumber": "string",
          "storeUrl": "string"
        }
      }
    }
    

    This example has been generated automatically.

  • #22

    • application/json

    Message IDOrderUpdated

    Correlation ID$message.payload#/detail/correlationid

    Default Correlation ID

    The application will send new order events through this channel for order status update.

    Payload

    Expand all

    object

    id

    required

    string

    specversion

    required

    string

    Default value:"1.0"

    env

    required

    string

    The environment from which the event originated from e.g. dev, prod

    Allowed values:
    • "local"
    • "dev"
    • "qa"
    • "qa2"
    • "stg"
    • "prod"

    sourceService

    string

    Const:"com.specsavers/order-service"

    type

    required

    string

    Const:"com.specsavers.order.updated"

    correlationid

    required

    string

    The correlation ID of the event. E.g. 1234

    data

    Expand all

    required

    object [OrderUpdatedData]

    __meta

    Expand all

    object [OrderBaseMeta]

    key

    required

    string

    language

    required

    string

    loginUrl

    required

    string

    logoUrl

    required

    string

    myAccountUrl

    required

    string

    contactUsUrl

    required

    string

    privacyPolicyUrl

    required

    string

    termsofPurchaseUrl

    required

    string

    legalPoliciesUrl

    required

    string

    name

    required

    string

    supportContactNumber

    required

    string

    supportEmailAddress

    required

    string

    Additional properties are allowed.

    customer

    Expand all

    required

    object [OrderBaseCustomer]

    id

    required

    string

    title

    string

    firstName

    required

    string

    middleName

    string

    lastName

    required

    string

    dateOfBirth

    required

    string

    gender

    required

    string

    allowMarketing

    required

    boolean

    contactInfo

    Expand all

    required

    object [ContactInfo]

    email

    required

    string

    mobile

    string

    Additional properties are NOT allowed.

    cprNumber

    string

    personnummer

    string

    Additional properties are allowed.

    order

    Expand all

    required

    allOf

    Consists of OrderBaseOrder:

    Expand all

    object [OrderBaseOrder]

    uid: OrderBaseOrder

    id

    required

    string

    createdAt

    required

    string

    format: date-time

    createdBy

    Expand all

    required

    object [CreatedBy]

    email

    string

    userType

    string

    Additional properties are allowed.

    locale

    required

    string

    number

    required

    string

    invoice

    Expand all

    object [InvoiceOrCreditNote]

    id

    required

    string

    fileName

    required

    string

    createdAt

    required

    string

    format: date-time

    lastUpdatedAt

    required

    string

    format: date-time

    externalUrl

    required

    string

    storageAccountName

    required

    string

    storageContainerName

    required

    string

    storagePath

    required

    string

    Additional properties are allowed.

    lineItemGroups

    Expand all

    required

    array<object [LineItemGroupType]>

    object [LineItemGroupType]

    id

    required

    number

    type

    required

    string

    number

    required

    string

    manufacturingData

    Expand all

    object [ManufacturingData]

    requisitionRequestId

    required

    number

    manufacturingData

    string

    frameAvailable

    required

    boolean

    orderType

    required

    string

    errors

    Expand all

    array<string> | null

    Items:

    string

    infos

    Expand all

    array<string> | null

    Items:

    string

    warnings

    Expand all

    array<string> | null

    Items:

    string

    Additional properties are allowed.

    Additional properties are allowed.

    orderState

    required

    string

    Allowed values:
    • "OPEN"
    • "COLLECTED"
    • "PROCESSING"
    • "CONFIRMED"
    • "BACK_ORDERED"
    • "COMPLETE"
    • "SHIPPED"
    • "CANCELLED"
    • "REMORSE"
    • "PENDING_RX_VALIDATION"
    • "PENDING_CANCELLATION"

    origin

    required

    string

    Allowed values:
    • "ONLINE"
    • "INSTORE"
    • "CUSTOMER_SERVICE"

    originalOrder

    Expand all

    object [OriginalOrder]

    id

    string

    number

    string

    Additional properties are NOT allowed.

    subscription

    Expand all

    object [BaseSubscription]

    uid: BaseSubscription

    id

    required

    string

    interval

    required

    number

    unit

    required

    string

    Allowed values:
    • "DAYS"
    • "WEEKS"
    • "MONTHS"

    type

    required

    string

    Allowed values:
    • "PREPAY"
    • "POSTPAY"
    • "RECURRING"

    status

    required

    string

    Allowed values:
    • "ACTIVE"
    • "PAUSED"
    • "EXPIRED"
    • "FAILED"
    • "FROZEN"
    • "CANCELLED"
    • "PENDING_CANCELLATION"

    instalments

    Expand all

    array<object [BaseInstalment]>

    object [BaseInstalment]

    id

    required

    string

    amount

    Expand all

    required

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    dueDate

    required

    string

    format: date-time

    paidDate

    Expand all

    oneOf

    Adheres to <anonymous-schema-117>:

    null

    Or to <anonymous-schema-118>:

    string

    format: date-time

    success

    Expand all

    oneOf

    Adheres to <anonymous-schema-120>:

    null

    Or to <anonymous-schema-121>:

    boolean

    Additional properties are allowed.

    Additional properties are allowed.

    type

    required

    string

    Allowed values:
    • "STANDARD"
    • "RECURRING"
    • "REPLACEMENT"
    • "REPAIR"
    • "REMAKE"

    Additional properties are allowed.

    And of <anonymous-schema-597>:

    Expand all

    object

    lineItems

    Expand all

    required

    array<object allOf>

    Items:

    object allOf

    Consists of <anonymous-schema-577>:

    Expand all

    object

    groupId

    required

    number

    id

    required

    string

    itemCategory

    required

    string

    eye

    string

    Allowed values:
    • "L"
    • "R"
    • "LR"

    name

    required

    string

    number

    required

    string

    groupNumber

    required

    string

    quantity

    required

    number

    sku

    required

    string

    state

    string

    style

    string

    Additional properties are allowed.

    And of <anonymous-schema-589>:

    Expand all

    object

    originalLineItem

    Expand all

    allOf

    Consists of <anonymous-schema-577>:

    Expand all

    object

    groupId

    required

    number

    id

    required

    string

    itemCategory

    required

    string

    eye

    string

    Allowed values:
    • "L"
    • "R"
    • "LR"

    name

    required

    string

    number

    required

    string

    groupNumber

    required

    string

    quantity

    required

    number

    sku

    required

    string

    state

    string

    style

    string

    Additional properties are allowed.

    And of <anonymous-schema-591>:

    Expand all

    object

    Additional properties are allowed.

    Additional properties are allowed.

    Additional properties are allowed.

    Additional properties are allowed.

    aftercareStore

    Expand all

    object [OrderBaseStore]

    address

    Expand all

    object [OrderBaseStoreAddress]

    city

    string

    country

    string

    line1

    string

    line2

    string

    line3

    string

    name

    string

    postcode

    string

    region

    string

    Additional properties are NOT allowed.

    companyDetails

    Expand all

    object [OrderBaseStoreCompanyDetails]

    name

    string

    registeredAddress

    string

    Additional properties are NOT allowed.

    contactInfo

    Expand all

    object [OrderBaseStoreContactInfo]

    phone

    string

    email

    string

    Additional properties are NOT allowed.

    coordinates

    Expand all

    object [OrderBaseStoreCoordinates]

    latitude

    string

    longitude

    string

    Additional properties are NOT allowed.

    lineOfBusiness

    string

    name

    string

    eposNumber

    string

    storeUrl

    string

    Additional properties are allowed.

    Additional properties are allowed.

    Extensions

    x-envelope-type

    cloudevent

    Additional properties are allowed.

    • #order

    Examples

    Payload

    {
      "id": "string",
      "specversion": "1.0",
      "env": "local",
      "sourceService": "com.specsavers/order-service",
      "type": "com.specsavers.order.updated",
      "correlationid": "string",
      "data": {
        "__meta": {
          "key": "string",
          "language": "string",
          "loginUrl": "string",
          "logoUrl": "string",
          "myAccountUrl": "string",
          "contactUsUrl": "string",
          "privacyPolicyUrl": "string",
          "termsofPurchaseUrl": "string",
          "legalPoliciesUrl": "string",
          "name": "string",
          "supportContactNumber": "string",
          "supportEmailAddress": "string"
        },
        "customer": {
          "id": "string",
          "title": "string",
          "firstName": "string",
          "middleName": "string",
          "lastName": "string",
          "dateOfBirth": "string",
          "gender": "string",
          "allowMarketing": true,
          "contactInfo": {
            "email": "string",
            "mobile": "string"
          },
          "cprNumber": "string",
          "personnummer": "string"
        },
        "order": {
          "id": "string",
          "createdAt": "2019-08-24T14:15:22Z",
          "createdBy": {
            "email": "string",
            "userType": "string"
          },
          "locale": "string",
          "number": "string",
          "invoice": {
            "id": "string",
            "fileName": "string",
            "createdAt": "2019-08-24T14:15:22Z",
            "lastUpdatedAt": "2019-08-24T14:15:22Z",
            "externalUrl": "string",
            "storageAccountName": "string",
            "storageContainerName": "string",
            "storagePath": "string"
          },
          "lineItemGroups": [
            {
              "id": 0,
              "type": "string",
              "number": "string",
              "manufacturingData": {
                "requisitionRequestId": 0,
                "manufacturingData": "string",
                "frameAvailable": true,
                "orderType": "string",
                "errors": [
                  "string"
                ],
                "infos": [
                  "string"
                ],
                "warnings": [
                  "string"
                ]
              }
            }
          ],
          "orderState": "OPEN",
          "origin": "ONLINE",
          "originalOrder": {
            "id": "string",
            "number": "string"
          },
          "subscription": {
            "id": "string",
            "interval": 0,
            "unit": "DAYS",
            "type": "PREPAY",
            "status": "ACTIVE",
            "instalments": [
              {
                "id": "string",
                "amount": {
                  "currencyCode": "string",
                  "centAmount": 0
                },
                "dueDate": "2019-08-24T14:15:22Z",
                "paidDate": {},
                "success": {}
              }
            ]
          },
          "type": "STANDARD",
          "lineItems": [
            {
              "groupId": 0,
              "id": "string",
              "itemCategory": "string",
              "eye": "L",
              "name": "string",
              "number": "string",
              "groupNumber": "string",
              "quantity": 0,
              "sku": "string",
              "state": "string",
              "style": "string",
              "originalLineItem": {
                "groupId": 0,
                "id": "string",
                "itemCategory": "string",
                "eye": "L",
                "name": "string",
                "number": "string",
                "groupNumber": "string",
                "quantity": 0,
                "sku": "string",
                "state": "string",
                "style": "string"
              }
            }
          ]
        },
        "aftercareStore": {
          "address": {
            "city": "string",
            "country": "string",
            "line1": "string",
            "line2": "string",
            "line3": "string",
            "name": "string",
            "postcode": "string",
            "region": "string"
          },
          "companyDetails": {
            "name": "string",
            "registeredAddress": "string"
          },
          "contactInfo": {
            "phone": "string",
            "email": "string"
          },
          "coordinates": {
            "latitude": "string",
            "longitude": "string"
          },
          "lineOfBusiness": "string",
          "name": "string",
          "eposNumber": "string",
          "storeUrl": "string"
        }
      }
    }
    

    This example has been generated automatically.

  • #23

    • application/json

    Message IDOrderShipped

    Correlation ID$message.payload#/detail/correlationid

    Default Correlation ID

    The application will send new order shipped events through this channel.

    Payload

    Expand all

    object

    id

    required

    string

    specversion

    required

    string

    Default value:"1.0"

    env

    string

    The environment from which the event originated from e.g. dev, prod

    Allowed values:
    • "local"
    • "dev"
    • "qa"
    • "qa2"
    • "stg"
    • "prod"

    sourceService

    string

    Const:"com.specsavers/order-service"

    type

    required

    string

    Const:"com.specsavers.order.shipped"

    correlationid

    string

    The correlation ID of the event. E.g. 1234

    subject

    string

    market

    string

    Derived from locale i.e GB

    Default value:"GB"

    datacontenttype

    string

    Const:"application/json"

    data

    Expand all

    required

    object [OrderShippedData]

    __meta

    Expand all

    object [OrderBaseMeta]

    key

    required

    string

    language

    required

    string

    loginUrl

    required

    string

    logoUrl

    required

    string

    myAccountUrl

    required

    string

    contactUsUrl

    required

    string

    privacyPolicyUrl

    required

    string

    termsofPurchaseUrl

    required

    string

    legalPoliciesUrl

    required

    string

    name

    required

    string

    supportContactNumber

    required

    string

    supportEmailAddress

    required

    string

    Additional properties are allowed.

    customer

    Expand all

    required

    object [OrderBaseCustomer]

    id

    required

    string

    title

    string

    firstName

    required

    string

    middleName

    string

    lastName

    required

    string

    dateOfBirth

    required

    string

    gender

    required

    string

    allowMarketing

    required

    boolean

    contactInfo

    Expand all

    required

    object [ContactInfo]

    email

    required

    string

    mobile

    string

    Additional properties are NOT allowed.

    cprNumber

    string

    personnummer

    string

    Additional properties are allowed.

    order

    Expand all

    required

    allOf

    Consists of OrderBaseOrder:

    Expand all

    object [OrderBaseOrder]

    uid: OrderBaseOrder

    id

    required

    string

    createdAt

    required

    string

    format: date-time

    createdBy

    Expand all

    required

    object [CreatedBy]

    email

    string

    userType

    string

    Additional properties are allowed.

    locale

    required

    string

    number

    required

    string

    invoice

    Expand all

    object [InvoiceOrCreditNote]

    id

    required

    string

    fileName

    required

    string

    createdAt

    required

    string

    format: date-time

    lastUpdatedAt

    required

    string

    format: date-time

    externalUrl

    required

    string

    storageAccountName

    required

    string

    storageContainerName

    required

    string

    storagePath

    required

    string

    Additional properties are allowed.

    lineItemGroups

    Expand all

    required

    array<object [LineItemGroupType]>

    object [LineItemGroupType]

    id

    required

    number

    type

    required

    string

    number

    required

    string

    manufacturingData

    Expand all

    object [ManufacturingData]

    requisitionRequestId

    required

    number

    manufacturingData

    string

    frameAvailable

    required

    boolean

    orderType

    required

    string

    errors

    Expand all

    array<string> | null

    Items:

    string

    infos

    Expand all

    array<string> | null

    Items:

    string

    warnings

    Expand all

    array<string> | null

    Items:

    string

    Additional properties are allowed.

    Additional properties are allowed.

    orderState

    required

    string

    Allowed values:
    • "OPEN"
    • "COLLECTED"
    • "PROCESSING"
    • "CONFIRMED"
    • "BACK_ORDERED"
    • "COMPLETE"
    • "SHIPPED"
    • "CANCELLED"
    • "REMORSE"
    • "PENDING_RX_VALIDATION"
    • "PENDING_CANCELLATION"

    origin

    required

    string

    Allowed values:
    • "ONLINE"
    • "INSTORE"
    • "CUSTOMER_SERVICE"

    originalOrder

    Expand all

    object [OriginalOrder]

    id

    string

    number

    string

    Additional properties are NOT allowed.

    subscription

    Expand all

    object [BaseSubscription]

    uid: BaseSubscription

    id

    required

    string

    interval

    required

    number

    unit

    required

    string

    Allowed values:
    • "DAYS"
    • "WEEKS"
    • "MONTHS"

    type

    required

    string

    Allowed values:
    • "PREPAY"
    • "POSTPAY"
    • "RECURRING"

    status

    required

    string

    Allowed values:
    • "ACTIVE"
    • "PAUSED"
    • "EXPIRED"
    • "FAILED"
    • "FROZEN"
    • "CANCELLED"
    • "PENDING_CANCELLATION"

    instalments

    Expand all

    array<object [BaseInstalment]>

    object [BaseInstalment]

    id

    required

    string

    amount

    Expand all

    required

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    dueDate

    required

    string

    format: date-time

    paidDate

    Expand all

    oneOf

    Adheres to <anonymous-schema-117>:

    null

    Or to <anonymous-schema-118>:

    string

    format: date-time

    success

    Expand all

    oneOf

    Adheres to <anonymous-schema-120>:

    null

    Or to <anonymous-schema-121>:

    boolean

    Additional properties are allowed.

    Additional properties are allowed.

    type

    required

    string

    Allowed values:
    • "STANDARD"
    • "RECURRING"
    • "REPLACEMENT"
    • "REPAIR"
    • "REMAKE"

    Additional properties are allowed.

    And of <anonymous-schema-607>:

    Expand all

    object

    lineItems

    Expand all

    required

    array<object allOf>

    Items:

    object allOf

    Consists of <anonymous-schema-577>:

    Expand all

    object

    groupId

    required

    number

    id

    required

    string

    itemCategory

    required

    string

    eye

    string

    Allowed values:
    • "L"
    • "R"
    • "LR"

    name

    required

    string

    number

    required

    string

    groupNumber

    required

    string

    quantity

    required

    number

    sku

    required

    string

    state

    string

    style

    string

    Additional properties are allowed.

    And of <anonymous-schema-589>:

    Expand all

    object

    originalLineItem

    Expand all

    allOf

    Consists of <anonymous-schema-577>:

    Expand all

    object

    groupId

    required

    number

    id

    required

    string

    itemCategory

    required

    string

    eye

    string

    Allowed values:
    • "L"
    • "R"
    • "LR"

    name

    required

    string

    number

    required

    string

    groupNumber

    required

    string

    quantity

    required

    number

    sku

    required

    string

    state

    string

    style

    string

    Additional properties are allowed.

    And of <anonymous-schema-591>:

    Expand all

    object

    Additional properties are allowed.

    Additional properties are allowed.

    Additional properties are allowed.

    deliveries

    Expand all

    array<object [BaseDeliveryType]>

    object [BaseDeliveryType]

    id

    required

    string

    key

    string

    createdAt

    string

    items

    Expand all

    required

    array<object [DeliveryItem]>

    object [DeliveryItem]

    id

    string

    quantity

    number

    Additional properties are allowed.

    state

    string

    Additional properties are allowed.

    Additional properties are allowed.

    aftercareStore

    Expand all

    object [OrderBaseStore]

    address

    Expand all

    object [OrderBaseStoreAddress]

    city

    string

    country

    string

    line1

    string

    line2

    string

    line3

    string

    name

    string

    postcode

    string

    region

    string

    Additional properties are NOT allowed.

    companyDetails

    Expand all

    object [OrderBaseStoreCompanyDetails]

    name

    string

    registeredAddress

    string

    Additional properties are NOT allowed.

    contactInfo

    Expand all

    object [OrderBaseStoreContactInfo]

    phone

    string

    email

    string

    Additional properties are NOT allowed.

    coordinates

    Expand all

    object [OrderBaseStoreCoordinates]

    latitude

    string

    longitude

    string

    Additional properties are NOT allowed.

    lineOfBusiness

    string

    name

    string

    eposNumber

    string

    storeUrl

    string

    Additional properties are allowed.

    Additional properties are allowed.

    Extensions

    x-envelope-type

    cloudevent

    Additional properties are allowed.

    • #order

    Examples

    Payload

    {
      "id": "string",
      "specversion": "1.0",
      "env": "local",
      "sourceService": "com.specsavers/order-service",
      "type": "com.specsavers.order.shipped",
      "correlationid": "string",
      "subject": "string",
      "market": "GB",
      "datacontenttype": "application/json",
      "data": {
        "__meta": {
          "key": "string",
          "language": "string",
          "loginUrl": "string",
          "logoUrl": "string",
          "myAccountUrl": "string",
          "contactUsUrl": "string",
          "privacyPolicyUrl": "string",
          "termsofPurchaseUrl": "string",
          "legalPoliciesUrl": "string",
          "name": "string",
          "supportContactNumber": "string",
          "supportEmailAddress": "string"
        },
        "customer": {
          "id": "string",
          "title": "string",
          "firstName": "string",
          "middleName": "string",
          "lastName": "string",
          "dateOfBirth": "string",
          "gender": "string",
          "allowMarketing": true,
          "contactInfo": {
            "email": "string",
            "mobile": "string"
          },
          "cprNumber": "string",
          "personnummer": "string"
        },
        "order": {
          "id": "string",
          "createdAt": "2019-08-24T14:15:22Z",
          "createdBy": {
            "email": "string",
            "userType": "string"
          },
          "locale": "string",
          "number": "string",
          "invoice": {
            "id": "string",
            "fileName": "string",
            "createdAt": "2019-08-24T14:15:22Z",
            "lastUpdatedAt": "2019-08-24T14:15:22Z",
            "externalUrl": "string",
            "storageAccountName": "string",
            "storageContainerName": "string",
            "storagePath": "string"
          },
          "lineItemGroups": [
            {
              "id": 0,
              "type": "string",
              "number": "string",
              "manufacturingData": {
                "requisitionRequestId": 0,
                "manufacturingData": "string",
                "frameAvailable": true,
                "orderType": "string",
                "errors": [
                  "string"
                ],
                "infos": [
                  "string"
                ],
                "warnings": [
                  "string"
                ]
              }
            }
          ],
          "orderState": "OPEN",
          "origin": "ONLINE",
          "originalOrder": {
            "id": "string",
            "number": "string"
          },
          "subscription": {
            "id": "string",
            "interval": 0,
            "unit": "DAYS",
            "type": "PREPAY",
            "status": "ACTIVE",
            "instalments": [
              {
                "id": "string",
                "amount": {
                  "currencyCode": "string",
                  "centAmount": 0
                },
                "dueDate": "2019-08-24T14:15:22Z",
                "paidDate": {},
                "success": {}
              }
            ]
          },
          "type": "STANDARD",
          "lineItems": [
            {
              "groupId": 0,
              "id": "string",
              "itemCategory": "string",
              "eye": "L",
              "name": "string",
              "number": "string",
              "groupNumber": "string",
              "quantity": 0,
              "sku": "string",
              "state": "string",
              "style": "string",
              "originalLineItem": {
                "groupId": 0,
                "id": "string",
                "itemCategory": "string",
                "eye": "L",
                "name": "string",
                "number": "string",
                "groupNumber": "string",
                "quantity": 0,
                "sku": "string",
                "state": "string",
                "style": "string"
              }
            }
          ],
          "deliveries": [
            {
              "id": "string",
              "key": "string",
              "createdAt": "string",
              "items": [
                {
                  "id": "string",
                  "quantity": 0
                }
              ],
              "state": "string"
            }
          ]
        },
        "aftercareStore": {
          "address": {
            "city": "string",
            "country": "string",
            "line1": "string",
            "line2": "string",
            "line3": "string",
            "name": "string",
            "postcode": "string",
            "region": "string"
          },
          "companyDetails": {
            "name": "string",
            "registeredAddress": "string"
          },
          "contactInfo": {
            "phone": "string",
            "email": "string"
          },
          "coordinates": {
            "latitude": "string",
            "longitude": "string"
          },
          "lineOfBusiness": "string",
          "name": "string",
          "eposNumber": "string",
          "storeUrl": "string"
        }
      }
    }
    

    This example has been generated automatically.

  • #24

    • application/json

    Message IDOrderCancelled

    Correlation ID$message.payload#/detail/correlationid

    Default Correlation ID

    The application will send new order cancelled events through this channel.

    Payload

    Expand all

    object

    id

    required

    string

    specversion

    required

    string

    Default value:"1.0"

    env

    string

    The environment from which the event originated from e.g. dev, prod

    Allowed values:
    • "local"
    • "dev"
    • "qa"
    • "qa2"
    • "stg"
    • "prod"

    sourceService

    string

    Const:"com.specsavers/order-service"

    type

    required

    string

    Const:"com.specsavers.order.cancelled"

    correlationid

    string

    The correlation ID of the event. E.g. 1234

    subject

    string

    market

    string

    Derived from locale i.e GB

    Default value:"GB"

    datacontenttype

    string

    Const:"application/json"

    data

    Expand all

    required

    object [OrderCancelledData]

    __meta

    Expand all

    object [OrderBaseMeta]

    key

    required

    string

    language

    required

    string

    loginUrl

    required

    string

    logoUrl

    required

    string

    myAccountUrl

    required

    string

    contactUsUrl

    required

    string

    privacyPolicyUrl

    required

    string

    termsofPurchaseUrl

    required

    string

    legalPoliciesUrl

    required

    string

    name

    required

    string

    supportContactNumber

    required

    string

    supportEmailAddress

    required

    string

    Additional properties are allowed.

    customer

    Expand all

    required

    object [OrderBaseCustomer]

    id

    required

    string

    title

    string

    firstName

    required

    string

    middleName

    string

    lastName

    required

    string

    dateOfBirth

    required

    string

    gender

    required

    string

    allowMarketing

    required

    boolean

    contactInfo

    Expand all

    required

    object [ContactInfo]

    email

    required

    string

    mobile

    string

    Additional properties are NOT allowed.

    cprNumber

    string

    personnummer

    string

    Additional properties are allowed.

    order

    Expand all

    required

    allOf

    Consists of OrderBaseOrder:

    Expand all

    object [OrderBaseOrder]

    uid: OrderBaseOrder

    id

    required

    string

    createdAt

    required

    string

    format: date-time

    createdBy

    Expand all

    required

    object [CreatedBy]

    email

    string

    userType

    string

    Additional properties are allowed.

    locale

    required

    string

    number

    required

    string

    invoice

    Expand all

    object [InvoiceOrCreditNote]

    id

    required

    string

    fileName

    required

    string

    createdAt

    required

    string

    format: date-time

    lastUpdatedAt

    required

    string

    format: date-time

    externalUrl

    required

    string

    storageAccountName

    required

    string

    storageContainerName

    required

    string

    storagePath

    required

    string

    Additional properties are allowed.

    lineItemGroups

    Expand all

    required

    array<object [LineItemGroupType]>

    object [LineItemGroupType]

    id

    required

    number

    type

    required

    string

    number

    required

    string

    manufacturingData

    Expand all

    object [ManufacturingData]

    requisitionRequestId

    required

    number

    manufacturingData

    string

    frameAvailable

    required

    boolean

    orderType

    required

    string

    errors

    Expand all

    array<string> | null

    Items:

    string

    infos

    Expand all

    array<string> | null

    Items:

    string

    warnings

    Expand all

    array<string> | null

    Items:

    string

    Additional properties are allowed.

    Additional properties are allowed.

    orderState

    required

    string

    Allowed values:
    • "OPEN"
    • "COLLECTED"
    • "PROCESSING"
    • "CONFIRMED"
    • "BACK_ORDERED"
    • "COMPLETE"
    • "SHIPPED"
    • "CANCELLED"
    • "REMORSE"
    • "PENDING_RX_VALIDATION"
    • "PENDING_CANCELLATION"

    origin

    required

    string

    Allowed values:
    • "ONLINE"
    • "INSTORE"
    • "CUSTOMER_SERVICE"

    originalOrder

    Expand all

    object [OriginalOrder]

    id

    string

    number

    string

    Additional properties are NOT allowed.

    subscription

    Expand all

    object [BaseSubscription]

    uid: BaseSubscription

    id

    required

    string

    interval

    required

    number

    unit

    required

    string

    Allowed values:
    • "DAYS"
    • "WEEKS"
    • "MONTHS"

    type

    required

    string

    Allowed values:
    • "PREPAY"
    • "POSTPAY"
    • "RECURRING"

    status

    required

    string

    Allowed values:
    • "ACTIVE"
    • "PAUSED"
    • "EXPIRED"
    • "FAILED"
    • "FROZEN"
    • "CANCELLED"
    • "PENDING_CANCELLATION"

    instalments

    Expand all

    array<object [BaseInstalment]>

    object [BaseInstalment]

    id

    required

    string

    amount

    Expand all

    required

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    dueDate

    required

    string

    format: date-time

    paidDate

    Expand all

    oneOf

    Adheres to <anonymous-schema-117>:

    null

    Or to <anonymous-schema-118>:

    string

    format: date-time

    success

    Expand all

    oneOf

    Adheres to <anonymous-schema-120>:

    null

    Or to <anonymous-schema-121>:

    boolean

    Additional properties are allowed.

    Additional properties are allowed.

    type

    required

    string

    Allowed values:
    • "STANDARD"
    • "RECURRING"
    • "REPLACEMENT"
    • "REPAIR"
    • "REMAKE"

    Additional properties are allowed.

    And of <anonymous-schema-618>:

    Expand all

    object

    lineItems

    Expand all

    required

    array<object allOf>

    Items:

    object allOf

    Consists of <anonymous-schema-577>:

    Expand all

    object

    groupId

    required

    number

    id

    required

    string

    itemCategory

    required

    string

    eye

    string

    Allowed values:
    • "L"
    • "R"
    • "LR"

    name

    required

    string

    number

    required

    string

    groupNumber

    required

    string

    quantity

    required

    number

    sku

    required

    string

    state

    string

    style

    string

    Additional properties are allowed.

    And of <anonymous-schema-589>:

    Expand all

    object

    originalLineItem

    Expand all

    allOf

    Consists of <anonymous-schema-577>:

    Expand all

    object

    groupId

    required

    number

    id

    required

    string

    itemCategory

    required

    string

    eye

    string

    Allowed values:
    • "L"
    • "R"
    • "LR"

    name

    required

    string

    number

    required

    string

    groupNumber

    required

    string

    quantity

    required

    number

    sku

    required

    string

    state

    string

    style

    string

    Additional properties are allowed.

    And of <anonymous-schema-591>:

    Expand all

    object

    Additional properties are allowed.

    Additional properties are allowed.

    Additional properties are allowed.

    cancellationInfo

    Expand all

    object [OrderCancellationInfoData]

    uid: OrderCancellationInfoData

    id

    string

    key

    string

    detail

    string

    cancelledAt

    string

    format: date-time

    cancelledBy

    string

    Additional properties are NOT allowed.

    creditNote

    Expand all

    object [InvoiceOrCreditNote]

    id

    required

    string

    fileName

    required

    string

    createdAt

    required

    string

    format: date-time

    lastUpdatedAt

    required

    string

    format: date-time

    externalUrl

    required

    string

    storageAccountName

    required

    string

    storageContainerName

    required

    string

    storagePath

    required

    string

    Additional properties are allowed.

    totalRefundAmount

    Expand all

    required

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    Additional properties are allowed.

    aftercareStore

    Expand all

    object [OrderBaseStore]

    address

    Expand all

    object [OrderBaseStoreAddress]

    city

    string

    country

    string

    line1

    string

    line2

    string

    line3

    string

    name

    string

    postcode

    string

    region

    string

    Additional properties are NOT allowed.

    companyDetails

    Expand all

    object [OrderBaseStoreCompanyDetails]

    name

    string

    registeredAddress

    string

    Additional properties are NOT allowed.

    contactInfo

    Expand all

    object [OrderBaseStoreContactInfo]

    phone

    string

    email

    string

    Additional properties are NOT allowed.

    coordinates

    Expand all

    object [OrderBaseStoreCoordinates]

    latitude

    string

    longitude

    string

    Additional properties are NOT allowed.

    lineOfBusiness

    string

    name

    string

    eposNumber

    string

    storeUrl

    string

    Additional properties are allowed.

    Additional properties are allowed.

    Extensions

    x-envelope-type

    cloudevent

    Additional properties are allowed.

    • #order

    Examples

    Payload

    {
      "id": "string",
      "specversion": "1.0",
      "env": "local",
      "sourceService": "com.specsavers/order-service",
      "type": "com.specsavers.order.cancelled",
      "correlationid": "string",
      "subject": "string",
      "market": "GB",
      "datacontenttype": "application/json",
      "data": {
        "__meta": {
          "key": "string",
          "language": "string",
          "loginUrl": "string",
          "logoUrl": "string",
          "myAccountUrl": "string",
          "contactUsUrl": "string",
          "privacyPolicyUrl": "string",
          "termsofPurchaseUrl": "string",
          "legalPoliciesUrl": "string",
          "name": "string",
          "supportContactNumber": "string",
          "supportEmailAddress": "string"
        },
        "customer": {
          "id": "string",
          "title": "string",
          "firstName": "string",
          "middleName": "string",
          "lastName": "string",
          "dateOfBirth": "string",
          "gender": "string",
          "allowMarketing": true,
          "contactInfo": {
            "email": "string",
            "mobile": "string"
          },
          "cprNumber": "string",
          "personnummer": "string"
        },
        "order": {
          "id": "string",
          "createdAt": "2019-08-24T14:15:22Z",
          "createdBy": {
            "email": "string",
            "userType": "string"
          },
          "locale": "string",
          "number": "string",
          "invoice": {
            "id": "string",
            "fileName": "string",
            "createdAt": "2019-08-24T14:15:22Z",
            "lastUpdatedAt": "2019-08-24T14:15:22Z",
            "externalUrl": "string",
            "storageAccountName": "string",
            "storageContainerName": "string",
            "storagePath": "string"
          },
          "lineItemGroups": [
            {
              "id": 0,
              "type": "string",
              "number": "string",
              "manufacturingData": {
                "requisitionRequestId": 0,
                "manufacturingData": "string",
                "frameAvailable": true,
                "orderType": "string",
                "errors": [
                  "string"
                ],
                "infos": [
                  "string"
                ],
                "warnings": [
                  "string"
                ]
              }
            }
          ],
          "orderState": "OPEN",
          "origin": "ONLINE",
          "originalOrder": {
            "id": "string",
            "number": "string"
          },
          "subscription": {
            "id": "string",
            "interval": 0,
            "unit": "DAYS",
            "type": "PREPAY",
            "status": "ACTIVE",
            "instalments": [
              {
                "id": "string",
                "amount": {
                  "currencyCode": "string",
                  "centAmount": 0
                },
                "dueDate": "2019-08-24T14:15:22Z",
                "paidDate": {},
                "success": {}
              }
            ]
          },
          "type": "STANDARD",
          "lineItems": [
            {
              "groupId": 0,
              "id": "string",
              "itemCategory": "string",
              "eye": "L",
              "name": "string",
              "number": "string",
              "groupNumber": "string",
              "quantity": 0,
              "sku": "string",
              "state": "string",
              "style": "string",
              "originalLineItem": {
                "groupId": 0,
                "id": "string",
                "itemCategory": "string",
                "eye": "L",
                "name": "string",
                "number": "string",
                "groupNumber": "string",
                "quantity": 0,
                "sku": "string",
                "state": "string",
                "style": "string"
              }
            }
          ],
          "cancellationInfo": {
            "id": "string",
            "key": "string",
            "detail": "string",
            "cancelledAt": "2019-08-24T14:15:22Z",
            "cancelledBy": "string"
          },
          "creditNote": {
            "id": "string",
            "fileName": "string",
            "createdAt": "2019-08-24T14:15:22Z",
            "lastUpdatedAt": "2019-08-24T14:15:22Z",
            "externalUrl": "string",
            "storageAccountName": "string",
            "storageContainerName": "string",
            "storagePath": "string"
          },
          "totalRefundAmount": {
            "currencyCode": "string",
            "centAmount": 0
          }
        },
        "aftercareStore": {
          "address": {
            "city": "string",
            "country": "string",
            "line1": "string",
            "line2": "string",
            "line3": "string",
            "name": "string",
            "postcode": "string",
            "region": "string"
          },
          "companyDetails": {
            "name": "string",
            "registeredAddress": "string"
          },
          "contactInfo": {
            "phone": "string",
            "email": "string"
          },
          "coordinates": {
            "latitude": "string",
            "longitude": "string"
          },
          "lineOfBusiness": "string",
          "name": "string",
          "eposNumber": "string",
          "storeUrl": "string"
        }
      }
    }
    

    This example has been generated automatically.

  • #25

    • application/json

    Message IDReturnCreated

    Correlation ID$message.payload#/detail/correlationid

    Default Correlation ID

    The application will send return created events through this channel.

    Payload

    Expand all

    object

    id

    required

    string

    subject

    string

    market

    string

    Derived from locale i.e GB

    Default value:"GB"

    datacontenttype

    string

    Const:"application/json"

    specversion

    required

    string

    Default value:"1.0"

    env

    required

    string

    The environment from which the event originated from e.g. dev, prod

    Allowed values:
    • "local"
    • "dev"
    • "qa"
    • "qa2"
    • "stg"
    • "prod"

    sourceService

    string

    Const:"com.specsavers/returns"

    type

    string

    Const:"com.specsavers.return.created"

    correlationid

    required

    string

    The correlation ID of the event. E.g. 1234

    data

    Expand all

    required

    object [OrderReturnData]

    __meta

    Expand all

    required

    object [OrderBaseMeta]

    key

    required

    string

    language

    required

    string

    loginUrl

    required

    string

    logoUrl

    required

    string

    myAccountUrl

    required

    string

    contactUsUrl

    required

    string

    privacyPolicyUrl

    required

    string

    termsofPurchaseUrl

    required

    string

    legalPoliciesUrl

    required

    string

    name

    required

    string

    supportContactNumber

    required

    string

    supportEmailAddress

    required

    string

    Additional properties are allowed.

    customer

    Expand all

    required

    object [OrderBaseCustomer]

    id

    required

    string

    title

    string

    firstName

    required

    string

    middleName

    string

    lastName

    required

    string

    dateOfBirth

    required

    string

    gender

    required

    string

    allowMarketing

    required

    boolean

    contactInfo

    Expand all

    required

    object [ContactInfo]

    email

    required

    string

    mobile

    string

    Additional properties are NOT allowed.

    cprNumber

    string

    personnummer

    string

    Additional properties are allowed.

    order

    Expand all

    required

    allOf

    Consists of OrderBaseOrder:

    Expand all

    object [OrderBaseOrder]

    uid: OrderBaseOrder

    id

    required

    string

    createdAt

    required

    string

    format: date-time

    createdBy

    Expand all

    required

    object [CreatedBy]

    email

    string

    userType

    string

    Additional properties are allowed.

    locale

    required

    string

    number

    required

    string

    invoice

    Expand all

    object [InvoiceOrCreditNote]

    id

    required

    string

    fileName

    required

    string

    createdAt

    required

    string

    format: date-time

    lastUpdatedAt

    required

    string

    format: date-time

    externalUrl

    required

    string

    storageAccountName

    required

    string

    storageContainerName

    required

    string

    storagePath

    required

    string

    Additional properties are allowed.

    lineItemGroups

    Expand all

    required

    array<object [LineItemGroupType]>

    object [LineItemGroupType]

    id

    required

    number

    type

    required

    string

    number

    required

    string

    manufacturingData

    Expand all

    object [ManufacturingData]

    requisitionRequestId

    required

    number

    manufacturingData

    string

    frameAvailable

    required

    boolean

    orderType

    required

    string

    errors

    Expand all

    array<string> | null

    Items:

    string

    infos

    Expand all

    array<string> | null

    Items:

    string

    warnings

    Expand all

    array<string> | null

    Items:

    string

    Additional properties are allowed.

    Additional properties are allowed.

    orderState

    required

    string

    Allowed values:
    • "OPEN"
    • "COLLECTED"
    • "PROCESSING"
    • "CONFIRMED"
    • "BACK_ORDERED"
    • "COMPLETE"
    • "SHIPPED"
    • "CANCELLED"
    • "REMORSE"
    • "PENDING_RX_VALIDATION"
    • "PENDING_CANCELLATION"

    origin

    required

    string

    Allowed values:
    • "ONLINE"
    • "INSTORE"
    • "CUSTOMER_SERVICE"

    originalOrder

    Expand all

    object [OriginalOrder]

    id

    string

    number

    string

    Additional properties are NOT allowed.

    subscription

    Expand all

    object [BaseSubscription]

    uid: BaseSubscription

    id

    required

    string

    interval

    required

    number

    unit

    required

    string

    Allowed values:
    • "DAYS"
    • "WEEKS"
    • "MONTHS"

    type

    required

    string

    Allowed values:
    • "PREPAY"
    • "POSTPAY"
    • "RECURRING"

    status

    required

    string

    Allowed values:
    • "ACTIVE"
    • "PAUSED"
    • "EXPIRED"
    • "FAILED"
    • "FROZEN"
    • "CANCELLED"
    • "PENDING_CANCELLATION"

    instalments

    Expand all

    array<object [BaseInstalment]>

    object [BaseInstalment]

    id

    required

    string

    amount

    Expand all

    required

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    dueDate

    required

    string

    format: date-time

    paidDate

    Expand all

    oneOf

    Adheres to <anonymous-schema-117>:

    null

    Or to <anonymous-schema-118>:

    string

    format: date-time

    success

    Expand all

    oneOf

    Adheres to <anonymous-schema-120>:

    null

    Or to <anonymous-schema-121>:

    boolean

    Additional properties are allowed.

    Additional properties are allowed.

    type

    required

    string

    Allowed values:
    • "STANDARD"
    • "RECURRING"
    • "REPLACEMENT"
    • "REPAIR"
    • "REMAKE"

    Additional properties are allowed.

    And of <anonymous-schema-642>:

    Expand all

    object

    lineItems

    Expand all

    required

    array<object [ReturnBaseLineItemType]>

    object [ReturnBaseLineItemType]

    groupId

    number

    id

    required

    string

    itemCategory

    required

    string

    name

    required

    string

    number

    required

    string

    quantity

    required

    number

    returnedQuantity

    required

    number

    returnableQuantity

    required

    number

    sku

    string

    state

    string

    style

    string

    Additional properties are allowed.

    Additional properties are allowed.

    returnInfo

    Expand all

    object [ReturnInfoData]

    uid: ReturnInfoData

    number

    required

    string

    createdAt

    required

    string

    format: date-time

    createdBy

    Expand all

    required

    object [CreatedBy]

    id

    string

    email

    string

    userType

    string

    name

    string

    Additional properties are allowed.

    lastModifiedAt

    required

    string

    format: date-time

    lastModifiedBy

    Expand all

    required

    object [lastModifiedBy]

    id

    string

    email

    string

    userType

    string

    name

    string

    Additional properties are allowed.

    state

    required

    string

    Allowed values:
    • "INITIATED"
    • "COMPLETE"

    paymentState

    required

    string

    Allowed values:
    • "PENDING"
    • "FAILED"
    • "REFUNDED"

    type

    required

    string

    Allowed values:
    • "RECEIPTED"
    • "NON_RECEIPTED"
    • "APPEASEMENT"

    totalRefundAmount

    Expand all

    required

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    lineItems

    Expand all

    required

    array<object [ReturnLineItem]>

    object [ReturnLineItem]

    uid: ReturnLineItem

    id

    required

    string

    lineItemId

    required

    string

    quantity

    required

    number

    reasonCode

    required

    string

    reason

    required

    string

    additionalInfo

    string

    appeasementType

    string

    Allowed values:
    • "PERCENT_OFF"
    • "AMOUNT_OFF"

    appeasementValue

    number

    Additional properties are NOT allowed.

    creditNote

    Expand all

    object [InvoiceOrCreditNote]

    id

    required

    string

    fileName

    required

    string

    createdAt

    required

    string

    format: date-time

    lastUpdatedAt

    required

    string

    format: date-time

    externalUrl

    required

    string

    storageAccountName

    required

    string

    storageContainerName

    required

    string

    storagePath

    required

    string

    Additional properties are allowed.

    Additional properties are NOT allowed.

    aftercareStore

    Expand all

    object [OrderBaseStore]

    address

    Expand all

    object [OrderBaseStoreAddress]

    city

    string

    country

    string

    line1

    string

    line2

    string

    line3

    string

    name

    string

    postcode

    string

    region

    string

    Additional properties are NOT allowed.

    companyDetails

    Expand all

    object [OrderBaseStoreCompanyDetails]

    name

    string

    registeredAddress

    string

    Additional properties are NOT allowed.

    contactInfo

    Expand all

    object [OrderBaseStoreContactInfo]

    phone

    string

    email

    string

    Additional properties are NOT allowed.

    coordinates

    Expand all

    object [OrderBaseStoreCoordinates]

    latitude

    string

    longitude

    string

    Additional properties are NOT allowed.

    lineOfBusiness

    string

    name

    string

    eposNumber

    string

    storeUrl

    string

    Additional properties are allowed.

    Additional properties are allowed.

    Extensions

    x-envelope-type

    cloudevent

    Additional properties are allowed.

    • #return

    Examples

    Payload

    {
      "id": "string",
      "subject": "string",
      "market": "GB",
      "datacontenttype": "application/json",
      "specversion": "1.0",
      "env": "local",
      "sourceService": "com.specsavers/returns",
      "type": "com.specsavers.return.created",
      "correlationid": "string",
      "data": {
        "__meta": {
          "key": "string",
          "language": "string",
          "loginUrl": "string",
          "logoUrl": "string",
          "myAccountUrl": "string",
          "contactUsUrl": "string",
          "privacyPolicyUrl": "string",
          "termsofPurchaseUrl": "string",
          "legalPoliciesUrl": "string",
          "name": "string",
          "supportContactNumber": "string",
          "supportEmailAddress": "string"
        },
        "customer": {
          "id": "string",
          "title": "string",
          "firstName": "string",
          "middleName": "string",
          "lastName": "string",
          "dateOfBirth": "string",
          "gender": "string",
          "allowMarketing": true,
          "contactInfo": {
            "email": "string",
            "mobile": "string"
          },
          "cprNumber": "string",
          "personnummer": "string"
        },
        "order": {
          "id": "string",
          "createdAt": "2019-08-24T14:15:22Z",
          "createdBy": {
            "email": "string",
            "userType": "string"
          },
          "locale": "string",
          "number": "string",
          "invoice": {
            "id": "string",
            "fileName": "string",
            "createdAt": "2019-08-24T14:15:22Z",
            "lastUpdatedAt": "2019-08-24T14:15:22Z",
            "externalUrl": "string",
            "storageAccountName": "string",
            "storageContainerName": "string",
            "storagePath": "string"
          },
          "lineItemGroups": [
            {
              "id": 0,
              "type": "string",
              "number": "string",
              "manufacturingData": {
                "requisitionRequestId": 0,
                "manufacturingData": "string",
                "frameAvailable": true,
                "orderType": "string",
                "errors": [
                  "string"
                ],
                "infos": [
                  "string"
                ],
                "warnings": [
                  "string"
                ]
              }
            }
          ],
          "orderState": "OPEN",
          "origin": "ONLINE",
          "originalOrder": {
            "id": "string",
            "number": "string"
          },
          "subscription": {
            "id": "string",
            "interval": 0,
            "unit": "DAYS",
            "type": "PREPAY",
            "status": "ACTIVE",
            "instalments": [
              {
                "id": "string",
                "amount": {
                  "currencyCode": "string",
                  "centAmount": 0
                },
                "dueDate": "2019-08-24T14:15:22Z",
                "paidDate": {},
                "success": {}
              }
            ]
          },
          "type": "STANDARD",
          "lineItems": [
            {
              "groupId": 0,
              "id": "string",
              "itemCategory": "string",
              "name": "string",
              "number": "string",
              "quantity": 0,
              "returnedQuantity": 0,
              "returnableQuantity": 0,
              "sku": "string",
              "state": "string",
              "style": "string"
            }
          ]
        },
        "returnInfo": {
          "number": "string",
          "createdAt": "2019-08-24T14:15:22Z",
          "createdBy": {
            "id": "string",
            "email": "string",
            "userType": "string",
            "name": "string"
          },
          "lastModifiedAt": "2019-08-24T14:15:22Z",
          "lastModifiedBy": {
            "id": "string",
            "email": "string",
            "userType": "string",
            "name": "string"
          },
          "state": "INITIATED",
          "paymentState": "PENDING",
          "type": "RECEIPTED",
          "totalRefundAmount": {
            "currencyCode": "string",
            "centAmount": 0
          },
          "lineItems": [
            {
              "id": "string",
              "lineItemId": "string",
              "quantity": 0,
              "reasonCode": "string",
              "reason": "string",
              "additionalInfo": "string",
              "appeasementType": "PERCENT_OFF",
              "appeasementValue": 0
            }
          ],
          "creditNote": {
            "id": "string",
            "fileName": "string",
            "createdAt": "2019-08-24T14:15:22Z",
            "lastUpdatedAt": "2019-08-24T14:15:22Z",
            "externalUrl": "string",
            "storageAccountName": "string",
            "storageContainerName": "string",
            "storagePath": "string"
          }
        },
        "aftercareStore": {
          "address": {
            "city": "string",
            "country": "string",
            "line1": "string",
            "line2": "string",
            "line3": "string",
            "name": "string",
            "postcode": "string",
            "region": "string"
          },
          "companyDetails": {
            "name": "string",
            "registeredAddress": "string"
          },
          "contactInfo": {
            "phone": "string",
            "email": "string"
          },
          "coordinates": {
            "latitude": "string",
            "longitude": "string"
          },
          "lineOfBusiness": "string",
          "name": "string",
          "eposNumber": "string",
          "storeUrl": "string"
        }
      }
    }
    

    This example has been generated automatically.

  • #26

    • application/json

    Message IDReturnCompleted

    Correlation ID$message.payload#/detail/correlationid

    Default Correlation ID

    The application will send return completed events through this channel.

    Payload

    Expand all

    object

    id

    required

    string

    subject

    string

    market

    string

    Derived from locale i.e GB

    Default value:"GB"

    datacontenttype

    string

    Const:"application/json"

    specversion

    required

    string

    Default value:"1.0"

    env

    required

    string

    The environment from which the event originated from e.g. dev, prod

    Allowed values:
    • "local"
    • "dev"
    • "qa"
    • "qa2"
    • "stg"
    • "prod"

    sourceService

    string

    Const:"com.specsavers/returns"

    type

    string

    Const:"com.specsavers.return.completed"

    correlationid

    required

    string

    The correlation ID of the event. E.g. 1234

    data

    Expand all

    required

    object [OrderReturnData]

    __meta

    Expand all

    required

    object [OrderBaseMeta]

    key

    required

    string

    language

    required

    string

    loginUrl

    required

    string

    logoUrl

    required

    string

    myAccountUrl

    required

    string

    contactUsUrl

    required

    string

    privacyPolicyUrl

    required

    string

    termsofPurchaseUrl

    required

    string

    legalPoliciesUrl

    required

    string

    name

    required

    string

    supportContactNumber

    required

    string

    supportEmailAddress

    required

    string

    Additional properties are allowed.

    customer

    Expand all

    required

    object [OrderBaseCustomer]

    id

    required

    string

    title

    string

    firstName

    required

    string

    middleName

    string

    lastName

    required

    string

    dateOfBirth

    required

    string

    gender

    required

    string

    allowMarketing

    required

    boolean

    contactInfo

    Expand all

    required

    object [ContactInfo]

    email

    required

    string

    mobile

    string

    Additional properties are NOT allowed.

    cprNumber

    string

    personnummer

    string

    Additional properties are allowed.

    order

    Expand all

    required

    allOf

    Consists of OrderBaseOrder:

    Expand all

    object [OrderBaseOrder]

    uid: OrderBaseOrder

    id

    required

    string

    createdAt

    required

    string

    format: date-time

    createdBy

    Expand all

    required

    object [CreatedBy]

    email

    string

    userType

    string

    Additional properties are allowed.

    locale

    required

    string

    number

    required

    string

    invoice

    Expand all

    object [InvoiceOrCreditNote]

    id

    required

    string

    fileName

    required

    string

    createdAt

    required

    string

    format: date-time

    lastUpdatedAt

    required

    string

    format: date-time

    externalUrl

    required

    string

    storageAccountName

    required

    string

    storageContainerName

    required

    string

    storagePath

    required

    string

    Additional properties are allowed.

    lineItemGroups

    Expand all

    required

    array<object [LineItemGroupType]>

    object [LineItemGroupType]

    id

    required

    number

    type

    required

    string

    number

    required

    string

    manufacturingData

    Expand all

    object [ManufacturingData]

    requisitionRequestId

    required

    number

    manufacturingData

    string

    frameAvailable

    required

    boolean

    orderType

    required

    string

    errors

    Expand all

    array<string> | null

    Items:

    string

    infos

    Expand all

    array<string> | null

    Items:

    string

    warnings

    Expand all

    array<string> | null

    Items:

    string

    Additional properties are allowed.

    Additional properties are allowed.

    orderState

    required

    string

    Allowed values:
    • "OPEN"
    • "COLLECTED"
    • "PROCESSING"
    • "CONFIRMED"
    • "BACK_ORDERED"
    • "COMPLETE"
    • "SHIPPED"
    • "CANCELLED"
    • "REMORSE"
    • "PENDING_RX_VALIDATION"
    • "PENDING_CANCELLATION"

    origin

    required

    string

    Allowed values:
    • "ONLINE"
    • "INSTORE"
    • "CUSTOMER_SERVICE"

    originalOrder

    Expand all

    object [OriginalOrder]

    id

    string

    number

    string

    Additional properties are NOT allowed.

    subscription

    Expand all

    object [BaseSubscription]

    uid: BaseSubscription

    id

    required

    string

    interval

    required

    number

    unit

    required

    string

    Allowed values:
    • "DAYS"
    • "WEEKS"
    • "MONTHS"

    type

    required

    string

    Allowed values:
    • "PREPAY"
    • "POSTPAY"
    • "RECURRING"

    status

    required

    string

    Allowed values:
    • "ACTIVE"
    • "PAUSED"
    • "EXPIRED"
    • "FAILED"
    • "FROZEN"
    • "CANCELLED"
    • "PENDING_CANCELLATION"

    instalments

    Expand all

    array<object [BaseInstalment]>

    object [BaseInstalment]

    id

    required

    string

    amount

    Expand all

    required

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    dueDate

    required

    string

    format: date-time

    paidDate

    Expand all

    oneOf

    Adheres to <anonymous-schema-117>:

    null

    Or to <anonymous-schema-118>:

    string

    format: date-time

    success

    Expand all

    oneOf

    Adheres to <anonymous-schema-120>:

    null

    Or to <anonymous-schema-121>:

    boolean

    Additional properties are allowed.

    Additional properties are allowed.

    type

    required

    string

    Allowed values:
    • "STANDARD"
    • "RECURRING"
    • "REPLACEMENT"
    • "REPAIR"
    • "REMAKE"

    Additional properties are allowed.

    And of <anonymous-schema-642>:

    Expand all

    object

    lineItems

    Expand all

    required

    array<object [ReturnBaseLineItemType]>

    object [ReturnBaseLineItemType]

    groupId

    number

    id

    required

    string

    itemCategory

    required

    string

    name

    required

    string

    number

    required

    string

    quantity

    required

    number

    returnedQuantity

    required

    number

    returnableQuantity

    required

    number

    sku

    string

    state

    string

    style

    string

    Additional properties are allowed.

    Additional properties are allowed.

    returnInfo

    Expand all

    object [ReturnInfoData]

    uid: ReturnInfoData

    number

    required

    string

    createdAt

    required

    string

    format: date-time

    createdBy

    Expand all

    required

    object [CreatedBy]

    id

    string

    email

    string

    userType

    string

    name

    string

    Additional properties are allowed.

    lastModifiedAt

    required

    string

    format: date-time

    lastModifiedBy

    Expand all

    required

    object [lastModifiedBy]

    id

    string

    email

    string

    userType

    string

    name

    string

    Additional properties are allowed.

    state

    required

    string

    Allowed values:
    • "INITIATED"
    • "COMPLETE"

    paymentState

    required

    string

    Allowed values:
    • "PENDING"
    • "FAILED"
    • "REFUNDED"

    type

    required

    string

    Allowed values:
    • "RECEIPTED"
    • "NON_RECEIPTED"
    • "APPEASEMENT"

    totalRefundAmount

    Expand all

    required

    object [BasePriceType]

    currencyCode

    required

    string

    centAmount

    required

    number

    Additional properties are NOT allowed.

    lineItems

    Expand all

    required

    array<object [ReturnLineItem]>

    object [ReturnLineItem]

    uid: ReturnLineItem

    id

    required

    string

    lineItemId

    required

    string

    quantity

    required

    number

    reasonCode

    required

    string

    reason

    required

    string

    additionalInfo

    string

    appeasementType

    string

    Allowed values:
    • "PERCENT_OFF"
    • "AMOUNT_OFF"

    appeasementValue

    number

    Additional properties are NOT allowed.

    creditNote

    Expand all

    object [InvoiceOrCreditNote]

    id

    required

    string

    fileName

    required

    string

    createdAt

    required

    string

    format: date-time

    lastUpdatedAt

    required

    string

    format: date-time

    externalUrl

    required

    string

    storageAccountName

    required

    string

    storageContainerName

    required

    string

    storagePath

    required

    string

    Additional properties are allowed.

    Additional properties are NOT allowed.

    aftercareStore

    Expand all

    object [OrderBaseStore]

    address

    Expand all

    object [OrderBaseStoreAddress]

    city

    string

    country

    string

    line1

    string

    line2

    string

    line3

    string

    name

    string

    postcode

    string

    region

    string

    Additional properties are NOT allowed.

    companyDetails

    Expand all

    object [OrderBaseStoreCompanyDetails]

    name

    string

    registeredAddress

    string

    Additional properties are NOT allowed.

    contactInfo

    Expand all

    object [OrderBaseStoreContactInfo]

    phone

    string

    email

    string

    Additional properties are NOT allowed.

    coordinates

    Expand all

    object [OrderBaseStoreCoordinates]

    latitude

    string

    longitude

    string

    Additional properties are NOT allowed.

    lineOfBusiness

    string

    name

    string

    eposNumber

    string

    storeUrl

    string

    Additional properties are allowed.

    Additional properties are allowed.

    Extensions

    x-envelope-type

    cloudevent

    Additional properties are allowed.

    • #return

    Examples

    Payload

    {
      "id": "string",
      "subject": "string",
      "market": "GB",
      "datacontenttype": "application/json",
      "specversion": "1.0",
      "env": "local",
      "sourceService": "com.specsavers/returns",
      "type": "com.specsavers.return.completed",
      "correlationid": "string",
      "data": {
        "__meta": {
          "key": "string",
          "language": "string",
          "loginUrl": "string",
          "logoUrl": "string",
          "myAccountUrl": "string",
          "contactUsUrl": "string",
          "privacyPolicyUrl": "string",
          "termsofPurchaseUrl": "string",
          "legalPoliciesUrl": "string",
          "name": "string",
          "supportContactNumber": "string",
          "supportEmailAddress": "string"
        },
        "customer": {
          "id": "string",
          "title": "string",
          "firstName": "string",
          "middleName": "string",
          "lastName": "string",
          "dateOfBirth": "string",
          "gender": "string",
          "allowMarketing": true,
          "contactInfo": {
            "email": "string",
            "mobile": "string"
          },
          "cprNumber": "string",
          "personnummer": "string"
        },
        "order": {
          "id": "string",
          "createdAt": "2019-08-24T14:15:22Z",
          "createdBy": {
            "email": "string",
            "userType": "string"
          },
          "locale": "string",
          "number": "string",
          "invoice": {
            "id": "string",
            "fileName": "string",
            "createdAt": "2019-08-24T14:15:22Z",
            "lastUpdatedAt": "2019-08-24T14:15:22Z",
            "externalUrl": "string",
            "storageAccountName": "string",
            "storageContainerName": "string",
            "storagePath": "string"
          },
          "lineItemGroups": [
            {
              "id": 0,
              "type": "string",
              "number": "string",
              "manufacturingData": {
                "requisitionRequestId": 0,
                "manufacturingData": "string",
                "frameAvailable": true,
                "orderType": "string",
                "errors": [
                  "string"
                ],
                "infos": [
                  "string"
                ],
                "warnings": [
                  "string"
                ]
              }
            }
          ],
          "orderState": "OPEN",
          "origin": "ONLINE",
          "originalOrder": {
            "id": "string",
            "number": "string"
          },
          "subscription": {
            "id": "string",
            "interval": 0,
            "unit": "DAYS",
            "type": "PREPAY",
            "status": "ACTIVE",
            "instalments": [
              {
                "id": "string",
                "amount": {
                  "currencyCode": "string",
                  "centAmount": 0
                },
                "dueDate": "2019-08-24T14:15:22Z",
                "paidDate": {},
                "success": {}
              }
            ]
          },
          "type": "STANDARD",
          "lineItems": [
            {
              "groupId": 0,
              "id": "string",
              "itemCategory": "string",
              "name": "string",
              "number": "string",
              "quantity": 0,
              "returnedQuantity": 0,
              "returnableQuantity": 0,
              "sku": "string",
              "state": "string",
              "style": "string"
            }
          ]
        },
        "returnInfo": {
          "number": "string",
          "createdAt": "2019-08-24T14:15:22Z",
          "createdBy": {
            "id": "string",
            "email": "string",
            "userType": "string",
            "name": "string"
          },
          "lastModifiedAt": "2019-08-24T14:15:22Z",
          "lastModifiedBy": {
            "id": "string",
            "email": "string",
            "userType": "string",
            "name": "string"
          },
          "state": "INITIATED",
          "paymentState": "PENDING",
          "type": "RECEIPTED",
          "totalRefundAmount": {
            "currencyCode": "string",
            "centAmount": 0
          },
          "lineItems": [
            {
              "id": "string",
              "lineItemId": "string",
              "quantity": 0,
              "reasonCode": "string",
              "reason": "string",
              "additionalInfo": "string",
              "appeasementType": "PERCENT_OFF",
              "appeasementValue": 0
            }
          ],
          "creditNote": {
            "id": "string",
            "fileName": "string",
            "createdAt": "2019-08-24T14:15:22Z",
            "lastUpdatedAt": "2019-08-24T14:15:22Z",
            "externalUrl": "string",
            "storageAccountName": "string",
            "storageContainerName": "string",
            "storagePath": "string"
          }
        },
        "aftercareStore": {
          "address": {
            "city": "string",
            "country": "string",
            "line1": "string",
            "line2": "string",
            "line3": "string",
            "name": "string",
            "postcode": "string",
            "region": "string"
          },
          "companyDetails": {
            "name": "string",
            "registeredAddress": "string"
          },
          "contactInfo": {
            "phone": "string",
            "email": "string"
          },
          "coordinates": {
            "latitude": "string",
            "longitude": "string"
          },
          "lineOfBusiness": "string",
          "name": "string",
          "eposNumber": "string",
          "storeUrl": "string"
        }
      }
    }
    

    This example has been generated automatically.

  • #27

    • application/json

    Message IDHicapsWebhookEvent

    Correlation ID$message.payload#/detail/correlationid

    Default Correlation ID

    The application will send new content events through this channel.

    Payload

    Expand all

    object

    id

    required

    string

    specversion

    required

    string

    Default value:"1.0"

    env

    required

    string

    The environment from which the event originated from e.g. dev, prod

    Allowed values:
    • "local"
    • "dev"
    • "qa"
    • "qa2"
    • "stg"
    • "prod"

    sourceService

    string

    Const:"com.specsavers/order-service"

    type

    required

    string

    Const:"com.specsavers.rtp.order.hicaps.webhook"

    correlationid

    required

    string

    The correlation ID of the event. E.g. 1234

    data

    Expand all

    required

    object

    headers

    Expand all

    required

    object

    The headers of the webhook event

    Additional properties:

    string

    body

    required

    string

    The body of the webhook event

    Additional properties are NOT allowed.

    Extensions

    x-envelope-type

    cloudevent

    Additional properties are allowed.

    • #content

    Examples

    Payload

    {
      "id": "string",
      "specversion": "1.0",
      "env": "local",
      "sourceService": "com.specsavers/order-service",
      "type": "com.specsavers.rtp.order.hicaps.webhook",
      "correlationid": "string",
      "data": {
        "headers": {
          "property1": "string",
          "property2": "string"
        },
        "body": "string"
      }
    }
    

    This example has been generated automatically.