Skip to content

Introduction

Which is

The Portfolio is responsible for managing information related to the SKUs that are part of a portfolio, and it is also possible to perform simple management of prices and inventories that make up a SKU.

Portfolio Structure Image

How it works

The structure of Portfolio is divided into 3 models:

  • SKU: representation of products within a portfolio.
  • Inventory: quantity of products available for sale.
  • Price: price management of a product.

The most common process for using Portfolio is as follows:

  1. Create SKU using the SKU service.
  2. Link an inventory to the SKU using the Inventory service.
  3. Link a price to the SKU using the Price service.

Scope Considerations

Scopes allow you to specify exactly what type of access your application will request from the client. Since the Portfolio is the system that manages the customer portfolio, there are the following scopes:

  • open:portfolio:read - It will allow read access to all resources.
  • open:portfolio:write - It will allow write access to all resources.

Use cases

  1. I'm an integrator and I want to integrate with a Marketplace that uses Portfolio:
    • Create an application;
    • Consult the client's Tenant ID;
    • Consult all the customer's registered SKUs through the endpoints available in the SKU model;
    • For inventory management of a SKU use the Inventory model;
    • To manage the price of a SKU, use the Price model;
  2. I'm a seller, I have a development team and I want to integrate with a Marketplace that uses Portfolio:
    • Create an application using my Seller ID client.
    • Consult all your registered SKUs through the endpoints available in the SKU model;
    • For inventory management of a SKU use the Inventory model;
    • To manage the price of a SKU, use the Price model;
  3. I want to sell products that are in the catalog, using my stock. (Coming soon with the Catalog).