Get Inventory Search Result

Get Inventory Search Result

Get product inventory information based on search criteria.

Request
URI
POST
https://{api_host}/inventory/search-results
COPY
Header Parameters
string
sessionid
Required

The authentication token obtained from login API response

Request Body

Search criteria

SearchInventoryRequest of type(s) application/json
Required 
{
    "productId": 0,
    "productType": "string",
    "criteria": {
        "targetType": "string",
        "ruleName": "string"
    }
}
Product_ID
productId
Optional

productId

ProductType_CMR
productType
Optional

productType

object
criteria
Optional

criteria

Responses
200

OK

Returns Array of object of type(s) application/json 
[
    {
        "productType": "string",
        "productId": 0,
        "ruleName": "string",
        "targetName": "string",
        "targetId": "string",
        "targetType": "string",
        "deleted": false
    }
]

204

OK - no content

Operation doesn't return any data structure

401
Returns 401Unauthorized_sessionID of type(s) application/json 
{
    "errCode": "GW_LOGIN_REQUIRED",
    "errMessage": "Your session not found or already expired. Please login"
}
string
errCode
Optional

errCode

string
errMessage
Optional

errMessage


On This Page
Customer Rules Operations
DELETE
Delete Rule
DELETE
Delete Rules
POST
Get Inventory Search Result
GET
Get Rule
GET
Get Rules
GET
Get Rules Audit
PATCH
Patch Rule
PATCH
Patch Rules
POST
Post Rules