Product Ordering API manages the following Data resources:

• Product order
  • Main Product Order attributes are
    • Id: ID created on repository side (OM system)
    • Href: Hyperlink to access the order
    • External ID: ID given by the consumer and only understandable by him (to facilitate his searches afterwards)
    • State: State of the order
    • Priority: A way that can be used by consumers to prioritize orders in OM system (from 0 to 4 : 0 is the highest priority, and 4 the lowest)
    • Category: Used to categorize the order from a business perspective that can be useful for the OM system (e.g. "enterprise", "residential", ...)
    • Order Date: Date when the order was created
    • Requested Start Date: Order start date wished by the requestor
    • Completion Date: Date when the order was completed
    • Requested Completion Date: Requested delivery date from the requestor perspective
    • Expected Completion Date: Expected delivery date amended by the provider
    • Notification Contact: Contact attached to the order to send back information regarding this order
    • Note: Extra-information about the order (e.g. useful to add extra delivery information that could be useful for a human process: a digicode access to a building …)
    • Billing Account: Billing Account to use to bill the ordered products
    • Related Party: Parties which are involved in this order and the role they are playing
    • Order Item: List of order items that have to be treated
• Order item
  • Main Product Order attributes are
    • Id: Identifier of the line item (generally it is a sequence number 01, 02, 03, …)
    • ActionCan be "add" / "modify" / "no_change"/ "delete"
    • StateState of the order item
    • Place: Used to defined a place useful for the order item (for example a delivery geographical place)
    • Appointment: Used to precise that an appointment was set up with a related party for this order item
    • Product Offering :Ordered offering (pricing, default values, etc. are fetched by the OM directly from the catalog)
      • It may be a bundle Product Offering, in this case it will contain the list of bundled offers that are ordered
      • Product: Configure the product characteristics (only configurable characteristics and necessary only if a non-default value is selected) and/or identify the product that needs to be modified/deleted. Product attributes are:
        • Id: Identifier of the owned product (useful for delete or modify command)
        • Href: Reference to the owned product (useful for delete or modify command)
        • Product Characteristics: Characteristics of the product to instantiate or to modify
        • Product Relationship: Linked products to the one instantiated, it can be :
          • "bundled" if the product is a bundle and you want to describe the "bundled" products inside this bundle
          • "reliesOn" if the product needs another already owned product to rely on (e.g. an option on an already owned mobile access product)
          • "targets" or "isTargeted" (depending on the way of expressing the link) for any other kind of links that may be useful
          • Related Party: Party linked at the product level (it may be a User for example)