Product Inventory Process API

1.0.x
(0 reviews)

Brief Description

The following document is the specification of the REST API for Product Inventory Management. It includes the model definition as well as all available operations. Possible actions are creating, updating and retrieving Product.

The Product API provides a standardized mechanism to retrieve product inventory information. The API consists of a simple set of operations that interact with Inventory systems in a consistent manner. Usually, a product is created and modified consequently to product order bit could be also ‘directly’ modified for administrative reason.

Product API manages product resource:

A Product represents an instance of a product offering subscribed to by a party, such as a customer, the place where the product is in use, as well as configuration characteristics, such as assigned telephone numbers and internet addresses. The Product also tracks the services and/or resources through which the product is realized.

Product API performs the following operations on Product:

  • Retrieval of a product or a collection of product depending on filter criteria
  • Partial update of a product (including updating rules) (for administration purposes)
  • Creation of a product (including default values and creation rules) (for administration purposes)
  • Deletion of product (for administration purposes)
  • Notification of events on product
    • Product creation
    • Product removal
    • Product status change
    • Product value change used to notify that any data in a product has just changed
Criticality

Medium

Layer/Category

Process

API Current State

Testing Phase

Usage

TBD

Base URI Summary of Methods
  1. Development
  2. Test
  3. Pre-Prod
  4. Prod
Transport Protocol(s)

HTTPS

3 Layer architecture flow diagram
Sequence Diagram

TBD

Quality of Service (QoS)

TBD

Avg. Response Time (Secs)

TBD

Avg. Payload Size (KB/MB)

TBD

Max Payload Size (KB/MB)

TBD

Avg. Volumes (per day)

TBD

Peak Volumes

TBD

Peak Volumes Timespan

TBD

Availability

High Availability

Service Level Agreement

N/A

Policies

N/A

GDPR

TBD

Constraints

There are no constraints applicable to this API.

Assumptions

Average/Peak Response time depends on the size of payload and speed and other network and processing factors.

Reference documents

Reviews