Stock Quantity API

A customer can send a request to Steadfast to get stock quantity.

5.1 Stock Quantity

The stock quantity endpoint is given below.

Stock Quantity API

POST https://middleware.podapp.com.au/passthrough/customerstockquantity

Headers

Name	Type	Description
X-Steadfast-Api-Key	string	API Key Name that must be passed in request headers

Request Body

Name	Type	Description
request body	json	Please see below.

200 data successfully retrieved.

Sucess Response

{
    "Message": "Ok",
    "ResponseMessage": {
        "Success": true,
        "TokenChanged": false,
        "ErrorMessage": "",
        "NewToken": "00000000000000000000000000000000"
    },
    "TotalQueryRows": 0
}

401

Error Response 1

{
    "StatusCode": 401,
    "Message": "Authentication failed. Invalid Api Key."
}

Error Response 2

{
    "StatusCode": 401,
    "Message": "No Api Key is provided. Api Key is missing in request headers."
}

404 If the request URL is wrong like /passthrough/gerardorder1

Error Response 1

{
    "StatusCode": 404,
    "Message": "Endpoint gerardorder Not Found. Api in Not Active."
}

Error Response 2

{
    "StatusCode": 404,
    "Message": "Endpoint gerardorder1 Not Found. No Api is configured at gerardorder1."
}

500 In case of any other server error

Error Response 1

{
    "StatusCode": 500,
    "Message": "There is error while calling Outbound API."
}

By default, if the list of products is not provided, it sends all product stock quantities that are available in the system.

Example Request 1

Steadfast will send data of stock of all products as given below.

Example Response 1

{
    "Success": true,
    "ErrorMessage": "",
    "StocksQuantity": [
        {
            "ProductCode": "4X4POS16",
            "Quantity": 1
        },
        {
            "ProductCode": "4X4POS16EMPTY",
            "Quantity": 2
        },
        {
            "ProductCode": "ALPAP151G",
            "Quantity": 1
        },
        {
            "ProductCode": "ZZMAERCHE",
            "Quantity": 2
        }, 
        {
            "ProductCode": "ALSW2G",
            "Quantity": 147
        },
        {
            "ProductCode": "ALSWPV1G",
            "Quantity": 98
        },
    ]
}

5.2 Stock Quantity with Product Codes

A list of product codes can be passed to the stock API.

Example Request 1

{
    "ProductCodes": [
        "ZZMERCHE",
        "4X4POS16EMPTY"
    ]
}

Steadfast will send data of stock of all products as given below.

Example Response 1

{
    "Success": true,
    "ErrorMessage": "",
    "StocksQuantity": [
        {
            "ProductCode": "ZZMERCHE",
            "Quantity": 1
        },
        {
            "ProductCode": "4X4POS16EMPTY",
            "Quantity": 2
        }
    ]
}