Receive ASN

Process the receiving of items from an ASN and update inventory

This endpoint processes the receiving of items from an ASN. It updates inventory levels, records any discrepancies, and can trigger automated workflows for putaway and quality control.

Path Parameters

id · string · required

The unique identifier of the ASN to receive

Request Body

received_date · string · required

Date and time when items were received (ISO 8601)

received_by · string · required

User ID or name of the person processing the receipt

items · array · required

Array of received items with quantities and conditions

Show Item object properties

item_id · string · required

ASN item ID being received

quantity_received · integer · required

Actual quantity received

condition · string

Condition of received items: “new”, “damaged”, “defective”

lot_number · string

Lot number for tracking (can override ASN lot number)

expiration_date · string

Expiration date for perishable items

serial_numbers · array

Array of serial numbers for serialized items

location · string

Warehouse location where items are placed

discrepancy_notes · string

Notes about any discrepancies found

quality_check · object

Quality control information

Show Quality check properties

performed · boolean

Whether quality check was performed

passed · boolean

Whether items passed quality check

notes · string

Quality check notes

failed_items · array

List of items that failed quality check

discrepancies · array

Overall discrepancies found during receiving

Show Discrepancy properties

type · string · required

Type: “quantity”, “damage”, “wrong_item”, “missing_item”

description · string · required

Description of the discrepancy

resolution · string

How the discrepancy was resolved

notes · string

General receiving notes

complete_receipt · boolean

Whether this completes the ASN receipt (default: true)

Response

id · string

ASN ID

status · string

Updated ASN status

receiving_summary · object

Summary of the receiving process

inventory_updates · array

Details of inventory updates made

discrepancy_report · object

Summary of any discrepancies found

cURL

curl --location --request POST 'https://api.stateset.com/v1/asns/asn_0901f083-aa1c-43c5-af5c-0a9d2fc64e30/receive' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_API_KEY' \
--data-raw '{
    "received_date": "2024-01-18T11:00:00Z",
    "received_by": "[e-mail]",
    "items": [
        {
            "item_id": "asn_item_123",
            "quantity_received": 498,
            "condition": "new",
            "lot_number": "LOT-2024-001",
            "location": "A-12-3",
            "discrepancy_notes": "2 units damaged in transit"
        },
        {
            "item_id": "asn_item_124",
            "quantity_received": 1000,
            "condition": "new",
            "lot_number": "LOT-2024-002",
            "location": "B-5-1"
        }
    ],
    "quality_check": {
        "performed": true,
        "passed": true,
        "notes": "All items meet quality standards"
    },
    "discrepancies": [
        {
            "type": "damage",
            "description": "2 units of WBH-001 damaged in transit",
            "resolution": "Filed claim with carrier"
        }
    ],
    "notes": "Shipment received in good condition except for noted damages",
    "complete_receipt": true
}'

Response

{
  "id": "asn_0901f083-aa1c-43c5-af5c-0a9d2fc64e30",
  "asn_number": "ASN-2024-00001",
  "status": "received",
  "receiving_summary": {
    "total_items_expected": 1500,
    "total_items_received": 1498,
    "discrepancy_count": 1,
    "receipt_completed": true,
    "received_date": "2024-01-18T11:00:00Z",
    "received_by": "[e-mail]"
  },
  "inventory_updates": [
    {
      "sku": "WBH-001",
      "product_name": "Wireless Bluetooth Headphones",
      "quantity_added": 498,
      "previous_quantity": 145,
      "new_total": 643,
      "location": "A-12-3",
      "lot_number": "LOT-2024-001"
    },
    {
      "sku": "USB-C-001",
      "product_name": "USB-C Charging Cable",
      "quantity_added": 1000,
      "previous_quantity": 487,
      "new_total": 1487,
      "location": "B-5-1",
      "lot_number": "LOT-2024-002"
    }
  ],
  "discrepancy_report": {
    "has_discrepancies": true,
    "total_discrepancies": 1,
    "discrepancies": [
      {
        "type": "damage",
        "description": "2 units of WBH-001 damaged in transit",
        "expected_quantity": 500,
        "received_quantity": 498,
        "impact": "inventory_shortage",
        "resolution": "Filed claim with carrier"
      }
    ]
  },
  "purchase_order_update": {
    "po_id": "po_123456789",
    "items_received": 1498,
    "items_outstanding": 2,
    "po_status": "partially_received"
  },
  "workflows_triggered": [
    {
      "type": "putaway",
      "status": "initiated",
      "assigned_to": "warehouse_team"
    },
    {
      "type": "carrier_claim",
      "status": "initiated",
      "reference": "CLAIM-2024-00123"
    }
  ]
}