Product inventory API manages Product resource:
Main attributes of Product are:
- Id: is the ID created for the product
- Name: is the name of the product. It could be the same as the name of the Product Offering
- Description: is the description of the product. It could be copied from the description of the Product Offering.
- Status: Is the status of the product.
- isBundle: Boolean indicating if the product is a bundle
- is Customer Visible: is a Boolean indicating if the product is visible by customer
- product Serial Number: is the serial number for the product. This is typically applicable to tangible products e.g. Broadband Router.
- Start Date: is the date from which the product starts
- Order Date: is the date when the product was ordered.
- Termination Date: is the date when the product was terminated. Not applicable to active products.
- Product Offering: is a link to the product offering.
- Product Specification: is a link to the product specification. It may be useful to manage links directly to the Product Specification, when the product is a non-bundle one you may not manage the Product Offering link with this Product.
- Product Characteristics: is a list of name value pairs listing the various relevant characteristics of the instantiated product.
- Product Relationships: is a collection of a number of types of relationships between the products e.g. bundle. The value of the 'type' attribute should describe the direction of the relationship. E.g. "isContainedIn"
- Billing Account: is a link to the billing account on which the product is billed. This is optional because in some cases the parent is billed and not all the children.
- Related Parties: is a link to collection of parties. Each party will contain a role and a link.
- Agreement Item: is a link to the agreement item for the product. Agreement item will contain the terms and conditions for the product including the product term.
- Place: is a link to the place where the product is provided.
- Realizing Service: is a link to the service that realizes the product.
- Realizing Resource: is a link to the resource that realizes the product.
- Product Price: is a collection of all applicable prices for the product, it's an override of the default one specified in the Product Offering.