SKU

Stock Keeping Unit or SKU is the product information in the warehouse. Its a template of the product is and how can be linked with location to manifest to an inventory or stock

Fetch SKUs

GET /wms/skus

This api returns all or a set of SKUs 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 name of the SKU like 'Wires'
client_name	String	Client name like 'ABC Corp'
sku_number	String	sku_number like 'SKU-2294XOV'
description	String	Partial or full text matching the description of the SKU.
id	String	Blowhorn assigned/supplied integer unique id for the SKU 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":2,
    "previous":null,
    "next":0,
    "result":[
        {
            "id":111,
            "supplier_name":"Default Supplier",
            "client_name":"Default Client",
            "pack_config_name":"Box of 25",
            "created_date":"2022-03-09T15:44:02.403935+05:30",
            "modified_date":"2022-03-09T15:44:02.411864+05:30",
            "name":"Wires",
            "sku_number":"SKU-227S9TD",
            "ean":null,
            "upc":null,
            "description":null,
            "each_weight":"5.00",
            "each_volume":"200.00",
            "has_expiry":false,
            "shelf_life":null,
            "shelf_life_uom":null,
            "requires_putaway":true,
            "uom":"KG",
            "file":null,
            "mrp":"95.0",
            "discounts":"0.00",
            "discount_type":"fixed",
            "is_kit_sku":false,
            "requires_shipping":true,
            "created_by":null,
            "modified_by":null,
            "product_group":null,
            "pack_config":4,
            "supplier":4,
            "client":4,
            "each_dimension":null,
            "base_price": "100",
            "cost_price": "100",
            "isbn": null,
            "tax_type_code": null
        },
        {
            "id":111099,
            "supplier_name":"Default Supplier",
            "client_name":"Default Client",
            "pack_config_name":"Box of 25",
            "created_date":"2022-03-09T15:44:02.356697+05:30",
            "modified_date":"2022-03-09T15:44:02.367905+05:30",
            "name":"Wall Fit",
            "sku_number":"SKU-227S9TM",
            "ean":null,
            "upc":null,
            "description":null,
            "each_weight":"10.00",
            "each_volume":"1000.00",
            "has_expiry":false,
            "shelf_life":null,
            "shelf_life_uom":null,
            "requires_putaway":true,
            "uom":"KG",
            "file":null,
            "mrp":"85.0"            ,
            "discounts":"0.00",
            "discount_type":"fixed",
            "is_kit_sku":false,
            "requires_shipping":true,
            "created_by":null,
            "modified_by":null,
            "product_group":null,
            "pack_config":4,
            "supplier":4,
            "client":4,
            "each_dimension":null,
            "base_price": "100",
            "cost_price": "100",
            "isbn": null,
            "tax_type_code": null
        }
}

200: OK No SKUs found for the search criteria

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

401: Unauthorized Unauthorized/Validation Error

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

Create SKUs

POST /wms/skus

This API is for creating new SKUs.

Headers

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

Request Body

Name	Type	Description
name*		Unique text identifier of the SKU for the client
client_name	String	Warehouse Client name to which the item belongs. Note: This is conditionally optional. Either client or client_name or both can be provided for identifying a client to associate this SKU or else both can be left empty if need not to associate with any.
id	integer	An identifier will be randomly generated by Blowhorn. You can optionally override this ID, but the ID must be unique across all SKUs in your account.
description*	String	SKU description.
ean_code	String	European Article Number - A barcode for product identification (which helps manufacturers identify how many products have been sold once a sale is made). It is 13 digits long.
upc	String	Universal Product Code – Barcode for product identification which is used across the world. It is 12 digits long.
product_group	String	Product Group id to which the SKU belongs. Note: This is conditionally optional. Either product_group or product_group_name or both can be provided for identifying a product group to associate this SKU or else both can be left empty if need not to associate with any.
pack_config	String	The packaging details id for the SKU. Note: This is conditionally optional. Either pack_config or pack_config_name or both can be provided for identifying a package config to associate this SKU or else both can be left empty if need not to associate with any.
supplier	integer	Supplier id of the SKU. Note: This is conditionally optional. Either supplier or supplier_name or both can be provided for identifying a supplier to associate this SKU or else both can be left empty if need not to associate with any.
client	String	Warehouse Client id to which the item belongs. Note: This is conditionally optional. Either client or client_name or both can be provided for identifying a client to associate this SKU or else both can be left empty if need not to associate with any.
each_weight	String	The weight of the SKU in kgs without packaging
each_dimension	String	Product Dimensions Format: LxBxH, Unit: mm, Eg: 60X40X20
each_volume	String	The width of the SKU in cubic meters.
has_expiry	String	If the SKU has an expiry or not
shelf_life	String	Duration of time that a product may be stored without becoming unfit for use, consumption, or sale
shelf_life_uom	String	Days, Months, Years etc. Note this is case sensitive and enumerated.
mrp	String	Maximum Retail Price. How much is the maximum price at which the product is being sold.
discounts	String	Mention the discount value that needs to be provided
discount_type	String	Type of discount provided i.e Fixed or Percentage
is_kit_sku	boolean	A Kit SKU an SKU that either has multiple units of an underlying SKU ( Pack or Multi-Pack) or multiple underlying SKUs (Bundle)
sku_number	String	Unique SKU identifier for the client. This can either provided by the client or Blowhorn generates if not provided.
product_group_name	String	Product Group name to which the SKU belongs. Note: This is conditionally optional. Either product_group or product_group_name or both can be provided for identifying a product group to associate this SKU or else both can be left empty if need not to associate with any.
pack_config_name	String	The packaging details name for the SKU. Note: This is conditionally optional. Either pack_config or pack_config_name or both can be provided for identifying a package config to associate this SKU or else both can be left empty if need not to associate with any.
supplier_name	String	Supplier name of the SKU. Note: This is conditionally optional. Either supplier or supplier_name or both can be provided for identifying a supplier to associate this SKU or else both can be left empty if need not to associate with any.
requires_putaway	boolean	Flag to indicate if this SKU does not need to be stored and needs to be putaway for cross dock shipping.
uom	String	Unit of weight of the inventory items. Ex: KG or GM
base_price	Decimal	Base price of the SKU excluding tax and discounts.
cost_price	Decimal	Cost price of the SKU which is excluding all discounts ?
isbn	String	ISBN number of the product
tax_type_code	String	Tax type code

200: OK Successful creation of SKU

{
    "status": "PASS",
    "message": {
        "id": 35257,
        "sku_number": "SKU-2285KMP"
    }
}

400: Bad Request Bad Request/Validation Error

{
    "status": "FAIL",
    "message": "Failed to create SKU. Reason: {'sku_number': [ErrorDetail(string='wh sku with this SKU Number already exists.', code='unique')]}"
}

401: Unauthorized Unauthorized/Wrong API key

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

500: Internal Server Error Unexpected Error

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

Update SKUs

PUT /wms/skus

This API is for updating an existing SKU. Any or all of the below mentioned attribute of the SKU 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	integer	Unique identifier either generated by Blowhorn or provided at the time of SKU creation. Note: This is conditionally optional. Either id, sku_number or name should be provided for identifying the SKU that needs to be updated.
name	String	Unique text identifier of the SKU for the client. Note: This is conditionally optional. Either id, sku_number or name should be provided for identifying the SKU that needs to be updated.
description	String	SKU description.
sku_number	String	Unique SKU identifier for the client. This can either provided by the client or Blowhorn generates if not provided. Note: This is conditionally optional. Either id, sku_number or name should be provided for identifying the SKU that needs to be updated.
ean_ code	String	European Article Number - A barcode for product identification (which helps manufacturers identify how many products have been sold once a sale is made). It is 13 digits long.
upc	String	Universal Product Code - Barcode for product identification which is used across the world. It is 12 digits long.
product_group	String	Product Group id to which the SKU belongs. Note: This is conditionally optional. Either product_group or product_group_name or both can be provided for identifying a product group to associate this SKU or else both can be left empty if need not to associate with any.
product_group_name	String	Product Group name to which the SKU belongs. Note: This is conditionally optional. Either product_group or product_group_name or both can be provided for identifying a product group to associate this SKU or else both can be left empty if need not to associate with any.
pack_config	String	The packaging details id for the SKU. Note: This is conditionally optional. Either pack_config or pack_config_name or both can be provided for identifying a package config to associate this SKU or else both can be left empty if need not to associate with any.
pack_config_name	String	The packaging details name for the SKU. Note: This is conditionally optional. Either pack_config or pack_config_name or both can be provided for identifying a package config to associate this SKU or else both can be left empty if need not to associate with any.
supplier	String	Supplier id of the SKU. Note: This is conditionally optional. Either supplier or supplier_name or both can be provided for identifying a supplier to associate this SKU or else both can be left empty if need not to associate with any.
supplier_name	String	Supplier name of the SKU. Note: This is conditionally optional. Either supplier or supplier_name or both can be provided for identifying a supplier to associate this SKU or else both can be left empty if need not to associate with any.
client	String	Warehouse Client id to which the item belongs. Note: This is conditionally optional. Either client or client_name or both can be provided for identifying a client to associate this SKU or else both can be left empty if need not to associate with any.
client name	String	Warehouse Client name to which the item belongs. Note: This is conditionally optional. Either client or client_name or both can be provided for identifying a client to associate this SKU or else both can be left empty if need not to associate with any.
each_weight	String	The weight of the SKU in kgs without packaging
each volume	String	The width of the SKU in cubic meters.
each_dimension	String	Product Dimensions Format: LxBxH. Unit: mm, Eg: 60X40X20
has_expiry	String	If the SKU has an expiry or not
shelf life	String	Duration of time that a product may be stored without becoming unfit for use, consumption, or sale
shelf life uom	String	Days, Months, Years etc. Note this is case sensitive and enumerated.
mrp	String	Maximum Retail Price. How much is the maximum price at which the product is being sold.
discounts	String	Mention the discount value that needs to be provided
is_kit_sku	String	A Kit SKU an SKU that either has multiple units of an underlying SKU (Pack or Multi-Pack) or multiple underlying SKUs (Bundle)
requires_putaway	String	Flag to indicate if this SKU does not need to be stored and needs to be putaway for cross dock shipping
uom	String	Unit of weight of the inventory items. Ex: KG or GM

200: OK Successful update of SKU

{
    "status": "PASS",
    "message": "Updated the SKU details"
}

400: Bad Request Bad Request/Validation Error

{
    "status": "FAIL",
    "message": "SKU ID does not exist"
}

401: Unauthorized Unauthorized/Wrong API key

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

500: Internal Server Error Unexpected Error

{
  "status": "FAIL",
  "message": "Enexpected Error"
}

Sample Create SKU | Schema

{
 "id": 3,
 "name": "EOS 5D Mark IV Kit",
 "description": "30.4 megapixel full-frame CMOS sensor",
 "sku_number": "SKU-2294XOV",
 "ean_code": 4712345967072,
 "upc": 036000291452,
 "product_group": 3,
 "product_group_name": "Luggage & Travel",
 "pack_config" : 1
 "pack_config_name": "each",
 "supplier": 5
 "supplier_name": "Boston Photo lab",
 "client": 100
 "client_name": "Canon",
 "each_weight": 1,
 "each_volume": 131312,
 "each_dimension": "150.7 x 116.4 x 75.9",
 "uom": "KG"
 "has_expiry": true,
 "shelf_life": 45,
 "shelf_life_uom": "Days",
 "mrp": 23000,
 "discounts": 3,
 "discount_type": "percentage",
 "is_kit_sku": false,
 "requires_putaway": true
 }

Example Create Kit SKU | Schema

{
 "id": 3,
 "name": "EOS 5D Mark IV Kit",
 "description": "30.4 megapixel full-frame CMOS sensor",
 "sku_number": "SKU-2294XOX",
 "ean_code": 4712345967076,
 "upc": 036000291457,
 "product_group": 3,
 "product_group_name": "Luggage & Travel",
 "pack_config": 1,
 "pack_config_name": "each",
 "supplier": 4,
 "supplier": "Boston Photo lab",
 "client": 3,
 "client_name": "Canon",
 "each_weight": 1,
 "each_volume": 131312,
 "each_dimension": "150.7 x 116.4 x 75.9",
 "has_expiry": true,
 "shelf_life": 45,
 "shelf_life_uom": "Days",
 "mrp": 23000,
 "discounts": 3,
 "discount_type": "percentage",
 "is_kit_sku": true,
 "requires_putaway": true
}