Webhook subscriptions can assist you in receiving real-time updates regarding specific events in your Logiwa account. Once you have successfully subscribed to a webhook topic, Logiwa will initiate API calls to send a data payload to the target URL when this particular event occurs, eliminating the need to periodically check the status by making API calls. By utilizing webhooks, you can reduce the overall number of API calls, ensuring that your applications are more efficient and promptly updated.
If you wish to receive a webhook notification for any changes in inventory within the warehouse, you would subscribe to the inventory webhook. It's the same for any webhook topic. The sections below serve as an introduction to the various webhook topics available.
Client Notifications
Client Notifications
To receive notifications for all clients, the IgnoreClient parameter should be set to True and the ClientIdentifier should be set to Null.
To receive a notification for a particular client, set IgnoreClient to False and ensure that ClientIdentifier is set.
Sample Request
Sample Request
A sample request will give you a preview of the data your webhook will receive from another system. It's a handy tool for testing and ensuring everything is set up correctly before the real data comes through.
Sample Request Body:
{
"Topic": "wms/inventory/available",
"Address": "https://webhook.site/648a87a3-9c18-4903-a8dc-7f47f3431217",
"ClientIdentifier": null,
"IgnoreClient": true
}
Inventory
Inventory
Inventory webhooks play a crucial role in fulfillment by providing fast updates on inventory levels and changes. By utilizing webhooks, you can automate tracking inventory, receiving notifications when stock levels change, and integrating this information into your systems. This not only enhances the efficiency of your operations but also helps ensure accurate and up-to-date inventory information, enabling timely decision-making.
Available Inventory
Available Inventory
Subscription Topic: wms/inventory/available
Sample Callback Response:
{
"ClientIdentifier":"c5b5eb88-d266-4aa7-a1f5-5d32e0c95e14",
"WarehouseIdentifier":"a30a94d8-436e-43c6-a72a-9be70e54b585",
"ProductList":[
{
"CalculatedDateTime":
"ProductIdentifier":"1ca7d624-b365-424e-9deb-3c9d36efdc30",
"PackTypeIdentifier":"43cfaf9d-8a69-46fc-bed6-8c2811c26231",
"AvailableQuantity":830,
"TotalQuantity":871,
"OrderQuantity":41,
"SKU":"Hook1",
"PackTypeName":"Piece"
}
]
}
Triggers and Frequency
With most conditions, you will receive notifications in real-time. The frequency of each notification is listed below:
Shipment Order Insert: Real-Time
Shipment Order Bulk Insert: Real-Time
Shipment Order Update: Real-Time
Shipment Order Delete: Real-Time
Shipment Order Cancel: Real-Time
Cancel Receipt: Real-Time
Negative Inventory Adjustment: Real-Time
Positive Inventory Adjustment: Delayed (Less than 2 mins)
Damaged Inventory: Real-Time
Inventory Movement From/To Location IsPreventInventorySync Changes: Real-Time
Receiving: Delayed (Less than 2 mins)
Count: Delayed (Less than 2 mins)
Location IsPreventInventorySync Parameter Change: Real-Time
IsPreventInventorySync is the only location parameter that affects the calculation. If this parameter is true, the stock at the relevant location is also taken into account. Otherwise, the stock is not taken into account.
Inventory Transaction
Inventory Transaction
Subscription Topic: wms/inventory/transaction
Sample Callback Response:
Pending
Locations
Locations
Our Location webhooks track the creation and update of locations and mobile carts. These webhooks provide visibility around the movement and management of locations, both stationary and mobile, within the warehouse. Knowing about changes to your locations and mobile carts can help optimize your workflows and detecting or prevent errors.
Create Location
Create Location
Subscription Topic: wms/location/create
Sample Call Back Response:
[
{
"Identifier": "cb7afbfb-31ed-4262-b05c-04e7199bf41a",
"Code": "A-5-5",
"WarehouseIdentifier": "3cd7c232-1dcd-4ff3-8eb4-fd43ce1060c4",
"Description": null,
"ClientIdentifier": "00000000-0000-0000-0000-000000000000",
"LocationGroupIdentifier": "233ca410-e1f2-4bb5-9ba5-c1f33d7c9f31",
"LocationGroupName": "Group 1",
"LocationZoneIdentifier": "0f7ac1f3-532b-4f07-a751-ac82b784f370",
"LocationZoneName": "Active",
"LocationTypeId": 1,
"AreaTypeId": 1,
"ReplenishmentTypeId": 2,
"Level": 5,
"Aisle": "A",
"Column": 1,
"IsLocked": false,
"PickingPriority": 25,
"PutawayPriority": null,
"Length": 50,
"Width": 50,
"Height": 50,
"DimensionUnitId": 1,
"Volume": 125000,
"VolumeUnitId": 2,
"SystemLength": 127,
"SystemWidth": 127,
"SystemHeight": 127,
"SystemDimensionUnitId": 3,
"SystemVolume": null,
"SystemVolumeUnitId": 0,
"ColorCode": null,
"CheckDigit": null,
"DisplayMember": "Pick Rack 25",
"IsMobileCart": false,
"AssignedMobileCartIdentifier": null,
"AssignedMobileCartCode": null,
"ABCCode": "A",
"IsPreventAllocation": false,
"IsPreventInventorySync": false,
"IsPreventMultiClient": false,
"IsAllowOnlyDamaged": false,
"IsPreventMultiLotBatchNumber": false,
"IsPreventMultiExpiryDate": false,
"IsPreventMultiSKU": false,
"IsPreventMultiLP": false,
"SuggestionSequence": 0,
"ProductCapacityList": [
{
"Identifier": "58459de7-b7d2-4f65-9a32-56f69bc8cd81",
"ProductIdentifier": "a7e9a473-4b3e-427b-9781-1e53016a3cfc",
"PackTypeIdentifier": "9f5cb778-c0f0-46dc-a7c5-203d845fe397",
"MaxVolume": null,
"MinVolume": null,
"ReplenishmentThresholdVolume": null,
"MaxQuantity": 200,
"MinQuantity": 50,
"ReplenishmentThresholdQuantity": 100,
"ClientIdentifier": "1c899755-b2ba-4d8c-b821-c265d5bea9c4"
}
],
"LPCapacityList": [],
"CustomFieldDateTime1": null,
"CustomFieldDateTime2": null,
"CustomFieldDateTime3": null,
"CustomFieldToggle1": null,
"CustomFieldToggle2": null,
"CustomFieldDropDown1": null,
"CustomFieldDropDown2": null,
"CustomFieldTextBox1": null,
"CustomFieldTextBox2": null,
"CustomFieldTextBox3": null
}
]
Update Location
Update Location
Subscription Topic: wms/location/update
Sample Call Back Response:
[
{
"Identifier": "cb7afbfb-31ed-4262-b05c-04e7199bf41a",
"Code": "A-5-5",
"WarehouseIdentifier": "3cd7c232-1dcd-4ff3-8eb4-fd43ce1060c4",
"Description": null,
"ClientIdentifier": "00000000-0000-0000-0000-000000000000",
"LocationGroupIdentifier": "233ca410-e1f2-4bb5-9ba5-c1f33d7c9f31",
"LocationGroupName": "Group 1",
"LocationZoneIdentifier": "0f7ac1f3-532b-4f07-a751-ac82b784f370",
"LocationZoneName": "Active",
"LocationTypeId": 1,
"AreaTypeId": 1,
"ReplenishmentTypeId": 2,
"Level": 5,
"Aisle": "A",
"Column": 1,
"IsLocked": false,
"PickingPriority": 25,
"PutawayPriority": null,
"Length": 50,
"Width": 50,
"Height": 50,
"DimensionUnitId": 1,
"Volume": 125000,
"VolumeUnitId": 2,
"SystemLength": 127,
"SystemWidth": 127,
"SystemHeight": 127,
"SystemDimensionUnitId": 3,
"SystemVolume": null,
"SystemVolumeUnitId": 0,
"ColorCode": null,
"CheckDigit": null,
"DisplayMember": "Pick Rack 25",
"IsMobileCart": false,
"AssignedMobileCartIdentifier": null,
"AssignedMobileCartCode": null,
"ABCCode": "A",
"IsPreventAllocation": false,
"IsPreventInventorySync": false,
"IsPreventMultiClient": false,
"IsAllowOnlyDamaged": false,
"IsPreventMultiLotBatchNumber": false,
"IsPreventMultiExpiryDate": false,
"IsPreventMultiSKU": false,
"IsPreventMultiLP": false,
"SuggestionSequence": 0,
"ProductCapacityList": [
{
"Identifier": "58459de7-b7d2-4f65-9a32-56f69bc8cd81",
"ProductIdentifier": "a7e9a473-4b3e-427b-9781-1e53016a3cfc",
"PackTypeIdentifier": "9f5cb778-c0f0-46dc-a7c5-203d845fe397",
"MaxVolume": null,
"MinVolume": null,
"ReplenishmentThresholdVolume": null,
"MaxQuantity": 200,
"MinQuantity": 50,
"ReplenishmentThresholdQuantity": 100,
"ClientIdentifier": "1c899755-b2ba-4d8c-b821-c265d5bea9c4"
}
],
"LPCapacityList": [],
"CustomFieldDateTime1": null,
"CustomFieldDateTime2": null,
"CustomFieldDateTime3": null,
"CustomFieldToggle1": null,
"CustomFieldToggle2": null,
"CustomFieldDropDown1": null,
"CustomFieldDropDown2": null,
"CustomFieldTextBox1": null,
"CustomFieldTextBox2": null,
"CustomFieldTextBox3": null
}
]
Create Mobile Cart
Create Mobile Cart
Subscription Topic: wms/mobilecart/create
Sample Call Back Response:
[
{
"Identifier": "7e310a22-e8e1-4879-aa9a-8048a358a756",
"AccountIdentifier": "335dff27-9bb2-41fb-b9a1-91753ed82241",
"WarehouseIdentifier": "e8d6e6a0-4f21-4ffa-871f-35311cacb907",
"Code": "MBC",
"Description": "",
"NofLevels": 4,
"NofColumns": 4,
"NofCells": 16,
"IsDynamic": false,
"WarehouseJobIdentifier": null,
"WarehouseJobCode": null,
"IsOccupied": false,
"WarehouseJobDetails": {
"NofOrders": 0,
"NofTasks": 0
}
}
]
Update Mobile Cart
Update Mobile Cart
Subscription Topic: wms/mobilecart/update
Sample Call Back Response:
[
{
"Identifier": "7e310a22-e8e1-4879-aa9a-8048a358a756",
"AccountIdentifier": "335dff27-9bb2-41fb-b9a1-91753ed82241",
"WarehouseIdentifier": "e8d6e6a0-4f21-4ffa-871f-35311cacb907",
"Code": "MBCART",
"Description": "",
"NofLevels": 4,
"NofColumns": 4,
"NofCells": 16,
"IsDynamic": false,
"WarehouseJobIdentifier": null,
"WarehouseJobCode": null,
"IsOccupied": false,
"WarehouseJobDetails": {
"NofOrders": 0,
"NofTasks": 0
}
}
]
Products
Products
Our Product webhooks track the creation and update of products and send notifications whenever new products are added or existing products are updated. This allows your fulfillment center to stay up-to-date with the latest inventory information, enabling you to efficiently manage and fulfill orders without delays or errors.
Create Product
Create Product
Subscription Topic: wms/product/create
Sample Call Back Response:
[
{
"Identifier": "27fe7b49-1ec5-478c-b23c-cf6e06ef8c22",
"SKU": "SKU4",
"ClientId": 49139
}
]
Update Product
Update Product
Subscription Topic: wms/product/update
Sample Call Back Response:
[
{
"Identifier": "27fe7b49-1ec5-478c-b23c-cf6e06ef8c22",
"SKU": "SKU4",
"ClientId": 49139
}
]
Purchase Orders
Purchase Orders
Our Purchase Order webhooks provide updates when a new purchase order document is uploaded or when the status of an existing purchase order changes. These notifications enhance your workflow by promptly notifying you of such changes, allowing you to effectively manage inventory and plan for incoming shipments.
Purchase Order Document Upload
Purchase Order Document Upload
Subscription Topic: wms/purchaseorder/documentupload
Sample Call Back Response:
Pending
Purchase Order Status Change
Purchase Order Status Change
Subscription Topic: wms/purchaseorder/statuschange
Sample Call Back Response:
{
"Identifier": "b1fe485b-001b-40a8-92f1-aa4c11b29201",
"Code": "SO02079278_1",
"PreviousStatus": "ReadyToShip",
"CurrentStatus": "Shipped",
"ClientId": 40735
}
Shipment Orders
Shipment Orders
Our Shipment Order webhooks note status changes, creation of shipment orders, when shipment order packing has started, shipping of shipment orders, and updates to shipment orders. This information can help you stay on top of the progress of orders. With webhooks, your fulfillment center can efficiently track and manage shipments, streamline operations, and provide timely information to customers regarding their orders.
Shipment Order Status Change
Shipment Order Status Change
Subscription Topic: wms/shipmentorder/statuschange
Sample Call Back Response:
Pending
Create Shipment Order
Create Shipment Order
Subscription Topic: wms/shipmentorder/create
Sample Call Back Response:
{
"Data": [
{
"Identifier": "ca7fd021-3e02-43d9-a74a-6e8e5ef78ea9",
"Code": "SO02088566",
"ClientId": 40735
}
]
}
Shipment Order Packing Started
Shipment Order Packing Started
Subscription Topic: wms/shipmentorder/packingstarted
Sample Call Back Response:
Pending
Shipment of Shipment Order
Shipment of Shipment Order
Subscription Topic: wms/shipmentorder/shipment
Sample Call Back Response:
{
"ShipmentOrderCode": "SO0335",
"WarehouseCode": "MyWarehouse",
"WarehouseIdentifier": "0a61c594-9adb-46b6-b3a6-1d03152b7ff7",
"ClientIdentifier": "88abb4db-376a-49fe-933c-0aa8765e3e7c",
"ChannelOrderNumber": null,
"ClientDisplayName": "MyClient",
"ShipmentTypeName": "AllFALSE",
"ShipmentDate": "2023-11-16T08:50:34.1222276Z",
"MasterTrackingNumber": "0371aa7498",
"OrderCarrierTrackingNumbers": "0371aa7498",
"ShipmentPackageList": [
{
"CarrierPackageCode": "BOX 4*4*4",
"CarrierPackageTypeCode": "BOX 4*4*4",
"CarrierPackageTypeIdentifier": "5eb52bf5-d213-4309-8d38-f7d261426e99",
"TrackingNumber": "0371aa7498",
"Carrier": "XDE",
"CarrierSetup": "CUST1",
"CarrierSetupShippingOption": "XDE OP1",
"TotalCost": 12,
"ShippingCost": 12,
"OtherCost": 12,
"InsuranceValue": null,
"Weight": 369.6,
"WeightUnit": "oz",
"CurrencyCode": "USD",
"Height": 4,
"Length": 4,
"Width": 4,
"DimensionUnit": "ft",
"LabelCreatedDateTime": "2023-11-13T10:42:37.84Z",
"LabelUpdatedDateTime": null,
"ProductList": [
{
"ProductIdentifier": "de50f722-9203-49ea-abdb-78b31b96b64c",
"Sku": "MRV-HB-VENOM-1",
"Name": "Venom 6-inch Collectible Action Figure",
"ExpiryDate": null,
"LotBatchNumber": null,
"PackQuantity": 2,
"PackTypeName": "Piece"
},
{
"ProductIdentifier": "4ef554e7-de07-4d5c-936c-520164d1c284",
"Sku": "packt",
"Name": "packt",
"ExpiryDate": null,
"LotBatchNumber": null,
"PackQuantity": 3,
"PackTypeName": "Unit"
}
]
}
]
}
Update Shipment Order
Update Shipment Order
Subscription Topic: wms/shipmentorder/update
Sample Call Back Response:
{
"Data": [
{
"Identifier": "3126d954-b637-4823-838c-c529c12dd413",
"Code": "SO0003",
"ClientId": 49139
}
]
}
Couldn’t Find What You Were Looking For?
Visit our Help Center to search for more documents!