Advance Shipping Notice

Advanced Shipping Notification (ASN) is the electronic way to place an intent of moving goods from supplier to the warehouse to plan for WMS inbound activities.

Fetch details of Advance Shipping Notice(ASN)

GET /wms/advance-shipping-notice

Use this api to get the details of a single or multiple ASNs like WILL-BE-DELIVERED items, their quantity and price etc against the purchase order.

Note: In order to reduce the amount of data returned, Either time range on created date, modified date, delivery date or invoice number is mandatory when invoking this API.

Query Parameters

Name	Type	Description
description	String	Full or partial description text of matching purchase order
site	String	Site id where the inventory will be delivered.
site_name	String	Site name where the inventory will be delivered.
status	String	Status of the GRN. Ex: New, In-Progress, Completed, Expired
delivery_date_start	String	Delivery date start which is inclusive to filter the result based on. Note: This works only if both delivery_date_start and delivery_date_end are provided. Ex: 2022-01-01
delivery_date_end	String	Delivery date end which is inclusive to filter the result based on. Note: This works only if both delivery_date_start and delivery_date_end are provided. Ex: 2022-01-01
invoice_number	String	Invoice number for the ASN.
created_date_start	String	Date range start for the date when the inventories received. This date which is inclusive. Note: This works only if both created_date_start and created_date_end are provided. Ex: 2022-01-01
created_date_end	String	Date range end for the date when the inventories received. This date which is inclusive. Note: This works only if both created_date_start and created_date_end are provided. Ex: 2022-01-01
modified_date_start	String	Date range start for the date when the GRN was last updated. This date which is inclusive. Note: This works only if both modified_date_start and modified_date_end are provided. Ex: 2022-01-01
modified_date_end	String	Date range end for the date when the GRN was last updated. This date which is inclusive. Note: This works only if both modified_date_start and modified_date_end are provided. Ex: 2022-01-01
supplier	String	Supplier id delivering the items.
supplier_name	String	Supplier name delivering the items.

Headers

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

200 Successful Result

{
    "count": 1,
    "previous": null,
    "next": 0,
    "result": [
        {
            "id": 5,
            "client_name": "Default Client",
            "site_name": "Banashankari WH",
            "sku_lines": [
                {
                    "id": 4,
                    "sku": "Sample 123456",
                    "pack_config": {
                        "id": 4,
                        "tracking_level": "Each",
                        "created_date": "2021-07-30T17:53:01.396745+05:30",
                        "modified_date": "2021-07-30T17:53:01.397988+05:30",
                        "name": "Box of 25",
                        "each_volume": 1,
                        "each_weight": 250,
                        "tag_volume": 1,
                        "use_each_volume": true,
                        "use_tag_volume": false,
                        "uom": null,
                        "created_by": 108434,
                        "modified_by": 108434,
                        "each_dimension": null,
                        "customer": 40082
                    },
                    "created_date": "2022-05-26T02:17:41.060040+05:30",
                    "modified_date": "2022-05-26T02:17:41.060259+05:30",
                    "status": "New",
                    "qty": 77,
                    "qty_received": 6,
                    "price_per_qty": 22,
                    "item_desc": "Nice quality",
                    "tracking_level": "Each",
                    "created_by": null,
                    "modified_by": null,
                    "asn_order": 5
                },
                {
                    "id": 5,
                    "sku": "Sample 1234",
                    "pack_config": {
                        "id": 4,
                        "tracking_level": "Each",
                        "created_date": "2021-07-30T17:53:01.396745+05:30",
                        "modified_date": "2021-07-30T17:53:01.397988+05:30",
                        "name": "Box of 25",
                        "each_volume": 1,
                        "each_weight": 250,
                        "tag_volume": 1,
                        "use_each_volume": true,
                        "use_tag_volume": false,
                        "uom": null,
                        "created_by": 108434,
                        "modified_by": 108434,
                        "each_dimension": null,
                        "customer": 40082
                    },
                    "created_date": "2022-05-26T02:18:16.255579+05:30",
                    "modified_date": "2022-05-26T02:18:16.405478+05:30",
                    "status": "New",
                    "qty": 55,
                    "qty_received": 5,
                    "price_per_qty": 33,
                    "item_desc": "Good quality",
                    "tracking_level": "Each",
                    "created_by": null,
                    "modified_by": null,
                    "asn_order": 5
                }
            ],
            "created_date": "2022-05-26T02:17:40.477724+05:30",
            "modified_date": "2022-05-26T02:17:40.658026+05:30",
            "invoice_number": "1234567894",
            "description": "Advance Shipping Notice Order description",
            "delivery_date": "2022-05-24T05:30:00+05:30",
            "expiry_date": "2022-05-30T05:30:00+05:30",
            "status": "New",
            "total_price": 125.5,
            "batch": "yes",
            "serial_number": "54943",
            "created_by": null,
            "modified_by": null,
            "supplier": 4,
            "site": 7,
            "client": 4
        }
    ]
}

401 Unauthorised / Wrong api key

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

500 Unexpected error

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

200: OK No data for the filter criteria

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

Create an Advance Shipping Notice(ASN)

POST /wms/advance-shipping-notice

Use this api to create an ASN.

Headers

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

Request Body

Name	Type	Description
supplier	String	Supplier id for the purchase order. Note: This field is conditionally optional. Either supplier or supplier_name should be provided.
supplier_name	String	Supplier name for the purchase order. Note: This field is conditionally optional. Either supplier or supplier_name should be provided.
description	String	Full or partial description text of matching purchase order
site	String	Site id to which purchase order was created for. Note: This field is conditionally optional. Either site or site_name should be provided.
site_name	String	Unique Site name to which purchase order was created for. Note: This field is conditionally optional. Either site or site_name should be provided.
status	String	Status of the purchase order. Ex: New, In-Progress, Completed, Expired. Default is New.
delivery_date	String	Delivery date of the purchase order. Ex:2022-01-01
expiry_date	String	Expiry date of the purchase order. Ex:2022-01-01
total_price	String	total price of all the items of the same SKU
batch	String	Batch number
serial_number	String	Serial Number
sku_lines*	String	Array containing SKUs information against those purchase order is created
sku_lines/sku_name	String	SKU name which should be uniquely identifiable in Blowhorn system.
sku_lines/status	String	Status of the SKUs. Ex: Unlocked or Locked
sku_lines/qty*	String	Quantity of the item being dispatched.
sku_lines/price_per_qty	String	Price of the SKU per unit.
sku_lines/item_desc	String	SKU description.
sku_lines/maximum_retail_price	String	Maximum retail price of the SKU.
sku_lines/discount	String	Discount amount if any applied on the SKU.
sku_lines/discount_percentage	String	What percentage of discount applied on the SKUs maximum retail price if any.
invoice_number*	String	Invoice number for the purchase order
sku_lines/tracking_level	String	Tracking level of the item.
sku_lines/qty_received	String	Quantity of the item warehouse has requested.

200 Successful Result

{
    "status": "PASS",
    "message": {
        "id": 4,
        "invoice_number": 1234567893
    }
}

401 Unauthorised / Wrong api key

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

500 Unexpected error

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

400: Bad Request Invalid Payload

{
    "status": "FAIL",
    "message": "Error when creating the ASNOrder. Reason: ASNOrder with invoice_number: 1234567893 already exists."
}

Sample Schema 01

{
    "invoice_number": 1234567894,
    "description": "Advance Shipping Notice Order 01 description",
    "delivery_date": "2022-05-24",
    "expiry_date": "2022-05-30",
    "status": "New",
    "total_price": 125.50,
    "batch": "yes",
    "serial_number": 54943,
    "supplier": 4,
    "supplier_name": "Default Supplier",
    "site": 7,
    "site_name": "Taj Vivanta Bangalore",
    "sku_lines": [
        {
            "sku_name": "Sample 123456",
            "status": "New",
            "qty": 77,
            "qty_received": 6,
            "price_per_qty": 22,
            "item_desc": "Nice quality",
            "tracking_level": "Each"
        }
    ]
}

Update an existing Advance Shipping Notice(ASN)

PUT /wms/advance-shipping-notice

Use this api to update an existing ASN by sending the details of the ASN to be updated in the request body.

Headers

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

Request Body

Name	Type	Description
supplier	String	Supplier id for the purchase order. Note: This field is conditionally optional. Either supplier or supplier_name should be provided.
supplier_name	String	Supplier name for the purchase order. Note: This field is conditionally optional. Either supplier or supplier_name should be provided.
description	String	Full or partial description text of matching purchase order
site	String	Site id to which purchase order was created for. Note: This field is conditionally optional. Either site or site_name should be provided.
site_name	String	Unique Site name to which purchase order was created for. Note: This field is conditionally optional. Either site or site_name should be provided.
status	String	Status of the purchase order. Ex: New, In-Progress, Completed, Expired. Default is New.
delivery_date	String	Delivery date of the purchase order. Ex:2022-01-01
expiry_date	String	Expiry date of the purchase order. Ex:2022-01-01
total_price	String	total price of all the items of the same SKU
batch	String	Batch number
serial_number	String	Serial Number
sku_lines*	String	Array containing SKUs information against those purchase order is created
sku_lines/sku_name	String	SKU name which should be uniquely identifiable in Blowhorn system.
sku_lines/status	String	Status of the SKUs. Ex: Unlocked or Locked
sku_lines/qty*	String	Quantity of the item being dispatched.
sku_lines/price_per_qty	String	Price of the SKU per unit.
sku_lines/item_desc	String	SKU description.
sku_lines/maximum_retail_price	String	Maximum retail price of the SKU.
sku_lines/discount	String	Discount amount if any applied on the SKU.
sku_lines/discount_percentage	String	What percentage of discount applied on the SKUs maximum retail price if any.
invoice_number*	String	Invoice number for the purchase order
sku_lines/tracking_level	String	Tracking level of the item.
sku_lines/qty_received	String	Quantity of the item warehouse has requested.

200 Successful Result

{
    "status": "PASS",
    "message": {
        "id": 4,
        "invoice_number": 1234567893
    }
}

401 Unauthorised / Wrong api key

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

500 Unexpected error

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

400: Bad Request Invalid Payload

{
    "status": "FAIL",
    "message": "Error when updating the ASNOrder. Reason: ASNOrder with invoice_number: 1234567893 does not exists."
}

Sample Schema 01

{
    "invoice_number": 1234567894,
    "description": "Advance Shipping Notice Order 01 description",
    "delivery_date": "2022-05-24",
    "expiry_date": "2022-05-30",
    "status": "New",
    "total_price": 125.50,
    "batch": "yes",
    "serial_number": 54943,
    "supplier": 4,
    "supplier_name": "Default Supplier",
    "site": 7,
    "site_name": "Taj Vivanta Bangalore",
    "sku_lines": [
        {
            "sku_name": "Sample 123456",
            "status": "New",
            "qty": 77,
            "qty_received": 6,
            "price_per_qty": 22,
            "item_desc": "Nice quality",
            "tracking_level": "Each"
        }
    ]
}

Sample Schema 02

{
    "invoice_number": 1234567894,
    "description": "Advance Shipping Notice Order 01 description",
}n

Sample Schema 03

{
    "invoice_number": 1234567894,
    "sku_lines": [
        {
            "sku_name": "Sample 123456",
            "status": "New",
            "qty": 77,
            "qty_received": 6,
            "price_per_qty": 22,
            "item_desc": "Nice quality",
            "tracking_level": "Each"
        },
        {
            "sku_name": "Sample 1234",
            "status": "New",
            "qty": 100,
            "qty_received": 10,
            "price_per_qty": 22,
            "item_desc": "Good quality",
            "tracking_level": "Each"
        }
    ]
}