Product Group

Product Group is a category of SKUs that belong to like Electronics, Apparels, etc.

Fetch Product Groups

GET /wms/sku/product-group

This api returns all or a set of Product Groups configured depending on the filter criteria passed or not. Note when more than one below parameters are sent the result will be filtered matching all the parameters and not any one. so filter should be applied accordingly or else result would be empty if all conditions are not met.

Query Parameters

Name	Type	Description
name	String	Partial or full text matching the name of the Product Group like 'Travel & Leisure'
description	String	Partial or full text matching the description of the Product Group.
id	String	Blowhorn assigned/supplied integer unique id for the Product Group like 12345

Headers

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

200: OK Response for no search criteria or matching criteria

{
    "count": 1,
    "previous": null,
    "next": 0,
    "result": [
        {
            "id": 9,
            "created_date": "2021-07-30T17:39:32.787735+05:30",
            "modified_date": "2021-07-30T17:39:32.787755+05:30",
            "name": "Instants",
            "description": "Ready to cook products",
            "created_by": null,
            "modified_by": null,
            "customer": 40082
        }
    ]
}

401: Unauthorized Unauthorized/Validation Error

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

200: OK No Product Group found for the search criteria

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

500: Internal Server Error Unexpected Error

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

Create Product Groups

POST /wms/sku/product-group

This API is for creating new Product Groups.

Headers

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

Request Body

Name	Type	Description
name*	String	Unique text identifier of the Product Group for the client
description	String	Product Group description
id	String	An identifier will be randomly generated by Blowhorn. You can optionally override this ID, but the ID must be unique across all products groups in your account.

200: OK Successful creation of Product Group

{
    "status": "PASS",
    "message": {
        "id": 297
    }
}

400: Bad Request Bad Request/Validation Error

{
    "status": "FAIL",
    "message": "Product Group already exists"
}

401: Unauthorized Unauthorized/Wrong API key

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

500: Internal Server Error Unexpected Error

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

400: Bad Request Missing required parameters

{
    "status": "FAIL",
    "message": "Missing required parameters."
}

Update Product Groups

PUT /wms/sku/product-group

This API is for updating an existing Product Group. Any or all of the below mentioned attribute of the Product Group can be updated using this API.

Headers

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

Request Body

Name	Type	Description
id	String	Unique identifier either generated by Blowhorn or provided at the time of Product Group creation. Note: This is conditionally optional. Either id or name should be provided for identifying the Product Group that needs to be updated.
name	String	Unique text identifier of the Product Group for the client. Note: This is conditionally optional. Either id or name should be provided for identifying the Product Group that needs to be updated.
description	String	Product Group description

200: OK Successful updation of Product Group

{
    "status": "PASS",
    "message": "Product Group Updated successfully."
}

400: Bad Request Bad Request/Validation Error

{
    "status": "FAIL",
    "message": "Product Group does not exists"
}

401: Unauthorized Unauthorized/Wrong API key

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

500: Internal Server Error Unexpected error

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

400: Bad Request Missing required parameters

{
    "status": "FAIL",
    "message": "Missing required parameters."
}

Sample Create Product Group | Schema

{
    "id": 291,
    "name": "Travel & Leisure",
    "description": "This is travel & leisure related group of products."
}