Discriminator Values

• ProductOrder
• CancelProductOrderOSM

{
    "required":[
        "productOrder"
    ],
    "type":"object",
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "ProductOrder":"#/components/schemas/CancelProductOrder",
            "CancelProductOrderOSM":"#/components/schemas/CancelProductOrderOSM"
        }
    },
    "properties":{
        "id":{
            "type":"string",
            "description":"ID of the cancellation request (this is not an order id)."
        },
        "href":{
            "type":"string",
            "description":"Hyperlink to access the cancellation request."
        },
        "cancellationReason":{
            "type":"string",
            "description":"Reason why the order is cancelled."
        },
        "effectiveCancellationDate":{
            "type":"string",
            "description":"Date when the order is cancelled.",
            "format":"date-time"
        },
        "requestedCancellationDate":{
            "type":"string",
            "description":"Date when the order was requested to be cancelled.",
            "format":"date-time"
        },
        "productOrder":{
            "$ref":"#/components/schemas/ProductOrderRef"
        },
        "state":{
            "$ref":"#/components/schemas/TaskStateType"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    },
    "description":"Request for the cancellation of an existing product order."
}

Show Source

• @baseType: string
  When sub-classing, this defines the super-class.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships.
• @type: string
  When sub-classing, this defines the sub-class entity name.
• cancellationReason: string
  Reason why the order is cancelled.
• effectiveCancellationDate: string (date-time)
  Date when the order is cancelled.
• href: string
  Hyperlink to access the cancellation request.
• id: string
  ID of the cancellation request (this is not an order id).
• productOrder(required): object ProductOrderRef
  ProductOrder (ProductOrder). The product order that the recommendation is related to.
• requestedCancellationDate: string (date-time)
  Date when the order was requested to be cancelled.
• state: string
  Allowed Values: [ "acknowledged", "terminatedWithError", "inProgress", "done", "queued", "terminated", "skipped" ]

  Possible values for the state of a task.

{
    "required":[
        "productOrder"
    ],
    "type":"object",
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "ProductOrder":"#/components/schemas/CancelProductOrder",
            "CancelProductOrderOSM":"#/components/schemas/CancelProductOrderOSM"
        }
    },
    "properties":{
        "id":{
            "type":"string",
            "description":"ID of the cancellation request (this is not an order id)."
        },
        "href":{
            "type":"string",
            "description":"Hyperlink to access the cancellation request."
        },
        "cancellationReason":{
            "type":"string",
            "description":"Reason why the order is cancelled."
        },
        "effectiveCancellationDate":{
            "type":"string",
            "description":"Date when the order is cancelled.",
            "format":"date-time"
        },
        "requestedCancellationDate":{
            "type":"string",
            "description":"Date when the order was requested to be cancelled.",
            "format":"date-time"
        },
        "productOrder":{
            "$ref":"#/components/schemas/ProductOrderRef"
        },
        "state":{
            "$ref":"#/components/schemas/TaskStateType"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    },
    "description":"Request for the cancellation of an existing product order."
}

Show Source

• @baseType: string
  When sub-classing, this defines the super-class.
• @referredType: string
  The actual type of the target instance when needed for disambiguation.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships.
• @type: string
  When sub-classing, this defines the sub-class entity name.
• href: string
  Reference of the related entity.
• id(required): string
  Unique identifier of a related entity.
• name: string
  Name of the related entity.

{
    "required":[
        "id"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of a related entity."
        },
        "href":{
            "type":"string",
            "description":"Reference of the related entity."
        },
        "name":{
            "type":"string",
            "description":"Name of the related entity."
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        },
        "@referredType":{
            "type":"string",
            "description":"The actual type of the target instance when needed for disambiguation."
        }
    },
    "description":"ProductOrder (ProductOrder). The product order that the recommendation is related to."
}

Show Source

• @baseType: string
  When sub-classing, this defines the super-class.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships.
• @type: string
  When sub-classing, this defines the sub-class entity name.
• code(required): string
  Application relevant detail, defined in the API or a common list.
• message: string
  More details and corrective actions related to the error shown to a client user.
• reason(required): string
  Explanation of the reason for the error shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error.
• state: string
  HTTP error code extension.

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error shown to a client user."
        },
        "state":{
            "type":"string",
            "description":"HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    },
    "description":"Used when an API throws an error. Typically, with an HTTP error response-code (3xx, 4xx, 5xx)."
}

Show Source

• @baseType: string
  When sub-classing, this defines the super-class.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships.
• @type: string
  When sub-classing, this defines the sub-class entity name.
• code(required): string
  Application relevant detail, defined in the API or a common list.
• message: string
  More details and corrective actions related to the error shown to a client user.
• reason(required): string
  Explanation of the reason for the error shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error.
• state: string
  HTTP error code extension.

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error shown to a client user."
        },
        "state":{
            "type":"string",
            "description":"HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    },
    "description":"Used when an API throws an error. Typically, with an HTTP error response-code (3xx, 4xx, 5xx)."
}

Show Source

• @baseType: string
  When sub-classing, this defines the super-class.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships.
• @type: string
  When sub-classing, this defines the sub-class entity name.
• code(required): string
  Application relevant detail, defined in the API or a common list.
• message: string
  More details and corrective actions related to the error shown to a client user.
• reason(required): string
  Explanation of the reason for the error shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error.
• state: string
  HTTP error code extension.

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error shown to a client user."
        },
        "state":{
            "type":"string",
            "description":"HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    },
    "description":"Used when an API throws an error. Typically, with an HTTP error response-code (3xx, 4xx, 5xx)."
}

Show Source

• @baseType: string
  When sub-classing, this defines the super-class.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships.
• @type: string
  When sub-classing, this defines the sub-class entity name.
• code(required): string
  Application relevant detail, defined in the API or a common list.
• message: string
  More details and corrective actions related to the error shown to a client user.
• reason(required): string
  Explanation of the reason for the error shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error.
• state: string
  HTTP error code extension.

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error shown to a client user."
        },
        "state":{
            "type":"string",
            "description":"HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    },
    "description":"Used when an API throws an error. Typically, with an HTTP error response-code (3xx, 4xx, 5xx)."
}

Show Source

• @baseType: string
  When sub-classing, this defines the super-class.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships.
• @type: string
  When sub-classing, this defines the sub-class entity name.
• code(required): string
  Application relevant detail, defined in the API or a common list.
• message: string
  More details and corrective actions related to the error shown to a client user.
• reason(required): string
  Explanation of the reason for the error shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error.
• state: string
  HTTP error code extension.

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error shown to a client user."
        },
        "state":{
            "type":"string",
            "description":"HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    },
    "description":"Used when an API throws an error. Typically, with an HTTP error response-code (3xx, 4xx, 5xx)."
}

Show Source

• @baseType: string
  When sub-classing, this defines the super-class.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships.
• @type: string
  When sub-classing, this defines the sub-class entity name.
• code(required): string
  Application relevant detail, defined in the API or a common list.
• message: string
  More details and corrective actions related to the error shown to a client user.
• reason(required): string
  Explanation of the reason for the error shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error.
• state: string
  HTTP error code extension.

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error shown to a client user."
        },
        "state":{
            "type":"string",
            "description":"HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    },
    "description":"Used when an API throws an error. Typically, with an HTTP error response-code (3xx, 4xx, 5xx)."
}

Show Source

• @baseType: string
  When sub-classing, this defines the super-class.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships.
• @type: string
  When sub-classing, this defines the sub-class entity name.
• code(required): string
  Application relevant detail, defined in the API or a common list.
• message: string
  More details and corrective actions related to the error shown to a client user.
• reason(required): string
  Explanation of the reason for the error shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error.
• state: string
  HTTP error code extension.

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error shown to a client user."
        },
        "state":{
            "type":"string",
            "description":"HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    },
    "description":"Used when an API throws an error. Typically, with an HTTP error response-code (3xx, 4xx, 5xx)."
}