Product Order Management: Release notes

Release Kylie:

Readiness status: Mplify Published Standard

Summary:

No changes

Release Janis:

Readiness status: Requested Letter Ballot. It will be most likely published as a standard in this form.

Summary:

• Common schemas consistency applied.

• Split R111 and R112 to R111-R115 for better clarity. No actual change in logic.

• Clarification of the requirements for action=delete (R12 and R46) - contacts must be provided.

• productOrderManagement.api.yaml:

• GeographicAddress_Query:

  • @type - added
  • minProperties: 2 - added

• MEFProductOrderItem_Common:

  • requestedCompletionDate - marked as required (according to already exisitng Requirement)

productOrderNotification.api.yaml:

No changes.

Release Irene:

Readiness status: Call for Comments Ballot #1. Work in progress and is subject to change.

Summary:

• Implementing new Address model introduced by MEF 150
• Revised, fully specialized Event model.
• State change events now carry the value of the new state
• buyerId and sellerId in notification now carried via query params (consistent with seller side API)
• Clarification of the requirements for action=delete (section 6.1.8. and R14)
• Allowed change of ProductOffering in modification request

List of changes in the API:

productOrderManagement.api.yaml:

• GET /productOrder:

  • 422 - response code added

• GET /productOrder/{id}:

  • 422 - response code added

• GET /cancelProductOrder:

  • 422 - response code added

• GET /charge:

  • 422 - response code added

• PATCH /charge/{id}:

  • 422 - response code added

• POST /hub:

  • 422 - response code added

• DELETE /hub/{id}:

  • 422 - response code added

• ContactInformation - added

• Duration:

  • amount - added minimum:0

• FieldedAddress - replaced with FieldedAddressRepresentation

  • allOf with GeographicAddress - removed
  • buildingName - added
  • country - removed
  • countryCode - added
  • geographicSubAddress - removed
  • language - added
  • poBox - added
  • privateStreetName - added
  • privateStreetNumber - added
  • streetPreDirection - added
  • streetPostDirection - added
  • streetSuffix - removed
  • no attribute is required anymore

• FormattedAddress - replaced with FormattedAddressRepresentation

  • addrLine1 - renamed to formattedAddress
  • allOf with GeographicAddress - removed
  • addrLine2 - removed
  • city - removed
  • country - removed
  • language - added
  • locality - removed
  • postcode - removed
  • postcodeExtension - removed
  • stateOrProvince - removed

• GeographicAddress_Query - added

• GeographicAddressLabel - replaced with LabelRepresentation

  • allOf with GeographicAddress - removed
  • externalReferenceId - renamed to label
  • externalReferenceType - renamed to administrativeAuthority
  • language - added

• GeographicAddressRef

  • does not extend the GeographicAddressRefOrValue
  • @type - added with constant GeographicAddressRef value

• GeographicSiteRef

  • does not extend the GeographicAddressRefOrValue
  • @type - added with constant GeographicSiteRef value- GeographicSubAddress - removed

• MEFChargePeriod - removed

• MEFGeographicPoint - replaced with GeographicPointRepresentation

  • allOf with GeographicAddress - removed
  • x - renamed to longitude
  • y - renamed to latitude
  • z - renamed to elevation

• MEFProductRefOrValueOrder:

  • place - ref type changed to RelatedPlaceRefOrQueryWithSubUnit

• MEFProductOrderChargeItem:

  • recurringChargePeriod - changed ref type to Duration

• MEFProductOrderItem_Common:

  • product - clarified to be required

• MEFSubUnit - renamed to SubUnit

• PlaceRefOrQuery - added, now using oneOf instead of allOf for refOrValue pattern

• ProductOrder:

  • stateChange - clarified to be required, minItems=1

• ProductOrderItem:

  • state - clarified to be required
  • stateChange - clarified to be required, minItems=1

• RelatedContactInformation:

  • postalAddress - changed ref type to FieldedAddressRepresentation

• RelatedPlaceRefOrQueryWithSubUnit - added

• RelatedPlaceRefOrValue - replaced with RelatedPlaceRefOrQueryWithSubUnit

• TimeUnit:

  • added:
    • seconds
    • minutes
    • months
    • years
  • removed:
    • calendarMinutes
    • businessMinutes
    • calendarMonths

productOrderNotification.api.yaml:

• buyerId and sellerId added to parameters to all endpoints ProductOrderEventPayload

• buyerId and sellerId removed from all payloads

• all listener endpoint changed the requestBody content schema to their respective events.

• /listener/productOrderItemExpectedCompletionDateSet - path renamed to /listener/productOrderItemExpectedCompletionDateSetEvent

• 408 - response code removed

• Error408 - removed

• Event - made a generic Event

  • event - added
  • eventType - added

• CancelProductOrderEvent - removed

• CancelProductOrderEventPayload - removed

• CancelProductOrderEventType - removed

• CancelProductOrderStateChangeEvent - added

• CancelProductOrderStateChangeEventPayload - added

• ChargeEvent - removed

• ChargeEventType - removed

• ChargeCreateEvent - added

• ChargeStateChangeEvent - added

• ChargeStateChangeEventPayload - added

• ChargeTimeoutEvent - added

• MEFChargeableTaskStateType - added

• MEFProductOrderChargeStateType - added

• MEFProductOrderItemStateType - added

• MEFProductOrderStateType - added

• ModifyProductOrderItemRequestedDeliveryDateEvent - removed

• ModifyProductOrderItemRequestedDeliveryDateEventPayload - removed

• ModifyProductOrderItemRequestedDeliveryDateEventType - removed

• ModifyProductOrderItemRequestedDeliveryDateStateChangeEvent - added

• ModifyProductOrderItemRequestedDeliveryDateStateChangeEventPayload - added

• ProductOrderEventPayload - removed

• ProductOrderEventType - removed

• ProductOrderItemExpectedCompletionDateSetEvent - added

• ProductOrderItemExpectedCompletionDateSetEventPayload - added

• ProductOrderItemStateChangeEvent - added

• ProductOrderItemStateChangeEventPayload - added

• ProductOrderStateChangeEvent - added

• ProductOrderStateChangeEventPayload - added- `` - added

• ProductSpecificProductOrderItemMilestoneEvent - added

• ProductSpecificProductOrderItemMilestoneEventPayload - added

Release Haley:

Readiness status: MEF Published Standard

No changes.

Release Grace:

Readiness status: MEF Published Standard

No changes.

Release Fergie:

Readiness status: MEF Published Standard

No changes.

Release Ella:

Readiness status: Requested Letter Ballot. It will be most likely published as a standard without further changes.

Summary - Only small updates introduced:

• 1 attribute added,
• 1 attribute marked as required.

List of changes in the API:

productOrderManagement.api.yaml:

• CancelProductOrder
  • charge - added
• MEFProductOrderCharge_Find
  • marked as required:
    • creationDate

productOrderNotification.api.yaml:

None

Release Dolly:

Readiness status: Work in progress and is subject to change. Completed and resolved Call for Comments #2

List of changes in the API:

productOrderManagement.api.yaml:

• /productOrder/

  • GET
    • requestedCompletionDate.gt - renamed to itemRequestedCompletionDate.gt
    • requestedCompletionDate.lt - renamed to itemRequestedCompletionDate.lt
    • expectedCompletionDate.gt - renamed to itemExpectedCompletionDate.gt
    • expectedCompletionDate.lt - renamed to itemExpectedCompletionDate.lt
    • orderCancellationDate.gt - renamed to cancellationDate.gt
    • orderCancellationDate.lt - renamed to cancellationDate.lt

• /cancelProductOrder/

  • GET
    • productOrderExternalId - removed
    • state - added
    • cancellationReasonType - added

• /charge/

  • GET
    • creationDate.gt - added
    • creationDate.lt - added

• ProductOrder

  • orderVersion - removed
  • expectedCompletionDate - removed

• ProductOrder_Common

  • requestedCompletionDate - removed

• ProductOrder_Find

  • orderVersion - removed
  • requestedCompletionDate - removed

• ProductOrder_Update

  • orderVersion - removed

• CancelProductOrder

  • orderVersion - removed

• CancelProductOrder_Create

  • orderVersion - removed

• MEFModifyProductOrderItemRequestedDeliveryDate

  • orderVersion - removed

• MEFModifyProductOrderItemRequestedDeliveryDate_Create

  • orderVersion - removed

• ProductOrderItem

  • milestone - added

• CancelProductOrder

  • relatedContactInformation - required role sellerContact renamed to cancelProductOrderSellerContact

• CancelProductOrder_Find - added and set as result type of listCancelProductOrder list operation

• MEFProductOrderCharge

  • replacedCharge - removed
  • creationDate - made required

• MEFProductOrderChargeItem

  • chargeType - renamed to priceType
  • description - renamed to priceCategory
  • note - added

• MEFProductOrderChargeItem_Update

  • note - added

• MEFProductOrderCharge_Find - added and set as result type of listCharge list operation

• MEFProductOrderChargeItemDescription - renamed to MEFPriceCategory

  • other - added to enumeration

• MEFMilestone - added

• MEFItemTerm

  • made required:
    • name
    • duration
    • endOfTermAction

productOrderNotification.api.yaml:

• server URL /mefApi/sonata/productOrderingManagement/ changed to /mefApi/sonata/productOrderingNotification/

Release Celine:

Readiness status: Work in progress and is subject to change. Completed and resolved Call for Comments #1

List of changes in the API:

productOrderManagement.api.yaml:

• /productOrder/

  • GET
    • orderCancellationDate.gt renamed to cancellationDate.gt
    • orderCancellationDate.lt renamed to cancellationDate.lt

• /modifyProductOrderItemCompletionDate renamed to /modifyProductOrderItemRequestedDeliveryDate

• /modifyProductOrderItemRequestedDeliveryDate

  • GET
    • added:
      • creationDate.gt
      • creationDate.lt

• ProductOrder

  • added:
    • cancellationCharge
  • removed:
    • description

• ProductOrderItem

  • added:
    • agreementName
  • removed:
    • sellerItemIdentifier

• MEFBillingAccount - removed (replaced by MEFBillingAccountRef. agreementName and billingContact moved to Product Order Item level

• MEFBillingAccountRef - added

• CancelProductOrder

  • added:
    • cancellationDeniedReason
  • removed:
    • note

• MEFCharge - renamed to MEFProductOrderCharge

• MEFCharge_Update - renamed to MEFProductOrderCharge_Update

• MEFChargeStateType - renamed to MEFProductOrderChargeStateType

• MEFChargeRef - renamed to MEFProductOrderChargeRef

• MEFChargeActivityType - renamed to MEFProductOrderChargeActivityType

• MEFChargeItem - renamed to MEFProductOrderChargeItem

• MEFChargeItem_Update - renamed to MEFProductOrderChargeItem_Update

• MEFChargeItemStateType - renamed to MEFProductOrderChargeItemStateType

• MEFChargeItemDescription - renamed to MEFProductOrderChargeItemDescription

• MEFChargeItemDescription

  • inFlightCancellation - renamed to cancellation

• MEFModifyProductOrderItemCompletionDate - renamed to MEFModifyProductOrderItemRequestedDeliveryDate

• MEFModifyProductOrderItemCompletionDateRef - renamed to MEFModifyProductOrderItemRequestedDeliveryDateRef

• MEFModifyProductOrderItemCompletionDate_Create - renamed to MEFModifyProductOrderItemRequestedDeliveryDate_Create

• MEFProductOrderCharge:

  • added:
    • productOrder
    • replacedCharge
  • modifyProductOrderItemCompletionDate renamed to modifyProductOrderItemRequestedDeliveryDate
  • productOrderItem - marked not required

• MEFProductOrderChargeItem:

  • chargeType - marked as required
  • description - marked as required
  • description - dictionary introduced (https://github.com/MEF-GIT/MEF-LSO-Sonata-SDK-extended/issues/60)
  • activityType - marked as required
  • blocking - marked as required
  • price - marked as required
  • state - marked as required

• MEFChargeStateType

  • timeout - added

• MEFProductOrderRef

  • productOrderId - made required

productOrderNotification.api.yaml:

Changed the url from /productOrderNotification to productOrderingNotification

• /listener/productSpecificProductOrderMilestoneEvent - endpoint removed

• /listener/productOrderExpectedCompletionDateSet - endpoint removed

• ProductOrderEventType

  • productSpecificProductOrderMilestoneEvent - removed
  • productOrderExpectedCompletionDateSet - removed

• Code renamed to Error400Code

• /listener/modifyProductOrderItemCompletionDateStateChangeEvent renamed to /listener/ModifyProductOrderItemRequestedDeliveryDateStateChangeEvent

• ModifyProductOrderItemCompletionDateEvent renamed to ModifyProductOrderItemRequestedDeliveryDateEvent

• ModifyProductOrderItemCompletionDateEventType renamed to ModifyProductOrderItemRequestedDeliveryDateEventType

• modifyProductOrderItemCompletionDateStateChangeEvent renamed to ModifyProductOrderItemRequestedDeliveryDateStateChangeEvent

• ModifyProductOrderItemCompletionDateEventPayload renamed to ModifyProductOrderItemRequestedDeliveryDateEventPayload

Release Billie:

Readiness status: Work in progress and is subject to change

List of changes in the API:

• endpoints added:
  • /productOrder/{id}:
    • patch
  • /charge:
    • get
  • /charge/{id}:
    • get
    • patch
  • /modifyProductOrderItemCompletionDate:
    • get
    • post
  • /modifyProductOrderItemCompletionDate/{id}
    • get
• MEFProductOrderSummary renamed to MEFProductOrder_Find
• ProductOrder:
  • added:
    • charge
    • requestedCompletionDate
  • removed:
    • pricingReference
  • state:
    • pending - renamed to pending.assessingModification
    • held - renamed to held.assessingCharge
• ProductOrderItem
  • added:
    • expediteAcceptedIndicator
    • charge
    • terminationError
  • removed:
    • itemPrice
  • itemTerm - maxItems: 1
• MEFProductOrderItem_Common:
  • added:
    • relatedBuyerPON
    • expediteIndicator
  • removed:
    • pricingReference
    • pricingTerm
    • pricingMethod
    • itemPrice
  • coordinatedAction - changed to array
  • requestedItemTerm - changed from list to single reference
• MEFItemTerm
  • name - added
  • description - added
• MEFProductRefOrValueForOrder
  • renamed to MEFProductRefOrValueOrder
  • buyerProductId - removed
  • productOffering - not mandatory
• MEFOrderItemCoordinatedAction
  • id - renamed to itemId
• MEFProductConfiguration
  • @schemaLocation - removed
• ProductRelationship
  • groupingKey - removed
• ProductOrderEventPayload
  • milestoneName - added
• Error - removed status
• CancelProductOrder
  • added:
    • cancellationReasonType
    • orderVersion
    • note
    • relatedContactInformation
  • removed:
    • requestedCancellationDate
    • effectiveCancellationDate
    • cancellationDeniedReason
• CancelProductOrder_Create
  • added:
    • cancellationReasonType
    • orderVersion
    • note
    • relatedContactInformation
  • removed:
    • requestedCancellationDate
• MEFBillingAccountRefOrValue replaced with MEFBillingAccount
• NoteSourceType - renamed to MEFBuyerSellerType
• Notifications:
  • removed:
    • productOrderCreateEvent
    • cancelProductOrderCreateEvent
  • added:
    • productOrderItemStateChangeEvent
    • productSpecificProductOrderMilestoneEvent
    • productSpecificProductOrderItemMilestoneEvent
    • chargeCreateEvent
    • chargeStateChangeEvent
    • chargeTimeoutEvent
    • modifyProductOrderItemCompletionDateStateChangeEvent
  • renamed:
    • productOrderExpectedCompletionDateSet => productOrderExpectedCompletionDateSetEvent
    • productOrderItemExpectedCompletionDateSet => productOrderItemExpectedCompletionDateSetEvent
• Added types
  • ProductOrder_Update
  • MEFProductOrderItem_Update
  • MEFCharge
  • MEFChargeItem
  • MEFChargeActivityType
  • MEFPriceType
  • MEFChargeStateType
  • MEFAcceptedRejectedType
  • MEFModifyProductOrderItemCompletionDate
  • MEFModifyProductOrderItemCompletionDateStateType
  • MEFProductOrderItemRef
  • TerminationError
  • CancelProductOrderStateType
  • CancellationReasonType
• Removed types:
  • MEFPricingMethod
  • Error405
  • OrderPrice
  • TaskStateType
  • MEFPricingMethod
  • OrderPrice

Release Aretha:

List of changes in the API:

Change Log:

• /productOrder/{id}

  • Removed fields from query parameters

• Order:

  • Removed
    • buyerRequestDate
    • desiredResponse
    • expeditePriority
    • Note
    • orderActivity
    • orderMessage
    • pricingMethod
    • pricingReference
    • relatedBuyerPON
    • requestedCompletionDate
    • tspRestorationPriority
    • pricingTerm
    • priority

• OrderItem:

  • Added:
    • completionDate
    • coordinatedAction
    • expectedCompletionDate
    • expediteIndicator
    • Note
    • relatedBuyerPON
    • requestedCompletionDate
    • sellerItemIdentifier
    • tspRestorationPriority
    • requestedItemTerm
  • Moved productOffering to MEFProductRefOrValue
  • relatedParty refactored to RelatedContactInformation

• Error409 - removed

• Error422

  • status - removed

• GlobalAddressId

  • Renamed to GeographicAddressIdentifier

• MEFBillingAccountRefOrValue

  • Removed
    • @type
  • Added
    • agreementName

• MEFBillingContact replaced with RelatedContactInformation

• MEFDesiredOrderResponse removed

• MEFEndOfTermAction - added

• MEFGeographicPoint

  • Merged with MEFGeographicLocation
  • Added:
    • z - elevation

• MEFGeographicLocation - removed

• MEFProductOrderItemStateType

  • Removed inProgress.configured

• MEFProductOrderStateType

  • Removed
    • inProgress.configured
    • inProgress.confirmed
    • inProgress.jeopardy

• MEFProductRefOrValue

  • productOffering - added
  • productSpecification - removed
  • @type - removed

• MEFQuoteItemRef

  • Removed:
    • @type
    • @referredType

• MEFEndOfTermAction - added

• MEFSeverity - removed

• Note

  • Added source - mandatory

• NoteSourceType - added

• OrderItemRelationship

  • Removed
    • @type

• OrderItemCoordinatedAction - added

• OrderItemCoordinationDependencyType - Added

• OrderTerm changed to MEFItemTerm

• PlaceRef

  • Split to GeographicAddressRef and GeographicSiteRef to reflect existing MEF endpoints and ease implementation

• ProductOfferingQualificationItemRef

  • Removed:
    • @type
    • @referredType

• ProductOfferingRef

  • removed:
    • name
    • @type
    • @referredType

• ProductRelationship

  • Removed:
    • buyerProductId - removed
    • @type
    • @referredType
  • added:
    • groupingKey

• ProductSpecificationRef - removed

• Quantity unified to Duration and TimeUnit

• RelatedParty

  • refactored to RelatedContactInformation
  • added:
    • organization
    • postalAddress

• TargetProductSchema - removed

• Notifications:

• Added:

  • cancelProductOrderCreateEvent
  • cancelProductOrderStateChangeEvent
  • productOrderExpectedCompletionDateSet
  • productOrderItemExpectedCompletionDateSet

• Removed:

  • productOrderAttributeValueChangeEvent
  • productOrderInformationRequiredEvent

Developer Guide document

There is no Developer Guide document at his moment. A project is running to deliver one for the next Billie release.

Readiness status: Work in progress and is subject to change