Advanced Shipment Notice (ASN)¶

GET    /api/asn
GET    /api/asn/{id}
POST   /api/asn
PUT    /api/asn/{id}
DELETE /api/asn/{id}

Required privilege: ASN / View (read) · ASN / Edit (write)

An Advanced Shipment Notice (ASN) is a notification sent by a supplier before a shipment arrives. It provides detailed information about the contents and timing of an inbound delivery, enabling receiving teams to prepare in advance.

ASN Object¶

{
  "id": 1001,
  "ASN Number": "ASN-2024-001",
  "BOL": "BOL-789456",
  "ETA": "2024-03-15",
  "Ship Date": "2024-03-08",
  "Timestamp": "2024-03-07T14:30:00Z",
  "From": {
    "Supplier Id": 7,
    "Supplier Number": "SUP-007",
    "Ship From Id": 8,
    "Ship From Number": "SF-01",
    "Ship From Name": "Acme East Plant"
  },
  "To": {
    "Warehouse Id": 3,
    "Warehouse Number": "WH-01",
    "Warehouse Name": "Main Distribution Center"
  },
  "details": [
    {
      "id": 1051,
      "Item Id": 55,
      "Item Number": "ITEM-A",
      "Item Description": "Widget Assembly - Type A",
      "Sub Item Id": null,
      "Sub Item Number": null,
      "ASN Details Quantity": 200,
      "ASN Details ETA": "2024-03-15",
      "ASN Details Ship Date": "2024-03-08",
      "Purchase Order Id": 42,
      "PO List Number": "PO-2024-001",
      "PO Details Id": 101
    }
  ]
}

Header Fields¶

Field	Type	Description
`id`	integer	Internal ASN identifier
`ASN Number`	string	Unique ASN reference
`BOL`	string \| null	Bill of Lading number
`ETA`	string \| null	Expected arrival date (ISO 8601)
`Ship Date`	string \| null	Actual ship date (ISO 8601)
`Timestamp`	string \| null	ASN creation timestamp (ISO 8601)
`From.Supplier Number`	string	Shipping supplier reference
`From.Ship From Number`	string	Ship-from location reference
`To.Warehouse Number`	string	Destination warehouse

Detail Line Fields¶

Field	Type	Description
`Item Number`	string	Item being shipped
`ASN Details Quantity`	number	Quantity in this shipment
`Purchase Order Id`	integer \| null	Linked purchase order
`PO Details Id`	integer \| null	Linked PO line item

GET - List ASNs¶

curl -b cookies.txt "https://acme.knosc.com/api/asn"

GET - Get ASN¶

curl -b cookies.txt "https://acme.knosc.com/api/asn/1001"

POST - Create ASN¶

POST /api/asn HTTP/1.1
Content-Type: application/json
X-XSRF-TOKEN: <csrf>

{
  "ASN Number": "ASN-2024-NEW",
  "BOL": "BOL-NEW",
  "ETA": "2024-04-01",
  "Ship Date": "2024-03-25",
  "Supplier Number": "SUP-007",
  "Ship From Number": "SF-01",
  "Warehouse Number": "WH-01",
  "details": [
    {
      "Item Number": "ITEM-A",
      "ASN Details Quantity": 150,
      "Purchase Order Id": 42,
      "PO Details Id": 101
    }
  ]
}

PUT - Update ASN¶

Same schema as POST. Include all detail lines to retain (with their id).

DELETE - Delete ASN¶

DELETE /api/asn/{id} HTTP/1.1
X-XSRF-TOKEN: <csrf>

Errors¶

Status	Code	Description
400	`ASN.NotFound`	No ASN with this ID
400	`ASN.StillInUse`	ASN referenced by other records
400	`SupplierMaster.NotFound`	Supplier not found
400	`WarehouseMaster.NotFound`	Warehouse not found
403	`User.NotPrivileged`	Insufficient privilege