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

Idle api

POST

/optimizer/{tenantId}/v1/order/idle

API enables optimization of orders asynchronously. API takes input and sends it to internal queue for asynchronous processing. Optimization happens after a latency period, which makes sure latest message for an orderNo is used for optimization.

Request URL
https://api.watsoncommerce.ibm.com/optimizer/{tenantId}/v1/order/idle
Parameters
Name
Description
  • tenantId
    REQUIRED
    string
    (path)

    The tenant ID provided by IBM.

  • authorization
    REQUIRED
    string
    (header)

    Usage, authorization: Bearer access_token

  • Content-type
    string
    (header)
    application/json
  • Accept
    string
    (header)
    application/json; charset=UTF-8
  • Request body
    Responses
    • 200

      successful operation

    • 400

      OTMZException is thrown

    • 401

      Unauthorized requests

    • 500

      Internal server error. Retry later.

    Code snippet
      1curl --request POST \
      2  --url https://api.watsoncommerce.ibm.com/optimizer/REPLACE_TENANTID/v1/order/idle \
      3  --header 'accept: application/json; charset=UTF-8' \
      4  --header 'authorization: REPLACE_THIS_VALUE' \
      5  --header 'content-type: application/json' \
      6  --data REPLACE_REQUEST_BODY
      

        Example response

          1{
          2  "id": 2881331818135552
          3}