Pack Config

Pack configuration define how the SKU is packaged, how the unit of metrics are for the SKU and linked with the tracking level of the SKU

Fetch Package Config

GET /wms/sku/pack-config

This api returns all or a set of Package Config 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 Package Config like 'Box of 25'
id	String	Blowhorn assigned/supplied integer unique id for the Package Config 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": 61,
            "tracking_level_dict": {
                "name": "Each",
                "level_one_name": "Each",
                "level_two_name": "Box of 25",
                "level_three_name": "Pallet for 25",
                "ratio_level_two_one": 25,
                "ratio_level_three_two": 1
            },
            "created_date": "2022-04-29T14:09:33.047659+05:30",
            "modified_date": "2022-04-29T14:09:33.049242+05:30",
            "name": "Box of 200",
            "each_volume": 100,
            "each_weight": 750,
            "tag_volume": 1,
            "use_each_volume": true,
            "use_tag_volume": false,
            "uom": "cc",
            "created_by": 108434,
            "modified_by": null,
            "tracking_level": 4,
            "each_dimension": 3548619,
            "customer": 40082,
            "color": null
        }
    ]
}

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 Package Config

POST /wms/sku/pack-config

This API is for creating new Package Configs.

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 Package Configs for the client
tracking_level	Integer	Tracking Level unique id to used for this package config. Note: Either tracking_level or tracking_level_name should be provided even both of them marked as optional.
id	Integer	An identifier will be randomly generated by Blowhorn. You can optionally override this ID, but the ID must be unique across all Package Configs in your account.
tracking_level_name	String	Tracking Level unique name to used for this package config. Note: Either tracking_level or tracking_level_name should be provided even both of them marked as optional. This field is case-sensitive.
each_volume	Integer	Package volume ?
each_weight	Integer	Package weight ?
tag_volume	Integer	Tag Volume ?
use_each_volume	Boolean	Flag to indicate to use 'each_volume' attribute of the package
use_tag_volume	Boolean	Flag to indicate to use 'tag_volume' attribute of the package
uom	String	Unit of weight or volume of the package. Ex: KG
each_dimension	String	This is the dimension of the package in the format of '<Length>x<breadth>x<height> uom' ex: '10x10x10 cc'
color	String	Color of the package.

200: OK Successful creation of Package Config

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

400: Bad Request Bad Request/Validation Error

{
    "status": "FAIL",
    "message": "Package Config 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 Package Config

PUT /wms/sku/pack-config

This API is for updating an existing Package Config. Any or all of the below mentioned attribute of the Package Config 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 Package Config creation. Note: This is conditionally optional. Either id or name should be provided for identifying the Package Config that needs to be updated.
name	String	Unique text identifier of the Package Config for the client. Note: This is conditionally optional. Either id or name should be provided for identifying the Package Config that needs to be updated.
tracking_level	Integer	Tracking Level unique id to used for this package config. Note: Either tracking_level or tracking_level_name should be provided even both of them marked as optional.
tracking_level_name	String	Tracking Level unique name to used for this package config. Note: Either tracking_level or tracking_level_name should be provided even both of them marked as optional. This field is case-sensitive.
each_volume	Integer	Package volume
each_weight	String	Package weight
uom	Integer	Unit of weight or volume of the package. Ex: KG
use_each_volume	Boolean	Flag to indicate to use 'each_volume' attribute of the package
use_tag_volume	Boolean	Flag to indicate to use 'tag_volume' attribute of the package
tag_volume	Integer	Tag Volume
each_dimension	String	This is the dimension of the package in the format of '<Length>x<breadth>x<height> uom' ex: '10x10x10 cc'
color	String	Color of the package

200: OK Successful updation of Package Config

{
    "status": "PASS",
    "message": "Package Config Updated successfully."
}

400: Bad Request Bad Request/Validation Error

{
    "status": "FAIL",
    "message": "Package Config 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 Package Config | Schema

{
    "id": 2001
    "name": "Box of 200",
    "tracking_level": 1,
    "tracking_level_name": "Each",
    "each_volume": 100,
    "tag_volume": 1,
    "each_weight": 750,
    "uom": "KG",
    "use_each_volume": true,
    "use_tag_volume": false,
    "each_dimension": "10x10x10 cc",
    "color": "Grey"
}

Sample Create Package Config | Schema

{
    "id": 2001
    "name": "Box of 200",
    "tracking_level": 1,
    "tracking_level_name": "Each",
    "each_volume": 100,
    "tag_volume": 1,
    "each_weight": 750,
    "uom": "KG",
    "use_each_volume": true,
    "use_tag_volume": false,
    "each_dimension": 3548619,
    "color": "Grey"
}