Get Facility Details

This REST API is used to fetch Facility/Warehouse details from Uniware based on Facility code used.

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/get
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

{
      "facilityCode":"XYZ"
}

Request Payload Details

PARAMETER	TYPE	DESCRIPTION	MANDATORY	NOTES
facilityCode	string	Facility code of seller’s uniware account	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"
      }
   ],
       "facility": {
        "type": "WAREHOUSE",
        "displayName": "varad",
        "operationalType": "WAREHOUSE",
        "name": "Varad Enterprises",
        "code": "varad",
        "alternateCode": "WONDERSOFT_TEST1",
        "pan": "",
        "tin": "",
        "cstNumber": "",
        "cinNumber": null,
        "gstNumber": "",
        "enabled": true,
        "taxExempted": false,
        "website": "",
        "billingAddress": {
            "addressLine1": "test_billing",
            "addressLine2": "Test Address",
            "city": "pune",
            "pincode": "999002",
            "countryName": "India",
            "phone": "9999999999",
            "stateCode": "DL",
            "stateName": "Delhi",
            "countryCode": "IN",
            "enabled": true,
            "email": null
        },
        "shippingAddress": {
            "addressLine1": "test_billing",
            "addressLine2": "Test Address",
            "city": "pune",
            "pincode": "999002",
            "countryName": "India",
            "phone": "9999999999",
            "stateCode": "DL",
            "stateName": "Delhi",
            "countryCode": "IN",
            "enabled": true,
            "email": null
        },
        "associatedBillingParty": null
    }
}

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	facility	list	facility details	-

Error Codes

Refer Response Codes section to know about specific errors codes.