Search Facility
This REST API is used to search all facilities/warehouses in a tenant’s Uniware account based on the specified search criteria.
Tip
It is recommended to check out Notes for the reader. You might find this helpful as it contains Guidelines for using API references and Terminologies used here.
Basic Information
| NAME | DETAILS |
|---|---|
| Endpoint: | /services/rest/v1/facility/search |
| Request Type: | POST |
| Level: | Tenant |
| Scheme: | HTTPS |
| Header (Content-Type): | application/json |
| Header (Authorization): | bearer {access-token}, Eg.: bearer b30f3aea-7978-49bb-9ea7-33eddfc80afa |
Request Payload
{
"facilityStatus":"ALL",
"fromDate" : "2023-10-19T09:23:48.023Z",
"toDate" : "2024-03-16T09:23:48.023Z",
"dateType" : "UPDATED"
}Request Payload Details
| PARAMETER | TYPE | DESCRIPTION | MANDATORY | NOTES |
|---|---|---|---|---|
| facilityStatus | string | Facility status of seller’s uniware account | Yes | take any one from ALL, ENABLED, DISABLED |
| fromDate | Date | Filter start date | Yes | Eg.:2021-06-01T03:52:13.812Z |
| toDate | Date | Filter end date | Yes | Eg.:2021-06-01T03:52:13.812Z |
| dateType | string | take any one of 2 values CREATED,UPDATED | Yes | - |
Response Payload
{
"successful": true,
"message": "string",
"errors": [
{
"code": 0,
"fieldName": "string",
"description": "string",
"message": "string",
"errorParams": {
"additionalProp1": {
},
"additionalProp2": {
},
"additionalProp3": {
}
}
}
],
"warnings": [
{
"code": 0,
"message": "string",
"description": "string"
}
],
"parties": [
{
"facilityStatus": "ENABLED",
"facilityCode": "TestStore",
"created": 1448525889000,
"updated": 1705643877000
},
{
"facilityStatus": "ENABLED",
"facilityCode": "him1",
"created": 1452853245000,
"updated": 1705054953000
}
]
}Response Payload Details
| LEVEL | PARAMETER | TYPE | DESCRIPTION | NOTES |
|---|---|---|---|---|
| 1 | successful | true | Request success status | - |
| 2 | message | string | Response message | - |
| 3 | errors | list | List of errors (if any) | - |
| 3.1 | code | number | Error code | - |
| 3.2 | fieldName | string | Field with error | - |
| 3.3 | description | string | Error description | - |
| 3.4 | message | string | Error message | - |
| 3.5 | errorParams | object | Parameters with error | - |
| 3.5.1 | additionalProp1 | object | Parameter 1 with error | - |
| 3.5.2 | additionalProp2 | object | Parameter 2 with error | - |
| 3.5.3 | additionalProp3 | object | Parameter 3 with error | - |
| 4 | warnings | list | List of warnings (if any) | - |
| 4.1 | code | number | Warning code | - |
| 4.2 | message | string | Warning message | - |
| 4.3 | description | string | Warning description | - |
| 5 | parties | list | list of facilities code with status | all facilities accessible to the specific user having the access resource named ‘store manager’ |
Error Codes
Refer Response Codes section to know about specific errors codes.