IBM API Hub
IBM Sterling Intelligent Promising APIs

By IBM Sterling Intelligent Promising

IBM Sterling Intelligent Promising is a stand-alone cloud service solution that provides reliable inventory promises at every stage of a shopper's order lifecycle.


API reference

Get Network Availability by date V2

POST

/{tenantId}/v2/availability/network

The current and future availability picture for an item with date breakup. For more information refer to IBM Documentation: Availability by date.

Provides the current and future availability picture, including non-expired reservations, at the network level. Responds with availability based on the configured distribution groups only for SELL availability type. This is a synchronous API call.

Request URL
https://api.watsoncommerce.ibm.com/inventory/{tenantId}/v2/availability/network
Security
apiKey
Authorization
required in header
Parameters
Name
Description
  • tenantId
    REQUIRED
    string
    (path)

    The tenant ID provided by IBM to access your APIs.

  • Content-type
    string
    (header)
    application/json
  • Accept
    string
    (header)
    application/json
  • Request body
    Responses
    • 200

      OK. The response for SELL availability type will be cached for minimum of the toTs for currentAvailability and 1 minute.

    • 400

      Invalid message format, badly formed message, or unknown settings

    • 401

      Access was not authorized given the credentials.

    • 403

      Access was not authorized given the provided access token.

    Code snippet
      1curl --request POST \
      2  --url https://api.watsoncommerce.ibm.com/inventory/REPLACE_TENANTID/v2/availability/network \
      3  --header 'Authorization: REPLACE_THIS_VALUE' \
      4  --header 'accept: application/json' \
      5  --header 'content-type: application/json' \
      6  --data REPLACE_REQUEST_BODY
      

        Example response

          1{
          2  "segment": "ONLINE",
          3  "segmentType": "Channel",
          4  "considerSafetyStock": false,
          5  "considerFulfillmentOptions": false,
          6  "lines": [
          7    {
          8      "lineId": "1",
          9      "itemId": "SKU1024",
          10      "unitOfMeasure": "EACH",
          11      "productClass": "NEW",
          12      "deliveryMethod": "SHP",
          13      "segment": "ONLINE",
          14      "segmentType": "Channel",
          15      "networkAvailabilities": [
          16        {
          17          "distributionGroupId": "US_Group",
          18          "onhandAvailableQuantity": 1,
          19          "futureAvailableQuantity": 3,
          20          "futureEarliestShipTs": "2020-02-07T05:00:00Z",
          21          "futureLatestShipTs": "2020-02-07T05:00:00Z",
          22          "currentAvailability": {
          23            "availableQuantity": 2,
          24            "segmentedQuantity": 1,
          25            "shortageQuantity": 0,
          26            "thresholdLevel": 3,
          27            "thresholdType": "ONHAND",
          28            "thresholdQuantity": 5.5,
          29            "toTs": "2020-02-07T05:00:00Z",
          30            "unsegmentedQuantity": 1
          31          },
          32          "futureAvailability": [
          33            {
          34              "availableQuantity": 3,
          35              "fromTs": "2020-02-07T05:00:00Z",
          36              "segmentedQuantity": 1,
          37              "shortageQuantity": 0,
          38              "toTs": "2020-02-14T05:00:00Z",
          39              "unsegmentedQuantity": 2
          40            }
          41          ]
          42        }
          43      ],
          44      "itemAttributes": {
          45        "color": [
          46          "red"
          47        ]
          48      }
          49    }
          50  ]
          51}