Product Ordering Biz Api

1.0.x
(0 reviews)

Brief Description

The following document is the specification of the REST API for Product Ordering API. It includes the model definition as well as all available operations.

The Product Ordering API provides a standardized mechanism for placing a product order with all of the necessary order parameters. The API consists of a simple set of operations that interact with CRM/Order Negotiation systems in a consistent manner. A product order is created based on a product offer that is defined in a catalog. The product offer identifies the product or set of products that are available to a customer and includes characteristics such as pricing, product options and market. This API provides a task-based resource to request an order cancellation.

The product order references the product offer and identifies any specific requests made by the customer.

Product Order manages the following data resources:

Product Order resource

A Product Order is a type of order which can be used to place an order between a customer and a service provider or between a service provider and a partner and vice versa.

Cancel Product Order resource

Request for cancellation an existing product order

Notification Resource Models: Notification related to product order and cancel product order resource

  • Product Order Create Event
  • Product Order Attribute Value Change Event
  • Product Order Information Required Event

Criticality

Medium

Layer/Category

Process

Base URI Summary of Methods

  1. Development
  2. Pre-Prod
  3. 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