TM Forum Open API

Product Inventory Management API

See which products and services a customer has

The Product Inventory Management API is designed to provide businesses with a structured and standardized way to manage product inventory data efficiently.

  • Subscription lookup
  • Upsell eligibility
  • Service status

What you can do with this API

Ready to test? Jump to the sample call and the API reference, where you can try every endpoint. Start testing
Read the full API overview

Product Inventory Management API

The Product Inventory Management API is designed to provide businesses with a structured and standardized way to manage product inventory data efficiently. It enables enterprises to create, update, and retrieve product details, ensuring consistency and accuracy across inventory systems.

Key Capabilities

1. Product Creation & Updating

  • Allows businesses to create new product entries in the inventory system.
  • Supports modification of existing product data due to product orders or administrative adjustments.

2. Real-Time Inventory Tracking

  • Provides accurate and up-to-date inventory status across multiple storage locations.
  • Helps businesses monitor stock levels, availability, and movement of products.

3. Standardized Product Information Retrieval

  • Enables seamless retrieval of product inventory details across different platforms.
  • Ensures consistent data synchronization with order and fulfillment systems.

4. Integration with Business Processes

  • Works with ordering, warehouse management, and sales systems to ensure smooth operations.
  • Helps teams access real-time inventory data to make informed supply chain decisions.

5. Automated Inventory Adjustments

  • Updates stock levels automatically when orders are placed, fulfilled, or canceled.
  • Supports manual modifications for administrative or regulatory purposes.

6. Enhanced Visibility & Reporting

  • Generates detailed inventory reports for tracking product trends and stock movement.
  • Helps businesses optimize inventory management to reduce shortages or overstock issues.

Use Cases of Product Inventory Management API

  1. Retail & E-Commerce – Ensures product availability for online and physical stores.
  2. Warehouse & Supply Chain Management – Provides accurate stock levels for fulfillment centers.
  3. Manufacturing & Production Tracking – Monitors materials and finished product inventories.
  4. Subscription-Based Services – Keeps track of stock for recurring product-based services.
  5. Wholesale & Distribution Networks – Enables smooth operations across multiple suppliers and retailers.

The Product Inventory Management API serves as a critical component in inventory tracking, ensuring businesses have real-time, accurate product data for operational efficiency and seamless customer experiences.

Questions about the Product Inventory Management API

What can I do with the Product Inventory Management API?

The Product Inventory Management API is designed to provide businesses with a structured and standardized way to manage product inventory data efficiently.

  • List or find Product objects (GET /product)
  • Creates a Product (POST /product)
  • Retrieves a Product by ID (GET /product/{id})
  • Updates partially a Product (PATCH /product/{id})
  • Deletes a Product (DELETE /product/{id})
  • Register a listener (POST /hub)
  • Unregister a listener (DELETE /hub/{id})
  • Client listener for entity ProductCreateEvent (POST /listener/productCreateEvent)
  • Client listener for entity ProductAttributeValueChangeEvent (POST /listener/productAttributeValueChangeEvent)
  • Client listener for entity ProductStateChangeEvent (POST /listener/productStateChangeEvent)
  • Client listener for entity ProductBatchEvent (POST /listener/productBatchEvent)
  • Client listener for entity ProductDeleteEvent (POST /listener/productDeleteEvent)
Which inputs does each call to the Product Inventory Management API need?
  • GET /product: requires realizingResource.id, realizingResource.@type
  • GET /product/{id}: requires id
  • PATCH /product/{id}: requires id
  • DELETE /product/{id}: requires id
  • DELETE /hub/{id}: requires id

Every call also needs Authorization: Bearer <access_token>. The API reference on this page shows each field's type and an example request.

Which errors can the Product Inventory Management API return?
  • 400: Bad Request
  • 401: Unauthorized
  • 403: Forbidden
  • 404: Not Found
  • 405: Method Not allowed
  • 409: Conflict
  • 422: Business Rule Exception
  • 500: Internal Server Error

On 401, request a new access token and retry.

Where is the Product Inventory Management API available?

Product Inventory Management is available in Algeria, Kuwait, Maldives, Oman, Palestine and Tunisia.

Which standard does the Product Inventory Management API follow?

It follows the TM Forum Open API standard used across the telecom industry. See our TM Forum certification page.

Related APIs

Sample call

From the published OpenAPI specification. Replace the placeholders with your app's credentials and real values.

Call the API

curl -X GET https://api.ooredoo.com/tmf-api/productInventoryManagement/v1/product \
  -H "Authorization: Bearer $ACCESS_TOKEN"

API reference

Try any endpoint in the sandbox