Clients

Client is the inventory owner for all the stock in the warehouse

Fetch details of Client

GET /wms/client

Use this API to get the details of the Client(s). Below mentioned filters can be used to filter to get a single or set of client objects. If multi filters are used then all will be used for matching the result.

Query Parameters

Name	Type	Description
id	String	Client id returned by the Blowhorn at the time of client creation.
description	String	Full or partial description text of the client
name	String	Full or partial name of the client.

Headers

Name	Type	Description
API_KEY*	string	API key obtained by the Customer/Partner

200 Successful result with or without filter

{
    "count": 1,
    "previous": null,
    "next": 0,
    "result": [
        {
            "id": 4,
            "created_date": "2021-07-30T17:37:55.864539+05:30",
            "modified_date": "2021-07-30T17:37:55.865651+05:30",
            "name": "Default Client",
            "description": "Default Client",
            "created_by": 108434,
            "modified_by": 108434,
            "customer": 40082
        }
    ]
}

401 Unauthorized / Wrong api key

{
  "status": "FAIL",
  "message": "Unauthorized"
}

500 Unexpected error

{
  "status": "FAIL",
  "message": "Unexpected error"
}

200: OK When no client matches the filter criteria

{
    "count": 0,
    "previous": null,
    "next": 0,
    "result": []
}

Create a Client

POST /wms/client

Use this API to create client on the blowhorn systems.

Headers

Name	Type	Description
API_KEY*	String	API key obtained by the Customer/Partner

Request Body

Name	Type	Description
name*	String	Name of the client
description	String	Description of the client

400: Bad Request Validation Error

{
    "status": "FAIL",
    "message": "Client name should be unique."
}

200: OK Successful Creation

{
    "status": "PASS",
    "message": {
        "id": 221,
        "name": "Client account default",
        "description": "Deault client account for abc corp."
    }
}

401: Unauthorized Unauthorized/Wrong API key

{
  "status": "FAIL",
  "message": "Unauthorized"
}

500: Internal Server Error Unexpected Error

{
  "status": "FAIL",
  "message": "Unexpected error"
}

Example Schema 01

{
    "name": "Default Client for ABC Corp 01",
    "description": "Default Client for ABC Corp 01"
}

Example Schema 02

{
    "name": "Default Client for ABC Corp 01"
}