Inbound Shipment

This API is used to get stock information for inbound shipment number after warehouse receives the goods and will send real-time data by webhook. User need to create URL to get data. The data variables provided in these updates will conform to the specified request parameters in below

API Endpoint

Method	POST
Content-Type	application/json

Request Parameters

Parameter	Type	Size	Description
event_id	string	30	A unique identifier for the event.
event_type	string	50	Indicates that the event is related to inbound receive
mchid	string	5	Merchant code
doc_no	string	30	Document Reference number
warehouse_id	string	5	Warehouse id
warehouse_name	string	200	Warehouse description
receipt_date	string	10	Receipt date format : yyyy-MM-dd
asn_status	string	3	Receipt receive status NEW = Waiting for verification CAN = Canceled PCS = In progress CMP = Complete or Received
item_list	string		Collection of TransferItem

Collection of Item_list

Parameter	Type	Size	Description
sku	string	50	Product code
barcode	string	50	Product barcode
sku_name	string	200	Product name
qty	integer		Quantity ordered
QTY	integer		quantity
received_qty	integer		Quantity received
lost_qty	integer		Quantity lost during transit
damage_qty	integer		Quantity damaged upon receipt at the warehouse
ref_id	string	30	Reference transaction number
remark_item	string	200	Remarks or comments

Request JSON Example

{
  "event_id": "a1b2c3d4-e5f6-7g8h",
  "event_type": "product.InboundShipment",
  "mchid": "M1234",
  "doc_no": "INV-20230829-001",
  "warehouse_id": "WH001",
  "warehouse_name": "Main Warehouse - Bangkok",
  "receipt_date": "2024-08-29",
  "asn_status": "9",
  "item_list": [
    {
      "sku": "SKU123456",
      "barcode": "1234567890123",
      "sku_name": "Smartphone Model X",
      "qty": 100,
      "received_qty": 98,
      "lost_qty": 1,
      "damage_qty": 1,
      "ref_id": "TXN-987654321",
      "remark_item": "One unit lost during transit, one unit damaged."
    },
    {
      "sku": "SKU789012",
      "barcode": "9876543210987",
      "sku_name": "Wireless Earbuds Pro",
      "qty": 50,
      "received_qty": 50,
      "lost_qty": 0,
      "damage_qty": 0,
      "ref_id": "TXN-123456789",
      "remark_item": "All items received in good condition."
    }
  ]
}

Response Parameters

Parameter	Type	Size	Description
event_id	string	30	A unique identifier for the event.
ResponseCode	string	1	Status Code (1=OK, 0=ERROR)
ResponseMessage	string	200	Response Description

Response JSON Example

{   
    "event_id": "a1b2c3d4-e5f6-7g8h",
    "ResponseCode": "1",   
    "ResponseMessage": "Operation completed successfully"
}