8.2 Inventory Management

Since inventory is a provider-centric feature, it does not interface with a customer. However, it is called by other services like quotation management, order management, and fulfillment management services.

post

Consumer Interface declares the customer's intent to buy/avail products or services

Body
Responses
post
/search
default

Acknowledgement of message received after successful validation of schema and signature

get

Check availability of a resource in an inventory

Path parameters
resourcestring · enumRequired

Name of the resource

Possible values:
idone ofRequired

ID of the Resource

stringOptional

ID of the item.

Responses
get
/inventory/checkAvailability/{resource}/{id}
default

Successful fetch of resources from the catalog

post

Add Item to inventory

Body

Describes a product or a service offered to the end consumer by the provider. In the mobility sector, it can represent a fare product like one way journey. In the logistics sector, it can represent the delivery service offering. In the retail domain it can represent a product like a grocery item.

idstringOptional

ID of the item.

parent_item_idstringOptional

ID of the item.

category_idsstringOptional

ID of the category

fulfillment_idsstringOptional

Unique reference ID to the fulfillment of an order

location_idsstringOptional
payment_idsstringOptional

ID of the payment term that can be referred at an item or an order level in a catalog

rateablebooleanOptional

Whether this item can be rated

ratingstringOptional

Rating value given to the object. This can be a single value or can also contain an inequality operator like gt, gte, lt, lte. This can also contain an inequality expression containing logical operators like && and ||.

matchedbooleanOptional

Whether this item is an exact match of the request

relatedbooleanOptional

Whether this item is a related item to the exactly matched item

recommendedbooleanOptional

Whether this item is a recommended item to a response

ttlstringOptional

Time to live in seconds for an instance of this schema

Responses
post
/inventory/item/add
default

Successful fetch of resources from the catalog

post

Remove Item from inventory

Body

Describes a product or a service offered to the end consumer by the provider. In the mobility sector, it can represent a fare product like one way journey. In the logistics sector, it can represent the delivery service offering. In the retail domain it can represent a product like a grocery item.

idstringOptional

ID of the item.

parent_item_idstringOptional

ID of the item.

category_idsstringOptional

ID of the category

fulfillment_idsstringOptional

Unique reference ID to the fulfillment of an order

location_idsstringOptional
payment_idsstringOptional

ID of the payment term that can be referred at an item or an order level in a catalog

rateablebooleanOptional

Whether this item can be rated

ratingstringOptional

Rating value given to the object. This can be a single value or can also contain an inequality operator like gt, gte, lt, lte. This can also contain an inequality expression containing logical operators like && and ||.

matchedbooleanOptional

Whether this item is an exact match of the request

relatedbooleanOptional

Whether this item is a related item to the exactly matched item

recommendedbooleanOptional

Whether this item is a recommended item to a response

ttlstringOptional

Time to live in seconds for an instance of this schema

Responses
post
/inventory/item/remove
default

Successful fetch of resources from the catalog

post

Block Item in inventory

Body

Describes a product or a service offered to the end consumer by the provider. In the mobility sector, it can represent a fare product like one way journey. In the logistics sector, it can represent the delivery service offering. In the retail domain it can represent a product like a grocery item.

idstringOptional

ID of the item.

parent_item_idstringOptional

ID of the item.

category_idsstringOptional

ID of the category

fulfillment_idsstringOptional

Unique reference ID to the fulfillment of an order

location_idsstringOptional
payment_idsstringOptional

ID of the payment term that can be referred at an item or an order level in a catalog

rateablebooleanOptional

Whether this item can be rated

ratingstringOptional

Rating value given to the object. This can be a single value or can also contain an inequality operator like gt, gte, lt, lte. This can also contain an inequality expression containing logical operators like && and ||.

matchedbooleanOptional

Whether this item is an exact match of the request

relatedbooleanOptional

Whether this item is a related item to the exactly matched item

recommendedbooleanOptional

Whether this item is a recommended item to a response

ttlstringOptional

Time to live in seconds for an instance of this schema

Responses
post
/inventory/item/block
default

Successful fetch of resources from the catalog

post

Unblock addOn in inventory

Body

Describes a product or a service offered to the end consumer by the provider. In the mobility sector, it can represent a fare product like one way journey. In the logistics sector, it can represent the delivery service offering. In the retail domain it can represent a product like a grocery item.

idstringOptional

ID of the item.

parent_item_idstringOptional

ID of the item.

category_idsstringOptional

ID of the category

fulfillment_idsstringOptional

Unique reference ID to the fulfillment of an order

location_idsstringOptional
payment_idsstringOptional

ID of the payment term that can be referred at an item or an order level in a catalog

rateablebooleanOptional

Whether this item can be rated

ratingstringOptional

Rating value given to the object. This can be a single value or can also contain an inequality operator like gt, gte, lt, lte. This can also contain an inequality expression containing logical operators like && and ||.

matchedbooleanOptional

Whether this item is an exact match of the request

relatedbooleanOptional

Whether this item is a related item to the exactly matched item

recommendedbooleanOptional

Whether this item is a recommended item to a response

ttlstringOptional

Time to live in seconds for an instance of this schema

Responses
post
/inventory/addOn/unblock
default

Successful fetch of resources from the catalog

post

Block add-on in inventory

Body

Describes a product or a service offered to the end consumer by the provider. In the mobility sector, it can represent a fare product like one way journey. In the logistics sector, it can represent the delivery service offering. In the retail domain it can represent a product like a grocery item.

idstringOptional

ID of the item.

parent_item_idstringOptional

ID of the item.

category_idsstringOptional

ID of the category

fulfillment_idsstringOptional

Unique reference ID to the fulfillment of an order

location_idsstringOptional
payment_idsstringOptional

ID of the payment term that can be referred at an item or an order level in a catalog

rateablebooleanOptional

Whether this item can be rated

ratingstringOptional

Rating value given to the object. This can be a single value or can also contain an inequality operator like gt, gte, lt, lte. This can also contain an inequality expression containing logical operators like && and ||.

matchedbooleanOptional

Whether this item is an exact match of the request

relatedbooleanOptional

Whether this item is a related item to the exactly matched item

recommendedbooleanOptional

Whether this item is a recommended item to a response

ttlstringOptional

Time to live in seconds for an instance of this schema

Responses
post
/inventory/addOn/block
default

Successful fetch of resources from the catalog

post

Add Item to inventory

Body

Describes a product or a service offered to the end consumer by the provider. In the mobility sector, it can represent a fare product like one way journey. In the logistics sector, it can represent the delivery service offering. In the retail domain it can represent a product like a grocery item.

idstringOptional

ID of the item.

parent_item_idstringOptional

ID of the item.

category_idsstringOptional

ID of the category

fulfillment_idsstringOptional

Unique reference ID to the fulfillment of an order

location_idsstringOptional
payment_idsstringOptional

ID of the payment term that can be referred at an item or an order level in a catalog

rateablebooleanOptional

Whether this item can be rated

ratingstringOptional

Rating value given to the object. This can be a single value or can also contain an inequality operator like gt, gte, lt, lte. This can also contain an inequality expression containing logical operators like && and ||.

matchedbooleanOptional

Whether this item is an exact match of the request

relatedbooleanOptional

Whether this item is a related item to the exactly matched item

recommendedbooleanOptional

Whether this item is a recommended item to a response

ttlstringOptional

Time to live in seconds for an instance of this schema

Responses
post
/inventory/item/unblock
default

Successful fetch of resources from the catalog

Last updated

Was this helpful?