IBM Inventory Visibility APIs

Live

IBM Inventory Visibility APIs

+ Day(s) remaining in the trial

Overview

The IBM Inventory Visibility is a completely cloud-based SaaS offering that presents an accurate, real-time availability picture in the cloud across all channels. The IBM Inventory Visibility also integrates into any existing commerce solution to instantly improve the enterprise inventory picture. Intended Audience IBMers, Business Partners, and IBM clients via seller. Prerequisites Review the IBM Inventory Visibility documentation in the IBM Knowledge Center at https://www.ibm.com/support/knowledgecenter/SSSMTK/landing/welcome.html.

Security

Keys

Pick a key to use with this API. Make sure you are logged in with your IBM id for your keys to be populated in the dropdown below. By selecting a key, it will be pre-filled for each endpoint in the Documentation section that can be used with the built-in testing. If you want to change which key to use for a particular endpoint, you can do so at the endpoint in the Documentation section.
You can manage your API keys in the <MyAPIs> section. API keys authenticate you to your subscription, so make sure to keep them secret. Do not share the X-IBM-Client-Secret portion of any API key in publicly accessible places such as GitHub, or client-side code.



Manage your keys
 

Documentation

IBM Inventory Visibility APIs:

Availability

Get Network Availability
Provides the current availability picture, including non-expired reservations, at the network level. Responds with availability based on the configured distribution groups.

POST   /{tenantId}/v1/availability/network

			https://api.watsoncommerce.ibm.com/inventory/{tenantId}/v1/availability/network
		
Keys
Header parameters

Transaction-Id

STRING , optional

Will prevent repeat processing of future requests providing the same transaction ID.

Path and Query parameters

tenantId

URL , required

The tenant ID provided by IBM to access your APIs.

Request code
								
HttpResponse<String> response = Unirest.post("https://api.watsoncommerce.ibm.com/inventory/{tenantId}/v1/availability/network") .body("{\"distributionGroupId\":\"US_Group\",\"lines\":[{\"deliveryMethod\":\"SHP\",\"distributionGroupId\":\"US_Group\",\"itemId\":\"SKU1024\",\"lineId\":\"1\",\"productClass\":\"NEW\",\"unitOfMeasure\":\"EACH\"}],\"segment\":\"ONLINE\",\"segmentType\":\"MTO\"}") .asString();
Request model

distributionGroupId

STRING , required

The distribution group to check for availability.

lines

ARRAY , required

The lines for which to get availability.

segment

STRING , optional

Segment for the inventory item.

segmentType

STRING , optional

Segment type for the inventory item.

deliveryMethod

STRING , required

Indicates the delivery method specified for an item. For example, SHP or PICK

distributionGroupId

STRING , optional

The distribution group to check for availability. Overrides the one specified on the header.

itemId

STRING , required

The unique identifier of an item.

lineId

STRING , required

A unique identifier for the line. This should be unique across all input lines.

productClass

STRING , optional

The product class of an item. For example, NEW, USED, or OPEN_BOX.

unitOfMeasure

STRING , optional

The unit of measure of an item. For example, EACH or CASE.

Request example
{
  "distributionGroupId": "US_Group",
  "lines": [{
    "deliveryMethod": "SHP",
    "distributionGroupId": "US_Group",
    "itemId": "SKU1024",
    "lineId": "1",
    "productClass": "NEW",
    "unitOfMeasure": "EACH"
  }],
  "segment": "ONLINE",
  "segmentType": "MTO"
}
Response model

200

OK

Body

lines [GetNetworkAvailabilityResponseLine]

ARRAY , optional

The lines for which availability is returned.

lineId

STRING , optional

The unique identifier for the line

networkAvailabilities [GetNetworkAvailabilityResponseNetworkAvailabilities]

ARRAY , optional

The current inventory availability picture at a network level.

alertLevel

STRING , optional

*Deprecated* Refer to thresholdLevel. The threshold level that is met for availability. 3 represents low, 2 for medium, 1 for high, and 0 for greater thresholds.

alertQuantity

DOUBLE , optional

*Deprecated* Refer to thresholdQuantity. Indicates the available inventory quantity based on the threshold. This excludes active reservations.

distributionGroupId

STRING , optional

The unique identifier of the distribution group.

earliestShipTs

STRING , optional

The earliest timestamp when the item can be shipped. Date and time must be in ISO 8601 standard.

futureAvailableQuantity

DOUBLE , optional

The quantity of the item available from future inventory for the distribution group. Active reservations will consume from onhandAvailableQuantity before consuming from futureAvailableQuantity.

futureEarliestShipTs

STRING , optional

The earliest date where future inventory is available to ship. Date and time must be in ISO 8601 standard.

futureLatestShipTs

STRING , optional

The latest date where future inventory is available to ship. Date and time must be in ISO 8601 standard.

onhandAvailableQuantity

DOUBLE , optional

The quantity of the item available onhand for the distribution group. Active reservations will consume from onhandAvailableQuantity before consuming from futureAvailableQuantity. Date and time must be in ISO 8601 standard.

onhandEarliestShipTs

STRING , optional

The earliest date where onhand inventory is available to ship. Date and time must be in ISO 8601 standard.

onhandLatestShipTs

STRING , optional

The latest date where onhand inventory is available to ship. Date and time must be in ISO 8601 standard.

thresholdLevel

STRING , optional

The threshold level that is met for availability. * low = Below Low * med = Below Medium * high = Below High * infinite = Above High

thresholdQuantity

DOUBLE , optional

*Deprecated* Indicates the available inventory quantity based on the threshold. This excludes active reservations.

thresholdType

STRING , optional

The threshold type

totalAvailableQuantity

DOUBLE , optional

The total quantity of the item available for the distribution group. This availability snapshot includes active reservations.

401

Access was not authorized given the credentials.

Body

error

STRING , optional

The code that represents this error.

error_description

STRING , optional

A short description of the error.

403

Access was not authorized given the provided access token.

Body

error

STRING , optional

The code that represents this error.

error_description

STRING , optional

A short description of the error.

Response example

200

OK

								{
  "lines" : [{
    "lineId" : "1",
    "networkAvailabilities" : [{
    "alertLevel" : "3",
    "alertQuantity" : 5.5,
    "distributionGroupId" : "US_Group",
    "earliestShipTs" : "2016-11-01T17:42:32Z",
    "futureAvailableQuantity" : 14.4,
    "futureEarliestShipTs" : "2016-11-10T00:00:00Z",
    "futureLatestShipTs" : "2016-11-20T00:00:00Z",
    "onhandAvailableQuantity" : 1.0,
    "onhandEarliestShipTs" : "2016-11-01T17:42:32Z",
    "onhandLatestShipTs" : "2016-11-01T17:42:32Z",
    "thresholdLevel" : "med",
    "thresholdQuantity" : 5.5,
    "thresholdType" : "ONHAND",
    "totalAvailableQuantity" : 15.4
  }]
  }]
}
							

401

Access was not authorized given the credentials.

								{
  "error" : "invalid_token",
  "error_description" : "The access token is invalid or has expired"
}
							

403

Access was not authorized given the provided access token.

								{
  "error" : "No token provided or token is invalid.",
  "error_description" : "You cannot consume this service"
}
							
Get Node Availability
Provides the current availability picture, including non-expired reservations, at the node level. Responds with availability based on the requested nodes.

POST   /{tenantId}/v1/availability/node

			https://api.watsoncommerce.ibm.com/inventory/{tenantId}/v1/availability/node
		
Keys
Header parameters

Transaction-Id

STRING , optional

Will prevent repeat processing of future requests providing the same transaction ID.

Path and Query parameters

tenantId

URL , required

The tenant ID provided by IBM to access your APIs.

Request code
								
HttpResponse<String> response = Unirest.post("https://api.watsoncommerce.ibm.com/inventory/{tenantId}/v1/availability/node") .body("{\"lines\":[{\"deliveryMethod\":\"SHP\",\"itemId\":\"SKU1024\",\"lineId\":\"1\",\"productClass\":\"NEW\",\"shipNodes\":{\"description\":\"The nodes for which to get availability\",\"example\":[\"Matrix-Store-001\"],\"items\":{\"type\":\"string\"},\"type\":\"array\"},\"unitOfMeasure\":\"EACH\"}],\"segment\":\"ONLINE\",\"segmentType\":\"MTO\"}") .asString();
Request model

lines

ARRAY , required

The lines for which to get availability

segment

STRING , optional

Segment for the inventory item.

segmentType

STRING , optional

Segment type for the inventory item.

deliveryMethod

STRING , required

Indicates the delivery method specified for an item. For example, SHP or PICK

itemId

STRING , required

The unique identifier of an item.

lineId

STRING , required

A unique identifier for the line. This should be unique across all input lines.

productClass

STRING , optional

The product class of an item. For example, NEW, USED, or OPEN_BOX.

shipNodes

ARRAY , required

The nodes for which to get availability

unitOfMeasure

STRING , optional

The unit of measure of an item. For example, EACH or CASE.

Request example
{
  "lines": [{
    "deliveryMethod": "SHP",
    "itemId": "SKU1024",
    "lineId": "1",
    "productClass": "NEW",
    "shipNodes": [],
    "unitOfMeasure": "EACH"
  }],
  "segment": "ONLINE",
  "segmentType": "MTO"
}
Response model

200

OK

Body

lines [GetNodeAvailabilityResponseLine]

ARRAY , optional

The lines for which availability is returned

lineId

STRING , optional

The unique identifier for the line.

shipNodeAvailability [GetNodeAvailabilityResponseShipNodeAvailability]

ARRAY , optional

earliestShipTs

STRING , optional

The earliest timestamp when the item can be shipped. Date and time must be in ISO 8601 standard.

futureAvailableQuantity

DOUBLE , optional

The quantity of the item available from future inventory for the distribution group. Active reservations will consume from onhandAvailableQuantity before consuming from futureAvailableQuantity.

futureEarliestShipTs

STRING , optional

The earliest date where future inventory is available to ship. Date and time must be in ISO 8601 standard.

futureLatestShipTs

STRING , optional

The latest date where future inventory is available to ship. Date and time must be in ISO 8601 standard.

futureSafetyQuantity

DOUBLE , optional

The future available quantity withheld during availability calculation.

latestShipTs

STRING , optional

The latest timestamp when the item can be shipped. Date and time must be in ISO 8601 standard.

onhandAvailableQuantity

DOUBLE , optional

The quantity of the item available onhand for the distribution group. Active reservations will consume from onhandAvailableQuantity before consuming from futureAvailableQuantity.

onhandEarliestShipTs

STRING , optional

The earliest date where onhand inventory is available to ship. Date and time must be in ISO 8601 standard.

onhandLatestShipTs

STRING , optional

The latest date where onhand inventory is available to ship. Date and time must be in ISO 8601 standard.

onhandSafetyQuantity

DOUBLE , optional

The onhand available quantity withheld during availability calculation.

shipNode

STRING , optional

The node or location from where items are shipped.

thresholdLevel

STRING , optional

The threshold level that is met for availability. * low = Below Low * med = Below Medium * high = Below High * infinite = Above High

thresholdType

STRING , optional

The threshold type

totalAvailableQuantity

DOUBLE , optional

The total quantity of the item that is available for ship node. This availability includes active reservations.

401

Access was not authorized given the credentials.

Body

error

STRING , optional

The code that represents this error.

error_description

STRING , optional

A short description of the error.

403

Access was not authorized given the provided access token.

Body

error

STRING , optional

The code that represents this error.

error_description

STRING , optional

A short description of the error.

Response example

200

OK

								{
  "lines" : [{
    "lineId" : "1",
    "shipNodeAvailability" : [{
    "earliestShipTs" : "2016-11-01T17:42:32Z",
    "futureAvailableQuantity" : 14.4,
    "futureEarliestShipTs" : "2016-11-10T00:00:00Z",
    "futureLatestShipTs" : "2016-11-20T00:00:00Z",
    "futureSafetyQuantity" : 5.0,
    "latestShipTs" : "2016-11-20T00:00:00Z",
    "onhandAvailableQuantity" : 1.0,
    "onhandEarliestShipTs" : "2016-11-01T17:42:32Z",
    "onhandLatestShipTs" : "2016-11-01T17:42:32Z",
    "onhandSafetyQuantity" : 5.0,
    "shipNode" : "Matrix-Store-001",
    "thresholdLevel" : "med",
    "thresholdType" : "ONHAND",
    "totalAvailableQuantity" : 15.4
  }]
  }]
}
							

401

Access was not authorized given the credentials.

								{
  "error" : "invalid_token",
  "error_description" : "The access token is invalid or has expired"
}
							

403

Access was not authorized given the provided access token.

								{
  "error" : "No token provided or token is invalid.",
  "error_description" : "You cannot consume this service"
}
							

Loading content...

Resources