Simplify Workflows using a Chaining API

We’ve introduced a new workflow chaining API that simplifies multi-step warehouse operations. Traditionally, users needed to manually sequence several API requests or wait for batch jobs to finish, making processes like receiving and putaway time-consuming. With the new Chaining API, you can now automate these workflows—initiating multiple API actions as a seamless, single request.

You can automate multi-step tasks by combining multiple API calls into one request, eliminating manual intervention after each step. You can assign outputs from one step to variables for use in subsequent steps.

EXAMPLE USE CASE:

A receiving and putaway operation can be triggered as a single API call. The Chaining API will automatically handle the sequence—such as creating a pallet, generating an outbound LPN, retrieving its ID, and shipping it—passing required information from each step to the next.

HOW THE CHAINING API WORKS

Submit your workflow steps in a call list, specifying the HTTP verb, endpoint URL, content type, and request body for each. Use variables to capture outputs and feed them into subsequent actions. When referencing variables in API requests, use the $ syntax (e.g., /entity/oblpn/${lpn_id[0]['id']}/ship). If your data contains a $ character, escape it with $$.

NOTE: Chaining APIs execute the logic for each API internally one after another. While the communication overhead for each call gets reduced since this is just one API call, the overall time taken will roughly be the same. We do not recommend passing “too many” API calls in one chain. What is “too many” will depend on the use case and the customer’s acceptance of the time it takes for that chain. Customers need to determine the right limit for the use case while keeping in mind that having too many calls will slow down the chaining API.

ENDPOINT

.../lgfapi/v10/chaining/chaining/

SAMPLE PAYLOAD

{

    "call_list": [

        {

            "assignment_target": "",

            "verb": "POST",

            "url": "/wms/api/create_lpn/",

            "content_type": "application/x-www-form-urlencoded",

            "body": "lpn_nbr=LPN123&qty=5&facility_code=DC01&item_barcode=ITM101&company_code=C01&xdock_lpn_flg=False"

        },

        {

            "assignment_target": "",

            "verb": "POST",

            "url": "/wms/lgfapi/v10/entity/oblpn/create_from_iblpn/",

            "content_type": "application/json",

            "body": "{     \"fields\": {     \"oblpn\": {     \"facility_id\": 1,             \"company_id\": 1,             \"container_nbr\": \"OBLPN123\",     \"parameters\": {         \"allocations\": [             {                 \"order_nbr\": \"ORDER123\",                 \"order_dtl\": {                     \"seq_nbr\": 1                     },                 \"iblpn_nbr\": \"LPN123\",                 \"qty\": 5            }             ]     },     \"options\":     {         \"pack_flg\": true    } }"

        },

        {

            "assignment_target": "lpn_id",

            "verb": "GET",

            "url": "/wms/lgfapi/v10/entity/oblpn/?container_nbr=OBLPN123&values_list=id",

            "content_type": "application/json"

        },

        {

            "assignment_target": "",

            "verb": "POST",

            "url": "/wms/lgfapi/v10/entity/oblpn/${lpn_id[0]['id']}/ship",

            "content_type": "application/json",

            "body": "{     \"fields\": {       },     \"parameters\": {},     \"options\":     {\"locn_barcode\": \"LOC1135894\" } }"

        }

    ]

}

Steps to Enable and Configure

Review the REST service definition in the REST API guides to leverage (available from the Oracle Help Center > your apps service area of interest > APIs & Schema). If you are new to Oracle's REST services you may want to begin with the Quick Start section.